2 * Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 2000, 2001 Internet Software Consortium.
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.
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.
18 /* $Id: sdb.h,v 1.12.12.3 2004/03/08 09:04:39 marka Exp $ */
28 * Simple database API.
37 #include <dns/types.h>
44 * A simple database. This is an opaque type.
46 typedef struct dns_sdb dns_sdb_t;
49 * A simple database lookup in progress. This is an opaque type.
51 typedef struct dns_sdblookup dns_sdblookup_t;
54 * A simple database traversal in progress. This is an opaque type.
56 typedef struct dns_sdballnodes dns_sdballnodes_t;
59 (*dns_sdblookupfunc_t)(const char *zone, const char *name, void *dbdata,
63 (*dns_sdbauthorityfunc_t)(const char *zone, void *dbdata, dns_sdblookup_t *);
66 (*dns_sdballnodesfunc_t)(const char *zone, void *dbdata,
67 dns_sdballnodes_t *allnodes);
70 (*dns_sdbcreatefunc_t)(const char *zone, int argc, char **argv,
71 void *driverdata, void **dbdata);
74 (*dns_sdbdestroyfunc_t)(const char *zone, void *driverdata, void **dbdata);
77 typedef struct dns_sdbmethods {
78 dns_sdblookupfunc_t lookup;
79 dns_sdbauthorityfunc_t authority;
80 dns_sdballnodesfunc_t allnodes;
81 dns_sdbcreatefunc_t create;
82 dns_sdbdestroyfunc_t destroy;
91 #define DNS_SDBFLAG_RELATIVEOWNER 0x00000001U
92 #define DNS_SDBFLAG_RELATIVERDATA 0x00000002U
93 #define DNS_SDBFLAG_THREADSAFE 0x00000004U
96 dns_sdb_register(const char *drivername, const dns_sdbmethods_t *methods,
97 void *driverdata, unsigned int flags, isc_mem_t *mctx,
98 dns_sdbimplementation_t **sdbimp);
100 * Register a simple database driver for the database type 'drivername',
101 * implemented by the functions in '*methods'.
103 * sdbimp must point to a NULL dns_sdbimplementation_t pointer. That is,
104 * sdbimp != NULL && *sdbimp == NULL. It will be assigned a value that
105 * will later be used to identify the driver when deregistering it.
107 * The name server will perform lookups in the database by calling the
108 * function 'lookup', passing it a printable zone name 'zone', a printable
109 * domain name 'name', and a copy of the argument 'dbdata' that
110 * was potentially returned by the create function. The 'dns_sdblookup_t'
111 * argument to 'lookup' and 'authority' is an opaque pointer to be passed to
114 * The lookup function returns the lookup results to the name server
115 * by calling ns_sdb_putrr() once for each record found. On success,
116 * the return value of the lookup function should be ISC_R_SUCCESS.
117 * If the domain name 'name' does not exist, the lookup function should
118 * ISC_R_NOTFOUND. Any other return value is treated as an error.
120 * Lookups at the zone apex will cause the server to also call the
121 * function 'authority' (if non-NULL), which must provide an SOA record
122 * and NS records for the zone by calling ns_sdb_putrr() once for each of
123 * these records. The 'authority' function may be NULL if invoking
124 * the 'lookup' function on the zone apex will return SOA and NS records.
126 * The allnodes function, if non-NULL, fills in an opaque structure to be
127 * used by a database iterator. This allows the zone to be transferred.
128 * This may use a considerable amount of memory for large zones, and the
129 * zone transfer may not be fully RFC 1035 compliant if the zone is
130 * frequently changed.
132 * The create function will be called for each zone configured
133 * into the name server using this database type. It can be used
134 * to create a "database object" containg zone specific data,
135 * which can make use of the database arguments specified in the
136 * name server configuration.
138 * The destroy function will be called to free the database object
139 * when its zone is destroyed.
141 * The create and destroy functions may be NULL.
143 * If flags includes DNS_SDBFLAG_RELATIVEOWNER, the lookup and authority
144 * functions will be called with relative names rather than absolute names.
145 * The string "@" represents the zone apex in this case.
147 * If flags includes DNS_SDBFLAG_RELATIVERDATA, the rdata strings may
148 * include relative names. Otherwise, all names in the rdata string must
149 * be absolute. Be aware that if relative names are allowed, any
150 * absolute names must contain a trailing dot.
152 * If flags includes DNS_SDBFLAG_THREADSAFE, the driver must be able to
153 * handle multiple lookups in parallel. Otherwise, calls into the driver
158 dns_sdb_unregister(dns_sdbimplementation_t **sdbimp);
160 * Removes the simple database driver from the list of registered database
161 * types. There must be no active databases of this type when this function
166 dns_sdb_putrr(dns_sdblookup_t *lookup, const char *type, dns_ttl_t ttl,
169 dns_sdb_putrdata(dns_sdblookup_t *lookup, dns_rdatatype_t type, dns_ttl_t ttl,
170 const unsigned char *rdata, unsigned int rdlen);
172 * Add a single resource record to the lookup structure to be
173 * returned in the query response. dns_sdb_putrr() takes the
174 * resource record in master file text format as a null-terminated
175 * string, and dns_sdb_putrdata() takes the raw RDATA in
176 * uncompressed wire format.
180 dns_sdb_putnamedrr(dns_sdballnodes_t *allnodes, const char *name,
181 const char *type, dns_ttl_t ttl, const char *data);
183 dns_sdb_putnamedrdata(dns_sdballnodes_t *allnodes, const char *name,
184 dns_rdatatype_t type, dns_ttl_t ttl,
185 const void *rdata, unsigned int rdlen);
187 * Add a single resource record to the allnodes structure to be
188 * included in a zone transfer response, in text or wire
193 dns_sdb_putsoa(dns_sdblookup_t *lookup, const char *mname, const char *rname,
194 isc_uint32_t serial);
196 * This function may optionally be called from the 'authority' callback
197 * to simplify construction of the SOA record for 'zone'. It will
198 * provide a SOA listing 'mname' as as the master server and 'rname' as
199 * the responsible person mailbox. It is the responsibility of the
200 * driver to increment the serial number between responses if necessary.
201 * All other SOA fields will have reasonable default values.
206 #endif /* DNS_SDB_H */