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