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