core: added mem_summary config option
[sip-router] / cfg_core.c
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2007 iptelorg GmbH
5  *
6  * This file is part of ser, a free SIP server.
7  *
8  * ser 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  * For a license to use the ser software under conditions
14  * other than those described here, or to purchase support for this
15  * software, please contact iptel.org by e-mail at the following addresses:
16  *    info@iptel.org
17  *
18  * ser is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26  *
27  * History
28  * -------
29  *  2007-12-03  Initial version (Miklos)
30  *  2008-01-31  added DNS resolver parameters (Miklos)
31  */
32
33 #include "dprint.h"
34 #ifdef USE_DST_BLACKLIST
35 #include "dst_blacklist.h"
36 #endif
37 #include "resolve.h"
38 #ifdef USE_DNS_CACHE
39 #include "dns_cache.h"
40 #endif
41 #if defined PKG_MALLOC || defined SHM_MEM
42 #include "pt.h"
43 #endif
44 #include "msg_translator.h" /* fix_global_req_flags() */
45 #include "cfg/cfg.h"
46 #include "cfg_core.h"
47
48 struct cfg_group_core default_core_cfg = {
49         L_WARN,         /*  print only msg. < L_WARN */
50         LOG_DAEMON,     /* log_facility -- see syslog(3) */
51 #ifdef USE_DST_BLACKLIST
52         /* blacklist */
53         0, /* dst blacklist is disabled by default */
54         DEFAULT_BLST_TIMEOUT,
55         DEFAULT_BLST_MAX_MEM,
56 #endif
57         /* resolver */
58 #ifdef USE_IPV6
59         1,  /* dns_try_ipv6 -- on by default */
60 #else
61         0,  /* dns_try_ipv6 -- off, if no ipv6 support */
62 #endif
63         0,  /* dns_try_naptr -- off by default */
64         30,  /* udp transport preference (for naptr) */
65         20,  /* tcp transport preference (for naptr) */
66         10,  /* tls transport preference (for naptr) */
67         20,  /* sctp transport preference (for naptr) */
68         -1, /* dns_retr_time */
69         -1, /* dns_retr_no */
70         -1, /* dns_servers_no */
71         1,  /* dns_search_list */
72         1,  /* dns_search_fmatch */
73         0,  /* dns_reinit */
74         /* DNS cache */
75 #ifdef USE_DNS_CACHE
76         1,  /* use_dns_cache -- on by default */
77         0,  /* dns_cache_flags */
78         0,  /* use_dns_failover -- off by default */
79         0,  /* dns_srv_lb -- off by default */
80         DEFAULT_DNS_NEG_CACHE_TTL, /* neg. cache ttl */
81         DEFAULT_DNS_CACHE_MIN_TTL, /* minimum ttl */
82         DEFAULT_DNS_CACHE_MAX_TTL, /* maximum ttl */
83         DEFAULT_DNS_MAX_MEM, /* dns_cache_max_mem */
84         0, /* dns_cache_del_nonexp -- delete only expired entries by default */
85 #endif
86 #ifdef PKG_MALLOC
87         0, /* mem_dump_pkg */
88 #endif
89 #ifdef SHM_MEM
90         0, /* mem_dump_shm */
91 #endif
92         DEFAULT_MAX_WHILE_LOOPS, /* max_while_loops */
93         0, /* udp_mtu (disabled by default) */
94         0, /* udp_mtu_try_proto -> default disabled */
95         0,  /* force_rport */
96         1 /* mem_summary -flags: 0 off, 1 shm/pkg_status, 2 shm/pkg_sums */
97 };
98
99 void    *core_cfg = &default_core_cfg;
100
101 cfg_def_t core_cfg_def[] = {
102         {"debug",               CFG_VAR_INT|CFG_ATOMIC, 0, 0, 0, 0,
103                 "debug level"},
104         {"log_facility",        CFG_VAR_INT|CFG_INPUT_STRING,   0, 0, log_facility_fixup, 0,
105                 "syslog facility, see \"man 3 syslog\""},
106 #ifdef USE_DST_BLACKLIST
107         /* blacklist */
108         {"use_dst_blacklist",   CFG_VAR_INT,    0, 1, use_dst_blacklist_fixup, 0,
109                 "enable/disable destination blacklisting"},
110         {"dst_blacklist_expire",        CFG_VAR_INT,    0, 0, 0, 0,
111                 "how much time (in s) a blacklisted destination is kept in the list"},
112         {"dst_blacklist_mem",   CFG_VAR_INT,    0, 0, blst_max_mem_fixup, 0,
113                 "maximum shared memory amount (in KB) used for keeping the blacklisted destinations"},
114 #endif
115         /* resolver */
116 #ifdef USE_DNS_CACHE
117         {"dns_try_ipv6",        CFG_VAR_INT,    0, 1, dns_try_ipv6_fixup, fix_dns_flags,
118 #else
119         {"dns_try_ipv6",        CFG_VAR_INT,    0, 1, dns_try_ipv6_fixup, 0,
120 #endif
121                 "enable/disable IPv6 DNS lookups"},
122 #ifdef USE_DNS_CACHE
123         {"dns_try_naptr",       CFG_VAR_INT,    0, 1, 0, fix_dns_flags,
124 #else
125         {"dns_try_naptr",       CFG_VAR_INT,    0, 1, 0, 0,
126 #endif
127                 "enable/disable NAPTR DNS lookups"},
128         {"dns_udp_pref",        CFG_VAR_INT,    0, 0, 0, reinit_naptr_proto_prefs,
129                 "udp protocol preference when doing NAPTR lookups"},
130         {"dns_tcp_pref",        CFG_VAR_INT,    0, 0, 0, reinit_naptr_proto_prefs,
131                 "tcp protocol preference when doing NAPTR lookups"},
132         {"dns_tls_pref",        CFG_VAR_INT,    0, 0, 0, reinit_naptr_proto_prefs,
133                 "tls protocol preference when doing NAPTR lookups"},
134         {"dns_sctp_pref",       CFG_VAR_INT,    0, 0, 0, reinit_naptr_proto_prefs,
135                 "sctp protocol preference when doing NAPTR lookups"},
136         {"dns_retr_time",       CFG_VAR_INT,    0, 0, 0, resolv_reinit,
137                 "time in s before retrying a dns request"},
138         {"dns_retr_no",         CFG_VAR_INT,    0, 0, 0, resolv_reinit,
139                 "number of dns retransmissions before giving up"},
140         {"dns_servers_no",      CFG_VAR_INT,    0, 0, 0, resolv_reinit,
141                 "how many dns servers from the ones defined in "
142                 "/etc/resolv.conf will be used"},
143         {"dns_use_search_list", CFG_VAR_INT,    0, 1, 0, resolv_reinit,
144                 "if set to 0, the search list in /etc/resolv.conf is ignored"},
145         {"dns_search_full_match",       CFG_VAR_INT,    0, 1, 0, 0,
146                 "enable/disable domain name checks against the search list "
147                 "in DNS answers"},
148         {"dns_reinit",          CFG_VAR_INT|CFG_INPUT_INT,      1, 1, dns_reinit_fixup, resolv_reinit,
149                 "set to 1 in order to reinitialize the DNS resolver"},
150         /* DNS cache */
151 #ifdef USE_DNS_CACHE
152         {"use_dns_cache",       CFG_VAR_INT,    0, 1, use_dns_cache_fixup, 0,
153                 "enable/disable the dns cache"},
154         {"dns_cache_flags",     CFG_VAR_INT,    0, 4, 0, fix_dns_flags,
155                 "dns cache specific resolver flags "
156                 "(1=ipv4 only, 2=ipv6 only, 4=prefer ipv6"},
157         {"use_dns_failover",    CFG_VAR_INT,    0, 1, use_dns_failover_fixup, 0,
158                 "enable/disable dns failover in case the destination "
159                 "resolves to multiple ip addresses and/or multiple SRV records "
160                 "(depends on use_dns_cache)"},
161         {"dns_srv_lb",          CFG_VAR_INT,    0, 1, 0, fix_dns_flags,
162                 "enable/disable load balancing to different srv records "
163                 "of the same priority based on the srv records weights "
164                 "(depends on dns_failover)"},
165         {"dns_cache_negative_ttl",      CFG_VAR_INT,    0, 0, 0, 0,
166                 "time to live for negative results (\"not found\") "
167                 "in seconds. Use 0 to disable"},
168         {"dns_cache_min_ttl",   CFG_VAR_INT,    0, 0, 0, 0,
169                 "minimum accepted time to live for a record, in seconds"},
170         {"dns_cache_max_ttl",   CFG_VAR_INT,    0, 0, 0, 0,
171                 "maximum accepted time to live for a record, in seconds"},
172         {"dns_cache_mem",       CFG_VAR_INT,    0, 0, dns_cache_max_mem_fixup, 0,
173                 "maximum memory used for the dns cache in Kb"},
174         {"dns_cache_del_nonexp",        CFG_VAR_INT,    0, 1, 0, 0,
175                 "allow deletion of non-expired records from the cache when "
176                 "there is no more space left for new ones"},
177 #endif
178 #ifdef PKG_MALLOC
179         {"mem_dump_pkg",        CFG_VAR_INT,    0, 0, 0, mem_dump_pkg_cb,
180                 "dump process memory status, parameter: pid_number"},
181 #endif
182 #ifdef SHM_MEM
183         {"mem_dump_shm",        CFG_VAR_INT,    0, 0, mem_dump_shm_fixup, 0,
184                 "dump shared memory status"},
185 #endif
186         {"max_while_loops",     CFG_VAR_INT|CFG_ATOMIC, 0, 0, 0, 0,
187                 "maximum iterations allowed for a while loop" },
188         {"udp_mtu",     CFG_VAR_INT|CFG_ATOMIC, 0, 65535, 0, 0,
189                 "fallback to a congestion controlled protocol if send size"
190                         " exceeds udp_mtu"},
191         {"udp_mtu_try_proto", CFG_VAR_INT, 1, 4, 0, fix_global_req_flags,
192                 "if send size > udp_mtu use proto (1 udp, 2 tcp, 3 tls, 4 sctp)"},
193         {"force_rport",     CFG_VAR_INT, 0, 1,  0, fix_global_req_flags,
194                 "force rport for all the received messages" },
195         {"mem_summary", CFG_VAR_INT|CFG_ATOMIC, 0, 3, 0, 0,
196                 "memory debugging information displayed on exit (flags): "
197                 " 0 - off, 1 - dump all used blocks, 2 - summary of used blocks" },
198         {0, 0, 0, 0, 0, 0}
199 };