Add error category QSSUnsupportedQASM3

include/API/errors.h

@@ -48,6 +48,7 @@ enum class ErrorCategory {
   QSSLinkInvalidPatchTypeError,
   QSSControlSystemResourcesExceeded,
   QSSTargetUnsupportedOperation,
+  QSSUnsupportedQASM3,
   UncategorizedError,
 };
 

lib/API/api.cpp

@@ -347,7 +347,7 @@ void diagEngineHandler(mlir::Diagnostic &diagnostic,
   // emit diagnostic cast to void to discard result as it is not needed here
   if (qssc_severity == qssc::Severity::Error) {
     (void)qssc::emitDiagnostic(diagnosticCb, qssc_severity,
-                               qssc::ErrorCategory::QSSCompilationFailure,
+                               qssc::ErrorCategory::QSSUnsupportedQASM3,
                                diagnostic.str());
   }
 

lib/API/errors.cpp

@@ -85,6 +85,9 @@ std::string_view getErrorCategoryAsString(qssc::ErrorCategory category) {
   case ErrorCategory::QSSTargetUnsupportedOperation:
     return "An unsupported operation on a target was used";
 
+  case ErrorCategory::QSSUnsupportedQASM3:
+    return "The provided QASM3 is not supported by the compiler";
+
   case ErrorCategory::UncategorizedError:
     return "Compilation failure";
   }

python_lib/qss_compiler/compile.py

@@ -316,6 +316,12 @@ def compile(self) -> Union[bytes, str, None]:
                         diagnostics,
                         return_diagnostics=self.return_diagnostics,
                     )
+                if diag.category == ErrorCategory.QSSUnsupportedQASM3:
+                    raise exceptions.QSSUnsupportedQASM3(
+                        diag.message,
+                        diagnostics,
+                        return_diagnostics=self.return_diagnostics,
+                    )
 
             if not success:
                 raise exceptions.QSSCompilationFailure(

python_lib/qss_compiler/exceptions.py

@@ -123,3 +123,7 @@ class QSSTargetUnsupportedOperation(QSSCompilerError):
 
 class OpenQASM3ParseFailure(QSSCompilerError):
     """Raised when a parser failure is received"""
+
+
+class QSSUnsupportedQASM3(QSSCompilerError):
+    """Raised when an unsupported QASM3 is received."""

python_lib/qss_compiler/lib_enums.cpp

@@ -45,6 +45,7 @@ void addErrorCategory(py::module &m) {
              qssc::ErrorCategory::QSSControlSystemResourcesExceeded)
       .value("QSSTargetUnsupportedOperation",
              qssc::ErrorCategory::QSSTargetUnsupportedOperation)
+      .value("QSSUnsupportedQASM3", qssc::ErrorCategory::QSSUnsupportedQASM3)
       .value("UncategorizedError", qssc::ErrorCategory::UncategorizedError)
       .export_values();
 }

releasenotes/notes/soo-ER-add-QSSUnsupportedQASM3-5f32fb45a26a7d8d.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Added ``QSSUnsupportedQASM3`` error category for the cases which
+    fail to generate MLIR from the QUIRGen. These errors used to be
+    categorized under ``QSSCompilationFailure``.

targets/systems/mock/test/python_lib/test_compile_mock.py

@@ -29,7 +29,7 @@
     OutputType,
     CompileOptions,
 )
-from qss_compiler.exceptions import QSSCompilationFailure
+from qss_compiler.exceptions import QSSUnsupportedQASM3
 
 compiler_extra_args = ["--enable-circuits=false"]
 
@@ -136,7 +136,7 @@ def test_compile_failing_str_to_qem(
     """Test that compiling an invalid OpenQASM3 string via the interface
     compile_str to a QEM payload will fail and result in an empty payload."""
 
-    with pytest.raises(QSSCompilationFailure):
+    with pytest.raises(QSSUnsupportedQASM3):
         compile_str(
             example_unsupported_qasm3_str,
             input_type=InputType.QASM3,
@@ -154,7 +154,7 @@ def test_compile_failing_file_to_qem(
     """Test that compiling an invalid file input via the interface compile_file
     to a QEM payload will fail and result in an empty payload."""
 
-    with pytest.raises(QSSCompilationFailure):
+    with pytest.raises(QSSUnsupportedQASM3):
         compile_file(
             example_unsupported_qasm3_tmpfile,
             input_type=InputType.QASM3,