xref: /aosp_15_r20/external/pigweed/pw_assert_trap/public/pw_assert_trap/handler.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2024 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 //     https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14 #pragma once
15 
16 #include "pw_preprocessor/util.h"
17 
18 #if defined(_PW_ASSERT_TRAP_DISABLE_TRAP_FOR_TESTING) && \
19     _PW_ASSERT_TRAP_DISABLE_TRAP_FOR_TESTING
20 #define _PW_ASSERT_TRAP_EPILOG() pw_assert_trap_interrupt_unlock();
21 #else
22 #define _PW_ASSERT_TRAP_EPILOG() __builtin_trap();
23 #endif  // defined(_PW_ASSERT_TRAP_DISABLE_TRAP_FOR_TESTING) &&
24         // _PW_ASSERT_TRAP_DISABLE_TRAP_FOR_TESTING
25 
26 PW_EXTERN_C_START
27 
28 void pw_assert_trap_interrupt_lock(void);
29 void pw_assert_trap_interrupt_unlock(void);
30 
31 // TODO: https://pwbug.dev/351904146 - tokenize these handlers.
32 void pw_assert_trap_HandleAssertFailure(const char* file_name,
33                                         int line_number,
34                                         const char* function_name);
35 
36 void pw_assert_trap_HandleCheckFailure(const char* file_name,
37                                        int line_number,
38                                        const char* function_name,
39                                        const char* format,
40                                        ...);
41 
42 PW_EXTERN_C_END
43