1 /* 2 * Copyright (c) 2021-2023 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://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, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 #ifndef DFX_SIGNAL_HANDLER_H 16 #define DFX_SIGNAL_HANDLER_H 17 18 #include <inttypes.h> 19 #include <threads.h> 20 #include <signal.h> 21 #include <ucontext.h> 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 /** 27 * @brief callback function of thread infomation when thread crash 28 * 29 * @param buf buffer for writing thread infomation 30 * @param len length of buffer 31 * @param ucontext userlevel context 32 */ 33 typedef void(*ThreadInfoCallBack)(char* buf, size_t len, void* ucontext); 34 35 /** 36 * @brief set callback function of thread infomation 37 * 38 * @param func callback function of thread infomation 39 */ 40 void SetThreadInfoCallback(ThreadInfoCallBack func); 41 42 /** 43 * @brief install signal handler 44 */ 45 void DFX_InstallSignalHandler(void); 46 47 typedef uint64_t(*GetStackIdFunc)(void); 48 void SetAsyncStackCallbackFunc(void* func); 49 50 int DFX_SetAppRunningUniqueId(const char* appRunningId, size_t len); 51 52 enum CrashObjType : uint8_t { 53 /* string type */ 54 OBJ_STRING = 0, 55 /* 64 byte memory */ 56 OBJ_MEMORY_64B, 57 /* 256 byte memory */ 58 OBJ_MEMORY_256B, 59 /* 1024 byte memory */ 60 OBJ_MEMORY_1024B, 61 /* 2048 byte memory */ 62 OBJ_MEMORY_2048B, 63 /* 4096 byte memory */ 64 OBJ_MEMORY_4096B, 65 }; 66 /** 67 * @brief set crash object which is measurement information of crash 68 * 69 * @param type type of object, using enum CrashObjType 70 * @param addr addr of object 71 * @return return crash Object which set up last time 72 */ 73 uintptr_t DFX_SetCrashObj(uint8_t type, uintptr_t addr); 74 75 /** 76 * @brief reset crash object 77 * 78 * @param crashObj return of DFX_SetCrashObj 79 */ 80 void DFX_ResetCrashObj(uintptr_t crashObj); 81 #ifdef __cplusplus 82 } 83 #endif 84 #endif 85