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