3 * - declarations of private objects with external linkage (adns__*)
4 * - definitons of internal macros
5 * - comments regarding library data structures
8 * This file is part of adns, which is
9 * Copyright (C) 1997-2000,2003,2006,2014 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.)
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 3, or (at your option)
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.
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.
28 #ifndef ADNS_INTERNAL_H_INCLUDED
29 #define ADNS_INTERNAL_H_INCLUDED
32 typedef unsigned char byte;
45 #define ADNS_FEATURE_MANYAF
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 MAX_POLLFDS ADNS_POLLFDS_RECOMMENDED
74 /* Some preprocessor hackery */
76 #define GLUE(x, y) GLUE_(x, y)
77 #define GLUE_(x, y) x##y
79 /* C99 macro `...' must match at least one argument, so the naive definition
80 * `#define CAR(car, ...) car' won't work. But it's easy to arrange for the
81 * tail to be nonempty if we're just going to discard it anyway. */
82 #define CAR(...) CAR_(__VA_ARGS__, _)
83 #define CAR_(car, ...) car
85 /* Extracting the tail of an argument list is rather more difficult. The
86 * following trick is based on one by Laurent Deniau to count the number of
87 * arguments to a macro, simplified in two ways: (a) it only handles up to
88 * eight arguments, and (b) it only needs to distinguish the one-argument
89 * case from many arguments. */
90 #define CDR(...) CDR_(__VA_ARGS__, m, m, m, m, m, m, m, 1, _)(__VA_ARGS__)
91 #define CDR_(_1, _2, _3, _4, _5, _6, _7, _8, n, ...) CDR_##n
93 #define CDR_m(_, ...) __VA_ARGS__
111 adns__qf_addr_answer= 0x01000000,/* addr query received an answer */
112 adns__qf_addr_cname = 0x02000000 /* addr subquery performed on cname */
115 /* Shared data structures */
127 int dglen, nsstart, nscount, arcount;
131 #define MAXREVLABELS 34 /* keep in sync with addrfam! */
132 struct revparse_state {
133 uint16_t labstart[MAXREVLABELS];
134 uint8_t lablen[MAXREVLABELS];
137 union checklabel_state {
138 struct revparse_state ptr;
143 void (*callback)(adns_query parent, adns_query child);
147 adns_rrtype rev_rrtype;
153 } tinfo; /* type-specific state for the query itself: zero-init if you
154 * don't know better. */
157 adns_rr_hostaddr *hostaddr;
158 } pinfo; /* state for use by parent's callback function */
161 typedef struct typeinfo {
167 void (*makefinal)(adns_query qu, void *data);
168 /* Change memory management of *data.
169 * Previously, used alloc_interim, now use alloc_final.
172 adns_status (*convstring)(vbuf *vb, const void *data);
173 /* Converts the RR data to a string representation in vbuf.
174 * vbuf will be appended to (it must have been initialised),
175 * and will not be null-terminated by convstring.
178 adns_status (*parse)(const parseinfo *pai, int cbyte,
179 int max, void *store_r);
180 /* Parse one RR, in dgram of length dglen, starting at cbyte and
181 * extending until at most max.
183 * The RR should be stored at *store_r, of length qu->typei->getrrsz().
185 * If there is an overrun which might indicate truncation, it should set
186 * *rdstart to -1; otherwise it may set it to anything else positive.
188 * nsstart is the offset of the authority section.
191 int (*diff_needswap)(adns_state ads,const void *datap_a,const void *datap_b);
192 /* Returns !0 if RR a should be strictly after RR b in the sort order,
193 * 0 otherwise. Must not fail.
196 adns_status (*checklabel)(adns_state ads, adns_queryflags flags,
197 union checklabel_state *cls, qcontext *ctx,
198 int labnum, const char *dgram,
199 int labstart, int lablen);
200 /* Check a label from the query domain string. The label is not
201 * necessarily null-terminated. The hook can refuse the query's submission
202 * by returning a nonzero status. State can be stored in *cls between
203 * calls, and useful information can be stashed in ctx->tinfo, to be stored
204 * with the query (e.g., it will be available to the parse hook). This
205 * hook can detect a first call because labnum is zero, and a final call
206 * because lablen is zero.
209 void (*postsort)(adns_state ads, void *array, int nrrs, int rrsz,
210 const struct typeinfo *typei);
211 /* Called immediately after the RRs have been sorted, and may rearrange
212 * them. (This is really for the benefit of SRV's bizarre weighting
213 * stuff.) May be 0 to mean nothing needs to be done.
216 int (*getrrsz)(const struct typeinfo *typei, adns_rrtype type);
217 /* Return the output resource-record element size; if this is null, then
218 * the rrsz member can be used.
221 void (*query_send)(adns_query qu, struct timeval now);
222 /* Send the query to nameservers, and hook it into the appropriate queue.
223 * Normal behaviour is to call adns__query_send, but this can be overridden
224 * for special effects.
228 adns_status adns__ckl_hostname(adns_state ads, adns_queryflags flags,
229 union checklabel_state *cls,
230 qcontext *ctx, int labnum,
231 const char *dgram, int labstart, int lablen);
232 /* implemented in query.c, used by types.c as default
233 * and as part of implementation for some fancier types
234 * doesn't require any state */
236 typedef struct allocnode {
237 struct allocnode *next, *back;
252 enum { query_tosend, query_tcpw, query_childw, query_done } state;
253 adns_query back, next, parent;
254 struct { adns_query head, tail; } children;
255 struct { adns_query back, next; } siblings;
256 struct { allocnode *head, *tail; } allocations;
257 int interim_allocd, preserved_allocd;
258 void *final_allocspace;
260 const typeinfo *typei;
265 /* General-purpose messing-about buffer.
266 * Wherever a `big' interface is crossed, this may be corrupted/changed
267 * unless otherwise specified.
271 /* This is allocated when a query is submitted, to avoid being unable
272 * to relate errors to queries if we run out of memory. During
273 * query processing status, rrs is 0. cname is set if
274 * we found a cname (this corresponds to cname_dgram in the query
275 * structure). type is set from the word go. nrrs and rrs
276 * are set together, when we find how many rrs there are.
277 * owner is set during querying unless we're doing searchlist,
278 * in which case it is set only when we find an answer.
282 int cname_dglen, cname_begin;
283 /* If non-0, has been allocated using . */
286 int search_origlen, search_pos, search_doneabs;
287 /* Used by the searching algorithm. The query domain in textual form
288 * is copied into the vbuf, and _origlen set to its length. Then
289 * we walk the searchlist, if we want to. _pos says where we are
290 * (next entry to try), and _doneabs says whether we've done the
291 * absolute query yet (0=not yet, 1=done, -1=must do straight away,
292 * but not done yet). If flags doesn't have adns_qf_search then
293 * the vbuf is initialised but empty and everything else is zero.
296 int id, flags, retries;
298 unsigned long udpsent; /* bitmap indexed by server */
299 struct timeval timeout;
300 time_t expires; /* Earliest expiry time of any record we used. */
306 * state Queue child id nextudpserver udpsent tcpfailed
308 * tosend NONE null >=0 0 zero zero
309 * tosend udpw null >=0 any nonzero zero
310 * tosend NONE null >=0 any nonzero zero
312 * tcpw tcpw null >=0 irrelevant any any
314 * child childw set >=0 irrelevant irrelevant irrelevant
315 * child NONE null >=0 irrelevant irrelevant irrelevant
316 * done output null -1 irrelevant irrelevant irrelevant
318 * Queries are only not on a queue when they are actually being processed.
319 * Queries in state tcpw/tcpw have been sent (or are in the to-send buffer)
320 * iff the tcp connection is in state server_ok.
322 * Internal queries (from adns__submit_internal) end up on intdone
323 * instead of output, and the callbacks are made on the way out of
324 * adns, to avoid reentrancy hazards.
326 * +------------------------+
327 * START -----> | tosend/NONE |
328 * +------------------------+
330 * too big for UDP / UDP timeout \ \ send via UDP
331 * send via TCP / more retries \ \
332 * when conn'd / desired \ \
335 * +-----------+ +-------------+
336 * | tcpw/tcpw | ________ | tosend/udpw |
337 * +-----------+ \ +-------------+
338 * | | | UDP timeout | |
341 * \ | TCP died | desired | |
343 * \ \ servers | TCP / |
344 * \ \ to try | timeout / |
346 * reply \ _| +------------------+ / reply
347 * \ | done/output FAIL | /
348 * \ +------------------+ /
351 * (..... got reply ....)
353 * need child query/ies / \ no child query
356 * +---------------+ +----------------+
357 * | childw/childw | ----------------> | done/output OK |
358 * +---------------+ children done +----------------+
362 struct query_queue { adns_query head, tail; };
367 adns_initflags iflags;
368 adns_logcallbackfn *logfn;
371 struct query_queue udpw, tcpw, childw, output, intdone;
372 adns_query forallnext;
373 int nextid, tcpsocket;
374 struct udpsocket { int af; int fd; } udpsockets[MAXUDP];
376 vbuf tcpsend, tcprecv;
377 int nservers, nsortlist, nsearchlist, searchndots, tcpserver, tcprecv_skip;
378 enum adns__tcpstate {
379 server_disconnected, server_connecting,
380 server_ok, server_broken
382 struct timeval tcptimeout;
383 /* This will have tv_sec==0 if it is not valid. It will always be
384 * valid if tcpstate _connecting. When _ok, it will be nonzero if
385 * we are idle (ie, tcpw queue is empty), in which case it is the
386 * absolute time when we will close the connection.
388 struct sigaction stdsigpipe;
390 struct pollfd pollfds_buf[MAX_POLLFDS];
391 adns_rr_addr servers[MAXSERVERS];
393 adns_sockaddr base, mask;
394 } sortlist[MAXSORTLIST];
396 unsigned short rand48xsubi[3];
399 /* From addrfam.c: */
401 extern int adns__addrs_equal_raw(const struct sockaddr *a,
402 int bf, const void *b);
403 /* Returns nonzero a's family is bf and a's protocol address field
404 * refers to the same protocol address as that stored at ba.
407 extern int adns__addrs_equal(const adns_sockaddr *a,
408 const adns_sockaddr *b);
409 /* Returns nonzero if the two refer to the same protocol address
410 * (disregarding port, IPv6 scope, etc).
413 extern int adns__sockaddrs_equal(const struct sockaddr *sa,
414 const struct sockaddr *sb);
415 /* Return nonzero if the two socket addresses are equal (in all significant
419 extern int adns__addr_width(int af);
420 /* Return the width of addresses of family af, in bits. */
422 extern void adns__prefix_mask(adns_sockaddr *sa, int len);
423 /* Stores in sa's protocol address field an address mask for address
424 * family af, whose first len bits are set and the remainder are
425 * clear. On entry, sa's af field must be set. This is what you want
426 * for converting a prefix length into a netmask.
429 extern int adns__guess_prefix_length(const adns_sockaddr *addr);
430 /* Given a network base address, guess the appropriate prefix length based on
431 * the appropriate rules for the address family (e.g., for IPv4, this uses
432 * the old address classes).
435 extern int adns__addr_matches(int af, const void *addr,
436 const adns_sockaddr *base,
437 const adns_sockaddr *mask);
438 /* Return nonzero if the protocol address specified by af and addr
439 * lies within the network specified by base and mask.
442 extern void adns__addr_inject(const void *a, adns_sockaddr *sa);
443 /* Injects the protocol address *a into the socket adress sa. Assumes
444 * that sa->sa_family is already set correctly.
447 extern const void *adns__sockaddr_addr(const struct sockaddr *sa);
448 /* Returns the address of the protocol address field in sa.
451 char *adns__sockaddr_ntoa(const struct sockaddr *sa, char *buf);
452 /* Converts sa to a string, and writes it to buf, which must be at
453 * least ADNS_ADDR2TEXT_BUFLEN bytes long (unchecked). Returns buf;
457 extern int adns__make_reverse_domain(const struct sockaddr *sa,
459 char **buf_io, size_t bufsz,
461 /* Construct a reverse domain string, given a socket address and a parent
462 * zone. If zone is null, then use the standard reverse-lookup zone for the
463 * address family. If the length of the resulting string is no larger than
464 * bufsz, then the result is stored starting at *buf_io; otherwise a new
465 * buffer is allocated is used, and a pointer to it is stored in both *buf_io
466 * and *buf_free_r (the latter of which should be null on entry). If
467 * something goes wrong, then an errno value is returned: ENOSYS if the
468 * address family of sa isn't recognized, or ENOMEM if the attempt to
469 * allocate an output buffer failed.
472 extern bool adns__revparse_label(struct revparse_state *rps, int labnum,
474 int labstart, int lablen);
475 /* Parse a label in a reverse-domain name, given its index labnum (starting
476 * from zero), a pointer to its contents (which need not be null-terminated),
477 * and its length. The state in *rps is initialized implicitly when labnum
480 * Returns 1 if the parse is proceeding successfully, 0 if the domain
481 * name is definitely invalid and the parse must be abandoned.
484 extern bool adns__revparse_done(struct revparse_state *rps,
485 const char *dgram, int nlabels,
486 adns_rrtype *rrtype_r, adns_sockaddr *addr_r);
487 /* Finishes parsing a reverse-domain name, given the total number of
488 * labels in the name. On success, fills in the af and protocol
489 * address in *addr_r, and the forward query type in *rrtype_r
490 * (because that turns out to be useful). Returns 1 if the parse
496 int adns__setnonblock(adns_state ads, int fd); /* => errno value */
498 /* From general.c: */
500 void adns__vlprintf(adns_state ads, const char *fmt, va_list al);
501 void adns__lprintf(adns_state ads, const char *fmt,
502 ...) PRINTFFORMAT(2,3);
504 void adns__vdiag(adns_state ads, const char *pfx, adns_initflags prevent,
505 int serv, adns_query qu, const char *fmt, va_list al);
507 void adns__debug(adns_state ads, int serv, adns_query qu,
508 const char *fmt, ...) PRINTFFORMAT(4,5);
509 void adns__warn(adns_state ads, int serv, adns_query qu,
510 const char *fmt, ...) PRINTFFORMAT(4,5);
511 void adns__diag(adns_state ads, int serv, adns_query qu,
512 const char *fmt, ...) PRINTFFORMAT(4,5);
514 int adns__vbuf_ensure(vbuf *vb, int want);
515 int adns__vbuf_appendstr(vbuf *vb, const char *data); /* doesn't include nul */
516 int adns__vbuf_append(vbuf *vb, const byte *data, int len);
517 /* 1=>success, 0=>realloc failed */
518 void adns__vbuf_appendq(vbuf *vb, const byte *data, int len);
519 void adns__vbuf_init(vbuf *vb);
520 void adns__vbuf_free(vbuf *vb);
522 const char *adns__diag_domain(adns_state ads, int serv, adns_query qu,
524 const byte *dgram, int dglen, int cbyte);
525 /* Unpicks a domain in a datagram and returns a string suitable for
526 * printing it as. Never fails - if an error occurs, it will
527 * return some kind of string describing the error.
529 * serv may be -1 and qu may be 0. vb must have been initialised,
530 * and will be left in an arbitrary consistent state.
532 * Returns either vb->buf, or a pointer to a string literal. Do not modify
533 * vb before using the return value.
536 int adns__getrrsz_default(const typeinfo *typei, adns_rrtype type);
537 /* Default function for the `getrrsz' type hook; returns the `fixed_rrsz'
538 * value from the typeinfo entry.
541 void adns__isort(void *array, int nobjs, int sz, void *tempbuf,
542 int (*needswap)(void *context, const void *a, const void *b),
544 /* Does an insertion sort of array which must contain nobjs objects
545 * each sz bytes long. tempbuf must point to a buffer at least
546 * sz bytes long. needswap should return !0 if a>b (strictly, ie
547 * wrong order) 0 if a<=b (ie, order is fine).
550 void adns__sigpipe_protect(adns_state);
551 void adns__sigpipe_unprotect(adns_state);
552 /* If SIGPIPE protection is not disabled, will block all signals except
553 * SIGPIPE, and set SIGPIPE's disposition to SIG_IGN. (And then restore.)
554 * Each call to _protect must be followed by a call to _unprotect before
555 * any significant amount of code gets to run, since the old signal mask
556 * is stored in the adns structure.
559 /* From transmit.c: */
561 adns_status adns__mkquery(adns_state ads, vbuf *vb, int *id_r,
562 const char *owner, int ol,
563 const typeinfo *typei, adns_rrtype type,
564 adns_queryflags flags);
565 /* Assembles a query packet in vb. A new id is allocated and returned.
568 adns_status adns__mkquery_frdgram(adns_state ads, vbuf *vb, int *id_r,
569 const byte *qd_dgram, int qd_dglen,
571 adns_rrtype type, adns_queryflags flags);
572 /* Same as adns__mkquery, but takes the owner domain from an existing datagram.
573 * That domain must be correct and untruncated.
576 void adns__querysend_tcp(adns_query qu, struct timeval now);
577 /* Query must be in state tcpw/tcpw; it will be sent if possible and
578 * no further processing can be done on it for now. The connection
579 * might be broken, but no reconnect will be attempted.
582 struct udpsocket *adns__udpsocket_by_af(adns_state ads, int af);
583 /* Find the UDP socket structure in ads which has the given address family.
584 * Return null if there isn't one.
586 * This is used during initialization, so ads is only partially filled in.
587 * The requirements are that nudp is set, and that udpsocket[i].af are
588 * defined for 0<=i<nudp.
591 void adns__query_send(adns_query qu, struct timeval now);
592 /* Query must be in state tosend/NONE; it will be moved to a new state,
593 * and no further processing can be done on it for now.
594 * (Resulting state is one of udp/timew, tcpwait/timew (if server not
595 * connected), tcpsent/timew, child/childw or done/output.)
596 * __query_send may decide to use either UDP or TCP depending whether
597 * _qf_usevc is set (or has become set) and whether the query is too
603 adns_status adns__internal_submit(adns_state ads, adns_query *query_r,
605 const typeinfo *typei, adns_rrtype type,
606 vbuf *qumsg_vb, int id,
607 adns_queryflags flags, struct timeval now,
609 /* Submits a query (for internal use, called during external submits).
611 * The new query is returned in *query_r, or we return adns_s_nomemory.
613 * The query datagram should already have been assembled in qumsg_vb;
614 * the memory for it is _taken over_ by this routine whether it
615 * succeeds or fails (if it succeeds, the vbuf is reused for qu->vb).
617 * *ctx is copied byte-for-byte into the query. Before doing this, its tinfo
618 * field may be modified by type hooks.
620 * When the child query is done, ctx->callback will be called. The
621 * child will already have been taken off both the global list of
622 * queries in ads and the list of children in the parent. The child
623 * will be freed when the callback returns. The parent will have been
624 * taken off the global childw queue.
626 * The callback should either call adns__query_done, if it is
627 * complete, or adns__query_fail, if an error has occurred, in which
628 * case the other children (if any) will be cancelled. If the parent
629 * has more unfinished children (or has just submitted more) then the
630 * callback may choose to wait for them - it must then put the parent
631 * back on the childw queue.
634 void adns__search_next(adns_state ads, adns_query qu, struct timeval now);
635 /* Walks down the searchlist for a query with adns_qf_search.
636 * The query should have just had a negative response, or not had
637 * any queries sent yet, and should not be on any queue.
638 * The query_dgram if any will be freed and forgotten and a new
639 * one constructed from the search_* members of the query.
641 * Cannot fail (in case of error, calls adns__query_fail).
644 void *adns__alloc_interim(adns_query qu, size_t sz);
645 void *adns__alloc_preserved(adns_query qu, size_t sz);
646 /* Allocates some memory, and records which query it came from
647 * and how much there was.
649 * If an error occurs in the query, all the memory from _interim is
650 * simply freed. If the query succeeds, one large buffer will be made
651 * which is big enough for all these allocations, and then
652 * adns__alloc_final will get memory from this buffer.
654 * _alloc_interim can fail (and return 0).
655 * The caller must ensure that the query is failed.
657 * The memory from _preserved is is kept and transferred into the
658 * larger buffer - unless we run out of memory, in which case it too
659 * is freed. When you use _preserved you have to add code to the
660 * x_nomem error exit case in adns__makefinal_query to clear out the
661 * pointers you made to those allocations, because that's when they're
662 * thrown away; you should also make a note in the declaration of
663 * those pointer variables, to note that they are _preserved rather
664 * than _interim. If they're in the answer, note it here:
665 * answer->cname and answer->owner are _preserved.
668 void adns__transfer_interim(adns_query from, adns_query to, void *block);
669 /* Transfers an interim allocation from one query to another, so that
670 * the `to' query will have room for the data when we get to makefinal
671 * and so that the free will happen when the `to' query is freed
672 * rather than the `from' query.
674 * It is legal to call adns__transfer_interim with a null pointer; this
677 * _transfer_interim also ensures that the expiry time of the `to' query
678 * is no later than that of the `from' query, so that child queries'
679 * TTLs get inherited by their parents.
682 void adns__free_interim(adns_query qu, void *p);
683 /* Forget about a block allocated by adns__alloc_interim.
686 void *adns__alloc_mine(adns_query qu, size_t sz);
687 /* Like _interim, but does not record the length for later
688 * copying into the answer. This just ensures that the memory
689 * will be freed when we're done with the query.
692 void *adns__alloc_final(adns_query qu, size_t sz);
693 /* Cannot fail, and cannot return 0.
696 void adns__makefinal_block(adns_query qu, void **blpp, size_t sz);
697 void adns__makefinal_str(adns_query qu, char **strp);
699 void adns__reset_preserved(adns_query qu);
700 /* Resets all of the memory management stuff etc. to take account of
701 * only the _preserved stuff from _alloc_preserved. Used when we find
702 * an error somewhere and want to just report the error (with perhaps
703 * CNAME, owner, etc. info), and also when we're halfway through RRs
704 * in a datagram and discover that we need to retry the query.
707 void adns__cancel(adns_query qu);
708 void adns__query_done(adns_query qu);
709 void adns__query_fail(adns_query qu, adns_status st);
710 void adns__cancel_children(adns_query qu);
712 void adns__returning(adns_state ads, adns_query qu);
713 /* Must be called before returning from adns any time that we have
714 * progressed (including made, finished or destroyed) queries.
716 * Might reenter adns via internal query callbacks, so
717 * external-faciing functions which call adns__returning should
718 * normally be avoided in internal code. */
722 void adns__procdgram(adns_state ads, const byte *dgram, int len,
723 int serv, int viatcp, struct timeval now);
724 /* This function is allowed to cause new datagrams to be constructed
725 * and sent, or even new queries to be started. However,
726 * query-sending functions are not allowed to call any general event
727 * loop functions in case they accidentally call this.
729 * Ie, receiving functions may call sending functions.
730 * Sending functions may NOT call receiving functions.
735 const typeinfo *adns__findtype(adns_rrtype type);
744 int dglen, max, cbyte, namelen;
748 void adns__findlabel_start(findlabel_state *fls, adns_state ads,
749 int serv, adns_query qu,
750 const byte *dgram, int dglen, int max,
751 int dmbegin, int *dmend_rlater);
752 /* Finds labels in a domain in a datagram.
754 * Call this routine first.
755 * dmend_rlater may be null. ads (and of course fls) may not be.
756 * serv may be -1, qu may be null - they are for error reporting.
759 adns_status adns__findlabel_next(findlabel_state *fls,
760 int *lablen_r, int *labstart_r);
761 /* Then, call this one repeatedly.
763 * It will return adns_s_ok if all is well, and tell you the length
764 * and start of successive labels. labstart_r may be null, but
765 * lablen_r must not be.
767 * After the last label, it will return with *lablen_r zero.
768 * Do not then call it again; instead, just throw away the findlabel_state.
770 * *dmend_rlater will have been set to point to the next part of
771 * the datagram after the label (or after the uncompressed part,
772 * if compression was used). *namelen_rlater will have been set
773 * to the length of the domain name (total length of labels plus
774 * 1 for each intervening dot).
776 * If the datagram appears to be truncated, *lablen_r will be -1.
777 * *dmend_rlater, *labstart_r and *namelen_r may contain garbage.
778 * Do not call _next again.
780 * There may also be errors, in which case *dmend_rlater,
781 * *namelen_rlater, *lablen_r and *labstart_r may contain garbage.
782 * Do not then call findlabel_next again.
789 adns_status adns__parse_domain(adns_state ads, int serv, adns_query qu,
790 vbuf *vb, parsedomain_flags flags,
791 const byte *dgram, int dglen, int *cbyte_io,
793 /* vb must already have been initialised; it will be reset if necessary.
794 * If there is truncation, vb->used will be set to 0; otherwise
795 * (if there is no error) vb will be null-terminated.
796 * If there is an error vb and *cbyte_io may be left indeterminate.
798 * serv may be -1 and qu may be 0 - they are used for error reporting only.
801 adns_status adns__parse_domain_more(findlabel_state *fls, adns_state ads,
802 adns_query qu, vbuf *vb,
803 parsedomain_flags flags,
805 /* Like adns__parse_domain, but you pass it a pre-initialised findlabel_state,
806 * for continuing an existing domain or some such of some kind. Also, unlike
807 * _parse_domain, the domain data will be appended to vb, rather than replacing
808 * the existing contents.
811 adns_status adns__findrr(adns_query qu, int serv,
812 const byte *dgram, int dglen, int *cbyte_io,
813 int *type_r, int *class_r, unsigned long *ttl_r,
814 int *rdlen_r, int *rdstart_r,
815 int *ownermatchedquery_r);
816 /* Finds the extent and some of the contents of an RR in a datagram
817 * and does some checks. The datagram is *dgram, length dglen, and
818 * the RR starts at *cbyte_io (which is updated afterwards to point
819 * to the end of the RR).
821 * The type, class, TTL and RRdata length and start are returned iff
822 * the corresponding pointer variables are not null. type_r, class_r
823 * and ttl_r may not be null. The TTL will be capped.
825 * If ownermatchedquery_r != 0 then the owner domain of this
826 * RR will be compared with that in the query (or, if the query
827 * has gone to a CNAME lookup, with the canonical name).
828 * In this case, *ownermatchedquery_r will be set to 0 or 1.
829 * The query datagram (or CNAME datagram) MUST be valid and not truncated.
831 * If there is truncation then *type_r will be set to -1 and
832 * *cbyte_io, *class_r, *rdlen_r, *rdstart_r and *eo_matched_r will be
835 * qu must obviously be non-null.
837 * If an error is returned then *type_r will be undefined too.
840 adns_status adns__findrr_anychk(adns_query qu, int serv,
841 const byte *dgram, int dglen, int *cbyte_io,
842 int *type_r, int *class_r,
843 unsigned long *ttl_r,
844 int *rdlen_r, int *rdstart_r,
845 const byte *eo_dgram, int eo_dglen,
846 int eo_cbyte, int *eo_matched_r);
847 /* Like adns__findrr_checked, except that the datagram and
848 * owner to compare with can be specified explicitly.
850 * If the caller thinks they know what the owner of the RR ought to
851 * be they can pass in details in eo_*: this is another (or perhaps
852 * the same datagram), and a pointer to where the putative owner
853 * starts in that datagram. In this case *eo_matched_r will be set
854 * to 1 if the datagram matched or 0 if it did not. Either
855 * both eo_dgram and eo_matched_r must both be non-null, or they
856 * must both be null (in which case eo_dglen and eo_cbyte will be ignored).
857 * The eo datagram and contained owner domain MUST be valid and
861 void adns__update_expires(adns_query qu, unsigned long ttl,
863 /* Updates the `expires' field in the query, so that it doesn't exceed
867 int vbuf__append_quoted1035(vbuf *vb, const byte *buf, int len);
869 bool adns__labels_equal(const byte *a, int al, const byte *b, int bl);
873 void adns__tcp_broken(adns_state ads, const char *what, const char *why);
874 /* what and why may be both 0, or both non-0. */
876 void adns__tcp_tryconnect(adns_state ads, struct timeval now);
878 void adns__autosys(adns_state ads, struct timeval now);
879 /* Make all the system calls we want to if the application wants us to.
880 * Must not be called from within adns internal processing functions,
881 * lest we end up in recursive descent !
884 void adns__must_gettimeofday(adns_state ads, const struct timeval **now_io,
885 struct timeval *tv_buf);
886 /* Call with care - might reentrantly cause queries to be completed! */
888 int adns__pollfds(adns_state ads, struct pollfd pollfds_buf[MAX_POLLFDS]);
889 void adns__fdevents(adns_state ads,
890 const struct pollfd *pollfds, int npollfds,
891 int maxfd, const fd_set *readfds,
892 const fd_set *writefds, const fd_set *exceptfds,
893 struct timeval now, int *r_r);
894 int adns__internal_check(adns_state ads,
895 adns_query *query_io,
896 adns_answer **answer,
899 void adns__timeouts(adns_state ads, int act,
900 struct timeval **tv_io, struct timeval *tvbuf,
902 /* If act is !0, then this will also deal with the TCP connection
903 * if previous events broke it or require it to be connected.
908 void adns__consistency(adns_state ads, adns_query qu, consistency_checks cc);
910 /* Useful static inline functions: */
912 static inline int ctype_whitespace(int c) {
913 return c==' ' || c=='\n' || c=='\t';
915 static inline int ctype_digit(int c) { return c>='0' && c<='9'; }
916 static inline int ctype_alpha(int c) {
917 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z');
919 static inline int ctype_toupper(int c) {
920 return ctype_alpha(c) ? (c & ~32) : c;
922 static inline int ctype_822special(int c) {
923 return strchr("()<>@,;:\\\".[]",c) != 0;
925 static inline int ctype_domainunquoted(int c) {
926 return ctype_alpha(c) || ctype_digit(c) || (strchr("-_/+",c) != 0);
929 static inline int errno_resources(int e) { return e==ENOMEM || e==ENOBUFS; }
933 #define MEM_ROUND(sz) \
934 (( ((sz)+sizeof(union maxalign)-1) / sizeof(union maxalign) ) \
935 * sizeof(union maxalign) )
937 #define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ff)
938 #define GET_B(cb,tv) ((tv)= GETIL_B((cb)))
939 #define GET_W(cb,tv) ((tv)=0,(tv)|=(GETIL_B((cb))<<8), (tv)|=GETIL_B(cb), (tv))
940 #define GET_L(cb,tv) ( (tv)=0, \
941 (tv)|=(GETIL_B((cb))<<24), \
942 (tv)|=(GETIL_B((cb))<<16), \
943 (tv)|=(GETIL_B((cb))<<8), \