target.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_H_
#define LOOMC_TARGET_H_
 
#include "loomc/context.h"
#include "loomc/pass.h"
#include "loomc/result.h"
#include "loomc/sanitizer.h"

 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct loomc_target_environment_t loomc_target_environment_t;

typedef struct loomc_target_profile_t loomc_target_profile_t;

typedef enum loomc_target_fact_state_e {
  LOOMC_TARGET_FACT_STATE_UNKNOWN = 0,

  LOOMC_TARGET_FACT_STATE_FALSE = 1,

  LOOMC_TARGET_FACT_STATE_TRUE = 2,
} loomc_target_fact_state_t;

typedef struct loomc_context_target_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_target_environment_t* target_environment;
} loomc_context_target_options_t;

typedef struct loomc_target_specialization_t {
  loomc_string_view_t function_symbol;

  loomc_target_profile_t* target_profile;
} loomc_target_specialization_t;

typedef struct loomc_target_binding_t {
  loomc_string_view_t target_symbol;

  loomc_target_profile_t* target_profile;
} loomc_target_binding_t;

typedef struct loomc_target_specialization_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  const loomc_target_specialization_t* specializations;

  loomc_host_size_t specialization_count;

  const loomc_target_binding_t* target_bindings;

  loomc_host_size_t target_binding_count;
} loomc_target_specialization_options_t;

typedef enum loomc_target_pipeline_kind_e {
  LOOMC_TARGET_PIPELINE_KIND_PREPARED_LOW = 0,

  LOOMC_TARGET_PIPELINE_KIND_SOURCE_LOW = 1,

  LOOMC_TARGET_PIPELINE_KIND_SOURCE_LOW_ARTIFACTS = 2,
} loomc_target_pipeline_kind_t;

typedef enum loomc_source_to_low_diagnostic_flag_bits_e {
  LOOMC_SOURCE_TO_LOW_DIAGNOSTIC_MEMORY_ACCESS = 1u << 0,

  LOOMC_SOURCE_TO_LOW_DIAGNOSTIC_OPERAND_FORM = 1u << 1,

  LOOMC_SOURCE_TO_LOW_DIAGNOSTIC_ALL =
      LOOMC_SOURCE_TO_LOW_DIAGNOSTIC_MEMORY_ACCESS |
      LOOMC_SOURCE_TO_LOW_DIAGNOSTIC_OPERAND_FORM,
} loomc_source_to_low_diagnostic_flag_bits_t;

typedef uint32_t loomc_source_to_low_diagnostic_flags_t;

typedef enum loomc_target_control_flow_lowering_e {
  LOOMC_TARGET_CONTROL_FLOW_LOWERING_CFG = 0,

  LOOMC_TARGET_CONTROL_FLOW_LOWERING_STRUCTURED_LOW = 1,
} loomc_target_control_flow_lowering_t;

typedef struct loomc_target_pipeline_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_string_view_t identifier;

  loomc_target_pipeline_kind_t kind;

  loomc_target_control_flow_lowering_t control_flow_lowering;

  uint32_t source_to_low_max_errors;

  uint32_t reserved;

  loomc_source_to_low_diagnostic_flags_t source_to_low_diagnostic_flags;
} loomc_target_pipeline_options_t;

LOOMC_API_EXPORT loomc_status_t loomc_pass_program_create_from_target_pipeline(
    loomc_context_t* context, const loomc_target_pipeline_options_t* options,
    loomc_allocator_t allocator, loomc_pass_program_t** out_pass_program,
    loomc_result_t** out_result);

LOOMC_API_EXPORT loomc_status_t loomc_target_profile_select(
    loomc_target_environment_t* target_environment,
    loomc_string_view_t specification, loomc_allocator_t allocator,
    loomc_target_profile_t** out_profile);

LOOMC_API_EXPORT loomc_status_t
loomc_target_profile_refine_execution_unit_count(
    loomc_target_profile_t* base_profile, uint32_t execution_unit_count,
    loomc_allocator_t allocator, loomc_target_profile_t** out_profile);

LOOMC_API_EXPORT void loomc_target_profile_retain(
    loomc_target_profile_t* profile);

LOOMC_API_EXPORT void loomc_target_profile_release(
    loomc_target_profile_t* profile);

LOOMC_API_EXPORT bool loomc_target_profile_equal(
    const loomc_target_profile_t* lhs, const loomc_target_profile_t* rhs);

LOOMC_API_EXPORT loomc_status_t loomc_target_environment_create(
    loomc_host_size_t environment_count,
    loomc_target_environment_t* const* environments,
    loomc_allocator_t allocator,
    loomc_target_environment_t** out_target_environment);

LOOMC_API_EXPORT loomc_host_size_t
loomc_target_environment_artifact_format_count(
    const loomc_target_environment_t* target_environment);

LOOMC_API_EXPORT loomc_string_view_t
loomc_target_environment_artifact_format_at(
    const loomc_target_environment_t* target_environment,
    loomc_host_size_t ordinal);

LOOMC_API_EXPORT loomc_host_size_t loomc_target_environment_target_family_count(
    const loomc_target_environment_t* target_environment);

LOOMC_API_EXPORT loomc_string_view_t loomc_target_environment_target_family_at(
    const loomc_target_environment_t* target_environment,
    loomc_host_size_t ordinal);

LOOMC_API_EXPORT void loomc_target_environment_retain(
    loomc_target_environment_t* target_environment);

LOOMC_API_EXPORT void loomc_target_environment_release(
    loomc_target_environment_t* target_environment);
 
#ifdef __cplusplus
}  // extern "C"
#endif
 
#endif  // LOOMC_TARGET_H_