From 0c7e73043842511e3e6eb9c5f9cd4c942c07b820 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominic=20H=C3=B6glinger?= Date: Wed, 14 May 2025 21:10:19 +0200 Subject: [PATCH] Finalize name change from PET to SET There were still a few references to PET, which are corrected. --- set.c | 16 ++++++++-------- set.h | 17 ++++++++--------- set_record.py | 12 ++++++------ 3 files changed, 22 insertions(+), 23 deletions(-) diff --git a/set.c b/set.c index a0781ca..f19a96a 100644 --- a/set.c +++ b/set.c @@ -1,5 +1,5 @@ /* - * PET: Pocket Event Trace - A tiny tracing library + * SET: Streaming Event Trace - A tiny tracing library * Copyright (C) 2025 Dominic Hoeglinger * * Permission is hereby granted, free of charge, to any person obtaining a copy @@ -21,7 +21,7 @@ * SOFTWARE. */ -#include "pet.h" +#include "set.h" #define SET_NIBBLE_TO_HEX(nibble) ((nibble) < 10 ? (nibble) + '0' : (nibble) - 10 + 'A') #define SET_NIBBLE(value, nibble) ((value >> nibble) & 0xF) @@ -317,27 +317,27 @@ void set_diagtrace(void) { const uint32_t buffer_health = ((s_tracebuffer_size - s_tracebuffer_items) * 0xFF)/s_tracebuffer_size; - set_u32trace("PET.BufferItems", s_tracebuffer_items, false); - set_u8trace("PET.BufferHealth", (uint8_t)buffer_health, true); + set_u32trace("SET.BufferItems", s_tracebuffer_items, false); + set_u8trace("SET.BufferHealth", (uint8_t)buffer_health, true); if (s_diag_avg_compression_n > 0) { const uint32_t average = s_diag_avg_compression_total / s_diag_avg_compression_n; - set_u8trace("PET.CompressionLevel", (uint8_t)average, true); + set_u8trace("SET.CompressionLevel", (uint8_t)average, true); s_diag_avg_compression_total = 0; s_diag_avg_compression_n = 0; } if (s_diag_items_sent > 0) { - set_u32trace("PET.ItemsSent", s_diag_items_sent, true); + set_u32trace("SET.ItemsSent", s_diag_items_sent, true); s_diag_items_sent = 0; } if (s_diag_avg_ctime_n > 0) { const uint32_t average = s_diag_avg_ctime_total / s_diag_avg_ctime_n; - set_u8trace("PET.CompressionTime", (uint8_t)average, true); + set_u8trace("SET.CompressionTime", (uint8_t)average, true); s_diag_avg_ctime_total = 0; s_diag_avg_ctime_n = 0; } @@ -346,7 +346,7 @@ void set_diagtrace(void) if (s_diag_avg_rtime_n > 0) { const uint32_t average = s_diag_avg_rtime_total / s_diag_avg_rtime_n; - set_u8trace("PET.RenderTime", (uint8_t)average, true); + set_u8trace("SET.RenderTime", (uint8_t)average, true); s_diag_avg_rtime_total = 0; s_diag_avg_rtime_n = 0; } diff --git a/set.h b/set.h index 1bcb458..1c7c7af 100644 --- a/set.h +++ b/set.h @@ -1,5 +1,5 @@ /* - * PET: Pocket Event Trace - A tiny tracing library + * SET: Streaming Event Trace - A tiny tracing library * Copyright (C) 2025 Dominic Hoeglinger * * Permission is hereby granted, free of charge, to any person obtaining a copy @@ -72,8 +72,7 @@ uint32_t set_timestamp(void); */ void set_crit_on(uint32_t *h); -/** @brief Integration hook which locks the tracebuffer - * This can be for instance a mutex or interrupt lock. +/** @brief Integration hook which unlocks the tracebuffer * @param[in] h handle value set by #set_crit_on */ void set_crit_off(const uint32_t h); @@ -143,12 +142,12 @@ size_t set_render(char buffer[], const size_t buffer_size, const size_t n, const /** @brief Adds diagnostic samples to the tracebuffer * Signals include: - * - PET.BufferItems:u32 - The current amount of tracebuffer items - * - PET.BufferHealth:u8 - The buffer utilization, zero means that the buffer is full while 255 means the buffer is free - * - PET.CompressionLevel:u8 - The average compression level if packets are rendered compressed - * - PET.CompressionTime:u32 - The average compression time spent for one packet render - * - PET.RenderTime:u32 - The average render time for one packet - * - PET.ItemsSent:u32 - The number of items sent since the last call to this function + * - SET.BufferItems:u32 - The current amount of tracebuffer items + * - SET.BufferHealth:u8 - The buffer utilization, zero means that the buffer is full while 255 means the buffer is free + * - SET.CompressionLevel:u8 - The average compression level if packets are rendered compressed + * - SET.CompressionTime:u32 - The average compression time spent for one packet render + * - SET.RenderTime:u32 - The average render time for one packet + * - SET.ItemsSent:u32 - The number of items sent since the last call to this function * @return None */ void set_diagtrace(void); diff --git a/set_record.py b/set_record.py index 1b2163f..6fa8617 100644 --- a/set_record.py +++ b/set_record.py @@ -482,12 +482,12 @@ def main(): predefined_signals = [] if enable_diag: predefined_signals += [ - 'PET.BufferItems:u32', - 'PET.BufferHealth:u8', - 'PET.CompressionLevel:u8', - 'PET.CompressionTime:u32', - 'PET.RenderTime:u32', - 'PET.ItemsSent:u32' + 'SET.BufferItems:u32', + 'SET.BufferHealth:u8', + 'SET.CompressionLevel:u8', + 'SET.CompressionTime:u32', + 'SET.RenderTime:u32', + 'SET.ItemsSent:u32' ] signals, signals_valid = scan_for_signals(source_tree, predefined_signals)