add rdataset

lib/dns/Makefile.in

@@ -12,7 +12,7 @@ CINCLUDES =	-I${srcdir}/../isc/unix/include \
 CDEFINES =
 CWARNINGS =
 
-OBJS =		name.o result.o version.o
+OBJS =		name.o rdataset.o result.o version.o
 
 SUBDIRS =	include
 TARGETS =	timestamp

lib/dns/include/dns/rdataset.h

+/*
+ * Copyright (C) 1999  Internet Software Consortium.
+ * 
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
+ * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
+ * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+ * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
+ * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
+ * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
+ * SOFTWARE.
+ */
+
+#ifndef DNS_RDATASET_H
+#define DNS_RDATASET_H 1
+
+/*****
+ ***** Module Info
+ *****/
+
+/*
+ * DNS Rdataset
+ *
+ * A DNS rdataset is a handle that can be associated with a collection of
+ * rdata all having a common owner name, class, and type.
+ *
+ * The dns_rdataset_t type is like a "virtual class".  To actually use
+ * rdatasets, an implementation of the method suite (e.g. "slabbed rdata") is
+ * required.
+ *
+ * XXX <more> XXX
+ *
+ * MP:
+ *	Clients of this module must impose any required synchronization.
+ *
+ * Reliability:
+ *	No anticipated impact.
+ *
+ * Resources:
+ *	<TBS>
+ *
+ * Security:
+ *	No anticipated impact.
+ *
+ * Standards:
+ *	None.
+ */
+
+#include <isc/boolean.h>
+#include <isc/buffer.h>
+
+#include <dns/types.h>
+#include <dns/result.h>
+
+typedef struct dns_rdatasetmethods {
+	dns_result_t		(*disassociate)(dns_rdataset_t *rdatasetp);
+	dns_result_t		(*first)(dns_rdataset_t *rdataset);
+	dns_result_t		(*next)(dns_rdataset_t *rdataset);
+	void			(*current)(dns_rdataset_t *rdataset,
+					   dns_rdata_t *rdata);
+} dns_rdatasetmethods_t;
+
+/*
+ * Direct use of this structure by clients is strongly discouraged, except
+ * for the 'link' field which may be used however the client wishes.  The
+ * 'private', 'current', and 'index' fields MUST NOT be changed by clients.
+ * rdataset implementations may change any of the fields.
+ */
+struct dns_rdataset {
+	unsigned int			magic;		/* XXX ? */
+	dns_rdatasetmethods_t *		methods;
+	ISC_LINK(dns_rdataset_t)	link;
+	/*
+	 * XXX do we need these, or should they be retrieved by methods?
+	 * Leaning towards the latter, since they are not frequently required
+	 * once you have the rdataset.
+	 */
+	dns_rdataclass_t		class;
+	dns_rdatatype_t			type;
+	dns_ttl_t			ttl;
+	/*
+	 * These are for use by the rdataset implementation, and MUST NOT
+	 * be changed by clients.
+	 */
+	void *				private1;
+	void *				private2;
+	void *				private3;
+};
+
+void
+dns_rdataset_init(dns_rdataset_t *rdataset);
+/*
+ * Make 'rdataset' a valid, disassociated rdataset.
+ *
+ * Requires:
+ *	'rdataset' is not NULL.
+ *
+ * Ensures:
+ *	'rdataset' is a valid, disassociated rdataset.
+ */
+
+void
+dns_rdataset_invalidate(dns_rdataset_t *rdataset);
+/*
+ * Invalidate 'rdataset'.
+ *
+ * Requires:
+ *	'rdataset' is a valid, disassociated rdataset.
+ *
+ * Ensures:
+ *	If assertion checking is enabled, future attempts to use 'rdataset'
+ *	without initializing it will cause an assertion failure.
+ */
+
+void
+dns_rdataset_disassociate(dns_rdataset_t *rdataset);
+/*
+ * Disassocate 'rdataset' from its rdata, allowing it to be reused.
+ *
+ * Notes:
+ *	The client must ensure it has no references to rdata in the rdataset
+ *	before disassociating.
+ *
+ * Requires:
+ *	'rdataset' is a valid, associated rdataset.
+ *
+ * Ensures:
+ *	'rdataset' is a valid, disassociated rdataset.
+ *	
+ */
+
+dns_result_t
+dns_rdataset_first(dns_rdataset_t *rdataset);
+/*
+ * Move the rdata cursor to the first rdata in the rdataset (if any).
+ *
+ * Requires:
+ *	'rdataset' is a valid, associated rdataset.
+ *
+ * Returns:
+ *	DNS_R_SUCCESS
+ *	DNS_R_NOMORE			There are no rdata in the set.
+ */
+
+dns_result_t
+dns_rdataset_next(dns_rdataset_t *rdataset);
+/*
+ * Move the rdata cursor to the next rdata in the rdataset (if any).
+ *
+ * Requires:
+ *	'rdataset' is a valid, associated rdataset.
+ *
+ * Returns:
+ *	DNS_R_SUCCESS
+ *	DNS_R_NOMORE			There are no more rdata in the set.
+ */
+
+void
+dns_rdataset_current(dns_rdataset_t *rdataset, dns_rdata_t *rdata);
+/*
+ * Make 'rdata' refer to the current rdata.
+ *
+ * Requires:
+ *	'rdataset' is a valid, associated rdataset.
+ *
+ *	The rdata cursor of 'rdataset' is at a valid location (i.e. the
+ *	result of last call to a cursor movement command was DNS_R_SUCCESS).
+ *
+ * Ensures:
+ *	'rdata' refers to the rdata at the rdata cursor location of
+ *	'rdataset'.
+ */
+
+dns_result_t
+dns_rdataset_totext(dns_rdataset_t *rdataset,
+		    dns_name_t *owner_name,
+		    isc_boolean_t omit_final_dot,
+		    isc_buffer_t *target);
+/*
+ * Convert 'rdataset' to text format, storing the result in 'target'.
+ *
+ * Notes:
+ *	The rdata cursor position will be changed.
+ *
+ * XXX Supply Requires and Ensures XXX
+ */
+
+dns_result_t
+dns_rdataset_towire(dns_rdataset_t *rdataset,
+		    dns_name_t *owner_name,
+		    dns_compress_t *cctx,
+		    isc_buffer_t *target);
+/*
+ * Convert 'rdataset' to wire format, compressing names as specified
+ * in cctx, and storing the result in 'target'.
+ *
+ * Notes:
+ *	The rdata cursor position will be changed.
+ *
+ * XXX Supply Requires and Ensures XXX
+ */
+
+#endif /* DNS_RDATASET_H */

lib/dns/rdataset.c

+/*
+ * Copyright (C) 1999  Internet Software Consortium.
+ * 
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
+ * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
+ * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+ * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
+ * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
+ * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
+ * SOFTWARE.
+ */
+
+#include <stddef.h>
+
+#include <isc/assertions.h>
+
+#include <dns/rdataset.h>
+
+#define RDATASET_MAGIC			0x444E5352U	/* DNSR */
+#define VALID_RDATASET(rdataset)	((rdataset) != NULL && \
+					 (rdataset)->magic == RDATASET_MAGIC)
+
+void
+dns_rdataset_init(dns_rdataset_t *rdataset) {
+
+	/*
+	 * Make 'rdataset' a valid, disassociated rdataset.
+	 */
+
+	REQUIRE(rdataset != NULL);
+
+	rdataset->magic = RDATASET_MAGIC;
+	rdataset->methods = NULL;
+	ISC_LINK_INIT(rdataset, link);
+	rdataset->class = 0;
+	rdataset->type = 0;
+	rdataset->ttl = 0;
+	rdataset->private1 = NULL;
+	rdataset->private2 = NULL;
+	rdataset->private3 = NULL;
+}
+
+void
+dns_rdataset_invalidate(dns_rdataset_t *rdataset) {
+
+	/*
+	 * Invalidate 'rdataset'.
+	 */
+
+	REQUIRE(VALID_RDATASET(rdataset));
+	REQUIRE(rdataset->methods == NULL);
+	
+	rdataset->magic = 0;
+	ISC_LINK_INIT(rdataset, link);
+	rdataset->class = 0;
+	rdataset->type = 0;
+	rdataset->ttl = 0;
+	rdataset->private1 = NULL;
+	rdataset->private2 = NULL;
+	rdataset->private3 = NULL;
+}
+
+void
+dns_rdataset_disassociate(dns_rdataset_t *rdataset) {
+
+	/*
+	 * Disassocate 'rdataset' from its rdata, allowing it to be reused.
+	 */
+
+	REQUIRE(VALID_RDATASET(rdataset));
+
+	(rdataset->methods->disassociate)(rdataset);
+	rdataset->methods = NULL;
+	ISC_LINK_INIT(rdataset, link);
+	rdataset->class = 0;
+	rdataset->type = 0;
+	rdataset->ttl = 0;
+	rdataset->private1 = NULL;
+	rdataset->private2 = NULL;
+	rdataset->private3 = NULL;
+}
+
+dns_result_t
+dns_rdataset_first(dns_rdataset_t *rdataset) {
+
+	/*
+	 * Move the rdata cursor to the first rdata in the rdataset (if any).
+	 */
+
+	REQUIRE(VALID_RDATASET(rdataset));
+
+	return ((rdataset->methods->first)(rdataset));
+}
+
+dns_result_t
+dns_rdataset_next(dns_rdataset_t *rdataset) {
+
+	/*
+	 * Move the rdata cursor to the next rdata in the rdataset (if any).
+	 */
+
+	REQUIRE(VALID_RDATASET(rdataset));
+
+	return ((rdataset->methods->next)(rdataset));
+}
+
+void
+dns_rdataset_current(dns_rdataset_t *rdataset, dns_rdata_t *rdata) {
+
+	/*
+	 * Make 'rdata' refer to the current rdata.
+	 */
+
+	REQUIRE(VALID_RDATASET(rdataset));
+
+	(rdataset->methods->current)(rdataset, rdata);
+}
+
+dns_result_t
+dns_rdataset_totext(dns_rdataset_t *rdataset,
+		    dns_name_t *owner_name,
+		    isc_boolean_t omit_final_dot,
+		    isc_buffer_t *target)
+{
+
+	/*
+	 * Convert 'rdataset' to text format, storing the result in 'target'.
+	 */
+
+	REQUIRE(VALID_RDATASET(rdataset));
+
+	/* XXX stop warnings. */
+	owner_name = NULL;
+	omit_final_dot = ISC_FALSE;
+	target = NULL;
+
+	return (DNS_R_NOTIMPLEMENTED);
+}
+
+dns_result_t
+dns_rdataset_towire(dns_rdataset_t *rdataset,
+		    dns_name_t *owner_name,
+		    dns_compress_t *cctx,
+		    isc_buffer_t *target)
+{
+
+	/*
+	 * Convert 'rdataset' to wire format, compressing names as specified
+	 * in cctx, and storing the result in 'target'.
+	 */
+
+	/* XXX stop warnings. */
+	owner_name = NULL;
+	cctx = NULL;
+	target = NULL;
+
+	REQUIRE(VALID_RDATASET(rdataset));
+
+	return (DNS_R_NOTIMPLEMENTED);
+}