conf.h revision 126077
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 126077 2004-02-21 20:29:52Z 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#define SI_CANDELETE	0x0100	/* can do BIO_DELETE */
67#define SI_CLONELIST	0x0200	/* on a clone list */
68	struct timespec	si_atime;
69	struct timespec	si_ctime;
70	struct timespec	si_mtime;
71	udev_t		si_udev;
72	LIST_ENTRY(cdev)	si_clone;
73	LIST_ENTRY(cdev)	si_hash;
74	SLIST_HEAD(, vnode)	si_hlist;
75	LIST_HEAD(, cdev)	si_children;
76	LIST_ENTRY(cdev)	si_siblings;
77	dev_t		si_parent;
78	u_int		si_inode;
79	char		*si_name;
80	void		*si_drv1, *si_drv2;
81	struct cdevsw	*si_devsw;
82	int		si_iosize_max;	/* maximum I/O size (for physio &al) */
83	u_int		si_stripesize;
84	u_int		si_stripeoffset;
85	uid_t		si_uid;
86	gid_t		si_gid;
87	mode_t		si_mode;
88	u_long		si_usecount;
89	union {
90		struct {
91			struct tty *__sit_tty;
92		} __si_tty;
93		struct {
94			struct mount *__sid_mountpoint;
95			int __sid_bsize_phys; /* min physical block size */
96			int __sid_bsize_best; /* optimal block size */
97			struct snaphead	__sid_snapshots;
98			daddr_t __sid_snaplistsize; /* size of snapblklist. */
99			daddr_t	*__sid_snapblklist; /* known snapshot blocks. */
100			int (*__sid_copyonwrite)(struct vnode *, struct buf *);
101		} __si_disk;
102	} __si_u;
103	char		__si_namebuf[SPECNAMELEN + 1];
104};
105
106#define si_tty		__si_u.__si_tty.__sit_tty
107#define si_mountpoint	__si_u.__si_disk.__sid_mountpoint
108#define si_bsize_phys	__si_u.__si_disk.__sid_bsize_phys
109#define si_bsize_best	__si_u.__si_disk.__sid_bsize_best
110#define si_snapshots	__si_u.__si_disk.__sid_snapshots
111#define si_snaplistsize	__si_u.__si_disk.__sid_snaplistsize
112#define si_snapblklist	__si_u.__si_disk.__sid_snapblklist
113#define si_copyonwrite	__si_u.__si_disk.__sid_copyonwrite
114
115/*
116 * Special device management
117 */
118#define	SPECHSZ	64
119#define	SPECHASH(rdev)	(((unsigned)(minor(rdev)))%SPECHSZ)
120
121/*
122 * Definitions of device driver entry switches
123 */
124
125struct bio;
126struct buf;
127struct thread;
128struct uio;
129struct knote;
130struct clonedevs;
131
132/*
133 * Note: d_thread_t is provided as a transition aid for those drivers
134 * that treat struct proc/struct thread as an opaque data type and
135 * exist in substantially the same form in both 4.x and 5.x.  Writers
136 * of drivers that dips into the d_thread_t structure should use
137 * struct thread or struct proc as appropriate for the version of the
138 * OS they are using.  It is provided in lieu of each device driver
139 * inventing its own way of doing this.  While it does violate style(9)
140 * in a number of ways, this violation is deemed to be less
141 * important than the benefits that a uniform API between releases
142 * gives.
143 *
144 * Users of struct thread/struct proc that aren't device drivers should
145 * not use d_thread_t.
146 */
147
148typedef struct thread d_thread_t;
149
150typedef int d_open_t(dev_t dev, int oflags, int devtype, struct thread *td);
151typedef int d_fdopen_t(dev_t dev, int oflags, struct thread *td, int fdidx);
152typedef int d_close_t(dev_t dev, int fflag, int devtype, struct thread *td);
153typedef void d_strategy_t(struct bio *bp);
154typedef int d_ioctl_t(dev_t dev, u_long cmd, caddr_t data,
155		      int fflag, struct thread *td);
156
157typedef int d_read_t(dev_t dev, struct uio *uio, int ioflag);
158typedef int d_write_t(dev_t dev, struct uio *uio, int ioflag);
159typedef int d_poll_t(dev_t dev, int events, struct thread *td);
160typedef int d_kqfilter_t(dev_t dev, struct knote *kn);
161typedef int d_mmap_t(dev_t dev, vm_offset_t offset, vm_paddr_t *paddr,
162   		     int nprot);
163
164typedef int l_open_t(dev_t dev, struct tty *tp);
165typedef int l_close_t(struct tty *tp, int flag);
166typedef int l_read_t(struct tty *tp, struct uio *uio, int flag);
167typedef int l_write_t(struct tty *tp, struct uio *uio, int flag);
168typedef int l_ioctl_t(struct tty *tp, u_long cmd, caddr_t data,
169		      int flag, struct thread *td);
170typedef int l_rint_t(int c, struct tty *tp);
171typedef int l_start_t(struct tty *tp);
172typedef int l_modem_t(struct tty *tp, int flag);
173
174typedef int dumper_t(
175	void *priv,		/* Private to the driver. */
176	void *virtual,		/* Virtual (mapped) address. */
177	vm_offset_t physical,	/* Physical address of virtual. */
178	off_t offset,		/* Byte-offset to write at. */
179	size_t length);		/* Number of bytes to dump. */
180
181#define DEV_STRATEGY(bp) dev_strategy(bp)
182
183#endif /* _KERNEL */
184
185/*
186 * Types for d_flags.
187 */
188#define	D_TAPE	0x0001
189#define	D_DISK	0x0002
190#define	D_TTY	0x0004
191#define	D_MEM	0x0008
192
193#ifdef _KERNEL
194
195#define	D_TYPEMASK	0xffff
196
197/*
198 * Flags for d_flags.
199 */
200#define	D_MEMDISK	0x00010000	/* memory type disk */
201#define	D_NAGGED	0x00020000	/* nagged about missing make_dev() */
202#define	D_TRACKCLOSE	0x00080000	/* track all closes */
203#define D_MMAP_ANON	0x00100000	/* special treatment in vm_mmap.c */
204#define D_PSEUDO	0x00200000	/* make_dev() can return NULL */
205#define D_NOGIANT	0x00400000	/* Doesn't want Giant */
206
207/*
208 * Character device switch table
209 */
210struct cdevsw {
211	int		d_maj;
212	u_int		d_flags;
213	const char	*d_name;
214	d_open_t	*d_open;
215	d_fdopen_t	*d_fdopen;
216	d_close_t	*d_close;
217	d_read_t	*d_read;
218	d_write_t	*d_write;
219	d_ioctl_t	*d_ioctl;
220	d_poll_t	*d_poll;
221	d_mmap_t	*d_mmap;
222	d_strategy_t	*d_strategy;
223	dumper_t	*d_dump;
224	d_kqfilter_t	*d_kqfilter;
225};
226
227/*
228 * Line discipline switch table
229 */
230struct linesw {
231	l_open_t	*l_open;
232	l_close_t	*l_close;
233	l_read_t	*l_read;
234	l_write_t	*l_write;
235	l_ioctl_t	*l_ioctl;
236	l_rint_t	*l_rint;
237	l_start_t	*l_start;
238	l_modem_t	*l_modem;
239	u_char		l_hotchar;
240};
241
242extern struct linesw linesw[];
243extern int nlinesw;
244
245int ldisc_register(int , struct linesw *);
246void ldisc_deregister(int);
247#define LDISC_LOAD 	-1		/* Loadable line discipline */
248#endif /* _KERNEL */
249
250#ifdef _KERNEL
251
252#define NUMCDEVSW 256
253
254/*
255 * XXX: do not use MAJOR_AUTO unless you have no choice.  In general drivers
256 * should just not initialize .d_maj and that will DTRT.
257 */
258#define	MAJOR_AUTO	0	/* XXX: Not GM */
259
260l_ioctl_t	l_nullioctl;
261l_read_t	l_noread;
262l_write_t	l_nowrite;
263
264struct module;
265
266struct devsw_module_data {
267	int	(*chainevh)(struct module *, int, void *); /* next handler */
268	void	*chainarg;	/* arg for next event handler */
269	/* Do not initialize fields hereafter */
270};
271
272#define DEV_MODULE(name, evh, arg)					\
273static moduledata_t name##_mod = {					\
274    #name,								\
275    evh,								\
276    arg									\
277};									\
278DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
279
280
281void clone_cleanup(struct clonedevs **);
282#define CLONE_UNITMASK 0xfffff
283#define CLONE_FLAG0 (CLONE_UNITMASK + 1)
284int clone_create(struct clonedevs **, struct cdevsw *, int *unit, dev_t *dev, u_int extra);
285
286int	count_dev(dev_t _dev);
287void	destroy_dev(dev_t _dev);
288struct cdevsw *devsw(dev_t _dev);
289const char *devtoname(dev_t _dev);
290int	dev_named(dev_t _pdev, const char *_name);
291void	dev_depends(dev_t _pdev, dev_t _cdev);
292void	dev_strategy(struct buf *bp);
293void	freedev(dev_t _dev);
294dev_t	makebdev(int _maj, int _min);
295dev_t	make_dev(struct cdevsw *_devsw, int _minor, uid_t _uid, gid_t _gid,
296		int _perms, const char *_fmt, ...) __printflike(6, 7);
297dev_t	make_dev_alias(dev_t _pdev, const char *_fmt, ...) __printflike(2, 3);
298int	dev2unit(dev_t _dev);
299int	unit2minor(int _unit);
300void	setconf(void);
301dev_t	getdiskbyname(char *_name);
302
303void devfs_create(dev_t dev);
304void devfs_destroy(dev_t dev);
305
306#define		UID_ROOT	0
307#define		UID_BIN		3
308#define		UID_UUCP	66
309
310#define		GID_WHEEL	0
311#define		GID_KMEM	2
312#define		GID_OPERATOR	5
313#define		GID_BIN		7
314#define		GID_GAMES	13
315#define		GID_DIALER	68
316
317typedef void (*dev_clone_fn)(void *arg, char *name, int namelen, dev_t *result);
318
319int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit);
320EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
321
322/* Stuff relating to kernel-dump */
323
324struct dumperinfo {
325	dumper_t *dumper;	/* Dumping function. */
326	void    *priv;		/* Private parts. */
327	u_int   blocksize;	/* Size of block in bytes. */
328	off_t   mediaoffset;	/* Initial offset in bytes. */
329	off_t   mediasize;	/* Space available in bytes. */
330};
331
332int set_dumper(struct dumperinfo *);
333void dumpsys(struct dumperinfo *);
334extern int dumping;		/* system is dumping */
335
336#endif /* _KERNEL */
337
338#endif /* !_SYS_CONF_H_ */
339