freertos_in_rust/

trace.rs

/*
 * FreeRTOS Kernel <DEVELOPMENT BRANCH>
 * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * SPDX-License-Identifier: MIT
 *
 * [AMENDMENT] This module provides the trace hook functions for FreeRTOS.
 * In the original C, these are macros defined in FreeRTOS.h that default
 * to nothing but can be overridden by the user for tracing/debugging.
 *
 * Here we provide them as inline no-op functions. Users can enable tracing
 * by providing their own implementations via a feature flag (TODO).
 */

//! Trace Hooks
//!
//! FreeRTOS provides extensive tracing hooks that are called at key points
//! in the kernel. By default, these are no-ops, but they can be overridden
//! for debugging, profiling, or integration with trace tools like Tracealyzer.
//!
//! ## Categories
//!
//! - `traceENTER_*` / `traceRETURN_*` - Function entry/exit tracing
//! - `traceTASK_*` - Task-related events
//! - `traceQUEUE_*` - Queue operations
//! - `traceTIMER_*` - Timer events
//! - `traceEVENT_GROUP_*` - Event group operations
//! - `traceSTREAM_BUFFER_*` - Stream buffer operations
//!
//! ## Usage
//!
//! These functions are called from kernel code. To implement custom tracing,
//! users would need to provide their own trace.rs implementation (TODO: feature flag).

#![allow(unused_variables)]

use crate::kernel::list::{ListItem_t, List_t};
use crate::types::*;

// =============================================================================
// List tracing
// =============================================================================

#[inline(always)]
pub fn traceENTER_vListInitialise(pxList: *mut List_t) {}

#[inline(always)]
pub fn traceRETURN_vListInitialise() {}

#[inline(always)]
pub fn traceENTER_vListInitialiseItem(pxItem: *mut ListItem_t) {}

#[inline(always)]
pub fn traceRETURN_vListInitialiseItem() {}

#[inline(always)]
pub fn traceENTER_vListInsertEnd(pxList: *mut List_t, pxNewListItem: *mut ListItem_t) {}

#[inline(always)]
pub fn traceRETURN_vListInsertEnd() {}

#[inline(always)]
pub fn traceENTER_vListInsert(pxList: *mut List_t, pxNewListItem: *mut ListItem_t) {}

#[inline(always)]
pub fn traceRETURN_vListInsert() {}

#[inline(always)]
pub fn traceENTER_uxListRemove(pxItemToRemove: *mut ListItem_t) {}

#[inline(always)]
pub fn traceRETURN_uxListRemove(uxNumberOfItems: UBaseType_t) {}

// =============================================================================
// Task tracing (placeholders for tasks.rs)
// =============================================================================

#[inline(always)]
pub fn traceTASK_CREATE(pxNewTCB: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceTASK_CREATE_FAILED() {}

#[inline(always)]
pub fn traceTASK_DELETE(pxTaskToDelete: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceTASK_DELAY_UNTIL(xTimeToWake: TickType_t) {}

#[inline(always)]
pub fn traceTASK_DELAY() {}

#[inline(always)]
pub fn traceTASK_PRIORITY_SET(pxTask: *mut core::ffi::c_void, uxNewPriority: UBaseType_t) {}

#[inline(always)]
pub fn traceTASK_SUSPEND(pxTaskToSuspend: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceTASK_RESUME(pxTaskToResume: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceTASK_RESUME_FROM_ISR(pxTaskToResume: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceTASK_INCREMENT_TICK(xTickCount: TickType_t) {}

#[inline(always)]
pub fn traceTASK_SWITCHED_IN() {}

#[inline(always)]
pub fn traceTASK_SWITCHED_OUT() {}

#[inline(always)]
pub fn traceTASK_PRIORITY_INHERIT(
    pxTCBOfMutexHolder: *mut core::ffi::c_void,
    uxInheritedPriority: UBaseType_t,
) {
}

#[inline(always)]
pub fn traceTASK_PRIORITY_DISINHERIT(
    pxTCBOfMutexHolder: *mut core::ffi::c_void,
    uxOriginalPriority: UBaseType_t,
) {
}

#[inline(always)]
pub fn traceTASK_NOTIFY_TAKE_BLOCK(uxIndexToWait: UBaseType_t) {}

#[inline(always)]
pub fn traceTASK_NOTIFY_TAKE(uxIndexToWait: UBaseType_t) {}

#[inline(always)]
pub fn traceTASK_NOTIFY_WAIT_BLOCK(uxIndexToWait: UBaseType_t) {}

#[inline(always)]
pub fn traceTASK_NOTIFY_WAIT(uxIndexToWait: UBaseType_t) {}

#[inline(always)]
pub fn traceTASK_NOTIFY(uxIndexToNotify: UBaseType_t) {}

#[inline(always)]
pub fn traceTASK_NOTIFY_FROM_ISR(uxIndexToNotify: UBaseType_t) {}

#[inline(always)]
pub fn traceTASK_NOTIFY_GIVE_FROM_ISR(uxIndexToNotify: UBaseType_t) {}

// =============================================================================
// Queue tracing (placeholders for queue.rs)
// =============================================================================

#[inline(always)]
pub fn traceQUEUE_CREATE(pxNewQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_CREATE_FAILED(ucQueueType: u8) {}

#[inline(always)]
pub fn traceCREATE_MUTEX(pxNewQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceCREATE_MUTEX_FAILED() {}

#[inline(always)]
pub fn traceGIVE_MUTEX_RECURSIVE(pxMutex: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceGIVE_MUTEX_RECURSIVE_FAILED(pxMutex: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceTAKE_MUTEX_RECURSIVE(pxMutex: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceTAKE_MUTEX_RECURSIVE_FAILED(pxMutex: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceCREATE_COUNTING_SEMAPHORE() {}

#[inline(always)]
pub fn traceCREATE_COUNTING_SEMAPHORE_FAILED() {}

#[inline(always)]
pub fn traceQUEUE_SEND(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_SEND_FAILED(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_RECEIVE(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_PEEK(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_PEEK_FAILED(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_PEEK_FROM_ISR(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_RECEIVE_FAILED(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_SEND_FROM_ISR(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_SEND_FROM_ISR_FAILED(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_RECEIVE_FROM_ISR(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_RECEIVE_FROM_ISR_FAILED(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_PEEK_FROM_ISR_FAILED(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_DELETE(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceBLOCKING_ON_QUEUE_RECEIVE(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceBLOCKING_ON_QUEUE_PEEK(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceBLOCKING_ON_QUEUE_SEND(pxQueue: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceQUEUE_REGISTRY_ADD(pxQueue: *mut core::ffi::c_void, pcQueueName: *const u8) {}

// =============================================================================
// Timer tracing (placeholders for timers.rs)
// =============================================================================

#[inline(always)]
pub fn traceTIMER_CREATE(pxNewTimer: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceTIMER_CREATE_FAILED() {}

#[inline(always)]
pub fn traceTIMER_COMMAND_SEND(
    xTimer: *mut core::ffi::c_void,
    xMessageID: BaseType_t,
    xMessageValueValue: TickType_t,
    xReturn: BaseType_t,
) {
}

#[inline(always)]
pub fn traceTIMER_EXPIRED(pxTimer: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceTIMER_COMMAND_RECEIVED(
    pxTimer: *mut core::ffi::c_void,
    xMessageID: BaseType_t,
    xMessageValue: TickType_t,
) {
}

// =============================================================================
// Event group tracing (placeholders for event_groups.rs)
// =============================================================================

#[inline(always)]
pub fn traceEVENT_GROUP_CREATE(pxEventGroup: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceEVENT_GROUP_CREATE_FAILED() {}

#[inline(always)]
pub fn traceEVENT_GROUP_SYNC_BLOCK(
    pxEventGroup: *mut core::ffi::c_void,
    uxBitsToSet: UBaseType_t,
    uxBitsToWaitFor: UBaseType_t,
) {
}

#[inline(always)]
pub fn traceEVENT_GROUP_SYNC_END(
    pxEventGroup: *mut core::ffi::c_void,
    uxBitsToSet: UBaseType_t,
    uxBitsToWaitFor: UBaseType_t,
    xTimeoutOccurred: BaseType_t,
) {
}

#[inline(always)]
pub fn traceEVENT_GROUP_WAIT_BITS_BLOCK(
    pxEventGroup: *mut core::ffi::c_void,
    uxBitsToWaitFor: UBaseType_t,
) {
}

#[inline(always)]
pub fn traceEVENT_GROUP_WAIT_BITS_END(
    pxEventGroup: *mut core::ffi::c_void,
    uxBitsToWaitFor: UBaseType_t,
    xTimeoutOccurred: BaseType_t,
) {
}

#[inline(always)]
pub fn traceEVENT_GROUP_CLEAR_BITS(
    pxEventGroup: *mut core::ffi::c_void,
    uxBitsToClear: UBaseType_t,
) {
}

#[inline(always)]
pub fn traceEVENT_GROUP_CLEAR_BITS_FROM_ISR(
    pxEventGroup: *mut core::ffi::c_void,
    uxBitsToClear: UBaseType_t,
) {
}

#[inline(always)]
pub fn traceEVENT_GROUP_SET_BITS(pxEventGroup: *mut core::ffi::c_void, uxBitsToSet: UBaseType_t) {}

#[inline(always)]
pub fn traceEVENT_GROUP_SET_BITS_FROM_ISR(
    pxEventGroup: *mut core::ffi::c_void,
    uxBitsToSet: UBaseType_t,
) {
}

#[inline(always)]
pub fn traceEVENT_GROUP_DELETE(pxEventGroup: *mut core::ffi::c_void) {}

// =============================================================================
// Stream buffer tracing (placeholders for stream_buffer.rs)
// =============================================================================

#[inline(always)]
pub fn traceSTREAM_BUFFER_CREATE(
    pxStreamBuffer: *mut core::ffi::c_void,
    xIsMessageBuffer: BaseType_t,
) {
}

#[inline(always)]
pub fn traceSTREAM_BUFFER_CREATE_FAILED(xIsMessageBuffer: BaseType_t) {}

#[inline(always)]
pub fn traceSTREAM_BUFFER_CREATE_STATIC_FAILED(
    xReturn: *mut core::ffi::c_void,
    xIsMessageBuffer: BaseType_t,
) {
}

#[inline(always)]
pub fn traceSTREAM_BUFFER_DELETE(pxStreamBuffer: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceSTREAM_BUFFER_RESET(pxStreamBuffer: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceSTREAM_BUFFER_SEND(pxStreamBuffer: *mut core::ffi::c_void, xBytesSent: usize) {}

#[inline(always)]
pub fn traceSTREAM_BUFFER_SEND_FAILED(pxStreamBuffer: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceSTREAM_BUFFER_SEND_FROM_ISR(pxStreamBuffer: *mut core::ffi::c_void, xBytesSent: usize) {
}

#[inline(always)]
pub fn traceSTREAM_BUFFER_RECEIVE(pxStreamBuffer: *mut core::ffi::c_void, xReceivedLength: usize) {}

#[inline(always)]
pub fn traceSTREAM_BUFFER_RECEIVE_FAILED(pxStreamBuffer: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceSTREAM_BUFFER_RECEIVE_FROM_ISR(
    pxStreamBuffer: *mut core::ffi::c_void,
    xReceivedLength: usize,
) {
}

#[inline(always)]
pub fn traceBLOCKING_ON_STREAM_BUFFER_SEND(pxStreamBuffer: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceBLOCKING_ON_STREAM_BUFFER_RECEIVE(pxStreamBuffer: *mut core::ffi::c_void) {}

// =============================================================================
// ISR tracing
// =============================================================================

#[inline(always)]
pub fn traceISR_ENTER() {}

#[inline(always)]
pub fn traceISR_EXIT() {}

#[inline(always)]
pub fn traceISR_EXIT_TO_SCHEDULER() {}

// =============================================================================
// Scheduler tracing
// =============================================================================

#[inline(always)]
pub fn traceSCHEDULER_STARTED() {}

#[inline(always)]
pub fn traceSCHEDULER_STOPPED() {}

#[inline(always)]
pub fn traceSCHEDULER_SUSPENDED() {}

#[inline(always)]
pub fn traceSCHEDULER_RESUMED() {}

// =============================================================================
// Idle task tracing
// =============================================================================

#[inline(always)]
pub fn traceIDLE_TASK_STARTED() {}

// =============================================================================
// Low power / tickless idle tracing
// =============================================================================

#[inline(always)]
pub fn traceLOW_POWER_IDLE_BEGIN() {}

#[inline(always)]
pub fn traceLOW_POWER_IDLE_END() {}

#[inline(always)]
pub fn traceINCREASE_TICK_COUNT(_xTicksToJump: TickType_t) {}

// =============================================================================
// Memory allocation tracing
// =============================================================================

#[inline(always)]
pub fn traceMALLOC(pvAddress: *mut core::ffi::c_void, uiSize: usize) {}

#[inline(always)]
pub fn traceFREE(pvAddress: *mut core::ffi::c_void, uiSize: usize) {}

// =============================================================================
// Pend function call tracing
// =============================================================================

#[inline(always)]
pub fn tracePEND_FUNC_CALL(
    xFunctionToPend: *mut core::ffi::c_void,
    pvParameter1: *mut core::ffi::c_void,
    ulParameter2: u32,
    xReturn: BaseType_t,
) {
}

#[inline(always)]
pub fn tracePEND_FUNC_CALL_FROM_ISR(
    xFunctionToPend: *mut core::ffi::c_void,
    pvParameter1: *mut core::ffi::c_void,
    ulParameter2: u32,
    xReturn: BaseType_t,
) {
}

// =============================================================================
// Queue set tracing
// =============================================================================

#[inline(always)]
pub fn traceQUEUE_SET_SEND(pxQueueSet: *mut core::ffi::c_void) {}

// =============================================================================
// Moved task to ready state tracing
// =============================================================================

#[inline(always)]
pub fn traceMOVED_TASK_TO_READY_STATE(pxTCB: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn tracePOST_MOVED_TASK_TO_READY_STATE(pxTCB: *mut core::ffi::c_void) {}

#[inline(always)]
pub fn traceMOVED_TASK_TO_DELAYED_LIST() {}

#[inline(always)]
pub fn traceMOVED_TASK_TO_OVERFLOW_DELAYED_LIST() {}

// =============================================================================
// Trace Macros
// =============================================================================
// [AMENDMENT] These macros provide no-op stubs that can be replaced with
// actual tracing implementations. They match the FreeRTOS trace macro pattern.

// Timer tracing macros
#[macro_export]
macro_rules! traceENTER_xTimerCreateTimerTask {
    () => {};
}

#[macro_export]
macro_rules! traceRETURN_xTimerCreateTimerTask {
    ($xReturn:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_xTimerCreate {
    ($pcTimerName:expr, $xTimerPeriodInTicks:expr, $xAutoReload:expr, $pvTimerID:expr, $pxCallbackFunction:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_xTimerCreate {
    ($pxNewTimer:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_xTimerCreateStatic {
    ($pcTimerName:expr, $xTimerPeriodInTicks:expr, $xAutoReload:expr, $pvTimerID:expr, $pxCallbackFunction:expr, $pxTimerBuffer:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_xTimerCreateStatic {
    ($pxNewTimer:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_xTimerGenericCommandFromTask {
    ($xTimer:expr, $xCommandID:expr, $xOptionalValue:expr, $pxHigherPriorityTaskWoken:expr, $xTicksToWait:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_xTimerGenericCommandFromTask {
    ($xReturn:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_xTimerGenericCommandFromISR {
    ($xTimer:expr, $xCommandID:expr, $xOptionalValue:expr, $pxHigherPriorityTaskWoken:expr, $xTicksToWait:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_xTimerGenericCommandFromISR {
    ($xReturn:expr) => {};
}

#[macro_export]
macro_rules! traceTIMER_COMMAND_SEND {
    ($xTimer:expr, $xCommandID:expr, $xOptionalValue:expr, $xReturn:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_xTimerGetTimerDaemonTaskHandle {
    () => {};
}

#[macro_export]
macro_rules! traceRETURN_xTimerGetTimerDaemonTaskHandle {
    ($xTimerTaskHandle:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_xTimerGetPeriod {
    ($xTimer:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_xTimerGetPeriod {
    ($xReturn:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_vTimerSetReloadMode {
    ($xTimer:expr, $xAutoReload:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_vTimerSetReloadMode {
    () => {};
}

#[macro_export]
macro_rules! traceENTER_xTimerGetReloadMode {
    ($xTimer:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_xTimerGetReloadMode {
    ($xReturn:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_uxTimerGetReloadMode {
    ($xTimer:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_uxTimerGetReloadMode {
    ($uxReturn:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_xTimerGetExpiryTime {
    ($xTimer:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_xTimerGetExpiryTime {
    ($xReturn:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_pcTimerGetName {
    ($xTimer:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_pcTimerGetName {
    ($pcName:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_xTimerIsTimerActive {
    ($xTimer:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_xTimerIsTimerActive {
    ($xReturn:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_pvTimerGetTimerID {
    ($xTimer:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_pvTimerGetTimerID {
    ($pvReturn:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_vTimerSetTimerID {
    ($xTimer:expr, $pvNewID:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_vTimerSetTimerID {
    () => {};
}

#[macro_export]
macro_rules! traceENTER_xTimerGetStaticBuffer {
    ($xTimer:expr, $ppxTimerBuffer:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_xTimerGetStaticBuffer {
    ($xReturn:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_uxTimerGetTimerNumber {
    ($xTimer:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_uxTimerGetTimerNumber {
    ($uxReturn:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_vTimerSetTimerNumber {
    ($xTimer:expr, $uxTimerNumber:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_vTimerSetTimerNumber {
    () => {};
}

#[macro_export]
macro_rules! traceENTER_xTimerPendFunctionCallFromISR {
    ($xFunctionToPend:expr, $pvParameter1:expr, $ulParameter2:expr, $pxHigherPriorityTaskWoken:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_xTimerPendFunctionCallFromISR {
    ($xReturn:expr) => {};
}

#[macro_export]
macro_rules! traceENTER_xTimerPendFunctionCall {
    ($xFunctionToPend:expr, $pvParameter1:expr, $ulParameter2:expr, $xTicksToWait:expr) => {};
}

#[macro_export]
macro_rules! traceRETURN_xTimerPendFunctionCall {
    ($xReturn:expr) => {};
}

#[macro_export]
macro_rules! traceTIMER_CREATE {
    ($pxTimer:expr) => {};
}

#[macro_export]
macro_rules! traceTIMER_EXPIRED {
    ($pxTimer:expr) => {};
}

#[macro_export]
macro_rules! traceTIMER_COMMAND_RECEIVED {
    ($pxTimer:expr, $xMessageID:expr, $xMessageValue:expr) => {};
}

#[macro_export]
macro_rules! tracePEND_FUNC_CALL_FROM_ISR {
    ($xFunctionToPend:expr, $pvParameter1:expr, $ulParameter2:expr, $xReturn:expr) => {};
}

#[macro_export]
macro_rules! tracePEND_FUNC_CALL {
    ($xFunctionToPend:expr, $pvParameter1:expr, $ulParameter2:expr, $xReturn:expr) => {};
}