Tracing: Thread tracing

Add thread tracing hooks, default hooks, and documentation.

Signed-off-by: Torbjörn Leksell <[email protected]>

Author: tleksell-pe

include/tracing/tracing.h

@@ -35,112 +35,283 @@
  * @defgroup tracing_apis Tracing APIs
  * @{
  */
+
 /**
- * @brief Called before a thread has been selected to run
+ * @brief Called when entering an ISR
  */
-#define sys_trace_thread_switched_out()
+#define sys_trace_isr_enter()
 
 /**
- * @brief Called after a thread has been selected to run
+ * @brief Called when exiting an ISR
  */
-#define sys_trace_thread_switched_in()
+#define sys_trace_isr_exit()
 
 /**
- * @brief Called when setting priority of a thread
- * @param thread Thread structure
+ * @brief Called when exiting an ISR and switching to scheduler
  */
-#define sys_trace_thread_priority_set(thread)
+#define sys_trace_isr_exit_to_scheduler()
 
 /**
- * @brief Called when a thread is being created
- * @param thread Thread structure
+ * @brief Called when the cpu enters the idle state
  */
-#define sys_trace_thread_create(thread)
+#define sys_trace_idle()
+/**
+ * @}
+ */
+
+
+/**
+ * @brief Tracing APIs
+ * @defgroup tracing_apis Tracing APIs
+ * @{
+ */
+
+
+/**
+ * @brief Thread Tracing APIs
+ * @defgroup thread_tracing_apis Thread Tracing APIs
+ * @ingroup tracing_apis
+ * @{
+ */
+
+/**
+ * @brief Called when entering a k_thread_foreach call
+ */
+#define sys_port_trace_k_thread_foreach_enter()
+
+/**
+ * @brief Called when exiting a k_thread_foreach call
+ */
+#define sys_port_trace_k_thread_foreach_exit()
+
+/**
+ * @brief Called when entering a k_thread_foreach_unlocked
+ */
+#define sys_port_trace_k_thread_foreach_unlocked_enter()
+
+/**
+ * @brief Called when exiting a k_thread_foreach_unlocked
+ */
+#define sys_port_trace_k_thread_foreach_unlocked_exit()
+
+/**
+ * @brief Trace creating a Thread
+ * @param new_thread Thread object
+ */
+#define sys_port_trace_k_thread_create(new_thread)
+
+/**
+ * @brief Trace Thread entering user mode
+ */
+#define sys_port_trace_k_thread_user_mode_enter()
+
+/**
+ * @brief Called when entering a k_thread_join
+ * @param thread Thread object
+ * @param timeout Timeout period
+ */
+#define sys_port_trace_k_thread_join_enter(thread, timeout)
+
+/**
+ * @brief Called when k_thread_join blocks
+ * @param thread Thread object
+ * @param timeout Timeout period
+ */
+#define sys_port_trace_k_thread_join_blocking(thread, timeout)
+
+/**
+ * @brief Called when exiting k_thread_join
+ * @param thread Thread object
+ * @param timeout Timeout period
+ * @param ret Return value
+ */
+#define sys_port_trace_k_thread_join_exit(thread, timeout, ret)
+
+/**
+ * @brief Called when entering k_thread_sleep
+ * @param timeout Timeout period
+ */
+#define sys_port_trace_k_thread_sleep_enter(timeout)
+
+/**
+ * @brief Called when exiting k_thread_sleep
+ * @param timeout Timeout period
+ * @param ret Return value
+ */
+#define sys_port_trace_k_thread_sleep_exit(timeout, ret)
+
+/**
+ * @brief Called when entering k_thread_msleep
+ * @param ms Duration in milliseconds
+ */
+#define sys_port_trace_k_thread_msleep_enter(ms)
+
+/**
+ * @brief Called when exiting k_thread_msleep
+ * @param ms Duration in milliseconds
+ * @param ret Return value
+ */
+#define sys_port_trace_k_thread_msleep_exit(ms, ret)
+
+/**
+ * @brief Called when entering k_thread_usleep
+ * @param us Duration in microseconds
+ */
+#define sys_port_trace_k_thread_usleep_enter(us)
+
+/**
+ * @brief Called when exiting k_thread_usleep
+ * @param us Duration in microseconds
+ * @param ret Return value
+ */
+#define sys_port_trace_k_thread_usleep_exit(us, ret)
+
+/**
+ * @brief Called when entering k_thread_busy_wait
+ * @param usec_to_wait Duration in microseconds
+ */
+#define sys_port_trace_k_thread_busy_wait_enter(usec_to_wait)
+
+/**
+ * @brief Called when exiting k_thread_busy_wait
+ * @param usec_to_wait Duration in microseconds
+ */
+#define sys_port_trace_k_thread_busy_wait_exit(usec_to_wait)
+
+/**
+ * @brief Called when a thread yields
+ */
+#define sys_port_trace_k_thread_yield()
+
+/**
+ * @brief Called when a thread wakes up
+ * @param thread Thread object
+ */
+#define sys_port_trace_k_thread_wakeup(thread)
+
+/**
+ * @brief Called when a thread is started
+ * @param thread Thread object
+ */
+#define sys_port_trace_k_thread_start(thread)
 
 /**
  * @brief Called when a thread is being aborted
- * @param thread Thread structure
- *
+ * @param thread Thread object
+ */
+#define sys_port_trace_k_thread_abort(thread)
+
+/**
+ * @brief Called when setting priority of a thread
+ * @param thread Thread object
  */
-#define sys_trace_thread_abort(thread)
+#define sys_port_trace_k_thread_priority_set(thread)
 
 /**
  * @brief Called when a thread is being suspended
- * @param thread Thread structure
+ * @param thread Thread object
  */
-#define sys_trace_thread_suspend(thread)
+#define sys_port_trace_k_thread_suspend(thread)
 
 /**
  * @brief Called when a thread is being resumed from suspension
- * @param thread Thread structure
+ * @param thread Thread object
+ */
+#define sys_port_trace_k_thread_resume(thread)
+
+/**
+ * @brief Called when the thread scheduler is locked
+ */
+#define sys_port_trace_k_thread_sched_lock()
+
+/**
+ * @brief Called when the thread sceduler is unlocked
+ */
+#define sys_port_trace_k_thread_sched_unlock()
+
+/**
+ * @brief Called when a thread name is set
+ * @param thread Thread object
+ * @param ret Return value
+ */
+#define sys_port_trace_k_thread_name_set(thread, ret)
+
+/**
+ * @brief Called before a thread has been selected to run
+ */
+#define sys_port_trace_k_thread_switched_out()
+
+/**
+ * @brief Called after a thread has been selected to run
  */
-#define sys_trace_thread_resume(thread)
+#define sys_port_trace_k_thread_switched_in()
 
 /**
  * @brief Called when a thread is ready to run
- * @param thread Thread structure
+ * @param thread Thread object
  */
-#define sys_trace_thread_ready(thread)
+#define sys_port_trace_k_thread_ready(thread)
 
 /**
  * @brief Called when a thread is pending
- * @param thread Thread structure
+ * @param thread Thread object
  */
-#define sys_trace_thread_pend(thread)
+#define sys_port_trace_k_thread_pend(thread)
 
 /**
  * @brief Provide information about specific thread
- * @param thread Thread structure
+ * @param thread Thread object
  */
-#define sys_trace_thread_info(thread)
+#define sys_port_trace_k_thread_info(thread)
 
 /**
- * @brief Called when a thread name is set
- * @param thread Thread structure
+ * @brief Trace implicit thread wakup invocation by the scheduler
+ * @param thread Thread object
  */
-#define sys_trace_thread_name_set(thread)
+#define sys_port_trace_k_thread_sched_wakeup(thread)
 
 /**
- * @brief Called when entering an ISR
+ * @brief Trace implicit thread abort invocation by the scheduler
+ * @param thread Thread object
  */
-#define sys_trace_isr_enter()
+#define sys_port_trace_k_thread_sched_abort(thread)
 
 /**
- * @brief Called when exiting an ISR
+ * @brief Trace implicit thread set priority invocation by the scheduler
+ * @param thread Thread object
+ * @param prio Thread priority
  */
-#define sys_trace_isr_exit()
+#define sys_port_trace_k_thread_sched_priority_set(thread, prio)
 
 /**
- * @brief Called when exiting an ISR and switching to scheduler
+ * @brief Trace implicit thread ready invocation by the scheduler
+ * @param thread Thread object
  */
-#define sys_trace_isr_exit_to_scheduler()
+#define sys_port_trace_k_thread_sched_ready(thread)
 
 /**
- * @brief Can be called with any id signifying a new call
- * @param id ID of the operation that was started
+ * @brief Trace implicit thread pend invocation by the scheduler
+ * @param thread Thread object
  */
-#define sys_trace_void(id)
+#define sys_port_trace_k_thread_sched_pend(thread)
 
 /**
- * @brief Can be called with any id signifying ending a call
- * @param id ID of the operation that was completed
+ * @brief Trace implicit thread resume invocation by the scheduler
+ * @param thread Thread object
  */
-#define sys_trace_end_call(id)
+#define sys_port_trace_k_thread_sched_resume(thread)
 
 /**
- * @brief Called when the cpu enters the idle state
+ * @brief Trace implicit thread suspend invocation by the scheduler
+ * @param thread Thread object
  */
-#define sys_trace_idle()
+#define sys_port_trace_k_thread_sched_suspend(thread)
+
 /**
  * @}
- */
+ */ /* end of thread_tracing_apis */
 
 
-/**
- * @brief Tracing APIs
- * @defgroup tracing_apis Tracing APIs
- * @{
- */
 
 
 /**

kernel/include/ksched.h

@@ -141,13 +141,15 @@ static inline bool z_is_thread_queued(struct k_thread *thread)
 static inline void z_mark_thread_as_suspended(struct k_thread *thread)
 {
 	thread->base.thread_state |= _THREAD_SUSPENDED;
-	sys_trace_thread_suspend(thread);
+
+	SYS_PORT_TRACING_FUNC(k_thread, sched_suspend, thread);
 }
 
 static inline void z_mark_thread_as_not_suspended(struct k_thread *thread)
 {
 	thread->base.thread_state &= ~_THREAD_SUSPENDED;
-	sys_trace_thread_resume(thread);
+
+	SYS_PORT_TRACING_FUNC(k_thread, sched_resume, thread);
 }
 
 static inline void z_mark_thread_as_started(struct k_thread *thread)