tmtests/include/timesys.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  *  @file
0005  *  @brief Timing Test Support
0006  *
0007  *  This header file contains supporting definitions for the
0008  *  Timing Test Suites.
0009  */
0010
0011 /*
0012  *  COPYRIGHT (c) 1989-2013.
0013  *  On-Line Applications Research Corporation (OAR).
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #include <tmacros.h>
0038 #include <inttypes.h>
0039
0040 /*
0041  *  This constant determines the maximum number of a resource
0042  *  that will be created.  For example, some test create multiple
0043  *  blocking tasks to determine the execution time of blocking
0044  *  services.  By default, the blocking time of 100 tasks will
0045  *  be measured.  Small targets often do not have enough memory
0046  *  to create 100 tasks.  By overriding the default OPERATION_COUNT
0047  *  with a lower number (typically 10 or less), all of the time tests
0048  *  can usually be run.  This is stil not very fine-grained but
0049  *  is enough to significantly reduce memory consumption.
0050  */
0051
0052 #ifndef OPERATION_COUNT
0053 #define OPERATION_COUNT 100
0054 #endif
0055
0056 /* functions */
0057
0058 #define put_time( _message, _total_time, \
0059                   _iterations, _loop_overhead, _overhead ) \
0060     printf( \
0061       "%s - %" PRId32 "\n", \
0062       (_message), \
0063       (((_total_time) - (_loop_overhead)) / (_iterations)) - (_overhead) \
0064     )
0065
0066 #if  defined(CONFIGURE_STACK_CHECKER_ENABLED) || defined(RTEMS_DEBUG)
0067 #define Print_Warning() \
0068   do { \
0069     puts( \
0070       "\n" \
0071       "THE TIMES REPORTED BY THIS TEST INCLUDE DEBUG CODE!\n" \
0072       "\n" \
0073     ); \
0074   } while (0)
0075
0076 #else
0077 #define Print_Warning()
0078 #endif
0079
0080 /* variables */
0081
0082 TEST_EXTERN volatile uint32_t   end_time;   /* ending time variable */
0083 TEST_EXTERN volatile uint32_t   overhead;   /* loop overhead variable */
0084
0085 /* end of include file */