[WIP] New compiler driver interface

[mehrdad2m]

Context:

The compiler driver previously had limited flexibility regarding compiler passes, pipelines, and option management. There was also a need for a standalone command-line compiler tool to facilitate easier compilation and testing of MLIR files without python dependancy. Additionally, the handling of intermediate compiler outputs in the Python frontend was complex and needed simplification.

Description of the Change:

1. Refactored Compiler Driver:

• Updated CompilerOptions and related functions to accommodate new options and pipeline configurations.
• Enhanced the handling of compiler pipelines to allow for custom pipelines and better integration with MLIR’s pass management.

2. New Standalone Compiler Tool (qcc):

• qcc enables users to compile MLIR files from the command line.
• Ability to isolate different tools that are used in the compilation process (quantum-opt, mlir-translate, llc)

3. Improved Intermediate File Handling

• Changed the keepIntermediate option, allowing users to save intermediate IR after each pass or pipeline. Currently, this is only available via qcc and the python frontend is still unchanged, which can updated later.

4. Pipeline Configuration:

• Defined catalyst pipelines explicitly in Pipelines.h and Pipelines.cpp and also registered them as individual passes. Therefore, user can easily run an specific pipeline on an mlir file.

5. Removed self.last_compiler_output

• Modified the compiler to search the workspace directory for outputs which is inline with the keep_intermediate option.

Benefits:

1. Standalone executable to run the catalyst compilation pipeline without dependancy to python frontend
2. Easier Debugging capabilities
3. mlir options are directly accessible from qcc e.g.
   -mlir-print-ir-after-failure
   -mlir-print-ir-before-all
   -mlir-print-op-generic
   -mlir-timing
   -pass-pipeline
4. New options added for catalyst compiler e.g.
   -tool=[opt|translate|llc]
   -keep-intermediate=[true|false]
   -save-ir-after-each=[pass|pipeline]
   -catalyst-pipeline=pipeline1(pass1;pass2),pipeline2(pass3)

Possible Drawbacks:

Related GitHub Issues:

[sc-73536], [sc-73353]

[github-actions]

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md on your branch with:

• A one-to-two sentence description of the change. You may include a small working example for new features.
• A link back to this PR.
• Your name (or GitHub username) in the contributors section.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.96%. Comparing base (ea55348) to head (9663843).
Report is 7 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1208      +/-   ##
==========================================
+ Coverage   97.90%   97.96%   +0.06%     
==========================================
  Files          77       77              
  Lines       10932    11259     +327     
  Branches      967      971       +4     
==========================================
+ Hits        10703    11030     +327     
  Misses        180      180              
  Partials       49       49              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.