conf.h revision 65374 
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 65374 2000-09-02 19:17:34Z 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
50#define SPECNAMELEN	15
51
52struct tty;
53struct disk;
54struct vnode;
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	struct timespec	si_atime;
61	struct timespec	si_ctime;
62	struct timespec	si_mtime;
63	udev_t		si_udev;
64	LIST_ENTRY(specinfo)	si_hash;
65	SLIST_HEAD(, vnode)	si_hlist;
66	LIST_HEAD(, specinfo)	si_names;
67	u_int		si_inode;
68	char		si_name[SPECNAMELEN + 1];
69	void		*si_drv1, *si_drv2;
70	struct cdevsw	*si_devsw;
71	int		si_iosize_max;	/* maximum I/O size (for physio &al) */
72	uid_t		si_uid;
73	gid_t		si_gid;
74	mode_t		si_mode;
75	union {
76		struct {
77			struct tty *__sit_tty;
78		} __si_tty;
79		struct {
80			struct disk *__sid_disk;
81			struct mount *__sid_mountpoint;
82			int __sid_bsize_phys; /* min physical block size */
83			int __sid_bsize_best; /* optimal block size */
84		} __si_disk;
85	} __si_u;
86};
87
88#define si_tty		__si_u.__si_tty.__sit_tty
89#define si_disk		__si_u.__si_disk.__sid_disk
90#define si_mountpoint	__si_u.__si_disk.__sid_mountpoint
91#define si_bsize_phys	__si_u.__si_disk.__sid_bsize_phys
92#define si_bsize_best	__si_u.__si_disk.__sid_bsize_best
93
94/*
95 * Exported shorthand
96 */
97#define v_hashchain v_rdev->si_hlist
98#define v_specmountpoint v_rdev->si_mountpoint
99
100/*
101 * Special device management
102 */
103#define	SPECHSZ	64
104#define	SPECHASH(rdev)	(((unsigned)(minor(rdev)))%SPECHSZ)
105
106/*
107 * Definitions of device driver entry switches
108 */
109
110struct bio;
111struct buf;
112struct proc;
113struct uio;
114
115typedef int d_open_t __P((dev_t dev, int oflags, int devtype, struct proc *p));
116typedef int d_close_t __P((dev_t dev, int fflag, int devtype, struct proc *p));
117typedef void d_strategy_t __P((struct bio *bp));
118typedef int d_parms_t __P((dev_t dev, struct specinfo *sinfo, int ctl));
119typedef int d_ioctl_t __P((dev_t dev, u_long cmd, caddr_t data,
120			   int fflag, struct proc *p));
121typedef int d_dump_t __P((dev_t dev));
122typedef int d_psize_t __P((dev_t dev));
123
124typedef int d_read_t __P((dev_t dev, struct uio *uio, int ioflag));
125typedef int d_write_t __P((dev_t dev, struct uio *uio, int ioflag));
126typedef int d_poll_t __P((dev_t dev, int events, struct proc *p));
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	0x10000		/* memory type disk */
179#define	D_NAGGED	0x20000		/* nagged about missing make_dev() */
180#define	D_CANFREE	0x40000		/* can free blocks */
181#define	D_TRACKCLOSE	0x80000		/* track all closes */
182#define D_MMAP_ANON	0x100000	/* special treatment in vm_mmap.c */
183
184/*
185 * Character device switch table
186 */
187struct cdevsw {
188	d_open_t	*d_open;
189	d_close_t	*d_close;
190	d_read_t	*d_read;
191	d_write_t	*d_write;
192	d_ioctl_t	*d_ioctl;
193	d_poll_t	*d_poll;
194	d_mmap_t	*d_mmap;
195	d_strategy_t	*d_strategy;
196	const char	*d_name;	/* base device name, e.g. 'vn' */
197	int		d_maj;
198	d_dump_t	*d_dump;
199	d_psize_t	*d_psize;
200	u_int		d_flags;
201	int		d_bmaj;
202};
203
204/*
205 * Line discipline switch table
206 */
207struct linesw {
208	l_open_t	*l_open;
209	l_close_t	*l_close;
210	l_read_t	*l_read;
211	l_write_t	*l_write;
212	l_ioctl_t	*l_ioctl;
213	l_rint_t	*l_rint;
214	l_start_t	*l_start;
215	l_modem_t	*l_modem;
216	u_char		l_hotchar;
217};
218
219#ifdef _KERNEL
220extern struct linesw linesw[];
221extern int nlinesw;
222
223int ldisc_register __P((int , struct linesw *));
224void ldisc_deregister __P((int));
225#define LDISC_LOAD 	-1		/* Loadable line discipline */
226#endif
227
228/*
229 * Swap device table
230 */
231struct swdevt {
232	udev_t	sw_dev;			/* For quasibogus swapdev reporting */
233	int	sw_flags;
234	int	sw_nblks;
235	struct	vnode *sw_vp;
236	dev_t	sw_device;
237};
238#define	SW_FREED	0x01
239#define	SW_SEQUENTIAL	0x02
240#define	sw_freed	sw_flags	/* XXX compat */
241
242#ifdef _KERNEL
243d_open_t	noopen;
244d_close_t	noclose;
245d_read_t	noread;
246d_write_t	nowrite;
247d_ioctl_t	noioctl;
248d_mmap_t	nommap;
249#define	nostrategy	((d_strategy_t *)NULL)
250#define	nopoll	seltrue
251
252d_dump_t	nodump;
253
254#define NUMCDEVSW 256
255
256/*
257 * nopsize is little used, so not worth having dummy functions for.
258 */
259#define	nopsize	((d_psize_t *)NULL)
260
261d_open_t	nullopen;
262d_close_t	nullclose;
263
264l_read_t	l_noread;
265l_write_t	l_nowrite;
266
267struct module;
268
269struct devsw_module_data {
270	int	(*chainevh)(struct module *, int, void *); /* next handler */
271	void	*chainarg;	/* arg for next event handler */
272	/* Do not initialize fields hereafter */
273};
274
275#define DEV_MODULE(name, evh, arg)					\
276static moduledata_t name##_mod = {					\
277    #name,								\
278    evh,								\
279    arg									\
280};									\
281DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
282
283
284int	cdevsw_add __P((struct cdevsw *new));
285int	cdevsw_remove __P((struct cdevsw *old));
286int	count_dev __P((dev_t dev));
287void	destroy_dev __P((dev_t dev));
288struct cdevsw *devsw __P((dev_t dev));
289const char *devtoname __P((dev_t dev));
290void	freedev __P((dev_t dev));
291int	iszerodev __P((dev_t dev));
292dev_t	makebdev __P((int maj, int min));
293dev_t	make_dev __P((struct cdevsw *devsw, int minor, uid_t uid, gid_t gid, int perms, char *fmt, ...)) __printflike(6, 7);
294dev_t	make_dev_alias __P((dev_t pdev, char *fmt, ...)) __printflike(2, 3);
295int	lminor __P((dev_t dev));
296void	setconf __P((void));
297dev_t	getdiskbyname(char *name);
298
299/* This is type of the function DEVFS uses to hook into the kernel with */
300typedef void devfs_create_t __P((dev_t dev));
301typedef void devfs_destroy_t __P((dev_t dev));
302
303extern devfs_create_t *devfs_create_hook;
304extern devfs_destroy_t *devfs_destroy_hook;
305extern int devfs_present;
306
307/*
308 * XXX: This included for when DEVFS resurfaces
309 */
310
311#define		UID_ROOT	0
312#define		UID_BIN		3
313#define		UID_UUCP	66
314
315#define		GID_WHEEL	0
316#define		GID_KMEM	2
317#define		GID_OPERATOR	5
318#define		GID_BIN		7
319#define		GID_GAMES	13
320#define		GID_DIALER	68
321
322typedef void (*dev_clone_fn) __P((void *arg, char *name, int namelen, dev_t *result));
323
324int dev_stdclone __P((char *name, char **namep, char *stem, int *unit));
325EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
326#endif /* _KERNEL */
327
328#endif /* !_SYS_CONF_H_ */
329