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 // These functions do not allocate memory to send data to the log. 38 39 __BEGIN_DECLS 40 41 enum { 42 ANDROID_LOG_UNKNOWN = 0, 43 ANDROID_LOG_DEFAULT, /* only for SetMinPriority() */ 44 45 ANDROID_LOG_VERBOSE, 46 ANDROID_LOG_DEBUG, 47 ANDROID_LOG_INFO, 48 ANDROID_LOG_WARN, 49 ANDROID_LOG_ERROR, 50 ANDROID_LOG_FATAL, 51 52 ANDROID_LOG_SILENT, /* only for SetMinPriority(); must be last */ 53 }; 54 55 enum { 56 LOG_ID_MIN = 0, 57 58 LOG_ID_MAIN = 0, 59 LOG_ID_RADIO = 1, 60 LOG_ID_EVENTS = 2, 61 LOG_ID_SYSTEM = 3, 62 LOG_ID_CRASH = 4, 63 64 LOG_ID_MAX 65 }; 66 67 // Formats a message to the log (priority 'fatal'), then aborts. 68 // Implemented as a macro so that async_safe_fatal isn't on the stack when we crash: 69 // we appear to go straight from the caller to abort, saving an uninteresting stack 70 // frame. 71 #define async_safe_fatal(...) \ 72 do { \ 73 async_safe_fatal_no_abort(__VA_ARGS__); \ 74 abort(); \ 75 } while (0) \ 76 77 78 // These functions do return, so callers that want to abort, must do so themselves, 79 // or use the macro above. 80 void async_safe_fatal_no_abort(const char* fmt, ...) __printflike(1, 2); 81 void async_safe_fatal_va_list(const char* prefix, const char* fmt, va_list args); 82 83 // 84 // Formatting routines for the C library's internal debugging. 85 // Unlike the usual alternatives, these don't allocate, and they don't drag in all of stdio. 86 // These are async signal safe, so they can be called from signal handlers. 87 // 88 89 int async_safe_format_buffer(char* buf, size_t size, const char* fmt, ...) __printflike(3, 4); 90 int async_safe_format_buffer_va_list(char* buffer, size_t buffer_size, const char* format, va_list args); 91 92 int async_safe_format_fd(int fd, const char* format , ...) __printflike(2, 3); 93 int async_safe_format_log(int pri, const char* tag, const char* fmt, ...) __printflike(3, 4); 94 int async_safe_format_log_va_list(int pri, const char* tag, const char* fmt, va_list ap); 95 int async_safe_write_log(int pri, const char* tag, const char* msg); 96 97 #define CHECK(predicate) \ 98 do { \ 99 if (!(predicate)) { \ 100 async_safe_fatal("%s:%d: %s CHECK '" #predicate "' failed", \ 101 __FILE__, __LINE__, __FUNCTION__); \ 102 } \ 103 } while(0) 104 105 __END_DECLS 106