Wrap LiteRtStatus into C++ enum litert::Status

LiteRT-PiperOrigin-RevId: 829018389

Author: gcarranza-1

litert/c/litert_common.h

@@ -282,7 +282,10 @@ typedef enum {
   kLiteRtStatusPatternNoMatch = 3000,
   kLiteRtStatusInvalidTransformation = 3001,
 } LiteRtStatus;
-// LINT.ThenChange(../kotlin/src/main/kotlin/com/google/ai/edge/litert/LiteRtException.kt:status_codes)
+// LINT.ThenChange(
+//   ../kotlin/src/main/kotlin/com/google/ai/edge/litert/LiteRtException.kt:status_codes,
+//   ../cc/litert_common.h:status_codes
+// )
 
 // Returns a string describing the status value.
 const char* LiteRtGetStatusString(LiteRtStatus status);

litert/cc/BUILD

@@ -136,6 +136,7 @@ cc_library(
     hdrs = ["litert_expected.h"],
     deps = [
         "//litert/c:litert_common",
+        "//litert/cc:litert_common",
         "//litert/cc/internal:litert_detail",
         "@com_google_absl//absl/log:absl_check",
         "@com_google_absl//absl/strings",

litert/cc/litert_common.h

@@ -20,6 +20,44 @@
 
 namespace litert {
 
+// LINT.IfChange(status_codes)
+enum class Status : int {
+  kOk = kLiteRtStatusOk,
+  // Generic errors.
+  kErrorInvalidArgument = kLiteRtStatusErrorInvalidArgument,
+  kErrorMemoryAllocationFailure = kLiteRtStatusErrorMemoryAllocationFailure,
+  kErrorRuntimeFailure = kLiteRtStatusErrorRuntimeFailure,
+  kErrorMissingInputTensor = kLiteRtStatusErrorMissingInputTensor,
+  kErrorUnsupported = kLiteRtStatusErrorUnsupported,
+  kErrorNotFound = kLiteRtStatusErrorNotFound,
+  kErrorTimeoutExpired = kLiteRtStatusErrorTimeoutExpired,
+  kErrorWrongVersion = kLiteRtStatusErrorWrongVersion,
+  kErrorUnknown = kLiteRtStatusErrorUnknown,
+  kErrorAlreadyExists = kLiteRtStatusErrorAlreadyExists,
+  // Inference progression errors.
+  kCancelled = kLiteRtStatusCancelled,
+  // File and loading related errors.
+  kErrorFileIO = kLiteRtStatusErrorFileIO,
+  kErrorInvalidFlatbuffer = kLiteRtStatusErrorInvalidFlatbuffer,
+  kErrorDynamicLoading = kLiteRtStatusErrorDynamicLoading,
+  kErrorSerialization = kLiteRtStatusErrorSerialization,
+  kErrorCompilation = kLiteRtStatusErrorCompilation,
+  // IR related errors.
+  kErrorIndexOOB = kLiteRtStatusErrorIndexOOB,
+  kErrorInvalidIrType = kLiteRtStatusErrorInvalidIrType,
+  kErrorInvalidGraphInvariant = kLiteRtStatusErrorInvalidGraphInvariant,
+  kErrorGraphModification = kLiteRtStatusErrorGraphModification,
+  // Tool related errors.
+  kErrorInvalidToolConfig = kLiteRtStatusErrorInvalidToolConfig,
+  // Legalization related errors.
+  kLegalizeNoMatch = kLiteRtStatusLegalizeNoMatch,
+  kErrorInvalidLegalization = kLiteRtStatusErrorInvalidLegalization,
+  // Transformation related errors.
+  kPatternNoMatch = kLiteRtStatusPatternNoMatch,
+  kInvalidTransformation = kLiteRtStatusInvalidTransformation,
+};
+// LINT.ThenChange(../c/litert_common.h:status_codes)
+
 enum class HwAccelerators : int {
   kNone = kLiteRtHwAcceleratorNone,
   kCpu = kLiteRtHwAcceleratorCpu,

litert/cc/litert_expected.h

@@ -28,6 +28,7 @@
 #include "absl/strings/str_cat.h"  // from @com_google_absl
 #include "absl/strings/str_format.h"  // from @com_google_absl
 #include "litert/c/litert_common.h"
+#include "litert/cc/litert_common.h"
 #include "litert/cc/internal/litert_detail.h"
 
 namespace litert {
@@ -44,13 +45,27 @@ class Error {
  public:
   // Construct Unexpected from status and optional error message.
   //
-  // NOTE: kLiteRtStatusOk should not be passed to Unexpected.
+  // NOTE: ::litert::Status::kOk should not be passed to Unexpected.
+  explicit Error(Status status, std::string message = "")
+      : status_(static_cast<LiteRtStatus>(status)),
+        message_(std::move(message)) {
+    ABSL_DCHECK(status != Status::kOk);
+  }
+
+  [[deprecated("Use the constructor that takes ::litert::Status instead.")]]
   explicit Error(LiteRtStatus status, std::string message = "")
       : status_(status), message_(std::move(message)) {
     ABSL_DCHECK(status != kLiteRtStatusOk);
   }
 
   // Get the status.
+  // TODO: b/454666070 - Rename to Status() after the deprecated function is
+  // removed.
+  constexpr Status StatusCC() const {
+    return static_cast<enum Status>(status_);
+  }
+
+  [[deprecated("Use StatusCC() instead.")]]
   constexpr LiteRtStatus Status() const { return status_; }
 
   // Get the error message, empty string if none was attached.

litert/test/BUILD

@@ -196,10 +196,10 @@ cc_library(
     deps = [
         "//litert/c:litert_common",
         "//litert/c:litert_model_types",
+        "//litert/cc:litert_common",
         "//litert/cc:litert_element_type",
         "//litert/cc:litert_expected",
-        "//litert/cc:litert_macros",
-        "//litert/cc:litert_model",
+        "//litert/cc:litert_ranked_tensor_type",
         "//litert/cc/internal:litert_c_types_printing",
         "@com_google_absl//absl/status",
         "@com_google_absl//absl/status:statusor",
@@ -262,9 +262,11 @@ cc_library(
     deps = [
         "//litert/c:litert_common",
         "//litert/c:litert_model_types",
+        "//litert/cc:litert_common",
         "//litert/cc:litert_element_type",
         "//litert/cc:litert_expected",
         "//litert/cc:litert_macros",
+        "//litert/cc:litert_ranked_tensor_type",
         "//litert/cc/dynamic_runtime:litert_model",
         "//litert/cc/internal:litert_c_types_printing",
         "@com_google_absl//absl/status",

litert/test/matchers.h

@@ -34,10 +34,10 @@
 #include "litert/c/litert_common.h"
 #include "litert/c/litert_model_types.h"
 #include "litert/cc/internal/litert_c_types_printing.h"  // IWYU pragma: keep
+#include "litert/cc/litert_common.h"
 #include "litert/cc/litert_element_type.h"
 #include "litert/cc/litert_expected.h"
-#include "litert/cc/litert_macros.h"
-#include "litert/cc/litert_model.h"
+#include "litert/cc/litert_ranked_tensor_type.h"
 
 // Is equivalent to `ASSERT_THAT(expr, testing::litert::IsOk())`
 #define LITERT_ASSERT_OK(EXPR) ASSERT_THAT((EXPR), ::testing::litert::IsOk())
@@ -348,32 +348,42 @@ inline IsErrorMatcher IsError() {
 }
 
 // Matches `litert::Expected`, `litert::Unexpected`, `litert::Error` and
-// `LiteRtStatus` values that hold a specific error status.
+// `litert::Status` values that hold a specific error status.
 //
 // ```cpp
 // Expected<Something> BuildSomething();
 //
 // // Will fail the test if BuildSomething()'s returned object holds a value or
-// // if the error status is not `kLiteRtStatusErrorSystemError`.
-// EXPECT_THAT(BuildSomething(), IsError(kLiteRtStatusErrorSystemError));
+// // if the error status is not `kErrorSystemError`.
+// EXPECT_THAT(BuildSomething(), IsError(::litert::Status::kErrorSystemError));
 // ```
+inline IsErrorMatcher IsError(::litert::Status status) {
+  return IsErrorMatcher(static_cast<LiteRtStatus>(status),
+                        /*msg=*/std::nullopt);
+}
+
 inline IsErrorMatcher IsError(LiteRtStatus status) {
   return IsErrorMatcher(status, /*msg=*/std::nullopt);
 }
 
-// Matches `litert::Expected` and `LiteRtStatus` values that have a specific
+// Matches `litert::Expected` and `litert::Status` values that have a specific
 // error status and error message.
 //
-// Warning: This will always return `false` for `LiteRtStatus` objects as those
-// do not convey a message.
+// Warning: This will always return `false` for `litert::Status` objects as
+// those do not convey a message.
 //
 // ```cpp
 // Expected<Something> BuildSomething();
 //
 // // Will fail the test if BuildSomething()'s returned object holds a value.
-// EXPECT_THAT(BuildSomething(), IsError(kLiteRtStatusErrorSystemError,
+// EXPECT_THAT(BuildSomething(), IsError(::litert::Status::kErrorSystemError,
 //                                       "System is not initialised"));
 // ```
+inline IsErrorMatcher IsError(::litert::Status status, std::string msg) {
+  return IsErrorMatcher(static_cast<LiteRtStatus>(status), std::move(msg));
+}
+
+[[deprecated("Use the litert::Status version instead.")]]
 inline IsErrorMatcher IsError(LiteRtStatus status, std::string msg) {
   return IsErrorMatcher(status, std::move(msg));
 }