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