compile.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_COMPILE_H_
#define LOOMC_COMPILE_H_
 
#include "loomc/config.h"
#include "loomc/emit.h"
#include "loomc/module.h"
#include "loomc/pass.h"
#include "loomc/pass_trace.h"
#include "loomc/product.h"
#include "loomc/result.h"
#include "loomc/workspace.h"

 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct loomc_compiler_t loomc_compiler_t;

typedef enum loomc_compile_artifact_flag_bits_e {
  LOOMC_COMPILE_ARTIFACT_FLAG_MODULE_TEXT = 1u << 0,

  LOOMC_COMPILE_ARTIFACT_FLAG_MODULE_BYTECODE = 1u << 1,

  LOOMC_COMPILE_ARTIFACT_FLAG_REPORT_JSON = 1u << 2,

  LOOMC_COMPILE_ARTIFACT_FLAG_LAUNCH_CONFIG = 1u << 3,
} loomc_compile_artifact_flag_bits_t;

typedef uint32_t loomc_compile_artifact_flags_t;

typedef struct loomc_compiler_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;
} loomc_compiler_options_t;

typedef struct loomc_compile_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_string_view_t module_name;

  loomc_compile_artifact_flags_t artifact_flags;

  loomc_config_policy_flags_t config_flags;

  const loomc_module_t* config_module;
} loomc_compile_options_t;

typedef struct loomc_compile_artifact_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  const loomc_string_view_t* roots;

  loomc_host_size_t root_count;

  const loomc_string_view_t* excluded_roots;

  loomc_host_size_t excluded_root_count;

  loomc_target_profile_t* target_profile;

  const loomc_config_options_t* config;

  const loomc_emit_options_t* emit_options;

  loomc_compile_artifact_flags_t artifact_flags;
} loomc_compile_artifact_options_t;

LOOMC_API_EXPORT loomc_status_t loomc_compiler_create(
    loomc_context_t* context, const loomc_compiler_options_t* options,
    loomc_allocator_t allocator, loomc_compiler_t** out_compiler);

LOOMC_API_EXPORT loomc_status_t loomc_compile_module(
    loomc_compiler_t* compiler, loomc_workspace_t* workspace,
    const loomc_pass_program_t* pass_program, loomc_module_t* module,
    const loomc_compile_options_t* options, loomc_allocator_t allocator,
    loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_compile_artifact(
    loomc_compiler_t* compiler, loomc_workspace_t* workspace,
    const loomc_pass_program_t* pass_program, loomc_module_t* module,
    const loomc_compile_artifact_options_t* options,
    loomc_allocator_t allocator, loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_compile_request(
    loomc_compiler_t* compiler, loomc_workspace_t* workspace,
    const loomc_pass_program_t* pass_program, const loomc_request_t* request,
    const loomc_compile_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_compiled_module_product_descriptor(void);

LOOMC_API_EXPORT void loomc_compiler_retain(loomc_compiler_t* compiler);

LOOMC_API_EXPORT void loomc_compiler_release(loomc_compiler_t* compiler);
 
#ifdef __cplusplus
}  // extern "C"
#endif
 
#endif  // LOOMC_COMPILE_H_