Imported Upstream version 0.3.5
[debian/uanytun.git] / src / log.h
1 /*
2  *  uAnytun
3  *
4  *  uAnytun is a tiny implementation of SATP. Unlike Anytun which is a full
5  *  featured implementation uAnytun has no support for multiple connections
6  *  or synchronisation. It is a small single threaded implementation intended
7  *  to act as a client on small platforms.
8  *  The secure anycast tunneling protocol (satp) defines a protocol used
9  *  for communication between any combination of unicast and anycast
10  *  tunnel endpoints.  It has less protocol overhead than IPSec in Tunnel
11  *  mode and allows tunneling of every ETHER TYPE protocol (e.g.
12  *  ethernet, ip, arp ...). satp directly includes cryptography and
13  *  message authentication based on the methods used by SRTP.  It is
14  *  intended to deliver a generic, scaleable and secure solution for
15  *  tunneling and relaying of packets of any protocol.
16  *
17  *
18  *  Copyright (C) 2007-2014 Christian Pointner <equinox@anytun.org>
19  *
20  *  This file is part of uAnytun.
21  *
22  *  uAnytun is free software: you can redistribute it and/or modify
23  *  it under the terms of the GNU General Public License as published by
24  *  the Free Software Foundation, either version 3 of the License, or
25  *  any later version.
26  *
27  *  uAnytun is distributed in the hope that it will be useful,
28  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
29  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30  *  GNU General Public License for more details.
31  *
32  *  You should have received a copy of the GNU General Public License
33  *  along with uAnytun. If not, see <http://www.gnu.org/licenses/>.
34  *
35  *  In addition, as a special exception, the copyright holders give
36  *  permission to link the code of portions of this program with the
37  *  OpenSSL library under certain conditions as described in each
38  *  individual source file, and distribute linked combinations
39  *  including the two.
40  *  You must obey the GNU General Public License in all respects
41  *  for all of the code used other than OpenSSL.  If you modify
42  *  file(s) with this exception, you may extend this exception to your
43  *  version of the file(s), but you are not obligated to do so.  If you
44  *  do not wish to do so, delete this exception statement from your
45  *  version.  If you delete this exception statement from all source
46  *  files in the program, then also delete it here.
47  */
48
49 #ifndef UANYTUN_log_h_INCLUDED
50 #define UANYTUN_log_h_INCLUDED
51
52 #define MSG_LENGTH_MAX 150
53
54 enum log_prio_enum { ERROR = 1, WARNING = 2, NOTICE = 3,
55                      INFO = 4, DEBUG = 5 };
56 typedef enum log_prio_enum log_prio_t;
57
58 const char* log_prio_to_string(log_prio_t prio);
59
60 enum log_target_type_enum { TARGET_SYSLOG , TARGET_STDOUT, TARGET_STDERR, TARGET_FILE , TARGET_UNKNOWN };
61 typedef enum log_target_type_enum log_target_type_t;
62
63 struct log_target_struct {
64   log_target_type_t type_;
65   int (*init)(struct log_target_struct* self, const char* conf);
66   void (*open)(struct log_target_struct* self);
67   void (*log)(struct log_target_struct* self, log_prio_t prio, const char* msg);
68   void (*close)(struct log_target_struct* self);
69   void (*clear)(struct log_target_struct* self);
70   int opened_;
71   int enabled_;
72   log_prio_t max_prio_;
73   void* param_;
74   struct log_target_struct* next_;
75 };
76 typedef struct log_target_struct log_target_t;
77
78
79 struct log_targets_struct {
80   log_target_t* first_;
81 };
82 typedef struct log_targets_struct log_targets_t;
83
84 int log_targets_target_exists(log_targets_t* targets, log_target_type_t type);
85 int log_targets_add(log_targets_t* targets, const char* conf);
86 void log_targets_log(log_targets_t* targets, log_prio_t prio, const char* msg);
87 void log_targets_clear(log_targets_t* targets);
88
89
90 struct log_struct {
91   log_prio_t max_prio_;
92   log_targets_t targets_;
93 };
94 typedef struct log_struct log_t;
95
96 void log_init();
97 void log_close();
98 void update_max_prio();
99 int log_add_target(const char* conf);
100 void log_printf(log_prio_t prio, const char* fmt, ...);
101 void log_print_hex_dump(log_prio_t prio, const u_int8_t* buf, u_int32_t len);
102
103 #endif