git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/mqtt/common/Run-time-stats-utils.c

   1 /*\r
   2  * FreeRTOS Kernel V10.3.0\r
   3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 /*\r
  29  * Utility functions required to gather run time statistics.  See:\r
  30  * http://www.freertos.org/rtos-run-time-stats.html\r
  31  *\r
  32  * Note that this is a simulated port, where simulated time is a lot slower than\r
  33  * real time, therefore the run time counter values have no real meaningful\r
  34  * units.\r
  35  *\r
  36  * Also note that it is assumed this demo is going to be used for short periods\r
  37  * of time only, and therefore timer overflows are not handled.\r
  38 */\r
  39 \r
  40 /* FreeRTOS includes. */\r
  41 #include <FreeRTOS.h>\r
  42 \r
  43 /* Variables used in the creation of the run time stats time base.  Run time\r
  44 stats record how much time each task spends in the Running state. */\r
  45 static long long llInitialRunTimeCounterValue = 0LL, llTicksPerHundedthMillisecond = 0LL;\r
  46 \r
  47 /*-----------------------------------------------------------*/\r
  48 \r
  49 void vConfigureTimerForRunTimeStats( void )\r
  50 {\r
  51 LARGE_INTEGER liPerformanceCounterFrequency, liInitialRunTimeValue;\r
  52 \r
  53         /* Initialise the variables used to create the run time stats time base.\r
  54         Run time stats record how much time each task spends in the Running\r
  55         state. */\r
  56 \r
  57         if( QueryPerformanceFrequency( &liPerformanceCounterFrequency ) == 0 )\r
  58         {\r
  59                 llTicksPerHundedthMillisecond = 1;\r
  60         }\r
  61         else\r
  62         {\r
  63                 /* How many times does the performance counter increment in 1/100th\r
  64                 millisecond. */\r
  65                 llTicksPerHundedthMillisecond = liPerformanceCounterFrequency.QuadPart / 100000LL;\r
  66 \r
  67                 /* What is the performance counter value now, this will be subtracted\r
  68                 from readings taken at run time. */\r
  69                 QueryPerformanceCounter( &liInitialRunTimeValue );\r
  70                 llInitialRunTimeCounterValue = liInitialRunTimeValue.QuadPart;\r
  71         }\r
  72 }\r
  73 /*-----------------------------------------------------------*/\r
  74 \r
  75 unsigned long ulGetRunTimeCounterValue( void )\r
  76 {\r
  77 LARGE_INTEGER liCurrentCount;\r
  78 unsigned long ulReturn;\r
  79 \r
  80         /* What is the performance counter value now? */\r
  81         QueryPerformanceCounter( &liCurrentCount );\r
  82 \r
  83         /* Subtract the performance counter value reading taken when the\r
  84         application started to get a count from that reference point, then\r
  85         scale to (simulated) 1/100ths of a millisecond. */\r
  86         if( llTicksPerHundedthMillisecond == 0 )\r
  87         {\r
  88                 /* The trace macros are probably calling this function before the\r
  89                 scheduler has been started. */\r
  90                 ulReturn = 0;\r
  91         }\r
  92         else\r
  93         {\r
  94                 ulReturn = ( unsigned long ) ( ( liCurrentCount.QuadPart - llInitialRunTimeCounterValue ) / llTicksPerHundedthMillisecond );\r
  95         }\r
  96 \r
  97         return ulReturn;\r
  98 }\r
  99 /*-----------------------------------------------------------*/\r