efc5fe07a2
The existing stack_analyze APIs had some problems: 1. Not properly namespaced 2. Accepted the stack object as a parameter, yet the stack object does not contain the necessary information to get the associated buffer region, the thread object is needed for this 3. Caused a crash on certain platforms that do not allow inspection of unused stack space for the currently running thread 4. No user mode access 5. Separately passed in thread name We deprecate these functions and add a new API k_thread_stack_space_get() which addresses all of these issues. A helper API log_stack_usage() also added which resembles STACK_ANALYZE() in functionality. Fixes: #17852 Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
137 lines
3.0 KiB
C
137 lines
3.0 KiB
C
/*
|
|
* Copyright (c) 2017 Intel Corporation
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#include <ztest.h>
|
|
#include <power/power.h>
|
|
#include <irq_offload.h>
|
|
#include <debug/stack.h>
|
|
|
|
#define SLEEP_MS 100
|
|
#define NUM_OF_WORK 2
|
|
#define TEST_STRING "TEST"
|
|
|
|
static struct k_work work[NUM_OF_WORK];
|
|
static struct k_sem sync_sema;
|
|
|
|
/**TESTPOINT: stack analyze*/
|
|
static void tdata_dump_callback(const struct k_thread *thread, void *user_data)
|
|
{
|
|
log_stack_usage(thread);
|
|
}
|
|
|
|
/*
|
|
* Weak power hook functions. Used on systems that have not implemented
|
|
* power management.
|
|
*/
|
|
__weak void sys_set_power_state(enum power_states state)
|
|
{
|
|
/* Never called. */
|
|
__ASSERT_NO_MSG(false);
|
|
}
|
|
|
|
__weak void _sys_pm_power_state_exit_post_ops(enum power_states state)
|
|
{
|
|
/* Never called. */
|
|
__ASSERT_NO_MSG(false);
|
|
}
|
|
|
|
/* Our PM policy handler */
|
|
enum power_states sys_pm_policy_next_state(s32_t ticks)
|
|
{
|
|
static bool test_flag;
|
|
|
|
/* Call k_thread_foreach only once otherwise it will
|
|
* flood the console with stack dumps.
|
|
*/
|
|
if (!test_flag) {
|
|
k_thread_foreach(tdata_dump_callback, NULL);
|
|
test_flag = true;
|
|
}
|
|
|
|
return SYS_POWER_STATE_ACTIVE;
|
|
}
|
|
|
|
/*work handler*/
|
|
static void work_handler(struct k_work *w)
|
|
{
|
|
k_thread_foreach(tdata_dump_callback, NULL);
|
|
k_sem_give(&sync_sema);
|
|
}
|
|
|
|
/**
|
|
* @brief Tests for kernel profiling
|
|
* @defgroup kernel_profiling_tests Profiling
|
|
* @ingroup all_tests
|
|
* @{
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @brief Test stack usage through main thread
|
|
*
|
|
* This test prints the main, idle, interrupt and system workqueue
|
|
* stack usage through main thread.
|
|
*
|
|
* @ingroup kernel_profiling_tests
|
|
*
|
|
* @see k_thread_foreach(), stack_analyze()
|
|
*/
|
|
void test_call_stacks_analyze_main(void)
|
|
{
|
|
TC_PRINT("from main thread:\n");
|
|
k_thread_foreach(tdata_dump_callback, NULL);
|
|
}
|
|
|
|
/**
|
|
* @brief Test stack usage through idle thread
|
|
*
|
|
* This test prints the main, idle, interrupt and system workqueue
|
|
* stack usage through idle thread.
|
|
*
|
|
* @ingroup kernel_profiling_tests
|
|
*
|
|
* @see k_thread_foreach(), _sys_suspend(), _sys_resume(),
|
|
* stack_analyze()
|
|
*/
|
|
void test_call_stacks_analyze_idle(void)
|
|
{
|
|
TC_PRINT("from idle thread:\n");
|
|
k_sleep(SLEEP_MS);
|
|
}
|
|
|
|
/**
|
|
* @brief Test stack usage through system workqueue
|
|
*
|
|
* This test prints the main, idle, interrupt and system workqueue
|
|
* stack usage through system workqueue.
|
|
*
|
|
* @ingroup kernel_profiling_tests
|
|
*
|
|
* @see k_thread_foreach(), k_work_init(), k_work_submit(),
|
|
* stack_analyze()
|
|
*/
|
|
void test_call_stacks_analyze_workq(void)
|
|
{
|
|
TC_PRINT("from workq:\n");
|
|
k_sem_init(&sync_sema, 0, NUM_OF_WORK);
|
|
for (int i = 0; i < NUM_OF_WORK; i++) {
|
|
k_work_init(&work[i], work_handler);
|
|
k_work_submit(&work[i]);
|
|
k_sem_take(&sync_sema, K_FOREVER);
|
|
}
|
|
}
|
|
|
|
/*TODO: add test case to capture the usage of interrupt call stack*/
|
|
|
|
void test_main(void)
|
|
{
|
|
ztest_test_suite(profiling_api,
|
|
ztest_unit_test(test_call_stacks_analyze_main),
|
|
ztest_1cpu_unit_test(test_call_stacks_analyze_idle),
|
|
ztest_1cpu_unit_test(test_call_stacks_analyze_workq));
|
|
ztest_run_test_suite(profiling_api);
|
|
}
|