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