link_index.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_LINK_INDEX_H_
#define LOOMC_LINK_INDEX_H_
 
#include "loomc/config.h"
#include "loomc/context.h"
#include "loomc/module.h"
#include "loomc/result.h"

 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct loomc_link_index_builder_t loomc_link_index_builder_t;

typedef struct loomc_link_index_t loomc_link_index_t;

typedef enum loomc_link_provider_role_e {
  LOOMC_LINK_PROVIDER_ROLE_INPUT = 0,

  LOOMC_LINK_PROVIDER_ROLE_LIBRARY = 1,
} loomc_link_provider_role_t;

typedef enum loomc_link_provider_kind_e {
  LOOMC_LINK_PROVIDER_KIND_UNKNOWN = 0,

  LOOMC_LINK_PROVIDER_KIND_TEXT = 1,

  LOOMC_LINK_PROVIDER_KIND_BYTECODE = 2,

  LOOMC_LINK_PROVIDER_KIND_MATERIALIZED = 3,
} loomc_link_provider_kind_t;

typedef enum loomc_link_symbol_identity_e {
  LOOMC_LINK_SYMBOL_IDENTITY_PRIVATE = 0,

  LOOMC_LINK_SYMBOL_IDENTITY_GLOBAL = 1,
} loomc_link_symbol_identity_t;

typedef enum loomc_link_symbol_kind_e {
  LOOMC_LINK_SYMBOL_KIND_UNKNOWN = 0,

  LOOMC_LINK_SYMBOL_KIND_FUNCTION_DEFINITION = 1,

  LOOMC_LINK_SYMBOL_KIND_FUNCTION_DECLARATION = 2,

  LOOMC_LINK_SYMBOL_KIND_FUNCTION_TEMPLATE = 3,

  LOOMC_LINK_SYMBOL_KIND_FUNCTION_UKERNEL = 4,

  LOOMC_LINK_SYMBOL_KIND_GLOBAL = 5,

  LOOMC_LINK_SYMBOL_KIND_EXECUTABLE = 6,

  LOOMC_LINK_SYMBOL_KIND_RECORD = 7,
} loomc_link_symbol_kind_t;

typedef enum loomc_link_symbol_flag_bits_e {
  LOOMC_LINK_SYMBOL_FLAG_PUBLIC = 1u << 0,

  LOOMC_LINK_SYMBOL_FLAG_IMPORT = 1u << 1,

  LOOMC_LINK_SYMBOL_FLAG_EXPORT = 1u << 2,

  LOOMC_LINK_SYMBOL_FLAG_DECLARATION = 1u << 3,

  LOOMC_LINK_SYMBOL_FLAG_CONCRETE_DEFINITION = 1u << 4,

  LOOMC_LINK_SYMBOL_FLAG_CONFIG = 1u << 5,

  LOOMC_LINK_SYMBOL_FLAG_TEST_ONLY = 1u << 6,

  LOOMC_LINK_SYMBOL_FLAG_RETAIN = 1u << 7,
} loomc_link_symbol_flag_bits_t;

typedef uint32_t loomc_link_symbol_flags_t;

typedef struct loomc_link_index_builder_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_host_size_t block_size;
} loomc_link_index_builder_options_t;

typedef struct loomc_link_index_source_slot_t {
  loomc_host_size_t ordinal;
} loomc_link_index_source_slot_t;

typedef struct loomc_link_index_source_options_t {
  loomc_string_view_t provider_name;

  loomc_link_provider_role_t role;
 
} loomc_link_index_source_options_t;

typedef struct loomc_link_index_provider_t {
  loomc_host_size_t ordinal;

  loomc_link_provider_kind_t kind;

  loomc_link_provider_role_t role;

  loomc_string_view_t name;

  loomc_host_size_t module_start_ordinal;

  loomc_host_size_t module_count;
} loomc_link_index_provider_t;

typedef struct loomc_link_index_module_t {
  loomc_host_size_t ordinal;

  loomc_host_size_t provider_ordinal;

  loomc_host_size_t provider_module_ordinal;

  loomc_string_view_t name;

  loomc_host_size_t symbol_start_ordinal;

  loomc_host_size_t symbol_count;
} loomc_link_index_module_t;

typedef struct loomc_link_index_symbol_t {
  loomc_host_size_t ordinal;

  loomc_host_size_t provider_ordinal;

  loomc_host_size_t module_ordinal;

  loomc_host_size_t provider_module_ordinal;

  loomc_host_size_t module_symbol_ordinal;

  loomc_string_view_t name;

  loomc_link_symbol_kind_t kind;

  loomc_link_symbol_identity_t identity;

  loomc_link_symbol_flags_t flags;
} loomc_link_index_symbol_t;

LOOMC_API_EXPORT loomc_status_t loomc_link_index_builder_allocate(
    loomc_context_t* context, const loomc_link_index_builder_options_t* options,
    loomc_allocator_t allocator, loomc_link_index_builder_t** out_builder);

LOOMC_API_EXPORT void loomc_link_index_builder_free(
    loomc_link_index_builder_t* builder);

LOOMC_API_EXPORT loomc_status_t loomc_link_index_builder_reserve_source_slot(
    loomc_link_index_builder_t* builder,
    const loomc_link_index_source_options_t* options,
    loomc_link_index_source_slot_t* out_slot);

LOOMC_API_EXPORT loomc_status_t loomc_link_index_builder_fill_source_slot(
    loomc_link_index_builder_t* builder, loomc_link_index_source_slot_t slot,
    loomc_source_t* source);

LOOMC_API_EXPORT loomc_status_t loomc_link_index_builder_add_source(
    loomc_link_index_builder_t* builder, loomc_source_t* source,
    const loomc_link_index_source_options_t* options,
    loomc_link_index_source_slot_t* out_slot);

LOOMC_API_EXPORT loomc_status_t loomc_link_index_builder_fill_module_slot(
    loomc_link_index_builder_t* builder, loomc_link_index_source_slot_t slot,
    const loomc_module_t* module);

LOOMC_API_EXPORT loomc_status_t loomc_link_index_builder_add_module(
    loomc_link_index_builder_t* builder, const loomc_module_t* module,
    const loomc_link_index_source_options_t* options,
    loomc_link_index_source_slot_t* out_slot);

LOOMC_API_EXPORT loomc_status_t loomc_link_index_builder_finish(
    loomc_link_index_builder_t* builder, loomc_link_index_t** out_link_index,
    loomc_result_t** out_result);

LOOMC_API_EXPORT void loomc_link_index_retain(loomc_link_index_t* link_index);

LOOMC_API_EXPORT void loomc_link_index_release(loomc_link_index_t* link_index);

LOOMC_API_EXPORT loomc_host_size_t
loomc_link_index_provider_count(const loomc_link_index_t* link_index);

LOOMC_API_EXPORT bool loomc_link_index_provider_at(
    const loomc_link_index_t* link_index, loomc_host_size_t ordinal,
    loomc_link_index_provider_t* out_provider);

LOOMC_API_EXPORT loomc_host_size_t
loomc_link_index_module_count(const loomc_link_index_t* link_index);

LOOMC_API_EXPORT bool loomc_link_index_module_at(
    const loomc_link_index_t* link_index, loomc_host_size_t ordinal,
    loomc_link_index_module_t* out_module);

LOOMC_API_EXPORT loomc_host_size_t
loomc_link_index_symbol_count(const loomc_link_index_t* link_index);

LOOMC_API_EXPORT bool loomc_link_index_symbol_at(
    const loomc_link_index_t* link_index, loomc_host_size_t ordinal,
    loomc_link_index_symbol_t* out_symbol);

LOOMC_API_EXPORT bool loomc_link_index_lookup_global(
    const loomc_link_index_t* link_index, loomc_string_view_t name,
    loomc_link_index_symbol_t* out_symbol);

LOOMC_API_EXPORT bool loomc_link_index_next_global_duplicate(
    const loomc_link_index_t* link_index,
    const loomc_link_index_symbol_t* symbol,
    loomc_link_index_symbol_t* out_symbol);

LOOMC_API_EXPORT bool loomc_link_index_lookup_private(
    const loomc_link_index_t* link_index,
    const loomc_link_index_module_t* module, loomc_string_view_t name,
    loomc_link_index_symbol_t* out_symbol);
 
#ifdef __cplusplus
}  // extern "C"
#endif
 
#endif  // LOOMC_LINK_INDEX_H_