conf.h revision 104043
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 104043 2002-09-27 18:27:10Z 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	struct snaphead	si_snapshots;
76	int		(*si_copyonwrite)(struct vnode *, struct buf *);
77	u_int		si_inode;
78	char		si_name[SPECNAMELEN + 1];
79	void		*si_drv1, *si_drv2;
80	struct cdevsw	*si_devsw;
81	int		si_iosize_max;	/* maximum I/O size (for physio &al) */
82	uid_t		si_uid;
83	gid_t		si_gid;
84	mode_t		si_mode;
85	union {
86		struct {
87			struct tty *__sit_tty;
88		} __si_tty;
89		struct {
90			struct disk *__sid_disk;
91			struct mount *__sid_mountpoint;
92			int __sid_bsize_phys; /* min physical block size */
93			int __sid_bsize_best; /* optimal block size */
94		} __si_disk;
95	} __si_u;
96};
97
98#define si_tty		__si_u.__si_tty.__sit_tty
99#define si_disk		__si_u.__si_disk.__sid_disk
100#define si_mountpoint	__si_u.__si_disk.__sid_mountpoint
101#define si_bsize_phys	__si_u.__si_disk.__sid_bsize_phys
102#define si_bsize_best	__si_u.__si_disk.__sid_bsize_best
103
104/*
105 * Special device management
106 */
107#define	SPECHSZ	64
108#define	SPECHASH(rdev)	(((unsigned)(minor(rdev)))%SPECHSZ)
109
110/*
111 * Definitions of device driver entry switches
112 */
113
114struct bio;
115struct buf;
116struct thread;
117struct uio;
118struct knote;
119
120/*
121 * Note: d_thread_t is provided as a transition aid for those drivers
122 * that treat struct proc/struct thread as an opaque data type and
123 * exist in substantially the same form in both 4.x and 5.x.  Writers
124 * of drivers that dips into the d_thread_t structure should use
125 * struct thread or struct proc as appropriate for the version of the
126 * OS they are using.  It is provided in lieu of each device driver
127 * inventing its own way of doing this.  While it does violate style(9)
128 * in a number of ways, this violation is deemed to be less
129 * important than the benefits that a uniform API between releases
130 * gives.
131 *
132 * Users of struct thread/struct proc that aren't device drivers should
133 * not use d_thread_t.
134 */
135
136typedef struct thread d_thread_t;
137
138typedef int d_open_t(dev_t dev, int oflags, int devtype, struct thread *td);
139typedef int d_close_t(dev_t dev, int fflag, int devtype, struct thread *td);
140typedef void d_strategy_t(struct bio *bp);
141typedef int d_ioctl_t(dev_t dev, u_long cmd, caddr_t data,
142		      int fflag, struct thread *td);
143typedef int d_dump_t(dev_t dev,void *virtual, vm_offset_t physical, off_t offset, size_t length);
144typedef int d_psize_t(dev_t dev);
145
146typedef int d_read_t(dev_t dev, struct uio *uio, int ioflag);
147typedef int d_write_t(dev_t dev, struct uio *uio, int ioflag);
148typedef int d_poll_t(dev_t dev, int events, struct thread *td);
149typedef int d_kqfilter_t(dev_t dev, struct knote *kn);
150typedef int d_mmap_t(dev_t dev, vm_offset_t offset, int nprot);
151
152typedef int l_open_t(dev_t dev, struct tty *tp);
153typedef int l_close_t(struct tty *tp, int flag);
154typedef int l_read_t(struct tty *tp, struct uio *uio, int flag);
155typedef int l_write_t(struct tty *tp, struct uio *uio, int flag);
156typedef int l_ioctl_t(struct tty *tp, u_long cmd, caddr_t data,
157		      int flag, struct thread *td);
158typedef int l_rint_t(int c, struct tty *tp);
159typedef int l_start_t(struct tty *tp);
160typedef int l_modem_t(struct tty *tp, int flag);
161
162/*
163 * XXX: The dummy argument can be used to do what strategy1() never
164 * did anywhere:  Create a per device flag to lock the device during
165 * label/slice surgery, all calls with a dummy == 0 gets stalled on
166 * a queue somewhere, whereas dummy == 1 are let through.  Once out
167 * of surgery, reset the flag and restart all the stuff on the stall
168 * queue.
169 */
170#define BIO_STRATEGY(bp, dummy)						\
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, dummy)						\
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, dummy);				\
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
212/*
213 * Character device switch table
214 */
215struct cdevsw {
216	d_open_t	*d_open;
217	d_close_t	*d_close;
218	d_read_t	*d_read;
219	d_write_t	*d_write;
220	d_ioctl_t	*d_ioctl;
221	d_poll_t	*d_poll;
222	d_mmap_t	*d_mmap;
223	d_strategy_t	*d_strategy;
224	const char	*d_name;	/* base device name, e.g. 'vn' */
225	int		d_maj;
226	d_dump_t	*d_dump;
227	d_psize_t	*d_psize;
228	u_int		d_flags;
229	/* additions below are not binary compatible with 4.2 and below */
230	d_kqfilter_t	*d_kqfilter;
231};
232
233/*
234 * Line discipline switch table
235 */
236struct linesw {
237	l_open_t	*l_open;
238	l_close_t	*l_close;
239	l_read_t	*l_read;
240	l_write_t	*l_write;
241	l_ioctl_t	*l_ioctl;
242	l_rint_t	*l_rint;
243	l_start_t	*l_start;
244	l_modem_t	*l_modem;
245	u_char		l_hotchar;
246};
247
248extern struct linesw linesw[];
249extern int nlinesw;
250
251int ldisc_register(int , struct linesw *);
252void ldisc_deregister(int);
253#define LDISC_LOAD 	-1		/* Loadable line discipline */
254#endif /* _KERNEL */
255
256/*
257 * Swap device table
258 */
259struct swdevt {
260	udev_t	sw_dev;			/* For quasibogus swapdev reporting */
261	int	sw_flags;
262	int	sw_nblks;
263	int     sw_used;
264	struct	vnode *sw_vp;
265	dev_t	sw_device;
266};
267#define	SW_FREED	0x01
268#define	SW_SEQUENTIAL	0x02
269#define	sw_freed	sw_flags	/* XXX compat */
270
271#ifdef _KERNEL
272d_open_t	noopen;
273d_close_t	noclose;
274d_read_t	noread;
275d_write_t	nowrite;
276d_ioctl_t	noioctl;
277d_mmap_t	nommap;
278d_kqfilter_t	nokqfilter;
279#define	nostrategy	((d_strategy_t *)NULL)
280#define	nopoll	seltrue
281
282d_dump_t	nodump;
283
284#define NUMCDEVSW 256
285
286/*
287 * nopsize is little used, so not worth having dummy functions for.
288 */
289#define	nopsize	((d_psize_t *)NULL)
290
291d_open_t	nullopen;
292d_close_t	nullclose;
293
294l_ioctl_t	l_nullioctl;
295l_read_t	l_noread;
296l_write_t	l_nowrite;
297
298struct module;
299
300struct devsw_module_data {
301	int	(*chainevh)(struct module *, int, void *); /* next handler */
302	void	*chainarg;	/* arg for next event handler */
303	/* Do not initialize fields hereafter */
304};
305
306#define DEV_MODULE(name, evh, arg)					\
307static moduledata_t name##_mod = {					\
308    #name,								\
309    evh,								\
310    arg									\
311};									\
312DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
313
314
315int	cdevsw_add(struct cdevsw *_new);
316int	cdevsw_remove(struct cdevsw *_old);
317int	count_dev(dev_t _dev);
318void	destroy_dev(dev_t _dev);
319void	revoke_and_destroy_dev(dev_t _dev);
320struct cdevsw *devsw(dev_t _dev);
321const char *devtoname(dev_t _dev);
322int	dev_named(dev_t _pdev, const char *_name);
323void	dev_depends(dev_t _pdev, dev_t _cdev);
324void	freedev(dev_t _dev);
325int	iszerodev(dev_t _dev);
326dev_t	makebdev(int _maj, int _min);
327dev_t	make_dev(struct cdevsw *_devsw, int _minor, uid_t _uid, gid_t _gid,
328		int _perms, const char *_fmt, ...) __printflike(6, 7);
329dev_t	make_dev_alias(dev_t _pdev, const char *_fmt, ...) __printflike(2, 3);
330int	dev2unit(dev_t _dev);
331int	unit2minor(int _unit);
332void	setconf(void);
333dev_t	getdiskbyname(char *_name);
334
335/* This is type of the function DEVFS uses to hook into the kernel with */
336typedef void devfs_create_t(dev_t dev);
337typedef void devfs_destroy_t(dev_t dev);
338
339extern devfs_create_t *devfs_create_hook;
340extern devfs_destroy_t *devfs_destroy_hook;
341extern int devfs_present;
342
343#define		UID_ROOT	0
344#define		UID_BIN		3
345#define		UID_UUCP	66
346
347#define		GID_WHEEL	0
348#define		GID_KMEM	2
349#define		GID_OPERATOR	5
350#define		GID_BIN		7
351#define		GID_GAMES	13
352#define		GID_DIALER	68
353
354typedef void (*dev_clone_fn)(void *arg, char *name, int namelen, dev_t *result);
355
356int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit);
357EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
358
359/* Stuff relating to kernel-dump */
360
361typedef int dumper_t(
362	void *priv,		/* Private to the driver. */
363	void *virtual,		/* Virtual (mapped) address. */
364	vm_offset_t physical,	/* Physical address of virtual. */
365	off_t offset,		/* Byte-offset to write at. */
366	size_t length);		/* Number of bytes to dump. */
367
368struct dumperinfo {
369	dumper_t *dumper;	/* Dumping function. */
370	void    *priv;		/* Private parts. */
371	u_int   blocksize;	/* Size of block in bytes. */
372	off_t   mediaoffset;	/* Initial offset in bytes. */
373	off_t   mediasize;	/* Space available in bytes. */
374};
375
376int set_dumper(struct dumperinfo *);
377void dumpsys(struct dumperinfo *);
378extern int dumping;		/* system is dumping */
379
380#endif /* _KERNEL */
381
382#endif /* !_SYS_CONF_H_ */
383