chiark / gitweb /
+ Minor improvements:
[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-2000 Ian Jackson <ian@davenant.greenend.org.uk>
10  *
11  *  It is part of adns, which is
12  *    Copyright (C) 1997-2000 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 TCPWAITMS 30000
55 #define TCPCONNMS 14000
56 #define TCPIDLEMS 30000
57 #define MAXTTLBELIEVE (7*86400) /* any TTL > 7 days is capped */
58
59 #define DNS_PORT 53
60 #define DNS_MAXUDP 512
61 #define DNS_MAXLABEL 63
62 #define DNS_MAXDOMAIN 255
63 #define DNS_HDRSIZE 12
64 #define DNS_IDOFFSET 0
65 #define DNS_CLASS_IN 1
66
67 #define DNS_INADDR_ARPA "in-addr", "arpa"
68
69 #define MAX_POLLFDS  ADNS_POLLFDS_RECOMMENDED
70
71 typedef enum {
72   cc_user,
73   cc_entex,
74   cc_freq
75 } consistency_checks;
76
77 typedef enum {
78   rcode_noerror,
79   rcode_formaterror,
80   rcode_servfail,
81   rcode_nxdomain,
82   rcode_notimp,
83   rcode_refused
84 } dns_rcode;
85
86 /* Shared data structures */
87
88 typedef union {
89   adns_status status;
90   char *cp;
91   adns_rrtype type;
92   int i;
93   struct in_addr ia;
94   unsigned long ul;
95 } rr_align;
96
97 typedef struct {
98   int used, avail;
99   byte *buf;
100 } vbuf;
101
102 typedef struct {
103   adns_state ads;
104   adns_query qu;
105   int serv;
106   const byte *dgram;
107   int dglen, nsstart, nscount, arcount;
108   struct timeval now;
109 } parseinfo;
110
111 typedef struct {
112   adns_rrtype type;
113   const char *rrtname;
114   const char *fmtname;
115   int rrsz;
116
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
128   adns_status (*parse)(const parseinfo *pai, int cbyte, int max, void *store_r);
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.
136    *
137    * nsstart is the offset of the authority section.
138    */
139
140   int (*diff_needswap)(adns_state ads, const void *datap_a, const void *datap_b);
141   /* Returns !0 if RR a should be strictly after RR b in the sort order,
142    * 0 otherwise.  Must not fail.
143    */
144 } typeinfo;
145
146 typedef struct allocnode {
147   struct allocnode *next, *back;
148 } allocnode;
149
150 union 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
159 typedef 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
168 struct adns__query {
169   adns_state ads;
170   enum { query_tosend, query_tcpw, query_childw, query_done } state;
171   adns_query back, next, parent;
172   struct { adns_query head, tail; } children;
173   struct { adns_query back, next; } siblings;
174   struct { allocnode *head, *tail; } allocations;
175   int interim_allocd, preserved_allocd;
176   void *final_allocspace;
177
178   const typeinfo *typei;
179   byte *query_dgram;
180   int query_dglen;
181
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.
195    * owner is set during querying unless we're doing searchlist,
196    * in which case it is set only when we find an answer.
197    */
198
199   byte *cname_dgram;
200   int cname_dglen, cname_begin;
201   /* If non-0, has been allocated using . */
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
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
211    * the vbuf is initialised but empty and everything else is zero.
212    */
213
214   int id, flags, retries;
215   int udpnextserver;
216   unsigned long udpsent; /* bitmap indexed by server */
217   struct timeval timeout;
218   time_t expires; /* Earliest expiry time of any record we used. */
219
220   qcontext ctx;
221
222   /* Possible states:
223    *
224    *  state   Queue   child  id   nextudpserver  udpsent     tcpfailed
225    *
226    *  tosend  NONE    null   >=0  0              zero        zero
227    *  tosend  udpw    null   >=0  any            nonzero     zero
228    *  tosend  NONE    null   >=0  any            nonzero     zero
229    *
230    *  tcpw    tcpw    null   >=0  irrelevant     any         any
231    *
232    *  child   childw  set    >=0  irrelevant     irrelevant  irrelevant
233    *  child   NONE    null   >=0  irrelevant     irrelevant  irrelevant
234    *  done    output  null   -1   irrelevant     irrelevant  irrelevant
235    *
236    * Queries are only not on a queue when they are actually being processed.
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.
239    *
240    *                          +------------------------+
241    *             START -----> |      tosend/NONE       |
242    *                          +------------------------+
243    *                         /                       |\  \
244    *        too big for UDP /             UDP timeout  \  \ send via UDP
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
260    *                 reply \   _| +------------------+      / reply
261    *                        \     | done/output FAIL |     /
262    *                         \    +------------------+    /
263    *                          \                          /
264    *                           _|                      |_
265    *                             (..... got reply ....)
266    *                              /                   \
267    *        need child query/ies /                     \ no child query
268    *                            /                       \
269    *                          |_                         _|
270    *               +---------------+                   +----------------+
271    *               | childw/childw | ----------------> | done/output OK |
272    *               +---------------+  children done    +----------------+
273    */
274 };
275
276 struct query_queue { adns_query head, tail; };
277
278 struct adns__state {
279   adns_initflags iflags;
280   FILE *diagfile;
281   int configerrno;
282   struct query_queue udpw, tcpw, childw, output;
283   adns_query forallnext;
284   int nextid, udpsocket, tcpsocket;
285   vbuf tcpsend, tcprecv;
286   int nservers, nsortlist, nsearchlist, searchndots, tcpserver, tcprecv_skip;
287   enum adns__tcpstate {
288     server_disconnected, server_connecting,
289     server_ok, server_broken
290   } tcpstate;
291   struct timeval tcptimeout;
292   /* This will have tv_sec==0 if it is not valid.  It will always be
293    * valid if tcpstate _connecting.  When _ok, it will be nonzero if
294    * we are idle (ie, tcpw queue is empty), in which case it is the
295    * absolute time when we will close the connection.
296    */
297   struct sigaction stdsigpipe;
298   sigset_t stdsigmask;
299   struct pollfd pollfds_buf[MAX_POLLFDS];
300   struct server {
301     struct in_addr addr;
302   } servers[MAXSERVERS];
303   struct sortlist {
304     struct in_addr base, mask;
305   } sortlist[MAXSORTLIST];
306   char **searchlist;
307 };
308
309 /* From setup.c: */
310
311 int adns__setnonblock(adns_state ads, int fd); /* => errno value */
312
313 /* From general.c: */
314
315 void adns__vdiag(adns_state ads, const char *pfx, adns_initflags prevent,
316                  int serv, adns_query qu, const char *fmt, va_list al);
317
318 void adns__debug(adns_state ads, int serv, adns_query qu,
319                  const char *fmt, ...) PRINTFFORMAT(4,5);
320 void adns__warn(adns_state ads, int serv, adns_query qu,
321                 const char *fmt, ...) PRINTFFORMAT(4,5);
322 void adns__diag(adns_state ads, int serv, adns_query qu,
323                 const char *fmt, ...) PRINTFFORMAT(4,5);
324
325 int adns__vbuf_ensure(vbuf *vb, int want);
326 int adns__vbuf_appendstr(vbuf *vb, const char *data); /* does not include nul */
327 int adns__vbuf_append(vbuf *vb, const byte *data, int len);
328 /* 1=>success, 0=>realloc failed */
329 void adns__vbuf_appendq(vbuf *vb, const byte *data, int len);
330 void adns__vbuf_init(vbuf *vb);
331 void adns__vbuf_free(vbuf *vb);
332
333 const char *adns__diag_domain(adns_state ads, int serv, adns_query qu,
334                               vbuf *vb, const byte *dgram, int dglen, int cbyte);
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  *
339  * serv may be -1 and qu may be 0.  vb must have been initialised,
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  */
345
346 void adns__isort(void *array, int nobjs, int sz, void *tempbuf,
347                  int (*needswap)(void *context, const void *a, const void *b),
348                  void *context);
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  */
354
355 void adns__sigpipe_protect(adns_state);
356 void 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
360  * any significant amount of code gets to run, since the old signal mask
361  * is stored in the adns structure.
362  */
363
364 /* From transmit.c: */
365
366 adns_status adns__mkquery(adns_state ads, vbuf *vb, int *id_r,
367                           const char *owner, int ol,
368                           const typeinfo *typei, adns_queryflags flags);
369 /* Assembles a query packet in vb.  A new id is allocated and returned.
370  */
371
372 adns_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
379 void 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.
383  */
384
385 void 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,
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.)
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.
393  */
394
395 /* From query.c: */
396
397 adns_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);
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  *
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).
408  *
409  * *ctx is copied byte-for-byte into the query.
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
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.
423  */
424
425 void 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
435 void *adns__alloc_interim(adns_query qu, size_t sz);
436 void *adns__alloc_preserved(adns_query qu, size_t sz);
437 /* Allocates some memory, and records which query it came from
438  * and how much there was.
439  *
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.
444  *
445  * _alloc_interim can fail (and return 0).
446  * The caller must ensure that the query is failed.
447  *
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.
457  */
458
459 void 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.
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.
471  */
472
473 void *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
479 void *adns__alloc_final(adns_query qu, size_t sz);
480 /* Cannot fail, and cannot return 0.
481  */
482
483 void adns__makefinal_block(adns_query qu, void **blpp, size_t sz);
484 void adns__makefinal_str(adns_query qu, char **strp);
485
486 void 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.
492  */
493
494 void adns__query_done(adns_query qu);
495 void adns__query_fail(adns_query qu, adns_status stat);
496
497 /* From reply.c: */
498
499 void adns__procdgram(adns_state ads, const byte *dgram, int len,
500                      int serv, int viatcp, struct timeval now);
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.
505  *
506  * Ie, receiving functions may call sending functions.
507  * Sending functions may NOT call receiving functions.
508  */
509
510 /* From types.c: */
511
512 const typeinfo *adns__findtype(adns_rrtype type);
513
514 /* From parse.c: */
515
516 typedef struct {
517   adns_state ads;
518   adns_query qu;
519   int serv;
520   const byte *dgram;
521   int dglen, max, cbyte, namelen;
522   int *dmend_r;
523 } findlabel_state;
524
525 void adns__findlabel_start(findlabel_state *fls, adns_state ads,
526                            int serv, adns_query qu,
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.
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.
534  */
535
536 adns_status adns__findlabel_next(findlabel_state *fls, int *lablen_r, int *labstart_r);
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
561 typedef enum {
562   pdf_quoteok= 0x001
563 } parsedomain_flags;
564
565 adns_status adns__parse_domain(adns_state ads, int serv, adns_query qu,
566                                vbuf *vb, parsedomain_flags flags,
567                                const byte *dgram, int dglen, int *cbyte_io, int max);
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.
572  *
573  * serv may be -1 and qu may be 0 - they are used for error reporting only.
574  */
575
576 adns_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
585 adns_status adns__findrr(adns_query qu, int serv,
586                          const byte *dgram, int dglen, int *cbyte_io,
587                          int *type_r, int *class_r, unsigned long *ttl_r,
588                          int *rdlen_r, int *rdstart_r,
589                          int *ownermatchedquery_r);
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  *
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.
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
614 adns_status adns__findrr_anychk(adns_query qu, int serv,
615                                 const byte *dgram, int dglen, int *cbyte_io,
616                                 int *type_r, int *class_r, unsigned long *ttl_r,
617                                 int *rdlen_r, int *rdstart_r,
618                                 const byte *eo_dgram, int eo_dglen, int eo_cbyte,
619                                 int *eo_matched_r);
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  */
633
634 void 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
639 int vbuf__append_quoted1035(vbuf *vb, const byte *buf, int len);
640
641 /* From event.c: */
642
643 void adns__tcp_broken(adns_state ads, const char *what, const char *why);
644 /* what and why may be both 0, or both non-0. */
645
646 void adns__tcp_tryconnect(adns_state ads, struct timeval now);
647
648 void adns__autosys(adns_state ads, struct timeval now);
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  */
653
654 void adns__must_gettimeofday(adns_state ads, const struct timeval **now_io,
655                              struct timeval *tv_buf);
656
657 int adns__pollfds(adns_state ads, struct pollfd pollfds_buf[MAX_POLLFDS]);
658 void 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);
663 int adns__internal_check(adns_state ads,
664                          adns_query *query_io,
665                          adns_answer **answer,
666                          void **context_r);
667
668 void 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
675 /* From check.c: */
676
677 void adns__consistency(adns_state ads, adns_query qu, consistency_checks cc);
678
679 /* Useful static inline functions: */
680
681 static inline int ctype_whitespace(int c) { return c==' ' || c=='\n' || c=='\t'; }
682 static inline int ctype_digit(int c) { return c>='0' && c<='9'; }
683 static inline int ctype_alpha(int c) {
684   return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z');
685 }
686 static inline int ctype_822special(int c) { return strchr("()<>@,;:\\\".[]",c) != 0; }
687 static inline int ctype_domainunquoted(int c) {
688   return ctype_alpha(c) || ctype_digit(c) || (strchr("-_/+",c) != 0);
689 }
690
691 static inline int errno_resources(int e) { return e==ENOMEM || e==ENOBUFS; }
692
693 /* Useful macros */
694
695 #define MEM_ROUND(sz) \
696   (( ((sz)+sizeof(union maxalign)-1) / sizeof(union maxalign) ) \
697    * sizeof(union maxalign) )
698
699 #define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ff)
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))
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) )
708
709 #endif