Refactor and clean IR module (#62)

* Reimplement `Context` * Reimplement `Dialect` * Reimplement `Location` * Reimplement `Value` * Reimplement `Block` * Move `BlockIterator` * Refactor `first_op` * Refactor `mlirIsNull` calls in `Block` * Reimplement `Region` * Reimplement `Module` * Fix namespaces in `Location` * Refactor `Type` to `Core.Type` to avoid import * Remove unused arg name from `iterator(::BlockIterator)` * Fix namespace calls under `API` * Refactor constructors * Refactor `Context` code * Refactor `Dialect` code * Fix typo in exported symbol * Fix typo in returned value in `enable_multithreading!` * Document some code * Refactor code * Reimplement `Operation` * Remove commented code * Export symbols from `IR` * Reimplement `TypeID` * Move iterators to new file * Fix missing module name in function calls * Remove `MLIRType` from tblgen generator * Refactor `MLIRType` from brutus example * Remove duplicate `get_or_load_dialect!` method * Fix missing module name in symbol refs * Refactor `MLIRType` in tests * Add `Identifier` * Add `SymbolTable` * Implement `IntegerSet` * Add `AffineExpr` type * Throw message on assert fail in `AffineExpr` constructor * Add `AffineMap` type * Fix `Context` kwargs * Import `@affinemap` macro from #35 Co-authored-by: Paul Berg <[email protected]> * Fix `@affinemap` * Implement `LogicalResult` * Fix typo in `move_after!` * Add `rmfromparent!` for `Operation` * Reimplement `Type` * Reorder includes * Fix `Type` clash in `LogicalResult` * Reimplement `Attribute` * Refactor `MLIRType` to `IR.Type` in dialect bindings * Fix `mlir*IsNull` calls `mlir*IsNull` are only defined in headers (no symbol in libs), so binding is generated but fails to look for the symbol * Apply suggestion from @Pangoraw Co-authored-by: Paul Berg <[email protected]> * Apply suggestion from @Pangoraw Co-authored-by: Paul Berg <[email protected]> * Apply suggestion by @Pangoraw Co-authored-by: Paul Berg <[email protected]> * Fix typos * Fix ambiguity * Fix typos * Remove redundant exports * Fix type value retrieval of `Attribute` for integers * Apply suggestion by @Pangoraw * Refactor `@affinemap` * Remove invalid assert in `@affinemap` * Fix extra namespace inside macro * Fix `mlir_str` macro * Fix `verifyall` * Rename `next_in_region` to `next` * Add `OpOperand` type (LLVM 16) * Fix `mlirOpPrintingFlagsEnableDebugInfo` on LLVM 15,16 * Add `@llvmversioned` macro utility * Add Float8 types * Add support for `DenseArray` attributes * Remove `isopaquelements` on LLVM 16 * Fix typos in `OpOperand` * Fix namespace in `DenseArrayAttribute` * Refactor `operandsegmentsizes` * Fix import in Julia 1.10 * Fix max versioning in `@llvmversioned` * Fix `DenseElementsAttribute` docstrings * Fix docstring warning in methods with `@llvmversioned` * Fix docstring of `type` * Fix `mlirIsNull` calls * Fix `LogicalResult` methods `mlirLogicalResult*` functions in the C-API are header-only * Fix `LogicalResult` calls in pass infrastructure * Update Brutus example * Comment `mlirOperationWriteBytecode` * Use signless integer types in MLIR for `<:Signed` types in Julia * Fix `Bool` to MLIR conversion * Fix tests * Update docs * Fix 0-indexing of dims and symbol expressions in `@affinemap` * Refactor `PassManager`,`OpPassManager` * Add `ExecutionEngine` * Fix docstring of `Type(Complex{T})` * Refactor `TensorType` constructor * Refactor `push_argument!` * Apply suggestion by @Pangoraw Co-authored-by: Paul Berg <[email protected]> * Refactor `create_operation` * Fix `push_arguent!` * Try fix `load_all_available_dialects` call in Julia 1.9 --------- Co-authored-by: Paul Berg <[email protected]>
JuliaLLVM · Mar 8, 2024 · 3527e24 · 3527e24
1 parent 8267af4
commit 3527e24
Show file tree

Hide file tree

Showing 149 changed files with 18,904 additions and 16,195 deletions.
diff --git a/deps/tblgen/jl-generators.cc b/deps/tblgen/jl-generators.cc
@@ -170,7 +170,7 @@ bool emitOpTableDefs(const llvm::RecordKeeper &recordKeeper,
   const char *moduleTemplate;
   if (disableModuleWrap)
   {
-    moduleTemplate = R"(import ...IR: NamedAttribute, MLIRType, Value, Location, Block, Region, Attribute, create_operation, context, IndexType
+    moduleTemplate = R"(import ...IR: IR, NamedAttribute, Value, Location, Block, Region, Attribute, create_operation, context, IndexType
 import ..Dialects: namedattribute, operandsegmentsizes
 import ...API
 
@@ -181,7 +181,7 @@ import ...API
   {
     moduleTemplate = R"(module {0}
 
-import ...IR: NamedAttribute, MLIRType, Value, Location, Block, Region, Attribute, create_operation, context, IndexType
+import ...IR: NamedAttribute, Value, Location, Block, Region, Attribute, create_operation, context, IndexType
 import ..Dialects: namedattribute, operandsegmentsizes
 import ...API
 
@@ -196,7 +196,7 @@ function {0}({1}location=Location())
     {2}
 end
 )";      // 0: functionname, 1: functionarguments, 2: functionbody
-  const char *functionbodytemplate = R"(results = MLIRType[{0}]
+  const char *functionbodytemplate = R"(results = IR.Type[{0}]
     operands = Value[{1}]
     owned_regions = Region[{2}]
     successors = Block[{3}]
@@ -321,7 +321,7 @@ end
         resultname = "result_" + std::to_string(i);
       }
       resultname = sanitizeName(resultname);
-      std::string type = "MLIRType";
+      std::string type = "IR.Type";
 
       bool optional = named_result.isOptional() || inferrable;
       bool variadic = named_result.isVariadic();

diff --git a/docs/make.jl b/docs/make.jl
@@ -40,6 +40,28 @@ makedocs(;
     pages = [
         "Home" => "index.md",
         "Examples" => examples,
+        "IR" => [
+            "AffineExpr" => "IR/affineexpr.md",
+            "AffineMap" => "IR/affinemap.md",
+            "Attribute" => "IR/attribute.md",
+            "Block" => "IR/block.md",
+            "Context" => "IR/context.md",
+            "Dialect" => "IR/dialect.md",
+            "Identifier" => "IR/identifier.md",
+            "IntegerSet" => "IR/integerset.md",
+            "Iterators" => "IR/iterators.md",
+            "Location" => "IR/location.md",
+            "LogicalResult" => "IR/logicalresult.md",
+            "Module" => "IR/module.md",
+            "Operation" => "IR/operation.md",
+            # TODO `OpOperand` for LLVM >=16
+            "Pass Infrastucture" => "IR/pass.md",
+            "Region" => "IR/region.md",
+            "SymbolTable" => "IR/symboltable.md",
+            "Type" => "IR/type.md",
+            "TypeID" => "IR/typeid.md",
+            "Value" => "IR/value.md",
+        ],
         "Dialects" => [
             "15" => [
                 "`affine`" => "dialects/affine.md",

diff --git a/docs/src/IR/affineexpr.md b/docs/src/IR/affineexpr.md
@@ -0,0 +1,6 @@
+# Affine Expressions
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/AffineExpr.jl"]
+```
diff --git a/docs/src/IR/affinemap.md b/docs/src/IR/affinemap.md
@@ -0,0 +1,6 @@
+# Affine Map
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/AffineMap.jl"]
+```
diff --git a/docs/src/IR/attribute.md b/docs/src/IR/attribute.md
@@ -0,0 +1,6 @@
+# Attribute
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/Attribute.jl"]
+```
diff --git a/docs/src/IR/block.md b/docs/src/IR/block.md
@@ -0,0 +1,6 @@
+# Block
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/Block.jl"]
+```
diff --git a/docs/src/IR/context.md b/docs/src/IR/context.md
@@ -0,0 +1,6 @@
+# Context
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/Context.jl"]
+```
diff --git a/docs/src/IR/dialect.md b/docs/src/IR/dialect.md
@@ -0,0 +1,6 @@
+# Dialect
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/Dialect.jl"]
+```
diff --git a/docs/src/IR/identifier.md b/docs/src/IR/identifier.md
@@ -0,0 +1,6 @@
+# Identifier
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/Identifier.jl"]
+```
diff --git a/docs/src/IR/integerset.md b/docs/src/IR/integerset.md
@@ -0,0 +1,6 @@
+# Integer Set
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/IntegerSet.jl"]
+```
diff --git a/docs/src/IR/iterators.md b/docs/src/IR/iterators.md
@@ -0,0 +1,6 @@
+# Iterators
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/Iterators.jl"]
+```
diff --git a/docs/src/IR/location.md b/docs/src/IR/location.md
@@ -0,0 +1,6 @@
+# Location
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/Location.jl"]
+```
diff --git a/docs/src/IR/logicalresult.md b/docs/src/IR/logicalresult.md
@@ -0,0 +1,6 @@
+# Logical Result
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/LogicalResult.jl"]
+```
diff --git a/docs/src/IR/module.md b/docs/src/IR/module.md
@@ -0,0 +1,6 @@
+# Module
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/Module.jl"]
+```
diff --git a/docs/src/IR/operation.md b/docs/src/IR/operation.md
@@ -0,0 +1,6 @@
+# Operation
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/Operation.jl"]
+```
diff --git a/docs/src/IR/pass.md b/docs/src/IR/pass.md
@@ -0,0 +1,6 @@
+# Pass Infrastructure
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/Pass.jl"]
+```
diff --git a/docs/src/IR/region.md b/docs/src/IR/region.md
@@ -0,0 +1,6 @@
+# Region
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/Region.jl"]
+```
diff --git a/docs/src/IR/symboltable.md b/docs/src/IR/symboltable.md
@@ -0,0 +1,6 @@
+# Symbol Table
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/SymbolTable.jl"]
+```
diff --git a/docs/src/IR/type.md b/docs/src/IR/type.md
@@ -0,0 +1,6 @@
+# Type
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/Type.jl"]
+```
diff --git a/docs/src/IR/typeid.md b/docs/src/IR/typeid.md
@@ -0,0 +1,6 @@
+# TypeID
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/TypeID.jl"]
+```
diff --git a/docs/src/IR/value.md b/docs/src/IR/value.md
@@ -0,0 +1,6 @@
+# Value
+
+```@autodocs
+Modules = [MLIR.IR]
+Pages = ["IR/Value.jl"]
+```
diff --git a/docs/src/api.md b/docs/src/api.md
@@ -19,4 +19,4 @@ Order = [:macro, :function]
 ```@autodocs
 Modules = [MLIR.API]
 Order = [:module, :type, :constant, :macro, :function]
-```
+```
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -2,7 +2,8 @@
 
 ## Design
 
-### String and MlirStringRef.
+### String and MlirStringRef
+
 `MlirStringRef` is a non-owning pointer, the caller is in charge of performing necessary
 copies or ensuring that the pointee outlives all uses of `MlirStringRef`.
 Since Julia is a GC'd language special care must be taken around the live-time of Julia

diff --git a/examples/brutus.jl b/examples/brutus.jl
@@ -27,8 +27,8 @@ const uge = 9
 end
 
 function cmpi_pred(predicate)
-    function (ops...; location = Location())
-        arith.cmpi(ops...; result=IR.MLIRType(Bool), predicate, location)
+    function (ops...; location=Location())
+        arith.cmpi(ops...; result=IR.Type(Bool), predicate, location)
     end
 end
 
@@ -45,10 +45,10 @@ const intrinsics_to_mlir = Dict([
     Base.mul_float => single_op_wrapper(arith.mulf),
     Base.not_int => function (block, args; location=Location())
         arg = only(args)
-        mT = IR.get_type(arg)
+        mT = IR.type(arg)
         T = IR.julia_type(mT)
         ones = push!(block, arith.constant(value=typemax(UInt64) % T;
-                                           result=mT, location)) |> IR.get_result
+            result=mT, location)) |> IR.result
         push!(block, arith.xori(arg, ones; location))
     end,
 ])
@@ -63,7 +63,7 @@ function prepare_block(ir, bb)
         inst isa Core.PhiNode || continue
 
         type = stmt[:type]
-        IR.push_argument!(b, MLIRType(type), Location())
+        IR.push_argument!(b, IR.Type(type))
     end
 
     return b
@@ -107,9 +107,10 @@ function code_mlir(f, types)
 
     values = Vector{Value}(undef, length(ir.stmts))
 
-    for dialect in ("func", "cf")
-        IR.get_or_load_dialect!(dialect)
+    for dialect in (:func, :cf)
+        IR.register_dialect!(IR.DialectHandle(dialect))
     end
+    IR.load_all_available_dialects()
 
     blocks = [
         prepare_block(ir, bb)
@@ -119,17 +120,17 @@ function code_mlir(f, types)
     current_block = entry_block = blocks[begin]
 
     for argtype in types.parameters
-        IR.push_argument!(entry_block, MLIRType(argtype), Location())
+        IR.push_argument!(entry_block, IR.Type(argtype))
     end
 
     function get_value(x)::Value
         if x isa Core.SSAValue
             @assert isassigned(values, x.id) "value $x was not assigned"
             values[x.id]
         elseif x isa Core.Argument
-            IR.get_argument(entry_block, x.n - 1)
+            IR.argument(entry_block, x.n - 1)
         elseif x isa BrutusScalar
-            IR.get_result(push!(current_block, arith.constant(;value=x)))
+            IR.result(push!(current_block, arith.constant(; value=x)))
         else
             error("could not use value $x inside MLIR")
         end
@@ -142,14 +143,14 @@ function code_mlir(f, types)
         for sidx in bb.stmts
             stmt = ir.stmts[sidx]
             inst = stmt[:inst]
-            line = ir.linetable[stmt[:line]]
+            line = ir.linetable[stmt[:line] + 1]
 
             if Meta.isexpr(inst, :call)
                 val_type = stmt[:type]
                 if !(val_type <: BrutusScalar)
                     error("type $val_type is not supported")
                 end
-                out_type = MLIRType(val_type)
+                out_type = IR.Type(val_type)
 
                 called_func = first(inst.args)
                 if called_func isa GlobalRef # TODO: should probably use something else here
@@ -160,11 +161,11 @@ function code_mlir(f, types)
                 args = get_value.(@view inst.args[begin+1:end])
 
                 location = Location(string(line.file), line.line, 0)
-                res = IR.get_result(fop!(current_block, args; location))
+                res = IR.result(fop!(current_block, args; location))
 
                 values[sidx] = res
             elseif inst isa PhiNode
-                values[sidx] = IR.get_argument(current_block, n_phi_nodes += 1)
+                values[sidx] = IR.argument(current_block, n_phi_nodes += 1)
             elseif inst isa PiNode
                 values[sidx] = get_value(inst.val)
             elseif inst isa GotoNode
@@ -185,7 +186,7 @@ function code_mlir(f, types)
                 cond_br = cf.cond_br(cond, true_args, false_args; trueDest=other_dest, falseDest=dest, location)
                 push!(current_block, cond_br)
             elseif inst isa ReturnNode
-                line = ir.linetable[stmt[:line]]
+                line = ir.linetable[stmt[:line]+1]
                 location = Location(string(line.file), line.line, 0)
                 push!(current_block, func.return_([get_value(inst.val)]; location))
             elseif Meta.isexpr(inst, :code_coverage_effect)
@@ -203,21 +204,19 @@ function code_mlir(f, types)
         push!(region, b)
     end
 
-    LLVM15 = LLVM.version() >= v"15"
-
-    input_types = MLIRType[
-        IR.get_type(IR.get_argument(entry_block, i))
-        for i in 1:IR.num_arguments(entry_block)
+    input_types = IR.Type[
+        IR.type(IR.argument(entry_block, i))
+        for i in 1:IR.nargs(entry_block)
     ]
-    result_types = [MLIRType(ret)]
+    result_types = [IR.Type(ret)]
 
-    ftype = MLIRType(input_types => result_types)
+    ftype = IR.FunctionType(input_types, result_types)
     op = IR.create_operation(
         "func.func",
         Location();
         attributes=[
-            NamedAttribute("sym_name", IR.Attribute(string(func_name))),
-            NamedAttribute("function_type", IR.Attribute(ftype)),
+            IR.NamedAttribute("sym_name", IR.Attribute(string(func_name))),
+            IR.NamedAttribute("function_type", IR.Attribute(ftype)),
         ],
         owned_regions=Region[region],
         result_inference=false,
@@ -277,7 +276,7 @@ fptr = IR.context!(IR.Context()) do
     op = Brutus.code_mlir(pow, Tuple{Int,Int})
 
     mod = IR.Module(Location())
-    body = IR.get_body(mod)
+    body = IR.body(mod)
     push!(body, op)
 
     pm = IR.PassManager()

diff --git a/src/Dialects.jl b/src/Dialects.jl
@@ -1,7 +1,7 @@
 module Dialects
 
 import LLVM
-import ..IR: Attribute, NamedAttribute, DenseArrayAttribute, context
+import ..IR: Attribute, NamedAttribute, context
 import ..API
 
 namedattribute(name, val) = namedattribute(name, Attribute(val))
@@ -11,13 +11,7 @@ function namedattribute(name, val::NamedAttribute)
     return val
 end
 
-operandsegmentsizes(segments) =
-    namedattribute("operand_segment_sizes",
-        LLVM.version() >= v"16" ?
-            DenseArrayAttribute(Int32.(segments)) :
-            Attribute(Int32.(segments))
-    )
-
+operandsegmentsizes(segments) = namedattribute("operand_segment_sizes", Attribute(Int32.(segments)))
 
 let
     ver = string(LLVM.version().major)