From ab42b3e1002306ed343adc47c460788ed31df66f Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Thu, 12 Mar 2020 18:29:48 +0100 Subject: record: Add rtems_record_dump() Add rtems_record_dump_base64() and rtems_record_dump_base64_zlib(). Add CONFIGURE_RECORD_FATAL_DUMP_BASE64 and CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB configuration options. Update #3904. --- cpukit/include/rtems/confdefs/extensions.h | 18 ++++- cpukit/include/rtems/record.h | 32 ++++---- cpukit/include/rtems/recorddump.h | 118 +++++++++++++++++++++++++++++ 3 files changed, 151 insertions(+), 17 deletions(-) create mode 100644 cpukit/include/rtems/recorddump.h (limited to 'cpukit/include') diff --git a/cpukit/include/rtems/confdefs/extensions.h b/cpukit/include/rtems/confdefs/extensions.h index cf53e0d573..cd68734a56 100644 --- a/cpukit/include/rtems/confdefs/extensions.h +++ b/cpukit/include/rtems/confdefs/extensions.h @@ -79,7 +79,23 @@ extern "C" { const User_extensions_Table _User_extensions_Initial_extensions[] = { #if CONFIGURE_RECORD_PER_PROCESSOR_ITEMS > 0 \ && defined(CONFIGURE_RECORD_EXTENSIONS_ENABLED) - RECORD_EXTENSION, + { + _Record_Thread_create, + _Record_Thread_start, + _Record_Thread_restart, + _Record_Thread_delete, + _Record_Thread_switch, + _Record_Thread_begin, + _Record_Thread_exitted, + #ifdef CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB + _Record_Fatal_dump_base64_zlib, + #elif defined(CONFIGURE_RECORD_FATAL_DUMP_BASE64) + _Record_Fatal_dump_base64, + #else + NULL, + #endif + _Record_Thread_terminate + }, #endif #ifdef _CONFIGURE_ENABLE_NEWLIB_REENTRANCY RTEMS_NEWLIB_EXTENSION, diff --git a/cpukit/include/rtems/record.h b/cpukit/include/rtems/record.h index 4e1c469173..2f5ad5415c 100644 --- a/cpukit/include/rtems/record.h +++ b/cpukit/include/rtems/record.h @@ -1,7 +1,7 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + /* - * SPDX-License-Identifier: BSD-2-Clause - * - * Copyright (C) 2018, 2019 embedded brains GmbH + * Copyright (C) 2018, 2020 embedded brains GmbH (http://www.embedded-brains.de) * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions @@ -32,6 +32,7 @@ #include #include +#include #include #include #include @@ -95,23 +96,22 @@ void _Record_Thread_begin( struct _Thread_Control *executing ); void _Record_Thread_exitted( struct _Thread_Control *executing ); +void _Record_Fatal_dump_base64( + Internal_errors_Source source, + bool always_set_to_false, + Internal_errors_t code +); + +void _Record_Fatal_dump_base64_zlib( + Internal_errors_Source source, + bool always_set_to_false, + Internal_errors_t code +); + void _Record_Thread_terminate( struct _Thread_Control *executing ); -#define RECORD_EXTENSION \ - { \ - _Record_Thread_create, \ - _Record_Thread_start, \ - _Record_Thread_restart, \ - _Record_Thread_delete, \ - _Record_Thread_switch, \ - _Record_Thread_begin, \ - _Record_Thread_exitted, \ - NULL, \ - _Record_Thread_terminate \ - } - RTEMS_INLINE_ROUTINE unsigned int _Record_Index( const Record_Control *control, unsigned int index diff --git a/cpukit/include/rtems/recorddump.h b/cpukit/include/rtems/recorddump.h new file mode 100644 index 0000000000..246482161c --- /dev/null +++ b/cpukit/include/rtems/recorddump.h @@ -0,0 +1,118 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/* + * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef _RTEMS_RECORDDUMP_H +#define _RTEMS_RECORDDUMP_H + +#include + +#include + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +/** + * @addtogroup RTEMSRecord + * + * @{ + */ + +/** + * @brief Handler for record dumps to output a chunk of data. + * + * @param arg The argument passed to rtems_record_dump(). + * @param data The begin of the data chunk. + * @param length The length in bytes of the data chunk. + */ +typedef void ( *rtems_record_dump_chunk )( + void *arg, + const void *data, + size_t length +); + +/** + * @brief Dumps the record header, the thread names, and all items of all + * processors. + * + * @param chunk Handler to dump a chunk of data. + * @param flush Handler to flush the data. + * @param arg The argument for the handlers. + */ +void rtems_record_dump( + rtems_record_dump_chunk chunk, + void *arg +); + +/** + * @brief Dumps the event records in base64 encoding. + * + * @param put_char The put char handler. + * @param arg The argument for the put char handler. + * + * @see rtems_record_dump(). + */ +void rtems_record_dump_base64( void ( *put_char )( int, void * ), void *arg ); + +/** + * @brief The context for record dumps with zlib compression and base64 + * encoding. + */ +typedef struct { + void ( *put_char )( int, void * ); + void *arg; + int out; + unsigned char buf[ 57 ]; + z_stream stream; + char *mem_begin; + size_t mem_available; + char mem[ 0x80000 ]; +} rtems_record_dump_base64_zlib_context; + +/** + * @brief Dumps the event records compressed with zlib in base64 encoding. + * + * @param ctx The context to perform the record dump with zlib compression and + * base64 encoding. This context is too large for normal stack sizes. + * @param put_char The put char handler. + * @param arg The argument for the put char handler. + * + * @see rtems_record_dump(). + */ +void rtems_record_dump_zlib_base64( + rtems_record_dump_base64_zlib_context *ctx, + void ( *put_char )( int, void * ), + void *arg +); + +/** @} */ + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + +#endif /* _RTEMS_RECORDDUMP_H */ -- cgit v1.2.3