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 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)conf.h 8.5 (Berkeley) 1/9/95 37 * $FreeBSD$ 38 */ 39 40 #ifndef _SYS_CONF_H_ 41 #define _SYS_CONF_H_ 42 43 #ifdef _KERNEL 44 #include <sys/eventhandler.h> 45 #else 46 #include <sys/queue.h> 47 #endif 48 49 struct snapdata; 50 struct devfs_dirent; 51 struct cdevsw; 52 struct file; 53 54 struct cdev { 55 void *__si_reserved; 56 u_int si_flags; 57 #define SI_ALIAS 0x0002 /* carrier of alias name */ 58 #define SI_NAMED 0x0004 /* make_dev{_alias} has been called */ 59 #define SI_CHEAPCLONE 0x0008 /* can be removed_dev'ed when vnode reclaims */ 60 #define SI_CHILD 0x0010 /* child of another struct cdev **/ 61 #define SI_DEVOPEN 0x0020 /* opened by device */ 62 #define SI_CONSOPEN 0x0040 /* opened by console */ 63 #define SI_DUMPDEV 0x0080 /* is kernel dumpdev */ 64 #define SI_CANDELETE 0x0100 /* can do BIO_DELETE */ 65 #define SI_CLONELIST 0x0200 /* on a clone list */ 66 struct timespec si_atime; 67 struct timespec si_ctime; 68 struct timespec si_mtime; 69 uid_t si_uid; 70 gid_t si_gid; 71 mode_t si_mode; 72 struct ucred *si_cred; /* cached clone-time credential */ 73 int si_drv0; 74 int si_refcount; 75 LIST_ENTRY(cdev) si_list; 76 LIST_ENTRY(cdev) si_clone; 77 LIST_HEAD(, cdev) si_children; 78 LIST_ENTRY(cdev) si_siblings; 79 struct cdev *si_parent; 80 char *si_name; 81 void *si_drv1, *si_drv2; 82 struct cdevsw *si_devsw; 83 int si_iosize_max; /* maximum I/O size (for physio &al) */ 84 u_long si_usecount; 85 u_long si_threadcount; 86 union { 87 struct snapdata *__sid_snapdata; 88 } __si_u; 89 char __si_namebuf[SPECNAMELEN + 1]; 90 }; 91 92 #define si_snapdata __si_u.__sid_snapdata 93 94 #ifdef _KERNEL 95 96 /* 97 * Definitions of device driver entry switches 98 */ 99 100 struct bio; 101 struct buf; 102 struct thread; 103 struct uio; 104 struct knote; 105 struct clonedevs; 106 struct vnode; 107 108 /* 109 * Note: d_thread_t is provided as a transition aid for those drivers 110 * that treat struct proc/struct thread as an opaque data type and 111 * exist in substantially the same form in both 4.x and 5.x. Writers 112 * of drivers that dips into the d_thread_t structure should use 113 * struct thread or struct proc as appropriate for the version of the 114 * OS they are using. It is provided in lieu of each device driver 115 * inventing its own way of doing this. While it does violate style(9) 116 * in a number of ways, this violation is deemed to be less 117 * important than the benefits that a uniform API between releases 118 * gives. 119 * 120 * Users of struct thread/struct proc that aren't device drivers should 121 * not use d_thread_t. 122 */ 123 124 typedef struct thread d_thread_t; 125 126 typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td); 127 typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, struct file *fp); 128 typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td); 129 typedef void d_strategy_t(struct bio *bp); 130 typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data, 131 int fflag, struct thread *td); 132 133 typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag); 134 typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag); 135 typedef int d_poll_t(struct cdev *dev, int events, struct thread *td); 136 typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn); 137 typedef int d_mmap_t(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr, 138 int nprot); 139 typedef void d_purge_t(struct cdev *dev); 140 141 typedef int d_spare2_t(struct cdev *dev); 142 143 typedef int dumper_t( 144 void *_priv, /* Private to the driver. */ 145 void *_virtual, /* Virtual (mapped) address. */ 146 vm_offset_t _physical, /* Physical address of virtual. */ 147 off_t _offset, /* Byte-offset to write at. */ 148 size_t _length); /* Number of bytes to dump. */ 149 150 #endif /* _KERNEL */ 151 152 /* 153 * Types for d_flags. 154 */ 155 #define D_TAPE 0x0001 156 #define D_DISK 0x0002 157 #define D_TTY 0x0004 158 #define D_MEM 0x0008 159 160 #ifdef _KERNEL 161 162 #define D_TYPEMASK 0xffff 163 164 /* 165 * Flags for d_flags which the drivers can set. 166 */ 167 #define D_TRACKCLOSE 0x00080000 /* track all closes */ 168 #define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */ 169 #define D_PSEUDO 0x00200000 /* make_dev() can return NULL */ 170 #define D_NEEDGIANT 0x00400000 /* driver want Giant */ 171 #define D_NEEDMINOR 0x00800000 /* driver uses clone_create() */ 172 173 /* 174 * Version numbers. 175 */ 176 #define D_VERSION_00 0x20011966 177 #define D_VERSION_01 0x17032005 /* Add d_uid,gid,mode & kind */ 178 #define D_VERSION D_VERSION_01 179 180 /* 181 * Flags used for internal housekeeping 182 */ 183 #define D_INIT 0x80000000 /* cdevsw initialized */ 184 185 /* 186 * Character device switch table 187 */ 188 struct cdevsw { 189 int d_version; 190 u_int d_flags; 191 const char *d_name; 192 d_open_t *d_open; 193 d_fdopen_t *d_fdopen; 194 d_close_t *d_close; 195 d_read_t *d_read; 196 d_write_t *d_write; 197 d_ioctl_t *d_ioctl; 198 d_poll_t *d_poll; 199 d_mmap_t *d_mmap; 200 d_strategy_t *d_strategy; 201 dumper_t *d_dump; 202 d_kqfilter_t *d_kqfilter; 203 d_purge_t *d_purge; 204 d_spare2_t *d_spare2; 205 uid_t d_uid; 206 gid_t d_gid; 207 mode_t d_mode; 208 const char *d_kind; 209 210 /* These fields should not be messed with by drivers */ 211 LIST_ENTRY(cdevsw) d_list; 212 LIST_HEAD(, cdev) d_devs; 213 int d_spare3; 214 union { 215 struct cdevsw *gianttrick; 216 SLIST_ENTRY(cdevsw) postfree_list; 217 } __d_giant; 218 }; 219 #define d_gianttrick __d_giant.gianttrick 220 #define d_postfree_list __d_giant.postfree_list 221 222 struct module; 223 224 struct devsw_module_data { 225 int (*chainevh)(struct module *, int, void *); /* next handler */ 226 void *chainarg; /* arg for next event handler */ 227 /* Do not initialize fields hereafter */ 228 }; 229 230 #define DEV_MODULE(name, evh, arg) \ 231 static moduledata_t name##_mod = { \ 232 #name, \ 233 evh, \ 234 arg \ 235 }; \ 236 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE) 237 238 239 void clone_setup(struct clonedevs **cdp); 240 void clone_cleanup(struct clonedevs **); 241 #define CLONE_UNITMASK 0xfffff 242 #define CLONE_FLAG0 (CLONE_UNITMASK + 1) 243 int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra); 244 245 int count_dev(struct cdev *_dev); 246 void destroy_dev(struct cdev *_dev); 247 int destroy_dev_sched(struct cdev *dev); 248 int destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg); 249 void destroy_dev_drain(struct cdevsw *csw); 250 void drain_dev_clone_events(void); 251 struct cdevsw *dev_refthread(struct cdev *_dev); 252 struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp); 253 void dev_relthread(struct cdev *_dev); 254 void dev_depends(struct cdev *_pdev, struct cdev *_cdev); 255 void dev_ref(struct cdev *dev); 256 void dev_refl(struct cdev *dev); 257 void dev_rel(struct cdev *dev); 258 void dev_strategy(struct cdev *dev, struct buf *bp); 259 struct cdev *make_dev(struct cdevsw *_devsw, int _unit, uid_t _uid, gid_t _gid, 260 int _perms, const char *_fmt, ...) __printflike(6, 7); 261 struct cdev *make_dev_cred(struct cdevsw *_devsw, int _unit, 262 struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms, 263 const char *_fmt, ...) __printflike(7, 8); 264 #define MAKEDEV_REF 0x1 265 #define MAKEDEV_WHTOUT 0x2 266 struct cdev *make_dev_credf(int _flags, 267 struct cdevsw *_devsw, int _unit, 268 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, 269 const char *_fmt, ...) __printflike(8, 9); 270 struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...) __printflike(2, 3); 271 void dev_lock(void); 272 void dev_unlock(void); 273 void setconf(void); 274 275 #define dev2unit(d) ((d)->si_drv0) 276 277 typedef void (*cdevpriv_dtr_t)(void *data); 278 int devfs_get_cdevpriv(void **datap); 279 int devfs_set_cdevpriv(void *priv, cdevpriv_dtr_t dtr); 280 void devfs_clear_cdevpriv(void); 281 void devfs_fpdrop(struct file *fp); /* XXX This is not public KPI */ 282 283 #define UID_ROOT 0 284 #define UID_BIN 3 285 #define UID_UUCP 66 286 #define UID_NOBODY 65534 287 288 #define GID_WHEEL 0 289 #define GID_KMEM 2 290 #define GID_TTY 4 291 #define GID_OPERATOR 5 292 #define GID_BIN 7 293 #define GID_GAMES 13 294 #define GID_DIALER 68 295 #define GID_NOBODY 65534 296 297 typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name, 298 int namelen, struct cdev **result); 299 300 int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit); 301 EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn); 302 303 /* Stuff relating to kernel-dump */ 304 305 struct dumperinfo { 306 dumper_t *dumper; /* Dumping function. */ 307 void *priv; /* Private parts. */ 308 u_int blocksize; /* Size of block in bytes. */ 309 u_int maxiosize; /* Max size allowed for an individual I/O */ 310 off_t mediaoffset; /* Initial offset in bytes. */ 311 off_t mediasize; /* Space available in bytes. */ 312 }; 313 314 int set_dumper(struct dumperinfo *); 315 int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t); 316 void dumpsys(struct dumperinfo *); 317 extern int dumping; /* system is dumping */ 318 319 #endif /* _KERNEL */ 320 321 #endif /* !_SYS_CONF_H_ */ 322