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