xref: /onnv-gate/usr/src/lib/libdhcpsvc/modules/binfiles/dhcptab.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright (c) 2000 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate  * All rights reserved.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _DHCPTAB_H
28*0Sstevel@tonic-gate #define	_DHCPTAB_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate /*
33*0Sstevel@tonic-gate  * Implementation-specific data structures and constants for the binary
34*0Sstevel@tonic-gate  * dhcptab container.  These structures are subject to change at any time.
35*0Sstevel@tonic-gate  */
36*0Sstevel@tonic-gate 
37*0Sstevel@tonic-gate #ifdef __cplusplus
38*0Sstevel@tonic-gate extern "C" {
39*0Sstevel@tonic-gate #endif
40*0Sstevel@tonic-gate 
41*0Sstevel@tonic-gate #include <sys/types.h>
42*0Sstevel@tonic-gate #include <dhcp_svc_public.h>
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate #define	DT_NOREC	0		/* "no record" id value */
45*0Sstevel@tonic-gate #define	DT_MAGIC	0x0d6c94ab	/* "dhcptab" in a hexadecimal world */
46*0Sstevel@tonic-gate 
47*0Sstevel@tonic-gate /*
48*0Sstevel@tonic-gate  * Constants for use with find_dt
49*0Sstevel@tonic-gate  */
50*0Sstevel@tonic-gate #define	FIND_PARTIAL	0x0001		/* allow partial success */
51*0Sstevel@tonic-gate #define	FIND_POSITION	0x0002 		/* return dt_recpos_t's */
52*0Sstevel@tonic-gate 
53*0Sstevel@tonic-gate /*
54*0Sstevel@tonic-gate  * Header atop the dhcptab container -- contains some basic information
55*0Sstevel@tonic-gate  * about the container for sanity-checking purposes.
56*0Sstevel@tonic-gate  */
57*0Sstevel@tonic-gate typedef struct dt_header {
58*0Sstevel@tonic-gate 	unsigned char	dth_version;	/* container version */
59*0Sstevel@tonic-gate 	unsigned char	dth_align[3]; 	/* ensure binary compatibility */
60*0Sstevel@tonic-gate 	uint32_t	dth_magic;	/* magic for sanity check */
61*0Sstevel@tonic-gate 	uint32_t	dth_pad[4];	/* for future use */
62*0Sstevel@tonic-gate } dt_header_t;
63*0Sstevel@tonic-gate 
64*0Sstevel@tonic-gate /*
65*0Sstevel@tonic-gate  * What each dt_rec_t looks like on-disk -- note that we cannot just write
66*0Sstevel@tonic-gate  * dt_rec_t's because the `dt_value' field can be arbitrarily large.
67*0Sstevel@tonic-gate  * Instead, write out the dt_rec_t structure followed by the variable-size
68*0Sstevel@tonic-gate  * `rec_dtval' array which will contain the current value of `dt_value'.
69*0Sstevel@tonic-gate  * Since `rec_dtval' is of variable size, we must explicitly keep track of
70*0Sstevel@tonic-gate  * its length via `rec_dtvalsize'.
71*0Sstevel@tonic-gate  */
72*0Sstevel@tonic-gate typedef struct dt_filerec {
73*0Sstevel@tonic-gate 	dt_rec_t	rec_dt;		/* actual dt_rec_t */
74*0Sstevel@tonic-gate 	uint32_t	rec_dtvalsize;	/* total size of rec_dtval */
75*0Sstevel@tonic-gate 	char		rec_dtval[1];	/* dt_value field from dt_rec_t */
76*0Sstevel@tonic-gate } dt_filerec_t;
77*0Sstevel@tonic-gate 
78*0Sstevel@tonic-gate /*
79*0Sstevel@tonic-gate  * Per-record state describing the underlying record, including its
80*0Sstevel@tonic-gate  * position on-disk; these are returned instead of dt_rec_t's when find_dt
81*0Sstevel@tonic-gate  * is called with FIND_POSITION set.  Note that for this to work, the
82*0Sstevel@tonic-gate  * dt_rec_t must be the first member.
83*0Sstevel@tonic-gate  */
84*0Sstevel@tonic-gate typedef struct dt_recpos {
85*0Sstevel@tonic-gate 	dt_rec_t	dtp_rec;	/* traditional dt_rec_t */
86*0Sstevel@tonic-gate 	size_t		dtp_size;	/* its size in the file */
87*0Sstevel@tonic-gate 	off_t		dtp_off;	/* its starting offset in the file */
88*0Sstevel@tonic-gate } dt_recpos_t;
89*0Sstevel@tonic-gate 
90*0Sstevel@tonic-gate /*
91*0Sstevel@tonic-gate  * Per-instance state for each handle returned from open_dt
92*0Sstevel@tonic-gate  */
93*0Sstevel@tonic-gate typedef struct dt_handle {
94*0Sstevel@tonic-gate 	unsigned int	dh_oflags;		 /* flags passed into open_dt */
95*0Sstevel@tonic-gate 	char		dh_location[MAXPATHLEN]; /* location of container */
96*0Sstevel@tonic-gate } dt_handle_t;
97*0Sstevel@tonic-gate 
98*0Sstevel@tonic-gate #ifdef __cplusplus
99*0Sstevel@tonic-gate }
100*0Sstevel@tonic-gate #endif
101*0Sstevel@tonic-gate 
102*0Sstevel@tonic-gate #endif /* _DHCPTAB_H */
103