link.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_H_
#define LOOMC_LINK_H_
 
#include "loomc/config.h"
#include "loomc/link_index.h"
#include "loomc/module.h"
#include "loomc/product.h"
#include "loomc/result.h"
#include "loomc/target.h"
#include "loomc/workspace.h"

 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct loomc_linker_t loomc_linker_t;

typedef struct loomc_linker_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_string_view_t module_name;
} loomc_linker_options_t;

typedef enum loomc_link_flag_bits_e {
  LOOMC_LINK_FLAG_INCLUDE_INPUT_EXPORTS = 1u << 0,

  LOOMC_LINK_FLAG_ALLOW_UNRESOLVED_SYMBOLS = 1u << 1,

  LOOMC_LINK_FLAG_STRIP_TEST_SYMBOLS = 1u << 2,

  LOOMC_LINK_FLAG_INCLUDE_INPUT_TESTS = 1u << 3,
} loomc_link_flag_bits_t;

typedef uint32_t loomc_link_flags_t;

#define LOOMC_ARTIFACT_FORMAT_LINK_PLAN_TEXT "loom-link-plan-text"

typedef enum loomc_link_artifact_flag_bits_e {
  LOOMC_LINK_ARTIFACT_FLAG_PLAN_TEXT = 1u << 0,
} loomc_link_artifact_flag_bits_t;

typedef uint32_t loomc_link_artifact_flags_t;

typedef enum loomc_link_mode_e {
  LOOMC_LINK_MODE_MERGE = 0,

  LOOMC_LINK_MODE_LINK = 1,
} loomc_link_mode_t;

typedef struct loomc_link_module_provider_t {
  const loomc_module_t* module;

  loomc_string_view_t provider_name;

  loomc_link_provider_role_t role;
} loomc_link_module_provider_t;

typedef struct loomc_link_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_link_index_t* link_index;

  loomc_string_view_t module_name;

  loomc_link_mode_t mode;

  const loomc_string_view_t* root_symbols;

  loomc_host_size_t root_symbol_count;

  loomc_link_flags_t flags;

  loomc_config_options_t config;

  const loomc_host_size_t* root_provider_ordinals;

  loomc_host_size_t root_provider_count;

  const loomc_link_module_provider_t* module_providers;

  loomc_host_size_t module_provider_count;

  const loomc_target_profile_t* target_profile;

  loomc_link_artifact_flags_t artifact_flags;
} loomc_link_options_t;

typedef struct loomc_link_request_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  const loomc_link_index_t* library_index;

  loomc_string_view_t module_name;

  loomc_config_options_t config;
} loomc_link_request_options_t;

LOOMC_API_EXPORT loomc_status_t loomc_linker_create(
    loomc_context_t* context, const loomc_linker_options_t* options,
    loomc_allocator_t allocator, loomc_linker_t** out_linker);

LOOMC_API_EXPORT loomc_status_t
loomc_link_module(loomc_linker_t* linker, loomc_workspace_t* workspace,
                  const loomc_link_options_t* options,
                  loomc_module_t** out_module, loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_link_request(
    loomc_linker_t* linker, loomc_workspace_t* workspace,
    const loomc_request_t* input_request,
    const loomc_link_request_options_t* options, loomc_allocator_t allocator,
    loomc_request_t** out_request, loomc_result_t** out_result);

LOOMC_API_EXPORT void loomc_linker_retain(loomc_linker_t* linker);

LOOMC_API_EXPORT void loomc_linker_release(loomc_linker_t* linker);
 
#ifdef __cplusplus
}  // extern "C"
#endif
 
#endif  // LOOMC_LINK_H_