yac_pak.h

Go to the documentation of this file.

// Copyright (c) 2026 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
/*
 * YAC PAK - YAC Performance Analysis Kit
 * Lightweight per-rank event tracing tool
 */
 
#ifndef YAC_PAK_H
#define YAC_PAK_H
 
#include <mpi.h>
#include <stdio.h>
 
#define YAC_PAK_VERSION_MAJOR  0
#define YAC_PAK_VERSION_MINOR  1
#define YAC_PAK_VERSION_PATCH  2
#define YAC_PAK_VERSION_STRING "0.1.2"
 
struct yac_pak;
 
typedef enum {
  YAC_PAK_EVENT_TYPE_INIT     = 0,
  YAC_PAK_EVENT_TYPE_DEF_COMP,
  YAC_PAK_EVENT_TYPE_SYNC_DEF,
  YAC_PAK_EVENT_TYPE_ENDDEF,
  YAC_PAK_EVENT_TYPE_FINALIZE,
  YAC_PAK_EVENT_TYPE_GET,
  YAC_PAK_EVENT_TYPE_AGET,
  YAC_PAK_EVENT_TYPE_PUT,
  YAC_PAK_EVENT_TYPE_REGION,
  YAC_PAK_EVENT_TYPE_UPDATE,
  YAC_PAK_EVENT_TYPE_WAIT,
} yac_pak_event_type_t;
 
typedef enum {
  YAC_PAK_TRACE_LEVEL_OFF      = 0, 
  YAC_PAK_TRACE_LEVEL_COUPLING = 1, 
  YAC_PAK_TRACE_LEVEL_REGIONS  = 2, 
  YAC_PAK_TRACE_LEVEL_MAX      = YAC_PAK_TRACE_LEVEL_REGIONS, 
} yac_pak_trace_level_t;
 
struct yac_pak * yac_pak_new(MPI_Comm comm, int capacity);
 
void yac_pak_delete(struct yac_pak * pak);
 
int yac_pak_register(struct yac_pak * pak, char const * name);
 
int yac_pak_start(struct yac_pak * pak, int idx);
 
int yac_pak_stop(struct yac_pak * pak, int idx);
 
int yac_pak_report(struct yac_pak * pak, FILE * out);
 
int yac_pak_trace_is_enabled(struct yac_pak const * pak);
 
int yac_pak_setup_trace_is_enabled(struct yac_pak const * pak);
 
int yac_pak_trace_stop(struct yac_pak * pak, int handle);
 
int yac_pak_flush_trace(struct yac_pak * pak);
 
int yac_pak_trace_start_ex(struct yac_pak * pak,
                           char const * field,
                           char const * component,
                           char const * grid,
                           yac_pak_event_type_t type,
                           int put_idx,
                           char const * datetime,
                           int action,
                           yac_pak_trace_level_t level);
 
int yac_pak_region_trace_is_enabled(
  struct yac_pak const * pak, yac_pak_trace_level_t level);
 
int yac_pak_trace_start_setup(struct yac_pak * pak,
                              char const * name, yac_pak_event_type_t type);
 
int yac_pak_trace_record(struct yac_pak * pak,
                         char const * field, char const * component,
                         char const * grid, yac_pak_event_type_t type,
                         double tstart, double tend);
 
char const * yac_pak_get_config_output_path(struct yac_pak const * pak);
 
void yac_pak_set_component(
  struct yac_pak * pak, char const * comp_name,
  int comp_rank, int comp_size);
 
  /* end of yac_pak group */
 
#endif /* YAC_PAK_H */