Skip to content

Tools: Testbench: Track and print heap usage for modules #10593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
singalsu wants to merge 1 commit into
base: main
Choose a base branch
from
+74 −19
Open

Tools: Testbench: Track and print heap usage for modules #10593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions tools/testbench/include/testbench/utils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,11 @@ struct testbench_prm {
#endif
};

struct tb_heap_usage_record {
char *module_name;
size_t heap_max;
};
Comment on lines +151 to +154
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This introduces a new cross-file API (tb_collect_heap_usage) and data contract (tb_heap_usage_record) but doesn’t document key expectations (e.g., module_name ownership/lifetime, whether heap_max is bytes, and whether it is “peak”/HWM). Adding a short comment block near the struct/function would make the usage clearer and reduce coupling to implementation details.

Copilot uses AI. Check for mistakes.

extern int debug;

int tb_decode_enum(struct snd_soc_tplg_enum_control *enum_ctl, char *token);
Expand All @@ -169,6 +174,7 @@ int tb_set_up_all_pipelines(struct testbench_prm *tp);
int tb_setup(struct sof *sof, struct testbench_prm *tp);
bool tb_is_pipeline_enabled(struct testbench_prm *tp, int pipeline_id);
bool tb_schedule_pipeline_check_state(struct testbench_prm *tp);
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This introduces a new cross-file API (tb_collect_heap_usage) and data contract (tb_heap_usage_record) but doesn’t document key expectations (e.g., module_name ownership/lifetime, whether heap_max is bytes, and whether it is “peak”/HWM). Adding a short comment block near the struct/function would make the usage clearer and reduce coupling to implementation details.

Suggested change
bool tb_schedule_pipeline_check_state(struct testbench_prm *tp);
bool tb_schedule_pipeline_check_state(struct testbench_prm *tp);
/**
* tb_collect_heap_usage - Collect per-module heap usage statistics.
* @tp: Testbench context; must remain valid for the duration of the call.
* @rec: Caller-allocated array of tb_heap_usage_record entries to fill.
* The function writes at most *@count records and does not retain
* a pointer to this array after returning.
* @count: In/out parameter. On entry, *@count specifies the maximum
* number of records that can be written to @rec. On return,
* *@count is set to the number of valid records populated.
*
* Each tb_heap_usage_record describes the heap usage of a single module
* (or module instance). The tb_heap_usage_record::module_name field, if
* non-NULL, points to a NUL-terminated string whose storage is owned by
* the caller or a longer-lived topology object; tb_collect_heap_usage
* does not take ownership, free, or duplicate this string, and it is only
* required to remain valid for the duration of this call.
*
* The tb_heap_usage_record::heap_max field is expressed in bytes and
* represents the maximum (peak/high-water mark) heap usage observed for
* the corresponding module since it was created.
*/

Copilot uses AI. Check for mistakes.
void tb_collect_heap_usage(struct testbench_prm *tp, struct tb_heap_usage_record *rec, int *count);
void tb_debug_print(char *message);
void tb_free(struct sof *sof);
void tb_free_topology(struct testbench_prm *tp);
Expand Down
45 changes: 26 additions & 19 deletions tools/testbench/testbench.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,9 @@ static int parse_input_args(int argc, char **argv, struct testbench_prm *tp)
return ret;
}

static void test_pipeline_stats(struct testbench_prm *tp, long long delta_t)
static void test_pipeline_stats(struct testbench_prm *tp, long long delta_t,
struct tb_heap_usage_record *heap_records,
int heap_records_count)
{
long long file_cycles, pipeline_cycles;
float pipeline_mcps;
Expand Down Expand Up @@ -284,22 +286,28 @@ static void test_pipeline_stats(struct testbench_prm *tp, long long delta_t)
frames_out = n_out / tp->channels_out;
printf("Input sample (frame) count: %d (%d)\n", n_in, n_in / tp->channels_in);
printf("Output sample (frame) count: %d (%d)\n", n_out, frames_out);
if (heap_records_count > 0) {
for (i = 0; i < heap_records_count; i++)
printf("Heap usage for module %s: %u bytes\n",
heap_records[i].module_name, (uint32_t)heap_records[i].heap_max);
Comment on lines +291 to +292
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

heap_max is a size_t, but it’s printed via a (uint32_t) cast and %u, which can truncate on 64-bit platforms and produce incorrect output. Prefer printing size_t with %zu and remove the cast to preserve the actual peak heap value.

Suggested change
printf("Heap usage for module %s: %u bytes\n",
heap_records[i].module_name, (uint32_t)heap_records[i].heap_max);
printf("Heap usage for module %s: %zu bytes\n",
heap_records[i].module_name, heap_records[i].heap_max);

Copilot uses AI. Check for mistakes.
Copy link
Collaborator Author

@singalsu singalsu Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't use "%zu" with xt-clang for xtensa. It just prints as zu when run.

}

printf("\n");
if (tp->total_cycles) {
pipeline_cycles = tp->total_cycles - file_cycles;
pipeline_mcps = (float)pipeline_cycles * tp->fs_out / frames_out / 1e6;
if (tb_check_trace(LOG_LEVEL_DEBUG))
printf("Warning: Use -d 3 or smaller value to avoid traces to increase MCPS.\n");

printf("Total execution cycles: %lld\n", tp->total_cycles);
printf("File component cycles: %lld\n", file_cycles);
printf("Pipeline cycles: %lld\n", pipeline_cycles);
printf("Pipeline MCPS: %6.2f\n", pipeline_mcps);
if (tb_check_trace(LOG_LEVEL_DEBUG))
printf("Warning: Use -d 3 or smaller value to avoid traces to increase MCPS.\n");
printf("Pipeline MCPS: %6.2f\n\n", pipeline_mcps);
}

if (delta_t)
printf("Total execution time: %lld us, %.2f x realtime\n",
delta_t, (float)frames_out / tp->fs_out * 1000000 / delta_t);

printf("\n");
printf("Total execution time: %lld us, %.2f x realtime\n\n", delta_t,
(float)frames_out / tp->fs_out * 1000000 / delta_t);
}

/*
Expand All @@ -308,14 +316,16 @@ static void test_pipeline_stats(struct testbench_prm *tp, long long delta_t)
*/
static int pipline_test(struct testbench_prm *tp)
{
float samples_to_ns;
int dp_count = 0;
struct timespec td0, td1;
struct tb_heap_usage_record heap_usage_records[TB_NUM_WIDGETS_SUPPORTED];
struct file_state *out_stat;
long long delta_t;
struct timespec td0 = {0}, td1 = {0};
long long delta_t = 0;
int64_t next_control_ns;
int64_t time_ns;
float samples_to_ns;
int err;
int heap_usage_records_count = 0;
int dp_count = 0;

/* build, run and teardown pipelines */
while (dp_count < tp->dynamic_pipeline_iterations) {
Expand Down Expand Up @@ -392,8 +402,10 @@ static int pipline_test(struct testbench_prm *tp)
}

tb_schedule_pipeline_check_state(tp); /* Once more to flush out remaining data */

tb_gettime(&td1);
delta_t = (td1.tv_sec - td0.tv_sec) * 1000000;
delta_t += (td1.tv_nsec - td0.tv_nsec) / 1000;
tb_collect_heap_usage(tp, heap_usage_records, &heap_usage_records_count);

out:
err = tb_set_reset_state(tp);
Expand All @@ -403,12 +415,7 @@ static int pipline_test(struct testbench_prm *tp)
break;
}

/* TODO: This should be printed after reset and free to get cleaner output
* but the file internal status would be lost there.
*/
delta_t = (td1.tv_sec - td0.tv_sec) * 1000000;
delta_t += (td1.tv_nsec - td0.tv_nsec) / 1000;
test_pipeline_stats(tp, delta_t);
test_pipeline_stats(tp, delta_t, heap_usage_records, heap_usage_records_count);

err = tb_free_all_pipelines(tp);
if (err < 0) {
Expand Down
4 changes: 4 additions & 0 deletions tools/testbench/utils_ipc3.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,4 +441,8 @@ int tb_set_bytes_control(struct testbench_prm *tp, struct tb_ctl *ctl, uint32_t
return 0;
}

void tb_collect_heap_usage(struct testbench_prm *tp, struct tb_heap_usage_record *rec, int *count)
{
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The IPC3 stub doesn’t set *count, so callers that don’t pre-initialize the out param can observe an uninitialized value. Set *count = 0 unconditionally (and consider explicitly marking tp/rec unused) to keep the API behavior consistent across IPC3/IPC4.

Suggested change
{
{
(void)tp;
(void)rec;
*count = 0;

Copilot uses AI. Check for mistakes.
}

#endif /* CONFIG_IPC_MAJOR_3 */
38 changes: 38 additions & 0 deletions tools/testbench/utils_ipc4.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

#if CONFIG_IPC_MAJOR_4

#include <sof/audio/module_adapter/module/generic.h>
#include <sof/audio/component_ext.h>
#include <sof/lib/notifier.h>
#include <sof/audio/component_ext.h>
Expand Down Expand Up @@ -702,4 +703,41 @@ int tb_set_bytes_control(struct testbench_prm *tp, struct tb_ctl *ctl, uint32_t
(struct sof_abi_hdr *)data);
}

void tb_collect_heap_usage(struct testbench_prm *tp, struct tb_heap_usage_record *records,
int *count_out)
{
struct list_item *item;
size_t hwm;
int count = 0;

list_for_item(item, &tp->widget_list) {
struct tplg_comp_info *info = container_of(item, struct tplg_comp_info, item);
uint32_t comp_id = IPC4_COMP_ID(info->module_id, info->instance_id);
struct comp_dev *dev = ipc4_get_comp_dev(comp_id);

if (!dev || !dev->mod)
continue;

/* In testbench environment, skip AIF/DAI because they are not real components. */
if (info->type == SND_SOC_TPLG_DAPM_AIF_IN ||
info->type == SND_SOC_TPLG_DAPM_AIF_OUT ||
info->type == SND_SOC_TPLG_DAPM_DAI_IN ||
info->type == SND_SOC_TPLG_DAPM_DAI_OUT)
continue;

if (count >= TB_NUM_WIDGETS_SUPPORTED) {
fprintf(stderr, "Error: Too many components for heap records, max %d.\n",
TB_NUM_WIDGETS_SUPPORTED);
break;
}

module_adapter_heap_usage(dev->mod, &hwm);
records[count].module_name = info->name;
records[count].heap_max = hwm;
count++;
}

*count_out = count;
}

#endif /* CONFIG_IPC_MAJOR_4 */
Loading