git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CLI_with_Trace/Run-time-stats-utils.c

   1 /*\r
   2     FreeRTOS V7.1.1 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3 \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\r
  22     ***************************************************************************\r
  23 \r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43     \r
  44     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 /*\r
  68  * Utility functions required to gather run time statistics.  See:\r
  69  * http://www.freertos.org/rtos-run-time-stats.html\r
  70  *\r
  71  * Note that this is a simulated port, where simulated time is a lot slower than\r
  72  * real time, therefore the run time counter values have no real meaningful\r
  73  * units.\r
  74  *\r
  75  * Also note that it is assumed this demo is going to be used for short periods\r
  76  * of time only, and therefore timer overflows are not handled.\r
  77 */\r
  78 \r
  79 /* FreeRTOS includes. */\r
  80 #include <FreeRTOS.h>\r
  81 \r
  82 /* FreeRTOS+Trace includes. */\r
  83 #include "trcUser.h"\r
  84 \r
  85 /* Variables used in the creation of the run time stats time base.  Run time \r
  86 stats record how much time each task spends in the Running state. */\r
  87 static long long llInitialRunTimeCounterValue = 0LL, llTicksPerHundedthMillisecond = 0LL;\r
  88 \r
  89 /*-----------------------------------------------------------*/\r
  90 \r
  91 void vConfigureTimerForRunTimeStats( void )\r
  92 {\r
  93 LARGE_INTEGER liPerformanceCounterFrequency, liInitialRunTimeValue;\r
  94 \r
  95         /* Initialise the variables used to create the run time stats time base.\r
  96         Run time stats record how much time each task spends in the Running \r
  97         state. */\r
  98 \r
  99         if( QueryPerformanceFrequency( &liPerformanceCounterFrequency ) == 0 )\r
 100         {\r
 101                 llTicksPerHundedthMillisecond = 1;\r
 102         }\r
 103         else\r
 104         {\r
 105                 /* How many times does the performance counter increment in 1/100th\r
 106                 millisecond. */\r
 107                 llTicksPerHundedthMillisecond = liPerformanceCounterFrequency.QuadPart / 100000LL;\r
 108 \r
 109                 /* What is the performance counter value now, this will be subtracted\r
 110                 from readings taken at run time. */\r
 111                 QueryPerformanceCounter( &liInitialRunTimeValue );\r
 112                 llInitialRunTimeCounterValue = liInitialRunTimeValue.QuadPart;\r
 113         }\r
 114 }\r
 115 /*-----------------------------------------------------------*/\r
 116 \r
 117 unsigned long ulGetRunTimeCounterValue( void )\r
 118 {\r
 119 LARGE_INTEGER liCurrentCount;\r
 120 unsigned long ulReturn;\r
 121 \r
 122         /* What is the performance counter value now? */\r
 123         QueryPerformanceCounter( &liCurrentCount );\r
 124 \r
 125         /* Subtract the performance counter value reading taken when the \r
 126         application started to get a count from that reference point, then\r
 127         scale to (simulated) 1/100ths of a millisecond. */\r
 128         if( llTicksPerHundedthMillisecond == 0 )\r
 129         {\r
 130                 /* The trace macros can call this function before the kernel has been\r
 131                 started, in which case llTicksPerHundedthMillisecond will not have been\r
 132                 initialised. */\r
 133                 ulReturn = 0;\r
 134         }\r
 135         else\r
 136         {\r
 137                 ulReturn = ( unsigned long ) ( ( liCurrentCount.QuadPart - llInitialRunTimeCounterValue ) / llTicksPerHundedthMillisecond );\r
 138         }\r
 139 \r
 140         return ulReturn;\r
 141 }\r
 142 /*-----------------------------------------------------------*/\r