status.h

Go to the documentation of this file.

// Copyright 2026 The IREE Authors
//
// Licensed under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
#ifndef LOOMC_STATUS_H_
#define LOOMC_STATUS_H_
 
#include "loomc/base.h"

 
#ifdef __cplusplus
extern "C" {
#endif

#define LOOMC_STATUS_FEATURE_SOURCE_LOCATION (1 << 0)

#define LOOMC_STATUS_FEATURE_ANNOTATIONS (1 << 1)

#define LOOMC_STATUS_FEATURE_STACK_TRACE (1 << 2)

#if !defined(LOOMC_STATUS_MODE)
#if defined(IREE_STATUS_MODE)
#define LOOMC_STATUS_MODE IREE_STATUS_MODE
#elif defined(NDEBUG)
#define LOOMC_STATUS_MODE 2
#else
#define LOOMC_STATUS_MODE 3
#endif
#endif

#if !defined(LOOMC_STATUS_FEATURES)
#if defined(LOOMC_STATUS_MODE) && LOOMC_STATUS_MODE == 1
#define LOOMC_STATUS_FEATURES (LOOMC_STATUS_FEATURE_SOURCE_LOCATION)
#elif defined(LOOMC_STATUS_MODE) && LOOMC_STATUS_MODE == 2
#define LOOMC_STATUS_FEATURES \
  (LOOMC_STATUS_FEATURE_SOURCE_LOCATION | LOOMC_STATUS_FEATURE_ANNOTATIONS)
#elif defined(LOOMC_STATUS_MODE) && LOOMC_STATUS_MODE == 3
#define LOOMC_STATUS_FEATURES                                                \
  (LOOMC_STATUS_FEATURE_SOURCE_LOCATION | LOOMC_STATUS_FEATURE_ANNOTATIONS | \
   LOOMC_STATUS_FEATURE_STACK_TRACE)
#else
#define LOOMC_STATUS_FEATURES 0
#endif
#endif

typedef enum loomc_status_code_e {
  LOOMC_STATUS_OK = 0,

  LOOMC_STATUS_CANCELLED = 1,

  LOOMC_STATUS_UNKNOWN = 2,

  LOOMC_STATUS_INVALID_ARGUMENT = 3,

  LOOMC_STATUS_DEADLINE_EXCEEDED = 4,

  LOOMC_STATUS_NOT_FOUND = 5,

  LOOMC_STATUS_ALREADY_EXISTS = 6,

  LOOMC_STATUS_PERMISSION_DENIED = 7,

  LOOMC_STATUS_RESOURCE_EXHAUSTED = 8,

  LOOMC_STATUS_FAILED_PRECONDITION = 9,

  LOOMC_STATUS_ABORTED = 10,

  LOOMC_STATUS_OUT_OF_RANGE = 11,

  LOOMC_STATUS_UNIMPLEMENTED = 12,

  LOOMC_STATUS_INTERNAL = 13,

  LOOMC_STATUS_UNAVAILABLE = 14,

  LOOMC_STATUS_DATA_LOSS = 15,

  LOOMC_STATUS_UNAUTHENTICATED = 16,

  LOOMC_STATUS_DEFERRED = 17,

  LOOMC_STATUS_INCOMPATIBLE = 18,

  LOOMC_STATUS_CODE_MASK = 0x1Fu,
} loomc_status_code_t;

typedef struct loomc_status_source_location_t {
  loomc_string_view_t file;

  uint32_t line;
} loomc_status_source_location_t;

static inline loomc_status_t loomc_status_from_code(loomc_status_code_t code) {
  return (loomc_status_t)((uintptr_t)code & LOOMC_STATUS_CODE_MASK);
}

static inline loomc_status_t loomc_ok_status(void) {
  return loomc_status_from_code(LOOMC_STATUS_OK);
}

static inline loomc_status_code_t loomc_status_code(loomc_status_t status) {
  return (loomc_status_code_t)((uintptr_t)status & LOOMC_STATUS_CODE_MASK);
}

static inline bool loomc_status_is_ok(loomc_status_t status) {
  return (uintptr_t)status == LOOMC_STATUS_OK;
}

LOOMC_API_EXPORT loomc_status_t
loomc_status_allocate(loomc_status_code_t code, const char* file, uint32_t line,
                      loomc_string_view_t message);

#define loomc_make_status(code, message)            \
  loomc_status_allocate((code), __FILE__, __LINE__, \
                        loomc_make_cstring_view(message))

LOOMC_API_EXPORT void loomc_status_free(loomc_status_t status);

LOOMC_API_EXPORT loomc_status_code_t
loomc_status_consume_code(loomc_status_t status);

LOOMC_API_EXPORT loomc_status_t loomc_status_join(loomc_status_t base_status,
                                                  loomc_status_t new_status);

LOOMC_API_EXPORT const char* loomc_status_code_string(loomc_status_code_t code);

LOOMC_API_EXPORT loomc_string_view_t
loomc_status_message(loomc_status_t status);

LOOMC_API_EXPORT loomc_status_source_location_t
loomc_status_source_location(loomc_status_t status);

LOOMC_API_EXPORT bool loomc_status_format(loomc_status_t status,
                                          loomc_host_size_t buffer_capacity,
                                          char* buffer,
                                          loomc_host_size_t* out_length);

#define LOOMC_RETURN_IF_ERROR(expr)      \
  do {                                   \
    loomc_status_t status__ = (expr);    \
    if (!loomc_status_is_ok(status__)) { \
      return status__;                   \
    }                                    \
  } while (0)
 
#ifdef __cplusplus
}  // extern "C"
#endif
 
#endif  // LOOMC_STATUS_H_