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 Copyright (C) 1997-1999 Ian Jackson
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)
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.
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.
25 #ifndef ADNS_INTERNAL_H_INCLUDED
26 #define ADNS_INTERNAL_H_INCLUDED
29 typedef unsigned char byte;
40 /* Configuration and constants */
43 #define MAXSORTLIST 15
44 #define UDPMAXRETRIES 15
45 #define UDPRETRYMS 2000
47 #define LOCALRESOURCEMS 20
48 #define MAXTTLBELIEVE (7*86400) /* any TTL > 7 days is capped */
51 #define DNS_MAXUDP 512
52 #define DNS_MAXDOMAIN 255
53 #define DNS_HDRSIZE 12
54 #define DNS_CLASS_IN 1
56 #define DNS_INADDR_ARPA "in-addr", "arpa"
67 /* Shared data structures */
88 int dglen, nsstart, nscount, arcount;
98 void (*makefinal)(adns_query qu, void *data);
99 /* Change memory management of *data.
100 * Previously, used alloc_interim, now use alloc_final.
103 adns_status (*convstring)(vbuf *vb, const void *data);
104 /* Converts the RR data to a string representation in vbuf.
105 * vbuf will be appended to (it must have been initialised),
106 * and will not be null-terminated by convstring.
109 adns_status (*parse)(const parseinfo *pai, int cbyte, int max, void *store_r);
110 /* Parse one RR, in dgram of length dglen, starting at cbyte and
111 * extending until at most max.
113 * The RR should be stored at *store_r, of length qu->typei->rrsz.
115 * If there is an overrun which might indicate truncation, it should set
116 * *rdstart to -1; otherwise it may set it to anything else positive.
118 * nsstart is the offset of the authority section.
121 int (*diff_needswap)(adns_state ads, const void *datap_a, const void *datap_b);
122 /* Returns !0 if RR a should be strictly after RR b in the sort order,
123 * 0 otherwise. Must not fail.
127 typedef struct allocnode {
128 struct allocnode *next, *back;
142 void (*callback)(adns_query parent, adns_query child);
144 adns_rr_addr ptr_parent_addr;
145 adns_rr_hostaddr *hostaddr;
151 enum { query_udp, query_tcpwait, query_tcpsent, query_child, query_done } state;
152 adns_query back, next, parent;
153 struct { adns_query head, tail; } children;
154 struct { adns_query back, next; } siblings;
155 struct { allocnode *head, *tail; } allocations;
157 void *final_allocspace;
159 const typeinfo *typei;
164 /* General-purpose messing-about buffer.
165 * Wherever a `big' interface is crossed, this may be corrupted/changed
166 * unless otherwise specified.
170 /* This is allocated when a query is submitted, to avoid being unable
171 * to relate errors to queries if we run out of memory. During
172 * query processing status, rrs is 0. cname is set if
173 * we found a cname (this corresponds to cname_dgram in the query
174 * structure). type is set from the word go. nrrs and rrs
175 * are set together, when we find how many rrs there are.
179 int cname_dglen, cname_begin;
180 /* If non-0, has been allocated using . */
183 int search_origlen, search_pos, search_doneabs;
184 /* Used by the searching algorithm. The query domain in textual form
185 * is copied into the vbuf, and _origlen set to its length. Then
186 * we walk the searchlist, if we want to. _pos says where we are
187 * (next entry to try), and _doneabs says whether we've done the
188 * absolute query yet. If flags doesn't have adns_qf_search then
189 * the vbuf is initialised but empty and everything else is zero.
191 * fixme: actually implement this!
194 int id, flags, udpretries;
196 unsigned long udpsent, tcpfailed; /* bitmap indexed by server */
197 struct timeval timeout;
198 time_t expires; /* Earliest expiry time of any record we used. */
204 * state Queue child id nextudpserver sentudp failedtcp
206 * udp NONE null >=0 0 zero zero
207 * udp timew null >=0 any nonzero zero
208 * udp NONE null >=0 any nonzero zero
210 * tcpwait timew null >=0 irrelevant zero any
211 * tcpsent timew null >=0 irrelevant zero any
213 * child childw set >=0 irrelevant irrelevant irrelevant
214 * done output null -1 irrelevant irrelevant irrelevant
216 * +------------------------+
217 * START -----> | udp/NONE |
218 * +------------------------+
220 * too big for UDP / UDP timeout \ \ send via UDP
221 * do this ASAP! / more retries \ \ do this ASAP!
223 * +---------------+ +-----------+
224 * | tcpwait/timew | ____ | udp/timew |
225 * +---------------+ \ +-----------+
227 * TCP conn'd; | | TCP died | | |
228 * send via TCP | | more | UDP timeout | |
229 * do this ASAP! | | servers | no more | |
230 * v | to try | retries | |
231 * +---------------+ | desired | |
232 * | tcpsent/timew | ____ | | |
233 * +---------------+ \| | |
234 * \ \ TCP died | TCP | |
235 * \ \ no more | timeout / |
239 * reply \ _| +------------------+ / reply
240 * \ | done/output FAIL | /
241 * \ +------------------+ /
244 * (..... got reply ....)
246 * need child query/ies / \ no child query
249 * +--------------+ +----------------+
250 * | child/childw | ----------------> | done/output OK |
251 * +--------------+ children done +----------------+
256 adns_initflags iflags;
259 struct { adns_query head, tail; } timew, childw, output;
260 int nextid, udpsocket, tcpsocket;
261 vbuf tcpsend, tcprecv;
262 int nservers, nsortlist, nsearchlist, tcpserver;
263 enum adns__tcpstate { server_disconnected, server_connecting, server_ok } tcpstate;
264 struct timeval tcptimeout;
265 struct sigaction stdsigpipe;
269 } servers[MAXSERVERS];
271 struct in_addr base, mask;
272 } sortlist[MAXSORTLIST];
278 int adns__setnonblock(adns_state ads, int fd); /* => errno value */
280 /* From general.c: */
282 void adns__vdiag(adns_state ads, const char *pfx, adns_initflags prevent,
283 int serv, adns_query qu, const char *fmt, va_list al);
285 void adns__debug(adns_state ads, int serv, adns_query qu,
286 const char *fmt, ...) PRINTFFORMAT(4,5);
287 void adns__warn(adns_state ads, int serv, adns_query qu,
288 const char *fmt, ...) PRINTFFORMAT(4,5);
289 void adns__diag(adns_state ads, int serv, adns_query qu,
290 const char *fmt, ...) PRINTFFORMAT(4,5);
292 int adns__vbuf_ensure(vbuf *vb, int want);
293 int adns__vbuf_appendstr(vbuf *vb, const char *data); /* does not include nul */
294 int adns__vbuf_append(vbuf *vb, const byte *data, int len);
295 /* 1=>success, 0=>realloc failed */
296 void adns__vbuf_appendq(vbuf *vb, const byte *data, int len);
297 void adns__vbuf_init(vbuf *vb);
298 void adns__vbuf_free(vbuf *vb);
300 const char *adns__diag_domain(adns_state ads, int serv, adns_query qu,
301 vbuf *vb, const byte *dgram, int dglen, int cbyte);
302 /* Unpicks a domain in a datagram and returns a string suitable for
303 * printing it as. Never fails - if an error occurs, it will
304 * return some kind of string describing the error.
306 * serv may be -1 and qu may be 0. vb must have been initialised,
307 * and will be left in an arbitrary consistent state.
309 * Returns either vb->buf, or a pointer to a string literal. Do not modify
310 * vb before using the return value.
313 void adns__isort(void *array, int nobjs, int sz, void *tempbuf,
314 int (*needswap)(void *context, const void *a, const void *b),
316 /* Does an insertion sort of array which must contain nobjs objects
317 * each sz bytes long. tempbuf must point to a buffer at least
318 * sz bytes long. needswap should return !0 if a>b (strictly, ie
319 * wrong order) 0 if a<=b (ie, order is fine).
322 void adns__sigpipe_protect(adns_state);
323 void adns__sigpipe_unprotect(adns_state);
324 /* If SIGPIPE protection is not disabled, will block all signals except
325 * SIGPIPE, and set SIGPIPE's disposition to SIG_IGN. (And then restore.)
326 * Each call to _protect must be followed by a call to _unprotect before
327 * any significant amount of code gets to run.
330 /* From transmit.c: */
332 adns_status adns__mkquery(adns_state ads, vbuf *vb, int *id_r,
333 const char *owner, int ol,
334 const typeinfo *typei, adns_queryflags flags);
335 /* Assembles a query packet in vb, and returns id at *id_r. */
337 adns_status adns__mkquery_frdgram(adns_state ads, vbuf *vb, int *id_r,
338 const byte *qd_dgram, int qd_dglen, int qd_begin,
339 adns_rrtype type, adns_queryflags flags);
340 /* Same as adns__mkquery, but takes the owner domain from an existing datagram.
341 * That domain must be correct and untruncated.
344 void adns__query_tcp(adns_query qu, struct timeval now);
345 /* Query must be in state tcpwait/timew; it will be moved to a new state
346 * if possible and no further processing can be done on it for now.
347 * (Resulting state is one of tcpwait/timew (if server not connected),
348 * tcpsent/timew, child/childw or done/output.)
350 * adns__tcp_tryconnect should already have been called - _tcp
351 * will only use an existing connection (if there is one), which it
352 * may break. If the conn list lost then the caller is responsible for any
353 * reestablishment and retry.
356 void adns__query_udp(adns_query qu, struct timeval now);
357 /* Query must be in state udp/NONE; it will be moved to a new state,
358 * and no further processing can be done on it for now.
359 * (Resulting state is one of udp/timew, tcpwait/timew (if server not connected),
360 * tcpsent/timew, child/childw or done/output.)
365 int adns__internal_submit(adns_state ads, adns_query *query_r,
366 const typeinfo *typei, vbuf *qumsg_vb, int id,
367 adns_queryflags flags, struct timeval now,
368 adns_status failstat, const qcontext *ctx);
369 /* Submits a query (for internal use, called during external submits).
371 * The new query is returned in *query_r, or we return adns_s_nomemory.
373 * The query datagram should already have been assembled in qumsg_vb;
374 * the memory for it is _taken over_ by this routine whether it
375 * succeeds or fails (if it succeeds, the vbuf is reused for qu->vb).
377 * If failstat is nonzero then if we are successful in creating the query
378 * it is immediately failed with code failstat (but _submit still succeds).
380 * *ctx is copied byte-for-byte into the query.
383 void *adns__alloc_interim(adns_query qu, size_t sz);
384 /* Allocates some memory, and records which query it came from
385 * and how much there was.
387 * If an error occurs in the query, all its memory is simply freed.
389 * If the query succeeds, one large buffer will be made which is
390 * big enough for all these allocations, and then adns__alloc_final
391 * will get memory from this buffer.
393 * _alloc_interim can fail (and return 0).
394 * The caller must ensure that the query is failed.
396 * adns__alloc_interim_{only,fail}(qu,0) will not return 0,
397 * but it will not necessarily return a distinct pointer each time.
400 void adns__transfer_interim(adns_query from, adns_query to, void *block, size_t sz);
401 /* Transfers an interim allocation from one query to another, so that
402 * the `to' query will have room for the data when we get to makefinal
403 * and so that the free will happen when the `to' query is freed
404 * rather than the `from' query.
406 * It is legal to call adns__transfer_interim with a null pointer; this
409 * _transfer_interim also ensures that the expiry time of the `to' query
410 * is no later than that of the `from' query, so that child queries'
411 * TTLs get inherited by their parents.
414 void *adns__alloc_mine(adns_query qu, size_t sz);
415 /* Like _interim, but does not record the length for later
416 * copying into the answer. This just ensures that the memory
417 * will be freed when we're done with the query.
420 void *adns__alloc_final(adns_query qu, size_t sz);
421 /* Cannot fail, and cannot return 0.
424 void adns__makefinal_block(adns_query qu, void **blpp, size_t sz);
425 void adns__makefinal_str(adns_query qu, char **strp);
427 void adns__reset_cnameonly(adns_query qu);
428 /* Resets all of the memory management stuff etc. to
429 * take account of only the CNAME. Used when we find an error somewhere
430 * and want to just report the error (with perhaps CNAME info), and also
431 * when we're halfway through RRs in a datagram and discover that we
432 * need to retry the query.
435 void adns__query_done(adns_query qu);
436 void adns__query_fail(adns_query qu, adns_status stat);
440 void adns__procdgram(adns_state ads, const byte *dgram, int len,
441 int serv, struct timeval now);
445 const typeinfo *adns__findtype(adns_rrtype type);
454 int dglen, max, cbyte, namelen;
458 void adns__findlabel_start(findlabel_state *fls, adns_state ads,
459 int serv, adns_query qu,
460 const byte *dgram, int dglen, int max,
461 int dmbegin, int *dmend_rlater);
462 /* Finds labels in a domain in a datagram.
464 * Call this routine first.
465 * dmend_rlater may be null. ads (and of course fls) may not be.
466 * serv may be -1, qu may be null - they are for error reporting.
469 adns_status adns__findlabel_next(findlabel_state *fls, int *lablen_r, int *labstart_r);
470 /* Then, call this one repeatedly.
472 * It will return adns_s_ok if all is well, and tell you the length
473 * and start of successive labels. labstart_r may be null, but
474 * lablen_r must not be.
476 * After the last label, it will return with *lablen_r zero.
477 * Do not then call it again; instead, just throw away the findlabel_state.
479 * *dmend_rlater will have been set to point to the next part of
480 * the datagram after the label (or after the uncompressed part,
481 * if compression was used). *namelen_rlater will have been set
482 * to the length of the domain name (total length of labels plus
483 * 1 for each intervening dot).
485 * If the datagram appears to be truncated, *lablen_r will be -1.
486 * *dmend_rlater, *labstart_r and *namelen_r may contain garbage.
487 * Do not call _next again.
489 * There may also be errors, in which case *dmend_rlater,
490 * *namelen_rlater, *lablen_r and *labstart_r may contain garbage.
491 * Do not then call findlabel_next again.
498 adns_status adns__parse_domain(adns_state ads, int serv, adns_query qu,
499 vbuf *vb, parsedomain_flags flags,
500 const byte *dgram, int dglen, int *cbyte_io, int max);
501 /* vb must already have been initialised; it will be reset if necessary.
502 * If there is truncation, vb->used will be set to 0; otherwise
503 * (if there is no error) vb will be null-terminated.
504 * If there is an error vb and *cbyte_io may be left indeterminate.
506 * serv may be -1 and qu may be 0 - they are used for error reporting only.
509 adns_status adns__parse_domain_more(findlabel_state *fls, adns_state ads,
510 adns_query qu, vbuf *vb, parsedomain_flags flags,
512 /* Like adns__parse_domain, but you pass it a pre-initialised findlabel_state,
513 * for continuing an existing domain or some such of some kind. Also, unlike
514 * _parse_domain, the domain data will be appended to vb, rather than replacing
515 * the existing contents.
518 adns_status adns__findrr(adns_query qu, int serv,
519 const byte *dgram, int dglen, int *cbyte_io,
520 int *type_r, int *class_r, unsigned long *ttl_r,
521 int *rdlen_r, int *rdstart_r,
522 int *ownermatchedquery_r);
523 /* Finds the extent and some of the contents of an RR in a datagram
524 * and does some checks. The datagram is *dgram, length dglen, and
525 * the RR starts at *cbyte_io (which is updated afterwards to point
526 * to the end of the RR).
528 * The type, class, TTL and RRdata length and start are returned iff
529 * the corresponding pointer variables are not null. type_r, class_r
530 * and ttl_r may not be null. The TTL will be capped.
532 * If ownermatchedquery_r != 0 then the owner domain of this
533 * RR will be compared with that in the query (or, if the query
534 * has gone to a CNAME lookup, with the canonical name).
535 * In this case, *ownermatchedquery_r will be set to 0 or 1.
536 * The query datagram (or CNAME datagram) MUST be valid and not truncated.
538 * If there is truncation then *type_r will be set to -1 and
539 * *cbyte_io, *class_r, *rdlen_r, *rdstart_r and *eo_matched_r will be
542 * qu must obviously be non-null.
544 * If an error is returned then *type_r will be undefined too.
547 adns_status adns__findrr_anychk(adns_query qu, int serv,
548 const byte *dgram, int dglen, int *cbyte_io,
549 int *type_r, int *class_r, unsigned long *ttl_r,
550 int *rdlen_r, int *rdstart_r,
551 const byte *eo_dgram, int eo_dglen, int eo_cbyte,
553 /* Like adns__findrr_checked, except that the datagram and
554 * owner to compare with can be specified explicitly.
556 * If the caller thinks they know what the owner of the RR ought to
557 * be they can pass in details in eo_*: this is another (or perhaps
558 * the same datagram), and a pointer to where the putative owner
559 * starts in that datagram. In this case *eo_matched_r will be set
560 * to 1 if the datagram matched or 0 if it did not. Either
561 * both eo_dgram and eo_matched_r must both be non-null, or they
562 * must both be null (in which case eo_dglen and eo_cbyte will be ignored).
563 * The eo datagram and contained owner domain MUST be valid and
567 void adns__update_expires(adns_query qu, unsigned long ttl, struct timeval now);
568 /* Updates the `expires' field in the query, so that it doesn't exceed
572 int vbuf__append_quoted1035(vbuf *vb, const byte *buf, int len);
576 void adns__tcp_broken(adns_state ads, const char *what, const char *why);
577 void adns__tcp_tryconnect(adns_state ads, struct timeval now);
579 void adns__autosys(adns_state ads, struct timeval now);
580 /* Make all the system calls we want to if the application wants us to. */
582 /* Useful static inline functions: */
584 static inline void timevaladd(struct timeval *tv_io, long ms) {
588 tmp.tv_usec += (ms%1000)*1000000;
589 tmp.tv_sec += ms/1000;
590 if (tmp.tv_usec >= 1000000) { tmp.tv_sec++; tmp.tv_usec -= 1000; }
594 static inline int ctype_whitespace(int c) { return c==' ' || c=='\n' || c=='\t'; }
595 static inline int ctype_digit(int c) { return c>='0' && c<='9'; }
596 static inline int ctype_alpha(int c) {
597 return (c >= 'a' && c <= 'z') || (c >= 'A' || c <= 'Z');
602 #define MEM_ROUND(sz) \
603 (( ((sz)+sizeof(union maxalign)-1) / sizeof(union maxalign) ) \
604 * sizeof(union maxalign) )
606 #define LIST_INIT(list) ((list).head= (list).tail= 0)
608 #define LIST_UNLINK_PART(list,node,part) \
610 if ((node)->part back) (node)->part back->part next= (node)->part next; \
611 else (list).head= (node)->part next; \
612 if ((node)->part next) (node)->part next->part back= (node)->part back; \
613 else (list).tail= (node)->part back; \
616 #define LIST_LINK_TAIL_PART(list,node,part) \
618 (node)->part next= 0; \
619 (node)->part back= (list).tail; \
620 if ((list).tail) (list).tail->part next= (node); else (list).head= (node); \
621 (list).tail= (node); \
624 #define LIST_UNLINK(list,node) LIST_UNLINK_PART(list,node,)
625 #define LIST_LINK_TAIL(list,node) LIST_LINK_TAIL_PART(list,node,)
627 #define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ff)
628 #define GET_B(cb,tv) ((tv)= GETIL_B((cb)))
629 #define GET_W(cb,tv) ((tv)=0, (tv)|=(GETIL_B((cb))<<8), (tv)|=GETIL_B(cb), (tv))
630 #define GET_L(cb,tv) ( (tv)=0, \
631 (tv)|=(GETIL_B((cb))<<24), \
632 (tv)|=(GETIL_B((cb))<<16), \
633 (tv)|=(GETIL_B((cb))<<8), \