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

   1 /*\r
   2     FreeRTOS V8.1.2 - Copyright (C) 2014 Real Time Engineers Ltd. \r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /*\r
  67  * Utility functions required to gather run time statistics.  See:\r
  68  * http://www.freertos.org/rtos-run-time-stats.html\r
  69  *\r
  70  * Note that this is a simulated port, where simulated time is a lot slower than\r
  71  * real time, therefore the run time counter values have no real meaningful\r
  72  * units.\r
  73  *\r
  74  * Also note that it is assumed this demo is going to be used for short periods\r
  75  * of time only, and therefore timer overflows are not handled.\r
  76 */\r
  77 \r
  78 /* FreeRTOS includes. */\r
  79 #include <FreeRTOS.h>\r
  80 \r
  81 /* Variables used in the creation of the run time stats time base.  Run time \r
  82 stats record how much time each task spends in the Running state. */\r
  83 static long long llInitialRunTimeCounterValue = 0LL, llTicksPerHundedthMillisecond = 0LL;\r
  84 \r
  85 /*-----------------------------------------------------------*/\r
  86 \r
  87 void vConfigureTimerForRunTimeStats( void )\r
  88 {\r
  89 LARGE_INTEGER liPerformanceCounterFrequency, liInitialRunTimeValue;\r
  90 \r
  91         /* Initialise the variables used to create the run time stats time base.\r
  92         Run time stats record how much time each task spends in the Running \r
  93         state. */\r
  94 \r
  95         if( QueryPerformanceFrequency( &liPerformanceCounterFrequency ) == 0 )\r
  96         {\r
  97                 llTicksPerHundedthMillisecond = 1;\r
  98         }\r
  99         else\r
 100         {\r
 101                 /* How many times does the performance counter increment in 1/100th\r
 102                 millisecond. */\r
 103                 llTicksPerHundedthMillisecond = liPerformanceCounterFrequency.QuadPart / 100000LL;\r
 104 \r
 105                 /* What is the performance counter value now, this will be subtracted\r
 106                 from readings taken at run time. */\r
 107                 QueryPerformanceCounter( &liInitialRunTimeValue );\r
 108                 llInitialRunTimeCounterValue = liInitialRunTimeValue.QuadPart;\r
 109         }\r
 110 }\r
 111 /*-----------------------------------------------------------*/\r
 112 \r
 113 unsigned long ulGetRunTimeCounterValue( void )\r
 114 {\r
 115 LARGE_INTEGER liCurrentCount;\r
 116 unsigned long ulReturn;\r
 117 \r
 118         /* What is the performance counter value now? */\r
 119         QueryPerformanceCounter( &liCurrentCount );\r
 120 \r
 121         /* Subtract the performance counter value reading taken when the \r
 122         application started to get a count from that reference point, then\r
 123         scale to (simulated) 1/100ths of a millisecond. */\r
 124         if( llTicksPerHundedthMillisecond == 0 )\r
 125         {\r
 126                 /* The trace macros can call this function before the kernel has been\r
 127                 started, in which case llTicksPerHundedthMillisecond will not have been\r
 128                 initialised. */\r
 129                 ulReturn = 0;\r
 130         }\r
 131         else\r
 132         {\r
 133                 ulReturn = ( unsigned long ) ( ( liCurrentCount.QuadPart - llInitialRunTimeCounterValue ) / llTicksPerHundedthMillisecond );\r
 134         }\r
 135 \r
 136         return ulReturn;\r
 137 }\r
 138 /*-----------------------------------------------------------*/\r