[MLIR] add out of tree version of mlir-opt

[stephenneuendorffer]

Summary

This is primarily for testing libMLIR.so

[vchuravy]

This is good to have as a test, but I assume that eventually we would want to have the equivalent of LLVM_LINK_LLVM_DYLIB.

[stephenneuendorffer]

In D74867#1887477, @vchuravy wrote:

This is good to have as a test, but I assume that eventually we would want to have the equivalent of LLVM_LINK_LLVM_DYLIB.

I've gone back and forth. I think it's weird for the 'regular' mlir-opt to include the test dialect. I was thinking that the test dialect should run with a test-mlir-opt
which includes the test dialect in addition to all the normal dialects. (or maybe *only* the test dialect?)

[marbre]

This comment was removed by marbre.

[marbre]

Out of curiosity, no need to call define and registerTestPasses()? Further, calling registerAllDialects() and registerAllPasses() can be skipped? Is that due linking against libMLIR.so?

[stephenneuendorffer]

In D74867#1943837, @marbre wrote:

Out of curiosity, no need to call define and registerTestPasses()? Further, calling registerAllDialects() and registerAllPasses() can be skipped? Is that due linking against libMLIR.so?

No, this is just a little old. Currently, calling registerAllDialects() and registerAllPasses() is required if you want any of the standard stuff. The .cpp code was just a copy of what's in tools/mlir-opt. The critical part of this is the CMakeLists.txt, which was intended as a test for linking against libMLIR.so. If you actually want to build an external project see: https://reviews.llvm.org/D76047

[marbre]

In D74867#1944069, @stephenneuendorffer wrote:

No, this is just a little old. Currently, calling registerAllDialects() and registerAllPasses() is required if you want any of the standard stuff. The .cpp code was just a copy of what's in tools/mlir-opt. The critical part of this is the CMakeLists.txt, which was intended as a test for linking against libMLIR.so. If you actually want to build an external project see: https://reviews.llvm.org/D76047

Thanks for clarifying. I was just surprised and thought I might have missed something. I actually forked the mlir-opt for IREE.

[stephenneuendorffer]

There's now an example of how to build your own opt in Examples/standalone.

mlir/test/CMakeLists.txt

 add_subdirectory(Dialect)
 add_subdirectory(EDSC)
 add_subdirectory(mlir-cpu-runner)
 add_subdirectory(SDBM)
 add_subdirectory(lib)
+add_subdirectory(OutOfTree/mlir-opt)
 
 llvm_canonicalize_cmake_booleans(
   LLVM_BUILD_EXAMPLES
   )
 
 # Passed to lit.site.cfg.py.in to set up the path where to find the libraries
 # for linalg integration tests.
 set(MLIR_DIALECT_LINALG_INTEGRATION_TEST_LIB_DIR ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})

mlir/test/OutOfTree/mlir-opt/CMakeLists.txt

+if(LLVM_LINK_LLVM_DYLIB)
+add_executable(mlir-opt-test
+  mlir-opt.cpp
+  )
+target_link_libraries(mlir-opt-test MLIR LLVM)
+llvm_update_compile_flags(mlir-opt-test)
+endif()
+
+# set(LLVM_OPTIONAL_SOURCES
+#   null.cpp
+# )
+
+# set(LIB_LIBS
+#   MLIRAnalysis
+#   MLIRLLVMIR
+#   MLIROptMain
+#   MLIRParser
+#   MLIRPass
+#   MLIRTransforms
+#   MLIRSupport
+# )
+# add_llvm_library(MLIRMlirOptLib BUILDTREE_ONLY
+#   mlir-opt.cpp
+#   LINK_LIBS ${LIB_LIBS}
+# )
+
+# set(LIBS
+#   MLIRAnalysis
+#   MLIRAffineOps
+#   MLIRAffineToStandard
+#   MLIRLoopsToGPU
+#   MLIRLinalgToLLVM
+
+#   MLIRLoopToStandard
+#   MLIREDSC
+#   MLIRFxpMathOps
+#   MLIRGPU
+#   MLIRGPUtoNVVMTransforms
+#   MLIRGPUtoROCDLTransforms
+#   MLIRGPUtoSPIRVTransforms
+#   MLIRLinalg
+#   MLIRLLVMIR
+#   MLIRLoopOps
+#   MLIRNVVMIR
+#   MLIROptMain
+#   MLIRParser
+#   MLIRPass
+#   MLIRQuantizerTransforms
+#   MLIRQuantOps
+#   MLIRROCDLIR
+#   MLIRSPIRV
+#   MLIRStandardToSPIRVTransforms
+#   MLIRSPIRVTransforms
+#   MLIRStandardOps
+#   MLIRStandardToLLVM
+#   MLIRTransforms
+#   MLIRTestDialect
+#   MLIRTestIR
+#   MLIRTestPass
+#   MLIRTestTransforms
+#   MLIRSupport
+#   MLIRVectorOps
+#   MLIRVectorToLLVM
+#   MLIRVectorToLoops
+# )
+# if(MLIR_CUDA_CONVERSIONS_ENABLED)
+#   list(APPEND LIBS
+#     MLIRGPUtoCUDATransforms
+#   )
+# endif()
+# add_llvm_tool(mlir-opt
+#  mlir-opt.cpp
+# )
+# llvm_update_compile_flags(mlir-opt)
+# whole_archive_link(mlir-opt ${LIBS})
+# target_link_libraries(mlir-opt PRIVATE MLIRIR MLIROptMain MLIRMlirOptLib ${LIBS} LLVMSupport)

mlir/test/OutOfTree/mlir-opt/mlir-opt.cpp

+//===- mlir-opt.cpp - MLIR Optimizer Driver -------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// Main entry function for mlir-opt for when built as standalone binary.
+//
+//===----------------------------------------------------------------------===//
+
+#include "mlir/Analysis/Passes.h"
+#include "mlir/IR/Dialect.h"
+#include "mlir/IR/MLIRContext.h"
+#include "mlir/Pass/Pass.h"
+#include "mlir/Pass/PassManager.h"
+#include "mlir/Support/FileUtilities.h"
+#include "mlir/Support/MlirOptMain.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/InitLLVM.h"
+#include "llvm/Support/SourceMgr.h"
+#include "llvm/Support/ToolOutputFile.h"
+
+using namespace llvm;
+using namespace mlir;
+
+static cl::opt<std::string>
+    inputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"));
+
+static cl::opt<std::string> outputFilename("o", cl::desc("Output filename"),
+                                           cl::value_desc("filename"),
+                                           cl::init("-"));
+
+static cl::opt<bool>
+    splitInputFile("split-input-file",
+                   cl::desc("Split the input file into pieces and process each "
+                            "chunk independently"),
+                   cl::init(false));
+
+static cl::opt<bool>
+    verifyDiagnostics("verify-diagnostics",
+                      cl::desc("Check that emitted diagnostics match "
+                               "expected-* lines on the corresponding line"),
+                      cl::init(false));
+
+static cl::opt<bool>
+    verifyPasses("verify-each",
+                 cl::desc("Run the verifier after each transformation pass"),
+                 cl::init(true));
+
+static cl::opt<bool>
+    showDialects("show-dialects",
+                 cl::desc("Print the list of registered dialects"),
+                 cl::init(false));
+
+int main(int argc, char **argv) {
+  InitLLVM y(argc, argv);
+
+  // Register any pass manager command line options.
+  registerPassManagerCLOptions();
+  PassPipelineCLParser passPipeline("", "Compiler passes to run");
+
+  // Parse pass names in main to ensure static initialization completed.
+  cl::ParseCommandLineOptions(argc, argv, "MLIR modular optimizer driver\n");
+
+  MLIRContext context;
+  if(showDialects) {
+    llvm::outs() << "Registered Dialects:\n";
+    for(Dialect *dialect : context.getRegisteredDialects()) {
+      llvm::outs() << dialect->getNamespace() << "\n";
+    }
+    return 0;
+  }
+
+  // Set up the input file.
+  std::string errorMessage;
+  auto file = openInputFile(inputFilename, &errorMessage);
+  if (!file) {
+    llvm::errs() << errorMessage << "\n";
+    return 1;
+  }
+
+  auto output = openOutputFile(outputFilename, &errorMessage);
+  if (!output) {
+    llvm::errs() << errorMessage << "\n";
+    exit(1);
+  }
+
+  return failed(MlirOptMain(output->os(), std::move(file), passPipeline,
+                            splitInputFile, verifyDiagnostics, verifyPasses));
+}