mlir-testutils 0.3.0

Utilities for writing tests that use MLIR.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

#![doc = include_str!("../README.md")]
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(missing_debug_implementations)]
#![deny(missing_docs)]

use melior::ir::Module;

/// Asserts that the given module is equal to the given string representation.
///
/// The string representation is roundtripped with the parser to normalize it. This makes the tests
/// less prone to flakiness because of things like whitespacing or value names.
///
/// # Example
///
/// ```
/// use melior::{
///    Context,
///    dialect::{DialectRegistry, arith, func},
///    ir::{
///     attribute::{StringAttribute, TypeAttribute},
///  operation::OperationLike,
///        r#type::FunctionType,
///     *,
///    },
/// utility::register_all_dialects,
/// };
///
///let registry = DialectRegistry::new();
///register_all_dialects(&registry);
///
///let context = Context::new();
///context.append_dialect_registry(&registry);
///context.load_all_available_dialects();
///
///let location = Location::unknown(&context);
///let module = Module::new(location);
///
///let index_type = Type::index(&context);
///
///module.body().append_operation(func::func(
///    &context,
/// StringAttribute::new(&context, "add"),
///    TypeAttribute::new(
///     FunctionType::new(&context, &[index_type, index_type], &[index_type]).into(),
///    ),
/// {
///  let block = Block::new(&[(index_type, location), (index_type, location)]);
///
///     let sum = block
///      .append_operation(arith::addi(
///       block.argument(0).unwrap().into(),
///    block.argument(1).unwrap().into(),
/// location,
///            ))
///         .result(0)
///      .unwrap();
///
///        block.append_operation(func::r#return(&[sum.into()], location));
///
///        let region = Region::new();
///        region.append_block(block);
///        region
///    },
///    &[],
///    location,
///));
///
/// // Note how this IR is not canonical wrt SSA names and formatting.
/// let repr = r#"
/// module {
///     func.func @add(%x: index, %y: index) -> index {
///         %r = arith.addi %x, %y: index
///         func.return %r : index
///     }
/// }
/// "#;
///
///mlir_testutils::assert_module_eq(&module, repr);
/// ```
pub fn assert_module_eq(module: &Module, repr: &str) {
    let module_str = format!("{}", module.as_operation());
    let ctx = module.context();
    let repr_mod = Module::parse(unsafe { ctx.to_ref() }, repr)
        .unwrap_or_else(|| panic!("Failed to parse check: {repr}"));
    let repr_str = format!("{}", repr_mod.as_operation());

    #[cfg(feature = "similar-asserts")]
    similar_asserts::assert_eq!(module_str, repr_str);
    #[cfg(not(feature = "similar-asserts"))]
    assert_eq!(module_str, repr_str);
}

/// Asserts that the given module is equal to the contents of a file in the given path.
///
/// The file content is roundtripped with the parser to normalize it. This makes the tests
/// less prone to flakiness because of things like whitespacing or value names.
///
/// # Example
///
/// ```
/// use melior::{
///    Context,
///    dialect::{DialectRegistry, arith, func},
///    ir::{
///     attribute::{StringAttribute, TypeAttribute},
///  operation::OperationLike,
///        r#type::FunctionType,
///     *,
///    },
/// utility::register_all_dialects,
/// };
///
///let registry = DialectRegistry::new();
///register_all_dialects(&registry);
///
///let context = Context::new();
///context.append_dialect_registry(&registry);
///context.load_all_available_dialects();
///
///let location = Location::unknown(&context);
///let module = Module::new(location);
///
///let index_type = Type::index(&context);
///
///module.body().append_operation(func::func(
///    &context,
/// StringAttribute::new(&context, "add"),
///    TypeAttribute::new(
///     FunctionType::new(&context, &[index_type, index_type], &[index_type]).into(),
///    ),
/// {
///  let block = Block::new(&[(index_type, location), (index_type, location)]);
///
///     let sum = block
///      .append_operation(arith::addi(
///       block.argument(0).unwrap().into(),
///    block.argument(1).unwrap().into(),
/// location,
///            ))
///         .result(0)
///      .unwrap();
///
///        block.append_operation(func::r#return(&[sum.into()], location));
///
///        let region = Region::new();
///        region.append_block(block);
///        region
///    },
///    &[],
///    location,
///));
///
///
///mlir_testutils::assert_module_eq_to_file!(&module, "sample.mlir");
/// ```

#[macro_export]
macro_rules! assert_module_eq_to_file {
    ($module:expr, $file:literal) => {
        $crate::assert_module_eq($module, include_str!($file));
    };
}