blob: 9ce37c956b5edef5b286f9a24ba156d35b6ab034 [file] [log] [blame]
Mark Salyzyn42958412013-11-22 10:50:27 -08001/*
2**
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08003** Copyright 2007, The Android Open Source Project
4**
5** This file is dual licensed. It may be redistributed and/or modified
6** under the terms of the Apache 2.0 License OR version 2 of the GNU
7** General Public License.
8*/
9
10#ifndef _UTILS_LOGGER_H
11#define _UTILS_LOGGER_H
12
Mark Salyzyn42958412013-11-22 10:50:27 -080013#include <sys/cdefs.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080014#include <stdint.h>
Mark Salyzyn42958412013-11-22 10:50:27 -080015#include <log/log.h>
16
17__BEGIN_DECLS
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080018
Nick Kralevich6756a0c2012-03-22 14:28:16 -070019/*
20 * The userspace structure for version 1 of the logger_entry ABI.
21 * This structure is returned to userspace by the kernel logger
22 * driver unless an upgrade to a newer ABI version is requested.
23 */
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080024struct logger_entry {
25 uint16_t len; /* length of the payload */
26 uint16_t __pad; /* no matter what, we get 2 bytes of padding */
27 int32_t pid; /* generating process's pid */
28 int32_t tid; /* generating process's tid */
29 int32_t sec; /* seconds since Epoch */
30 int32_t nsec; /* nanoseconds */
31 char msg[0]; /* the entry's payload */
32};
33
Nick Kralevich6756a0c2012-03-22 14:28:16 -070034/*
35 * The userspace structure for version 2 of the logger_entry ABI.
36 * This structure is returned to userspace if ioctl(LOGGER_SET_VERSION)
37 * is called with version==2
38 */
39struct logger_entry_v2 {
40 uint16_t len; /* length of the payload */
41 uint16_t hdr_size; /* sizeof(struct logger_entry_v2) */
42 int32_t pid; /* generating process's pid */
43 int32_t tid; /* generating process's tid */
44 int32_t sec; /* seconds since Epoch */
45 int32_t nsec; /* nanoseconds */
46 uint32_t euid; /* effective UID of logger */
47 char msg[0]; /* the entry's payload */
48};
49
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080050#define LOGGER_LOG_MAIN "log/main"
51#define LOGGER_LOG_RADIO "log/radio"
52#define LOGGER_LOG_EVENTS "log/events"
Joe Onoratoe2bf2ea2010-03-01 09:11:54 -080053#define LOGGER_LOG_SYSTEM "log/system"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080054
Nick Kralevich6756a0c2012-03-22 14:28:16 -070055/*
56 * The maximum size of the log entry payload that can be
57 * written to the kernel logger driver. An attempt to write
58 * more than this amount to /dev/log/* will result in a
59 * truncated log entry.
60 */
61#define LOGGER_ENTRY_MAX_PAYLOAD 4076
62
63/*
64 * The maximum size of a log entry which can be read from the
65 * kernel logger driver. An attempt to read less than this amount
66 * may result in read() returning EINVAL.
67 */
68#define LOGGER_ENTRY_MAX_LEN (5*1024)
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080069
Mark Salyzyn42958412013-11-22 10:50:27 -080070#define NS_PER_SEC 1000000000ULL
71
72struct log_msg {
73 union {
74 unsigned char buf[LOGGER_ENTRY_MAX_LEN + 1];
75 struct logger_entry_v2 entry;
76 struct logger_entry_v2 entry_v2;
77 struct logger_entry entry_v1;
78 struct {
79 unsigned char buf[LOGGER_ENTRY_MAX_LEN + 1];
80 log_id_t id;
81 } extra;
82 } __attribute__((aligned(4)));
83#ifdef __cplusplus
84 /* Matching log_time_t operators */
85 bool operator== (log_msg &T)
86 {
87 return (entry.sec == T.entry.sec) && (entry.nsec == T.entry.nsec);
88 }
89 bool operator!= (log_msg &T)
90 {
91 return !(*this == T);
92 }
93 bool operator< (log_msg &T)
94 {
95 return (entry.sec < T.entry.sec)
96 || ((entry.sec == T.entry.sec)
97 && (entry.nsec < T.entry.nsec));
98 }
99 bool operator>= (log_msg &T)
100 {
101 return !(*this < T);
102 }
103 bool operator> (log_msg &T)
104 {
105 return (entry.sec > T.entry.sec)
106 || ((entry.sec == T.entry.sec)
107 && (entry.nsec > T.entry.nsec));
108 }
109 bool operator<= (log_msg &T)
110 {
111 return !(*this > T);
112 }
113 uint64_t nsec(void)
114 {
115 return static_cast<uint64_t>(entry.sec) * NS_PER_SEC + entry.nsec;
116 }
117
118 /* packet methods */
119 log_id_t id(void)
120 {
121 return extra.id;
122 }
123 char *msg(void)
124 {
125 return entry.hdr_size ? (char *) buf + entry.hdr_size : entry_v1.msg;
126 }
127 unsigned int len(void)
128 {
129 return (entry.hdr_size ? entry.hdr_size : sizeof(entry_v1)) + entry.len;
130 }
131#endif
132};
133
134struct logger;
135
136log_id_t android_logger_get_id(struct logger *logger);
137
138int android_logger_clear(struct logger *logger);
139int android_logger_get_log_size(struct logger *logger);
140int android_logger_get_log_readable_size(struct logger *logger);
141int android_logger_get_log_version(struct logger *logger);
142
143struct logger_list;
144
145struct logger_list *android_logger_list_alloc(int mode,
146 unsigned int tail,
147 pid_t pid);
148void android_logger_list_free(struct logger_list *logger_list);
149/* In the purest sense, the following two are orthogonal interfaces */
150int android_logger_list_read(struct logger_list *logger_list,
151 struct log_msg *log_msg);
152
153/* Multiple log_id_t opens */
154struct logger *android_logger_open(struct logger_list *logger_list,
155 log_id_t id);
156#define android_logger_close android_logger_free
157/* Single log_id_t open */
158struct logger_list *android_logger_list_open(log_id_t id,
159 int mode,
160 unsigned int tail,
161 pid_t pid);
162#define android_logger_list_close android_logger_list_free
163
164/*
165 * log_id_t helpers
166 */
167log_id_t android_name_to_log_id(const char *logName);
168const char *android_log_id_to_name(log_id_t log_id);
169
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800170#ifdef HAVE_IOCTL
171
172#include <sys/ioctl.h>
173
174#define __LOGGERIO 0xAE
175
176#define LOGGER_GET_LOG_BUF_SIZE _IO(__LOGGERIO, 1) /* size of log */
177#define LOGGER_GET_LOG_LEN _IO(__LOGGERIO, 2) /* used log len */
178#define LOGGER_GET_NEXT_ENTRY_LEN _IO(__LOGGERIO, 3) /* next entry len */
179#define LOGGER_FLUSH_LOG _IO(__LOGGERIO, 4) /* flush log */
Nick Kralevich6756a0c2012-03-22 14:28:16 -0700180#define LOGGER_GET_VERSION _IO(__LOGGERIO, 5) /* abi version */
181#define LOGGER_SET_VERSION _IO(__LOGGERIO, 6) /* abi version */
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800182
183#endif // HAVE_IOCTL
184
Mark Salyzyn42958412013-11-22 10:50:27 -0800185__END_DECLS
186
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800187#endif /* _UTILS_LOGGER_H */