yac_pak_instrument.c

Go to the documentation of this file.

// Copyright (c) 2026 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
/*
 * YAC PAK: bridge from  YAC core instrumentation interface to YAC PAK trace
 * events.
 */
 
#include "yac_pak_instrument.h"
#include "instrument.h"
#include "yac_pak.h"
#include "utils_common.h"
 
/* State of single active tracing window. Only one window can be active
 * in the process at a time, because core instrumentation callbacks are
 * process-global (see yac_instrument_set_callbacks). */
static struct yac_pak *      window_pak       = NULL;
static yac_pak_trace_level_t window_level     = YAC_PAK_TRACE_LEVEL_OFF;
static char const *          window_component = NULL;
static char const *          window_grid      = NULL;
static int                   window_active    = 0;
 
/* Pending YAC PAK event handle per instrumentation nesting depth. Core
 * guarantees strict LIFO nesting and that a given region id is open at most
 * once, so at most YAC_INSTR_REGION_COUNT regions can be open simultaneously
 * and the depth never exceeds this bound. */
static int window_handles[YAC_INSTR_REGION_COUNT];
 
static void pak_instrument_start_cb(
  int id, void * region_handle, int depth, void * user_data) {
 
  UNUSED(region_handle);
  UNUSED(user_data);
 
  YAC_ASSERT_F(
    depth >= 0 && depth < YAC_INSTR_REGION_COUNT,
    "instrumentation region depth %d out of range", depth)
 
  window_handles[depth] =
    yac_pak_trace_start_ex(
      window_pak,
      yac_instrument_region_name((yac_instrument_region_id)id),
      window_component, window_grid, YAC_PAK_EVENT_TYPE_REGION,
      -1, NULL, -1, window_level);
}
 
static void pak_instrument_stop_cb(
  int id, void * region_handle, int depth, void * user_data) {
 
  UNUSED(id);
  UNUSED(region_handle);
  UNUSED(user_data);
 
  YAC_ASSERT_F(
    depth >= 0 && depth < YAC_INSTR_REGION_COUNT,
    "instrumentation region depth %d out of range", depth)
 
  yac_pak_trace_stop(window_pak, window_handles[depth]);
  window_handles[depth] = -1;
}
 
void yac_pak_instrument_begin(
  struct yac_pak * pak, yac_pak_trace_level_t level,
  char const * component, char const * grid) {
 
  window_active = 0;
 
  if (!yac_pak_region_trace_is_enabled(pak, level)) return;
 
  window_pak       = pak;
  window_level     = level;
  window_component = component;
  window_grid      = grid;
  for (int i = 0; i < YAC_INSTR_REGION_COUNT; ++i) window_handles[i] = -1;
 
  yac_instrument_set_callbacks(
    NULL, pak_instrument_start_cb, pak_instrument_stop_cb, NULL, NULL);
 
  window_active = 1;
}
 
void yac_pak_instrument_end(void) {
 
  if (!window_active) return;
 
  yac_instrument_clear_callbacks();
 
  window_active    = 0;
  window_pak       = NULL;
  window_component = NULL;
  window_grid      = NULL;
}