Возможности трассировки приложений

Перевод может содержать ошибки. Читайте первоисточник: Trace Hook Macros

Макросы отладочных ловушек

Описание

Макросы отладочных ловушек это очень мощная возможность собирать информацию о том, как ведёт себя встраиваемое приложение.

Ключевые точки интереса в исходных кодах FreeRTOS содержат пустые макросы, которые можно переопределить для обеспечения возможности трассировки конкретного приложения. В приложение нужно переопределять только те макросы, которые представляют особый интерес - остальные следует оставлять пустыми, чтобы они не влияли на синхронизацию в приложении.

Примеры

Ниже приведены примеры некоторых вариантов использования этих макросов:

• Установка цифрового выхода для индикации, какая задача сейчас запущена. Это позволяет использовать логический анализатор для просмотра и записи последовательности выполнения задач и их синхронизации.
• Аналогично - установка напряжения на аналоговом выходе, которое показывает, какая из задач сейчас запущена. Это позволяет использовать аналоговый осцилллограф для просмотра и записи последовательности выполнения задач и их синхронизации.
• Журналирование последовательности запуска, синхронизации задач, событий ядра ОС и вызовов функций API для последующего вдумчивого анализа.
• Интеграция событий ядра ОС с отладчиками сторонних производителей.

Пример 1

Функционал метки задачи FreeRTOS предоставляет простой механизм для настройки журналирования через цифровые или аналоговые выходы. Например, значение метки может быть установлено на напряжение, которое будет уникальным для каждой задачи. Тогда макрос traceSWITCHED_IN() может быть определён так, чтобы просто выводить на аналоговый выход значение метки задачи, на которую было выполнено переключение. В исходных кодах это будет выглядеть так:

/*----------------------------------------------------------------------------*/
/* В первой задаче устанавливаем значение метки в 1. */
void vTask1( void *pvParameters )
{
    /* Эта задача будет представлена напряжением, соответствующим значению 1. */
    vTaskSetApplicationTaskTag( NULL, ( void * ) 1 );

    for( ;; )
    {
        /* Здесь должен быть размещён код самой задачи. */
    }
}

/*----------------------------------------------------------------------------*/
/* Во второй задаче устанавливаем значение метки в 2. */
void vTask2( void *pvParameters )
{
    /* Эта задача будет представлена напряжением, соответствующим значению 2. */
    vTaskSetApplicationTaskTag( NULL, ( void * ) 2 );

    for( ;; )
    {
        /* Здесь должен быть размещён код самой задачи. */
    }
}

/*----------------------------------------------------------------------------*/
/* Определим макрос traceTASK_SWITCHED_IN() так, чтобы он вызывал функцию подачи
на аналоговый выход 0 напряжения, соответствущего значению метки задачи. */
#define traceTASK_SWITCHED_IN()         /
    vSetAnalogueOutput( 0, (int)pxCurrentTCB->pxTaskTag )

Пример 2

Журналирование вызовов функций API может использоваться для записи причин выполнения переключения контекста. Журналирование вызовов ядра ОС для записи последовательности, в которой запускаются задачи. Это можно реализовать так:

/*----------------------------------------------------------------------------*/
/* Макрос traceBLOCKING_ON_QUEUE_RECEIVE() это один из макросов, позволяющих
определить причину переключения контекста. */
#define traceBLOCKING_ON_QUEUE_RECEIVE(xQueue)  /
    ulSwitchReason = reasonBLOCKING_ON_QUEUE_READ;

/*----------------------------------------------------------------------------*/
/* Функция log_event() реализуется разработчиком приложения. В качестве
аргументов она получает собственно задачу, которая была заблокирована, и
причину, почему это произошло. */
#define traceTASK_SWITCHED_OUT()                /
    log_event( pxCurrentTCB, ulSwitchReason );

Описание макросов

Макросы, которые вызываются внутри обработчиков прерываний, особенно из прерывания тиков ОС, должны выполняться быстро и не использовать большого объёма ОЗУ в стеке. Установка значений переменных, запись в регистры трассировки или вывод в порты - это всё, что допустимо. А вызов, например, функции fprintf() с записью на медленный носитель работать не будет!

Макросы должны быть определены до включения в код файла FreeRTOS.h. Самое простое место для размещения макросов отладки - внизу файла FreeRTOSConfig.h, или в отдельном заголовочном файле, подключаемом внизу файла FreeRTOSConfig.h.

В таблице ниже описаны доступные макросы. Параметры макроса используются для указания того, какая задача, очередь, семафор или мьютекс были связаны с записываемым событием. Но на исходной странице список для версии где-то около 8.0.0, поэтому остальные взяты напрямую из FreeRTOS.h, и к ним пока нет пояснений.