devfs - Let devfs assume degenerate knotes when a device goes away
[dragonfly.git] / sys / sys / conf.h
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.18 2007/05/09 00:53:35 dillon Exp $
41  */
42
43 #ifndef _SYS_CONF_H_
44 #define _SYS_CONF_H_
45
46 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
47
48 #ifndef _SYS_QUEUE_H_
49 #include <sys/queue.h>
50 #endif
51 #ifndef _SYS_TIME_H_
52 #include <sys/time.h>
53 #endif
54 #ifndef _SYS_BIOTRACK_H_
55 #include <sys/biotrack.h>
56 #endif
57 #ifndef _SYS_SYSREF_H_
58 #include <sys/sysref.h>
59 #endif
60 #ifndef _SYS_EVENT_H_
61 #include <sys/event.h>
62 #endif
63 #include <libprop/proplib.h>
64
65 #define SPECNAMELEN     63
66
67 struct tty;
68 struct disk;
69 struct vnode;
70 struct dev_ops;
71 struct vm_object;
72
73 struct cdev {
74         u_int           si_flags;
75         __uint64_t      si_inode;
76         uid_t           si_uid;
77         gid_t           si_gid;
78         int             si_perms;
79         TAILQ_ENTRY(cdev) link;
80         int             si_uminor;
81         int             si_umajor;
82         LIST_ENTRY(cdev)        si_hash;
83         SLIST_HEAD(, vnode) si_hlist;
84         char            si_name[SPECNAMELEN + 1];
85         void            *si_drv1;
86         void            *si_drv2;
87         struct dev_ops  *si_ops;        /* device operations vector */
88         struct dev_ops  *si_bops;       /* backing devops vector */
89         int             si_iosize_max;  /* maximum I/O size (for physio &al) */
90         struct sysref   si_sysref;
91         union {
92                 struct {
93                         struct tty *__sit_tty;
94                 } __si_tty;
95                 struct {
96                         struct disk *__sid_disk;
97                         struct mount *__sid_mountpoint;
98                         int __sid_bsize_phys; /* min physical block size */
99                         int __sid_bsize_best; /* optimal block size */
100                 } __si_disk;
101         } __si_u;
102         struct bio_track si_track_read;
103         struct bio_track si_track_write;
104         time_t          si_lastread;    /* time_second */
105         time_t          si_lastwrite;   /* time_second */
106         struct vm_object *si_object;    /* vm_pager support */
107         prop_dictionary_t si_dict;
108         struct kqinfo   si_kqinfo;      /* degenerate delegated knotes */
109 };
110
111 #define SI_UNUSED01     0x0001
112 #define SI_HASHED       0x0002  /* in (maj,min) hash table */
113 #define SI_OVERRIDE     0x0004  /* override uid, gid, and perms */
114 #define SI_INTERCEPTED  0x0008  /* device ops was intercepted */
115 #define SI_DEVFS_LINKED 0x0010
116 #define SI_REPROBE_TEST 0x0020
117
118 #define si_tty          __si_u.__si_tty.__sit_tty
119 #define si_disk         __si_u.__si_disk.__sid_disk
120 #define si_mountpoint   __si_u.__si_disk.__sid_mountpoint
121 #define si_bsize_phys   __si_u.__si_disk.__sid_bsize_phys
122 #define si_bsize_best   __si_u.__si_disk.__sid_bsize_best
123
124 #define CDEVSW_ALL_MINORS       0       /* mask of 0 always matches 0 */
125
126 /*
127  * Special device management
128  */
129 #define SPECHSZ 64
130 #define SPECHASH(rdev)  (((unsigned)(minor(rdev)))%SPECHSZ)
131
132 /*
133  * Definitions of device driver entry switches
134  */
135
136 struct buf;
137 struct bio;
138 struct proc;
139 struct uio;
140 struct knote;
141 struct ucred;
142
143 struct thread;
144
145 typedef int l_open_t (struct cdev *dev, struct tty *tp);
146 typedef int l_close_t (struct tty *tp, int flag);
147 typedef int l_read_t (struct tty *tp, struct uio *uio, int flag);
148 typedef int l_write_t (struct tty *tp, struct uio *uio, int flag);
149 typedef int l_ioctl_t (struct tty *tp, u_long cmd, caddr_t data, int flag,
150                         struct ucred *cred);
151 typedef int l_rint_t (int c, struct tty *tp);
152 typedef int l_start_t (struct tty *tp);
153 typedef int l_modem_t (struct tty *tp, int flag);
154
155 /*
156  * Line discipline switch table
157  */
158 struct linesw {
159         l_open_t        *l_open;
160         l_close_t       *l_close;
161         l_read_t        *l_read;
162         l_write_t       *l_write;
163         l_ioctl_t       *l_ioctl;
164         l_rint_t        *l_rint;
165         l_start_t       *l_start;
166         l_modem_t       *l_modem;
167         u_char          l_hotchar;
168 };
169
170 #ifdef _KERNEL
171 extern struct linesw linesw[];
172 extern int nlinesw;
173
174 int ldisc_register (int , struct linesw *);
175 void ldisc_deregister (int);
176 #define LDISC_LOAD      -1              /* Loadable line discipline */
177 #endif
178
179 /*
180  * Swap device table
181  */
182 struct swdevt {
183         udev_t  sw_dev;                 /* For quasibogus swapdev reporting */
184         int     sw_flags;
185         int     sw_nblks;               /* Number of swap blocks on device */
186         int     sw_nused;               /* swap blocks used on device */
187         struct  vnode *sw_vp;
188         struct cdev *sw_device;
189 };
190
191 #define SW_FREED        0x01
192 #define SW_SEQUENTIAL   0x02
193 #define sw_freed        sw_flags        /* XXX compat */
194
195 #ifdef _KERNEL
196
197 l_ioctl_t       l_nullioctl;
198 l_read_t        l_noread;
199 l_write_t       l_nowrite;
200
201 struct module;
202
203 struct devsw_module_data {
204         int     (*chainevh)(struct module *, int, void *); /* next handler */
205         void    *chainarg;      /* arg for next event handler */
206         /* Do not initialize fields hereafter */
207 };
208
209 #define DEV_MODULE(name, evh, arg)                                      \
210 static moduledata_t name##_mod = {                                      \
211     #name,                                                              \
212     evh,                                                                \
213     arg                                                                 \
214 };                                                                      \
215 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
216
217 int     count_dev (cdev_t dev);
218 void    destroy_dev (cdev_t dev);
219 void    release_dev (cdev_t dev);
220 cdev_t  get_dev (int x, int y);
221 cdev_t  reference_dev (cdev_t dev);
222 struct dev_ops *devsw (cdev_t dev);
223 const char *devtoname (cdev_t dev);
224 void    freedev (cdev_t dev);
225 int     iszerodev (cdev_t dev);
226
227 int     lminor (cdev_t dev);
228 void    setconf (void);
229 cdev_t  kgetdiskbyname(const char *name);
230 int     dev_is_good(cdev_t dev);
231
232 /*
233  * XXX: This included for when DEVFS resurfaces
234  */
235
236 #define         UID_ROOT        0
237 #define         UID_BIN         3
238 #define         UID_UUCP        66
239
240 #define         GID_WHEEL       0
241 #define         GID_KMEM        2
242 #define         GID_TTY         4
243 #define         GID_OPERATOR    5
244 #define         GID_BIN         7
245 #define         GID_GAMES       13
246 #define         GID_DIALER      68
247
248 #endif /* _KERNEL */
249 #endif /* _KERNEL || _KERNEL_STRUCTURES */
250
251 #endif /* !_SYS_CONF_H_ */