product.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_PRODUCT_H_
#define LOOMC_PRODUCT_H_
 
#include "loomc/artifact.h"
#include "loomc/source.h"

 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct loomc_product_descriptor_t loomc_product_descriptor_t;

typedef struct loomc_product_t loomc_product_t;

LOOMC_API_EXPORT void loomc_product_retain(loomc_product_t* product);

LOOMC_API_EXPORT void loomc_product_release(loomc_product_t* product);

LOOMC_API_EXPORT const loomc_product_descriptor_t* loomc_product_descriptor(
    const loomc_product_t* product);

LOOMC_API_EXPORT loomc_host_size_t
loomc_product_artifact_count(const loomc_product_t* product);

LOOMC_API_EXPORT const loomc_artifact_t* loomc_product_artifact_at(
    const loomc_product_t* product, loomc_host_size_t ordinal);

LOOMC_API_EXPORT loomc_host_size_t
loomc_product_export_count(const loomc_product_t* product);

LOOMC_API_EXPORT loomc_host_size_t
loomc_product_requirement_count(const loomc_product_t* product);

typedef uint32_t loomc_requirement_ordinal_t;

#define LOOMC_REQUIREMENT_ORDINAL_INVALID UINT32_MAX

typedef uint32_t loomc_request_root_ordinal_t;

#define LOOMC_REQUEST_ROOT_ORDINAL_INVALID UINT32_MAX

typedef struct loomc_request_root_t {
  uint32_t module_ordinal;

  uint32_t symbol_ordinal;
} loomc_request_root_t;

typedef struct loomc_request_binding_t {
  loomc_requirement_ordinal_t requirement_ordinal;

  loomc_request_root_ordinal_t root_ordinal;
} loomc_request_binding_t;

typedef struct loomc_request_t loomc_request_t;

LOOMC_API_EXPORT loomc_status_t loomc_request_create(
    const loomc_product_descriptor_t* product_descriptor,
    loomc_source_t* source, const loomc_request_root_t* roots,
    loomc_host_size_t root_count, const loomc_request_binding_t* bindings,
    loomc_host_size_t binding_count, loomc_allocator_t allocator,
    loomc_request_t** out_request);

typedef loomc_status_t(LOOMC_API_PTR* loomc_request_publish_fn_t)(
    void* user_data, loomc_request_t* request);

typedef struct loomc_request_sink_t {
  loomc_request_publish_fn_t publish;

  void* user_data;
} loomc_request_sink_t;

LOOMC_API_EXPORT void loomc_request_retain(loomc_request_t* request);

LOOMC_API_EXPORT void loomc_request_release(loomc_request_t* request);

LOOMC_API_EXPORT const loomc_product_descriptor_t*
loomc_request_product_descriptor(const loomc_request_t* request);

LOOMC_API_EXPORT loomc_source_t* loomc_request_source(
    const loomc_request_t* request);

LOOMC_API_EXPORT loomc_host_size_t
loomc_request_root_count(const loomc_request_t* request);

LOOMC_API_EXPORT bool loomc_request_root_at(
    const loomc_request_t* request, loomc_request_root_ordinal_t ordinal,
    loomc_request_root_t* out_root);

LOOMC_API_EXPORT loomc_host_size_t
loomc_request_binding_count(const loomc_request_t* request);

LOOMC_API_EXPORT bool loomc_request_binding_at(
    const loomc_request_t* request, loomc_host_size_t ordinal,
    loomc_request_binding_t* out_binding);
 
#ifdef __cplusplus
}  // extern "C"
#endif
 
#endif  // LOOMC_PRODUCT_H_