conf.h revision 81068 
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 81068 2001-08-02 20:35:35Z imp $
42 */
43
44#ifndef _SYS_CONF_H_
45#define	_SYS_CONF_H_
46
47#ifdef _KERNEL
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#define SI_CHILD	0x0010	/* child of another dev_t */
63	struct timespec	si_atime;
64	struct timespec	si_ctime;
65	struct timespec	si_mtime;
66	udev_t		si_udev;
67	LIST_ENTRY(specinfo)	si_hash;
68	SLIST_HEAD(, vnode)	si_hlist;
69	LIST_HEAD(, specinfo)	si_children;
70	LIST_ENTRY(specinfo)	si_siblings;
71	dev_t		si_parent;
72	struct snaphead	si_snapshots;
73	int		(*si_copyonwrite)(struct vnode *, struct buf *);
74	u_int		si_inode;
75	char		si_name[SPECNAMELEN + 1];
76	void		*si_drv1, *si_drv2;
77	struct cdevsw	*si_devsw;
78	int		si_iosize_max;	/* maximum I/O size (for physio &al) */
79	uid_t		si_uid;
80	gid_t		si_gid;
81	mode_t		si_mode;
82	union {
83		struct {
84			struct tty *__sit_tty;
85		} __si_tty;
86		struct {
87			struct disk *__sid_disk;
88			struct mount *__sid_mountpoint;
89			int __sid_bsize_phys; /* min physical block size */
90			int __sid_bsize_best; /* optimal block size */
91		} __si_disk;
92	} __si_u;
93};
94
95#define si_tty		__si_u.__si_tty.__sit_tty
96#define si_disk		__si_u.__si_disk.__sid_disk
97#define si_mountpoint	__si_u.__si_disk.__sid_mountpoint
98#define si_bsize_phys	__si_u.__si_disk.__sid_bsize_phys
99#define si_bsize_best	__si_u.__si_disk.__sid_bsize_best
100
101/*
102 * Special device management
103 */
104#define	SPECHSZ	64
105#define	SPECHASH(rdev)	(((unsigned)(minor(rdev)))%SPECHSZ)
106
107/*
108 * Definitions of device driver entry switches
109 */
110
111struct bio;
112struct buf;
113struct proc;
114struct uio;
115struct knote;
116
117typedef int d_open_t __P((dev_t dev, int oflags, int devtype, struct proc *p));
118typedef int d_close_t __P((dev_t dev, int fflag, int devtype, struct proc *p));
119typedef void d_strategy_t __P((struct bio *bp));
120typedef int d_ioctl_t __P((dev_t dev, u_long cmd, caddr_t data,
121			   int fflag, struct proc *p));
122typedef int d_dump_t __P((dev_t dev));
123typedef int d_psize_t __P((dev_t dev));
124
125typedef int d_read_t __P((dev_t dev, struct uio *uio, int ioflag));
126typedef int d_write_t __P((dev_t dev, struct uio *uio, int ioflag));
127typedef int d_poll_t __P((dev_t dev, int events, struct proc *p));
128typedef int d_kqfilter_t __P((dev_t dev, struct knote *kn));
129typedef int d_mmap_t __P((dev_t dev, vm_offset_t offset, int nprot));
130
131typedef int l_open_t __P((dev_t dev, struct tty *tp));
132typedef int l_close_t __P((struct tty *tp, int flag));
133typedef int l_read_t __P((struct tty *tp, struct uio *uio, int flag));
134typedef int l_write_t __P((struct tty *tp, struct uio *uio, int flag));
135typedef int l_ioctl_t __P((struct tty *tp, u_long cmd, caddr_t data,
136			   int flag, struct proc *p));
137typedef int l_rint_t __P((int c, struct tty *tp));
138typedef int l_start_t __P((struct tty *tp));
139typedef int l_modem_t __P((struct tty *tp, int flag));
140
141/*
142 * XXX: The dummy argument can be used to do what strategy1() never
143 * did anywhere:  Create a per device flag to lock the device during
144 * label/slice surgery, all calls with a dummy == 0 gets stalled on
145 * a queue somewhere, whereas dummy == 1 are let through.  Once out
146 * of surgery, reset the flag and restart all the stuff on the stall
147 * queue.
148 */
149#define BIO_STRATEGY(bp, dummy)						\
150	do {								\
151	if ((!(bp)->bio_cmd) || ((bp)->bio_cmd & ((bp)->bio_cmd - 1)))	\
152		Debugger("bio_cmd botch");				\
153	(*devsw((bp)->bio_dev)->d_strategy)(bp);			\
154	} while (0)
155
156#define DEV_STRATEGY(bp, dummy)						\
157	do {								\
158	if ((bp)->b_flags & B_PHYS)					\
159		(bp)->b_io.bio_offset = (bp)->b_offset;			\
160	else								\
161		(bp)->b_io.bio_offset = dbtob((bp)->b_blkno);		\
162	(bp)->b_io.bio_done = bufdonebio;				\
163	(bp)->b_io.bio_caller2 = (bp);					\
164	BIO_STRATEGY(&(bp)->b_io, dummy);				\
165	} while (0)
166
167#endif /* _KERNEL */
168
169/*
170 * Types for d_flags.
171 */
172#define	D_TAPE	0x0001
173#define	D_DISK	0x0002
174#define	D_TTY	0x0004
175#define	D_MEM	0x0008
176
177#ifdef _KERNEL
178
179#define	D_TYPEMASK	0xffff
180
181/*
182 * Flags for d_flags.
183 */
184#define	D_MEMDISK	0x00010000	/* memory type disk */
185#define	D_NAGGED	0x00020000	/* nagged about missing make_dev() */
186#define	D_CANFREE	0x00040000	/* can free blocks */
187#define	D_TRACKCLOSE	0x00080000	/* track all closes */
188#define D_MMAP_ANON	0x00100000	/* special treatment in vm_mmap.c */
189#define D_KQFILTER	0x00200000	/* has kqfilter entry */
190
191/*
192 * Character device switch table
193 */
194struct cdevsw {
195	d_open_t	*d_open;
196	d_close_t	*d_close;
197	d_read_t	*d_read;
198	d_write_t	*d_write;
199	d_ioctl_t	*d_ioctl;
200	d_poll_t	*d_poll;
201	d_mmap_t	*d_mmap;
202	d_strategy_t	*d_strategy;
203	const char	*d_name;	/* base device name, e.g. 'vn' */
204	int		d_maj;
205	d_dump_t	*d_dump;
206	d_psize_t	*d_psize;
207	u_int		d_flags;
208	/* additions below are not binary compatible with 4.2 and below */
209	d_kqfilter_t	*d_kqfilter;
210};
211
212/*
213 * Line discipline switch table
214 */
215struct linesw {
216	l_open_t	*l_open;
217	l_close_t	*l_close;
218	l_read_t	*l_read;
219	l_write_t	*l_write;
220	l_ioctl_t	*l_ioctl;
221	l_rint_t	*l_rint;
222	l_start_t	*l_start;
223	l_modem_t	*l_modem;
224	u_char		l_hotchar;
225};
226
227extern struct linesw linesw[];
228extern int nlinesw;
229
230int ldisc_register __P((int , struct linesw *));
231void ldisc_deregister __P((int));
232#define LDISC_LOAD 	-1		/* Loadable line discipline */
233#endif /* _KERNEL */
234
235/*
236 * Swap device table
237 */
238struct swdevt {
239	udev_t	sw_dev;			/* For quasibogus swapdev reporting */
240	int	sw_flags;
241	int	sw_nblks;
242	int     sw_used;
243	struct	vnode *sw_vp;
244	dev_t	sw_device;
245};
246#define	SW_FREED	0x01
247#define	SW_SEQUENTIAL	0x02
248#define	sw_freed	sw_flags	/* XXX compat */
249
250#ifdef _KERNEL
251d_open_t	noopen;
252d_close_t	noclose;
253d_read_t	noread;
254d_write_t	nowrite;
255d_ioctl_t	noioctl;
256d_mmap_t	nommap;
257d_kqfilter_t	nokqfilter;
258#define	nostrategy	((d_strategy_t *)NULL)
259#define	nopoll	seltrue
260
261d_dump_t	nodump;
262
263#define NUMCDEVSW 256
264
265/*
266 * nopsize is little used, so not worth having dummy functions for.
267 */
268#define	nopsize	((d_psize_t *)NULL)
269
270d_open_t	nullopen;
271d_close_t	nullclose;
272
273l_ioctl_t	l_nullioctl;
274l_read_t	l_noread;
275l_write_t	l_nowrite;
276
277struct module;
278
279struct devsw_module_data {
280	int	(*chainevh)(struct module *, int, void *); /* next handler */
281	void	*chainarg;	/* arg for next event handler */
282	/* Do not initialize fields hereafter */
283};
284
285#define DEV_MODULE(name, evh, arg)					\
286static moduledata_t name##_mod = {					\
287    #name,								\
288    evh,								\
289    arg									\
290};									\
291DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
292
293
294int	cdevsw_add __P((struct cdevsw *new));
295int	cdevsw_remove __P((struct cdevsw *old));
296int	count_dev __P((dev_t dev));
297void	destroy_dev __P((dev_t dev));
298struct cdevsw *devsw __P((dev_t dev));
299const char *devtoname __P((dev_t dev));
300void	dev_depends __P((dev_t pdev, dev_t cdev));
301void	freedev __P((dev_t dev));
302int	iszerodev __P((dev_t dev));
303dev_t	makebdev __P((int maj, int min));
304dev_t	make_dev __P((struct cdevsw *devsw, int minor, uid_t uid, gid_t gid, int perms, const char *fmt, ...)) __printflike(6, 7);
305dev_t	make_dev_alias __P((dev_t pdev, const char *fmt, ...)) __printflike(2, 3);
306int	dev2unit __P((dev_t dev));
307int	unit2minor __P((int unit));
308void	setconf __P((void));
309dev_t	getdiskbyname(char *name);
310
311/* This is type of the function DEVFS uses to hook into the kernel with */
312typedef void devfs_create_t __P((dev_t dev));
313typedef void devfs_destroy_t __P((dev_t dev));
314
315extern devfs_create_t *devfs_create_hook;
316extern devfs_destroy_t *devfs_destroy_hook;
317extern int devfs_present;
318
319/*
320 * XXX: This included for when DEVFS resurfaces
321 */
322
323#define		UID_ROOT	0
324#define		UID_BIN		3
325#define		UID_UUCP	66
326
327#define		GID_WHEEL	0
328#define		GID_KMEM	2
329#define		GID_OPERATOR	5
330#define		GID_BIN		7
331#define		GID_GAMES	13
332#define		GID_DIALER	68
333
334typedef void (*dev_clone_fn) __P((void *arg, char *name, int namelen, dev_t *result));
335
336int dev_stdclone __P((char *name, char **namep, char *stem, int *unit));
337EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
338#endif /* _KERNEL */
339
340#endif /* !_SYS_CONF_H_ */
341