1 /* 2 * Copyright (C) 2014 The Android Open Source Project 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in 12 * the documentation and/or other materials provided with the 13 * distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #pragma once 30 31 /** 32 * @file android/set_abort_message.h 33 * @brief The android_set_abort_message() function. 34 */ 35 36 #include <stddef.h> 37 #include <stdint.h> 38 #include <string.h> 39 #include <sys/cdefs.h> 40 41 __BEGIN_DECLS 42 43 typedef struct crash_detail_t crash_detail_t; 44 45 /** 46 * android_set_abort_message() sets the abort message passed to 47 * [debuggerd](https://source.android.com/devices/tech/debug/native-crash) 48 * for inclusion in any crash. 49 * 50 * This is meant for use by libraries that deliberately abort so that they can 51 * provide an explanation. It is used within bionic to implement assert() and 52 * all FORTIFY and fdsan failures. 53 * 54 * The message appears directly in logcat at the time of crash. It will 55 * also be added to both the tombstone proto in the crash_detail field, and 56 * in the tombstone text format. 57 * 58 * Tombstone proto definition: 59 * https://cs.android.com/android/platform/superproject/main/+/main:system/core/debuggerd/proto/tombstone.proto 60 * 61 * An app can get hold of these for any `REASON_CRASH_NATIVE` instance of 62 * `android.app.ApplicationExitInfo`. 63 * https://developer.android.com/reference/android/app/ApplicationExitInfo#getTraceInputStream() 64 * 65 * The given message is copied at the time this function is called, and does 66 * not need to be valid until the crash actually happens, but typically this 67 * function is called immediately before aborting. See <android/crash_detail.h> 68 * for API more suited to the use case where the caller doesn't _expect_ a 69 * crash but would like to see the information _if_ a crash happens. 70 */ 71 void android_set_abort_message(const char* _Nullable __msg); 72 73 __END_DECLS 74