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