include/rtems/test-gcov.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSImplGcov
0007  *
0008  * @brief This header file provides the interfaces of the @ref RTEMSImplGcov.
0009  */
0010
0011 /*
0012  * Copyright (C) 2013, 2014 embedded brains GmbH & Co. KG
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 #ifndef _RTEMS_TEST_GCOV_H
0037 #define _RTEMS_TEST_GCOV_H
0038
0039 #include <gcov.h>
0040
0041 #include <rtems/linkersets.h>
0042 #include <rtems/dev/io.h>
0043
0044 #ifdef __cplusplus
0045 extern "C" {
0046 #endif /* __cplusplus */
0047
0048 /**
0049  * @defgroup RTEMSImplGcov Gcov Support
0050  *
0051  * @ingroup RTEMSTestFrameworkImpl
0052  *
0053  * @brief This group contains the gocv support.
0054  *
0055  * @{
0056  */
0057
0058 RTEMS_LINKER_ROSET_DECLARE( gcov_info, const struct gcov_info * );
0059
0060 /**
0061  * @brief Dumps the gcov information as a binary gcfn and gcda data
0062  *   stream using the put character handler.
0063  *
0064  * @param put_char is the put character handler used to output the data stream.
0065  *
0066  * @param arg is the argument passed to the put character handler.
0067  */
0068 void _Gcov_Dump_info( IO_Put_char put_char, void *arg );
0069
0070 /**
0071  * @brief Dumps the gcov information as a base64 encoded gcfn and gcda data
0072  *   stream using the put character handler.
0073  *
0074  * @param put_char is the put character handler used to output the data stream.
0075  *
0076  * @param arg is the argument passed to the put character handler.
0077  */
0078 void _Gcov_Dump_info_base64( IO_Put_char put_char, void *arg );
0079
0080 /** @} */
0081
0082 #ifdef __cplusplus
0083 }
0084 #endif /* __cplusplus */
0085
0086 #endif /* _RTEMS_TEST_GCOV_H */