kernel: Add k_thread_runtime_stats_is_enabled function

Add 'k_thread_runtime_stats_is_enabled' to 'usage.c', which's used to check whether runtime statistics collection is enabled for a thread. Signed-off-by: James Roy <[email protected]>
zephyrproject-rtos · Oct 25, 2024 · fc52903 · fc52903
1 parent 2f23313
commit fc52903
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/include/zephyr/kernel.h b/include/zephyr/kernel.h
@@ -6224,6 +6224,17 @@ int k_thread_runtime_stats_enable(k_tid_t thread);
  */
 int k_thread_runtime_stats_disable(k_tid_t thread);
 
+/**
+ * @brief Check if runtime statistics gathering is enabled for a thread
+ * 
+ * This function checks the status of runtime statistics gathering for the
+ * specified thread and returns the current usage_lock status.
+ * 
+ * @param thread ID of thread
+ * @return -EINVAL if invalid thread ID, otherwise return usage_lock status
+ */
+int k_thread_runtime_stats_is_enabled(k_tid_t thread);
+
 /**
  * @brief Enable gathering of system runtime statistics
  *

diff --git a/kernel/usage.c b/kernel/usage.c
@@ -272,6 +272,22 @@ int k_thread_runtime_stats_disable(k_tid_t  thread)
 
 	return 0;
 }
+
+int k_thread_runtime_stats_is_enabled(k_tid_t thread)
+{
+	int status;
+	k_spinlock_key_t key;
+
+	CHECKIF(thread == NULL) {
+		return -EINVAL;
+	}
+
+	key = k_spin_lock(&usage_lock);
+	status = thread->base.usage.track_usage;
+	k_spin_unlock(&usage_lock, key);
+
+	return status;
+}
 #endif /* CONFIG_SCHED_THREAD_USAGE_ANALYSIS */
 
 #ifdef CONFIG_SCHED_THREAD_USAGE_ALL

diff --git a/tests/kernel/usage/thread_runtime_stats/src/test_thread_runtime_stats.c b/tests/kernel/usage/thread_runtime_stats/src/test_thread_runtime_stats.c
@@ -225,6 +225,7 @@ ZTEST(usage_api, test_thread_stats_enable_disable)
 	k_sleep(K_TICKS(2));
 
 	k_thread_runtime_stats_enable(tid);
+	zassert_true(k_thread_runtime_stats_is_enabled(tid));
 	k_thread_runtime_stats_get(_current, &stats2);
 	k_thread_runtime_stats_get(tid, &helper_stats2);