[Offload] Don't partition error code enum into categories

RossBrunton · RossBrunton · commit 5850cb9ec404 · 2025-05-05T11:18:49.000+01:00
diff --git a/offload/liboffload/API/APIDefs.td b/offload/liboffload/API/APIDefs.td
@@ -152,10 +152,9 @@ class Function : APIObject {
         AddHandleChecksToReturns<params, returns_with_def>.returns_out>.returns_out;
 }
 
-class Etor<string Name, string Desc, int Value=-1> {
+class Etor<string Name, string Desc> {
   string name = Name;
   string desc = Desc;
-  int value = Value;
   string tagged_type;
 }
 
diff --git a/offload/liboffload/API/Common.td b/offload/liboffload/API/Common.td
@@ -87,26 +87,25 @@ def ErrorCode : Enum {
   let name = "ol_errc_t";
   let desc = "Defines Return/Error codes";
   let etors =[
-    Etor<"SUCCESS", "Success", 0>,
+    Etor<"SUCCESS", "Success">,
 
     // Universal errors
+    Etor<"UNKNOWN", "Unknown or internal error">,
     Etor<"INVALID_NULL_POINTER", "A pointer argument is null when it should not be">,
     Etor<"INVALID_ARGUMENT", "An argument is invalid">,
     Etor<"OUT_OF_RESOURCES", "Out of resources">,
     Etor<"UNSUPPORTED", "generic error code for unsupported features and enums">,
+    Etor<"INVALID_SIZE", "invalid size or dimensions (e.g., must not be zero, or is out of bounds)">,
+    Etor<"INVALID_ENUMERATION", "enumerator argument is not valid">,
+    Etor<"INVALID_KERNEL_NAME", "Named kernel not found in the program binary">,
 
-    // Liboffload specific errors
-    Etor<"INVALID_VALUE", "Invalid Value", 0x1000>,
+    // Handle related errors - only makes sense for liboffload
+    Etor<"INVALID_VALUE", "Invalid Value">,
     Etor<"INVALID_PLATFORM", "Invalid platform">,
     Etor<"INVALID_DEVICE", "Invalid device">,
     Etor<"INVALID_QUEUE", "Invalid queue">,
     Etor<"INVALID_EVENT", "Invalid event">,
-    Etor<"INVALID_KERNEL_NAME", "Named kernel not found in the program binary">,
-    Etor<"INVALID_NULL_HANDLE", "handle argument is not valid">,
-    Etor<"INVALID_SIZE", "invalid size or dimensions (e.g., must not be zero, or is out of bounds)">,
-    Etor<"INVALID_ENUMERATION", "enumerator argument is not valid">,
-
-    Etor<"UNKNOWN", "Unknown or internal error", 0x10000>
+    Etor<"INVALID_NULL_HANDLE", "handle argument is not valid">
   ];
 }
 
diff --git a/offload/liboffload/include/generated/OffloadAPI.h b/offload/liboffload/include/generated/OffloadAPI.h
@@ -22,34 +22,34 @@ extern "C" {
 typedef enum ol_errc_t {
   /// Success
   OL_ERRC_SUCCESS = 0,
+  /// Unknown or internal error
+  OL_ERRC_UNKNOWN = 1,
   /// A pointer argument is null when it should not be
-  OL_ERRC_INVALID_NULL_POINTER = 1,
+  OL_ERRC_INVALID_NULL_POINTER = 2,
   /// An argument is invalid
-  OL_ERRC_INVALID_ARGUMENT = 2,
+  OL_ERRC_INVALID_ARGUMENT = 3,
   /// Out of resources
-  OL_ERRC_OUT_OF_RESOURCES = 3,
+  OL_ERRC_OUT_OF_RESOURCES = 4,
   /// generic error code for unsupported features and enums
-  OL_ERRC_UNSUPPORTED = 4,
+  OL_ERRC_UNSUPPORTED = 5,
+  /// invalid size or dimensions (e.g., must not be zero, or is out of bounds)
+  OL_ERRC_INVALID_SIZE = 6,
+  /// enumerator argument is not valid
+  OL_ERRC_INVALID_ENUMERATION = 7,
+  /// Named kernel not found in the program binary
+  OL_ERRC_INVALID_KERNEL_NAME = 8,
   /// Invalid Value
-  OL_ERRC_INVALID_VALUE = 4096,
+  OL_ERRC_INVALID_VALUE = 9,
   /// Invalid platform
-  OL_ERRC_INVALID_PLATFORM = 4097,
+  OL_ERRC_INVALID_PLATFORM = 10,
   /// Invalid device
-  OL_ERRC_INVALID_DEVICE = 4098,
+  OL_ERRC_INVALID_DEVICE = 11,
   /// Invalid queue
-  OL_ERRC_INVALID_QUEUE = 4099,
+  OL_ERRC_INVALID_QUEUE = 12,
   /// Invalid event
-  OL_ERRC_INVALID_EVENT = 4100,
-  /// Named kernel not found in the program binary
-  OL_ERRC_INVALID_KERNEL_NAME = 4101,
+  OL_ERRC_INVALID_EVENT = 13,
   /// handle argument is not valid
-  OL_ERRC_INVALID_NULL_HANDLE = 4102,
-  /// invalid size or dimensions (e.g., must not be zero, or is out of bounds)
-  OL_ERRC_INVALID_SIZE = 4103,
-  /// enumerator argument is not valid
-  OL_ERRC_INVALID_ENUMERATION = 4104,
-  /// Unknown or internal error
-  OL_ERRC_UNKNOWN = 65536,
+  OL_ERRC_INVALID_NULL_HANDLE = 14,
   /// @cond
   OL_ERRC_FORCE_UINT32 = 0x7fffffff
   /// @endcond
diff --git a/offload/liboffload/include/generated/OffloadPrint.hpp b/offload/liboffload/include/generated/OffloadPrint.hpp
@@ -49,6 +49,9 @@ inline llvm::raw_ostream &operator<<(llvm::raw_ostream &os,
   case OL_ERRC_SUCCESS:
     os << "OL_ERRC_SUCCESS";
     break;
+  case OL_ERRC_UNKNOWN:
+    os << "OL_ERRC_UNKNOWN";
+    break;
   case OL_ERRC_INVALID_NULL_POINTER:
     os << "OL_ERRC_INVALID_NULL_POINTER";
     break;
@@ -61,6 +64,15 @@ inline llvm::raw_ostream &operator<<(llvm::raw_ostream &os,
   case OL_ERRC_UNSUPPORTED:
     os << "OL_ERRC_UNSUPPORTED";
     break;
+  case OL_ERRC_INVALID_SIZE:
+    os << "OL_ERRC_INVALID_SIZE";
+    break;
+  case OL_ERRC_INVALID_ENUMERATION:
+    os << "OL_ERRC_INVALID_ENUMERATION";
+    break;
+  case OL_ERRC_INVALID_KERNEL_NAME:
+    os << "OL_ERRC_INVALID_KERNEL_NAME";
+    break;
   case OL_ERRC_INVALID_VALUE:
     os << "OL_ERRC_INVALID_VALUE";
     break;
@@ -76,21 +88,9 @@ inline llvm::raw_ostream &operator<<(llvm::raw_ostream &os,
   case OL_ERRC_INVALID_EVENT:
     os << "OL_ERRC_INVALID_EVENT";
     break;
-  case OL_ERRC_INVALID_KERNEL_NAME:
-    os << "OL_ERRC_INVALID_KERNEL_NAME";
-    break;
   case OL_ERRC_INVALID_NULL_HANDLE:
     os << "OL_ERRC_INVALID_NULL_HANDLE";
     break;
-  case OL_ERRC_INVALID_SIZE:
-    os << "OL_ERRC_INVALID_SIZE";
-    break;
-  case OL_ERRC_INVALID_ENUMERATION:
-    os << "OL_ERRC_INVALID_ENUMERATION";
-    break;
-  case OL_ERRC_UNKNOWN:
-    os << "OL_ERRC_UNKNOWN";
-    break;
   default:
     os << "unknown enumerator";
     break;
diff --git a/offload/plugins-nextgen/common/include/OffloadErrcodes.inc b/offload/plugins-nextgen/common/include/OffloadErrcodes.inc
@@ -15,23 +15,23 @@
 // the GenerateOffload target.
 
 OFFLOAD_ERRC(SUCCESS, "Success", 0)
+OFFLOAD_ERRC(UNKNOWN, "Unknown or internal error", 1)
 OFFLOAD_ERRC(INVALID_NULL_POINTER,
-             "A pointer argument is null when it should not be", 1)
-OFFLOAD_ERRC(INVALID_ARGUMENT, "An argument is invalid", 2)
-OFFLOAD_ERRC(OUT_OF_RESOURCES, "Out of resources", 3)
+             "A pointer argument is null when it should not be", 2)
+OFFLOAD_ERRC(INVALID_ARGUMENT, "An argument is invalid", 3)
+OFFLOAD_ERRC(OUT_OF_RESOURCES, "Out of resources", 4)
 OFFLOAD_ERRC(UNSUPPORTED,
-             "generic error code for unsupported features and enums", 4)
-OFFLOAD_ERRC(INVALID_VALUE, "Invalid Value", 4096)
-OFFLOAD_ERRC(INVALID_PLATFORM, "Invalid platform", 4097)
-OFFLOAD_ERRC(INVALID_DEVICE, "Invalid device", 4098)
-OFFLOAD_ERRC(INVALID_QUEUE, "Invalid queue", 4099)
-OFFLOAD_ERRC(INVALID_EVENT, "Invalid event", 4100)
-OFFLOAD_ERRC(INVALID_KERNEL_NAME,
-             "Named kernel not found in the program binary", 4101)
-OFFLOAD_ERRC(INVALID_NULL_HANDLE, "handle argument is not valid", 4102)
+             "generic error code for unsupported features and enums", 5)
 OFFLOAD_ERRC(
     INVALID_SIZE,
     "invalid size or dimensions (e.g., must not be zero, or is out of bounds)",
-    4103)
-OFFLOAD_ERRC(INVALID_ENUMERATION, "enumerator argument is not valid", 4104)
-OFFLOAD_ERRC(UNKNOWN, "Unknown or internal error", 65536)
+    6)
+OFFLOAD_ERRC(INVALID_ENUMERATION, "enumerator argument is not valid", 7)
+OFFLOAD_ERRC(INVALID_KERNEL_NAME,
+             "Named kernel not found in the program binary", 8)
+OFFLOAD_ERRC(INVALID_VALUE, "Invalid Value", 9)
+OFFLOAD_ERRC(INVALID_PLATFORM, "Invalid platform", 10)
+OFFLOAD_ERRC(INVALID_DEVICE, "Invalid device", 11)
+OFFLOAD_ERRC(INVALID_QUEUE, "Invalid queue", 12)
+OFFLOAD_ERRC(INVALID_EVENT, "Invalid event", 13)
+OFFLOAD_ERRC(INVALID_NULL_HANDLE, "handle argument is not valid", 14)
diff --git a/offload/tools/offload-tblgen/APIGen.cpp b/offload/tools/offload-tblgen/APIGen.cpp
@@ -132,9 +132,6 @@ static void ProcessEnum(const EnumRec &Enum, raw_ostream &OS) {
 
   uint32_t EtorVal = 0;
   for (const auto &EnumVal : Enum.getValues()) {
-    if (auto NewVal = EnumVal.getEnumValue()) {
-      EtorVal = *NewVal;
-    }
     if (Enum.isTyped()) {
       OS << MakeComment(
           formatv("[{0}] {1}", EnumVal.getTaggedType(), EnumVal.getDesc())
diff --git a/offload/tools/offload-tblgen/MiscGen.cpp b/offload/tools/offload-tblgen/MiscGen.cpp
@@ -89,9 +89,6 @@ void EmitOffloadErrcodes(const RecordKeeper &Records, raw_ostream &OS) {
   auto ErrorCodeEnum = EnumRec{Records.getDef("ErrorCode")};
   uint32_t EtorVal = 0;
   for (const auto &EnumVal : ErrorCodeEnum.getValues()) {
-    if (auto NewVal = EnumVal.getEnumValue()) {
-      EtorVal = *NewVal;
-    }
     OS << formatv(TAB_1 "OFFLOAD_ERRC({0}, \"{1}\", {2})\n", EnumVal.getName(),
                   EnumVal.getDesc(), EtorVal++);
   }
diff --git a/offload/tools/offload-tblgen/RecordTypes.hpp b/offload/tools/offload-tblgen/RecordTypes.hpp
@@ -69,13 +69,6 @@ class EnumValueRec {
   StringRef getTaggedType() const {
     return rec->getValueAsString("tagged_type");
   }
-  std::optional<uint32_t> getEnumValue() const {
-    if (rec->getValueAsInt("value") == -1) {
-      return std::nullopt;
-    } else {
-      return rec->getValueAsInt("value");
-    }
-  }
 
 private:
   const Record *rec;

Original file line number	Diff line number	Diff line change
`@@ -152,10 +152,9 @@ class Function : APIObject {`
`152`	`152`	`AddHandleChecksToReturns<params, returns_with_def>.returns_out>.returns_out;`
`153`	`153`	`}`
`154`	`154`
`155`		`-class Etor<string Name, string Desc, int Value=-1> {`
	`155`	`+class Etor<string Name, string Desc> {`
`156`	`156`	`string name = Name;`
`157`	`157`	`string desc = Desc;`
`158`		`- int value = Value;`
`159`	`158`	`string tagged_type;`
`160`	`159`	`}`
`161`	`160`