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