[freertos] / FreeRTOS / Demo / WIN32-MSVC / Trace_Recorder_Configuration / trcSnapshotConfig.h

/*******************************************************************************\r
 * Trace Recorder Library for Tracealyzer v4.1.4\r
 * Percepio AB, www.percepio.com\r
 *\r
 * trcSnapshotConfig.h\r
 *\r
 * Configuration parameters for trace recorder library in snapshot mode.\r
 * Read more at http://percepio.com/2016/10/05/rtos-tracing/\r
 *\r
 * Terms of Use\r
 * This file is part of the trace recorder library (RECORDER), which is the\r
 * intellectual property of Percepio AB (PERCEPIO) and provided under a\r
 * license as follows.\r
 * The RECORDER may be used free of charge for the purpose of recording data\r
 * intended for analysis in PERCEPIO products. It may not be used or modified\r
 * for other purposes without explicit permission from PERCEPIO.\r
 * You may distribute the RECORDER in its original source code form, assuming\r
 * this text (terms of use, disclaimer, copyright notice) is unchanged. You are\r
 * allowed to distribute the RECORDER with minor modifications intended for\r
 * configuration or porting of the RECORDER, e.g., to allow using it on a\r
 * specific processor, processor family or with a specific communication\r
 * interface. Any such modifications should be documented directly below\r
 * this comment block.\r
 *\r
 * Disclaimer\r
 * The RECORDER is being delivered to you AS IS and PERCEPIO makes no warranty\r
 * as to its use or performance. PERCEPIO does not and cannot warrant the\r
 * performance or results you may obtain by using the RECORDER or documentation.\r
 * PERCEPIO make no warranties, express or implied, as to noninfringement of\r
 * third party rights, merchantability, or fitness for any particular purpose.\r
 * In no event will PERCEPIO, its technology partners, or distributors be liable\r
 * to you for any consequential, incidental or special damages, including any\r
 * lost profits or lost savings, even if a representative of PERCEPIO has been\r
 * advised of the possibility of such damages, or for any claim by any third\r
 * party. Some jurisdictions do not allow the exclusion or limitation of\r
 * incidental, consequential or special damages, or the exclusion of implied\r
 * warranties or limitations on how long an implied warranty may last, so the\r
 * above limitations may not apply to you.\r
 *\r
 * Tabs are used for indent in this file (1 tab = 4 spaces)\r
 *\r
 * Copyright Percepio AB, 2018.\r
 * www.percepio.com\r
 ******************************************************************************/\r
\r
#ifndef TRC_SNAPSHOT_CONFIG_H\r
#define TRC_SNAPSHOT_CONFIG_H\r
\r
#define TRC_SNAPSHOT_MODE_RING_BUFFER           (0x01)\r
#define TRC_SNAPSHOT_MODE_STOP_WHEN_FULL        (0x02)\r
\r
/******************************************************************************\r
 * TRC_CFG_SNAPSHOT_MODE\r
 *\r
 * Macro which should be defined as one of:\r
 * - TRC_SNAPSHOT_MODE_RING_BUFFER\r
 * - TRC_SNAPSHOT_MODE_STOP_WHEN_FULL\r
 * Default is TRC_SNAPSHOT_MODE_RING_BUFFER.\r
 *\r
 * With TRC_CFG_SNAPSHOT_MODE set to TRC_SNAPSHOT_MODE_RING_BUFFER, the\r
 * events are stored in a ring buffer, i.e., where the oldest events are\r
 * overwritten when the buffer becomes full. This allows you to get the last\r
 * events leading up to an interesting state, e.g., an error, without having\r
 * to store the whole run since startup.\r
 *\r
 * When TRC_CFG_SNAPSHOT_MODE is TRC_SNAPSHOT_MODE_STOP_WHEN_FULL, the\r
 * recording is stopped when the buffer becomes full. This is useful for\r
 * recording events following a specific state, e.g., the startup sequence.\r
 *****************************************************************************/\r
#define TRC_CFG_SNAPSHOT_MODE TRC_SNAPSHOT_MODE_RING_BUFFER\r
\r
/*******************************************************************************\r
 * TRC_CFG_EVENT_BUFFER_SIZE\r
 *\r
 * Macro which should be defined as an integer value.\r
 *\r
 * This defines the capacity of the event buffer, i.e., the number of records\r
 * it may store. Most events use one record (4 byte), although some events\r
 * require multiple 4-byte records. You should adjust this to the amount of RAM\r
 * available in the target system.\r
 *\r
 * Default value is 1000, which means that 4000 bytes is allocated for the\r
 * event buffer.\r
 ******************************************************************************/\r
#define TRC_CFG_EVENT_BUFFER_SIZE 15000\r
\r
/*******************************************************************************\r
 * TRC_CFG_NTASK, TRC_CFG_NISR, TRC_CFG_NQUEUE, TRC_CFG_NSEMAPHORE...\r
 *\r
 * A group of macros which should be defined as integer values, zero or larger.\r
 *\r
 * These define the capacity of the Object Property Table, i.e., the maximum\r
 * number of objects active at any given point, within each object class (e.g.,\r
 * task, queue, semaphore, ...).\r
 *\r
 * If tasks or other objects are deleted in your system, this\r
 * setting does not limit the total amount of objects created, only the number\r
 * of objects that have been successfully created but not yet deleted.\r
 *\r
 * Using too small values will cause vTraceError to be called, which stores an\r
 * error message in the trace that is shown when opening the trace file. The\r
 * error message can also be retrieved using xTraceGetLastError.\r
 *\r
 * It can be wise to start with large values for these constants,\r
 * unless you are very confident on these numbers. Then do a recording and\r
 * check the actual usage by selecting View menu -> Trace Details ->\r
 * Resource Usage -> Object Table.\r
 ******************************************************************************/\r
#define TRC_CFG_NTASK                   150\r
#define TRC_CFG_NISR                    90\r
#define TRC_CFG_NQUEUE                  90\r
#define TRC_CFG_NSEMAPHORE              90\r
#define TRC_CFG_NMUTEX                  90\r
#define TRC_CFG_NTIMER                  250\r
#define TRC_CFG_NEVENTGROUP             90\r
#define TRC_CFG_NSTREAMBUFFER   50\r
#define TRC_CFG_NMESSAGEBUFFER  50\r
\r
\r
/******************************************************************************\r
 * TRC_CFG_INCLUDE_FLOAT_SUPPORT\r
 *\r
 * Macro which should be defined as either zero (0) or one (1).\r
 *\r
 * If this is zero (0), the support for logging floating point values in\r
 * vTracePrintF is stripped out, in case floating point values are not used or\r
 * supported by the platform used.\r
 *\r
 * Floating point values are only used in vTracePrintF and its subroutines, to\r
 * allow for storing float (%f) or double (%lf) arguments.\r
 *\r
 * vTracePrintF can be used with integer and string arguments in either case.\r
 *\r
 * Default value is 0.\r
 *****************************************************************************/\r
#define TRC_CFG_INCLUDE_FLOAT_SUPPORT 0\r
\r
/*******************************************************************************\r
 * TRC_CFG_SYMBOL_TABLE_SIZE\r
 *\r
 * Macro which should be defined as an integer value.\r
 *\r
 * This defines the capacity of the symbol table, in bytes. This symbol table\r
 * stores User Events labels and names of deleted tasks, queues, or other kernel\r
 * objects. If you don't use User Events or delete any kernel\r
 * objects you set this to a very low value. The minimum recommended value is 4.\r
 * A size of zero (0) is not allowed since a zero-sized array may result in a\r
 * 32-bit pointer, i.e., using 4 bytes rather than 0.\r
 *\r
 * Default value is 800.\r
 ******************************************************************************/\r
#define TRC_CFG_SYMBOL_TABLE_SIZE 5000\r
\r
#if (TRC_CFG_SYMBOL_TABLE_SIZE == 0)\r
#error "TRC_CFG_SYMBOL_TABLE_SIZE may not be zero!"\r
#endif\r
\r
/******************************************************************************\r
 * TRC_CFG_NAME_LEN_TASK, TRC_CFG_NAME_LEN_QUEUE, ...\r
 *\r
 * Macros that specify the maximum lengths (number of characters) for names of\r
 * kernel objects, such as tasks and queues. If longer names are used, they will\r
 * be truncated when stored in the recorder.\r
 *****************************************************************************/\r
#define TRC_CFG_NAME_LEN_TASK                   15\r
#define TRC_CFG_NAME_LEN_ISR                    15\r
#define TRC_CFG_NAME_LEN_QUEUE                  15\r
#define TRC_CFG_NAME_LEN_SEMAPHORE              15\r
#define TRC_CFG_NAME_LEN_MUTEX                  15\r
#define TRC_CFG_NAME_LEN_TIMER                  15\r
#define TRC_CFG_NAME_LEN_EVENTGROUP     15\r
#define TRC_CFG_NAME_LEN_STREAMBUFFER   15\r
#define TRC_CFG_NAME_LEN_MESSAGEBUFFER  15\r
\r
/******************************************************************************\r
 *** ADVANCED SETTINGS ********************************************************\r
 ******************************************************************************\r
 * The remaining settings are not necessary to modify but allows for optimizing\r
 * the recorder setup for your specific needs, e.g., to exclude events that you\r
 * are not interested in, in order to get longer traces.\r
 *****************************************************************************/\r
\r
/******************************************************************************\r
* TRC_CFG_HEAP_SIZE_BELOW_16M\r
*\r
* An integer constant that can be used to reduce the buffer usage of memory\r
* allocation events (malloc/free). This value should be 1 if the heap size is\r
* below 16 MB (2^24 byte), and you can live with reported addresses showing the\r
* lower 24 bits only. If 0, you get the full 32-bit addresses.\r
*\r
* Default value is 0.\r
******************************************************************************/\r
#define TRC_CFG_HEAP_SIZE_BELOW_16M 0\r
\r
/******************************************************************************\r
 * TRC_CFG_USE_IMPLICIT_IFE_RULES\r
 *\r
 * Macro which should be defined as either zero (0) or one (1).\r
 * Default is 1.\r
 *\r
 * Tracealyzer groups the events into "instances" based on Instance Finish\r
 * Events (IFEs), produced either by default rules or calls to the recorder\r
 * functions vTraceInstanceFinishedNow and vTraceInstanceFinishedNext.\r
 *\r
 * If TRC_CFG_USE_IMPLICIT_IFE_RULES is one (1), the default IFE rules is\r
 * used, resulting in a "typical" grouping of events into instances.\r
 * If these rules don't give appropriate instances in your case, you can\r
 * override the default rules using vTraceInstanceFinishedNow/Next for one\r
 * or several tasks. The default IFE rules are then disabled for those tasks.\r
 *\r
 * If TRC_CFG_USE_IMPLICIT_IFE_RULES is zero (0), the implicit IFE rules are\r
 * disabled globally. You must then call vTraceInstanceFinishedNow or\r
 * vTraceInstanceFinishedNext to manually group the events into instances,\r
 * otherwise the tasks will appear a single long instance.\r
 *\r
 * The default IFE rules count the following events as "instance finished":\r
 * - Task delay, delay until\r
 * - Task suspend\r
 * - Blocking on "input" operations, i.e., when the task is waiting for the\r
 *   next a message/signal/event. But only if this event is blocking.\r
 *\r
 * For details, see trcSnapshotKernelPort.h and look for references to the\r
 * macro trcKERNEL_HOOKS_SET_TASK_INSTANCE_FINISHED.\r
 *****************************************************************************/\r
#define TRC_CFG_USE_IMPLICIT_IFE_RULES 1\r
\r
/******************************************************************************\r
 * TRC_CFG_USE_16BIT_OBJECT_HANDLES\r
 *\r
 * Macro which should be defined as either zero (0) or one (1).\r
 *\r
 * If set to 0 (zero), the recorder uses 8-bit handles to identify kernel\r
 * objects such as tasks and queues. This limits the supported number of\r
 * concurrently active objects to 255 of each type (tasks, queues, mutexes,\r
 * etc.) Note: 255, not 256, since handle 0 is reserved.\r
 *\r
 * If set to 1 (one), the recorder uses 16-bit handles to identify kernel\r
 * objects such as tasks and queues. This limits the supported number of\r
 * concurrent objects to 65535 of each type (object class). However, since the\r
 * object property table is limited to 64 KB, the practical limit is about\r
 * 3000 objects in total.\r
 *\r
 * Default is 0 (8-bit handles)\r
 *\r
 * NOTE: An object with handle above 255 will use an extra 4-byte record in\r
 * the event buffer whenever the object is referenced. Moreover, some internal\r
 * tables in the recorder gets slightly larger when using 16-bit handles.\r
 *****************************************************************************/\r
#define TRC_CFG_USE_16BIT_OBJECT_HANDLES 0\r
\r
/******************************************************************************\r
 * TRC_CFG_USE_TRACE_ASSERT\r
 *\r
 * Macro which should be defined as either zero (0) or one (1).\r
 * Default is 1.\r
 *\r
 * If this is one (1), the TRACE_ASSERT macro (used at various locations in the\r
 * trace recorder) will verify that a relevant condition is true.\r
 * If the condition is false, prvTraceError() will be called, which stops the\r
 * recording and stores an error message that is displayed when opening the\r
 * trace in Tracealyzer.\r
 *\r
 * This is used on several places in the recorder code for sanity checks on\r
 * parameters. Can be switched off to reduce the footprint of the tracing, but\r
 * we recommend to have it enabled initially.\r
 *****************************************************************************/\r
#define TRC_CFG_USE_TRACE_ASSERT 1\r
\r
/*******************************************************************************\r
 * TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER\r
 *\r
 * Macro which should be defined as an integer value.\r
 *\r
 * Set TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER to 1 to enable the\r
 * separate user event buffer (UB).\r
 * In this mode, user events are stored separately from other events,\r
 * e.g., RTOS events. Thereby you can get a much longer history of\r
 * user events as they don't need to share the buffer space with more\r
 * frequent events.\r
 *\r
 * The UB is typically used with the snapshot ring-buffer mode, so the\r
 * recording can continue when the main buffer gets full. And since the\r
 * main buffer then overwrites the earliest events, Tracealyzer displays\r
 * "Unknown Actor" instead of task scheduling for periods with UB data only.\r
 *\r
 * In UB mode, user events are structured as UB channels, which contains\r
 * a channel name and a default format string. Register a UB channel using\r
 * xTraceRegisterUBChannel.\r
 *\r
 * Events and data arguments are written using vTraceUBEvent and\r
 * vTraceUBData. They are designed to provide efficient logging of\r
 * repeating events, using the same format string within each channel.\r
 *\r
 * Examples:\r
 *\r
 *  traceString chn1 = xTraceRegisterString("Channel 1");\r
 *  traceString fmt1 = xTraceRegisterString("Event!");\r
 *  traceUBChannel UBCh1 = xTraceRegisterUBChannel(chn1, fmt1);\r
 *\r
 *  traceString chn2 = xTraceRegisterString("Channel 2");\r
 *  traceString fmt2 = xTraceRegisterString("X: %d, Y: %d");\r
 *      traceUBChannel UBCh2 = xTraceRegisterUBChannel(chn2, fmt2);\r
 *\r
 *  // Result in "[Channel 1] Event!"\r
 *      vTraceUBEvent(UBCh1);\r
 *\r
 *  // Result in "[Channel 2] X: 23, Y: 19"\r
 *      vTraceUBData(UBCh2, 23, 19);\r
 *\r
 * You can also use the other user event functions, like vTracePrintF.\r
 * as they are then rerouted to the UB instead of the main event buffer.\r
 * vTracePrintF then looks up the correct UB channel based on the\r
 * provided channel name and format string, or creates a new UB channel\r
 * if no match is found. The format string should therefore not contain\r
 * "random" messages but mainly format specifiers. Random strings should\r
 * be stored using %s and with the string as an argument.\r
 *\r
 *  // Creates a new UB channel ("Channel 2", "%Z: %d")\r
 *  vTracePrintF(chn2, "%Z: %d", value1);\r
 *\r
 *  // Finds the existing UB channel\r
 *  vTracePrintF(chn2, "%Z: %d", value2);\r
\r
 ******************************************************************************/\r
#define TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER 0\r
\r
/*******************************************************************************\r
 * TRC_CFG_SEPARATE_USER_EVENT_BUFFER_SIZE\r
 *\r
 * Macro which should be defined as an integer value.\r
 *\r
 * This defines the capacity of the user event buffer (UB), in number of slots.\r
 * A single user event can use multiple slots, depending on the arguments.\r
 *\r
 * Only applicable if TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER is 1.\r
 ******************************************************************************/\r
#define TRC_CFG_SEPARATE_USER_EVENT_BUFFER_SIZE 200\r
\r
/*******************************************************************************\r
 * TRC_CFG_UB_CHANNELS\r
 *\r
 * Macro which should be defined as an integer value.\r
 *\r
 * This defines the number of User Event Buffer Channels (UB channels).\r
 * These are used to structure the events when using the separate user\r
 * event buffer, and contains both a User Event Channel (the name) and\r
 * a default format string for the channel.\r
 *\r
 * Only applicable if TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER is 1.\r
 ******************************************************************************/\r
#define TRC_CFG_UB_CHANNELS 32\r
\r
/*******************************************************************************\r
 * TRC_CFG_ISR_TAILCHAINING_THRESHOLD\r
 *\r
 * Macro which should be defined as an integer value.\r
 *\r
 * If tracing multiple ISRs, this setting allows for accurate display of the\r
 * context-switching also in cases when the ISRs execute in direct sequence.\r
 *\r
 * vTraceStoreISREnd normally assumes that the ISR returns to the previous\r
 * context, i.e., a task or a preempted ISR. But if another traced ISR\r
 * executes in direct sequence, Tracealyzer may incorrectly display a minimal\r
 * fragment of the previous context in between the ISRs.\r
 *\r
 * By using TRC_CFG_ISR_TAILCHAINING_THRESHOLD you can avoid this. This is\r
 * however a threshold value that must be measured for your specific setup.\r
 * See http://percepio.com/2014/03/21/isr_tailchaining_threshold/\r
 *\r
 * The default setting is 0, meaning "disabled" and that you may get an\r
 * extra fragments of the previous context in between tail-chained ISRs.\r
 *\r
 * Note: This setting has separate definitions in trcSnapshotConfig.h and\r
 * trcStreamingConfig.h, since it is affected by the recorder mode.\r
 ******************************************************************************/\r
#define TRC_CFG_ISR_TAILCHAINING_THRESHOLD 0\r
\r
#endif /*TRC_SNAPSHOT_CONFIG_H*/\r