[all-commits] [llvm/llvm-project] 5e83a5: [mlir] Overhaul C/Python registration APIs to prop...

Sat Jul 16 17:28:13 PDT 2022

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 5e83a5b4752da6631d79c446f21e5d128b5c5495
      https://github.com/llvm/llvm-project/commit/5e83a5b4752da6631d79c446f21e5d128b5c5495
  Author: Stella Laurenzo <stellaraccident at gmail.com>
  Date:   2022-07-16 (Sat, 16 Jul 2022)

  Changed paths:
    M mlir/examples/standalone/include/Standalone-c/Dialects.h
    M mlir/examples/standalone/python/CMakeLists.txt
    M mlir/examples/standalone/test/CAPI/CMakeLists.txt
    M mlir/examples/standalone/test/CAPI/standalone-capi-test.c
    M mlir/include/mlir-c/Bindings/Python/Interop.h
    M mlir/include/mlir-c/Dialect/Async.h
    M mlir/include/mlir-c/Dialect/ControlFlow.h
    M mlir/include/mlir-c/Dialect/Func.h
    M mlir/include/mlir-c/Dialect/GPU.h
    M mlir/include/mlir-c/Dialect/LLVM.h
    M mlir/include/mlir-c/Dialect/Linalg.h
    M mlir/include/mlir-c/Dialect/PDL.h
    M mlir/include/mlir-c/Dialect/Quant.h
    M mlir/include/mlir-c/Dialect/SCF.h
    M mlir/include/mlir-c/Dialect/Shape.h
    M mlir/include/mlir-c/Dialect/SparseTensor.h
    M mlir/include/mlir-c/Dialect/Tensor.h
    M mlir/include/mlir-c/IR.h
    M mlir/include/mlir-c/Pass.h
    A mlir/include/mlir-c/RegisterEverything.h
    R mlir/include/mlir-c/Registration.h
    M mlir/include/mlir/Bindings/Python/PybindAdaptors.h
    M mlir/include/mlir/CAPI/Registration.h
    R mlir/lib/Bindings/Python/AllPassesRegistration.cpp
    R mlir/lib/Bindings/Python/Conversions/Conversions.cpp
    M mlir/lib/Bindings/Python/IRCore.cpp
    M mlir/lib/Bindings/Python/IRModule.h
    A mlir/lib/Bindings/Python/RegisterEverything.cpp
    R mlir/lib/Bindings/Python/Transforms/Transforms.cpp
    M mlir/lib/CAPI/CMakeLists.txt
    M mlir/lib/CAPI/Conversion/CMakeLists.txt
    M mlir/lib/CAPI/IR/IR.cpp
    A mlir/lib/CAPI/RegisterEverything/CMakeLists.txt
    A mlir/lib/CAPI/RegisterEverything/RegisterEverything.cpp
    R mlir/lib/CAPI/Registration/CMakeLists.txt
    R mlir/lib/CAPI/Registration/Registration.cpp
    M mlir/python/CMakeLists.txt
    M mlir/python/mlir/_mlir_libs/__init__.py
    M mlir/python/mlir/_mlir_libs/_mlir/ir.pyi
    R mlir/python/mlir/all_passes_registration/__init__.py
    R mlir/python/mlir/conversions/__init__.py
    R mlir/python/mlir/transforms/__init__.py
    M mlir/test/CAPI/CMakeLists.txt
    M mlir/test/CAPI/execution_engine.c
    M mlir/test/CAPI/ir.c
    M mlir/test/CAPI/pass.c
    M mlir/test/CAPI/sparse_tensor.c
    M mlir/test/python/execution_engine.py
    M mlir/test/python/integration/dialects/linalg/opsrun.py
    M mlir/test/python/lib/CMakeLists.txt
    M mlir/test/python/lib/PythonTestCAPI.h
    M mlir/test/python/pass_manager.py
    M utils/bazel/llvm-project-overlay/mlir/BUILD.bazel
    M utils/bazel/llvm-project-overlay/mlir/python/BUILD.bazel

  Log Message:
  -----------
  [mlir] Overhaul C/Python registration APIs to properly scope registration/loading activities.

Since the very first commits, the Python and C MLIR APIs have had mis-placed registration/load functionality for dialects, extensions, etc. This was done pragmatically in order to get bootstrapped and then just grew in. Downstreams largely bypass and do their own thing by providing various APIs to register things they need. Meanwhile, the C++ APIs have stabilized around this and it would make sense to follow suit.

The thing we have observed in canonical usage by downstreams is that each downstream tends to have native entry points that configure its installation to its preferences with one-stop APIs. This patch leans in to this approach with `RegisterEverything.h` and `mlir._mlir_libs._mlirRegisterEverything` being the one-stop entry points for the "upstream packages". The `_mlir_libs.__init__.py` now allows customization of the environment and Context by adding "initialization modules" to the `_mlir_libs` package. If present, `_mlirRegisterEverything` is treated as such a module. Others can be added by downstreams by adding a `_site_initialize_{i}.py` module, where '{i}' is a number starting with zero. The number will be incremented and corresponding module loaded until one is not found. Initialization modules can:

* Perform load time customization to the global environment (i.e. registering passes, hooks, etc).
* Define a `register_dialects(registry: DialectRegistry)` function that can extend the `DialectRegistry` that will be used to bootstrap the `Context`.
* Define a `context_init_hook(context: Context)` function that will be added to a list of callbacks which will be invoked after dialect registration during `Context` initialization.

Note that the `MLIRPythonExtension.RegisterEverything` is not included by default when building a downstream (its corresponding behavior was prior). For downstreams which need the default MLIR initialization to take place, they must add this back in to their Python CMake build just like they add their own components (i.e. to `add_mlir_python_common_capi_library` and `add_mlir_python_modules`). It is perfectly valid to not do this, in which case, only the things explicitly depended on and initialized by downstreams will be built/packaged. If the downstream has not been set up for this, it is recommended to simply add this back for the time being and pay the build time/package size cost.

CMake changes:
* `MLIRCAPIRegistration` -> `MLIRCAPIRegisterEverything` (renamed to signify what it does and force an evaluation: a number of places were incidentally linking this very expensive target)
* `MLIRPythonSoure.Passes` removed (without replacement: just drop)
* `MLIRPythonExtension.AllPassesRegistration` removed (without replacement: just drop)
* `MLIRPythonExtension.Conversions` removed (without replacement: just drop)
* `MLIRPythonExtension.Transforms` removed (without replacement: just drop)

Header changes:
* `mlir-c/Registration.h` is deleted. Dialect registration functionality is now in `IR.h`. Registration of upstream features are in `mlir-c/RegisterEverything.h`. When updating MLIR and a couple of downstreams, I found that proper usage was commingled so required making a choice vs just blind S&R.

Python APIs removed:
  * mlir.transforms and mlir.conversions (previously only had an __init__.py which indirectly triggered `mlirRegisterTransformsPasses()` and `mlirRegisterConversionPasses()` respectively). Downstream impact: Remove these imports if present (they now happen as part of default initialization).
  * mlir._mlir_libs._all_passes_registration, mlir._mlir_libs._mlirTransforms, mlir._mlir_libs._mlirConversions. Downstream impact: None expected (these were internally used).

C-APIs changed:
  * mlirRegisterAllDialects(MlirContext) now takes an MlirDialectRegistry instead. It also used to trigger loading of all dialects, which was already marked with a TODO to remove -- it no longer does, and for direct use, dialects must be explicitly loaded. Downstream impact: Direct C-API users must ensure that needed dialects are loaded or call `mlirContextLoadAllAvailableDialects(MlirContext)` to emulate the prior behavior. Also see the `ir.c` test case (e.g. `  mlirContextGetOrLoadDialect(ctx, mlirStringRefCreateFromCString("func"));`).
  * mlirDialectHandle* APIs were moved from Registration.h (which now is restricted to just global/upstream registration) to IR.h, arguably where it should have been. Downstream impact: include correct header (likely already doing so).

C-APIs added:
  * mlirContextLoadAllAvailableDialects(MlirContext): Corresponds to C++ API with the same purpose.

Python APIs added:
  * mlir.ir.DialectRegistry: Mapping for an MlirDialectRegistry.
  * mlir.ir.Context.append_dialect_registry(MlirDialectRegistry)
  * mlir.ir.Context.load_all_available_dialects()
  * mlir._mlir_libs._mlirAllRegistration: New native extension that exposes a `register_dialects(MlirDialectRegistry)` entry point and performs all upstream pass/conversion/transforms registration on init. In this first step, we eagerly load this as part of the __init__.py and use it to monkey patch the Context to emulate prior behavior.
  * Type caster and capsule support for MlirDialectRegistry

This should make it possible to build downstream Python dialects that only depend on a subset of MLIR. See: https://github.com/llvm/llvm-project/issues/56037

Here is an example PR, minimally adapting IREE to these changes: https://github.com/iree-org/iree/pull/9638/files In this situation, IREE is opting to not link everything, since it is already configuring the Context to its liking. For projects that would just like to not think about it and pull in everything, add `MLIRPythonExtension.RegisterEverything` to the list of Python sources getting built, and the old behavior will continue.

Reviewed By: mehdi_amini, ftynse

Differential Revision: https://reviews.llvm.org/D128593