Correct error messages for qname CNAME foo, foo CNAME bar.
[adns] / src / adns.h
CommitLineData
5628df75 1/*
18d49d56 2 * adns.h
3 * - adns user-visible API (single-threaded, without any locking)
4 */
5/*
a719a4be 6 * This file is part of adns, which is Copyright (C) 1997-1999 Ian Jackson
e576be50 7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2, or (at your option)
11 * any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software Foundation,
a719a4be 20 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 *
22 * $Id$
e576be50 23 */
a17d3a1d 24
25#ifndef ADNS_H_INCLUDED
26#define ADNS_H_INCLUDED
02b47faa 27#ifdef __cplusplus
28extern "C" { /* I really dislike this - iwj. */
29#endif
a17d3a1d 30
4353a5c4 31#include <stdio.h>
32
964344fc 33#include <sys/socket.h>
34#include <netinet/in.h>
636b69b1 35#include <sys/types.h>
36#include <sys/time.h>
37#include <unistd.h>
964344fc 38
09957b1c 39/* All struct in_addr anywhere in adns are in NETWORK byte order. */
40
964344fc 41typedef struct adns__state *adns_state;
42typedef struct adns__query *adns_query;
a17d3a1d 43
44typedef enum {
37e28fde 45 adns_if_noenv= 0x0001, /* do not look at environment */
46 adns_if_noerrprint= 0x0002, /* never print output to stderr (_debug overrides) */
47 adns_if_noserverwarn= 0x0004, /* do not warn to stderr about duff nameservers etc */
ddfda861 48 adns_if_debug= 0x0008, /* enable all output to stderr plus debug msgs */
37e28fde 49 adns_if_noautosys= 0x0010, /* do not make syscalls at every opportunity */
88372443 50 adns_if_eintr= 0x0020, /* allow _wait and _synchronous to return EINTR */
ac868fa8 51 adns_if_nosigpipe= 0x0040, /* applic has SIGPIPE set to SIG_IGN, do not protect */
3e2e5fab 52 adns_if_checkc_entex= 0x0100, /* do consistency checks on entry/exit to adns funcs */
53 adns_if_checkc_freq= 0x0300, /* do consistency checks very frequently (slow!) */
a17d3a1d 54} adns_initflags;
55
56typedef enum {
b365d68a 57 adns_qf_search= 0x00000001, /* use the searchlist */
58 adns_qf_usevc= 0x00000002, /* use a virtual circuit (TCP connection) */
59 adns_qf_owner= 0x00000004, /* fill in the owner field in the answer */
60 adns_qf_quoteok_query= 0x00000010, /* allow quote-requiring chars in query domain */
61 adns_qf_quoteok_cname= 0x00000000, /* allow ... in CNAME we go via - now default */
62 adns_qf_quoteok_anshost= 0x00000040, /* allow ... in things supposed to be hostnames */
63 adns_qf_quotefail_cname= 0x00000080, /* refuse if quote-req chars in CNAME we go via */
64 adns_qf_cname_loose= 0x00000100, /* allow refs to CNAMEs - without, get _s_cname */
65 adns_qf_cname_forbid= 0x00000200, /* don't follow CNAMEs, instead give _s_cname */
66 adns__qf_internalmask= 0x0ff00000
a17d3a1d 67} adns_queryflags;
68
69typedef enum {
350d37d9 70 adns__rrt_typemask= 0x0ffff,
ddfda861 71 adns__qtf_deref= 0x10000, /* dereference domains and perhaps produce extra data */
72 adns__qtf_mail822= 0x20000, /* make mailboxes be in RFC822 rcpt field format */
ddfda861 73
350d37d9 74 adns_r_none= 0,
ddfda861 75
350d37d9 76 adns_r_a= 1,
ddfda861 77
350d37d9 78 adns_r_ns_raw= 2,
79 adns_r_ns= adns_r_ns_raw|adns__qtf_deref,
ddfda861 80
350d37d9 81 adns_r_cname= 5,
ddfda861 82
350d37d9 83 adns_r_soa_raw= 6,
ddfda861 84 adns_r_soa= adns_r_soa_raw|adns__qtf_mail822,
ddfda861 85
350d37d9 86 adns_r_ptr_raw= 12,
87 adns_r_ptr= adns_r_ptr_raw|adns__qtf_deref,
ddfda861 88
350d37d9 89 adns_r_hinfo= 13,
ddfda861 90
350d37d9 91 adns_r_mx_raw= 15,
92 adns_r_mx= adns_r_mx_raw|adns__qtf_deref,
ddfda861 93
350d37d9 94 adns_r_txt= 16,
ddfda861 95
350d37d9 96 adns_r_rp_raw= 17,
4353a5c4 97 adns_r_rp= adns_r_rp_raw|adns__qtf_mail822,
828d89bd 98
99 adns_r_addr= adns_r_a|adns__qtf_deref
ddfda861 100
a17d3a1d 101} adns_rrtype;
102
b365d68a 103/*
104 * In queries without qf_quoteok_*, all domains must have standard
105 * legal syntax, or you get adns_s_querydomainvalid (if the query
106 * domain contains bad characters) or adns_s_answerdomaininvalid (if
107 * the answer contains bad characters).
108 *
109 * In queries _with_ qf_quoteok_*, domains in the query or response
110 * may contain any characters, quoted according to RFC1035 5.1. On
111 * input to adns, the char* is a pointer to the interior of a "
112 * delimited string, except that " may appear in it, and on output,
9da4a044 113 * the char* is a pointer to a string which would be legal either
114 * inside or outside " delimiters, and any characters not usually
115 * legal in domain names will be quoted as \X (if the character is
116 * 33-126 except \ and ") or \DDD.
964344fc 117 *
b365d68a 118 * If the query goes via a CNAME then the canonical name (ie, the
119 * thing that the CNAME record refers to) is usually allowed to
120 * contain any characters, which will be quoted as above. With
121 * adns_qf_quotefail_cname you get adns_s_answerdomaininvalid when
122 * this happens. (This is a change from version 0.4 and earlier, in
123 * which failing the query was the default, and you had to say
124 * adns_qf_quoteok_cname to avoid this; that flag is now deprecated.)
125 *
126 * In version 0.4 and earlier, asking for _raw records containing
127 * mailboxes without specifying _qf_quoteok_anshost was silly. This
128 * is no longer the case. In this version only parts of responses
129 * that are actually supposed to be hostnames will be refused by
130 * default if quote-requiring characters are found.
131 */
132
133/*
134 * If you ask for an RR which contains domains which are actually
135 * encoded mailboxes, and don't ask for the _raw version, then adns
136 * returns the mailbox formatted suitably for an RFC822 recipient
137 * header field. The particular format used is that if the mailbox
138 * requires quoting according to the rules in RFC822 then the
139 * local-part is quoted in double quotes, which end at the next
140 * unescaped double quote. (\ is the escape char, and is doubled, and
141 * is used to escape only \ and ".) Otherwise the local-part is
142 * presented as-is. In any case this is followed by an @ and the
143 * domain. The domain will not contain any characters not legal in
144 * hostnames. adns will protect the application from local parts
145 * containing control characters - these appear to be legal according
146 * to RFC822 but are clearly a bad idea.
147 *
148 * If you ask for the domain with _raw then _no_ checking is done
149 * (even on the host part, regardless of adns_qf_quoteok_anshost), and
150 * you just get the domain name in master file format.
151 *
152 * If no mailbox is supplied the returned string will be `.' in either
153 * caswe.
964344fc 154 */
155
a17d3a1d 156typedef enum {
157 adns_s_ok,
ea1e31e3 158
159 /* locally induced errors */
160 adns_s_nomemory,
161 adns_s_unknownrrtype,
620c146d 162 adns_s_systemfail,
163
164 adns_s_max_localfail= 29,
ea1e31e3 165
166 /* remotely induced errors, detected locally */
37e28fde 167 adns_s_timeout,
4bec51a4 168 adns_s_allservfail,
ec477b9e 169 adns_s_norecurse,
ea1e31e3 170 adns_s_invalidresponse,
171 adns_s_unknownformat,
620c146d 172
173 adns_s_max_remotefail= 59,
ea1e31e3 174
175 /* remotely induced errors, reported by remote server to us */
176 adns_s_rcodeservfail,
177 adns_s_rcodeformaterror,
178 adns_s_rcodenotimplemented,
179 adns_s_rcoderefused,
180 adns_s_rcodeunknown,
620c146d 181
b9de380c 182 adns_s_max_tempfail= 99,
ea1e31e3 183
184 /* remote configuration errors */
185 adns_s_inconsistent, /* PTR gives domain whose A does not exist and match */
186 adns_s_prohibitedcname, /* CNAME found where eg A expected (not if _qf_loosecname) */
187 adns_s_answerdomaininvalid,
188 adns_s_answerdomaintoolong,
189 adns_s_invaliddata,
190
191 adns_s_max_misconfig= 199,
192
ea1e31e3 193 /* permanent problems with the query */
194 adns_s_querydomainwrong,
195 adns_s_querydomaininvalid,
196 adns_s_querydomaintoolong,
197
198 adns_s_max_misquery= 299,
199
200 /* permanent errors */
a17d3a1d 201 adns_s_nxdomain,
0ba0614a 202 adns_s_nodata,
ea1e31e3 203
a17d3a1d 204} adns_status;
205
e8c505a5 206typedef struct {
828d89bd 207 int len;
208 union {
209 struct sockaddr sa;
210 struct sockaddr_in inet;
211 } addr;
551ff40f 212} adns_rr_addr;
828d89bd 213
214typedef struct {
1dfe95d8 215 char *host;
84fe28db 216 adns_status astatus;
217 int naddrs; /* temp fail => -1, perm fail => 0, s_ok => >0 */
551ff40f 218 adns_rr_addr *addrs;
c7836bc9 219} adns_rr_hostaddr;
4353a5c4 220
221typedef struct {
9ec44266 222 char *(array[2]);
4353a5c4 223} adns_rr_strpair;
224
225typedef struct {
226 int i;
1dfe95d8 227 adns_rr_hostaddr ha;
c7836bc9 228} adns_rr_inthostaddr;
4353a5c4 229
230typedef struct {
e062dcae 231 /* Used both for mx_raw, in which case i is the preference and str the domain,
232 * and for txt, in which case each entry has i for the `text' length,
233 * and str for the data (which will have had an extra nul appended
234 * so that if it was plain text it is now a null-terminated string).
235 */
4353a5c4 236 int i;
237 char *str;
238} adns_rr_intstr;
239
240typedef struct {
9ec44266 241 adns_rr_intstr array[2];
242} adns_rr_intstrpair;
243
244typedef struct {
245 char *mname, *rname;
4353a5c4 246 unsigned long serial, refresh, retry, expire, minimum;
247} adns_rr_soa;
84fe28db 248
249typedef struct {
a17d3a1d 250 adns_status status;
251 char *cname; /* always NULL if query was for CNAME records */
22181a31 252 char *owner; /* only set if requested in query flags */
86e7b8d9 253 adns_rrtype type; /* guaranteed to be same as in query */
73dba56e 254 time_t expires; /* expiry time, defined only if _s_ok, nxdomain or nodata. NOT TTL! */
b365d68a 255 int nrrs, rrsz; /* nrrs is 0 if an error occurs */
a17d3a1d 256 union {
8e5b0abb 257 void *untyped;
258 unsigned char *bytes;
c7836bc9 259 char *(*str); /* ns_raw, cname, ptr, ptr_raw */
260 adns_rr_intstr *(*manyistr); /* txt (list of strings ends with i=-1, str=0) */
551ff40f 261 adns_rr_addr *addr; /* addr */
c7836bc9 262 struct in_addr *inaddr; /* a */
263 adns_rr_hostaddr *hostaddr; /* ns */
9ec44266 264 adns_rr_intstrpair *intstrpair; /* hinfo */
265 adns_rr_strpair *strpair; /* rp, rp_raw */
c7836bc9 266 adns_rr_inthostaddr *inthostaddr; /* mx */
267 adns_rr_intstr *intstr; /* mx_raw */
268 adns_rr_soa *soa; /* soa, soa_raw */
a17d3a1d 269 } rrs;
e8c505a5 270} adns_answer;
a17d3a1d 271
272/* Memory management:
273 * adns_state and adns_query are actually pointers to malloc'd state;
274 * On submission questions are copied, including the owner domain;
4353a5c4 275 * Answers are malloc'd as a single piece of memory; pointers in the
276 * answer struct point into further memory in the answer.
a17d3a1d 277 * query_io:
278 * Must always be non-null pointer;
279 * If *query_io is 0 to start with then any query may be returned;
280 * If *query_io is !0 adns_query then only that query may be returned.
d3eea642 281 * If the call is successful, *query_io, *answer_r, and *context_r
282 * will all be set.
a17d3a1d 283 * Errors:
620c146d 284 * Return values are 0 or an errno value.
285 *
286 * For _init, _init_strcfg, _submit and _synchronous, system errors
287 * (eg, failure to create sockets, malloc failure, etc.) return errno
288 * values.
289 *
290 * For _wait and _check failures are reported in the answer
291 * structure, and only 0, ESRCH or (for _check) EWOULDBLOCK is
292 * returned: if no (appropriate) requests are done adns_check returns
293 * EWOULDBLOCK; if no (appropriate) requests are outstanding both
294 * adns_query and adns_wait return ESRCH.
295 *
296 * Additionally, _wait can return EINTR if you set adns_if_eintr.
297 *
298 * All other errors (nameserver failure, timed out connections, &c)
299 * are returned in the status field of the answer. After a
300 * successful _wait or _check, if status is nonzero then nrrs will be
301 * 0, otherwise it will be >0. type will always be the type
302 * requested.
a17d3a1d 303 */
304
36369543 305int adns_init(adns_state *newstate_r, adns_initflags flags,
306 FILE *diagfile /*0=>stderr*/);
307
308int adns_init_strcfg(adns_state *newstate_r, adns_initflags flags,
309 FILE *diagfile /*0=>discard*/, const char *configtext);
a17d3a1d 310
311int adns_synchronous(adns_state ads,
312 const char *owner,
313 adns_rrtype type,
72934832 314 adns_queryflags flags,
9d95094c 315 adns_answer **answer_r);
e8c505a5 316
317/* NB: if you set adns_if_noautosys then _submit and _check do not
620c146d 318 * make any system calls; you must use some of the asynch-io event
319 * processing functions to actually get things to happen.
e8c505a5 320 */
a17d3a1d 321
322int adns_submit(adns_state ads,
323 const char *owner,
324 adns_rrtype type,
72934832 325 adns_queryflags flags,
a17d3a1d 326 void *context,
964344fc 327 adns_query *query_r);
a17d3a1d 328
964344fc 329int adns_check(adns_state ads,
a17d3a1d 330 adns_query *query_io,
9d95094c 331 adns_answer **answer_r,
332 void **context_r);
a17d3a1d 333
334int adns_wait(adns_state ads,
335 adns_query *query_io,
9d95094c 336 adns_answer **answer_r,
337 void **context_r);
a17d3a1d 338
3955725c 339void adns_cancel(adns_query query);
a17d3a1d 340
620c146d 341/* The adns_query you get back from _submit is valid (ie, can be
342 * legitimately passed into adns functions) until it is returned by
343 * adns_check or adns_wait, or passed to adns_cancel. After that it
344 * must not be used. You can rely on it not being reused until the
345 * first adns_submit or _transact call using the same adns_state after
346 * it became invalid, so you may compare it for equality with other
347 * query handles until you next call _query or _transact.
636b69b1 348 *
349 * _submit and _synchronous return ENOSYS if they don't understand the
350 * query type.
e576be50 351 */
a17d3a1d 352
b365d68a 353int adns_submit_reverse(adns_state ads,
354 const struct sockaddr *addr,
355 adns_rrtype type,
356 adns_queryflags flags,
357 void *context,
358 adns_query *query_r);
359/* type must be _r_ptr or _r_ptr_raw. _qf_search is ignored. */
360
620c146d 361void adns_finish(adns_state ads);
e576be50 362/* You may call this even if you have queries outstanding;
363 * they will be cancelled.
364 */
a17d3a1d 365
964344fc 366
958ad1f0 367void adns_forallqueries_begin(adns_state ads);
8ce38e76 368adns_query adns_forallqueries_next(adns_state ads, void **context_r);
620c146d 369/* Iterator functions, which you can use to loop over the outstanding
958ad1f0 370 * (submitted but not yet successfuly checked/waited) queries.
a8768e80 371 *
958ad1f0 372 * You can only have one iteration going at once. You may call _begin
373 * at any time; after that, an iteration will be in progress. You may
374 * only call _next when an iteration is in progress - anything else
375 * may coredump. The iteration remains in progress until _next
376 * returns 0, indicating that all the queries have been walked over,
377 * or ANY other adns function is called with the same adns_state (or a
378 * query in the same adns_state). There is no need to explicitly
379 * finish an iteration.
380 *
8ce38e76 381 * context_r may be 0. *context_r may not be set when _next returns 0.
964344fc 382 */
a17d3a1d 383
28de6442 384void adns_checkconsistency(adns_state ads, adns_query qu);
3e2e5fab 385/* Checks the consistency of adns's internal data structures.
386 * If any error is found, the program will abort().
28de6442 387 * You may pass 0 for qu; if you pass non-null then additional checks
388 * are done to make sure that qu is a valid query.
3e2e5fab 389 */
390
620c146d 391/*
392 * Example expected/legal calling sequence for submit/check/wait:
a17d3a1d 393 * adns_init
394 * adns_submit 1
395 * adns_submit 2
396 * adns_submit 3
397 * adns_wait 1
964344fc 398 * adns_check 3 -> EWOULDBLOCK
a17d3a1d 399 * adns_wait 2
400 * adns_wait 3
401 * ....
402 * adns_finish
620c146d 403 */
404
405/*
406 * Entrypoints for generic asynch io:
407 * (these entrypoints are not very useful except in combination with *
408 * some of the other I/O model calls which can tell you which fds to
409 * be interested in):
410 *
411 * Note that any adns call may cause adns to open and close fds, so
412 * you must call beforeselect or beforepoll again just before
413 * blocking, or you may not have an up-to-date list of it's fds.
414 */
415
416int adns_processany(adns_state ads);
417/* Gives adns flow-of-control for a bit. This will never block, and
418 * can be used with any threading/asynch-io model. If some error
419 * occurred which might cause an event loop to spin then the errno
420 * value is returned.
421 */
422
423int adns_processreadable(adns_state ads, int fd, const struct timeval *now);
424int adns_processwriteable(adns_state ads, int fd, const struct timeval *now);
425int adns_processexceptional(adns_state ads, int fd, const struct timeval *now);
426/* Gives adns flow-of-control so that it can process incoming data
427 * from, or send outgoing data via, fd. Very like _processany. If it
428 * returns zero then fd will no longer be readable or writeable
429 * (unless of course more data has arrived since). adns will _only_
430 * that fd and only in the manner specified, regardless of whether
431 * adns_if_noautosys was specified.
432 *
433 * adns_processexceptional should be called when select(2) reports an
434 * exceptional condition, or poll(2) reports POLLPRI.
435 *
436 * It is fine to call _processreabable or _processwriteable when the
437 * fd is not ready, or with an fd that doesn't belong to adns; it will
438 * then just return 0.
439 *
440 * If some error occurred which might prevent an event loop to spin
441 * then the errno value is returned.
442 */
443
444void adns_processtimeouts(adns_state ads, const struct timeval *now);
445/* Gives adns flow-of-control so that it can process any timeouts
446 * which might have happened. Very like _processreadable/writeable.
447 *
448 * now may be 0; if it isn't, *now must be the current time, recently
449 * obtained from gettimeofday.
450 */
451
452void adns_firsttimeout(adns_state ads,
453 struct timeval **tv_mod, struct timeval *tv_buf,
454 struct timeval now);
455/* Asks adns when it would first like the opportunity to time
456 * something out. now must be the current time, from gettimeofday.
457 *
458 * If tv_mod points to 0 then tv_buf must be non-null, and
459 * _firsttimeout will fill in *tv_buf with the time until the first
460 * timeout, and make *tv_mod point to tv_buf. If adns doesn't have
461 * anything that might need timing out it will leave *tv_mod as 0.
462 *
463 * If *tv_mod is not 0 then tv_buf is not used. adns will update
464 * *tv_mod if it has any earlier timeout, and leave it alone if it
465 * doesn't.
466 *
467 * This call will not actually do any I/O, or change the fds that adns
468 * is using. It always succeeds and never blocks.
469 */
470
471void adns_globalsystemfailure(adns_state ads);
472/* If serious problem(s) happen which globally affect your ability to
473 * interact properly with adns, or adns's ability to function
474 * properly, you or adns can call this function.
475 *
476 * All currently outstanding queries will be made to fail with
477 * adns_s_systemfail, and adns will close any stream sockets it has
478 * open.
479 *
480 * This is used by adns, for example, if gettimeofday() fails.
481 * Without this the program's event loop might start to spin !
482 *
483 * This call will never block.
484 */
485
486/*
487 * Entrypoints for select-loop based asynch io:
488 */
489
490void adns_beforeselect(adns_state ads, int *maxfd, fd_set *readfds,
491 fd_set *writefds, fd_set *exceptfds,
492 struct timeval **tv_mod, struct timeval *tv_buf,
493 const struct timeval *now);
494/* Find out file descriptors adns is interested in, and when it would
495 * like the opportunity to time something out. If you do not plan to
496 * block then tv_mod may be 0. Otherwise, tv_mod and tv_buf are as
497 * for adns_firsttimeout. readfds, writefds, exceptfds and maxfd_io may
498 * not be 0.
499 *
500 * If *now is not 0 then this will never actually do any I/O, or
501 * change the fds that adns is using or the timeouts it wants. In any
502 * case it won't block.
503 */
504
505void adns_afterselect(adns_state ads, int maxfd, const fd_set *readfds,
506 const fd_set *writefds, const fd_set *exceptfds,
507 const struct timeval *now);
508/* Gives adns flow-of-control for a bit; intended for use after
509 * select. This is just a fancy way of calling adns_processreadable/
510 * writeable/timeouts as appropriate, as if select had returned the
511 * data being passed. Always succeeds.
512 */
513
514/*
515 * Example calling sequence:
a17d3a1d 516 *
e8c505a5 517 * adns_init _noautosys
a17d3a1d 518 * loop {
620c146d 519 * adns_beforeselect
a17d3a1d 520 * select
620c146d 521 * adns_afterselect
e8c505a5 522 * ...
523 * adns_submit / adns_check
524 * ...
a17d3a1d 525 * }
526 */
527
620c146d 528/*
529 * Entrypoints for poll-loop based asynch io:
530 */
531
532struct pollfd;
533/* In case your system doesn't have it or you forgot to include
534 * <sys/poll.h>, to stop the following declarations from causing
535 * problems. If your system doesn't have poll then the following
536 * entrypoints will not be defined in libadns. Sorry !
537 */
538
539int adns_beforepoll(adns_state ads, struct pollfd *fds, int *nfds_io, int *timeout_io,
540 const struct timeval *now);
541/* Finds out which fd's adns is interested in, and when it would like
542 * to be able to time things out. This is in a form suitable for use
543 * with poll(2).
544 *
545 * On entry, usually fds should point to at least *nfds_io structs.
546 * adns will fill up to that many structs will information for poll,
547 * and record in *nfds_io how many structs it filled. If it wants to
548 * listen for more structs then *nfds_io will be set to the number
549 * required and _beforepoll will return ERANGE.
550 *
620c146d 551 * You may call _beforepoll with fds==0 and *nfds_io 0, in which case
552 * adns will fill in the number of fds that it might be interested in
fc6a52ae 553 * in *nfds_io, and always return either 0 (if it is not interested in
554 * any fds) or ERANGE (if it is).
555 *
c912639e 556 * NOTE that (unless now is 0) adns may acquire additional fds
fc6a52ae 557 * from one call to the next, so you must put adns_beforepoll in a
558 * loop, rather than assuming that the second call (with the buffer
559 * size requested by the first) will not return ERANGE.
620c146d 560 *
561 * adns only ever sets POLLIN, POLLOUT and POLLPRI in its pollfd
562 * structs, and only ever looks at those bits. POLLPRI is required to
fc6a52ae 563 * detect TCP Urgent Data (which should not be used by a DNS server)
620c146d 564 * so that adns can know that the TCP stream is now useless.
565 *
566 * In any case, *timeout_io should be a timeout value as for poll(2),
567 * which adns will modify downwards as required. If the caller does
fc6a52ae 568 * not plan to block then *timeout_io should be 0 on entry, or
569 * alternatively, timeout_io may be 0. (Alternatively, the caller may
570 * use _beforeselect with timeout_io==0 to find out about file
571 * descriptors, and use _firsttimeout is used to find out when adns
572 * might want to time something out.)
620c146d 573 *
574 * adns_beforepoll will return 0 on success, and will not fail for any
575 * reason other than the fds buffer being too small (ERANGE).
576 *
c912639e 577 * This call will never actually do any I/O. If you supply the
578 * current time it will not change the fds that adns is using or the
579 * timeouts it wants.
580 *
581 * In any case this call won't block.
620c146d 582 */
583
584#define ADNS_POLLFDS_RECOMMENDED 2
585/* If you allocate an fds buf with at least RECOMMENDED entries then
586 * you are unlikely to need to enlarge it. You are recommended to do
587 * so if it's convenient. However, you must be prepared for adns to
588 * require more space than this.
589 */
590
591void adns_afterpoll(adns_state ads, const struct pollfd *fds, int nfds,
592 const struct timeval *now);
593/* Gives adns flow-of-control for a bit; intended for use after
594 * poll(2). fds and nfds should be the results from poll(). pollfd
595 * structs mentioning fds not belonging to adns will be ignored.
596 */
597
598
86e7b8d9 599adns_status adns_rr_info(adns_rrtype type,
600 const char **rrtname_r, const char **fmtname_r,
601 int *len_r,
602 const void *datap, char **data_r);
b365d68a 603/*
604
605 * Get information about a query type, or convert reply data to a
606 * textual form. type must be specified, and the official name of the
607 * corresponding RR type will be returned in *rrtname_r, and
608 * information about the processing style in *fmtname_r. The length
609 * of the table entry in an answer for that type will be returned in
610 * in *len_r. Any or all of rrtname_r, fmtname_r and len_r may be 0.
611 * If fmtname_r is non-null then *fmtname_r may be null on return,
612 * indicating that no special processing is involved.
613 *
614 * data_r be must be non-null iff datap is. In this case *data_r will
615 * be set to point to a string pointing to a representation of the RR
616 * data in master file format. (The owner name, timeout, class and
617 * type will not be present - only the data part of the RR.) The
618 * memory will have been obtained from malloc() and must be freed by
619 * the caller.
86e7b8d9 620 *
621 * Usually this routine will succeed. Possible errors include:
622 * adns_s_nomemory
ea1e31e3 623 * adns_s_rrtypeunknown
86e7b8d9 624 * adns_s_invaliddata (*datap contained garbage)
625 * If an error occurs then no memory has been allocated,
626 * and *rrtname_r, *fmtname_r, *len_r and *data_r are undefined.
b365d68a 627 *
628 * There are some adns-invented data formats which are not official
629 * master file formats. These include:
630 *
631 * Mailboxes if __qtf_mail822: these are just included as-is.
632 *
633 * Addresses (adns_rr_addr): these may be of pretty much any type.
634 * The representation is in two parts: first, a word for the address
635 * family (ie, in AF_XXX, the XXX), and then one or more items for the
636 * address itself, depending on the format. For an IPv4 address the
637 * syntax is INET followed by the dotted quad (from inet_ntoa).
638 * Currently only IPv4 is supported.
639 *
a6f1dc92 640 * Text strings (as in adns_rr_txt) appear inside double quotes, and
641 * use \" and \\ to represent " and \, and \xHH to represent
642 * characters not in the range 32-126.
643 *
b365d68a 644 * Hostname with addresses (adns_rr_hostaddr): this consists of the
a6f1dc92 645 * hostname, as usual, followed by the adns_status value, as an
646 * abbreviation, and then a descriptive string (encoded as if it were
647 * a piece of text), for the address lookup, followed by zero or more
b365d68a 648 * addresses enclosed in ( and ). If the result was a permanent
649 * failure, then a single ? appears instead of the ( ). If the
650 * result was a temporary failure then an empty pair of parentheses
651 * appears (which a space in between). For example, one of the NS
a6f1dc92 652 * records for greenend.org.uk comes out like
653 * ns.chiark.greenend.org.uk ok "OK" ( INET 195.224.76.132 )
b365d68a 654 * an MX referring to a nonexistent host might come out like:
a6f1dc92 655 * 50 sun2.nsfnet-relay.ac.uk nxdomain "No such domain" ( )
b365d68a 656 * and if nameserver information is not available you might get:
a6f1dc92 657 * dns2.spong.dyn.ml.org timeout "DNS query timed out" ?
86e7b8d9 658 */
659
31144a72 660const char *adns_strerror(adns_status st);
9da4a044 661const char *adns_errabbrev(adns_status st);
620c146d 662/* Like strerror but for adns_status values. adns_errabbrev returns
663 * the abbreviation of the error - eg, for adns_s_timeout it returns
664 * "timeout". You MUST NOT call these functions with status values
665 * not returned by the same adns library.
666 */
31144a72 667
02b47faa 668#ifdef __cplusplus
669} /* end of extern "C" */
670#endif
a17d3a1d 671#endif