1 /* 2 * Copyright (C) 2010 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 #include <sys/cdefs.h> 32 #include <stdarg.h> 33 #include <stddef.h> 34 #include <stdint.h> 35 #include <stdlib.h> 36 37 // This file is an alternative to <android/log.h>, but reuses 38 // `android_LogPriority` and should not have conflicting identifiers. 39 #include <android/log.h> 40 41 // These functions do not allocate memory to send data to the log. 42 43 __BEGIN_DECLS 44 45 // Formats a message to the log (priority 'fatal'), then aborts. 46 // Implemented as a macro so that async_safe_fatal isn't on the stack when we crash: 47 // we appear to go straight from the caller to abort, saving an uninteresting stack 48 // frame. 49 #define async_safe_fatal(...) \ 50 do { \ 51 async_safe_fatal_no_abort(__VA_ARGS__); \ 52 abort(); \ 53 } while (0) \ 54 55 56 // These functions do return, so callers that want to abort, must do so themselves, 57 // or use the macro above. 58 void async_safe_fatal_no_abort(const char* fmt, ...) __printflike(1, 2); 59 void async_safe_fatal_va_list(const char* prefix, const char* fmt, va_list args); 60 61 // 62 // Formatting routines for the C library's internal debugging. 63 // Unlike the usual alternatives, these don't allocate, and they don't drag in all of stdio. 64 // These are async signal safe, so they can be called from signal handlers. 65 // 66 67 int async_safe_format_buffer(char* buf, size_t size, const char* fmt, ...) __printflike(3, 4); 68 int async_safe_format_buffer_va_list(char* buffer, size_t buffer_size, const char* format, va_list args); 69 70 int async_safe_format_fd(int fd, const char* format , ...) __printflike(2, 3); 71 int async_safe_format_fd_va_list(int fd, const char* format, va_list args); 72 int async_safe_format_log(int priority, const char* tag, const char* fmt, ...) __printflike(3, 4); 73 int async_safe_format_log_va_list(int priority, const char* tag, const char* fmt, va_list ap); 74 int async_safe_write_log(int priority, const char* tag, const char* msg); 75 76 __END_DECLS 77