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