summaryrefslogtreecommitdiff
path: root/FreeRTOS-Plus/Test/FreeRTOS-Plus-TCP/Integration/Full-TCP-Suite/Logging/run-time-stats-utils.c
blob: 20ccec8b2a2d47d6c77aa876510e5caff2e93620 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/*
 * FreeRTOS V202111.00
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */


/*
 * Utility functions required to gather run time statistics.  See:
 * http://www.freertos.org/rtos-run-time-stats.html
 *
 * Note that this is a simulated port, where simulated time is a lot slower than
 * real time, therefore the run time counter values have no real meaningful
 * units.
 *
 * Also note that it is assumed this demo is going to be used for short periods
 * of time only, and therefore timer overflows are not handled.
 */

/* FreeRTOS includes. */
#include <FreeRTOS.h>

/* Variables used in the creation of the run time stats time base.  Run time
 * stats record how much time each task spends in the Running state. */
static long long llInitialRunTimeCounterValue = 0LL, llTicksPerHundedthMillisecond = 0LL;

/*-----------------------------------------------------------*/

void vConfigureTimerForRunTimeStats( void )
{
    LARGE_INTEGER liPerformanceCounterFrequency, liInitialRunTimeValue;

    /* Initialise the variables used to create the run time stats time base.
     * Run time stats record how much time each task spends in the Running
     * state. */

    if( QueryPerformanceFrequency( &liPerformanceCounterFrequency ) == 0 )
    {
        llTicksPerHundedthMillisecond = 1;
    }
    else
    {
        /* How many times does the performance counter increment in 1/100th
         * millisecond. */
        llTicksPerHundedthMillisecond = liPerformanceCounterFrequency.QuadPart / 100000LL;

        /* What is the performance counter value now, this will be subtracted
         * from readings taken at run time. */
        QueryPerformanceCounter( &liInitialRunTimeValue );
        llInitialRunTimeCounterValue = liInitialRunTimeValue.QuadPart;
    }
}
/*-----------------------------------------------------------*/

unsigned long ulGetRunTimeCounterValue( void )
{
    LARGE_INTEGER liCurrentCount;
    unsigned long ulReturn;

    /* What is the performance counter value now? */
    QueryPerformanceCounter( &liCurrentCount );

    /* Subtract the performance counter value reading taken when the
     * application started to get a count from that reference point, then
     * scale to (simulated) 1/100ths of a millisecond. */
    if( llTicksPerHundedthMillisecond == 0 )
    {
        /* The trace macros can call this function before the kernel has been
         * started, in which case llTicksPerHundedthMillisecond will not have been
         * initialised. */
        ulReturn = 0;
    }
    else
    {
        ulReturn = ( unsigned long )
                   ( ( liCurrentCount.QuadPart - llInitialRunTimeCounterValue ) /
                     llTicksPerHundedthMillisecond );
    }

    return ulReturn;
}
/*-----------------------------------------------------------*/