mlir/examples/standalone/README.md

   1 # An out-of-tree MLIR dialect
   2
   3 This is an example of an out-of-tree [MLIR](https://mlir.llvm.org/) dialect along with a standalone `opt`-like tool to operate on that dialect.
   4
   5 ## Building - Component Build
   6
   7 This setup assumes that you have built LLVM and MLIR in `$BUILD_DIR` and installed them to `$PREFIX`. To build and launch the tests, run
   8 ```sh
   9 mkdir build && cd build
  10 cmake -G Ninja .. -DMLIR_DIR=$PREFIX/lib/cmake/mlir -DLLVM_EXTERNAL_LIT=$BUILD_DIR/bin/llvm-lit
  11 cmake --build . --target check-standalone
  12 ```
  13 To build the documentation from the TableGen description of the dialect operations, run
  14 ```sh
  15 cmake --build . --target mlir-doc
  16 ```
  17 **Note**: Make sure to pass `-DLLVM_INSTALL_UTILS=ON` when building LLVM with CMake in order to install `FileCheck` to the chosen installation prefix.
  18
  19 ## Building - Monolithic Build
  20
  21 This setup assumes that you build the project as part of a monolithic LLVM build via the `LLVM_EXTERNAL_PROJECTS` mechanism.
  22 To build LLVM, MLIR, the example and launch the tests run
  23 ```sh
  24 mkdir build && cd build
  25 cmake -G Ninja `$LLVM_SRC_DIR/llvm` \
  26     -DCMAKE_BUILD_TYPE=Release \
  27     -DLLVM_TARGETS_TO_BUILD=host \
  28     -DLLVM_ENABLE_PROJECTS=mlir \
  29     -DLLVM_EXTERNAL_PROJECTS=standalone-dialect -DLLVM_EXTERNAL_STANDALONE_DIALECT_SOURCE_DIR=../
  30 cmake --build . --target check-standalone
  31 ```
  32 Here, `$LLVM_SRC_DIR` needs to point to the root of the monorepo.