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