include/osmocom/core/logging.h

   1 #ifndef _OSMOCORE_LOGGING_H
   2 #define _OSMOCORE_LOGGING_H
   3
   4 #include <stdio.h>
   5 #include <stdint.h>
   6 #include <osmocom/core/linuxlist.h>
   7
   8 #define LOG_MAX_CTX             8
   9 #define LOG_MAX_FILTERS 8
  10
  11 #define DEBUG
  12
  13 #ifdef DEBUG
  14 #define DEBUGP(ss, fmt, args...) logp(ss, __FILE__, __LINE__, 0, fmt, ## args)
  15 #define DEBUGPC(ss, fmt, args...) logp(ss, __FILE__, __LINE__, 1, fmt, ## args)
  16 #else
  17 #define DEBUGP(xss, fmt, args...)
  18 #define DEBUGPC(ss, fmt, args...)
  19 #endif
  20
  21
  22 void logp(int subsys, char *file, int line, int cont, const char *format, ...) __attribute__ ((format (printf, 5, 6)));
  23
  24 /* new logging interface */
  25 #define LOGP(ss, level, fmt, args...) \
  26         logp2(ss, level, __FILE__, __LINE__, 0, fmt, ##args)
  27 #define LOGPC(ss, level, fmt, args...) \
  28         logp2(ss, level, __FILE__, __LINE__, 1, fmt, ##args)
  29
  30 /* different levels */
  31 #define LOGL_DEBUG      1       /* debugging information */
  32 #define LOGL_INFO       3
  33 #define LOGL_NOTICE     5       /* abnormal/unexpected condition */
  34 #define LOGL_ERROR      7       /* error condition, requires user action */
  35 #define LOGL_FATAL      8       /* fatal, program aborted */
  36
  37 #define LOG_FILTER_ALL  0x0001
  38
  39 /* logging levels defined by the library itself */
  40 #define DLGLOBAL        -1
  41 #define DLLAPDM         -2
  42 #define OSMO_NUM_DLIB   2
  43
  44 struct log_category {
  45         uint8_t loglevel;
  46         uint8_t enabled;
  47 };
  48
  49 struct log_info_cat {
  50         const char *name;
  51         const char *color;
  52         const char *description;
  53         uint8_t loglevel;
  54         uint8_t enabled;
  55 };
  56
  57 /* log context information, passed to filter */
  58 struct log_context {
  59         void *ctx[LOG_MAX_CTX+1];
  60 };
  61
  62 struct log_target;
  63
  64 typedef int log_filter(const struct log_context *ctx,
  65                        struct log_target *target);
  66
  67 struct log_info {
  68         /* filter callback function */
  69         log_filter *filter_fn;
  70
  71         /* per-category information */
  72         struct log_info_cat *cat;
  73         unsigned int num_cat;
  74         unsigned int num_cat_user;
  75 };
  76
  77 enum log_target_type {
  78         LOG_TGT_TYPE_VTY,
  79         LOG_TGT_TYPE_SYSLOG,
  80         LOG_TGT_TYPE_FILE,
  81         LOG_TGT_TYPE_STDERR,
  82 };
  83
  84 struct log_target {
  85         struct llist_head entry;
  86
  87         int filter_map;
  88         void *filter_data[LOG_MAX_FILTERS+1];
  89
  90         struct log_category *categories;
  91
  92         uint8_t loglevel;
  93         int use_color:1;
  94         int print_timestamp:1;
  95
  96         enum log_target_type type;
  97
  98         union {
  99                 struct {
 100                         FILE *out;
 101                         const char *fname;
 102                 } tgt_file;
 103
 104                 struct {
 105                         int priority;
 106                         int facility;
 107                 } tgt_syslog;
 108
 109                 struct {
 110                         void *vty;
 111                 } tgt_vty;
 112         };
 113
 114         void (*output) (struct log_target *target, unsigned int level,
 115                         const char *string);
 116 };
 117
 118 /* use the above macros */
 119 void logp2(int subsys, unsigned int level, char *file,
 120            int line, int cont, const char *format, ...)
 121                                 __attribute__ ((format (printf, 6, 7)));
 122 int log_init(const struct log_info *inf, void *talloc_ctx);
 123
 124 /* context management */
 125 void log_reset_context(void);
 126 int log_set_context(uint8_t ctx, void *value);
 127
 128 /* filter on the targets */
 129 void log_set_all_filter(struct log_target *target, int);
 130
 131 void log_set_use_color(struct log_target *target, int);
 132 void log_set_print_timestamp(struct log_target *target, int);
 133 void log_set_log_level(struct log_target *target, int log_level);
 134 void log_parse_category_mask(struct log_target *target, const char* mask);
 135 int log_parse_level(const char *lvl);
 136 const char *log_level_str(unsigned int lvl);
 137 int log_parse_category(const char *category);
 138 void log_set_category_filter(struct log_target *target, int category,
 139                                int enable, int level);
 140
 141 /* management of the targets */
 142 struct log_target *log_target_create(void);
 143 void log_target_destroy(struct log_target *target);
 144 struct log_target *log_target_create_stderr(void);
 145 struct log_target *log_target_create_file(const char *fname);
 146 struct log_target *log_target_create_syslog(const char *ident, int option,
 147                                             int facility);
 148 int log_target_file_reopen(struct log_target *tgt);
 149
 150 void log_add_target(struct log_target *target);
 151 void log_del_target(struct log_target *target);
 152
 153 /* Generate command string for VTY use */
 154 const char *log_vty_command_string(const struct log_info *info);
 155 const char *log_vty_command_description(const struct log_info *info);
 156
 157 struct log_target *log_target_find(int type, const char *fname);
 158 extern struct llist_head osmo_log_target_list;
 159
 160 #endif /* _OSMOCORE_LOGGING_H */