program.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_TARGET_CMD_PROGRAM_H_
#define LOOMC_TARGET_CMD_PROGRAM_H_
 
#include "loomc/artifact.h"
#include "loomc/config.h"
#include "loomc/context.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

#define LOOMC_ARTIFACT_FORMAT_CMD_PROGRAM "loom-command"

typedef enum loomc_cmd_program_product_flag_bits_e {
  LOOMC_CMD_PROGRAM_PRODUCT_FLAG_INCLUDE_INPUT_EXPORTS = 1u << 0,
} loomc_cmd_program_product_flag_bits_t;

typedef uint32_t loomc_cmd_program_product_flags_t;

typedef struct loomc_cmd_program_product_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_link_index_t* link_index;

  const loomc_host_size_t* root_symbol_ordinals;

  loomc_host_size_t root_symbol_count;

  loomc_cmd_program_product_flags_t flags;

  loomc_config_options_t config;

  const loomc_target_profile_t* target_profile;

  loomc_request_sink_t request_sink;
} loomc_cmd_program_product_options_t;

typedef struct loomc_cmd_program_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_config_options_t config;

  const loomc_target_profile_t* target_profile;

  loomc_request_sink_t request_sink;
} loomc_cmd_program_request_options_t;

typedef struct loomc_cmd_program_module_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 provider_name;

  const loomc_string_view_t* root_symbols;

  loomc_host_size_t root_symbol_count;

  loomc_cmd_program_product_flags_t flags;

  loomc_config_options_t config;

  const loomc_target_profile_t* target_profile;

  loomc_request_sink_t request_sink;
} loomc_cmd_program_module_options_t;

typedef struct loomc_cmd_program_t {
  loomc_string_view_t symbol;

  loomc_artifact_t artifact;

  const loomc_requirement_ordinal_t* entry_requirement_ordinals;

  loomc_host_size_t entry_requirement_count;
} loomc_cmd_program_t;

typedef struct loomc_cmd_entry_requirement_t {
  loomc_string_view_t symbol;
} loomc_cmd_entry_requirement_t;

LOOMC_API_EXPORT loomc_status_t loomc_cmd_program_product_build(
    loomc_workspace_t* workspace,
    const loomc_cmd_program_product_options_t* options,
    loomc_allocator_t allocator, loomc_product_t** out_product,
    loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_cmd_program_product_build_request(
    loomc_context_t* context, loomc_workspace_t* workspace,
    const loomc_request_t* request,
    const loomc_cmd_program_request_options_t* options,
    loomc_allocator_t allocator, loomc_product_t** out_product,
    loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_cmd_program_product_build_module(
    loomc_workspace_t* workspace, const loomc_module_t* module,
    const loomc_cmd_program_module_options_t* options,
    loomc_allocator_t allocator, loomc_product_t** out_product,
    loomc_result_t** out_result);

LOOMC_API_EXPORT const loomc_product_descriptor_t*
loomc_cmd_program_product_descriptor(void);

LOOMC_API_EXPORT loomc_host_size_t
loomc_cmd_program_product_program_count(const loomc_product_t* product);

LOOMC_API_EXPORT bool loomc_cmd_program_product_program_at(
    const loomc_product_t* product, loomc_host_size_t ordinal,
    loomc_cmd_program_t* out_program);

LOOMC_API_EXPORT loomc_host_size_t
loomc_cmd_program_product_entry_requirement_count(
    const loomc_product_t* product);

LOOMC_API_EXPORT bool loomc_cmd_program_product_entry_requirement_at(
    const loomc_product_t* product, loomc_host_size_t ordinal,
    loomc_cmd_entry_requirement_t* out_requirement);
 
#ifdef __cplusplus
}  // extern "C"
#endif
 
#endif  // LOOMC_TARGET_CMD_PROGRAM_H_