✨ Migration of MLIR project to the MQT Core project #848

BertiFlorea · 2025-03-04T14:15:47Z

Description

The purpose of this PR is to migrate the functionality of the MQT MLIR project to the MQT Core library. At the moment, the functionality is turned by default to OFF using the CMAKE building method.

if (BUILD_MQT_CORE_MLIR)
  add_subdirectory(mlir)
endif()

Checklist:

The pull request only contains commits that are related to it.
I have added appropriate tests and documentation.
I have made sure that all CI jobs on GitHub pass.
The pull request introduces no new warnings and follows the project's style guidelines.

codecov · 2025-03-04T14:20:36Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.3%. Comparing base (e1e4515) to head (551f789).
Report is 21 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##            main    #848     +/-   ##
=======================================
- Coverage   92.3%   92.3%   -0.1%     
=======================================
  Files        127     138     +11     
  Lines      13555   13664    +109     
  Branches    2086    2104     +18     
=======================================
+ Hits       12522   12622    +100     
- Misses      1033    1042      +9

Flag	Coverage Δ
cpp	`92.1% <ø> (-0.1%)`	⬇️
python	`99.7% <ø> (+<0.1%)`	⬆️

see 41 files with indirect coverage changes

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

github-advanced-security · 2025-03-10T19:57:28Z

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

burgholzer

Hey @BertiFlorea 👋🏼

Thanks for this initial draft for the migration. I just did a very quick and rough pass through the changes. Take everything with a grain of salt 😌

The biggest and most important step for this PR is to actually build the MLIR part of the project in CI and run the tests. Right now, it isn't doing any of that 😅

burgholzer · 2025-03-10T23:02:34Z

.github/workflows/mlirCI.yml

This can be stripped down considerably. Most of the configured CI workflows here are already running on in the main CI.yml.
You can definitely remove

- cpp-coverage - cpp-linter - python-tests - python-linter - code-ql - cd

I am actually pretty sure that we won't be able to use the reusable MQT workflows at first. Simply because they do not install LLVM, so the project won't build.

I'd rather propose to start small here and adapt https://github.com/cda-tum/mqt-workflows/blob/main/.github/workflows/reusable-cpp-tests-ubuntu.yml so that the project properly builds on Ubuntu. Let's take it from there.

burgholzer · 2025-03-10T23:03:19Z

.github/workflows/mlirCI.yml

+  push:
+    paths:
+      - "mlir/**"
+  pull_request:
+    paths:
+      - "mlir/**"


probably worth adding a workflow trigger here. so that we can manually start the workflow if necesary

burgholzer · 2025-03-10T23:04:50Z

.github/workflows/mlirCI.yml

This workflow is also missing a concurrency config

concurrency: group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} cancel-in-progress: true

so that in-progress jobs get cancelled when new ones are started.

burgholzer · 2025-03-10T23:05:27Z

mlir/CMakeLists.txt

+# set required cmake version
+cmake_minimum_required(VERSION 3.24...3.30)


can be removed as this is no longer the top level project

burgholzer · 2025-03-10T23:05:45Z

mlir/CMakeLists.txt

+set(CMAKE_CXX_STANDARD
+    17
+    CACHE STRING "C++ standard to conform to")


can be removed as this is no longer the top level project and this is already set in MQT Core

burgholzer · 2025-03-10T23:06:18Z

mlir/CMakeLists.txt

+# Add path for custom modules
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")


This will never add anything because there is no cmake directory here.
can be removed as this is no longer the top level project

burgholzer · 2025-03-10T23:07:34Z

mlir/CMakeLists.txt

+# check if this is the master project or used via add_subdirectory
+if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
+  set(MQT_MLIR_MASTER_PROJECT ON)
+else()
+  set(MQT_MLIR_MASTER_PROJECT OFF)
+endif()


This will always be FALSE in the current setup, which is also why the current CI runs build nothing.
MQT Core is the master project.
This can be removed.

burgholzer · 2025-03-10T23:09:25Z

mlir/CMakeLists.txt

+option(BUILD_MQT_MLIR_TESTS "Also build tests for the MQT MLIR project" ${MQT_MLIR_MASTER_PROJECT})
+option(BUILD_MLIR_DIALECT "Build the MQT MLIR dialect" ${MQT_MLIR_MASTER_PROJECT})
+
+if(BUILD_MLIR_DIALECT)
+  add_subdirectory(mlir)
+endif()


I'd argue that the BUILD_MLIR_DIALECT option can be removed as there already has been an opt-in for building the MLIR components of the project.
BUILD_MQT_MLIR_TESTS is probably also not necessary because we already have BUILD_MQT_CORE_TESTS and I think it is sufficient to simply use that.

burgholzer · 2025-03-10T23:11:14Z

mlir/README.md

I'd argue that this file can either be removed entirely or considerably stripped down and rewritten.

burgholzer · 2025-03-10T23:11:59Z

mlir/mlir/CMakeLists.txt

+if(BUILD_MQT_MLIR_TESTS)
+  enable_testing()
+  include(GoogleTest)
+  add_subdirectory(test)
+endif()


Just as a reminder that this will require adaptation

BertiFlorea added 2 commits March 4, 2025 14:57

✨ Added MLIR functionality to MQT Core project

a2c712b

🚩 disable mlir cmake option

a7784ce

BertiFlorea self-assigned this Mar 4, 2025

BertiFlorea added Core Anything related to the Core library and IR c++ Anything related to C++ code labels Mar 4, 2025

🎨 pre-commit fixes

2f75a52

burgholzer added MLIR Anything related to MLIR feature New feature or request minor Minor version update labels Mar 4, 2025

burgholzer added this to the MLIR Support milestone Mar 4, 2025

BertiFlorea and others added 4 commits March 4, 2025 15:37

🔥 Removed docker functionality used in the begging of the MLIR project

2f88fd7

💚 add MLIR CI configuration

e612aa1

⏪ revert changes to pre-commit configuration

dd75bfe

🎨 pre-commit fixes

551f789

BertiFlorea requested a review from burgholzer March 10, 2025 19:57

burgholzer requested changes Mar 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Migration of MLIR project to the MQT Core project #848

✨ Migration of MLIR project to the MQT Core project #848

BertiFlorea commented Mar 4, 2025

codecov bot commented Mar 4, 2025 •

edited

Loading

github-advanced-security bot commented Mar 10, 2025

burgholzer left a comment

burgholzer Mar 10, 2025

burgholzer Mar 10, 2025

burgholzer Mar 10, 2025

burgholzer Mar 10, 2025

burgholzer Mar 10, 2025

burgholzer Mar 10, 2025

burgholzer Mar 10, 2025

burgholzer Mar 10, 2025

burgholzer Mar 10, 2025

burgholzer Mar 10, 2025

		# set required cmake version
		cmake_minimum_required(VERSION 3.24...3.30)

		# Add path for custom modules
		list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")

✨ Migration of MLIR project to the MQT Core project #848

Are you sure you want to change the base?

✨ Migration of MLIR project to the MQT Core project #848

Conversation

BertiFlorea commented Mar 4, 2025

Description

Checklist:

codecov bot commented Mar 4, 2025 • edited Loading

Codecov Report

github-advanced-security bot commented Mar 10, 2025

burgholzer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Mar 4, 2025 •

edited

Loading