2 * Copyright (c) 2005-2008, The Android Open Source Project
3 * Copyright (c) 2009-2013, Samsung Electronics Co., Ltd. All rights reserved.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
32 #include <arpa/inet.h>
38 #define DEFAULT_LOG_ROTATE_SIZE_KBYTES 16
39 #define DEFAULT_MAX_ROTATED_LOGS 4
40 #define MAX_QUEUED 4096
41 #define LOG_FILE_DIR "/dev/log_"
43 static log_format* g_logformat;
44 static bool g_nonblock = false;
45 static int g_tail_lines = 0;
47 static const char * g_output_filename = NULL;
48 static int g_log_rotate_size_kbytes = 0; // 0 means "no log rotation"
49 static int g_max_rotated_logs = DEFAULT_MAX_ROTATED_LOGS; // 0 means "unbounded"
50 static int g_outfd = -1;
51 static off_t g_out_byte_count = 0;
52 static int g_dev_count = 0;
54 struct queued_entry_t {
56 unsigned char buf[LOGGER_ENTRY_MAX_LEN + 1] __attribute__((aligned(4)));
57 struct logger_entry entry __attribute__((aligned(4)));
59 struct queued_entry_t* next;
62 static int cmp(struct queued_entry_t* a, struct queued_entry_t* b)
64 int n = a->entry.sec - b->entry.sec;
68 return a->entry.nsec - b->entry.nsec;
76 struct queued_entry_t* queue;
77 struct log_device_t* next;
80 static void enqueue(struct log_device_t* device, struct queued_entry_t* entry)
82 if (device->queue == NULL) {
83 device->queue = entry;
85 struct queued_entry_t** e = &device->queue;
86 while (*e && cmp(entry, *e) >= 0 ) {
94 static int open_logfile (const char *pathname)
96 return open(pathname, O_WRONLY | O_APPEND | O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH);
99 static void rotate_logs()
106 // Can't rotate logs if we're not outputting to a file
107 if (g_output_filename == NULL) {
113 for (i = g_max_rotated_logs ; i > 0 ; i--) {
114 snprintf(file1, 255, "%s.%d", g_output_filename, i);
117 snprintf(file0, 255, "%s", g_output_filename);
119 snprintf(file0, 255, "%s.%d", g_output_filename, i - 1);
122 err = rename (file0, file1);
124 if (err < 0 && errno != ENOENT) {
125 perror("while rotating log files");
129 g_outfd = open_logfile (g_output_filename);
132 perror ("couldn't open output file");
136 g_out_byte_count = 0;
141 static void processBuffer(struct log_device_t* dev, struct logger_entry *buf)
143 int bytes_written = 0;
148 err = log_process_log_buffer(buf, &entry);
154 if (log_should_print_line(g_logformat, entry.tag, entry.priority)) {
155 if (false && g_dev_count > 1) {
156 mgs_buf[0] = dev->device[0];
158 bytes_written = write(g_outfd, mgs_buf, 2);
159 if (bytes_written < 0) {
160 perror("output error");
165 bytes_written = log_print_log_line(g_logformat, g_outfd, &entry);
167 if (bytes_written < 0) {
168 perror("output error");
173 g_out_byte_count += bytes_written;
175 if (g_log_rotate_size_kbytes > 0 && (g_out_byte_count / 1024) >= g_log_rotate_size_kbytes) {
187 static void chooseFirst(struct log_device_t* dev, struct log_device_t** firstdev)
189 for (*firstdev = NULL; dev != NULL; dev = dev->next) {
190 if (dev->queue != NULL && (*firstdev == NULL ||
191 cmp(dev->queue, (*firstdev)->queue) < 0)) {
197 static void maybePrintStart(struct log_device_t* dev) {
200 if (g_dev_count > 1 ) {
202 snprintf(buf, sizeof(buf), "--------- beginning of %s\n", dev->device);
203 if (write(g_outfd, buf, strlen(buf)) < 0) {
204 perror("output error");
211 static void skipNextEntry(struct log_device_t* dev) {
212 maybePrintStart(dev);
213 struct queued_entry_t* entry = dev->queue;
214 dev->queue = entry->next;
218 static void printNextEntry(struct log_device_t* dev)
220 maybePrintStart(dev);
221 processBuffer(dev, &dev->queue->entry);
226 static void read_log_lines(struct log_device_t* devices)
228 struct log_device_t* dev;
231 int queued_lines = 0;
232 bool sleep = false; // for exit immediately when log buffer is empty and g_nonblock value is true.
237 for (dev=devices; dev; dev = dev->next) {
245 struct timeval timeout = { 0, 5000 /* 5ms */ }; // If we oversleep it's ok, i.e. ignore EINTR.
247 for (dev=devices; dev; dev = dev->next) {
248 FD_SET(dev->fd, &readset);
250 result = select(max + 1, &readset, NULL, NULL, sleep ? NULL : &timeout);
251 } while (result == -1 && errno == EINTR);
254 for (dev=devices; dev; dev = dev->next) {
255 if (FD_ISSET(dev->fd, &readset)) {
256 struct queued_entry_t* entry = (struct queued_entry_t *)malloc(sizeof( struct queued_entry_t));
258 fprintf(stderr,"Can't malloc queued_entry\n");
263 /* NOTE: driver guarantees we read exactly one full entry */
264 ret = read(dev->fd, entry->buf, LOGGER_ENTRY_MAX_LEN);
266 if (errno == EINTR) {
270 if (errno == EAGAIN) {
274 perror("dlogutil read");
279 fprintf(stderr, "read: Unexpected EOF!\n");
282 else if (entry->entry.len != ret - sizeof(struct logger_entry)) {
283 fprintf(stderr, "read: unexpected length. Expected %d, got %d\n",
284 entry->entry.len, ret - sizeof(struct logger_entry));
289 entry->entry.msg[entry->entry.len] = '\0';
293 if (g_nonblock && MAX_QUEUED < queued_lines) {
295 chooseFirst(devices, &dev);
307 /* we did our short timeout trick and there's nothing new
308 print everything we have and wait for more data */
311 chooseFirst(devices, &dev);
315 if (g_tail_lines == 0 || queued_lines <= g_tail_lines) {
323 /* the caller requested to just dump the log and exit */
328 /* print all that aren't the last in their list */
330 while (g_tail_lines == 0 || queued_lines > g_tail_lines) {
331 chooseFirst(devices, &dev);
332 if (dev == NULL || dev->queue->next == NULL) {
335 if (g_tail_lines == 0) {
350 static int clear_log(int logfd)
352 return ioctl(logfd, LOGGER_FLUSH_LOG);
355 /* returns the total size of the log's ring buffer */
356 static int get_log_size(int logfd)
358 return ioctl(logfd, LOGGER_GET_LOG_BUF_SIZE);
361 /* returns the readable size of the log's ring buffer (that is, amount of the log consumed) */
362 static int get_log_readable_size(int logfd)
364 return ioctl(logfd, LOGGER_GET_LOG_LEN);
367 static void setup_output()
370 if (g_output_filename == NULL) {
371 g_outfd = STDOUT_FILENO;
376 g_outfd = open_logfile (g_output_filename);
379 perror ("couldn't open output file");
382 if (fstat(g_outfd, &statbuf) == -1)
383 g_out_byte_count = 0;
385 g_out_byte_count = statbuf.st_size;
389 static int set_log_format(const char * formatString)
391 static log_print_format format;
393 format = log_format_from_string(formatString);
395 if (format == FORMAT_OFF) {
396 /* FORMAT_OFF means invalid string */
400 log_set_print_format(g_logformat, format);
405 static void show_help(const char *cmd)
407 fprintf(stderr,"Usage: %s [options] [filterspecs]\n", cmd);
409 fprintf(stderr, "options include:\n"
410 " -s Set default filter to silent.\n"
411 " Like specifying filterspec '*:s'\n"
412 " -f <filename> Log to file. Default to stdout\n"
413 " -r [<kbytes>] Rotate log every kbytes. (16 if unspecified). Requires -f\n"
414 " -n <count> Sets max number of rotated logs to <count>, default 4\n"
415 " -v <format> Sets the log print format, where <format> is one of:\n\n"
416 " brief(by default) process tag thread raw time threadtime long\n\n"
417 " -c clear (flush) the entire log and exit, conflicts with '-g'\n"
418 " -d dump the log and then exit (don't block)\n"
419 " -t <count> print only the most recent <count> lines (implies -d)\n"
420 " -g get the size of the log's ring buffer and exit, conflicts with '-c'\n"
421 " -b <buffer> request alternate ring buffer\n"
422 " ('main' (default), 'radio', 'system')");
425 fprintf(stderr,"\nfilterspecs are a series of \n"
426 " <tag>[:priority]\n\n"
427 "where <tag> is a log component tag (or * for all) and priority is:\n"
434 " S Silent (supress all output)\n"
435 "\n'*' means '*:D' and <tag> by itself means <tag>:V\n"
436 "If no filterspec is found, filter defaults to '*:I'\n\n");
441 * free one log_device_t and it doesn't take care of chain so it
442 * may break the chain list
444 static void log_devices_free(struct log_device_t *dev)
453 while (dev->queue->next) {
454 struct queued_entry_t *tmp = dev->queue->next;
455 dev->queue->next = tmp->next;
467 * free all the nodes after the "dev" and includes itself
469 static void log_devices_chain_free(struct log_device_t *dev)
475 struct log_device_t *tmp = dev->next;
476 dev->next = tmp->next;
477 log_devices_free(tmp);
480 log_devices_free(dev);
486 * create a new log_device_t instance but don't care about
487 * the device node accessable or not
489 static struct log_device_t *log_devices_new(const char *path)
491 struct log_device_t *new;
493 if (!path || strlen(path) <= 0)
496 new = malloc(sizeof(*new));
498 fprintf(stderr, "out of memory\n");
502 new->device = strdup(path);
504 new->printed = false;
513 * add a new device to the tail of chain
515 static int log_devices_add_to_tail(struct log_device_t *devices, struct log_device_t *new)
517 struct log_device_t *tail = devices;
519 if (!devices || !new)
531 int main(int argc, char **argv)
534 int has_set_log_format = 0;
535 int is_clear_log = 0;
538 int accessmode = R_OK;
540 struct log_device_t* devices = NULL;
541 struct log_device_t* dev;
543 g_logformat = (log_format *)log_format_new();
545 if (argc == 2 && 0 == strcmp(argv[1], "--test")) {
546 logprint_run_tests();
550 if (argc == 2 && 0 == strcmp(argv[1], "--help")) {
558 ret = getopt(argc, argv, "cdt:gsf:r:n:v:b:D");
566 /* default to all silent */
567 log_add_filter_rule(g_logformat, "*:s");
581 g_tail_lines = atoi(optarg);
591 if (asprintf(&buf, LOG_FILE_DIR "%s", optarg) == -1) {
592 fprintf(stderr,"Can't malloc LOG_FILE_DIR\n");
596 dev = log_devices_new(buf);
598 fprintf(stderr,"Can't add log device: %s\n", buf);
602 if (log_devices_add_to_tail(devices, dev)) {
603 fprintf(stderr, "Open log device %s failed\n", buf);
614 /* redirect output to a file */
615 g_output_filename = optarg;
620 if (!isdigit(optarg[0])) {
621 fprintf(stderr,"Invalid parameter to -r\n");
625 g_log_rotate_size_kbytes = atoi(optarg);
629 if (!isdigit(optarg[0])) {
630 fprintf(stderr,"Invalid parameter to -r\n");
635 g_max_rotated_logs = atoi(optarg);
639 err = set_log_format (optarg);
641 fprintf(stderr,"Invalid parameter to -v\n");
646 has_set_log_format = 1;
650 fprintf(stderr,"Unrecognized Option\n");
657 /* get log size conflicts with write mode */
658 if (getLogSize && mode != O_RDONLY) {
664 devices = log_devices_new("/dev/"LOGGER_LOG_MAIN);
665 if (devices == NULL) {
666 fprintf(stderr,"Can't add log device: %s\n", LOGGER_LOG_MAIN);
671 if (mode == O_WRONLY)
674 /* only add this if it's available */
675 if (0 == access("/dev/"LOGGER_LOG_SYSTEM, accessmode)) {
676 if (log_devices_add_to_tail(devices, log_devices_new("/dev/"LOGGER_LOG_SYSTEM))) {
677 fprintf(stderr,"Can't add log device: %s\n", LOGGER_LOG_SYSTEM);
681 if (0 == access("/dev/"LOGGER_LOG_APPS, accessmode)) {
682 if (log_devices_add_to_tail(devices, log_devices_new("/dev/"LOGGER_LOG_APPS))) {
683 fprintf(stderr,"Can't add log device: %s\n", LOGGER_LOG_APPS);
690 if (g_log_rotate_size_kbytes != 0 && g_output_filename == NULL)
692 fprintf(stderr,"-r requires -f as well\n");
700 if (has_set_log_format == 0) {
701 err = set_log_format("brief");
703 fprintf(stderr,"arc = %d, optind = %d ,Kb %d, rotate %d\n", argc, optind,g_log_rotate_size_kbytes,g_max_rotated_logs);
705 if(argc == optind ) {
706 /* Add from environment variable
707 char *env_tags_orig = getenv("DLOG_TAGS");*/
708 log_add_filter_string(g_logformat, "*:d");
711 for (i = optind ; i < argc ; i++) {
712 err = log_add_filter_string(g_logformat, argv[i]);
715 fprintf (stderr, "Invalid filter expression '%s'\n", argv[i]);
723 dev->fd = open(dev->device, mode);
725 fprintf(stderr, "Unable to open log device '%s': %s\n",
726 dev->device, strerror(errno));
732 ret = clear_log(dev->fd);
739 if (getLogSize || g_nonblock) {
742 size = get_log_size(dev->fd);
748 readable = get_log_readable_size(dev->fd);
753 g_log_rotate_size_kbytes += size / 1024;
754 printf("%s: ring buffer is %dKb (%dKb consumed), "
755 "max entry is %db, max payload is %db\n", dev->device,
756 size / 1024, readable / 1024,
757 (int) LOGGER_ENTRY_MAX_LEN, (int) LOGGER_ENTRY_MAX_PAYLOAD);
771 read_log_lines(devices);
773 log_devices_chain_free(devices);