Loom C API
Public Loom compiler C API
Loading...
Searching...
No Matches
compile.h
Go to the documentation of this file.
1// Copyright 2026 The IREE Authors
2//
3// Licensed under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
7#ifndef LOOMC_COMPILE_H_
8#define LOOMC_COMPILE_H_
9
10#include "loomc/config.h"
11#include "loomc/module.h"
12#include "loomc/pass.h"
13#include "loomc/product.h"
14#include "loomc/result.h"
15#include "loomc/workspace.h"
16
79
80#ifdef __cplusplus
81extern "C" {
82#endif
83
95
116
119
136
180
196 loomc_context_t* context, const loomc_compiler_options_t* options,
197 loomc_allocator_t allocator, loomc_compiler_t** out_compiler);
198
256 loomc_compiler_t* compiler, loomc_workspace_t* workspace,
257 const loomc_pass_program_t* pass_program, loomc_module_t* module,
258 const loomc_compile_options_t* options, loomc_allocator_t allocator,
259 loomc_result_t** out_result);
260
297 loomc_compiler_t* compiler, loomc_workspace_t* workspace,
298 const loomc_pass_program_t* pass_program, const loomc_request_t* request,
299 const loomc_compile_options_t* options, loomc_allocator_t allocator,
300 loomc_product_t** out_product, loomc_result_t** out_result);
301
308
316
325
326#ifdef __cplusplus
327} // extern "C"
328#endif
329
330#endif // LOOMC_COMPILE_H_
#define LOOMC_API_EXPORT
Exports a public Loom C API symbol from a shared library build.
Definition base.h:34
size_t loomc_host_size_t
Host allocation and container size type.
Definition base.h:45
loomc_structure_type_t
Structure type values used by extensible public descriptors.
Definition base.h:181
struct iree_status_handle_t * loomc_status_t
Opaque status handle.
Definition base.h:55
const loomc_product_descriptor_t * loomc_compiled_module_product_descriptor(void)
Returns the process-local descriptor for products from loomc_compile_request.
uint32_t loomc_compile_artifact_flags_t
Bitmask of loomc_compile_artifact_flag_bits_t.
Definition compile.h:118
void loomc_compiler_release(loomc_compiler_t *compiler)
Releases a prepared compiler from one owner.
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)
Compiles a mutable module into in-memory artifacts.
struct loomc_compiler_t loomc_compiler_t
Prepared immutable compiler.
Definition compile.h:94
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)
Compiles one immutable leaf request into a compiler product.
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)
Creates a prepared immutable compiler.
void loomc_compiler_retain(loomc_compiler_t *compiler)
Retains a prepared compiler for another owner.
loomc_compile_artifact_flag_bits_t
Compile artifact request bits.
Definition compile.h:97
@ LOOMC_COMPILE_ARTIFACT_FLAG_REPORT_JSON
Return a JSON compile report artifact.
Definition compile.h:106
@ LOOMC_COMPILE_ARTIFACT_FLAG_LAUNCH_CONFIG
Return the compiled host launch-config program for all kernel entries.
Definition compile.h:114
@ LOOMC_COMPILE_ARTIFACT_FLAG_MODULE_TEXT
Return textual Loom module IR after successful compilation.
Definition compile.h:99
@ LOOMC_COMPILE_ARTIFACT_FLAG_MODULE_BYTECODE
Return binary Loom bytecode after successful compilation.
Definition compile.h:102
Text and JSON configuration bindings.
uint32_t loomc_config_policy_flags_t
Bitmask of loomc_config_policy_flag_bits_t values.
Definition config.h:66
struct loomc_context_t loomc_context_t
Immutable Loom API context.
Definition context.h:47
Opaque in-memory Loom modules.
struct loomc_module_t loomc_module_t
Opaque parsed, linked, optimized, or lowered module.
Definition module.h:89
Prepared pass programs.
struct loomc_pass_program_t loomc_pass_program_t
Prepared immutable pass program.
Definition pass.h:86
Immutable compiler products and their recursively published requests.
struct loomc_product_t loomc_product_t
Immutable successful compiler product.
Definition product.h:66
struct loomc_request_t loomc_request_t
Immutable independently compilable product request.
Definition product.h:167
struct loomc_product_descriptor_t loomc_product_descriptor_t
Opaque process-local identity for one product representation.
Definition product.h:51
Shared operation result container.
struct loomc_result_t loomc_result_t
Immutable operation result.
Definition result.h:64
Host allocator used for persistent Loom object storage.
Definition base.h:390
Compile invocation options.
Definition compile.h:148
const loomc_module_t * config_module
Optional module containing only exact config.def operations.
Definition compile.h:178
const void * next
Extension chain for compile invocation options such as loomc_target_specialization_options_t.
Definition compile.h:158
loomc_host_size_t structure_size
Size of this structure in bytes.
Definition compile.h:154
loomc_compile_artifact_flags_t artifact_flags
Requested result artifacts.
Definition compile.h:166
loomc_string_view_t module_name
Runtime artifact module name for this invocation.
Definition compile.h:162
loomc_structure_type_t type
Structure type.
Definition compile.h:151
loomc_config_policy_flags_t config_flags
Config validation and final-resolution policy.
Definition compile.h:169
Compiler creation options.
Definition compile.h:125
const void * next
Extension chain for future compiler options.
Definition compile.h:134
loomc_host_size_t structure_size
Size of this structure in bytes.
Definition compile.h:131
loomc_structure_type_t type
Structure type.
Definition compile.h:128
Non-owning string view over bytes that need not be NUL-terminated.
Definition base.h:63
Per-worker scratch workspace.
struct loomc_workspace_t loomc_workspace_t
Mutable per-worker scratch workspace.
Definition workspace.h:54