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 #ifndef _LIBC_LOGGING_H
30 #define _LIBC_LOGGING_H
31 
32 #include <sys/cdefs.h>
33 #include <stdarg.h>
34 #include <stddef.h>
35 #include <stdint.h>
36 
37 __BEGIN_DECLS
38 
39 #include "libc_events.h"
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 struct abort_msg_t {
68   size_t size;
69   char msg[0];
70 };
71 
72 //
73 // Formats a message to the log (priority 'fatal'), then aborts.
74 //
75 
76 __LIBC_HIDDEN__ __noreturn void __libc_fatal(const char* format, ...) __printflike(1, 2);
77 
78 //
79 // Formats a message to the log (priority 'fatal'), but doesn't abort.
80 // Used by the malloc implementation to ensure that debuggerd dumps memory
81 // around the bad address.
82 //
83 
84 __LIBC_HIDDEN__ void __libc_fatal_no_abort(const char* format, ...)
85     __printflike(1, 2);
86 
87 //
88 // Formatting routines for the C library's internal debugging.
89 // Unlike the usual alternatives, these don't allocate, and they don't drag in all of stdio.
90 //
91 
92 __LIBC_HIDDEN__ int __libc_format_buffer(char* buffer, size_t buffer_size, const char* format, ...)
93     __printflike(3, 4);
94 
95 __LIBC_HIDDEN__ int __libc_format_fd(int fd, const char* format, ...)
96     __printflike(2, 3);
97 
98 __LIBC_HIDDEN__ int __libc_format_log(int priority, const char* tag, const char* format, ...)
99     __printflike(3, 4);
100 
101 __LIBC_HIDDEN__ int __libc_format_log_va_list(int priority, const char* tag, const char* format,
102                                               va_list ap);
103 
104 __LIBC_HIDDEN__ int __libc_write_log(int priority, const char* tag, const char* msg);
105 
106 //
107 // Event logging.
108 //
109 
110 __LIBC_HIDDEN__ void __libc_android_log_event_int(int32_t tag, int value);
111 __LIBC_HIDDEN__ void __libc_android_log_event_uid(int32_t tag);
112 
113 __LIBC_HIDDEN__ __noreturn void __fortify_chk_fail(const char* msg, uint32_t event_tag);
114 
115 __END_DECLS
116 
117 #endif
118