summaryrefslogtreecommitdiffstats
path: root/src/log.h
blob: 2c7788e89e62a73b61eef9d712797357ac336ac6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/*
  Copyright (c) 2012-2016, Matthias Schiffer <mschiffer@universe-factory.net>
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:

    1. Redistributions of source code must retain the above copyright notice,
       this list of conditions and the following disclaimer.
    2. Redistributions in binary form must reproduce the above copyright notice,
       this list of conditions and the following disclaimer in the documentation
       and/or other materials provided with the distribution.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

/**
   \file

   Logging functions and macros
*/


#pragma once

#include "types.h"

#include <errno.h>
#include <stdlib.h>
#include <string.h>


/** A log level specification */
typedef enum fastd_loglevel {
	LL_UNSPEC = 0,			/**< Nothing is logged */
	LL_FATAL,			/**< Only fatal errors are logged */
	LL_ERROR,			/**< Only errors are logged */
	LL_WARN,			/**< Only warning and errors are logged */
	LL_INFO,			/**< General informational messages are logged */
	LL_VERBOSE,			/**< More verbose logging */
	LL_DEBUG,			/**< Debug messages are logged, excluding messages potentially occuring very often */
	LL_DEBUG2,			/**< All debug messages a logged */
	LL_DEFAULT = LL_VERBOSE,	/**< The default log level */
} fastd_loglevel_t;


size_t fastd_snprint_peer_address(char *buffer, size_t size, const fastd_peer_address_t *address, const char *iface, bool bind_address, bool hide);


void fastd_logf(const fastd_loglevel_t level, const char *format, ...);

/** Logs a formatted fatal error message */
#define pr_fatal(args...) fastd_logf(LL_FATAL, args)
/** Logs a formatted error message */
#define pr_error(args...) fastd_logf(LL_ERROR, args)
/** Logs a formatted warning message */
#define pr_warn(args...) fastd_logf(LL_WARN, args)
/** Logs a formatted informational message */
#define pr_info(args...) fastd_logf(LL_INFO, args)
/** Logs a formatted verbose message */
#define pr_verbose(args...) fastd_logf(LL_VERBOSE, args)
/** Logs a formatted debug message */
#define pr_debug(args...) fastd_logf(LL_DEBUG, args)
/** Logs a formatted debug2 message */
#define pr_debug2(args...) fastd_logf(LL_DEBUG2, args)

/** Logs a simple error message adding the error found in \e errno */
#define pr_error_errno(message) pr_error("%s: %s", message, strerror(errno))
/** Logs a simple warning message adding the error found in \e errno */
#define pr_warn_errno(message) pr_warn("%s: %s", message, strerror(errno))
/** Logs a simple debug message adding the error found in \e errno */
#define pr_debug_errno(message) pr_debug("%s: %s", message, strerror(errno))
/** Logs a simple debug2 message adding the error found in \e errno */
#define pr_debug2_errno(message) pr_debug2("%s: %s", message, strerror(errno))

/** Logs a formatted fatal error message and aborts the program */
#define exit_fatal(args...) do { pr_fatal(args); abort(); } while(0)
/** Logs a simple fatal error message after a bug was found and aborts the program */
#define exit_bug(message) exit_fatal("BUG: %s", message)
/** Logs a formatted error message and exits with an error status */
#define exit_error(args...) do { pr_error(args); exit(1); } while(0)
/** Logs a simple error message adding the error found in \e errno and exits with an error status */
#define exit_errno(message) exit_error("%s: %s", message, strerror(errno))