hw.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 CERN
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#ifndef ADAPTYST_HW_H_
#define ADAPTYST_HW_H_
 
#ifndef __cplusplus
#include <stdbool.h>
#endif
 
#include <adaptyst/amod_t.h>

#define ADAPTYST_OK 0
#define ADAPTYST_ERR_MODULE_NOT_FOUND 1
#define ADAPTYST_ERR_OUT_OF_MEMORY 2
#define ADAPTYST_ERR_EXCEPTION 3
#define ADAPTYST_ERR_TERMINAL_NOT_INITIALISED 4
#define ADAPTYST_ERR_LOG_DIR_CREATE 5
#define ADAPTYST_ERR_INIT_ONLY 6
#define ADAPTYST_ERR_TIMEOUT 7
#define ADAPTYST_ERR_WORKFLOW_NOT_STARTED 8
#define ADAPTYST_ERR_TIMESTAMP 9
#define ADAPTYST_ERR_WORKFLOW_RUNNING 10

#define ADAPTYST_IR_MLIR 100
#define ADAPTYST_IR_SINGLE_CMD 101
 
#ifdef __cplusplus
extern "C" {
#endif
  typedef struct {
    unsigned int type;

    void *data;
  } ir;

  typedef enum {
    INT = 1,
    STRING = 2,
    UNSIGNED_INT = 3,
    BOOL = 4,
    NONE = 0
  } option_type;

  typedef struct {
    option_type type;

    void *data;

    unsigned int len;
  } option;

  typedef enum {
    LINUX_PROCESS = 0
  } profile_type;

  typedef struct {
    profile_type type;
    union {
      int pid;
    } data;
  } profile_info;

  const char *adaptyst_get_library_dir(amod_t id);

  option *adaptyst_get_option(amod_t id, const char *key);

  bool adaptyst_set_error(amod_t id, const char *msg);

  const char *adaptyst_get_log_dir(amod_t id);

  bool adaptyst_send_data(amod_t id, char *buf, unsigned int n);

  bool adaptyst_receive_data(amod_t id, char *buf, unsigned int buf_size, int *n);

  bool adaptyst_receive_data_timeout(amod_t id, char *buf, unsigned int buf_size,
                                     int *n, long timeout_seconds);

  bool adaptyst_send_string(amod_t id, const char *str);

  bool adaptyst_receive_string(amod_t id, const char **str);

  bool adaptyst_receive_string_timeout(amod_t id, const char **str,
                                       long timeout_seconds);

  const char *adaptyst_get_node_name(amod_t id);

  bool adaptyst_log(amod_t id, const char *msg, const char *type);

  bool adaptyst_print(amod_t id, const char *msg, bool sub, bool error,
                      const char *type);

  const char *adaptyst_get_module_dir(amod_t id);

  profile_info *adaptyst_get_profile_info(amod_t id);

  bool adaptyst_set_profile_info(amod_t id, profile_info *info);

  bool adaptyst_is_directing_node(amod_t id);

  bool adaptyst_profile_notify(amod_t id);

  int adaptyst_profile_wait(amod_t id);

  bool adaptyst_process_src_paths(amod_t id, const char **paths, int n);

  const char *adaptyst_get_cpu_mask(amod_t id);

  const char *adaptyst_get_tmp_dir(amod_t id);

  const char *adaptyst_get_local_config_dir(amod_t id);

  bool adaptyst_set_will_profile(amod_t id, bool will_profile);

  bool adaptyst_has_in_tag(amod_t id, const char *tag);

  bool adaptyst_has_out_tag(amod_t id, const char *tag);

  int adaptyst_get_internal_error_code(amod_t id);

  const char *adaptyst_get_internal_error_msg(amod_t id);

  unsigned long long adaptyst_get_timestamp(amod_t id);

  unsigned long long adaptyst_get_workflow_start_time(amod_t id);

  unsigned long long adaptyst_get_workflow_end_time(amod_t id);

  bool adaptyst_is_workflow_running(amod_t id);
 
#ifdef ADAPTYST_MODULE_ENTRYPOINT
  bool adaptyst_module_init(amod_t module_id);
  bool adaptyst_module_process(amod_t module_id, ir workflow);
  void adaptyst_module_close(amod_t module_id);
 
  bool adaptyst_region_start(amod_t module_id, const char *name,
                             const char *part_id, const char *timestamp_str);
  bool adaptyst_region_end(amod_t module_id, const char *name,
                           const char *part_id, const char *timestamp_str);
#endif
#ifdef __cplusplus
}
#endif
 
#endif