cutils/logprint.h

   1 /*
   2  * Copyright (C) 2006 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef _LOGPRINT_H
  18 #define _LOGPRINT_H
  19
  20 #include <cutils/log.h>
  21 #include <cutils/logger.h>
  22 #include <cutils/event_tag_map.h>
  23 #include <pthread.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 typedef enum {
  30     FORMAT_OFF = 0,
  31     FORMAT_BRIEF,
  32     FORMAT_PROCESS,
  33     FORMAT_TAG,
  34     FORMAT_THREAD,
  35     FORMAT_RAW,
  36     FORMAT_TIME,
  37     FORMAT_THREADTIME,
  38     FORMAT_LONG,
  39 } AndroidLogPrintFormat;
  40
  41 typedef enum {
  42     OUTPUT_COLOR_ON = 0,
  43     OUTPUT_COLOR_OFF,
  44 } AndroidLogColoredOutput;
  45
  46 typedef struct AndroidLogFormat_t AndroidLogFormat;
  47
  48 typedef struct AndroidLogEntry_t {
  49     time_t tv_sec;
  50     long tv_nsec;
  51     android_LogPriority priority;
  52     int32_t pid;
  53     int32_t tid;
  54     const char * tag;
  55     size_t messageLen;
  56     const char * message;
  57 } AndroidLogEntry;
  58
  59 AndroidLogFormat *android_log_format_new();
  60
  61 void android_log_format_free(AndroidLogFormat *p_format);
  62
  63 void android_log_setPrintFormat(AndroidLogFormat *p_format,
  64         AndroidLogPrintFormat format);
  65
  66 void android_log_setColoredOutput(AndroidLogFormat *p_format);
  67
  68 /**
  69  * Returns FORMAT_OFF on invalid string
  70  */
  71 AndroidLogPrintFormat android_log_formatFromString(const char *s);
  72
  73 /**
  74  * filterExpression: a single filter expression
  75  * eg "AT:d"
  76  *
  77  * returns 0 on success and -1 on invalid expression
  78  *
  79  * Assumes single threaded execution
  80  *
  81  */
  82
  83 int android_log_addFilterRule(AndroidLogFormat *p_format,
  84         const char *filterExpression);
  85
  86
  87 /**
  88  * filterString: a whitespace-separated set of filter expressions
  89  * eg "AT:d *:i"
  90  *
  91  * returns 0 on success and -1 on invalid expression
  92  *
  93  * Assumes single threaded execution
  94  *
  95  */
  96
  97 int android_log_addFilterString(AndroidLogFormat *p_format,
  98         const char *filterString);
  99
 100
 101 /**
 102  * returns 1 if this log line should be printed based on its priority
 103  * and tag, and 0 if it should not
 104  */
 105 int android_log_shouldPrintLine (
 106         AndroidLogFormat *p_format, const char *tag, android_LogPriority pri);
 107
 108
 109 /**
 110  * Splits a wire-format buffer into an AndroidLogEntry
 111  * entry allocated by caller. Pointers will point directly into buf
 112  *
 113  * Returns 0 on success and -1 on invalid wire format (entry will be
 114  * in unspecified state)
 115  */
 116 int android_log_processLogBuffer(struct logger_entry *buf,
 117                                  AndroidLogEntry *entry);
 118
 119 /**
 120  * Like android_log_processLogBuffer, but for binary logs.
 121  *
 122  * If "map" is non-NULL, it will be used to convert the log tag number
 123  * into a string.
 124  */
 125 int android_log_processBinaryLogBuffer(struct logger_entry *buf,
 126     AndroidLogEntry *entry, const EventTagMap* map, char* messageBuf,
 127     int messageBufLen);
 128
 129
 130 /**
 131  * Formats a log message into a buffer
 132  *
 133  * Uses defaultBuffer if it can, otherwise malloc()'s a new buffer
 134  * If return value != defaultBuffer, caller must call free()
 135  * Returns NULL on malloc error
 136  */
 137
 138 char *android_log_formatLogLine (
 139     AndroidLogFormat *p_format,
 140     char *defaultBuffer,
 141     size_t defaultBufferSize,
 142     const AndroidLogEntry *p_line,
 143     size_t *p_outLength);
 144
 145
 146 /**
 147  * Either print or do not print log line, based on filter
 148  *
 149  * Assumes single threaded execution
 150  *
 151  */
 152 int android_log_printLogLine(
 153     AndroidLogFormat *p_format,
 154     int fd,
 155     const AndroidLogEntry *entry);
 156
 157
 158 #ifdef __cplusplus
 159 }
 160 #endif
 161
 162
 163 #endif /*_LOGPRINT_H*/