ac67b11c3e250fe51b632ebf57d16d30bb3e661f
[sip-router] / cfg_core.c
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2007 iptelorg GmbH
5  *
6  * This file is part of SIP-router, a free SIP server.
7  *
8  * SIP-router is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * SIP-router is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  * History
23  * -------
24  *  2007-12-03  Initial version (Miklos)
25  *  2008-01-31  added DNS resolver parameters (Miklos)
26  */
27 /** core runtime config.
28  * @file cfg_core.c
29  * @ingroup core
30  * Module: @ref core
31  *
32  * See
33  * - @ref ConfigCoreDoc
34  * - @ref ConfigEngine
35  * - @ref cfg_core.h
36  */
37 /*!
38  * \page ConfigCoreDoc Documentation of configuration parser
39  * \section ConfigParser Configuration parser
40  * Further information
41  * - \ref ConfigEngine
42  * - \ref cfg_core.h
43  * \verbinclude cfg.txt
44  *
45  */
46
47 #include "dprint.h"
48 #ifdef USE_DST_BLACKLIST
49 #include "dst_blacklist.h"
50 #endif
51 #include "resolve.h"
52 #ifdef USE_DNS_CACHE
53 #include "dns_cache.h"
54 #endif
55 #if defined PKG_MALLOC || defined SHM_MEM
56 #include "pt.h"
57 #endif
58 #include "msg_translator.h" /* fix_global_req_flags() */
59 #include "globals.h"
60 #include "sock_ut.h"
61 #include "cfg/cfg.h"
62 #include "cfg_core.h"
63
64 struct cfg_group_core default_core_cfg = {
65         L_WARN,         /*!<  print only msg. < L_WARN */
66         LOG_DAEMON,     /*!< log_facility -- see syslog(3) */
67         L_DBG,  /*!< memdbg */
68 #ifdef USE_DST_BLACKLIST
69         /* blacklist */
70         0, /*!< dst blacklist is disabled by default */
71         DEFAULT_BLST_TIMEOUT,
72         DEFAULT_BLST_MAX_MEM,
73         0, /* blst_udp_imask */
74         0, /* blst_tcp_imask */
75         0, /* blst_tls_imask */
76         0, /* blst_sctp_imask */
77 #endif
78         /* resolver */
79         1,  /*!< dns_try_ipv6 -- on by default */
80         0,  /*!< dns_try_naptr -- off by default */
81         30,  /*!< udp transport preference (for naptr) */
82         20,  /*!< tcp transport preference (for naptr) */
83         10,  /*!< tls transport preference (for naptr) */
84         20,  /*!< sctp transport preference (for naptr) */
85         -1, /*!< dns_retr_time */
86         -1, /*!< dns_retr_no */
87         -1, /*!< dns_servers_no */
88         1,  /*!< dns_search_list */
89         1,  /*!< dns_search_fmatch */
90         0,  /*!< dns_reinit */
91         /* DNS cache */
92 #ifdef USE_DNS_CACHE
93         1,  /*!< use_dns_cache -- on by default */
94         0,  /*!< dns_cache_flags */
95         0,  /*!< use_dns_failover -- off by default */
96         0,  /*!< dns_srv_lb -- off by default */
97         DEFAULT_DNS_NEG_CACHE_TTL, /*!< neg. cache ttl */
98         DEFAULT_DNS_CACHE_MIN_TTL, /*!< minimum ttl */
99         DEFAULT_DNS_CACHE_MAX_TTL, /*!< maximum ttl */
100         DEFAULT_DNS_MAX_MEM, /*!< dns_cache_max_mem */
101         0, /*!< dns_cache_del_nonexp -- delete only expired entries by default */
102         0, /*!< dns_cache_rec_pref -- 0 by default, do not check the existing entries. */
103 #endif
104 #ifdef PKG_MALLOC
105         0, /*!< mem_dump_pkg */
106 #endif
107 #ifdef SHM_MEM
108         0, /*!< mem_dump_shm */
109 #endif
110         DEFAULT_MAX_WHILE_LOOPS, /*!< max_while_loops */
111         0, /*!< udp_mtu (disabled by default) */
112         0, /*!< udp_mtu_try_proto -> default disabled */
113         0, /**< udp4_raw (disabled by default) */
114         1500, /**< udp4_raw_mtu (1500 by default) */
115         -1,  /**< udp4_raw_ttl (auto detect by default) */
116         0,  /*!< force_rport */
117         L_DBG, /*!< memlog */
118         3, /*!< mem_summary -flags: 0 off, 1 pkg_status, 2 shm_status,
119                 4 pkg_sums, 8 shm_sums, 16 short_status */
120         0, /*!< mem_safety - 0 disabled */
121         0, /*!< mem_join - 0 disabled */
122         L_ERR, /*!< corelog */
123         L_ERR, /*!< latency log */
124         0, /*!< latency limit db */
125         0 /*!< latency limit action */
126 };
127
128 void    *core_cfg = &default_core_cfg;
129
130
131 static int check_raw_sock_support(void* cfg_h, str* gname, str* name,
132                                                                         void** v)
133 {
134         int val;
135         
136         val = (int)(long)(*v);
137 #ifndef USE_RAW_SOCKS
138         if (val > 0) {
139                 ERR("no RAW_SOCKS support, please recompile with it enabled\n");
140                 return -1;
141         }
142         return 0;
143 #else /* USE_RAW_SOCKS */
144         if (raw_udp4_send_sock < 0) {
145                 if (val > 0) {
146                         ERR("could not intialize raw socket on startup, please "
147                                         "restart as root or with CAP_NET_RAW\n");
148                         return -1;
149                 } else if (val < 0) {
150                         /* auto and no socket => disable */
151                         *v = (void*)(long)0;
152                 }
153         } else if (val < 0) {
154                 /* auto and socket => enable */
155                 *v = (void*)(long)1;
156         }
157         return 0;
158 #endif /* USE_RAW_SOCKS */
159 }
160
161
162
163 static int  udp4_raw_ttl_fixup(void* cfg_h, str* gname, str* name, void** val)
164 {
165         int v;
166         v = (int)(long)(*val);
167         if (v < 0) {
168                 if (sendipv4)
169                         v = sock_get_ttl(sendipv4->socket);
170         }
171         if (v < 0) {
172                 /* some error => use a reasonable default */
173                 v = 63;
174         }
175         *val = (void*)(long)v;
176         return 0;
177 }
178
179
180
181 cfg_def_t core_cfg_def[] = {
182         {"debug",               CFG_VAR_INT|CFG_ATOMIC, 0, 0, 0, 0,
183                 "debug level"},
184         {"log_facility",        CFG_VAR_INT|CFG_INPUT_STRING,   0, 0, log_facility_fixup, 0,
185                 "syslog facility, see \"man 3 syslog\""},
186         {"memdbg",              CFG_VAR_INT|CFG_ATOMIC, 0, 0, 0, 0,
187                 "log level for memory debugging messages"},
188 #ifdef USE_DST_BLACKLIST
189         /* blacklist */
190         {"use_dst_blacklist",   CFG_VAR_INT,    0, 1, use_dst_blacklist_fixup, 0,
191                 "enable/disable destination blacklisting"},
192         {"dst_blacklist_expire",        CFG_VAR_INT,    0, 0, 0, 0,
193                 "how much time (in s) a blacklisted destination is kept in the list"},
194         {"dst_blacklist_mem",   CFG_VAR_INT,    0, 0, blst_max_mem_fixup, 0,
195                 "maximum shared memory amount (in KB) used for keeping the blacklisted"
196                         " destinations"},
197         {"dst_blacklist_udp_imask", CFG_VAR_INT, 0, 0, 0, blst_reinit_ign_masks,
198                 "blacklist event ignore mask for UDP"},
199         {"dst_blacklist_tcp_imask", CFG_VAR_INT, 0, 0, 0, blst_reinit_ign_masks,
200                 "blacklist event ignore mask for TCP"},
201         {"dst_blacklist_tls_imask", CFG_VAR_INT, 0, 0, 0, blst_reinit_ign_masks,
202                 "blacklist event ignore mask for TLS"},
203         {"dst_blacklist_sctp_imask", CFG_VAR_INT, 0, 0, 0, blst_reinit_ign_masks,
204                 "blacklist event ignore mask for SCTP"},
205 #endif
206         /* resolver */
207 #ifdef USE_DNS_CACHE
208         {"dns_try_ipv6",        CFG_VAR_INT,    0, 1, dns_try_ipv6_fixup, fix_dns_flags,
209 #else
210         {"dns_try_ipv6",        CFG_VAR_INT,    0, 1, dns_try_ipv6_fixup, 0,
211 #endif
212                 "enable/disable IPv6 DNS lookups"},
213 #ifdef USE_DNS_CACHE
214         {"dns_try_naptr",       CFG_VAR_INT,    0, 1, 0, fix_dns_flags,
215 #else
216         {"dns_try_naptr",       CFG_VAR_INT,    0, 1, 0, 0,
217 #endif
218                 "enable/disable NAPTR DNS lookups"},
219         {"dns_udp_pref",        CFG_VAR_INT,    0, 0, 0, reinit_naptr_proto_prefs,
220                 "udp protocol preference when doing NAPTR lookups"},
221         {"dns_tcp_pref",        CFG_VAR_INT,    0, 0, 0, reinit_naptr_proto_prefs,
222                 "tcp protocol preference when doing NAPTR lookups"},
223         {"dns_tls_pref",        CFG_VAR_INT,    0, 0, 0, reinit_naptr_proto_prefs,
224                 "tls protocol preference when doing NAPTR lookups"},
225         {"dns_sctp_pref",       CFG_VAR_INT,    0, 0, 0, reinit_naptr_proto_prefs,
226                 "sctp protocol preference when doing NAPTR lookups"},
227         {"dns_retr_time",       CFG_VAR_INT,    0, 0, 0, resolv_reinit,
228                 "time in s before retrying a dns request"},
229         {"dns_retr_no",         CFG_VAR_INT,    0, 0, 0, resolv_reinit,
230                 "number of dns retransmissions before giving up"},
231         {"dns_servers_no",      CFG_VAR_INT,    0, 0, 0, resolv_reinit,
232                 "how many dns servers from the ones defined in "
233                 "/etc/resolv.conf will be used"},
234         {"dns_use_search_list", CFG_VAR_INT,    0, 1, 0, resolv_reinit,
235                 "if set to 0, the search list in /etc/resolv.conf is ignored"},
236         {"dns_search_full_match",       CFG_VAR_INT,    0, 1, 0, 0,
237                 "enable/disable domain name checks against the search list "
238                 "in DNS answers"},
239         {"dns_reinit",          CFG_VAR_INT|CFG_INPUT_INT,      1, 1, dns_reinit_fixup,
240                 resolv_reinit,
241                 "set to 1 in order to reinitialize the DNS resolver"},
242         /* DNS cache */
243 #ifdef USE_DNS_CACHE
244         {"use_dns_cache",       CFG_VAR_INT,    0, 1, use_dns_cache_fixup, 0,
245                 "enable/disable the dns cache"},
246         {"dns_cache_flags",     CFG_VAR_INT,    0, 4, 0, fix_dns_flags,
247                 "dns cache specific resolver flags "
248                 "(1=ipv4 only, 2=ipv6 only, 4=prefer ipv6"},
249         {"use_dns_failover",    CFG_VAR_INT,    0, 1, use_dns_failover_fixup, 0,
250                 "enable/disable dns failover in case the destination "
251                 "resolves to multiple ip addresses and/or multiple SRV records "
252                 "(depends on use_dns_cache)"},
253         {"dns_srv_lb",          CFG_VAR_INT,    0, 1, 0, fix_dns_flags,
254                 "enable/disable load balancing to different srv records "
255                 "of the same priority based on the srv records weights "
256                 "(depends on dns_failover)"},
257         {"dns_cache_negative_ttl",      CFG_VAR_INT,    0, 0, 0, 0,
258                 "time to live for negative results (\"not found\") "
259                 "in seconds. Use 0 to disable"},
260         {"dns_cache_min_ttl",   CFG_VAR_INT,    0, 0, 0, 0,
261                 "minimum accepted time to live for a record, in seconds"},
262         {"dns_cache_max_ttl",   CFG_VAR_INT,    0, 0, 0, 0,
263                 "maximum accepted time to live for a record, in seconds"},
264         {"dns_cache_mem",       CFG_VAR_INT,    0, 0, dns_cache_max_mem_fixup, 0,
265                 "maximum memory used for the dns cache in Kb"},
266         {"dns_cache_del_nonexp",        CFG_VAR_INT,    0, 1, 0, 0,
267                 "allow deletion of non-expired records from the cache when "
268                 "there is no more space left for new ones"},
269         {"dns_cache_rec_pref",  CFG_VAR_INT,    0, 3, 0, 0,
270                 "DNS cache record preference: "
271                 " 0 - do not check duplicates"
272                 " 1 - prefer old records"
273                 " 2 - prefer new records"
274                 " 3 - prefer records with longer lifetime"},
275 #endif
276 #ifdef PKG_MALLOC
277         {"mem_dump_pkg",        CFG_VAR_INT,    0, 0, 0, mem_dump_pkg_cb,
278                 "dump process memory status, parameter: pid_number"},
279 #endif
280 #ifdef SHM_MEM
281         {"mem_dump_shm",        CFG_VAR_INT,    0, 0, mem_dump_shm_fixup, 0,
282                 "dump shared memory status"},
283 #endif
284         {"max_while_loops",     CFG_VAR_INT|CFG_ATOMIC, 0, 0, 0, 0,
285                 "maximum iterations allowed for a while loop" },
286         {"udp_mtu",     CFG_VAR_INT|CFG_ATOMIC, 0, 65535, 0, 0,
287                 "fallback to a congestion controlled protocol if send size"
288                         " exceeds udp_mtu"},
289         {"udp_mtu_try_proto", CFG_VAR_INT, 1, 4, 0, fix_global_req_flags,
290                 "if send size > udp_mtu use proto (1 udp, 2 tcp, 3 tls, 4 sctp)"},
291         {"udp4_raw", CFG_VAR_INT | CFG_ATOMIC, -1, 1, check_raw_sock_support, 0,
292                 "enable/disable using a raw socket for sending UDP IPV4 packets."
293                 " Should be  faster on multi-CPU linux running machines."},
294         {"udp4_raw_mtu", CFG_VAR_INT | CFG_ATOMIC, 28, 65535, 0, 0,
295                 "set the MTU used when using raw sockets for udp sending."
296                 " This  value will be used when deciding whether or not to fragment"
297                 " the packets."},
298         {"udp4_raw_ttl", CFG_VAR_INT | CFG_ATOMIC, -1, 255, udp4_raw_ttl_fixup, 0,
299                 "set the IP TTL used when using raw sockets for udp sending."
300                 " -1 will use the same value as for normal udp sockets."},
301         {"force_rport",     CFG_VAR_INT, 0, 1,  0, fix_global_req_flags,
302                 "force rport for all the received messages" },
303         {"memlog",              CFG_VAR_INT|CFG_ATOMIC, 0, 0, 0, 0,
304                 "log level for memory status/summary information"},
305         {"mem_summary", CFG_VAR_INT|CFG_ATOMIC, 0, 31, 0, 0,
306                 "memory debugging information displayed on exit (flags): "
307                 " 0 - off,"
308                 " 1 - dump all the pkg used blocks (status),"
309                 " 2 - dump all the shm used blocks (status),"
310                 " 4 - summary of pkg used blocks,"
311                 " 8 - summary of shm used blocks,"
312                 " 16 - short status instead of dump" },
313         {"mem_safety",          CFG_VAR_INT|CFG_ATOMIC, 0, 0, 0, 0,
314                 "safety level for memory operations"},
315         {"mem_join",            CFG_VAR_INT|CFG_ATOMIC, 0, 0, 0, 0,
316                 "join free memory fragments"},
317         {"corelog",             CFG_VAR_INT|CFG_ATOMIC, 0, 0, 0, 0,
318                 "log level for non-critical core error messages"},
319         {"latency_log",         CFG_VAR_INT|CFG_ATOMIC, 0, 0, 0, 0,
320                 "log level for latency limits alert messages"},
321         {"latency_limit_db",            CFG_VAR_INT|CFG_ATOMIC, 0, 0, 0, 0,
322                 "limit is ms for alerting on time consuming db commands"},
323         {"latency_limit_action",                CFG_VAR_INT|CFG_ATOMIC, 0, 0, 0, 0,
324                 "limit is ms for alerting on time consuming config actions"},
325         {0, 0, 0, 0, 0, 0}
326 };