conf.h revision 74810 
1/*-
2 * Copyright (c) 1990, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 * Copyright (c) 2000
5 *	Poul-Henning Kamp.  All rights reserved.
6 * (c) UNIX System Laboratories, Inc.
7 * All or some portions of this file are derived from material licensed
8 * to the University of California by American Telephone and Telegraph
9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10 * the permission of UNIX System Laboratories, Inc.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 *    notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 *    notice, this list of conditions and the following disclaimer in the
19 *    documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 *    must display the following acknowledgement:
22 *	This product includes software developed by the University of
23 *	California, Berkeley and its contributors.
24 * 4. Neither the name of the University nor the names of its contributors
25 *    may be used to endorse or promote products derived from this software
26 *    without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * SUCH DAMAGE.
39 *
40 *	@(#)conf.h	8.5 (Berkeley) 1/9/95
41 * $FreeBSD: head/sys/sys/conf.h 74810 2001-03-26 12:41:29Z phk $
42 */
43
44#ifndef _SYS_CONF_H_
45#define	_SYS_CONF_H_
46
47#include <sys/queue.h>
48#include <sys/eventhandler.h>
49
50struct tty;
51struct disk;
52struct vnode;
53struct buf;
54TAILQ_HEAD(snaphead, inode);
55
56struct specinfo {
57	u_int		si_flags;
58#define SI_STASHED	0x0001	/* created in stashed storage */
59#define SI_ALIAS	0x0002	/* carrier of alias name */
60#define SI_NAMED	0x0004	/* make_dev{_alias} has been called */
61#define SI_CHEAPCLONE	0x0008	/* can be removed_dev'ed when vnode reclaims */
62	struct timespec	si_atime;
63	struct timespec	si_ctime;
64	struct timespec	si_mtime;
65	udev_t		si_udev;
66	LIST_ENTRY(specinfo)	si_hash;
67	SLIST_HEAD(, vnode)	si_hlist;
68	LIST_HEAD(, specinfo)	si_names;
69	struct snaphead	si_snapshots;
70	int		(*si_copyonwrite)(struct vnode *, struct buf *);
71	u_int		si_inode;
72	char		si_name[SPECNAMELEN + 1];
73	void		*si_drv1, *si_drv2;
74	struct cdevsw	*si_devsw;
75	int		si_iosize_max;	/* maximum I/O size (for physio &al) */
76	uid_t		si_uid;
77	gid_t		si_gid;
78	mode_t		si_mode;
79	union {
80		struct {
81			struct tty *__sit_tty;
82		} __si_tty;
83		struct {
84			struct disk *__sid_disk;
85			struct mount *__sid_mountpoint;
86			int __sid_bsize_phys; /* min physical block size */
87			int __sid_bsize_best; /* optimal block size */
88		} __si_disk;
89	} __si_u;
90};
91
92#define si_tty		__si_u.__si_tty.__sit_tty
93#define si_disk		__si_u.__si_disk.__sid_disk
94#define si_mountpoint	__si_u.__si_disk.__sid_mountpoint
95#define si_bsize_phys	__si_u.__si_disk.__sid_bsize_phys
96#define si_bsize_best	__si_u.__si_disk.__sid_bsize_best
97
98/*
99 * Special device management
100 */
101#define	SPECHSZ	64
102#define	SPECHASH(rdev)	(((unsigned)(minor(rdev)))%SPECHSZ)
103
104/*
105 * Definitions of device driver entry switches
106 */
107
108struct bio;
109struct buf;
110struct proc;
111struct uio;
112struct knote;
113
114typedef int d_open_t __P((dev_t dev, int oflags, int devtype, struct proc *p));
115typedef int d_close_t __P((dev_t dev, int fflag, int devtype, struct proc *p));
116typedef void d_strategy_t __P((struct bio *bp));
117typedef int d_parms_t __P((dev_t dev, struct specinfo *sinfo, int ctl));
118typedef int d_ioctl_t __P((dev_t dev, u_long cmd, caddr_t data,
119			   int fflag, struct proc *p));
120typedef int d_dump_t __P((dev_t dev));
121typedef int d_psize_t __P((dev_t dev));
122
123typedef int d_read_t __P((dev_t dev, struct uio *uio, int ioflag));
124typedef int d_write_t __P((dev_t dev, struct uio *uio, int ioflag));
125typedef int d_poll_t __P((dev_t dev, int events, struct proc *p));
126typedef int d_kqfilter_t __P((dev_t dev, struct knote *kn));
127typedef int d_mmap_t __P((dev_t dev, vm_offset_t offset, int nprot));
128
129typedef int l_open_t __P((dev_t dev, struct tty *tp));
130typedef int l_close_t __P((struct tty *tp, int flag));
131typedef int l_read_t __P((struct tty *tp, struct uio *uio, int flag));
132typedef int l_write_t __P((struct tty *tp, struct uio *uio, int flag));
133typedef int l_ioctl_t __P((struct tty *tp, u_long cmd, caddr_t data,
134			   int flag, struct proc *p));
135typedef int l_rint_t __P((int c, struct tty *tp));
136typedef int l_start_t __P((struct tty *tp));
137typedef int l_modem_t __P((struct tty *tp, int flag));
138
139/*
140 * XXX: The dummy argument can be used to do what strategy1() never
141 * did anywhere:  Create a per device flag to lock the device during
142 * label/slice surgery, all calls with a dummy == 0 gets stalled on
143 * a queue somewhere, whereas dummy == 1 are let through.  Once out
144 * of surgery, reset the flag and restart all the stuff on the stall
145 * queue.
146 */
147#define BIO_STRATEGY(bp, dummy)						\
148	do {								\
149	if ((!(bp)->bio_cmd) || ((bp)->bio_cmd & ((bp)->bio_cmd - 1)))	\
150		Debugger("bio_cmd botch");				\
151	(*devsw((bp)->bio_dev)->d_strategy)(bp);			\
152	} while (0)
153
154#define DEV_STRATEGY(bp, dummy)						\
155	do {								\
156	if ((bp)->b_flags & B_PHYS)					\
157		(bp)->b_io.bio_offset = (bp)->b_offset;			\
158	else								\
159		(bp)->b_io.bio_offset = dbtob((bp)->b_blkno);		\
160	(bp)->b_io.bio_done = bufdonebio;				\
161	(bp)->b_io.bio_caller2 = (bp);					\
162	BIO_STRATEGY(&(bp)->b_io, dummy);				\
163	} while (0)
164
165/*
166 * Types for d_flags.
167 */
168#define	D_TAPE	0x0001
169#define	D_DISK	0x0002
170#define	D_TTY	0x0004
171#define	D_MEM	0x0008
172
173#define	D_TYPEMASK	0xffff
174
175/*
176 * Flags for d_flags.
177 */
178#define	D_MEMDISK	0x00010000	/* memory type disk */
179#define	D_NAGGED	0x00020000	/* nagged about missing make_dev() */
180#define	D_CANFREE	0x00040000	/* can free blocks */
181#define	D_TRACKCLOSE	0x00080000	/* track all closes */
182#define D_MMAP_ANON	0x00100000	/* special treatment in vm_mmap.c */
183#define D_KQFILTER	0x00200000	/* has kqfilter entry */
184
185/*
186 * Character device switch table
187 */
188struct cdevsw {
189	d_open_t	*d_open;
190	d_close_t	*d_close;
191	d_read_t	*d_read;
192	d_write_t	*d_write;
193	d_ioctl_t	*d_ioctl;
194	d_poll_t	*d_poll;
195	d_mmap_t	*d_mmap;
196	d_strategy_t	*d_strategy;
197	const char	*d_name;	/* base device name, e.g. 'vn' */
198	int		d_maj;
199	d_dump_t	*d_dump;
200	d_psize_t	*d_psize;
201	u_int		d_flags;
202	/* additions below are not binary compatible with 4.2 and below */
203	d_kqfilter_t	*d_kqfilter;
204};
205
206/*
207 * Line discipline switch table
208 */
209struct linesw {
210	l_open_t	*l_open;
211	l_close_t	*l_close;
212	l_read_t	*l_read;
213	l_write_t	*l_write;
214	l_ioctl_t	*l_ioctl;
215	l_rint_t	*l_rint;
216	l_start_t	*l_start;
217	l_modem_t	*l_modem;
218	u_char		l_hotchar;
219};
220
221#ifdef _KERNEL
222extern struct linesw linesw[];
223extern int nlinesw;
224
225int ldisc_register __P((int , struct linesw *));
226void ldisc_deregister __P((int));
227#define LDISC_LOAD 	-1		/* Loadable line discipline */
228#endif
229
230/*
231 * Swap device table
232 */
233struct swdevt {
234	udev_t	sw_dev;			/* For quasibogus swapdev reporting */
235	int	sw_flags;
236	int	sw_nblks;
237	int     sw_used;
238	struct	vnode *sw_vp;
239	dev_t	sw_device;
240};
241#define	SW_FREED	0x01
242#define	SW_SEQUENTIAL	0x02
243#define	sw_freed	sw_flags	/* XXX compat */
244
245#ifdef _KERNEL
246d_open_t	noopen;
247d_close_t	noclose;
248d_read_t	noread;
249d_write_t	nowrite;
250d_ioctl_t	noioctl;
251d_mmap_t	nommap;
252d_kqfilter_t	nokqfilter;
253#define	nostrategy	((d_strategy_t *)NULL)
254#define	nopoll	seltrue
255
256d_dump_t	nodump;
257
258#define NUMCDEVSW 256
259
260/*
261 * nopsize is little used, so not worth having dummy functions for.
262 */
263#define	nopsize	((d_psize_t *)NULL)
264
265d_open_t	nullopen;
266d_close_t	nullclose;
267
268l_read_t	l_noread;
269l_write_t	l_nowrite;
270
271struct module;
272
273struct devsw_module_data {
274	int	(*chainevh)(struct module *, int, void *); /* next handler */
275	void	*chainarg;	/* arg for next event handler */
276	/* Do not initialize fields hereafter */
277};
278
279#define DEV_MODULE(name, evh, arg)					\
280static moduledata_t name##_mod = {					\
281    #name,								\
282    evh,								\
283    arg									\
284};									\
285DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
286
287
288int	cdevsw_add __P((struct cdevsw *new));
289int	cdevsw_remove __P((struct cdevsw *old));
290int	count_dev __P((dev_t dev));
291void	destroy_dev __P((dev_t dev));
292struct cdevsw *devsw __P((dev_t dev));
293const char *devtoname __P((dev_t dev));
294void	freedev __P((dev_t dev));
295int	iszerodev __P((dev_t dev));
296dev_t	makebdev __P((int maj, int min));
297dev_t	make_dev __P((struct cdevsw *devsw, int minor, uid_t uid, gid_t gid, int perms, char *fmt, ...)) __printflike(6, 7);
298dev_t	make_dev_alias __P((dev_t pdev, char *fmt, ...)) __printflike(2, 3);
299int	dev2unit __P((dev_t dev));
300int	unit2minor __P((int unit));
301void	setconf __P((void));
302dev_t	getdiskbyname(char *name);
303
304/* This is type of the function DEVFS uses to hook into the kernel with */
305typedef void devfs_create_t __P((dev_t dev));
306typedef void devfs_destroy_t __P((dev_t dev));
307
308extern devfs_create_t *devfs_create_hook;
309extern devfs_destroy_t *devfs_destroy_hook;
310extern int devfs_present;
311
312/*
313 * XXX: This included for when DEVFS resurfaces
314 */
315
316#define		UID_ROOT	0
317#define		UID_BIN		3
318#define		UID_UUCP	66
319
320#define		GID_WHEEL	0
321#define		GID_KMEM	2
322#define		GID_OPERATOR	5
323#define		GID_BIN		7
324#define		GID_GAMES	13
325#define		GID_DIALER	68
326
327typedef void (*dev_clone_fn) __P((void *arg, char *name, int namelen, dev_t *result));
328
329int dev_stdclone __P((char *name, char **namep, char *stem, int *unit));
330EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
331#endif /* _KERNEL */
332
333#endif /* !_SYS_CONF_H_ */
334