conf.h revision 110317
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 110317 2003-02-04 10:32:40Z phk $
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 cdev {
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#define SI_DUMPDEV	0x0080	/* is kernel dumpdev */
66	struct timespec	si_atime;
67	struct timespec	si_ctime;
68	struct timespec	si_mtime;
69	udev_t		si_udev;
70	LIST_ENTRY(cdev)	si_hash;
71	SLIST_HEAD(, vnode)	si_hlist;
72	LIST_HEAD(, cdev)	si_children;
73	LIST_ENTRY(cdev)	si_siblings;
74	dev_t		si_parent;
75	u_int		si_inode;
76	char		*si_name;
77	void		*si_drv1, *si_drv2;
78	struct cdevsw	*si_devsw;
79	int		si_iosize_max;	/* maximum I/O size (for physio &al) */
80	uid_t		si_uid;
81	gid_t		si_gid;
82	mode_t		si_mode;
83	u_long		si_usecount;
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			struct snaphead	__sid_snapshots;
94			daddr_t __sid_snaplistsize; /* size of snapblklist. */
95			daddr_t	*__sid_snapblklist; /* known snapshot blocks. */
96			int (*__sid_copyonwrite)(struct vnode *, struct buf *);
97		} __si_disk;
98	} __si_u;
99	char		__si_namebuf[SPECNAMELEN + 1];
100};
101
102#define si_tty		__si_u.__si_tty.__sit_tty
103#define si_disk		__si_u.__si_disk.__sid_disk
104#define si_mountpoint	__si_u.__si_disk.__sid_mountpoint
105#define si_bsize_phys	__si_u.__si_disk.__sid_bsize_phys
106#define si_bsize_best	__si_u.__si_disk.__sid_bsize_best
107#define si_snapshots	__si_u.__si_disk.__sid_snapshots
108#define si_snaplistsize	__si_u.__si_disk.__sid_snaplistsize
109#define si_snapblklist	__si_u.__si_disk.__sid_snapblklist
110#define si_copyonwrite	__si_u.__si_disk.__sid_copyonwrite
111
112/*
113 * Special device management
114 */
115#define	SPECHSZ	64
116#define	SPECHASH(rdev)	(((unsigned)(minor(rdev)))%SPECHSZ)
117
118/*
119 * Definitions of device driver entry switches
120 */
121
122struct bio;
123struct buf;
124struct thread;
125struct uio;
126struct knote;
127
128/*
129 * Note: d_thread_t is provided as a transition aid for those drivers
130 * that treat struct proc/struct thread as an opaque data type and
131 * exist in substantially the same form in both 4.x and 5.x.  Writers
132 * of drivers that dips into the d_thread_t structure should use
133 * struct thread or struct proc as appropriate for the version of the
134 * OS they are using.  It is provided in lieu of each device driver
135 * inventing its own way of doing this.  While it does violate style(9)
136 * in a number of ways, this violation is deemed to be less
137 * important than the benefits that a uniform API between releases
138 * gives.
139 *
140 * Users of struct thread/struct proc that aren't device drivers should
141 * not use d_thread_t.
142 */
143
144typedef struct thread d_thread_t;
145
146typedef int d_open_t(dev_t dev, int oflags, int devtype, struct thread *td);
147typedef int d_close_t(dev_t dev, int fflag, int devtype, struct thread *td);
148typedef void d_strategy_t(struct bio *bp);
149typedef int d_ioctl_t(dev_t dev, u_long cmd, caddr_t data,
150		      int fflag, struct thread *td);
151typedef int d_dump_t(dev_t dev,void *virtual, vm_offset_t physical, off_t offset, size_t length);
152typedef int d_psize_t(dev_t dev);
153
154typedef int d_read_t(dev_t dev, struct uio *uio, int ioflag);
155typedef int d_write_t(dev_t dev, struct uio *uio, int ioflag);
156typedef int d_poll_t(dev_t dev, int events, struct thread *td);
157typedef int d_kqfilter_t(dev_t dev, struct knote *kn);
158typedef int d_mmap_t(dev_t dev, vm_offset_t offset, int nprot);
159
160typedef int l_open_t(dev_t dev, struct tty *tp);
161typedef int l_close_t(struct tty *tp, int flag);
162typedef int l_read_t(struct tty *tp, struct uio *uio, int flag);
163typedef int l_write_t(struct tty *tp, struct uio *uio, int flag);
164typedef int l_ioctl_t(struct tty *tp, u_long cmd, caddr_t data,
165		      int flag, struct thread *td);
166typedef int l_rint_t(int c, struct tty *tp);
167typedef int l_start_t(struct tty *tp);
168typedef int l_modem_t(struct tty *tp, int flag);
169
170#define BIO_STRATEGY(bp)						\
171	do {								\
172	if ((!(bp)->bio_cmd) || ((bp)->bio_cmd & ((bp)->bio_cmd - 1)))	\
173		Debugger("bio_cmd botch");				\
174	(*devsw((bp)->bio_dev)->d_strategy)(bp);			\
175	} while (0)
176
177#define DEV_STRATEGY(bp)						\
178	do {								\
179	if ((bp)->b_flags & B_PHYS)					\
180		(bp)->b_io.bio_offset = (bp)->b_offset;			\
181	else								\
182		(bp)->b_io.bio_offset = dbtob((bp)->b_blkno);		\
183	(bp)->b_io.bio_done = bufdonebio;				\
184	(bp)->b_io.bio_caller2 = (bp);					\
185	BIO_STRATEGY(&(bp)->b_io);					\
186	} while (0)
187
188#endif /* _KERNEL */
189
190/*
191 * Types for d_flags.
192 */
193#define	D_TAPE	0x0001
194#define	D_DISK	0x0002
195#define	D_TTY	0x0004
196#define	D_MEM	0x0008
197
198#ifdef _KERNEL
199
200#define	D_TYPEMASK	0xffff
201
202/*
203 * Flags for d_flags.
204 */
205#define	D_MEMDISK	0x00010000	/* memory type disk */
206#define	D_NAGGED	0x00020000	/* nagged about missing make_dev() */
207#define	D_CANFREE	0x00040000	/* can free blocks */
208#define	D_TRACKCLOSE	0x00080000	/* track all closes */
209#define D_MMAP_ANON	0x00100000	/* special treatment in vm_mmap.c */
210#define D_KQFILTER	0x00200000	/* has kqfilter entry */
211#define D_NOGIANT	0x00400000	/* Doesn't want Giant */
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(int , struct linesw *);
253void ldisc_deregister(int);
254#define LDISC_LOAD 	-1		/* Loadable line discipline */
255#endif /* _KERNEL */
256
257#ifdef _KERNEL
258d_open_t	noopen;
259d_close_t	noclose;
260d_read_t	noread;
261d_write_t	nowrite;
262d_ioctl_t	noioctl;
263d_mmap_t	nommap;
264d_kqfilter_t	nokqfilter;
265#define	nostrategy	((d_strategy_t *)NULL)
266#define	nopoll	seltrue
267
268d_dump_t	nodump;
269
270#define NUMCDEVSW 256
271
272/*
273 * nopsize is little used, so not worth having dummy functions for.
274 */
275#define	nopsize	((d_psize_t *)NULL)
276
277d_open_t	nullopen;
278d_close_t	nullclose;
279
280l_ioctl_t	l_nullioctl;
281l_read_t	l_noread;
282l_write_t	l_nowrite;
283
284struct module;
285
286struct devsw_module_data {
287	int	(*chainevh)(struct module *, int, void *); /* next handler */
288	void	*chainarg;	/* arg for next event handler */
289	/* Do not initialize fields hereafter */
290};
291
292#define DEV_MODULE(name, evh, arg)					\
293static moduledata_t name##_mod = {					\
294    #name,								\
295    evh,								\
296    arg									\
297};									\
298DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
299
300
301int	cdevsw_add(struct cdevsw *_new);
302int	cdevsw_remove(struct cdevsw *_old);
303int	count_dev(dev_t _dev);
304void	destroy_dev(dev_t _dev);
305void	revoke_and_destroy_dev(dev_t _dev);
306struct cdevsw *devsw(dev_t _dev);
307const char *devtoname(dev_t _dev);
308int	dev_named(dev_t _pdev, const char *_name);
309void	dev_depends(dev_t _pdev, dev_t _cdev);
310void	freedev(dev_t _dev);
311dev_t	makebdev(int _maj, int _min);
312dev_t	make_dev(struct cdevsw *_devsw, int _minor, uid_t _uid, gid_t _gid,
313		int _perms, const char *_fmt, ...) __printflike(6, 7);
314dev_t	make_dev_alias(dev_t _pdev, const char *_fmt, ...) __printflike(2, 3);
315int	dev2unit(dev_t _dev);
316int	unit2minor(int _unit);
317void	setconf(void);
318dev_t	getdiskbyname(char *_name);
319
320/* This is type of the function DEVFS uses to hook into the kernel with */
321typedef void devfs_create_t(dev_t dev);
322typedef void devfs_destroy_t(dev_t dev);
323
324extern devfs_create_t *devfs_create_hook;
325extern devfs_destroy_t *devfs_destroy_hook;
326
327#define		UID_ROOT	0
328#define		UID_BIN		3
329#define		UID_UUCP	66
330
331#define		GID_WHEEL	0
332#define		GID_KMEM	2
333#define		GID_OPERATOR	5
334#define		GID_BIN		7
335#define		GID_GAMES	13
336#define		GID_DIALER	68
337
338typedef void (*dev_clone_fn)(void *arg, char *name, int namelen, dev_t *result);
339
340int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit);
341EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
342
343/* Stuff relating to kernel-dump */
344
345typedef int dumper_t(
346	void *priv,		/* Private to the driver. */
347	void *virtual,		/* Virtual (mapped) address. */
348	vm_offset_t physical,	/* Physical address of virtual. */
349	off_t offset,		/* Byte-offset to write at. */
350	size_t length);		/* Number of bytes to dump. */
351
352struct dumperinfo {
353	dumper_t *dumper;	/* Dumping function. */
354	void    *priv;		/* Private parts. */
355	u_int   blocksize;	/* Size of block in bytes. */
356	off_t   mediaoffset;	/* Initial offset in bytes. */
357	off_t   mediasize;	/* Space available in bytes. */
358};
359
360int set_dumper(struct dumperinfo *);
361void dumpsys(struct dumperinfo *);
362extern int dumping;		/* system is dumping */
363
364#endif /* _KERNEL */
365
366#endif /* !_SYS_CONF_H_ */
367