[mlir][python][cmake] Allows for specifying NB_DOMAIN in add_mlir_python_extension

[erwei-xilinx]

This PR allows the users to specify the NB_DOMAIN for add_mlir_python_extension. This allows users to avoid nanobind domain conflicts, when python bindings from multiple mlir projects were imported. (https://nanobind.readthedocs.io/en/latest/faq.html#how-can-i-avoid-conflicts-with-other-projects-using-nanobind)

[github-actions]

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

[llvmbot]

@llvm/pr-subscribers-mlir

Author: None (erwei-xilinx)

Changes

This PR allows the users to specify the NB_DOMAIN for add_mlir_python_extension. This allows users to avoid nanobind domain conflicts, when python bindings from multiple mlir projects were imported. (https://nanobind.readthedocs.io/en/latest/faq.html#how-can-i-avoid-conflicts-with-other-projects-using-nanobind)

---

Full diff: https://github.com/llvm/llvm-project/pull/122865.diff

1 Files Affected:

• (modified) mlir/cmake/modules/AddMLIRPython.cmake (+8-1)

diff --git a/mlir/cmake/modules/AddMLIRPython.cmake b/mlir/cmake/modules/AddMLIRPython.cmake
index 0679db9cf93e19..82a93c1a3c78c9 100644
--- a/mlir/cmake/modules/AddMLIRPython.cmake
+++ b/mlir/cmake/modules/AddMLIRPython.cmake
@@ -658,6 +658,13 @@ function(add_mlir_python_extension libname extname)
     set(eh_rtti_enable -frtti -fexceptions)
   endif ()
 
+  # Avoids domain conflict with nanobind by specifying NB_DOMAIN.
+  if(NB_DOMAIN)
+    set(_nb_domain ${NB_DOMAIN})
+  else()
+    set(_nb_domain "mlir")
+  endif ()
+
   # The actual extension library produces a shared-object or DLL and has
   # sources that must be compiled in accordance with pybind11 needs (RTTI and
   # exceptions).
@@ -667,7 +674,7 @@ function(add_mlir_python_extension libname extname)
     )
   elseif(ARG_PYTHON_BINDINGS_LIBRARY STREQUAL "nanobind")
     nanobind_add_module(${libname}
-      NB_DOMAIN mlir
+      NB_DOMAIN ${_nb_domain}
       FREE_THREADED
       ${ARG_SOURCES}
     )

[erwei-xilinx]

@makslevental

[makslevental]

I prefer if this were an argument to add_mlir_python_extension rather than a global but maybe a global is fine? @jpienaar @hawkinsp what do you guys think?

Edit: hmm I guess (duh) you need to expose this to downstream people that are just building the upstream extension without using add_mlir_python_extension explicitly. So on second thought @erwei-xilinx can you please promote this to a full global called MLIR_BINDINGS_PYTHON_NB_DOMAIN with something like

set(MLIR_BINDINGS_PYTHON_NB_DOMAIN "mlir" 
  CACHE STRING "nanobind domain for MLIR python bindings")

You can put it right by MLIR_BINDINGS_PYTHON here https://github.com/llvm/llvm-project/blob/main/mlir/CMakeLists.txt#L177

[erwei-xilinx]

I prefer if this were an argument to add_mlir_python_extension rather than a global but maybe a global is fine? @jpienaar @hawkinsp what do you guys think?

Edit: hmm I guess (duh) you need to expose this to downstream people that are just building the upstream extension without using add_mlir_python_extension explicitly. So on second thought @erwei-xilinx can you please promote this to a full global called MLIR_BINDINGS_PYTHON_NB_DOMAIN with something like

Sure, makes sense. PR updated. Thanks for the comment.