chiark / gitweb /
719a592255c3c0a0f7002b88257bfc73ce5b0845
[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 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   int bug_if_query_done_now;
286   vbuf tcpsend, tcprecv;
287   int nservers, nsortlist, nsearchlist, searchndots, tcpserver, tcprecv_skip;
288   enum adns__tcpstate {
289     server_disconnected, server_connecting,
290     server_ok, server_broken
291   } tcpstate;
292   struct timeval tcptimeout;
293   /* This will have tv_sec==0 if it is not valid.  It will always be
294    * valid if tcpstate _connecting.  When _ok, it will be nonzero if
295    * we are idle (ie, tcpw queue is empty), in which case it is the
296    * absolute time when we will close the connection.
297    */
298   struct sigaction stdsigpipe;
299   sigset_t stdsigmask;
300   struct pollfd pollfds_buf[MAX_POLLFDS];
301   struct server {
302     struct in_addr addr;
303   } servers[MAXSERVERS];
304   struct sortlist {
305     struct in_addr base, mask;
306   } sortlist[MAXSORTLIST];
307   char **searchlist;
308 };
309
310 /* From setup.c: */
311
312 int adns__setnonblock(adns_state ads, int fd); /* => errno value */
313
314 /* From general.c: */
315
316 void adns__vdiag(adns_state ads, const char *pfx, adns_initflags prevent,
317                  int serv, adns_query qu, const char *fmt, va_list al);
318
319 void adns__debug(adns_state ads, int serv, adns_query qu,
320                  const char *fmt, ...) PRINTFFORMAT(4,5);
321 void adns__warn(adns_state ads, int serv, adns_query qu,
322                 const char *fmt, ...) PRINTFFORMAT(4,5);
323 void adns__diag(adns_state ads, int serv, adns_query qu,
324                 const char *fmt, ...) PRINTFFORMAT(4,5);
325
326 int adns__vbuf_ensure(vbuf *vb, int want);
327 int adns__vbuf_appendstr(vbuf *vb, const char *data); /* does not include nul */
328 int adns__vbuf_append(vbuf *vb, const byte *data, int len);
329 /* 1=>success, 0=>realloc failed */
330 void adns__vbuf_appendq(vbuf *vb, const byte *data, int len);
331 void adns__vbuf_init(vbuf *vb);
332 void adns__vbuf_free(vbuf *vb);
333
334 const char *adns__diag_domain(adns_state ads, int serv, adns_query qu,
335                               vbuf *vb, const byte *dgram, int dglen, int cbyte);
336 /* Unpicks a domain in a datagram and returns a string suitable for
337  * printing it as.  Never fails - if an error occurs, it will
338  * return some kind of string describing the error.
339  *
340  * serv may be -1 and qu may be 0.  vb must have been initialised,
341  * and will be left in an arbitrary consistent state.
342  *
343  * Returns either vb->buf, or a pointer to a string literal.  Do not modify
344  * vb before using the return value.
345  */
346
347 void adns__isort(void *array, int nobjs, int sz, void *tempbuf,
348                  int (*needswap)(void *context, const void *a, const void *b),
349                  void *context);
350 /* Does an insertion sort of array which must contain nobjs objects
351  * each sz bytes long.  tempbuf must point to a buffer at least
352  * sz bytes long.  needswap should return !0 if a>b (strictly, ie
353  * wrong order) 0 if a<=b (ie, order is fine).
354  */
355
356 void adns__sigpipe_protect(adns_state);
357 void adns__sigpipe_unprotect(adns_state);
358 /* If SIGPIPE protection is not disabled, will block all signals except
359  * SIGPIPE, and set SIGPIPE's disposition to SIG_IGN.  (And then restore.)
360  * Each call to _protect must be followed by a call to _unprotect before
361  * any significant amount of code gets to run, since the old signal mask
362  * is stored in the adns structure.
363  */
364
365 /* From transmit.c: */
366
367 adns_status adns__mkquery(adns_state ads, vbuf *vb, int *id_r,
368                           const char *owner, int ol,
369                           const typeinfo *typei, adns_queryflags flags);
370 /* Assembles a query packet in vb.  A new id is allocated and returned.
371  */
372
373 adns_status adns__mkquery_frdgram(adns_state ads, vbuf *vb, int *id_r,
374                                   const byte *qd_dgram, int qd_dglen, int qd_begin,
375                                   adns_rrtype type, adns_queryflags flags);
376 /* Same as adns__mkquery, but takes the owner domain from an existing datagram.
377  * That domain must be correct and untruncated.
378  */
379
380 void adns__querysend_tcp(adns_query qu, struct timeval now);
381 /* Query must be in state tcpw/tcpw; it will be sent if possible and
382  * no further processing can be done on it for now.  The connection
383  * might be broken, but no reconnect will be attempted.
384  */
385
386 void adns__query_send(adns_query qu, struct timeval now);
387 /* Query must be in state tosend/NONE; it will be moved to a new state,
388  * and no further processing can be done on it for now.
389  * (Resulting state is one of udp/timew, tcpwait/timew (if server not connected),
390  *  tcpsent/timew, child/childw or done/output.)
391  * __query_send may decide to use either UDP or TCP depending whether
392  * _qf_usevc is set (or has become set) and whether the query is too
393  * large.
394  */
395
396 /* From query.c: */
397
398 adns_status adns__internal_submit(adns_state ads, adns_query *query_r,
399                                   const typeinfo *typei, vbuf *qumsg_vb, int id,
400                                   adns_queryflags flags, struct timeval now,
401                                   const qcontext *ctx);
402 /* Submits a query (for internal use, called during external submits).
403  *
404  * The new query is returned in *query_r, or we return adns_s_nomemory.
405  *
406  * The query datagram should already have been assembled in qumsg_vb;
407  * the memory for it is _taken over_ by this routine whether it
408  * succeeds or fails (if it succeeds, the vbuf is reused for qu->vb).
409  *
410  * *ctx is copied byte-for-byte into the query.
411  *
412  * When the child query is done, ctx->callback will be called.  The
413  * child will already have been taken off both the global list of
414  * queries in ads and the list of children in the parent.  The child
415  * will be freed when the callback returns.  The parent will have been
416  * taken off the global childw queue.
417  *
418  * The callback should either call adns__query_done, if it is
419  * complete, or adns__query_fail, if an error has occurred, in which
420  * case the other children (if any) will be cancelled.  If the parent
421  * has more unfinished children (or has just submitted more) then the
422  * callback may choose to wait for them - it must then put the parent
423  * back on the childw queue.
424  */
425
426 void adns__search_next(adns_state ads, adns_query qu, struct timeval now);
427 /* Walks down the searchlist for a query with adns_qf_search.
428  * The query should have just had a negative response, or not had
429  * any queries sent yet, and should not be on any queue.
430  * The query_dgram if any will be freed and forgotten and a new
431  * one constructed from the search_* members of the query.
432  *
433  * Cannot fail (in case of error, calls adns__query_fail).
434  */
435
436 void *adns__alloc_interim(adns_query qu, size_t sz);
437 void *adns__alloc_preserved(adns_query qu, size_t sz);
438 /* Allocates some memory, and records which query it came from
439  * and how much there was.
440  *
441  * If an error occurs in the query, all the memory from _interim is
442  * simply freed.  If the query succeeds, one large buffer will be made
443  * which is big enough for all these allocations, and then
444  * adns__alloc_final will get memory from this buffer.
445  *
446  * _alloc_interim can fail (and return 0).
447  * The caller must ensure that the query is failed.
448  *
449  * The memory from _preserved is is kept and transferred into the
450  * larger buffer - unless we run out of memory, in which case it too
451  * is freed.  When you use _preserved you have to add code to the
452  * x_nomem error exit case in adns__makefinal_query to clear out the
453  * pointers you made to those allocations, because that's when they're
454  * thrown away; you should also make a note in the declaration of
455  * those pointer variables, to note that they are _preserved rather
456  * than _interim.  If they're in the answer, note it here:
457  *  answer->cname and answer->owner are _preserved.
458  */
459
460 void adns__transfer_interim(adns_query from, adns_query to, void *block, size_t sz);
461 /* Transfers an interim allocation from one query to another, so that
462  * the `to' query will have room for the data when we get to makefinal
463  * and so that the free will happen when the `to' query is freed
464  * rather than the `from' query.
465  *
466  * It is legal to call adns__transfer_interim with a null pointer; this
467  * has no effect.
468  *
469  * _transfer_interim also ensures that the expiry time of the `to' query
470  * is no later than that of the `from' query, so that child queries'
471  * TTLs get inherited by their parents.
472  */
473
474 void *adns__alloc_mine(adns_query qu, size_t sz);
475 /* Like _interim, but does not record the length for later
476  * copying into the answer.  This just ensures that the memory
477  * will be freed when we're done with the query.
478  */
479
480 void *adns__alloc_final(adns_query qu, size_t sz);
481 /* Cannot fail, and cannot return 0.
482  */
483
484 void adns__makefinal_block(adns_query qu, void **blpp, size_t sz);
485 void adns__makefinal_str(adns_query qu, char **strp);
486
487 void adns__reset_preserved(adns_query qu);
488 /* Resets all of the memory management stuff etc. to take account of
489  * only the _preserved stuff from _alloc_preserved.  Used when we find
490  * an error somewhere and want to just report the error (with perhaps
491  * CNAME, owner, etc. info), and also when we're halfway through RRs
492  * in a datagram and discover that we need to retry the query.
493  */
494
495 void adns__query_done(adns_query qu);
496 void adns__query_fail(adns_query qu, adns_status stat);
497
498 /* From reply.c: */
499
500 void adns__procdgram(adns_state ads, const byte *dgram, int len,
501                      int serv, int viatcp, struct timeval now);
502 /* This function is allowed to cause new datagrams to be constructed
503  * and sent, or even new queries to be started.  However,
504  * query-sending functions are not allowed to call any general event
505  * loop functions in case they accidentally call this.
506  *
507  * Ie, receiving functions may call sending functions.
508  * Sending functions may NOT call receiving functions.
509  */
510
511 /* From types.c: */
512
513 const typeinfo *adns__findtype(adns_rrtype type);
514
515 /* From parse.c: */
516
517 typedef struct {
518   adns_state ads;
519   adns_query qu;
520   int serv;
521   const byte *dgram;
522   int dglen, max, cbyte, namelen;
523   int *dmend_r;
524 } findlabel_state;
525
526 void adns__findlabel_start(findlabel_state *fls, adns_state ads,
527                            int serv, adns_query qu,
528                            const byte *dgram, int dglen, int max,
529                            int dmbegin, int *dmend_rlater);
530 /* Finds labels in a domain in a datagram.
531  *
532  * Call this routine first.
533  * dmend_rlater may be null.  ads (and of course fls) may not be.
534  * serv may be -1, qu may be null - they are for error reporting.
535  */
536
537 adns_status adns__findlabel_next(findlabel_state *fls, int *lablen_r, int *labstart_r);
538 /* Then, call this one repeatedly.
539  *
540  * It will return adns_s_ok if all is well, and tell you the length
541  * and start of successive labels.  labstart_r may be null, but
542  * lablen_r must not be.
543  *
544  * After the last label, it will return with *lablen_r zero.
545  * Do not then call it again; instead, just throw away the findlabel_state.
546  *
547  * *dmend_rlater will have been set to point to the next part of
548  * the datagram after the label (or after the uncompressed part,
549  * if compression was used).  *namelen_rlater will have been set
550  * to the length of the domain name (total length of labels plus
551  * 1 for each intervening dot).
552  *
553  * If the datagram appears to be truncated, *lablen_r will be -1.
554  * *dmend_rlater, *labstart_r and *namelen_r may contain garbage.
555  * Do not call _next again.
556  *
557  * There may also be errors, in which case *dmend_rlater,
558  * *namelen_rlater, *lablen_r and *labstart_r may contain garbage.
559  * Do not then call findlabel_next again.
560  */
561
562 typedef enum {
563   pdf_quoteok= 0x001
564 } parsedomain_flags;
565
566 adns_status adns__parse_domain(adns_state ads, int serv, adns_query qu,
567                                vbuf *vb, parsedomain_flags flags,
568                                const byte *dgram, int dglen, int *cbyte_io, int max);
569 /* vb must already have been initialised; it will be reset if necessary.
570  * If there is truncation, vb->used will be set to 0; otherwise
571  * (if there is no error) vb will be null-terminated.
572  * If there is an error vb and *cbyte_io may be left indeterminate.
573  *
574  * serv may be -1 and qu may be 0 - they are used for error reporting only.
575  */
576
577 adns_status adns__parse_domain_more(findlabel_state *fls, adns_state ads,
578                                     adns_query qu, vbuf *vb, parsedomain_flags flags,
579                                     const byte *dgram);
580 /* Like adns__parse_domain, but you pass it a pre-initialised findlabel_state,
581  * for continuing an existing domain or some such of some kind.  Also, unlike
582  * _parse_domain, the domain data will be appended to vb, rather than replacing
583  * the existing contents.
584  */
585
586 adns_status adns__findrr(adns_query qu, int serv,
587                          const byte *dgram, int dglen, int *cbyte_io,
588                          int *type_r, int *class_r, unsigned long *ttl_r,
589                          int *rdlen_r, int *rdstart_r,
590                          int *ownermatchedquery_r);
591 /* Finds the extent and some of the contents of an RR in a datagram
592  * and does some checks.  The datagram is *dgram, length dglen, and
593  * the RR starts at *cbyte_io (which is updated afterwards to point
594  * to the end of the RR).
595  *
596  * The type, class, TTL and RRdata length and start are returned iff
597  * the corresponding pointer variables are not null.  type_r, class_r
598  * and ttl_r may not be null.  The TTL will be capped.
599  *
600  * If ownermatchedquery_r != 0 then the owner domain of this
601  * RR will be compared with that in the query (or, if the query
602  * has gone to a CNAME lookup, with the canonical name).
603  * In this case, *ownermatchedquery_r will be set to 0 or 1.
604  * The query datagram (or CNAME datagram) MUST be valid and not truncated.
605  *
606  * If there is truncation then *type_r will be set to -1 and
607  * *cbyte_io, *class_r, *rdlen_r, *rdstart_r and *eo_matched_r will be
608  * undefined.
609  *
610  * qu must obviously be non-null.
611  *
612  * If an error is returned then *type_r will be undefined too.
613  */
614
615 adns_status adns__findrr_anychk(adns_query qu, int serv,
616                                 const byte *dgram, int dglen, int *cbyte_io,
617                                 int *type_r, int *class_r, unsigned long *ttl_r,
618                                 int *rdlen_r, int *rdstart_r,
619                                 const byte *eo_dgram, int eo_dglen, int eo_cbyte,
620                                 int *eo_matched_r);
621 /* Like adns__findrr_checked, except that the datagram and
622  * owner to compare with can be specified explicitly.
623  *
624  * If the caller thinks they know what the owner of the RR ought to
625  * be they can pass in details in eo_*: this is another (or perhaps
626  * the same datagram), and a pointer to where the putative owner
627  * starts in that datagram.  In this case *eo_matched_r will be set
628  * to 1 if the datagram matched or 0 if it did not.  Either
629  * both eo_dgram and eo_matched_r must both be non-null, or they
630  * must both be null (in which case eo_dglen and eo_cbyte will be ignored).
631  * The eo datagram and contained owner domain MUST be valid and
632  * untruncated.
633  */
634
635 void adns__update_expires(adns_query qu, unsigned long ttl, struct timeval now);
636 /* Updates the `expires' field in the query, so that it doesn't exceed
637  * now + ttl.
638  */
639
640 int vbuf__append_quoted1035(vbuf *vb, const byte *buf, int len);
641
642 /* From event.c: */
643
644 void adns__tcp_broken(adns_state ads, const char *what, const char *why);
645 /* what and why may be both 0, or both non-0. */
646
647 void adns__tcp_tryconnect(adns_state ads, struct timeval now);
648
649 void adns__autosys(adns_state ads, struct timeval now);
650 /* Make all the system calls we want to if the application wants us to.
651  * Must not be called from within adns internal processing functions,
652  * lest we end up in recursive descent !
653  */
654
655 void adns__must_gettimeofday(adns_state ads, const struct timeval **now_io,
656                              struct timeval *tv_buf);
657
658 int adns__pollfds(adns_state ads, struct pollfd pollfds_buf[MAX_POLLFDS]);
659 void adns__fdevents(adns_state ads,
660                     const struct pollfd *pollfds, int npollfds,
661                     int maxfd, const fd_set *readfds,
662                     const fd_set *writefds, const fd_set *exceptfds,
663                     struct timeval now, int *r_r);
664 int adns__internal_check(adns_state ads,
665                          adns_query *query_io,
666                          adns_answer **answer,
667                          void **context_r);
668
669 void adns__timeouts(adns_state ads, int act,
670                     struct timeval **tv_io, struct timeval *tvbuf,
671                     struct timeval now);
672 /* If act is !0, then this will also deal with the TCP connection
673  * if previous events broke it or require it to be connected.
674  */
675
676 /* From check.c: */
677
678 void adns__consistency(adns_state ads, adns_query qu, consistency_checks cc);
679
680 /* Useful static inline functions: */
681
682 static inline int ctype_whitespace(int c) { return c==' ' || c=='\n' || c=='\t'; }
683 static inline int ctype_digit(int c) { return c>='0' && c<='9'; }
684 static inline int ctype_alpha(int c) {
685   return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z');
686 }
687 static inline int ctype_822special(int c) { return strchr("()<>@,;:\\\".[]",c) != 0; }
688 static inline int ctype_domainunquoted(int c) {
689   return ctype_alpha(c) || ctype_digit(c) || (strchr("-_/+",c) != 0);
690 }
691
692 static inline int errno_resources(int e) { return e==ENOMEM || e==ENOBUFS; }
693
694 /* Useful macros */
695
696 #define MEM_ROUND(sz) \
697   (( ((sz)+sizeof(union maxalign)-1) / sizeof(union maxalign) ) \
698    * sizeof(union maxalign) )
699
700 #define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ff)
701 #define GET_B(cb,tv) ((tv)= GETIL_B((cb)))
702 #define GET_W(cb,tv) ((tv)=0, (tv)|=(GETIL_B((cb))<<8), (tv)|=GETIL_B(cb), (tv))
703 #define GET_L(cb,tv) ( (tv)=0, \
704                        (tv)|=(GETIL_B((cb))<<24), \
705                        (tv)|=(GETIL_B((cb))<<16), \
706                        (tv)|=(GETIL_B((cb))<<8), \
707                        (tv)|=GETIL_B(cb), \
708                        (tv) )
709
710 #endif