contrib/bind-9.2.4rc7/lib/dns/include/dns/rdataslab.h

   1 /*
   2  * Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1999-2001, 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: rdataslab.h,v 1.20.2.3 2004/03/09 06:11:21 marka Exp $ */
  19
  20 #ifndef DNS_RDATASLAB_H
  21 #define DNS_RDATASLAB_H 1
  22
  23 /*
  24  * DNS Rdata Slab
  25  *
  26  * Implements storage of rdatasets into slabs of memory.
  27  *
  28  * MP:
  29  *      Clients of this module must impose any required synchronization.
  30  *
  31  * Reliability:
  32  *      This module deals with low-level byte streams.  Errors in any of
  33  *      the functions are likely to crash the server or corrupt memory.
  34  *
  35  *      If the caller passes invalid memory references, these functions are
  36  *      likely to crash the server or corrupt memory.
  37  *
  38  * Resources:
  39  *      None.
  40  *
  41  * Security:
  42  *      None.
  43  *
  44  * Standards:
  45  *      None.
  46  */
  47
  48 /***
  49  *** Imports
  50  ***/
  51
  52 #include <isc/lang.h>
  53
  54 #include <dns/types.h>
  55
  56 ISC_LANG_BEGINDECLS
  57
  58 #define DNS_RDATASLAB_FORCE 0x1
  59 #define DNS_RDATASLAB_EXACT 0x2
  60
  61 /***
  62  *** Functions
  63  ***/
  64
  65 isc_result_t
  66 dns_rdataslab_fromrdataset(dns_rdataset_t *rdataset, isc_mem_t *mctx,
  67                            isc_region_t *region, unsigned int reservelen);
  68 /*
  69  * Slabify a rdataset.  The slab area will be allocated and returned
  70  * in 'region'.
  71  *
  72  * Requires:
  73  *      'rdataset' is valid.
  74  *
  75  * Ensures:
  76  *      'region' will have base pointing to the start of allocated memory,
  77  *      with the slabified region beginning at region->base + reservelen.
  78  *      region->length contains the total length allocated.
  79  *
  80  * Returns:
  81  *      ISC_R_SUCCESS           - successful completion
  82  *      DNS_R_NOMEM             - no memory.
  83  *      <XXX others>
  84  */
  85
  86 unsigned int
  87 dns_rdataslab_size(unsigned char *slab, unsigned int reservelen);
  88 /*
  89  * Return the total size of an rdataslab.
  90  *
  91  * Requires:
  92  *      'slab' points to a slab.
  93  *
  94  * Returns:
  95  *      The number of bytes in the slab, including the reservelen.
  96  */
  97
  98 isc_result_t
  99 dns_rdataslab_merge(unsigned char *oslab, unsigned char *nslab,
 100                     unsigned int reservelen, isc_mem_t *mctx,
 101                     dns_rdataclass_t rdclass, dns_rdatatype_t type,
 102                     unsigned int flags, unsigned char **tslabp);
 103 /*
 104  * Merge 'oslab' and 'nslab'.
 105  */
 106
 107 isc_result_t
 108 dns_rdataslab_subtract(unsigned char *mslab, unsigned char *sslab,
 109                        unsigned int reservelen, isc_mem_t *mctx,
 110                        dns_rdataclass_t rdclass, dns_rdatatype_t type,
 111                        unsigned int flags, unsigned char **tslabp);
 112 /*
 113  * Subtract 'sslab' from 'mslab'.  If 'exact' is true then all elements
 114  * of 'sslab' must exist in 'mslab'.
 115  *
 116  * XXX
 117  * valid flags are DNS_RDATASLAB_EXACT
 118  */
 119
 120 isc_boolean_t
 121 dns_rdataslab_equal(unsigned char *slab1, unsigned char *slab2,
 122                     unsigned int reservelen);
 123
 124 /*
 125  * Compare two rdataslabs for equality.  This does _not_ do a full
 126  * DNSSEC comparison.
 127  *
 128  * Requires:
 129  *      'slab1' and 'slab2' point to slabs.
 130  *
 131  * Returns:
 132  *      ISC_TRUE if the slabs are equal, ISC_FALSE otherwise.
 133  */
 134
 135 isc_boolean_t
 136 dns_rdataslab_equalx(unsigned char *slab1, unsigned char *slab2,
 137                      unsigned int reservelen, dns_rdataclass_t rdclass,
 138                      dns_rdatatype_t type);
 139 /*
 140  * Compare two rdataslabs for DNSSEC equality.
 141  *
 142  * Requires:
 143  *      'slab1' and 'slab2' point to slabs.
 144  *
 145  * Returns:
 146  *      ISC_TRUE if the slabs are equal, ISC_FALSE otherwise.
 147  */
 148
 149 ISC_LANG_ENDDECLS
 150
 151 #endif /* DNS_RDATASLAB_H */