pass_trace.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_PASS_TRACE_H_
#define LOOMC_PASS_TRACE_H_
 
#include "loomc/base.h"

 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum loomc_pass_trace_format_e {
  LOOMC_PASS_TRACE_FORMAT_TEXT = 0,

  LOOMC_PASS_TRACE_FORMAT_JSONL = 1,
} loomc_pass_trace_format_t;

typedef enum loomc_pass_trace_flag_bits_e {
  LOOMC_PASS_TRACE_FLAG_BEFORE_ALL = 1u << 0,

  LOOMC_PASS_TRACE_FLAG_AFTER_ALL = 1u << 1,
} loomc_pass_trace_flag_bits_t;

typedef uint32_t loomc_pass_trace_flags_t;

typedef loomc_status_t(LOOMC_API_PTR* loomc_pass_trace_write_fn_t)(
    void* user_data, loomc_string_view_t fragment);

typedef struct loomc_pass_trace_sink_t {
  loomc_pass_trace_write_fn_t write;

  void* user_data;
} loomc_pass_trace_sink_t;

typedef enum loomc_pass_trace_point_e {
  LOOMC_PASS_TRACE_POINT_BEFORE = 0,

  LOOMC_PASS_TRACE_POINT_AFTER = 1,
} loomc_pass_trace_point_t;

typedef struct loomc_pass_trace_event_t {
  loomc_host_size_t event_ordinal;

  loomc_pass_trace_point_t point;

  loomc_string_view_t pass_key;
} loomc_pass_trace_event_t;

typedef struct loomc_pass_trace_artifact_t {
  loomc_string_view_t reference;

  loomc_pass_trace_sink_t sink;
} loomc_pass_trace_artifact_t;

typedef loomc_status_t(LOOMC_API_PTR* loomc_pass_trace_artifact_open_fn_t)(
    void* user_data, const loomc_pass_trace_event_t* event,
    loomc_pass_trace_artifact_t* out_artifact);

typedef loomc_status_t(LOOMC_API_PTR* loomc_pass_trace_artifact_close_fn_t)(
    void* user_data, loomc_pass_trace_artifact_t* artifact);

typedef struct loomc_pass_trace_artifact_sink_t {
  loomc_pass_trace_artifact_open_fn_t open;

  loomc_pass_trace_artifact_close_fn_t close;

  void* user_data;
} loomc_pass_trace_artifact_sink_t;

typedef struct loomc_pass_trace_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_pass_trace_format_t format;

  loomc_pass_trace_flags_t flags;

  loomc_string_view_t tool_name;

  loomc_string_view_t input_identifier;

  const loomc_string_view_t* before_filters;

  loomc_host_size_t before_filter_count;

  const loomc_string_view_t* after_filters;

  loomc_host_size_t after_filter_count;

  loomc_pass_trace_sink_t sink;

  loomc_pass_trace_artifact_sink_t artifact_sink;
} loomc_pass_trace_options_t;
 
#ifdef __cplusplus
}  // extern "C"
#endif
 
#endif  // LOOMC_PASS_TRACE_H_