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 V9.0.0rc1 - Copyright (C) 2016 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     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
  12 \r
  13     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 /*\r
  71  * Utility functions required to gather run time statistics.  See:\r
  72  * http://www.freertos.org/rtos-run-time-stats.html\r
  73  *\r
  74  * Note that this is a simulated port, where simulated time is a lot slower than\r
  75  * real time, therefore the run time counter values have no real meaningful\r
  76  * units.\r
  77  *\r
  78  * Also note that it is assumed this demo is going to be used for short periods\r
  79  * of time only, and therefore timer overflows are not handled.\r
  80 */\r
  81 \r
  82 /* FreeRTOS includes. */\r
  83 #include <FreeRTOS.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