Thread Tracing APIs

Thread Tracing APIs. More...

Macros
#define	sys_port_trace_k_thread_foreach_enter()
	Called when entering a k_thread_foreach call.
#define	sys_port_trace_k_thread_foreach_exit()
	Called when exiting a k_thread_foreach call.
#define	sys_port_trace_k_thread_foreach_unlocked_enter()
	Called when entering a k_thread_foreach_unlocked.
#define	sys_port_trace_k_thread_foreach_unlocked_exit()
	Called when exiting a k_thread_foreach_unlocked.
#define	sys_port_trace_k_thread_create(new_thread)
	Trace creating a Thread.
#define	sys_port_trace_k_thread_user_mode_enter()
	Trace Thread entering user mode.
#define	sys_port_trace_k_thread_join_enter(thread, timeout)
	Called when entering a k_thread_join.
#define	sys_port_trace_k_thread_join_blocking(thread, timeout)
	Called when k_thread_join blocks.
#define	sys_port_trace_k_thread_join_exit(thread, timeout, ret)
	Called when exiting k_thread_join.
#define	sys_port_trace_k_thread_sleep_enter(timeout)
	Called when entering k_thread_sleep.
#define	sys_port_trace_k_thread_sleep_exit(timeout, ret)
	Called when exiting k_thread_sleep.
#define	sys_port_trace_k_thread_msleep_enter(ms)
	Called when entering k_thread_msleep.
#define	sys_port_trace_k_thread_msleep_exit(ms, ret)
	Called when exiting k_thread_msleep.
#define	sys_port_trace_k_thread_usleep_enter(us)
	Called when entering k_thread_usleep.
#define	sys_port_trace_k_thread_usleep_exit(us, ret)
	Called when exiting k_thread_usleep.
#define	sys_port_trace_k_thread_busy_wait_enter(usec_to_wait)
	Called when entering k_thread_busy_wait.
#define	sys_port_trace_k_thread_busy_wait_exit(usec_to_wait)
	Called when exiting k_thread_busy_wait.
#define	sys_port_trace_k_thread_yield()
	Called when a thread yields.
#define	sys_port_trace_k_thread_wakeup(thread)
	Called when a thread wakes up.
#define	sys_port_trace_k_thread_start(thread)
	Called when a thread is started.
#define	sys_port_trace_k_thread_abort(thread)
	Called when a thread is being aborted.
#define	sys_port_trace_k_thread_abort_enter(thread)
	Called when a thread enters the k_thread_abort routine.
#define	sys_port_trace_k_thread_abort_exit(thread)
	Called when a thread exits the k_thread_abort routine.
#define	sys_port_trace_k_thread_priority_set(thread)
	Called when setting priority of a thread.
#define	sys_port_trace_k_thread_suspend_enter(thread)
	Called when a thread enters the k_thread_suspend function.
#define	sys_port_trace_k_thread_suspend_exit(thread)
	Called when a thread exits the k_thread_suspend function.
#define	sys_port_trace_k_thread_resume_enter(thread)
	Called when a thread enters the resume from suspension function.
#define	sys_port_trace_k_thread_resume_exit(thread)
	Called when a thread exits the resumed from suspension function.
#define	sys_port_trace_k_thread_sched_lock()
	Called when the thread scheduler is locked.
#define	sys_port_trace_k_thread_sched_unlock()
	Called when the thread scheduler is unlocked.
#define	sys_port_trace_k_thread_name_set(thread, ret)
	Called when a thread name is set.
#define	sys_port_trace_k_thread_switched_out()
	Called before a thread has been selected to run.
#define	sys_port_trace_k_thread_switched_in()
	Called after a thread has been selected to run.
#define	sys_port_trace_k_thread_ready(thread)
	Called when a thread is ready to run.
#define	sys_port_trace_k_thread_pend(thread)
	Called when a thread is pending.
#define	sys_port_trace_k_thread_info(thread)
	Provide information about specific thread.
#define	sys_port_trace_k_thread_sched_wakeup(thread)
	Trace implicit thread wakeup invocation by the scheduler.
#define	sys_port_trace_k_thread_sched_abort(thread)
	Trace implicit thread abort invocation by the scheduler.
#define	sys_port_trace_k_thread_sched_priority_set(thread, prio)
	Trace implicit thread set priority invocation by the scheduler.
#define	sys_port_trace_k_thread_sched_ready(thread)
	Trace implicit thread ready invocation by the scheduler.
#define	sys_port_trace_k_thread_sched_pend(thread)
	Trace implicit thread pend invocation by the scheduler.
#define	sys_port_trace_k_thread_sched_resume(thread)
	Trace implicit thread resume invocation by the scheduler.
#define	sys_port_trace_k_thread_sched_suspend(thread)
	Trace implicit thread suspend invocation by the scheduler.

Detailed Description

Thread Tracing APIs.

Macro Definition Documentation

sys_port_trace_k_thread_abort

#define sys_port_trace_k_thread_abort

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Called when a thread is being aborted.

Parameters

thread

Thread object

sys_port_trace_k_thread_abort_enter

#define sys_port_trace_k_thread_abort_enter

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Called when a thread enters the k_thread_abort routine.

Parameters

thread

Thread object

sys_port_trace_k_thread_abort_exit

#define sys_port_trace_k_thread_abort_exit

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Called when a thread exits the k_thread_abort routine.

Parameters

thread

Thread object

sys_port_trace_k_thread_busy_wait_enter

#define sys_port_trace_k_thread_busy_wait_enter

(

usec_to_wait

)

#include <include/zephyr/tracing/tracing.h>

Called when entering k_thread_busy_wait.

Parameters

usec_to_wait

Duration in microseconds

sys_port_trace_k_thread_busy_wait_exit

#define sys_port_trace_k_thread_busy_wait_exit

(

usec_to_wait

)

#include <include/zephyr/tracing/tracing.h>

Called when exiting k_thread_busy_wait.

Parameters

usec_to_wait

Duration in microseconds

sys_port_trace_k_thread_create

#define sys_port_trace_k_thread_create

(

new_thread

)

#include <include/zephyr/tracing/tracing.h>

Trace creating a Thread.

Parameters

new_thread

Thread object

sys_port_trace_k_thread_foreach_enter

#define sys_port_trace_k_thread_foreach_enter

(

)

#include <include/zephyr/tracing/tracing.h>

Called when entering a k_thread_foreach call.

sys_port_trace_k_thread_foreach_exit

#define sys_port_trace_k_thread_foreach_exit

(

)

#include <include/zephyr/tracing/tracing.h>

Called when exiting a k_thread_foreach call.

sys_port_trace_k_thread_foreach_unlocked_enter

#define sys_port_trace_k_thread_foreach_unlocked_enter

(

)

#include <include/zephyr/tracing/tracing.h>

Called when entering a k_thread_foreach_unlocked.

sys_port_trace_k_thread_foreach_unlocked_exit

#define sys_port_trace_k_thread_foreach_unlocked_exit

(

)

#include <include/zephyr/tracing/tracing.h>

Called when exiting a k_thread_foreach_unlocked.

sys_port_trace_k_thread_info

#define sys_port_trace_k_thread_info

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Provide information about specific thread.

Parameters

thread

Thread object

sys_port_trace_k_thread_join_blocking

#define sys_port_trace_k_thread_join_blocking	(		thread,
			timeout
	)

#include <include/zephyr/tracing/tracing.h>

Called when k_thread_join blocks.

Parameters

thread	Thread object
timeout	Timeout period

sys_port_trace_k_thread_join_enter

#define sys_port_trace_k_thread_join_enter	(		thread,
			timeout
	)

#include <include/zephyr/tracing/tracing.h>

Called when entering a k_thread_join.

Parameters

thread	Thread object
timeout	Timeout period

sys_port_trace_k_thread_join_exit

#define sys_port_trace_k_thread_join_exit	(		thread,
			timeout,
			ret
	)

#include <include/zephyr/tracing/tracing.h>

Called when exiting k_thread_join.

Parameters

thread	Thread object
timeout	Timeout period
ret	Return value

sys_port_trace_k_thread_msleep_enter

#define sys_port_trace_k_thread_msleep_enter

(

ms

)

#include <include/zephyr/tracing/tracing.h>

Called when entering k_thread_msleep.

Parameters

ms	Duration in milliseconds

sys_port_trace_k_thread_msleep_exit

#define sys_port_trace_k_thread_msleep_exit	(		ms,
			ret
	)

#include <include/zephyr/tracing/tracing.h>

Called when exiting k_thread_msleep.

Parameters

ms	Duration in milliseconds
ret	Return value

sys_port_trace_k_thread_name_set

#define sys_port_trace_k_thread_name_set	(		thread,
			ret
	)

#include <include/zephyr/tracing/tracing.h>

Called when a thread name is set.

Parameters

thread	Thread object
ret	Return value

sys_port_trace_k_thread_pend

#define sys_port_trace_k_thread_pend

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Called when a thread is pending.

Parameters

thread

Thread object

sys_port_trace_k_thread_priority_set

#define sys_port_trace_k_thread_priority_set

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Called when setting priority of a thread.

Parameters

thread

Thread object

sys_port_trace_k_thread_ready

#define sys_port_trace_k_thread_ready

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Called when a thread is ready to run.

Parameters

thread

Thread object

sys_port_trace_k_thread_resume_enter

#define sys_port_trace_k_thread_resume_enter

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Called when a thread enters the resume from suspension function.

Parameters

thread

Thread object

sys_port_trace_k_thread_resume_exit

#define sys_port_trace_k_thread_resume_exit

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Called when a thread exits the resumed from suspension function.

Parameters

thread

Thread object

sys_port_trace_k_thread_sched_abort

#define sys_port_trace_k_thread_sched_abort

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Trace implicit thread abort invocation by the scheduler.

Parameters

thread

Thread object

sys_port_trace_k_thread_sched_lock

#define sys_port_trace_k_thread_sched_lock

(

)

#include <include/zephyr/tracing/tracing.h>

Called when the thread scheduler is locked.

sys_port_trace_k_thread_sched_pend

#define sys_port_trace_k_thread_sched_pend

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Trace implicit thread pend invocation by the scheduler.

Parameters

thread

Thread object

sys_port_trace_k_thread_sched_priority_set

#define sys_port_trace_k_thread_sched_priority_set	(		thread,
			prio
	)

#include <include/zephyr/tracing/tracing.h>

Trace implicit thread set priority invocation by the scheduler.

Parameters

thread	Thread object
prio	Thread priority

sys_port_trace_k_thread_sched_ready

#define sys_port_trace_k_thread_sched_ready

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Trace implicit thread ready invocation by the scheduler.

Parameters

thread

Thread object

sys_port_trace_k_thread_sched_resume

#define sys_port_trace_k_thread_sched_resume

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Trace implicit thread resume invocation by the scheduler.

Parameters

thread

Thread object

sys_port_trace_k_thread_sched_suspend

#define sys_port_trace_k_thread_sched_suspend

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Trace implicit thread suspend invocation by the scheduler.

Parameters

thread

Thread object

sys_port_trace_k_thread_sched_unlock

#define sys_port_trace_k_thread_sched_unlock

(

)

#include <include/zephyr/tracing/tracing.h>

Called when the thread scheduler is unlocked.

sys_port_trace_k_thread_sched_wakeup

#define sys_port_trace_k_thread_sched_wakeup

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Trace implicit thread wakeup invocation by the scheduler.

Parameters

thread

Thread object

sys_port_trace_k_thread_sleep_enter

#define sys_port_trace_k_thread_sleep_enter

(

timeout

)

#include <include/zephyr/tracing/tracing.h>

Called when entering k_thread_sleep.

Parameters

timeout

Timeout period

sys_port_trace_k_thread_sleep_exit

#define sys_port_trace_k_thread_sleep_exit	(		timeout,
			ret
	)

#include <include/zephyr/tracing/tracing.h>

Called when exiting k_thread_sleep.

Parameters

timeout	Timeout period
ret	Return value

sys_port_trace_k_thread_start

#define sys_port_trace_k_thread_start

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Called when a thread is started.

Parameters

thread

Thread object

sys_port_trace_k_thread_suspend_enter

#define sys_port_trace_k_thread_suspend_enter

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Called when a thread enters the k_thread_suspend function.

Parameters

thread

Thread object

sys_port_trace_k_thread_suspend_exit

#define sys_port_trace_k_thread_suspend_exit

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Called when a thread exits the k_thread_suspend function.

Parameters

thread

Thread object

sys_port_trace_k_thread_switched_in

#define sys_port_trace_k_thread_switched_in

(

)

#include <include/zephyr/tracing/tracing.h>

Called after a thread has been selected to run.

sys_port_trace_k_thread_switched_out

#define sys_port_trace_k_thread_switched_out

(

)

#include <include/zephyr/tracing/tracing.h>

Called before a thread has been selected to run.

sys_port_trace_k_thread_user_mode_enter

#define sys_port_trace_k_thread_user_mode_enter

(

)

#include <include/zephyr/tracing/tracing.h>

Trace Thread entering user mode.

sys_port_trace_k_thread_usleep_enter

#define sys_port_trace_k_thread_usleep_enter

(

us

)

#include <include/zephyr/tracing/tracing.h>

Called when entering k_thread_usleep.

Parameters

us	Duration in microseconds

sys_port_trace_k_thread_usleep_exit

#define sys_port_trace_k_thread_usleep_exit	(		us,
			ret
	)

#include <include/zephyr/tracing/tracing.h>

Called when exiting k_thread_usleep.

Parameters

us	Duration in microseconds
ret	Return value

sys_port_trace_k_thread_wakeup

#define sys_port_trace_k_thread_wakeup

(

thread

)

#include <include/zephyr/tracing/tracing.h>

Called when a thread wakes up.

Parameters

thread

Thread object

sys_port_trace_k_thread_yield

#define sys_port_trace_k_thread_yield

(

)

#include <include/zephyr/tracing/tracing.h>

Called when a thread yields.