contrib/bind-9.3/lib/dns/include/dns/result.h

   1 /*
   2  * Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1998-2003  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  * PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* $Id: result.h,v 1.81.2.7.2.13 2004/05/14 05:06:41 marka Exp $ */
  19
  20 #ifndef DNS_RESULT_H
  21 #define DNS_RESULT_H 1
  22
  23 #include <isc/lang.h>
  24 #include <isc/resultclass.h>
  25
  26 #include <dns/types.h>
  27
  28 /*
  29  * Nothing in this file truly depends on <isc/result.h>, but the
  30  * DNS result codes are considered to be publicly derived from
  31  * the ISC result codes, so including this file buys you the ISC_R_
  32  * namespace too.
  33  */
  34 #include <isc/result.h>         /* Contractual promise. */
  35
  36 /*
  37  * DNS library result codes
  38  */
  39 #define DNS_R_LABELTOOLONG              (ISC_RESULTCLASS_DNS + 0)
  40 #define DNS_R_BADESCAPE                 (ISC_RESULTCLASS_DNS + 1)
  41 /*
  42  * Since we dropped the support of bitstring labels, deprecate the related
  43  * result codes too.
  44
  45 #define DNS_R_BADBITSTRING              (ISC_RESULTCLASS_DNS + 2)
  46 #define DNS_R_BITSTRINGTOOLONG          (ISC_RESULTCLASS_DNS + 3)
  47 */
  48 #define DNS_R_EMPTYLABEL                (ISC_RESULTCLASS_DNS + 4)
  49 #define DNS_R_BADDOTTEDQUAD             (ISC_RESULTCLASS_DNS + 5)
  50 #define DNS_R_INVALIDNS                 (ISC_RESULTCLASS_DNS + 6)
  51 #define DNS_R_UNKNOWN                   (ISC_RESULTCLASS_DNS + 7)
  52 #define DNS_R_BADLABELTYPE              (ISC_RESULTCLASS_DNS + 8)
  53 #define DNS_R_BADPOINTER                (ISC_RESULTCLASS_DNS + 9)
  54 #define DNS_R_TOOMANYHOPS               (ISC_RESULTCLASS_DNS + 10)
  55 #define DNS_R_DISALLOWED                (ISC_RESULTCLASS_DNS + 11)
  56 #define DNS_R_EXTRATOKEN                (ISC_RESULTCLASS_DNS + 12)
  57 #define DNS_R_EXTRADATA                 (ISC_RESULTCLASS_DNS + 13)
  58 #define DNS_R_TEXTTOOLONG               (ISC_RESULTCLASS_DNS + 14)
  59 #define DNS_R_NOTZONETOP                (ISC_RESULTCLASS_DNS + 15)
  60 #define DNS_R_SYNTAX                    (ISC_RESULTCLASS_DNS + 16)
  61 #define DNS_R_BADCKSUM                  (ISC_RESULTCLASS_DNS + 17)
  62 #define DNS_R_BADAAAA                   (ISC_RESULTCLASS_DNS + 18)
  63 #define DNS_R_NOOWNER                   (ISC_RESULTCLASS_DNS + 19)
  64 #define DNS_R_NOTTL                     (ISC_RESULTCLASS_DNS + 20)
  65 #define DNS_R_BADCLASS                  (ISC_RESULTCLASS_DNS + 21)
  66 #define DNS_R_NAMETOOLONG               (ISC_RESULTCLASS_DNS + 22)
  67 #define DNS_R_PARTIALMATCH              (ISC_RESULTCLASS_DNS + 23)
  68 #define DNS_R_NEWORIGIN                 (ISC_RESULTCLASS_DNS + 24)
  69 #define DNS_R_UNCHANGED                 (ISC_RESULTCLASS_DNS + 25)
  70 #define DNS_R_BADTTL                    (ISC_RESULTCLASS_DNS + 26)
  71 #define DNS_R_NOREDATA                  (ISC_RESULTCLASS_DNS + 27)
  72 #define DNS_R_CONTINUE                  (ISC_RESULTCLASS_DNS + 28)
  73 #define DNS_R_DELEGATION                (ISC_RESULTCLASS_DNS + 29)
  74 #define DNS_R_GLUE                      (ISC_RESULTCLASS_DNS + 30)
  75 #define DNS_R_DNAME                     (ISC_RESULTCLASS_DNS + 31)
  76 #define DNS_R_CNAME                     (ISC_RESULTCLASS_DNS + 32)
  77 #define DNS_R_BADDB                     (ISC_RESULTCLASS_DNS + 33)
  78 #define DNS_R_ZONECUT                   (ISC_RESULTCLASS_DNS + 34)
  79 #define DNS_R_BADZONE                   (ISC_RESULTCLASS_DNS + 35)
  80 #define DNS_R_MOREDATA                  (ISC_RESULTCLASS_DNS + 36)
  81 #define DNS_R_UPTODATE                  (ISC_RESULTCLASS_DNS + 37)
  82 #define DNS_R_TSIGVERIFYFAILURE         (ISC_RESULTCLASS_DNS + 38)
  83 #define DNS_R_TSIGERRORSET              (ISC_RESULTCLASS_DNS + 39)
  84 #define DNS_R_SIGINVALID                (ISC_RESULTCLASS_DNS + 40)
  85 #define DNS_R_SIGEXPIRED                (ISC_RESULTCLASS_DNS + 41)
  86 #define DNS_R_SIGFUTURE                 (ISC_RESULTCLASS_DNS + 42)
  87 #define DNS_R_KEYUNAUTHORIZED           (ISC_RESULTCLASS_DNS + 43)
  88 #define DNS_R_INVALIDTIME               (ISC_RESULTCLASS_DNS + 44)
  89 #define DNS_R_EXPECTEDTSIG              (ISC_RESULTCLASS_DNS + 45)
  90 #define DNS_R_UNEXPECTEDTSIG            (ISC_RESULTCLASS_DNS + 46)
  91 #define DNS_R_INVALIDTKEY               (ISC_RESULTCLASS_DNS + 47)
  92 #define DNS_R_HINT                      (ISC_RESULTCLASS_DNS + 48)
  93 #define DNS_R_DROP                      (ISC_RESULTCLASS_DNS + 49)
  94 #define DNS_R_NOTLOADED                 (ISC_RESULTCLASS_DNS + 50)
  95 #define DNS_R_NCACHENXDOMAIN            (ISC_RESULTCLASS_DNS + 51)
  96 #define DNS_R_NCACHENXRRSET             (ISC_RESULTCLASS_DNS + 52)
  97 #define DNS_R_WAIT                      (ISC_RESULTCLASS_DNS + 53)
  98 #define DNS_R_NOTVERIFIEDYET            (ISC_RESULTCLASS_DNS + 54)
  99 #define DNS_R_NOIDENTITY                (ISC_RESULTCLASS_DNS + 55)
 100 #define DNS_R_NOJOURNAL                 (ISC_RESULTCLASS_DNS + 56)
 101 #define DNS_R_ALIAS                     (ISC_RESULTCLASS_DNS + 57)
 102 #define DNS_R_USETCP                    (ISC_RESULTCLASS_DNS + 58)
 103 #define DNS_R_NOVALIDSIG                (ISC_RESULTCLASS_DNS + 59)
 104 #define DNS_R_NOVALIDNSEC               (ISC_RESULTCLASS_DNS + 60)
 105 #define DNS_R_NOTINSECURE               (ISC_RESULTCLASS_DNS + 61)
 106 #define DNS_R_UNKNOWNSERVICE            (ISC_RESULTCLASS_DNS + 62)
 107 #define DNS_R_RECOVERABLE               (ISC_RESULTCLASS_DNS + 63)
 108 #define DNS_R_UNKNOWNOPT                (ISC_RESULTCLASS_DNS + 64)
 109 #define DNS_R_UNEXPECTEDID              (ISC_RESULTCLASS_DNS + 65)
 110 #define DNS_R_SEENINCLUDE               (ISC_RESULTCLASS_DNS + 66)
 111 #define DNS_R_NOTEXACT                  (ISC_RESULTCLASS_DNS + 67)
 112 #define DNS_R_BLACKHOLED                (ISC_RESULTCLASS_DNS + 68)
 113 #define DNS_R_BADALG                    (ISC_RESULTCLASS_DNS + 69)
 114 #define DNS_R_METATYPE                  (ISC_RESULTCLASS_DNS + 70)
 115 #define DNS_R_CNAMEANDOTHER             (ISC_RESULTCLASS_DNS + 71)
 116 #define DNS_R_SINGLETON                 (ISC_RESULTCLASS_DNS + 72)
 117 #define DNS_R_HINTNXRRSET               (ISC_RESULTCLASS_DNS + 73)
 118 #define DNS_R_NOMASTERFILE              (ISC_RESULTCLASS_DNS + 74)
 119 #define DNS_R_UNKNOWNPROTO              (ISC_RESULTCLASS_DNS + 75)
 120 #define DNS_R_CLOCKSKEW                 (ISC_RESULTCLASS_DNS + 76)
 121 #define DNS_R_BADIXFR                   (ISC_RESULTCLASS_DNS + 77)
 122 #define DNS_R_NOTAUTHORITATIVE          (ISC_RESULTCLASS_DNS + 78)
 123 #define DNS_R_NOVALIDKEY                (ISC_RESULTCLASS_DNS + 79)
 124 #define DNS_R_OBSOLETE                  (ISC_RESULTCLASS_DNS + 80)
 125 #define DNS_R_FROZEN                    (ISC_RESULTCLASS_DNS + 81)
 126 #define DNS_R_UNKNOWNFLAG               (ISC_RESULTCLASS_DNS + 82)
 127 #define DNS_R_EXPECTEDRESPONSE          (ISC_RESULTCLASS_DNS + 83)
 128 #define DNS_R_NOVALIDDS                 (ISC_RESULTCLASS_DNS + 84)
 129 #define DNS_R_NSISADDRESS               (ISC_RESULTCLASS_DNS + 85)
 130 #define DNS_R_REMOTEFORMERR             (ISC_RESULTCLASS_DNS + 86)
 131 #define DNS_R_TRUNCATEDTCP              (ISC_RESULTCLASS_DNS + 87)
 132 #define DNS_R_LAME                      (ISC_RESULTCLASS_DNS + 88)
 133 #define DNS_R_UNEXPECTEDRCODE           (ISC_RESULTCLASS_DNS + 89)
 134 #define DNS_R_UNEXPECTEDOPCODE          (ISC_RESULTCLASS_DNS + 90)
 135 #define DNS_R_CHASEDSSERVERS            (ISC_RESULTCLASS_DNS + 91)
 136 #define DNS_R_EMPTYNAME                 (ISC_RESULTCLASS_DNS + 92)
 137 #define DNS_R_EMPTYWILD                 (ISC_RESULTCLASS_DNS + 93)
 138 #define DNS_R_BADBITMAP                 (ISC_RESULTCLASS_DNS + 94)
 139 #define DNS_R_FROMWILDCARD              (ISC_RESULTCLASS_DNS + 95)
 140 #define DNS_R_BADOWNERNAME              (ISC_RESULTCLASS_DNS + 96)
 141 #define DNS_R_BADNAME                   (ISC_RESULTCLASS_DNS + 97)
 142 #define DNS_R_DYNAMIC                   (ISC_RESULTCLASS_DNS + 98)
 143 #define DNS_R_UNKNOWNCOMMAND            (ISC_RESULTCLASS_DNS + 99)
 144 #define DNS_R_MUSTBESECURE              (ISC_RESULTCLASS_DNS + 100)
 145 #define DNS_R_COVERINGNSEC              (ISC_RESULTCLASS_DNS + 101)
 146
 147 #define DNS_R_NRESULTS                  102     /* Number of results */
 148
 149 /*
 150  * DNS wire format rcodes.
 151  *
 152  * By making these their own class we can easily convert them into the
 153  * wire-format rcode value simply by masking off the resultclass.
 154  */
 155 #define DNS_R_NOERROR                   (ISC_RESULTCLASS_DNSRCODE + 0)
 156 #define DNS_R_FORMERR                   (ISC_RESULTCLASS_DNSRCODE + 1)
 157 #define DNS_R_SERVFAIL                  (ISC_RESULTCLASS_DNSRCODE + 2)
 158 #define DNS_R_NXDOMAIN                  (ISC_RESULTCLASS_DNSRCODE + 3)
 159 #define DNS_R_NOTIMP                    (ISC_RESULTCLASS_DNSRCODE + 4)
 160 #define DNS_R_REFUSED                   (ISC_RESULTCLASS_DNSRCODE + 5)
 161 #define DNS_R_YXDOMAIN                  (ISC_RESULTCLASS_DNSRCODE + 6)
 162 #define DNS_R_YXRRSET                   (ISC_RESULTCLASS_DNSRCODE + 7)
 163 #define DNS_R_NXRRSET                   (ISC_RESULTCLASS_DNSRCODE + 8)
 164 #define DNS_R_NOTAUTH                   (ISC_RESULTCLASS_DNSRCODE + 9)
 165 #define DNS_R_NOTZONE                   (ISC_RESULTCLASS_DNSRCODE + 10)
 166 #define DNS_R_BADVERS                   (ISC_RESULTCLASS_DNSRCODE + 16)
 167
 168 #define DNS_R_NRCODERESULTS             17      /* Number of rcode results */
 169
 170 #define DNS_RESULT_ISRCODE(result) \
 171         (ISC_RESULTCLASS_INCLASS(ISC_RESULTCLASS_DNSRCODE, (result)))
 172
 173 ISC_LANG_BEGINDECLS
 174
 175 const char *
 176 dns_result_totext(isc_result_t);
 177
 178 void
 179 dns_result_register(void);
 180
 181 dns_rcode_t
 182 dns_result_torcode(isc_result_t result);
 183
 184 ISC_LANG_ENDDECLS
 185
 186 #endif /* DNS_RESULT_H */