Commit | Line | Data |
---|---|---|
e576be50 | 1 | /* |
2 | * internal.h | |
3 | * - declarations of private objects with external linkage (adns__*) | |
4 | * - definitons of internal macros | |
5 | * - comments regarding library data structures | |
6 | */ | |
7 | /* | |
ae8cc977 | 8 | * This file is part of adns, which is |
9 | * Copyright (C) 1997-2000,2003,2006 Ian Jackson | |
10 | * Copyright (C) 1999-2000,2003,2006 Tony Finch | |
11 | * Copyright (C) 1991 Massachusetts Institute of Technology | |
12 | * (See the file INSTALL for full details.) | |
f7f83b4a | 13 | * |
e576be50 | 14 | * This program is free software; you can redistribute it and/or modify |
15 | * it under the terms of the GNU General Public License as published by | |
16 | * the Free Software Foundation; either version 2, or (at your option) | |
17 | * any later version. | |
f7f83b4a | 18 | * |
e576be50 | 19 | * This program is distributed in the hope that it will be useful, |
20 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
21 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
22 | * GNU General Public License for more details. | |
f7f83b4a | 23 | * |
e576be50 | 24 | * You should have received a copy of the GNU General Public License |
25 | * along with this program; if not, write to the Free Software Foundation, | |
f7f83b4a | 26 | * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
e576be50 | 27 | */ |
37e28fde | 28 | |
29 | #ifndef ADNS_INTERNAL_H_INCLUDED | |
30 | #define ADNS_INTERNAL_H_INCLUDED | |
31 | ||
11b35193 | 32 | #include "config.h" |
4353a5c4 | 33 | typedef unsigned char byte; |
34 | ||
35 | #include <stdarg.h> | |
36 | #include <assert.h> | |
37 | #include <unistd.h> | |
ac868fa8 | 38 | #include <signal.h> |
620c146d | 39 | #include <errno.h> |
b365d68a | 40 | #include <string.h> |
0d66e373 | 41 | #include <stdlib.h> |
4353a5c4 | 42 | |
37e28fde | 43 | #include <sys/time.h> |
44 | ||
45 | #include "adns.h" | |
70ad7a2a | 46 | #include "dlist.h" |
37e28fde | 47 | |
0ebff22d | 48 | #ifdef ADNS_REGRESS_TEST |
49 | # include "hredirect.h" | |
50 | #endif | |
51 | ||
37e28fde | 52 | /* Configuration and constants */ |
53 | ||
54 | #define MAXSERVERS 5 | |
09957b1c | 55 | #define MAXSORTLIST 15 |
4b707d8b | 56 | #define UDPMAXRETRIES 15 |
37e28fde | 57 | #define UDPRETRYMS 2000 |
f7f83b4a | 58 | #define TCPWAITMS 30000 |
59 | #define TCPCONNMS 14000 | |
60 | #define TCPIDLEMS 30000 | |
73dba56e | 61 | #define MAXTTLBELIEVE (7*86400) /* any TTL > 7 days is capped */ |
b9de380c | 62 | |
98a3f706 | 63 | #define DNS_PORT 53 |
b9de380c | 64 | #define DNS_MAXUDP 512 |
5b9dd636 | 65 | #define DNS_MAXLABEL 63 |
b9de380c | 66 | #define DNS_MAXDOMAIN 255 |
67 | #define DNS_HDRSIZE 12 | |
660d7d3b | 68 | #define DNS_IDOFFSET 0 |
b9de380c | 69 | #define DNS_CLASS_IN 1 |
37e28fde | 70 | |
a6536d8b | 71 | #define DNS_INADDR_ARPA "in-addr", "arpa" |
72 | ||
620c146d | 73 | #define MAX_POLLFDS ADNS_POLLFDS_RECOMMENDED |
74 | ||
c5fd1fbb MW |
75 | /* Some preprocessor hackery */ |
76 | ||
77 | #define GLUE(x, y) GLUE_(x, y) | |
78 | #define GLUE_(x, y) x##y | |
79 | ||
80 | /* C99 macro `...' must match at least one argument, so the naive definition | |
81 | * `#define CAR(car, ...) car' won't work. But it's easy to arrange for the | |
82 | * tail to be nonempty if we're just going to discard it anyway. */ | |
83 | #define CAR(...) CAR_(__VA_ARGS__, _) | |
84 | #define CAR_(car, ...) car | |
85 | ||
86 | /* Extracting the tail of an argument list is rather more difficult. The | |
87 | * following trick is based on one by Laurent Deniau to count the number of | |
88 | * arguments to a macro, simplified in two ways: (a) it only handles up to | |
89 | * eight arguments, and (b) it only needs to distinguish the one-argument | |
90 | * case from many arguments. */ | |
91 | #define CDR(...) CDR_(__VA_ARGS__, m, m, m, m, m, m, m, 1, _)(__VA_ARGS__) | |
92 | #define CDR_(_1, _2, _3, _4, _5, _6, _7, _8, n, ...) CDR_##n | |
93 | #define CDR_1(_) | |
94 | #define CDR_m(_, ...) __VA_ARGS__ | |
95 | ||
98a3f706 | 96 | typedef enum { |
3e2e5fab | 97 | cc_user, |
98 | cc_entex, | |
99 | cc_freq | |
100 | } consistency_checks; | |
101 | ||
102 | typedef enum { | |
98a3f706 | 103 | rcode_noerror, |
104 | rcode_formaterror, | |
105 | rcode_servfail, | |
106 | rcode_nxdomain, | |
107 | rcode_notimp, | |
108 | rcode_refused | |
109 | } dns_rcode; | |
110 | ||
37e28fde | 111 | /* Shared data structures */ |
112 | ||
4353a5c4 | 113 | typedef struct { |
114 | int used, avail; | |
115 | byte *buf; | |
116 | } vbuf; | |
117 | ||
0ba0614a | 118 | typedef struct { |
1dfe95d8 | 119 | adns_state ads; |
c7836bc9 | 120 | adns_query qu; |
1dfe95d8 | 121 | int serv; |
c7836bc9 | 122 | const byte *dgram; |
1dfe95d8 | 123 | int dglen, nsstart, nscount, arcount; |
7da21070 | 124 | struct timeval now; |
c7836bc9 | 125 | } parseinfo; |
126 | ||
e8e5aeac MW |
127 | union checklabel_state { |
128 | int dummy; | |
129 | }; | |
130 | ||
e1d3be7e MW |
131 | typedef struct { |
132 | void *ext; | |
133 | void (*callback)(adns_query parent, adns_query child); | |
134 | ||
135 | union { | |
136 | adns_rr_addr ptr_addr; | |
137 | } tinfo; /* type-specific state for the query itself: zero-init if you | |
138 | * don't know better. */ | |
139 | ||
140 | union { | |
141 | adns_rr_hostaddr *hostaddr; | |
142 | } pinfo; /* state for use by parent's callback function */ | |
143 | } qcontext; | |
144 | ||
d19b03d0 | 145 | typedef struct typeinfo { |
2c6eb096 | 146 | adns_rrtype typekey; |
86e7b8d9 | 147 | const char *rrtname; |
148 | const char *fmtname; | |
98a3f706 | 149 | int rrsz; |
8e5b0abb | 150 | |
86e7b8d9 | 151 | void (*makefinal)(adns_query qu, void *data); |
152 | /* Change memory management of *data. | |
153 | * Previously, used alloc_interim, now use alloc_final. | |
154 | */ | |
155 | ||
156 | adns_status (*convstring)(vbuf *vb, const void *data); | |
157 | /* Converts the RR data to a string representation in vbuf. | |
158 | * vbuf will be appended to (it must have been initialised), | |
159 | * and will not be null-terminated by convstring. | |
160 | */ | |
161 | ||
609133ee | 162 | adns_status (*parse)(const parseinfo *pai, int cbyte, |
163 | int max, void *store_r); | |
31144a72 | 164 | /* Parse one RR, in dgram of length dglen, starting at cbyte and |
165 | * extending until at most max. | |
166 | * | |
167 | * The RR should be stored at *store_r, of length qu->typei->rrsz. | |
168 | * | |
169 | * If there is an overrun which might indicate truncation, it should set | |
170 | * *rdstart to -1; otherwise it may set it to anything else positive. | |
88372443 | 171 | * |
c7836bc9 | 172 | * nsstart is the offset of the authority section. |
8e5b0abb | 173 | */ |
e062dcae | 174 | |
609133ee | 175 | int (*diff_needswap)(adns_state ads,const void *datap_a,const void *datap_b); |
88372443 | 176 | /* Returns !0 if RR a should be strictly after RR b in the sort order, |
e062dcae | 177 | * 0 otherwise. Must not fail. |
178 | */ | |
d19b03d0 | 179 | |
e8e5aeac MW |
180 | adns_status (*checklabel)(adns_state ads, adns_queryflags flags, |
181 | union checklabel_state *cls, qcontext *ctx, | |
182 | int labnum, const char *label, int lablen); | |
183 | /* Check a label from the query domain string. The label is not | |
184 | * necessarily null-terminated. The hook can refuse the query's submission | |
185 | * by returning a nonzero status. State can be stored in *cls between | |
186 | * calls, and useful information can be stashed in ctx->tinfo, to be stored | |
187 | * with the query (e.g., it will be available to the parse hook). This | |
188 | * hook can detect a first call because labnum is zero, and a final call | |
189 | * because lablen is zero. | |
190 | */ | |
d19b03d0 | 191 | |
0e45654b | 192 | void (*postsort)(adns_state ads, void *array, int nrrs, |
d24e2a7e | 193 | const struct typeinfo *typei); |
194 | /* Called immediately after the RRs have been sorted, and may rearrange | |
195 | * them. (This is really for the benefit of SRV's bizarre weighting | |
196 | * stuff.) May be 0 to mean nothing needs to be done. | |
197 | */ | |
0ba0614a | 198 | } typeinfo; |
199 | ||
e8e5aeac MW |
200 | adns_status adns__ckl_hostname(adns_state ads, adns_queryflags flags, |
201 | union checklabel_state *cls, | |
202 | qcontext *ctx, int labnum, | |
203 | const char *label, int lablen); | |
204 | /* implemented in query.c, used by types.c as default | |
205 | * and as part of implementation for some fancier types | |
206 | * doesn't require any state */ | |
d19b03d0 | 207 | |
8e5b0abb | 208 | typedef struct allocnode { |
551ff40f | 209 | struct allocnode *next, *back; |
8e5b0abb | 210 | } allocnode; |
211 | ||
212 | union maxalign { | |
213 | byte d[1]; | |
214 | struct in_addr ia; | |
215 | long l; | |
216 | void *p; | |
217 | void (*fp)(void); | |
218 | union maxalign *up; | |
219 | } data; | |
220 | ||
37e28fde | 221 | struct adns__query { |
3955725c | 222 | adns_state ads; |
f7f83b4a | 223 | enum { query_tosend, query_tcpw, query_childw, query_done } state; |
4353a5c4 | 224 | adns_query back, next, parent; |
37e28fde | 225 | struct { adns_query head, tail; } children; |
226 | struct { adns_query back, next; } siblings; | |
551ff40f | 227 | struct { allocnode *head, *tail; } allocations; |
8b3d55e3 | 228 | int interim_allocd, preserved_allocd; |
68442019 | 229 | void *final_allocspace; |
8ce38e76 | 230 | |
0ba0614a | 231 | const typeinfo *typei; |
e062dcae | 232 | byte *query_dgram; |
8e5b0abb | 233 | int query_dglen; |
f7f83b4a | 234 | |
8e5b0abb | 235 | vbuf vb; |
236 | /* General-purpose messing-about buffer. | |
237 | * Wherever a `big' interface is crossed, this may be corrupted/changed | |
238 | * unless otherwise specified. | |
239 | */ | |
240 | ||
241 | adns_answer *answer; | |
242 | /* This is allocated when a query is submitted, to avoid being unable | |
243 | * to relate errors to queries if we run out of memory. During | |
244 | * query processing status, rrs is 0. cname is set if | |
245 | * we found a cname (this corresponds to cname_dgram in the query | |
246 | * structure). type is set from the word go. nrrs and rrs | |
247 | * are set together, when we find how many rrs there are. | |
22181a31 | 248 | * owner is set during querying unless we're doing searchlist, |
249 | * in which case it is set only when we find an answer. | |
8e5b0abb | 250 | */ |
f7f83b4a | 251 | |
31144a72 | 252 | byte *cname_dgram; |
253 | int cname_dglen, cname_begin; | |
3955725c | 254 | /* If non-0, has been allocated using . */ |
32af6b2a | 255 | |
256 | vbuf search_vb; | |
257 | int search_origlen, search_pos, search_doneabs; | |
258 | /* Used by the searching algorithm. The query domain in textual form | |
259 | * is copied into the vbuf, and _origlen set to its length. Then | |
260 | * we walk the searchlist, if we want to. _pos says where we are | |
261 | * (next entry to try), and _doneabs says whether we've done the | |
660d7d3b | 262 | * absolute query yet (0=not yet, 1=done, -1=must do straight away, |
263 | * but not done yet). If flags doesn't have adns_qf_search then | |
32af6b2a | 264 | * the vbuf is initialised but empty and everything else is zero. |
32af6b2a | 265 | */ |
f7f83b4a | 266 | |
267 | int id, flags, retries; | |
4353a5c4 | 268 | int udpnextserver; |
f7f83b4a | 269 | unsigned long udpsent; /* bitmap indexed by server */ |
37e28fde | 270 | struct timeval timeout; |
73dba56e | 271 | time_t expires; /* Earliest expiry time of any record we used. */ |
a6536d8b | 272 | |
273 | qcontext ctx; | |
ddfda861 | 274 | |
37e28fde | 275 | /* Possible states: |
ddfda861 | 276 | * |
3e2e5fab | 277 | * state Queue child id nextudpserver udpsent tcpfailed |
f7f83b4a | 278 | * |
d8c062fa | 279 | * tosend NONE null >=0 0 zero zero |
f7f83b4a | 280 | * tosend udpw null >=0 any nonzero zero |
d8c062fa | 281 | * tosend NONE null >=0 any nonzero zero |
f7f83b4a | 282 | * |
283 | * tcpw tcpw null >=0 irrelevant any any | |
284 | * | |
8e5b0abb | 285 | * child childw set >=0 irrelevant irrelevant irrelevant |
dcc8e442 | 286 | * child NONE null >=0 irrelevant irrelevant irrelevant |
8e5b0abb | 287 | * done output null -1 irrelevant irrelevant irrelevant |
ddfda861 | 288 | * |
dcc8e442 | 289 | * Queries are only not on a queue when they are actually being processed. |
f7f83b4a | 290 | * Queries in state tcpw/tcpw have been sent (or are in the to-send buffer) |
291 | * iff the tcp connection is in state server_ok. | |
dcc8e442 | 292 | * |
ddfda861 | 293 | * +------------------------+ |
f7f83b4a | 294 | * START -----> | tosend/NONE | |
ddfda861 | 295 | * +------------------------+ |
296 | * / |\ \ | |
297 | * too big for UDP / UDP timeout \ \ send via UDP | |
f7f83b4a | 298 | * send via TCP / more retries \ \ |
299 | * when conn'd / desired \ \ | |
300 | * | | | | |
301 | * v | v | |
302 | * +-----------+ +-------------+ | |
303 | * | tcpw/tcpw | ________ | tosend/udpw | | |
304 | * +-----------+ \ +-------------+ | |
305 | * | | | UDP timeout | | | |
306 | * | | | no more | | | |
307 | * | | | retries | | | |
308 | * \ | TCP died | desired | | | |
309 | * \ \ no more | | | | |
310 | * \ \ servers | TCP / | | |
311 | * \ \ to try | timeout / | | |
312 | * got \ \ v |_ | got | |
ddfda861 | 313 | * reply \ _| +------------------+ / reply |
314 | * \ | done/output FAIL | / | |
315 | * \ +------------------+ / | |
316 | * \ / | |
317 | * _| |_ | |
318 | * (..... got reply ....) | |
319 | * / \ | |
320 | * need child query/ies / \ no child query | |
321 | * / \ | |
322 | * |_ _| | |
f7f83b4a | 323 | * +---------------+ +----------------+ |
324 | * | childw/childw | ----------------> | done/output OK | | |
325 | * +---------------+ children done +----------------+ | |
37e28fde | 326 | */ |
327 | }; | |
328 | ||
f7f83b4a | 329 | struct query_queue { adns_query head, tail; }; |
330 | ||
37e28fde | 331 | struct adns__state { |
37e28fde | 332 | adns_initflags iflags; |
d3a102c4 | 333 | adns_logcallbackfn *logfn; |
334 | void *logfndata; | |
36369543 | 335 | int configerrno; |
f7f83b4a | 336 | struct query_queue udpw, tcpw, childw, output; |
8ce38e76 | 337 | adns_query forallnext; |
4353a5c4 | 338 | int nextid, udpsocket, tcpsocket; |
8e5b0abb | 339 | vbuf tcpsend, tcprecv; |
70ad7a2a | 340 | int nservers, nsortlist, nsearchlist, searchndots, tcpserver, tcprecv_skip; |
f7f83b4a | 341 | enum adns__tcpstate { |
342 | server_disconnected, server_connecting, | |
343 | server_ok, server_broken | |
344 | } tcpstate; | |
37e28fde | 345 | struct timeval tcptimeout; |
4fad263d | 346 | /* This will have tv_sec==0 if it is not valid. It will always be |
347 | * valid if tcpstate _connecting. When _ok, it will be nonzero if | |
348 | * we are idle (ie, tcpw queue is empty), in which case it is the | |
349 | * absolute time when we will close the connection. | |
f7f83b4a | 350 | */ |
ac868fa8 | 351 | struct sigaction stdsigpipe; |
352 | sigset_t stdsigmask; | |
620c146d | 353 | struct pollfd pollfds_buf[MAX_POLLFDS]; |
37e28fde | 354 | struct server { |
355 | struct in_addr addr; | |
356 | } servers[MAXSERVERS]; | |
09957b1c | 357 | struct sortlist { |
358 | struct in_addr base, mask; | |
359 | } sortlist[MAXSORTLIST]; | |
32af6b2a | 360 | char **searchlist; |
0e45654b | 361 | unsigned short rand48xsubi[3]; |
37e28fde | 362 | }; |
363 | ||
364 | /* From setup.c: */ | |
365 | ||
e576be50 | 366 | int adns__setnonblock(adns_state ads, int fd); /* => errno value */ |
367 | ||
368 | /* From general.c: */ | |
369 | ||
d3a102c4 | 370 | void adns__vlprintf(adns_state ads, const char *fmt, va_list al); |
371 | void adns__lprintf(adns_state ads, const char *fmt, | |
372 | ...) PRINTFFORMAT(2,3); | |
373 | ||
4353a5c4 | 374 | void adns__vdiag(adns_state ads, const char *pfx, adns_initflags prevent, |
68442019 | 375 | int serv, adns_query qu, const char *fmt, va_list al); |
31144a72 | 376 | |
377 | void adns__debug(adns_state ads, int serv, adns_query qu, | |
68442019 | 378 | const char *fmt, ...) PRINTFFORMAT(4,5); |
31144a72 | 379 | void adns__warn(adns_state ads, int serv, adns_query qu, |
68442019 | 380 | const char *fmt, ...) PRINTFFORMAT(4,5); |
31144a72 | 381 | void adns__diag(adns_state ads, int serv, adns_query qu, |
68442019 | 382 | const char *fmt, ...) PRINTFFORMAT(4,5); |
37e28fde | 383 | |
4353a5c4 | 384 | int adns__vbuf_ensure(vbuf *vb, int want); |
609133ee | 385 | int adns__vbuf_appendstr(vbuf *vb, const char *data); /* doesn't include nul */ |
4353a5c4 | 386 | int adns__vbuf_append(vbuf *vb, const byte *data, int len); |
ddfda861 | 387 | /* 1=>success, 0=>realloc failed */ |
4353a5c4 | 388 | void adns__vbuf_appendq(vbuf *vb, const byte *data, int len); |
389 | void adns__vbuf_init(vbuf *vb); | |
8e5b0abb | 390 | void adns__vbuf_free(vbuf *vb); |
4353a5c4 | 391 | |
828d89bd | 392 | const char *adns__diag_domain(adns_state ads, int serv, adns_query qu, |
609133ee | 393 | vbuf *vb, |
394 | const byte *dgram, int dglen, int cbyte); | |
e576be50 | 395 | /* Unpicks a domain in a datagram and returns a string suitable for |
396 | * printing it as. Never fails - if an error occurs, it will | |
397 | * return some kind of string describing the error. | |
398 | * | |
3955725c | 399 | * serv may be -1 and qu may be 0. vb must have been initialised, |
e576be50 | 400 | * and will be left in an arbitrary consistent state. |
401 | * | |
402 | * Returns either vb->buf, or a pointer to a string literal. Do not modify | |
403 | * vb before using the return value. | |
404 | */ | |
f7f83b4a | 405 | |
88372443 | 406 | void adns__isort(void *array, int nobjs, int sz, void *tempbuf, |
09957b1c | 407 | int (*needswap)(void *context, const void *a, const void *b), |
408 | void *context); | |
88372443 | 409 | /* Does an insertion sort of array which must contain nobjs objects |
410 | * each sz bytes long. tempbuf must point to a buffer at least | |
411 | * sz bytes long. needswap should return !0 if a>b (strictly, ie | |
412 | * wrong order) 0 if a<=b (ie, order is fine). | |
413 | */ | |
ac868fa8 | 414 | |
415 | void adns__sigpipe_protect(adns_state); | |
416 | void adns__sigpipe_unprotect(adns_state); | |
417 | /* If SIGPIPE protection is not disabled, will block all signals except | |
418 | * SIGPIPE, and set SIGPIPE's disposition to SIG_IGN. (And then restore.) | |
419 | * Each call to _protect must be followed by a call to _unprotect before | |
1f2ababa | 420 | * any significant amount of code gets to run, since the old signal mask |
421 | * is stored in the adns structure. | |
ac868fa8 | 422 | */ |
423 | ||
e576be50 | 424 | /* From transmit.c: */ |
ddfda861 | 425 | |
3955725c | 426 | adns_status adns__mkquery(adns_state ads, vbuf *vb, int *id_r, |
427 | const char *owner, int ol, | |
2c6eb096 | 428 | const typeinfo *typei, adns_rrtype type, |
429 | adns_queryflags flags); | |
660d7d3b | 430 | /* Assembles a query packet in vb. A new id is allocated and returned. |
431 | */ | |
e576be50 | 432 | |
e062dcae | 433 | adns_status adns__mkquery_frdgram(adns_state ads, vbuf *vb, int *id_r, |
609133ee | 434 | const byte *qd_dgram, int qd_dglen, |
435 | int qd_begin, | |
e062dcae | 436 | adns_rrtype type, adns_queryflags flags); |
437 | /* Same as adns__mkquery, but takes the owner domain from an existing datagram. | |
438 | * That domain must be correct and untruncated. | |
439 | */ | |
440 | ||
f7f83b4a | 441 | void adns__querysend_tcp(adns_query qu, struct timeval now); |
442 | /* Query must be in state tcpw/tcpw; it will be sent if possible and | |
443 | * no further processing can be done on it for now. The connection | |
444 | * might be broken, but no reconnect will be attempted. | |
e576be50 | 445 | */ |
446 | ||
d8c062fa | 447 | void adns__query_send(adns_query qu, struct timeval now); |
448 | /* Query must be in state tosend/NONE; it will be moved to a new state, | |
e576be50 | 449 | * and no further processing can be done on it for now. |
609133ee | 450 | * (Resulting state is one of udp/timew, tcpwait/timew (if server not |
451 | * connected), tcpsent/timew, child/childw or done/output.) | |
d8c062fa | 452 | * __query_send may decide to use either UDP or TCP depending whether |
453 | * _qf_usevc is set (or has become set) and whether the query is too | |
454 | * large. | |
e576be50 | 455 | */ |
456 | ||
457 | /* From query.c: */ | |
37e28fde | 458 | |
660d7d3b | 459 | adns_status adns__internal_submit(adns_state ads, adns_query *query_r, |
609133ee | 460 | const typeinfo *typei, vbuf *qumsg_vb, |
461 | int id, | |
660d7d3b | 462 | adns_queryflags flags, struct timeval now, |
be4d66dc | 463 | qcontext *ctx); |
8e5b0abb | 464 | /* Submits a query (for internal use, called during external submits). |
465 | * | |
466 | * The new query is returned in *query_r, or we return adns_s_nomemory. | |
467 | * | |
68442019 | 468 | * The query datagram should already have been assembled in qumsg_vb; |
469 | * the memory for it is _taken over_ by this routine whether it | |
470 | * succeeds or fails (if it succeeds, the vbuf is reused for qu->vb). | |
8e5b0abb | 471 | * |
be4d66dc MW |
472 | * *ctx is copied byte-for-byte into the query. Before doing this, its tinfo |
473 | * field may be modified by type hooks. | |
dcc8e442 | 474 | * |
475 | * When the child query is done, ctx->callback will be called. The | |
476 | * child will already have been taken off both the global list of | |
477 | * queries in ads and the list of children in the parent. The child | |
478 | * will be freed when the callback returns. The parent will have been | |
4218fb9a | 479 | * taken off the global childw queue. |
480 | * | |
481 | * The callback should either call adns__query_done, if it is | |
482 | * complete, or adns__query_fail, if an error has occurred, in which | |
483 | * case the other children (if any) will be cancelled. If the parent | |
484 | * has more unfinished children (or has just submitted more) then the | |
485 | * callback may choose to wait for them - it must then put the parent | |
486 | * back on the childw queue. | |
8e5b0abb | 487 | */ |
488 | ||
660d7d3b | 489 | void adns__search_next(adns_state ads, adns_query qu, struct timeval now); |
490 | /* Walks down the searchlist for a query with adns_qf_search. | |
491 | * The query should have just had a negative response, or not had | |
492 | * any queries sent yet, and should not be on any queue. | |
493 | * The query_dgram if any will be freed and forgotten and a new | |
494 | * one constructed from the search_* members of the query. | |
495 | * | |
496 | * Cannot fail (in case of error, calls adns__query_fail). | |
497 | */ | |
498 | ||
8e5b0abb | 499 | void *adns__alloc_interim(adns_query qu, size_t sz); |
8b3d55e3 | 500 | void *adns__alloc_preserved(adns_query qu, size_t sz); |
8e5b0abb | 501 | /* Allocates some memory, and records which query it came from |
502 | * and how much there was. | |
503 | * | |
8b3d55e3 | 504 | * If an error occurs in the query, all the memory from _interim is |
505 | * simply freed. If the query succeeds, one large buffer will be made | |
506 | * which is big enough for all these allocations, and then | |
507 | * adns__alloc_final will get memory from this buffer. | |
8e5b0abb | 508 | * |
e062dcae | 509 | * _alloc_interim can fail (and return 0). |
510 | * The caller must ensure that the query is failed. | |
a49a6d7b | 511 | * |
8b3d55e3 | 512 | * The memory from _preserved is is kept and transferred into the |
513 | * larger buffer - unless we run out of memory, in which case it too | |
514 | * is freed. When you use _preserved you have to add code to the | |
515 | * x_nomem error exit case in adns__makefinal_query to clear out the | |
516 | * pointers you made to those allocations, because that's when they're | |
517 | * thrown away; you should also make a note in the declaration of | |
518 | * those pointer variables, to note that they are _preserved rather | |
519 | * than _interim. If they're in the answer, note it here: | |
520 | * answer->cname and answer->owner are _preserved. | |
8e5b0abb | 521 | */ |
522 | ||
609133ee | 523 | void adns__transfer_interim(adns_query from, adns_query to, |
524 | void *block, size_t sz); | |
551ff40f | 525 | /* Transfers an interim allocation from one query to another, so that |
526 | * the `to' query will have room for the data when we get to makefinal | |
527 | * and so that the free will happen when the `to' query is freed | |
528 | * rather than the `from' query. | |
529 | * | |
530 | * It is legal to call adns__transfer_interim with a null pointer; this | |
531 | * has no effect. | |
73dba56e | 532 | * |
533 | * _transfer_interim also ensures that the expiry time of the `to' query | |
534 | * is no later than that of the `from' query, so that child queries' | |
535 | * TTLs get inherited by their parents. | |
551ff40f | 536 | */ |
537 | ||
3955725c | 538 | void *adns__alloc_mine(adns_query qu, size_t sz); |
539 | /* Like _interim, but does not record the length for later | |
540 | * copying into the answer. This just ensures that the memory | |
541 | * will be freed when we're done with the query. | |
542 | */ | |
543 | ||
8e5b0abb | 544 | void *adns__alloc_final(adns_query qu, size_t sz); |
a49a6d7b | 545 | /* Cannot fail, and cannot return 0. |
8e5b0abb | 546 | */ |
37e28fde | 547 | |
68442019 | 548 | void adns__makefinal_block(adns_query qu, void **blpp, size_t sz); |
549 | void adns__makefinal_str(adns_query qu, char **strp); | |
550 | ||
8b3d55e3 | 551 | void adns__reset_preserved(adns_query qu); |
552 | /* Resets all of the memory management stuff etc. to take account of | |
553 | * only the _preserved stuff from _alloc_preserved. Used when we find | |
554 | * an error somewhere and want to just report the error (with perhaps | |
555 | * CNAME, owner, etc. info), and also when we're halfway through RRs | |
556 | * in a datagram and discover that we need to retry the query. | |
68442019 | 557 | */ |
e576be50 | 558 | |
3955725c | 559 | void adns__query_done(adns_query qu); |
560 | void adns__query_fail(adns_query qu, adns_status stat); | |
f7f83b4a | 561 | |
4353a5c4 | 562 | /* From reply.c: */ |
563 | ||
98a3f706 | 564 | void adns__procdgram(adns_state ads, const byte *dgram, int len, |
ebf4877a | 565 | int serv, int viatcp, struct timeval now); |
1f2ababa | 566 | /* This function is allowed to cause new datagrams to be constructed |
567 | * and sent, or even new queries to be started. However, | |
568 | * query-sending functions are not allowed to call any general event | |
569 | * loop functions in case they accidentally call this. | |
f7f83b4a | 570 | * |
571 | * Ie, receiving functions may call sending functions. | |
572 | * Sending functions may NOT call receiving functions. | |
1f2ababa | 573 | */ |
98a3f706 | 574 | |
575 | /* From types.c: */ | |
576 | ||
577 | const typeinfo *adns__findtype(adns_rrtype type); | |
578 | ||
579 | /* From parse.c: */ | |
580 | ||
f1e474dd | 581 | typedef struct { |
68442019 | 582 | adns_state ads; |
3955725c | 583 | adns_query qu; |
68442019 | 584 | int serv; |
f1e474dd | 585 | const byte *dgram; |
586 | int dglen, max, cbyte, namelen; | |
3955725c | 587 | int *dmend_r; |
f1e474dd | 588 | } findlabel_state; |
589 | ||
3955725c | 590 | void adns__findlabel_start(findlabel_state *fls, adns_state ads, |
591 | int serv, adns_query qu, | |
f1e474dd | 592 | const byte *dgram, int dglen, int max, |
593 | int dmbegin, int *dmend_rlater); | |
594 | /* Finds labels in a domain in a datagram. | |
595 | * | |
596 | * Call this routine first. | |
3955725c | 597 | * dmend_rlater may be null. ads (and of course fls) may not be. |
598 | * serv may be -1, qu may be null - they are for error reporting. | |
f1e474dd | 599 | */ |
600 | ||
609133ee | 601 | adns_status adns__findlabel_next(findlabel_state *fls, |
602 | int *lablen_r, int *labstart_r); | |
f1e474dd | 603 | /* Then, call this one repeatedly. |
604 | * | |
605 | * It will return adns_s_ok if all is well, and tell you the length | |
606 | * and start of successive labels. labstart_r may be null, but | |
607 | * lablen_r must not be. | |
608 | * | |
609 | * After the last label, it will return with *lablen_r zero. | |
610 | * Do not then call it again; instead, just throw away the findlabel_state. | |
611 | * | |
612 | * *dmend_rlater will have been set to point to the next part of | |
613 | * the datagram after the label (or after the uncompressed part, | |
614 | * if compression was used). *namelen_rlater will have been set | |
615 | * to the length of the domain name (total length of labels plus | |
616 | * 1 for each intervening dot). | |
617 | * | |
618 | * If the datagram appears to be truncated, *lablen_r will be -1. | |
619 | * *dmend_rlater, *labstart_r and *namelen_r may contain garbage. | |
620 | * Do not call _next again. | |
621 | * | |
622 | * There may also be errors, in which case *dmend_rlater, | |
623 | * *namelen_rlater, *lablen_r and *labstart_r may contain garbage. | |
624 | * Do not then call findlabel_next again. | |
625 | */ | |
626 | ||
828d89bd | 627 | typedef enum { |
628 | pdf_quoteok= 0x001 | |
629 | } parsedomain_flags; | |
630 | ||
3955725c | 631 | adns_status adns__parse_domain(adns_state ads, int serv, adns_query qu, |
828d89bd | 632 | vbuf *vb, parsedomain_flags flags, |
609133ee | 633 | const byte *dgram, int dglen, int *cbyte_io, |
634 | int max); | |
f1e474dd | 635 | /* vb must already have been initialised; it will be reset if necessary. |
636 | * If there is truncation, vb->used will be set to 0; otherwise | |
637 | * (if there is no error) vb will be null-terminated. | |
638 | * If there is an error vb and *cbyte_io may be left indeterminate. | |
3955725c | 639 | * |
640 | * serv may be -1 and qu may be 0 - they are used for error reporting only. | |
f1e474dd | 641 | */ |
642 | ||
eaa44731 | 643 | adns_status adns__parse_domain_more(findlabel_state *fls, adns_state ads, |
609133ee | 644 | adns_query qu, vbuf *vb, |
645 | parsedomain_flags flags, | |
eaa44731 | 646 | const byte *dgram); |
647 | /* Like adns__parse_domain, but you pass it a pre-initialised findlabel_state, | |
648 | * for continuing an existing domain or some such of some kind. Also, unlike | |
649 | * _parse_domain, the domain data will be appended to vb, rather than replacing | |
650 | * the existing contents. | |
651 | */ | |
652 | ||
3955725c | 653 | adns_status adns__findrr(adns_query qu, int serv, |
f1e474dd | 654 | const byte *dgram, int dglen, int *cbyte_io, |
73dba56e | 655 | int *type_r, int *class_r, unsigned long *ttl_r, |
656 | int *rdlen_r, int *rdstart_r, | |
3955725c | 657 | int *ownermatchedquery_r); |
c7836bc9 | 658 | /* Finds the extent and some of the contents of an RR in a datagram |
659 | * and does some checks. The datagram is *dgram, length dglen, and | |
660 | * the RR starts at *cbyte_io (which is updated afterwards to point | |
661 | * to the end of the RR). | |
662 | * | |
73dba56e | 663 | * The type, class, TTL and RRdata length and start are returned iff |
664 | * the corresponding pointer variables are not null. type_r, class_r | |
665 | * and ttl_r may not be null. The TTL will be capped. | |
c7836bc9 | 666 | * |
667 | * If ownermatchedquery_r != 0 then the owner domain of this | |
668 | * RR will be compared with that in the query (or, if the query | |
669 | * has gone to a CNAME lookup, with the canonical name). | |
670 | * In this case, *ownermatchedquery_r will be set to 0 or 1. | |
671 | * The query datagram (or CNAME datagram) MUST be valid and not truncated. | |
672 | * | |
673 | * If there is truncation then *type_r will be set to -1 and | |
674 | * *cbyte_io, *class_r, *rdlen_r, *rdstart_r and *eo_matched_r will be | |
675 | * undefined. | |
676 | * | |
677 | * qu must obviously be non-null. | |
678 | * | |
679 | * If an error is returned then *type_r will be undefined too. | |
680 | */ | |
681 | ||
1dfe95d8 | 682 | adns_status adns__findrr_anychk(adns_query qu, int serv, |
683 | const byte *dgram, int dglen, int *cbyte_io, | |
609133ee | 684 | int *type_r, int *class_r, |
685 | unsigned long *ttl_r, | |
73dba56e | 686 | int *rdlen_r, int *rdstart_r, |
609133ee | 687 | const byte *eo_dgram, int eo_dglen, |
688 | int eo_cbyte, int *eo_matched_r); | |
c7836bc9 | 689 | /* Like adns__findrr_checked, except that the datagram and |
690 | * owner to compare with can be specified explicitly. | |
691 | * | |
692 | * If the caller thinks they know what the owner of the RR ought to | |
693 | * be they can pass in details in eo_*: this is another (or perhaps | |
694 | * the same datagram), and a pointer to where the putative owner | |
695 | * starts in that datagram. In this case *eo_matched_r will be set | |
696 | * to 1 if the datagram matched or 0 if it did not. Either | |
697 | * both eo_dgram and eo_matched_r must both be non-null, or they | |
698 | * must both be null (in which case eo_dglen and eo_cbyte will be ignored). | |
699 | * The eo datagram and contained owner domain MUST be valid and | |
700 | * untruncated. | |
701 | */ | |
98a3f706 | 702 | |
609133ee | 703 | void adns__update_expires(adns_query qu, unsigned long ttl, |
704 | struct timeval now); | |
73dba56e | 705 | /* Updates the `expires' field in the query, so that it doesn't exceed |
706 | * now + ttl. | |
707 | */ | |
708 | ||
f1e474dd | 709 | int vbuf__append_quoted1035(vbuf *vb, const byte *buf, int len); |
8402e34c | 710 | |
711 | /* From event.c: */ | |
4353a5c4 | 712 | |
8402e34c | 713 | void adns__tcp_broken(adns_state ads, const char *what, const char *why); |
f7f83b4a | 714 | /* what and why may be both 0, or both non-0. */ |
715 | ||
4353a5c4 | 716 | void adns__tcp_tryconnect(adns_state ads, struct timeval now); |
e576be50 | 717 | |
4353a5c4 | 718 | void adns__autosys(adns_state ads, struct timeval now); |
70ad7a2a | 719 | /* Make all the system calls we want to if the application wants us to. |
720 | * Must not be called from within adns internal processing functions, | |
721 | * lest we end up in recursive descent ! | |
722 | */ | |
37e28fde | 723 | |
620c146d | 724 | void adns__must_gettimeofday(adns_state ads, const struct timeval **now_io, |
725 | struct timeval *tv_buf); | |
f7f83b4a | 726 | |
620c146d | 727 | int adns__pollfds(adns_state ads, struct pollfd pollfds_buf[MAX_POLLFDS]); |
728 | void adns__fdevents(adns_state ads, | |
729 | const struct pollfd *pollfds, int npollfds, | |
730 | int maxfd, const fd_set *readfds, | |
731 | const fd_set *writefds, const fd_set *exceptfds, | |
732 | struct timeval now, int *r_r); | |
940356bd | 733 | int adns__internal_check(adns_state ads, |
734 | adns_query *query_io, | |
735 | adns_answer **answer, | |
736 | void **context_r); | |
620c146d | 737 | |
f7f83b4a | 738 | void adns__timeouts(adns_state ads, int act, |
739 | struct timeval **tv_io, struct timeval *tvbuf, | |
740 | struct timeval now); | |
741 | /* If act is !0, then this will also deal with the TCP connection | |
742 | * if previous events broke it or require it to be connected. | |
743 | */ | |
744 | ||
3e2e5fab | 745 | /* From check.c: */ |
746 | ||
28de6442 | 747 | void adns__consistency(adns_state ads, adns_query qu, consistency_checks cc); |
3e2e5fab | 748 | |
37e28fde | 749 | /* Useful static inline functions: */ |
750 | ||
609133ee | 751 | static inline int ctype_whitespace(int c) { |
752 | return c==' ' || c=='\n' || c=='\t'; | |
753 | } | |
37e28fde | 754 | static inline int ctype_digit(int c) { return c>='0' && c<='9'; } |
98a3f706 | 755 | static inline int ctype_alpha(int c) { |
9da4a044 | 756 | return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z'); |
98a3f706 | 757 | } |
609133ee | 758 | static inline int ctype_822special(int c) { |
759 | return strchr("()<>@,;:\\\".[]",c) != 0; | |
760 | } | |
8af5175d | 761 | static inline int ctype_domainunquoted(int c) { |
762 | return ctype_alpha(c) || ctype_digit(c) || (strchr("-_/+",c) != 0); | |
763 | } | |
37e28fde | 764 | |
620c146d | 765 | static inline int errno_resources(int e) { return e==ENOMEM || e==ENOBUFS; } |
766 | ||
37e28fde | 767 | /* Useful macros */ |
768 | ||
609133ee | 769 | #define MEM_ROUND(sz) \ |
770 | (( ((sz)+sizeof(union maxalign)-1) / sizeof(union maxalign) ) \ | |
8e5b0abb | 771 | * sizeof(union maxalign) ) |
772 | ||
86e7b8d9 | 773 | #define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ff) |
98a3f706 | 774 | #define GET_B(cb,tv) ((tv)= GETIL_B((cb))) |
609133ee | 775 | #define GET_W(cb,tv) ((tv)=0,(tv)|=(GETIL_B((cb))<<8), (tv)|=GETIL_B(cb), (tv)) |
776 | #define GET_L(cb,tv) ( (tv)=0, \ | |
777 | (tv)|=(GETIL_B((cb))<<24), \ | |
778 | (tv)|=(GETIL_B((cb))<<16), \ | |
779 | (tv)|=(GETIL_B((cb))<<8), \ | |
780 | (tv)|=GETIL_B(cb), \ | |
73dba56e | 781 | (tv) ) |
98a3f706 | 782 | |
37e28fde | 783 | #endif |