fixedname.h 2.17 KB
Newer Older
Bob Halley's avatar
add  
Bob Halley committed
1
/*
Mark Andrews's avatar
Mark Andrews committed
2
 * Copyright (C) 2004, 2005  Internet Systems Consortium, Inc. ("ISC")
Brian Wellington's avatar
Brian Wellington committed
3
 * Copyright (C) 1999-2001  Internet Software Consortium.
4
 *
Bob Halley's avatar
add  
Bob Halley committed
5 6 7
 * 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.
8
 *
Mark Andrews's avatar
Mark Andrews committed
9 10 11 12 13 14 15
 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS.  IN NO EVENT SHALL ISC 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.
Bob Halley's avatar
add  
Bob Halley committed
16 17
 */

Mark Andrews's avatar
Mark Andrews committed
18
/* $Id: fixedname.h,v 1.15 2005/04/29 00:22:58 marka Exp $ */
David Lawrence's avatar
David Lawrence committed
19

Bob Halley's avatar
add  
Bob Halley committed
20 21 22 23 24 25 26
#ifndef DNS_FIXEDNAME_H
#define DNS_FIXEDNAME_H 1

/*****
 ***** Module Info
 *****/

27 28
/*! \file
 * \brief
Bob Halley's avatar
add  
Bob Halley committed
29 30 31 32 33 34
 * Fixed-size Names
 *
 * dns_fixedname_t is a convenience type containing a name, an offsets table,
 * and a dedicated buffer big enough for the longest possible name.
 *
 * MP:
35
 *\li	The caller must ensure any required synchronization.
Bob Halley's avatar
add  
Bob Halley committed
36 37
 *
 * Reliability:
38
 *\li	No anticipated impact.
Bob Halley's avatar
add  
Bob Halley committed
39 40
 *
 * Resources:
41 42
 *\li	Per dns_fixedname_t:
 *\code
Bob Halley's avatar
add  
Bob Halley committed
43 44
 *		sizeof(dns_name_t) + sizeof(dns_offsets_t) +
 *		sizeof(isc_buffer_t) + 255 bytes + structure padding
45
 *\endcode
Bob Halley's avatar
add  
Bob Halley committed
46 47
 *
 * Security:
48
 *\li	No anticipated impact.
Bob Halley's avatar
add  
Bob Halley committed
49 50
 *
 * Standards:
51
 *\li	None.
Bob Halley's avatar
add  
Bob Halley committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65
 */

/*****
 ***** Imports
 *****/

#include <isc/buffer.h>

#include <dns/name.h>

/*****
 ***** Types
 *****/

66 67 68 69
struct dns_fixedname {
	dns_name_t			name;
	dns_offsets_t			offsets;
	isc_buffer_t			buffer;
70
	unsigned char			data[DNS_NAME_MAXWIRE];
71
};
Bob Halley's avatar
add  
Bob Halley committed
72 73 74 75

#define dns_fixedname_init(fn) \
	do { \
		dns_name_init(&((fn)->name), (fn)->offsets); \
76 77
		isc_buffer_init(&((fn)->buffer), (fn)->data, \
                                  DNS_NAME_MAXWIRE); \
Bob Halley's avatar
add  
Bob Halley committed
78 79 80 81 82 83
		dns_name_setbuffer(&((fn)->name), &((fn)->buffer)); \
	} while (0)

#define dns_fixedname_invalidate(fn) \
	dns_name_invalidate(&((fn)->name))

84 85
#define dns_fixedname_name(fn)		(&((fn)->name))

Bob Halley's avatar
add  
Bob Halley committed
86
#endif /* DNS_FIXEDNAME_H */