libtrace/record/record-dump-fatal.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*
0004  * Copyright (C) 2020, 2024 embedded brains GmbH & Co. KG
0005  *
0006  * Redistribution and use in source and binary forms, with or without
0007  * modification, are permitted provided that the following conditions
0008  * are met:
0009  * 1. Redistributions of source code must retain the above copyright
0010  *    notice, this list of conditions and the following disclaimer.
0011  * 2. Redistributions in binary form must reproduce the above copyright
0012  *    notice, this list of conditions and the following disclaimer in the
0013  *    documentation and/or other materials provided with the distribution.
0014  *
0015  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0016  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0017  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0018  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0019  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0020  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0021  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0024  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0025  * POSSIBILITY OF SUCH DAMAGE.
0026  */
0027
0028 #ifdef HAVE_CONFIG_H
0029 #include "config.h"
0030 #endif
0031
0032 #include <rtems/recorddump.h>
0033
0034 #include <rtems/bspIo.h>
0035 #include <rtems/score/isrlock.h>
0036 #include <rtems/score/smpimpl.h>
0037 #include <rtems/score/timecounter.h>
0038
0039 #if ISR_LOCK_NEEDS_OBJECT
0040 static ISR_lock_Control _Record_Dump_base64_lock =
0041   ISR_LOCK_INITIALIZER( "Record Dump base64" );
0042 #endif
0043
0044 static bool _Record_Dump_base64_done;
0045
0046 void _Record_Fatal_dump_base64(
0047   Internal_errors_Source source,
0048   bool                   always_set_to_false,
0049   Internal_errors_t      code
0050 )
0051 {
0052   ISR_lock_Context     lock_context;
0053   Per_CPU_Control     *cpu_self;
0054   rtems_record_context record_context;
0055   sbintime_t           now;
0056
0057   cpu_self = _Per_CPU_Get();
0058
0059   now = _Timecounter_Sbinuptime();
0060   rtems_record_prepare_critical( &record_context, cpu_self );
0061   rtems_record_add(
0062     &record_context,
0063     RTEMS_RECORD_UPTIME_LOW,
0064     (uint32_t) ( now >> 0 )
0065   );
0066   rtems_record_add(
0067     &record_context,
0068     RTEMS_RECORD_UPTIME_HIGH,
0069     (uint32_t) ( now >> 32 )
0070   );
0071   rtems_record_commit_critical( &record_context );
0072
0073   rtems_record_prepare_critical( &record_context, cpu_self );
0074   rtems_record_add(
0075     &record_context,
0076     RTEMS_RECORD_FATAL_SOURCE,
0077     source
0078   );
0079   rtems_record_add(
0080     &record_context,
0081     RTEMS_RECORD_FATAL_CODE,
0082     code
0083   );
0084   rtems_record_commit_critical( &record_context );
0085
0086 #if defined(RTEMS_SMP)
0087   if (
0088     source == RTEMS_FATAL_SOURCE_SMP &&
0089     code == SMP_FATAL_SHUTDOWN_RESPONSE
0090   ) {
0091     return;
0092   }
0093
0094   /* Request other online processors to shutdown to stop event generation */
0095   _SMP_Request_shutdown();
0096 #endif
0097
0098   _ISR_lock_Acquire( &_Record_Dump_base64_lock, &lock_context );
0099
0100   if ( !_Record_Dump_base64_done ) {
0101     _Record_Dump_base64_done = true;
0102
0103     printk( "\n*** BEGIN OF RECORDS BASE64 ***\n" );
0104     rtems_record_dump_base64( rtems_put_char, NULL );
0105     printk( "\n*** END OF RECORDS BASE64 ***\n" );
0106   }
0107
0108   _ISR_lock_Release( &_Record_Dump_base64_lock, &lock_context );
0109 }