module.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_MODULE_H_
#define LOOMC_MODULE_H_
 
#include <stdio.h>
 
#include "loomc/context.h"
#include "loomc/product.h"
#include "loomc/result.h"
#include "loomc/source.h"
#include "loomc/workspace.h"

 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct loomc_module_t loomc_module_t;

typedef enum loomc_module_verify_scope_e {
  LOOMC_MODULE_VERIFY_SCOPE_DEFAULT = 0,
  LOOMC_MODULE_VERIFY_SCOPE_STRUCTURAL = 1,
} loomc_module_verify_scope_t;

typedef struct loomc_module_verify_options_t {
  loomc_structure_type_t type;
  loomc_host_size_t structure_size;
  const void* next;
  uint32_t max_errors;
  uint32_t reserved;
  loomc_module_verify_scope_t scope;
} loomc_module_verify_options_t;

LOOMC_API_EXPORT loomc_status_t loomc_module_verify(
    loomc_module_t* module, const loomc_module_verify_options_t* options,
    loomc_allocator_t allocator, loomc_result_t** out_result);

typedef enum loomc_module_function_kind_e {
  LOOMC_MODULE_FUNCTION_KIND_UNKNOWN = 0,

  LOOMC_MODULE_FUNCTION_KIND_FUNCTION = 1,

  LOOMC_MODULE_FUNCTION_KIND_KERNEL = 2,

  LOOMC_MODULE_FUNCTION_KIND_TARGET_FUNCTION = 3,

  LOOMC_MODULE_FUNCTION_KIND_TARGET_KERNEL = 4,
} loomc_module_function_kind_t;

static inline bool loomc_module_function_kind_is_kernel(
    loomc_module_function_kind_t kind) {
  return kind == LOOMC_MODULE_FUNCTION_KIND_KERNEL ||
         kind == LOOMC_MODULE_FUNCTION_KIND_TARGET_KERNEL;
}

typedef enum loomc_module_function_flag_bits_e {
  LOOMC_MODULE_FUNCTION_FLAG_PUBLIC = 1u << 0,

  LOOMC_MODULE_FUNCTION_FLAG_HAS_EXPORT_INFO = 1u << 1,
} loomc_module_function_flag_bits_t;

typedef uint32_t loomc_module_function_flags_t;

typedef struct loomc_module_function_t {
  loomc_host_size_t function_ordinal;

  loomc_string_view_t symbol_name;

  loomc_module_function_kind_t kind;

  loomc_module_function_flags_t flags;
} loomc_module_function_t;

typedef enum loomc_module_function_export_flag_bits_e {
  LOOMC_MODULE_FUNCTION_EXPORT_FLAG_HAS_SYMBOL = 1u << 0,
} loomc_module_function_export_flag_bits_t;

typedef uint32_t loomc_module_function_export_flags_t;

typedef struct loomc_module_function_export_info_t {
  loomc_module_function_export_flags_t flags;

  loomc_string_view_t export_symbol;
} loomc_module_function_export_info_t;

typedef struct loomc_module_function_query_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_string_view_t function_symbol;

  loomc_module_function_kind_t kind;
} loomc_module_function_query_options_t;

typedef enum loomc_module_global_kind_e {
  LOOMC_MODULE_GLOBAL_KIND_UNKNOWN = 0,

  LOOMC_MODULE_GLOBAL_KIND_CONSTANT = 1,

  LOOMC_MODULE_GLOBAL_KIND_VARIABLE = 2,
} loomc_module_global_kind_t;

typedef enum loomc_module_global_flag_bits_e {
  LOOMC_MODULE_GLOBAL_FLAG_PUBLIC = 1u << 0,
} loomc_module_global_flag_bits_t;

typedef uint32_t loomc_module_global_flags_t;

typedef struct loomc_module_global_t {
  loomc_host_size_t global_ordinal;

  loomc_string_view_t symbol_name;

  loomc_module_global_kind_t kind;

  loomc_module_global_flags_t flags;
} loomc_module_global_t;

typedef struct loomc_module_global_query_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_string_view_t global_symbol;

  loomc_module_global_kind_t kind;
} loomc_module_global_query_options_t;

typedef enum loomc_module_text_presentation_e {
  LOOMC_MODULE_TEXT_PRESENTATION_DEFAULT = 0,

  LOOMC_MODULE_TEXT_PRESENTATION_GENERIC = 1,

  LOOMC_MODULE_TEXT_PRESENTATION_LOW_ASM = 2,

  LOOMC_MODULE_TEXT_PRESENTATION_PRESERVE = 3,
} loomc_module_text_presentation_t;

typedef struct loomc_module_serialize_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_source_format_t format;

  loomc_string_view_t identifier;

  loomc_module_text_presentation_t text_presentation;

  uint32_t reserved;

  bool print_locations;
} loomc_module_serialize_options_t;

typedef struct loomc_module_deserialize_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_source_format_t format;

  loomc_string_view_t identifier;

  uint32_t max_errors;
} loomc_module_deserialize_options_t;

LOOMC_API_EXPORT void loomc_module_retain(loomc_module_t* module);

LOOMC_API_EXPORT void loomc_module_release(loomc_module_t* module);

LOOMC_API_EXPORT loomc_status_t loomc_module_clone(
    const loomc_module_t* source_module, loomc_workspace_t* workspace,
    loomc_allocator_t allocator, loomc_module_t** out_module);

LOOMC_API_EXPORT loomc_status_t loomc_module_query_functions(
    const loomc_module_t* module,
    const loomc_module_function_query_options_t* options,
    loomc_allocator_t allocator, loomc_host_size_t function_capacity,
    loomc_module_function_t* out_functions,
    loomc_host_size_t* out_function_count, loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_module_query_globals(
    const loomc_module_t* module,
    const loomc_module_global_query_options_t* options,
    loomc_allocator_t allocator, loomc_host_size_t global_capacity,
    loomc_module_global_t* out_globals, loomc_host_size_t* out_global_count,
    loomc_result_t** out_result);

LOOMC_API_EXPORT bool loomc_module_try_get_function_at(
    const loomc_module_t* module, loomc_host_size_t function_ordinal,
    loomc_module_function_t* out_function);

LOOMC_API_EXPORT loomc_status_t loomc_module_get_function_at(
    const loomc_module_t* module, loomc_host_size_t function_ordinal,
    loomc_module_function_t* out_function);

LOOMC_API_EXPORT bool loomc_module_try_lookup_function(
    const loomc_module_t* module, loomc_string_view_t symbol_name,
    loomc_module_function_t* out_function);

LOOMC_API_EXPORT loomc_status_t loomc_module_lookup_function(
    const loomc_module_t* module, loomc_string_view_t symbol_name,
    loomc_module_function_t* out_function);

LOOMC_API_EXPORT bool loomc_module_try_get_global_at(
    const loomc_module_t* module, loomc_host_size_t global_ordinal,
    loomc_module_global_t* out_global);

LOOMC_API_EXPORT loomc_status_t loomc_module_get_global_at(
    const loomc_module_t* module, loomc_host_size_t global_ordinal,
    loomc_module_global_t* out_global);

LOOMC_API_EXPORT bool loomc_module_try_lookup_global(
    const loomc_module_t* module, loomc_string_view_t symbol_name,
    loomc_module_global_t* out_global);

LOOMC_API_EXPORT loomc_status_t loomc_module_lookup_global(
    const loomc_module_t* module, loomc_string_view_t symbol_name,
    loomc_module_global_t* out_global);

LOOMC_API_EXPORT bool loomc_module_function_try_get_export_info_at(
    const loomc_module_t* module, loomc_host_size_t function_ordinal,
    loomc_module_function_export_info_t* out_info);

LOOMC_API_EXPORT loomc_status_t loomc_module_function_get_export_info_at(
    const loomc_module_t* module, loomc_host_size_t function_ordinal,
    loomc_module_function_export_info_t* out_info);

LOOMC_API_EXPORT bool loomc_module_function_try_get_export_info(
    const loomc_module_t* module, const loomc_module_function_t* function,
    loomc_module_function_export_info_t* out_info);

LOOMC_API_EXPORT loomc_status_t loomc_module_function_get_export_info(
    const loomc_module_t* module, const loomc_module_function_t* function,
    loomc_module_function_export_info_t* out_info);

LOOMC_API_EXPORT loomc_status_t loomc_module_serialize_to_source(
    const loomc_module_t* module,
    const loomc_module_serialize_options_t* options,
    loomc_allocator_t allocator, loomc_source_t** out_source);

LOOMC_API_EXPORT loomc_status_t loomc_module_serialize_text_to_source(
    const loomc_module_t* module,
    const loomc_module_serialize_options_t* options,
    loomc_allocator_t allocator, loomc_source_t** out_source);

LOOMC_API_EXPORT loomc_status_t loomc_module_serialize_bytecode_to_source(
    const loomc_module_t* module,
    const loomc_module_serialize_options_t* options,
    loomc_allocator_t allocator, loomc_source_t** out_source);

LOOMC_API_EXPORT loomc_status_t loomc_module_serialize_to_file(
    const loomc_module_t* module,
    const loomc_module_serialize_options_t* options, FILE* file);

LOOMC_API_EXPORT loomc_status_t loomc_module_serialize_to_path(
    const loomc_module_t* module,
    const loomc_module_serialize_options_t* options, loomc_string_view_t path,
    loomc_allocator_t allocator);

LOOMC_API_EXPORT loomc_status_t loomc_module_deserialize_from_source(
    loomc_context_t* context, loomc_workspace_t* workspace,
    const loomc_source_t* source,
    const loomc_module_deserialize_options_t* options,
    loomc_allocator_t allocator, loomc_module_t** out_module,
    loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_module_deserialize_request(
    loomc_context_t* context, loomc_workspace_t* workspace,
    const loomc_request_t* request, loomc_allocator_t host_allocator,
    loomc_module_t** out_module, loomc_string_view_t* out_root_symbols,
    loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_module_deserialize_text_from_source(
    loomc_context_t* context, loomc_workspace_t* workspace,
    const loomc_source_t* source,
    const loomc_module_deserialize_options_t* options,
    loomc_allocator_t allocator, loomc_module_t** out_module,
    loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_module_deserialize_bytecode_from_source(
    loomc_context_t* context, loomc_workspace_t* workspace,
    const loomc_source_t* source,
    const loomc_module_deserialize_options_t* options,
    loomc_allocator_t allocator, loomc_module_t** out_module,
    loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_module_deserialize_from_file(
    loomc_context_t* context, loomc_workspace_t* workspace, FILE* file,
    const loomc_module_deserialize_options_t* options,
    loomc_allocator_t allocator, loomc_module_t** out_module,
    loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_module_deserialize_from_path(
    loomc_context_t* context, loomc_workspace_t* workspace,
    loomc_string_view_t path, const loomc_module_deserialize_options_t* options,
    loomc_allocator_t allocator, loomc_module_t** out_module,
    loomc_result_t** out_result);
 
#ifdef __cplusplus
}  // extern "C"
#endif
 
#endif  // LOOMC_MODULE_H_