summaryrefslogtreecommitdiff
path: root/usr/src/cmd/cmd-inet/usr.lib/in.dhcpd/per_dnet.h
blob: 8672e86ad83b4328381211c596fc5528586fb3aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef	_PER_DSTORE_H
#define	_PER_DSTORE_H

#pragma ident	"%Z%%M%	%I%	%E% SMI"

#ifdef	__cplusplus
extern "C" {
#endif

/*
 * per_dnet.h -- DHCP-datastore database definitions.
 */

/*
 * DHCP thread deferred work structure. One per deferred client thread.
 *
 * Track clients who cannot be immediately serviced due
 * to a lack of available client threads. Locked by thr_mtx.
 */
typedef struct dsvc_pending {
	uchar_t			pnd_cid[DN_MAX_CID_LEN];	/* cid */
	uchar_t			pnd_cid_len;			/* cid length */
	struct dsvc_pending	*pnd_next;			/* next */
} dsvc_pendclnt_t;

/*
 * DHCP thread structure. One per client thread.
 *
 * Performance: create and track each client thread, using
 * thr_suspend/thr_resume, rather than slower thread creation
 * and deletion. Locked by thr_mtx.
 */
struct clnt;
typedef struct dsvc_free {
	thread_t		thr_tid;	/* thread id */
	cond_t			thr_cv;		/* suspend/resume cv */
	mutex_t			thr_mtx;	/* suspend/resume mutex */
	uint_t			thr_flags;	/* suspend/resume flags */
	struct clnt		*thr_pcd;	/* per client data struct */
	struct dsvc_free	*thr_next;	/* next */
} dsvc_thr_t;

/*
 * DHCP thread structure flags
 */
#define	DHCP_THR_LIST		0x1		/* Thread is on freelist */
#define	DHCP_THR_EXITING	0x2		/* Thread is exiting */

/*
 * DHCP datastore table. One per active network or dhcptab datastore.
 *
 * Timestamps are used to age the datastore structure, and any cached
 * datastore free or lru records managed in select_offer().
 * The number of threads and clients can be controlled via MAX_THREADS
 * and MAX_CLIENTS server parameters.
 *
 * Client and offer hashes provide fast lookup/reservation.
 * Per-bucket rwlocks implemented in the hash routines reduce
 * lock contention between clients.
 *
 * To minimize expensive datastore activity, threads synchronize to
 * manage cached free and lru datastore records, which have the
 * same lifetime as cached offers, which can be controlled via
 * the OFFER_CACHE_TIMEOUT server parameter.
 */
typedef	struct dnet {
	hash_handle	hand;		/* hash insertion handle */
	time_t		free_mtime;	/* macro table purge time */
	time_t		free_stamp;	/* D_OFFER freerec purge time */
	time_t		lru_mtime;	/* macro table purge time */
	time_t		lru_stamp;	/* D_OFFER lrurec purge time */
	time_t		clnt_stamp;	/* D_OFFER client purge time */
	uint_t		flags;		/* dnet flags */
	struct in_addr	net;		/* network */
	struct in_addr	subnet;		/* subnet mask */
	int		naddrs;		/* # addrs owned by server */
	int		nthreads;	/* number of active threads */
	int		nclients;	/* number of active clients */
	hash_tbl	*ctable;	/* per client hash table */
	hash_tbl	*itable;	/* per ipaddr hash table */
	dsvc_thr_t	*thrhead;	/* free thread list */
	dsvc_thr_t	*thrtail;	/* free thread list tail */
	dsvc_pendclnt_t	*workhead;	/* head of thread work list */
	dsvc_pendclnt_t	*worktail;	/* tail of thread work list */
	dn_rec_list_t	*freerec;	/* free records head */
	dn_rec_list_t	*lrurec;	/* lru records head */
	dn_rec_list_t	**lrupage;	/* lru records sort area */
	size_t		lrusize;

	dsvc_handle_t	dh;		/* datastore handle */
	mutex_t		pnd_mtx;	/* open/close mutex */
	mutex_t		free_mtx;	/* lock for free records */
	mutex_t		lru_mtx;	/* lock for lru records */
	mutex_t		lrupage_mtx;	/* lock for lru page */
	mutex_t		thr_mtx;	/* lock for thread work list */
	cond_t		thr_cv;		/* cond var (nthreads == 0) */
	char		network[INET_ADDRSTRLEN];	/* display buffer */
} dsvc_dnet_t;

/*
 * DHCP datastore table flags
 */
#define	DHCP_PND_CLOSING	0x1		/* Dstore is closing */
#define	DHCP_PND_ERROR		0x2		/* Dstore experienced error */

/*
 * DHCP datastore table macros
 */
#define	PND_FREE_TIMEOUT(pnd, now)	((pnd)->free_stamp < (now) || \
					    (pnd)->free_mtime != reinit_time)
#define	PND_LRU_TIMEOUT(pnd, now)	((pnd)->lru_stamp < (now) || \
					    (pnd)->lru_mtime != reinit_time)

struct interfaces;

/*
 * DHCP client. One per active client, per network.
 *
 * Timestamps are used to age the client structure, and any cached
 * offer, which can be controlled via the OFFER_CACHE_TIMEOUT server
 * parameter, and the -t option, and SIGHUP signal.
 *
 * The original datastore record is cached, along with offer information,
 * for use if the datastore record is modified.
 *
 * The clnt struct may appear on the client hash table, and offer hash table,
 * depending on the validity of the current offer. A different dsvc_clnt_t
 * is used for each link, to allow independent aging of client and offer.
 */
typedef struct clnt {
	hash_handle	chand;		/* hash insertion handle: client hash */
	hash_handle	ihand;		/* hash insertion handle: inet hash */
	time_t		mtime;		/* macro table offer purge time */
	uint_t		flags;		/* Client flags */
	uint_t		state;		/* Client DHCP state */
	struct in_addr	off_ip;		/* Offered address */
	struct interfaces *ifp;		/* the ifp the packet arrived on */
	dsvc_dnet_t	*pnd;		/* the per network datastore */
	PKT_LIST	*pkthead;	/* head of client packet list */
	PKT_LIST	*pkttail;	/* tail of client packet list */
	uint_t		pending;	/* # of pkts on client packet list */
	lease_t		lease;		/* Offered lease time */
	dsvc_thr_t	*clnt_thread;	/* client thread */

	dn_rec_list_t	*dnlp;		/* Original datastore record */
	mutex_t		pcd_mtx;	/* overall struct lock */
	mutex_t		pkt_mtx;	/* lock for PKT_LIST */
	cond_t		pcd_cv;		/* cond var (clnt_thread == 0) */
	char 		cidbuf[DHCP_MAX_OPT_SIZE]; /* display buffer */
	uchar_t		cid[DN_MAX_CID_LEN]; /* Offered cid */
	uchar_t		cid_len;	/* Offered cid length */
} dsvc_clnt_t;

/*
 * Per Client flags and indices
 */
#define	DHCP_HDR_CLIENT		0x0	/* clnt dsvc_clnt_t */
#define	DHCP_HDR_OFFER		0x1	/* offer dsvc_clnt_t */

#define	DHCP_PCD_OFFER		0x1	/* Offered ip addr is valid */
#define	DHCP_PCD_WORK		0x2	/* Client is on deferred work list */
#define	DHCP_PCD_CLOSING	0x4	/* Client thread should exit */

/*
 * Per Client macros
 */
#define	PCD_OFFER_TIMEOUT(pcd, now)	(hash_Htime(pcd->ihand) < (now) || \
						(pcd)->mtime != reinit_time)

/*
 * Datastore hash table dynamic data free timeout values
 */
#define	DHCP_CLIENT_THRESHOLD	90	/* Time to free inactive clients */
#define	DHCP_NET_THRESHOLD	900	/* Time to free inactive nets */

/*
 * Datastore database access routines.
 */
extern int	open_dnet(dsvc_dnet_t **, struct in_addr *, struct in_addr *);
extern void	close_dnet(dsvc_dnet_t *, boolean_t);

/*
 * Per Client hash and utility routines.
 */
extern int open_clnt(dsvc_dnet_t *, dsvc_clnt_t **, uchar_t *, uchar_t,
	boolean_t);
extern void close_clnt(dsvc_clnt_t *, boolean_t);
extern int clnt_netcmp(dsvc_clnt_t *, dsvc_clnt_t *);
extern void close_clnts(void);
extern void purge_offer(dsvc_clnt_t *, boolean_t, boolean_t);

#ifdef	__cplusplus
}
#endif

#endif	/* _PER_DSTORE_H */