xref: /dragonfly/sys/sys/conf.h (revision 1d1731fa)
1 /*-
2  * Copyright (c) 1990, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the University of
21  *	California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *	@(#)conf.h	8.5 (Berkeley) 1/9/95
39  * $FreeBSD: src/sys/sys/conf.h,v 1.103.2.6 2002/03/11 01:14:55 dd Exp $
40  * $DragonFly: src/sys/sys/conf.h,v 1.5 2003/07/22 17:03:34 dillon Exp $
41  */
42 
43 #ifndef _SYS_CONF_H_
44 #define	_SYS_CONF_H_
45 
46 #include <sys/queue.h>
47 
48 #define SPECNAMELEN	15
49 
50 struct tty;
51 struct disk;
52 struct vnode;
53 
54 struct specinfo {
55 	u_int		si_flags;
56 	udev_t		si_udev;
57 	LIST_ENTRY(specinfo)	si_hash;
58 	SLIST_HEAD(, vnode) si_hlist;
59 	char		si_name[SPECNAMELEN + 1];
60 	void		*si_drv1;
61 	void		*si_drv2;
62 	struct cdevsw	*si_devsw;	/* cached */
63 	int		si_iosize_max;	/* maximum I/O size (for physio &al) */
64 	union {
65 		struct {
66 			struct tty *__sit_tty;
67 		} __si_tty;
68 		struct {
69 			struct disk *__sid_disk;
70 			struct mount *__sid_mountpoint;
71 			int __sid_bsize_phys; /* min physical block size */
72 			int __sid_bsize_best; /* optimal block size */
73 		} __si_disk;
74 	} __si_u;
75 };
76 
77 #define SI_STASHED	0x0001	/* created in stashed storage */
78 
79 #define si_tty		__si_u.__si_tty.__sit_tty
80 #define si_disk		__si_u.__si_disk.__sid_disk
81 #define si_mountpoint	__si_u.__si_disk.__sid_mountpoint
82 #define si_bsize_phys	__si_u.__si_disk.__sid_bsize_phys
83 #define si_bsize_best	__si_u.__si_disk.__sid_bsize_best
84 
85 /*
86  * Exported shorthand
87  */
88 #define v_hashchain v_rdev->si_hlist
89 #define v_specmountpoint v_rdev->si_mountpoint
90 
91 /*
92  * Special device management
93  */
94 #define	SPECHSZ	64
95 #define	SPECHASH(rdev)	(((unsigned)(minor(rdev)))%SPECHSZ)
96 
97 /*
98  * Definitions of device driver entry switches
99  */
100 
101 struct buf;
102 struct proc;
103 struct uio;
104 struct knote;
105 
106 /*
107  * Note: d_thread_t is provided as a transition aid for those drivers
108  * that treat struct proc/struct thread as an opaque data type and
109  * exist in substantially the same form in both 4.x and 5.x.  Writers
110  * of drivers that dips into the d_thread_t structure should use
111  * struct thread or struct proc as appropriate for the version of the
112  * OS they are using.  It is provided in lieu of each device driver
113  * inventing its own way of doing this.  While it does violate style(9)
114  * in a number of ways, this violation is deemed to be less
115  * important than the benefits that a uniform API between releases
116  * gives.
117  *
118  * Users of struct thread/struct proc that aren't device drivers should
119  * not use d_thread_t.
120  */
121 
122 struct thread;
123 struct lwkt_port;
124 
125 typedef struct thread d_thread_t;
126 typedef int d_open_t (dev_t dev, int oflags, int devtype, d_thread_t *td);
127 typedef int d_close_t (dev_t dev, int fflag, int devtype, d_thread_t *td);
128 typedef void d_strategy_t (struct buf *bp);
129 typedef int d_ioctl_t (dev_t dev, u_long cmd, caddr_t data,
130 			   int fflag, d_thread_t *td);
131 typedef int d_dump_t (dev_t dev);
132 typedef int d_psize_t (dev_t dev);
133 
134 typedef int d_read_t (dev_t dev, struct uio *uio, int ioflag);
135 typedef int d_write_t (dev_t dev, struct uio *uio, int ioflag);
136 typedef int d_poll_t (dev_t dev, int events, d_thread_t *td);
137 typedef int d_kqfilter_t (dev_t dev, struct knote *kn);
138 typedef int d_mmap_t (dev_t dev, vm_offset_t offset, int nprot);
139 
140 typedef int l_open_t (dev_t dev, struct tty *tp);
141 typedef int l_close_t (struct tty *tp, int flag);
142 typedef int l_read_t (struct tty *tp, struct uio *uio, int flag);
143 typedef int l_write_t (struct tty *tp, struct uio *uio, int flag);
144 typedef int l_ioctl_t (struct tty *tp, u_long cmd, caddr_t data,
145 			   int flag, d_thread_t *td);
146 typedef int l_rint_t (int c, struct tty *tp);
147 typedef int l_start_t (struct tty *tp);
148 typedef int l_modem_t (struct tty *tp, int flag);
149 
150 /*
151  * XXX: The dummy argument can be used to do what strategy1() never
152  * did anywhere:  Create a per device flag to lock the device during
153  * label/slice surgery, all calls with a dummy == 0 gets stalled on
154  * a queue somewhere, whereas dummy == 1 are let through.  Once out
155  * of surgery, reset the flag and restart all the stuff on the stall
156  * queue.
157  */
158 #define BUF_STRATEGY(bp, dummy) dev_dstrategy((bp)->b_dev, bp)
159 /*
160  * Types for d_flags.
161  */
162 #define	D_TAPE	0x0001
163 #define	D_DISK	0x0002
164 #define	D_TTY	0x0004
165 #define	D_MEM	0x0008
166 
167 #define	D_TYPEMASK	0xffff
168 
169 /*
170  * Flags for d_flags.
171  */
172 #define	D_MEMDISK	0x00010000	/* memory type disk */
173 #define	D_NAGGED	0x00020000	/* nagged about missing make_dev() */
174 #define	D_CANFREE	0x00040000	/* can free blocks */
175 #define	D_TRACKCLOSE	0x00080000	/* track all closes */
176 #define D_MASTER	0x00100000	/* used by pty/tty code */
177 #define	D_KQFILTER	0x00200000	/* has kqfilter entry */
178 
179 /*
180  * Character device switch table
181  */
182 struct cdevsw {
183 	const char	*d_name;	/* base device name, e.g. 'vn' */
184 	int		d_maj;		/* major (char) device number */
185 	u_int		d_flags;	/* D_ flags */
186 	struct lwkt_port *d_port;	/* port (template only) */
187 	u_int		d_autoq;	/* thread safe (old style) vec mask */
188 
189 	/*
190 	 * Old style vectors are used only if d_port is NULL when the cdevsw
191 	 * is added to the system.   They have been renamed to prevent misuse.
192 	 */
193 	d_open_t	*old_open;
194 	d_close_t	*old_close;
195 	d_read_t	*old_read;
196 	d_write_t	*old_write;
197 	d_ioctl_t	*old_ioctl;
198 	d_poll_t	*old_poll;
199 	d_mmap_t	*old_mmap;
200 	d_strategy_t	*old_strategy;
201 	d_dump_t	*old_dump;
202 	d_psize_t	*old_psize;
203 	d_kqfilter_t	*old_kqfilter;
204 };
205 
206 /*
207  * Line discipline switch table
208  */
209 struct linesw {
210 	l_open_t	*l_open;
211 	l_close_t	*l_close;
212 	l_read_t	*l_read;
213 	l_write_t	*l_write;
214 	l_ioctl_t	*l_ioctl;
215 	l_rint_t	*l_rint;
216 	l_start_t	*l_start;
217 	l_modem_t	*l_modem;
218 	u_char		l_hotchar;
219 };
220 
221 #ifdef _KERNEL
222 extern struct linesw linesw[];
223 extern int nlinesw;
224 
225 int ldisc_register (int , struct linesw *);
226 void ldisc_deregister (int);
227 #define LDISC_LOAD 	-1		/* Loadable line discipline */
228 #endif
229 
230 /*
231  * Swap device table
232  */
233 struct swdevt {
234 	udev_t	sw_dev;			/* For quasibogus swapdev reporting */
235 	int	sw_flags;
236 	int	sw_nblks;
237 	struct	vnode *sw_vp;
238 	dev_t	sw_device;
239 };
240 #define	SW_FREED	0x01
241 #define	SW_SEQUENTIAL	0x02
242 #define	sw_freed	sw_flags	/* XXX compat */
243 
244 #ifdef _KERNEL
245 d_open_t	noopen;
246 d_close_t	noclose;
247 d_read_t	noread;
248 d_write_t	nowrite;
249 d_ioctl_t	noioctl;
250 d_mmap_t	nommap;
251 d_kqfilter_t	nokqfilter;
252 #define	nostrategy	((d_strategy_t *)NULL)
253 #define	nopoll	seltrue
254 
255 d_dump_t	nodump;
256 
257 #define NUMCDEVSW 256
258 
259 /*
260  * nopsize is little used, so not worth having dummy functions for.
261  */
262 #define	nopsize	((d_psize_t *)NULL)
263 
264 d_open_t	nullopen;
265 d_close_t	nullclose;
266 
267 l_ioctl_t	l_nullioctl;
268 l_read_t	l_noread;
269 l_write_t	l_nowrite;
270 
271 struct module;
272 
273 struct devsw_module_data {
274 	int	(*chainevh)(struct module *, int, void *); /* next handler */
275 	void	*chainarg;	/* arg for next event handler */
276 	/* Do not initialize fields hereafter */
277 };
278 
279 #define DEV_MODULE(name, evh, arg)					\
280 static moduledata_t name##_mod = {					\
281     #name,								\
282     evh,								\
283     arg									\
284 };									\
285 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
286 
287 void	compile_devsw(struct cdevsw *devsw);
288 int	cdevsw_add (struct cdevsw *new);
289 struct lwkt_port *cdevsw_add_override (struct cdevsw *new, struct lwkt_port *port);
290 struct lwkt_port *cdevsw_dev_override(dev_t dev, struct lwkt_port *port);
291 
292 int	cdevsw_remove (struct cdevsw *old);
293 int	count_dev (dev_t dev);
294 void	destroy_dev (dev_t dev);
295 struct cdevsw *devsw (dev_t dev);
296 const char *devtoname (dev_t dev);
297 void	freedev (dev_t dev);
298 int	iszerodev (dev_t dev);
299 dev_t	make_dev (struct cdevsw *devsw, int minor, uid_t uid, gid_t gid, int perms, const char *fmt, ...) __printflike(6, 7);
300 int	lminor (dev_t dev);
301 void	setconf (void);
302 dev_t	getdiskbyname(char *name);
303 
304 /*
305  * XXX: This included for when DEVFS resurfaces
306  */
307 
308 #define		UID_ROOT	0
309 #define		UID_BIN		3
310 #define		UID_UUCP	66
311 
312 #define		GID_WHEEL	0
313 #define		GID_KMEM	2
314 #define		GID_OPERATOR	5
315 #define		GID_BIN		7
316 #define		GID_GAMES	13
317 #define		GID_DIALER	68
318 
319 #endif /* _KERNEL */
320 
321 #endif /* !_SYS_CONF_H_ */
322