@cfg_get.<group_name>.<var_name> is documented
[sip-router] / dns_cache.h
1 /*
2  * $Id$
3  *
4  * resolver/dns related functions, dns cache and failover
5  *
6  * Copyright (C) 2006 iptelorg GmbH
7  *
8  * This file is part of ser, a free SIP server.
9  *
10  * ser is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version
14  *
15  * For a license to use the ser software under conditions
16  * other than those described here, or to purchase support for this
17  * software, please contact iptel.org by e-mail at the following addresses:
18  *    info@iptel.org
19  *
20  * ser is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28  */
29 /* History:
30  * --------
31  *  2006-07-13  created by andrei
32  *  2007-06-16  naptr support (andrei)
33  *  2007-07-30  DNS cache measurements added (Gergo)
34  */
35
36
37 #ifndef __dns_cache_h
38 #define __dns_cache_h
39
40 #include "str.h"
41 #include "config.h" /* MAX_BRANCHES */
42 #include "timer.h"
43 #include "ip_addr.h"
44 #include "atomic_ops.h"
45 #include "resolve.h"
46
47
48 #if defined(USE_DNS_FAILOVER) && !defined(USE_DNS_CACHE)
49 #error "DNS FAILOVER requires DNS CACHE support (define USE_DNS_CACHE)"
50 #endif
51
52 #if defined(DNS_WATCHDOG_SUPPORT) && !defined(USE_DNS_CACHE)
53 #error "DNS WATCHDOG requires DNS CACHE support (define USE_DNS_CACHE)"
54 #endif
55
56 /* uncomment the define below for SRV weight based load balancing */
57 #define DNS_SRV_LB
58
59 #define DNS_LU_LST
60
61 /* dns functions return them as negative values (e.g. return -E_DNS_NO_IP)
62  * listed in the order of importance ( if more errors, only the most important
63  * is returned)
64  */
65 enum dns_errors{
66                                         E_DNS_OK=0,
67                                         E_DNS_EOR, /* no more records (not an error)
68                                                       -- returned only by the dns_resolve*
69                                                                   functions when called iteratively,; it
70                                                                   signals the end of the ip/records list */
71                                         E_DNS_UNKNOWN /* unkown error */,
72                                         E_DNS_INTERNAL_ERR /* internal error */,
73                                         E_DNS_BAD_SRV_ENTRY,
74                                         E_DNS_NO_SRV /* unresolvable srv record */,
75                                         E_DNS_BAD_IP_ENTRY,
76                                         E_DNS_NO_IP /* unresolvable a or aaaa records*/,
77                                         E_DNS_BAD_IP /* the ip is invalid */,
78                                         E_DNS_BLACKLIST_IP /* the ip is blacklisted */,
79                                         E_DNS_NAME_TOO_LONG /* try again with a shorter name */,
80                                         E_DNS_AF_MISMATCH /* ipv4 or ipv6 only requested, but
81                                                                                  name contains an ip addr. of the
82                                                                                  opossite type */ ,
83                                         E_DNS_NO_NAPTR /* unresolvable naptr record */,
84                                         E_DNS_CRITICAL /* critical error, marks the end
85                                                                           of the error table (always last) */
86 };
87
88
89
90 /* return a short string, printable error description (err <=0) */
91 const char* dns_strerror(int err);
92
93 /* dns entry error flags */
94 #define DNS_BAD_NAME     1 /* unresolvable */
95
96 /* dns requests flags */
97 #define DNS_NO_FLAGS    0
98 #define DNS_IPV4_ONLY   1
99 #define DNS_IPV6_ONLY   2
100 #define DNS_IPV6_FIRST  4
101 #define DNS_SRV_RR_LB   8  /* SRV RR weight based load balancing */
102 #define DNS_TRY_NAPTR   16 /* enable naptr lookup */
103
104
105 /* ip blacklist error flags */
106 #define IP_ERR_BAD_DST      2 /* destination is marked as bad (e.g. bad ip) */
107 #define IP_ERR_SND          3 /* send error while using this as destination */
108 #define IP_ERR_TIMEOUT      4 /* timeout waiting for a response */
109 #define IP_ERR_TCP_CON      5 /* could not establish tcp connection */
110
111
112 /* stripped down dns rr */
113 struct dns_rr{
114         struct dns_rr* next;
115         void* rdata; /* depends on the type */
116         /* name, type and class are not needed, contained in struct dns_query */
117         ticks_t expire; /* = ttl + crt_time */
118         unsigned char err_flags; /* if 0 everything is ok */
119
120 };
121
122
123
124 #ifdef DNS_LU_LST
125 struct dns_lu_lst{  /* last used ordered list */
126         struct dns_lu_lst* next;
127         struct dns_lu_lst* prev;
128 };
129 #endif
130
131 struct dns_hash_entry{
132         /* hash table links */
133         struct dns_hash_entry* next;
134         struct dns_hash_entry* prev;
135 #ifdef DNS_LU_LST
136         struct dns_lu_lst last_used_lst;
137 #endif
138         struct dns_rr* rr_lst;
139         atomic_t refcnt;
140         ticks_t last_used;
141         ticks_t expire; /* when the whole entry will expire */
142         int total_size;
143         unsigned short type;
144         unsigned char err_flags;
145         unsigned char name_len; /* can be maximum 255 bytes */
146         char name[1]; /* variable length, name, null terminated
147                          (actual lenght = name_len +1)*/
148 };
149
150
151 #if MAX_BRANCHES < 16
152 /* forking is limited by tm to 12 by default */
153 typedef unsigned short srv_flags_t;
154 #elif MAX_BRANCHES < 32
155 typedef unsigned int srv_flags_t;
156 #else
157 typedef unsigned long long srv_flags_t;
158 #endif
159
160 struct dns_srv_handle{
161         struct dns_hash_entry* srv; /* srv entry */
162         struct dns_hash_entry* a;   /* a or aaaa current entry */
163 #ifdef DNS_SRV_LB
164         srv_flags_t srv_tried_rrs;
165 #endif
166         unsigned short port; /* current port */
167         unsigned char srv_no; /* current record no. in the srv entry */
168         unsigned char ip_no;  /* current record no. in the a/aaaa entry */
169         unsigned char proto;  /* protocol number */
170 };
171
172
173
174 const char* dns_strerror(int err);
175
176 int init_dns_cache();
177 #ifdef USE_DNS_CACHE_STATS
178 int init_dns_cache_stats(int iproc_num);
179 #define DNS_CACHE_ALL_STATS "dc_all_stats"
180 #endif
181 void destroy_dns_cache();
182
183
184 void dns_hash_put(struct dns_hash_entry* e);
185 void dns_hash_put_shm_unsafe(struct dns_hash_entry* e);
186
187 inline static void dns_srv_handle_put(struct dns_srv_handle* h)
188 {
189         if (h){
190                 if (h->srv){
191                         dns_hash_put(h->srv);
192                         h->srv=0;
193                 }
194                 if (h->a){
195                         dns_hash_put(h->a);
196                         h->a=0;
197                 }
198         }
199 }
200
201
202
203 /* use it when copying, it manually increases the ref cound */
204 inline static void dns_srv_handle_ref(struct dns_srv_handle *h)
205 {
206         if (h){
207                 if (h->srv)
208                         atomic_inc(&h->srv->refcnt);
209                 if (h->a)
210                         atomic_inc(&h->a->refcnt);
211         }
212 }
213
214
215
216 /* safe copy increases the refcnt, src must not change while in this function
217  * WARNING: the copy must be dns_srv_handle_put ! */
218 inline static void dns_srv_handle_cpy(struct dns_srv_handle* dst,
219                                                                                 struct dns_srv_handle* src)
220 {
221         dns_srv_handle_ref(src);
222         *dst=*src;
223 }
224
225
226
227 /* same as above but assume shm_lock held (for internal tm use only) */
228 inline static void dns_srv_handle_put_shm_unsafe(struct dns_srv_handle* h)
229 {
230         if (h){
231                 if (h->srv){
232                         dns_hash_put_shm_unsafe(h->srv);
233                         h->srv=0;
234                 }
235                 if (h->a){
236                         dns_hash_put_shm_unsafe(h->a);
237                         h->a=0;
238                 }
239         }
240 }
241
242
243
244 /* get "next" ip next time a dns_srv_handle function is called
245  * params: h   - struct dns_srv_handler
246  *         err - return code of the last dns_*_resolve* call
247  * returns: 0 if it doesn't make sense to try another record,
248  * 1 otherwise
249  */
250 inline static int dns_srv_handle_next(struct dns_srv_handle* h, int err)
251 {
252         if (err<0) return 0;
253         h->ip_no++;
254         return (h->srv || h->a);
255 }
256
257
258
259 inline static void dns_srv_handle_init(struct dns_srv_handle* h)
260 {
261         h->srv=h->a=0;
262         h->srv_no=h->ip_no=0;
263         h->port=0;
264         h->proto=0;
265 #ifdef DNS_SRV_LB
266         h->srv_tried_rrs=0;
267 #endif
268 }
269
270
271
272 /* performes a srv query on name
273  * Params:  name  - srv query target (e.g. _sip._udp.foo.bar)
274  *          ip    - result: first good ip found
275  *          port  - result: corresponding port number
276  *          flags - resolve options (like ipv4 only, ipv6 prefered a.s.o)
277  * Returns: < 0 on error (can be passed to dns_strerror(), 0 on success
278  */
279 int dns_srv_get_ip(str* name, struct ip_addr* ip, unsigned short* port,
280                                         int flags);
281
282 /* performs an A, AAAA (or both) query/queries
283  * Params:  name  - query target (e.g. foo.bar)
284  *          ip    - result: first good ip found
285  *          flags - resolve options (like ipv4 only, ipv6 prefered a.s.o)
286  * Returns: < 0 on error (can be passed to dns_strerror(), 0 on success
287  */
288 int dns_get_ip(str* name, struct ip_addr* ip, int flags);
289
290 struct hostent* dns_srv_get_he(str* name, unsigned short* port, int flags);
291 struct hostent* dns_get_he(str* name, int flags);
292
293
294 /* resolve name to an ip, using srv record. Can be called multiple times
295  * to iterate on all the possible ips, e.g :
296  * dns_srv_handle_init(h);
297  * ret_code=dns_sip_resolve(h,...);
298  *  while( dns_srv_handle_next(h, ret_code){ ret_code=dns_sip_resolve(h...); }
299  * dns_srv_handle_put(h);
300  * WARNING: dns_srv_handle_init() must be called to initialize h and
301  *  dns_srv_handle_put(h) must be called when h is no longer needed
302  */
303 int dns_sip_resolve(struct dns_srv_handle* h,  str* name, struct ip_addr* ip,
304                                         unsigned short* port, char* proto, int flags);
305
306 /* same as above, but fills su intead of changing port and filling an ip */
307 inline static int dns_sip_resolve2su(struct dns_srv_handle* h,
308                                                                          union sockaddr_union* su,
309                                                                          str* name, unsigned short port,
310                                                                          char* proto, int flags)
311 {
312         struct ip_addr ip;
313         int ret;
314
315         ret=dns_sip_resolve(h, name, &ip, &port, proto, flags);
316         if (ret>=0)
317                 init_su(su, &ip, port);
318         return ret;
319 }
320
321 /* deletes all the entries from the cache */
322 void dns_cache_flush(void);
323
324 #ifdef DNS_WATCHDOG_SUPPORT
325 /* sets the state of the DNS servers:
326  * 1: at least one server is up
327  * 0: all the servers are down
328  */
329 void dns_set_server_state(int state);
330
331 /* returns the state of the DNS servers */
332 int dns_get_server_state(void);
333 #endif /* DNS_WATCHDOG_SUPPORT */
334
335 #endif