3 * - declarations of private objects with external linkage (adns__*)
4 * - definitons of internal macros
5 * - comments regarding library data structures
9 * Copyright (C) 1997-2000 Ian Jackson <ian@davenant.greenend.org.uk>
11 * It is part of adns, which is
12 * Copyright (C) 1997-2000 Ian Jackson <ian@davenant.greenend.org.uk>
13 * Copyright (C) 1999-2000 Tony Finch <dot@dotat.at>
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)
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.
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.
30 #ifndef ADNS_INTERNAL_H_INCLUDED
31 #define ADNS_INTERNAL_H_INCLUDED
34 typedef unsigned char byte;
49 #ifdef ADNS_REGRESS_TEST
50 # include "hredirect.h"
53 /* Configuration and constants */
56 #define MAXSORTLIST 15
57 #define UDPMAXRETRIES 15
58 #define UDPRETRYMS 2000
59 #define TCPWAITMS 30000
60 #define TCPCONNMS 14000
61 #define TCPIDLEMS 30000
62 #define MAXTTLBELIEVE (7*86400) /* any TTL > 7 days is capped */
65 #define DNS_MAXUDP 512
66 #define DNS_MAXLABEL 63
67 #define DNS_MAXDOMAIN 255
68 #define DNS_HDRSIZE 12
69 #define DNS_IDOFFSET 0
70 #define DNS_CLASS_IN 1
72 #define DNS_INADDR_ARPA "in-addr", "arpa"
74 #define MAX_POLLFDS ADNS_POLLFDS_RECOMMENDED
91 /* Shared data structures */
112 int dglen, nsstart, nscount, arcount;
116 typedef struct typeinfo {
122 void (*makefinal)(adns_query qu, void *data);
123 /* Change memory management of *data.
124 * Previously, used alloc_interim, now use alloc_final.
127 adns_status (*convstring)(vbuf *vb, const void *data);
128 /* Converts the RR data to a string representation in vbuf.
129 * vbuf will be appended to (it must have been initialised),
130 * and will not be null-terminated by convstring.
133 adns_status (*parse)(const parseinfo *pai, int cbyte,
134 int max, void *store_r);
135 /* Parse one RR, in dgram of length dglen, starting at cbyte and
136 * extending until at most max.
138 * The RR should be stored at *store_r, of length qu->typei->rrsz.
140 * If there is an overrun which might indicate truncation, it should set
141 * *rdstart to -1; otherwise it may set it to anything else positive.
143 * nsstart is the offset of the authority section.
146 int (*diff_needswap)(adns_state ads,const void *datap_a,const void *datap_b);
147 /* Returns !0 if RR a should be strictly after RR b in the sort order,
148 * 0 otherwise. Must not fail.
151 adns_status (*qdparselabel)(adns_state ads,
152 const char **p_io, const char *pe, int labelnum,
153 char label_r[DNS_MAXDOMAIN], int *ll_io,
154 adns_queryflags flags,
155 const struct typeinfo *typei);
156 /* Parses one label from the query domain string. On entry, *p_io
157 * points to the next character to parse and *ll_io is the size of
158 * the buffer. pe points just after the end of the query domain
159 * string. On successful return, label_r[] and *ll_io are filled in
160 * and *p_io points to *pe or just after the label-ending `.'. */
162 void (*postsort)(adns_state ads, void *array, int nobjs,
163 const struct typeinfo *typei);
164 /* Called immediately after the RRs have been sorted, and may rearrange
165 * them. (This is really for the benefit of SRV's bizarre weighting
166 * stuff.) May be 0 to mean nothing needs to be done.
170 adns_status adns__qdpl_normal(adns_state ads,
171 const char **p_io, const char *pe, int labelnum,
172 char label_r[], int *ll_io,
173 adns_queryflags flags,
174 const typeinfo *typei);
175 /* implemented in transmit.c, used by types.c as default
176 * and as part of implementation for some fancier types */
178 typedef struct allocnode {
179 struct allocnode *next, *back;
193 void (*callback)(adns_query parent, adns_query child);
195 adns_rr_addr ptr_parent_addr;
196 adns_rr_hostaddr *hostaddr;
202 enum { query_tosend, query_tcpw, query_childw, query_done } state;
203 adns_query back, next, parent;
204 struct { adns_query head, tail; } children;
205 struct { adns_query back, next; } siblings;
206 struct { allocnode *head, *tail; } allocations;
207 int interim_allocd, preserved_allocd;
208 void *final_allocspace;
210 const typeinfo *typei;
215 /* General-purpose messing-about buffer.
216 * Wherever a `big' interface is crossed, this may be corrupted/changed
217 * unless otherwise specified.
221 /* This is allocated when a query is submitted, to avoid being unable
222 * to relate errors to queries if we run out of memory. During
223 * query processing status, rrs is 0. cname is set if
224 * we found a cname (this corresponds to cname_dgram in the query
225 * structure). type is set from the word go. nrrs and rrs
226 * are set together, when we find how many rrs there are.
227 * owner is set during querying unless we're doing searchlist,
228 * in which case it is set only when we find an answer.
232 int cname_dglen, cname_begin;
233 /* If non-0, has been allocated using . */
236 int search_origlen, search_pos, search_doneabs;
237 /* Used by the searching algorithm. The query domain in textual form
238 * is copied into the vbuf, and _origlen set to its length. Then
239 * we walk the searchlist, if we want to. _pos says where we are
240 * (next entry to try), and _doneabs says whether we've done the
241 * absolute query yet (0=not yet, 1=done, -1=must do straight away,
242 * but not done yet). If flags doesn't have adns_qf_search then
243 * the vbuf is initialised but empty and everything else is zero.
246 int id, flags, retries;
248 unsigned long udpsent; /* bitmap indexed by server */
249 struct timeval timeout;
250 time_t expires; /* Earliest expiry time of any record we used. */
256 * state Queue child id nextudpserver udpsent tcpfailed
258 * tosend NONE null >=0 0 zero zero
259 * tosend udpw null >=0 any nonzero zero
260 * tosend NONE null >=0 any nonzero zero
262 * tcpw tcpw null >=0 irrelevant any any
264 * child childw set >=0 irrelevant irrelevant irrelevant
265 * child NONE null >=0 irrelevant irrelevant irrelevant
266 * done output null -1 irrelevant irrelevant irrelevant
268 * Queries are only not on a queue when they are actually being processed.
269 * Queries in state tcpw/tcpw have been sent (or are in the to-send buffer)
270 * iff the tcp connection is in state server_ok.
272 * +------------------------+
273 * START -----> | tosend/NONE |
274 * +------------------------+
276 * too big for UDP / UDP timeout \ \ send via UDP
277 * send via TCP / more retries \ \
278 * when conn'd / desired \ \
281 * +-----------+ +-------------+
282 * | tcpw/tcpw | ________ | tosend/udpw |
283 * +-----------+ \ +-------------+
284 * | | | UDP timeout | |
287 * \ | TCP died | desired | |
289 * \ \ servers | TCP / |
290 * \ \ to try | timeout / |
292 * reply \ _| +------------------+ / reply
293 * \ | done/output FAIL | /
294 * \ +------------------+ /
297 * (..... got reply ....)
299 * need child query/ies / \ no child query
302 * +---------------+ +----------------+
303 * | childw/childw | ----------------> | done/output OK |
304 * +---------------+ children done +----------------+
308 struct query_queue { adns_query head, tail; };
311 adns_initflags iflags;
312 adns_logcallbackfn *logfn;
315 struct query_queue udpw, tcpw, childw, output;
316 adns_query forallnext;
317 int nextid, udpsocket, tcpsocket;
318 vbuf tcpsend, tcprecv;
319 int nservers, nsortlist, nsearchlist, searchndots, tcpserver, tcprecv_skip;
320 enum adns__tcpstate {
321 server_disconnected, server_connecting,
322 server_ok, server_broken
324 struct timeval tcptimeout;
325 /* This will have tv_sec==0 if it is not valid. It will always be
326 * valid if tcpstate _connecting. When _ok, it will be nonzero if
327 * we are idle (ie, tcpw queue is empty), in which case it is the
328 * absolute time when we will close the connection.
330 struct sigaction stdsigpipe;
332 struct pollfd pollfds_buf[MAX_POLLFDS];
335 } servers[MAXSERVERS];
337 struct in_addr base, mask;
338 } sortlist[MAXSORTLIST];
344 int adns__setnonblock(adns_state ads, int fd); /* => errno value */
346 /* From general.c: */
348 void adns__vlprintf(adns_state ads, const char *fmt, va_list al);
349 void adns__lprintf(adns_state ads, const char *fmt,
350 ...) PRINTFFORMAT(2,3);
352 void adns__vdiag(adns_state ads, const char *pfx, adns_initflags prevent,
353 int serv, adns_query qu, const char *fmt, va_list al);
355 void adns__debug(adns_state ads, int serv, adns_query qu,
356 const char *fmt, ...) PRINTFFORMAT(4,5);
357 void adns__warn(adns_state ads, int serv, adns_query qu,
358 const char *fmt, ...) PRINTFFORMAT(4,5);
359 void adns__diag(adns_state ads, int serv, adns_query qu,
360 const char *fmt, ...) PRINTFFORMAT(4,5);
362 int adns__vbuf_ensure(vbuf *vb, int want);
363 int adns__vbuf_appendstr(vbuf *vb, const char *data); /* doesn't include nul */
364 int adns__vbuf_append(vbuf *vb, const byte *data, int len);
365 /* 1=>success, 0=>realloc failed */
366 void adns__vbuf_appendq(vbuf *vb, const byte *data, int len);
367 void adns__vbuf_init(vbuf *vb);
368 void adns__vbuf_free(vbuf *vb);
370 const char *adns__diag_domain(adns_state ads, int serv, adns_query qu,
372 const byte *dgram, int dglen, int cbyte);
373 /* Unpicks a domain in a datagram and returns a string suitable for
374 * printing it as. Never fails - if an error occurs, it will
375 * return some kind of string describing the error.
377 * serv may be -1 and qu may be 0. vb must have been initialised,
378 * and will be left in an arbitrary consistent state.
380 * Returns either vb->buf, or a pointer to a string literal. Do not modify
381 * vb before using the return value.
384 void adns__isort(void *array, int nobjs, int sz, void *tempbuf,
385 int (*needswap)(void *context, const void *a, const void *b),
387 /* Does an insertion sort of array which must contain nobjs objects
388 * each sz bytes long. tempbuf must point to a buffer at least
389 * sz bytes long. needswap should return !0 if a>b (strictly, ie
390 * wrong order) 0 if a<=b (ie, order is fine).
393 void adns__sigpipe_protect(adns_state);
394 void adns__sigpipe_unprotect(adns_state);
395 /* If SIGPIPE protection is not disabled, will block all signals except
396 * SIGPIPE, and set SIGPIPE's disposition to SIG_IGN. (And then restore.)
397 * Each call to _protect must be followed by a call to _unprotect before
398 * any significant amount of code gets to run, since the old signal mask
399 * is stored in the adns structure.
402 /* From transmit.c: */
404 adns_status adns__mkquery(adns_state ads, vbuf *vb, int *id_r,
405 const char *owner, int ol,
406 const typeinfo *typei, adns_queryflags flags);
407 /* Assembles a query packet in vb. A new id is allocated and returned.
410 adns_status adns__mkquery_frdgram(adns_state ads, vbuf *vb, int *id_r,
411 const byte *qd_dgram, int qd_dglen,
413 adns_rrtype type, adns_queryflags flags);
414 /* Same as adns__mkquery, but takes the owner domain from an existing datagram.
415 * That domain must be correct and untruncated.
418 void adns__querysend_tcp(adns_query qu, struct timeval now);
419 /* Query must be in state tcpw/tcpw; it will be sent if possible and
420 * no further processing can be done on it for now. The connection
421 * might be broken, but no reconnect will be attempted.
424 void adns__query_send(adns_query qu, struct timeval now);
425 /* Query must be in state tosend/NONE; it will be moved to a new state,
426 * and no further processing can be done on it for now.
427 * (Resulting state is one of udp/timew, tcpwait/timew (if server not
428 * connected), tcpsent/timew, child/childw or done/output.)
429 * __query_send may decide to use either UDP or TCP depending whether
430 * _qf_usevc is set (or has become set) and whether the query is too
436 adns_status adns__internal_submit(adns_state ads, adns_query *query_r,
437 const typeinfo *typei, vbuf *qumsg_vb,
439 adns_queryflags flags, struct timeval now,
440 const qcontext *ctx);
441 /* Submits a query (for internal use, called during external submits).
443 * The new query is returned in *query_r, or we return adns_s_nomemory.
445 * The query datagram should already have been assembled in qumsg_vb;
446 * the memory for it is _taken over_ by this routine whether it
447 * succeeds or fails (if it succeeds, the vbuf is reused for qu->vb).
449 * *ctx is copied byte-for-byte into the query.
451 * When the child query is done, ctx->callback will be called. The
452 * child will already have been taken off both the global list of
453 * queries in ads and the list of children in the parent. The child
454 * will be freed when the callback returns. The parent will have been
455 * taken off the global childw queue.
457 * The callback should either call adns__query_done, if it is
458 * complete, or adns__query_fail, if an error has occurred, in which
459 * case the other children (if any) will be cancelled. If the parent
460 * has more unfinished children (or has just submitted more) then the
461 * callback may choose to wait for them - it must then put the parent
462 * back on the childw queue.
465 void adns__search_next(adns_state ads, adns_query qu, struct timeval now);
466 /* Walks down the searchlist for a query with adns_qf_search.
467 * The query should have just had a negative response, or not had
468 * any queries sent yet, and should not be on any queue.
469 * The query_dgram if any will be freed and forgotten and a new
470 * one constructed from the search_* members of the query.
472 * Cannot fail (in case of error, calls adns__query_fail).
475 void *adns__alloc_interim(adns_query qu, size_t sz);
476 void *adns__alloc_preserved(adns_query qu, size_t sz);
477 /* Allocates some memory, and records which query it came from
478 * and how much there was.
480 * If an error occurs in the query, all the memory from _interim is
481 * simply freed. If the query succeeds, one large buffer will be made
482 * which is big enough for all these allocations, and then
483 * adns__alloc_final will get memory from this buffer.
485 * _alloc_interim can fail (and return 0).
486 * The caller must ensure that the query is failed.
488 * The memory from _preserved is is kept and transferred into the
489 * larger buffer - unless we run out of memory, in which case it too
490 * is freed. When you use _preserved you have to add code to the
491 * x_nomem error exit case in adns__makefinal_query to clear out the
492 * pointers you made to those allocations, because that's when they're
493 * thrown away; you should also make a note in the declaration of
494 * those pointer variables, to note that they are _preserved rather
495 * than _interim. If they're in the answer, note it here:
496 * answer->cname and answer->owner are _preserved.
499 void adns__transfer_interim(adns_query from, adns_query to,
500 void *block, size_t sz);
501 /* Transfers an interim allocation from one query to another, so that
502 * the `to' query will have room for the data when we get to makefinal
503 * and so that the free will happen when the `to' query is freed
504 * rather than the `from' query.
506 * It is legal to call adns__transfer_interim with a null pointer; this
509 * _transfer_interim also ensures that the expiry time of the `to' query
510 * is no later than that of the `from' query, so that child queries'
511 * TTLs get inherited by their parents.
514 void *adns__alloc_mine(adns_query qu, size_t sz);
515 /* Like _interim, but does not record the length for later
516 * copying into the answer. This just ensures that the memory
517 * will be freed when we're done with the query.
520 void *adns__alloc_final(adns_query qu, size_t sz);
521 /* Cannot fail, and cannot return 0.
524 void adns__makefinal_block(adns_query qu, void **blpp, size_t sz);
525 void adns__makefinal_str(adns_query qu, char **strp);
527 void adns__reset_preserved(adns_query qu);
528 /* Resets all of the memory management stuff etc. to take account of
529 * only the _preserved stuff from _alloc_preserved. Used when we find
530 * an error somewhere and want to just report the error (with perhaps
531 * CNAME, owner, etc. info), and also when we're halfway through RRs
532 * in a datagram and discover that we need to retry the query.
535 void adns__query_done(adns_query qu);
536 void adns__query_fail(adns_query qu, adns_status stat);
540 void adns__procdgram(adns_state ads, const byte *dgram, int len,
541 int serv, int viatcp, struct timeval now);
542 /* This function is allowed to cause new datagrams to be constructed
543 * and sent, or even new queries to be started. However,
544 * query-sending functions are not allowed to call any general event
545 * loop functions in case they accidentally call this.
547 * Ie, receiving functions may call sending functions.
548 * Sending functions may NOT call receiving functions.
553 const typeinfo *adns__findtype(adns_rrtype type);
562 int dglen, max, cbyte, namelen;
566 void adns__findlabel_start(findlabel_state *fls, adns_state ads,
567 int serv, adns_query qu,
568 const byte *dgram, int dglen, int max,
569 int dmbegin, int *dmend_rlater);
570 /* Finds labels in a domain in a datagram.
572 * Call this routine first.
573 * dmend_rlater may be null. ads (and of course fls) may not be.
574 * serv may be -1, qu may be null - they are for error reporting.
577 adns_status adns__findlabel_next(findlabel_state *fls,
578 int *lablen_r, int *labstart_r);
579 /* Then, call this one repeatedly.
581 * It will return adns_s_ok if all is well, and tell you the length
582 * and start of successive labels. labstart_r may be null, but
583 * lablen_r must not be.
585 * After the last label, it will return with *lablen_r zero.
586 * Do not then call it again; instead, just throw away the findlabel_state.
588 * *dmend_rlater will have been set to point to the next part of
589 * the datagram after the label (or after the uncompressed part,
590 * if compression was used). *namelen_rlater will have been set
591 * to the length of the domain name (total length of labels plus
592 * 1 for each intervening dot).
594 * If the datagram appears to be truncated, *lablen_r will be -1.
595 * *dmend_rlater, *labstart_r and *namelen_r may contain garbage.
596 * Do not call _next again.
598 * There may also be errors, in which case *dmend_rlater,
599 * *namelen_rlater, *lablen_r and *labstart_r may contain garbage.
600 * Do not then call findlabel_next again.
607 adns_status adns__parse_domain(adns_state ads, int serv, adns_query qu,
608 vbuf *vb, parsedomain_flags flags,
609 const byte *dgram, int dglen, int *cbyte_io,
611 /* vb must already have been initialised; it will be reset if necessary.
612 * If there is truncation, vb->used will be set to 0; otherwise
613 * (if there is no error) vb will be null-terminated.
614 * If there is an error vb and *cbyte_io may be left indeterminate.
616 * serv may be -1 and qu may be 0 - they are used for error reporting only.
619 adns_status adns__parse_domain_more(findlabel_state *fls, adns_state ads,
620 adns_query qu, vbuf *vb,
621 parsedomain_flags flags,
623 /* Like adns__parse_domain, but you pass it a pre-initialised findlabel_state,
624 * for continuing an existing domain or some such of some kind. Also, unlike
625 * _parse_domain, the domain data will be appended to vb, rather than replacing
626 * the existing contents.
629 adns_status adns__findrr(adns_query qu, int serv,
630 const byte *dgram, int dglen, int *cbyte_io,
631 int *type_r, int *class_r, unsigned long *ttl_r,
632 int *rdlen_r, int *rdstart_r,
633 int *ownermatchedquery_r);
634 /* Finds the extent and some of the contents of an RR in a datagram
635 * and does some checks. The datagram is *dgram, length dglen, and
636 * the RR starts at *cbyte_io (which is updated afterwards to point
637 * to the end of the RR).
639 * The type, class, TTL and RRdata length and start are returned iff
640 * the corresponding pointer variables are not null. type_r, class_r
641 * and ttl_r may not be null. The TTL will be capped.
643 * If ownermatchedquery_r != 0 then the owner domain of this
644 * RR will be compared with that in the query (or, if the query
645 * has gone to a CNAME lookup, with the canonical name).
646 * In this case, *ownermatchedquery_r will be set to 0 or 1.
647 * The query datagram (or CNAME datagram) MUST be valid and not truncated.
649 * If there is truncation then *type_r will be set to -1 and
650 * *cbyte_io, *class_r, *rdlen_r, *rdstart_r and *eo_matched_r will be
653 * qu must obviously be non-null.
655 * If an error is returned then *type_r will be undefined too.
658 adns_status adns__findrr_anychk(adns_query qu, int serv,
659 const byte *dgram, int dglen, int *cbyte_io,
660 int *type_r, int *class_r,
661 unsigned long *ttl_r,
662 int *rdlen_r, int *rdstart_r,
663 const byte *eo_dgram, int eo_dglen,
664 int eo_cbyte, int *eo_matched_r);
665 /* Like adns__findrr_checked, except that the datagram and
666 * owner to compare with can be specified explicitly.
668 * If the caller thinks they know what the owner of the RR ought to
669 * be they can pass in details in eo_*: this is another (or perhaps
670 * the same datagram), and a pointer to where the putative owner
671 * starts in that datagram. In this case *eo_matched_r will be set
672 * to 1 if the datagram matched or 0 if it did not. Either
673 * both eo_dgram and eo_matched_r must both be non-null, or they
674 * must both be null (in which case eo_dglen and eo_cbyte will be ignored).
675 * The eo datagram and contained owner domain MUST be valid and
679 void adns__update_expires(adns_query qu, unsigned long ttl,
681 /* Updates the `expires' field in the query, so that it doesn't exceed
685 int vbuf__append_quoted1035(vbuf *vb, const byte *buf, int len);
689 void adns__tcp_broken(adns_state ads, const char *what, const char *why);
690 /* what and why may be both 0, or both non-0. */
692 void adns__tcp_tryconnect(adns_state ads, struct timeval now);
694 void adns__autosys(adns_state ads, struct timeval now);
695 /* Make all the system calls we want to if the application wants us to.
696 * Must not be called from within adns internal processing functions,
697 * lest we end up in recursive descent !
700 void adns__must_gettimeofday(adns_state ads, const struct timeval **now_io,
701 struct timeval *tv_buf);
703 int adns__pollfds(adns_state ads, struct pollfd pollfds_buf[MAX_POLLFDS]);
704 void adns__fdevents(adns_state ads,
705 const struct pollfd *pollfds, int npollfds,
706 int maxfd, const fd_set *readfds,
707 const fd_set *writefds, const fd_set *exceptfds,
708 struct timeval now, int *r_r);
709 int adns__internal_check(adns_state ads,
710 adns_query *query_io,
711 adns_answer **answer,
714 void adns__timeouts(adns_state ads, int act,
715 struct timeval **tv_io, struct timeval *tvbuf,
717 /* If act is !0, then this will also deal with the TCP connection
718 * if previous events broke it or require it to be connected.
723 void adns__consistency(adns_state ads, adns_query qu, consistency_checks cc);
725 /* Useful static inline functions: */
727 static inline int ctype_whitespace(int c) {
728 return c==' ' || c=='\n' || c=='\t';
730 static inline int ctype_digit(int c) { return c>='0' && c<='9'; }
731 static inline int ctype_alpha(int c) {
732 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z');
734 static inline int ctype_822special(int c) {
735 return strchr("()<>@,;:\\\".[]",c) != 0;
737 static inline int ctype_domainunquoted(int c) {
738 return ctype_alpha(c) || ctype_digit(c) || (strchr("-_/+",c) != 0);
741 static inline int errno_resources(int e) { return e==ENOMEM || e==ENOBUFS; }
745 #define MEM_ROUND(sz) \
746 (( ((sz)+sizeof(union maxalign)-1) / sizeof(union maxalign) ) \
747 * sizeof(union maxalign) )
749 #define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ff)
750 #define GET_B(cb,tv) ((tv)= GETIL_B((cb)))
751 #define GET_W(cb,tv) ((tv)=0,(tv)|=(GETIL_B((cb))<<8), (tv)|=GETIL_B(cb), (tv))
752 #define GET_L(cb,tv) ( (tv)=0, \
753 (tv)|=(GETIL_B((cb))<<24), \
754 (tv)|=(GETIL_B((cb))<<16), \
755 (tv)|=(GETIL_B((cb))<<8), \