[Backport 3.8] Control systems resources exceeded

include/API/errors.h

@@ -44,6 +44,7 @@ enum class ErrorCategory {
   QSSLinkSignatureNotFound,
   QSSLinkArgumentNotFoundWarning,
   QSSLinkInvalidPatchTypeError,
+  QSSControlSystemResourcesExceeded,
   UncategorizedError,
 };
 

lib/API/errors.cpp

@@ -71,6 +71,9 @@ static std::string_view getErrorCategoryAsString(ErrorCategory category) {
   case ErrorCategory::QSSLinkInvalidPatchTypeError:
     return "Invalid patch point type";
 
+  case ErrorCategory::QSSControlSystemResourcesExceeded:
+    return "Control system resources exceeded";
+
   case ErrorCategory::UncategorizedError:
     return "Compilation failure";
   }

python_lib/qss_compiler/compile.py

@@ -305,6 +305,14 @@ def _do_compile(
                     return_diagnostics=return_diagnostics,
                 )
 
+        for diag in diagnostics:
+            if diag.category == ErrorCategory.QSSControlSystemResourcesExceeded:
+                raise exceptions.QSSControlSystemResourcesExceeded(
+                    diag.message,
+                    diagnostics,
+                    return_diagnostics=self.return_diagnostics,
+                )
+
         if not success:
             raise exceptions.QSSCompilationFailure(
                 "Failure during compilation",

python_lib/qss_compiler/exceptions.py

@@ -109,5 +109,9 @@ class QSSLinkInvalidArgumentError(QSSLinkingFailure):
     """Raised when argument is invalid"""
 
 
+class QSSControlSystemResourcesExceeded(QSSCompilerError):
+    """Raised when control system resources (such as instruction memory) are exceeded."""
+
+
 class OpenQASM3ParseFailure(QSSCompilerError):
     """Raised when a parser failure is received"""

python_lib/qss_compiler/lib_enums.cpp

@@ -4,24 +4,37 @@
 namespace py = pybind11;
 
 void addErrorCategory(py::module &m) {
-    py::enum_<qssc::ErrorCategory>(m, "ErrorCategory", py::arithmetic())
-        .value("OpenQASM3ParseFailure",
-                qssc::ErrorCategory::OpenQASM3ParseFailure)
-        .value("QSSCompilerError", qssc::ErrorCategory::QSSCompilerError)
-        .value("QSSCompilerNoInputError", qssc::ErrorCategory::QSSCompilerNoInputError)
-        .value("QSSCompilerCommunicationFailure", qssc::ErrorCategory::QSSCompilerCommunicationFailure)
-        .value("QSSCompilerEOFFailure", qssc::ErrorCategory::QSSCompilerEOFFailure)
-        .value("QSSCompilerNonZeroStatus", qssc::ErrorCategory::QSSCompilerNonZeroStatus)
-        .value("QSSCompilationFailure", qssc::ErrorCategory::QSSCompilationFailure)
-        .value("QSSLinkerNotImplemented", qssc::ErrorCategory::QSSLinkerNotImplemented)
-        .value("QSSLinkSignatureWarning", qssc::ErrorCategory::QSSLinkSignatureWarning)
-        .value("QSSLinkSignatureError", qssc::ErrorCategory::QSSLinkSignatureError)
-        .value("QSSLinkAddressError", qssc::ErrorCategory::QSSLinkAddressError)
-        .value("QSSLinkSignatureNotFound", qssc::ErrorCategory::QSSLinkSignatureNotFound)
-        .value("QSSLinkArgumentNotFoundWarning", qssc::ErrorCategory::QSSLinkArgumentNotFoundWarning)
-        .value("QSSLinkInvalidPatchTypeError", qssc::ErrorCategory::QSSLinkInvalidPatchTypeError)
-        .value("UncategorizedError", qssc::ErrorCategory::UncategorizedError)
-        .export_values();
+  py::enum_<qssc::ErrorCategory>(m, "ErrorCategory", py::arithmetic())
+      .value("OpenQASM3ParseFailure",
+             qssc::ErrorCategory::OpenQASM3ParseFailure)
+      .value("QSSCompilerError", qssc::ErrorCategory::QSSCompilerError)
+      .value("QSSCompilerNoInputError",
+             qssc::ErrorCategory::QSSCompilerNoInputError)
+      .value("QSSCompilerCommunicationFailure",
+             qssc::ErrorCategory::QSSCompilerCommunicationFailure)
+      .value("QSSCompilerEOFFailure",
+             qssc::ErrorCategory::QSSCompilerEOFFailure)
+      .value("QSSCompilerNonZeroStatus",
+             qssc::ErrorCategory::QSSCompilerNonZeroStatus)
+      .value("QSSCompilationFailure",
+             qssc::ErrorCategory::QSSCompilationFailure)
+      .value("QSSLinkerNotImplemented",
+             qssc::ErrorCategory::QSSLinkerNotImplemented)
+      .value("QSSLinkSignatureWarning",
+             qssc::ErrorCategory::QSSLinkSignatureWarning)
+      .value("QSSLinkSignatureError",
+             qssc::ErrorCategory::QSSLinkSignatureError)
+      .value("QSSLinkAddressError", qssc::ErrorCategory::QSSLinkAddressError)
+      .value("QSSLinkSignatureNotFound",
+             qssc::ErrorCategory::QSSLinkSignatureNotFound)
+      .value("QSSLinkArgumentNotFoundWarning",
+             qssc::ErrorCategory::QSSLinkArgumentNotFoundWarning)
+      .value("QSSLinkInvalidPatchTypeError",
+             qssc::ErrorCategory::QSSLinkInvalidPatchTypeError)
+      .value("QSSControlSystemResourcesExceeded",
+             qssc::ErrorCategory::QSSControlSystemResourcesExceeded)
+      .value("UncategorizedError", qssc::ErrorCategory::UncategorizedError)
+      .export_values();
 }
 
 void addSeverity(py::module &m) {

releasenotes/notes/control-system-resources-exceeded-error-d2a2c15c52fa02dd.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    A new QSSControlSystemResourcesExceeded error has been added as an error
+    category. This can be raised as an error whenever the compiler detects that
+    an input circuit will exceed the capabilities of the control system.