chiark - git - mdw - disorder/blob - lib/log.h

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2004, 2005, 2007-9, 2013 Richard Kettlewell
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 /** @file lib/log.h
  19  * @brief Errors and logging
  20  */
  21
  22 #ifndef LOG_H
  23 #define LOG_H
  24
  25 #include <stdarg.h>
  26
  27 struct log_output;
  28
  29 void set_progname(char **argv);
  30
  31 /** @brief Possible error number spaces */
  32 enum error_class {
  33   /** @brief Invalid number space */
  34   ec_none,
  35
  36   /** @brief @c errno number space */
  37   ec_errno,
  38
  39   /** @brief getaddrinfo() return value */
  40   ec_getaddrinfo,
  41 };
  42
  43 # define ec_native ec_errno
  44 # define ec_socket ec_errno
  45
  46 void elog(int pri, enum error_class, int errno_value, const char *fmt, va_list ap);
  47
  48 void disorder_fatal(int errno_value, const char *msg, ...) attribute((noreturn))
  49   attribute((format (printf, 2, 3)));
  50 void disorder_fatal_ec(enum error_class ec, int errno_value, const char *msg, ...) attribute((noreturn))
  51   attribute((format (printf, 3, 4)));
  52 void disorder_error(int errno_value, const char *msg, ...)
  53   attribute((format (printf, 2, 3)));
  54 void disorder_error_ec(enum error_class ec, int errno_value, const char *msg, ...)
  55   attribute((format (printf, 3, 4)));
  56 void disorder_info(const char *msg, ...)
  57   attribute((format (printf, 1, 2)));
  58 void disorder_debug(const char *msg, ...)
  59   attribute((format (printf, 1, 2)));
  60 /* report a message of the given class.  @errno_value@ if present an
  61  * non-zero is included.  @fatal@ terminates the process. */
  62
  63 const char *format_error(enum error_class ec, int err, char buffer[], size_t bufsize);
  64
  65 extern int debugging;
  66 /* set when debugging enabled */
  67
  68 extern void (*exitfn)(int) attribute((noreturn));
  69 /* how to exit the program (for fatal) */
  70
  71 extern const char *progname;
  72 /* program name */
  73
  74 extern struct log_output log_stderr, *log_default;
  75 #if HAVE_SYSLOG_H
  76 extern struct log_output log_syslog;
  77 #endif
  78 /* some typical outputs */
  79
  80 extern const char *debug_filename;
  81 extern int debug_lineno;
  82 extern int logdate;
  83
  84 /** @brief Issue a debug message if debugging is turned on
  85  * @param x Parenthesized debug arguments
  86  *
  87  * Use in the format: D(("format string", arg, arg, ...));
  88  */
  89 #define D(x) do {                               \
  90   if(debugging) {                               \
  91     debug_filename=__FILE__;                    \
  92     debug_lineno=__LINE__;                      \
  93     disorder_debug x;                           \
  94   }                                             \
  95 } while(0)
  96
  97 #endif /* LOG_H */
  98
  99 /*
 100 Local Variables:
 101 c-basic-offset:2
 102 comment-column:40
 103 fill-column:79
 104 End:
 105 */