conf.h revision 136940
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: head/sys/sys/conf.h 136940 2004-10-25 07:40:54Z phk $ 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 49struct tty; 50struct disk; 51struct vnode; 52struct buf; 53struct snapdata; 54 55struct cdev { 56 u_int si_flags; 57#define SI_STASHED 0x0001 /* created in stashed storage */ 58#define SI_ALIAS 0x0002 /* carrier of alias name */ 59#define SI_NAMED 0x0004 /* make_dev{_alias} has been called */ 60#define SI_CHEAPCLONE 0x0008 /* can be removed_dev'ed when vnode reclaims */ 61#define SI_CHILD 0x0010 /* child of another struct cdev **/ 62#define SI_DEVOPEN 0x0020 /* opened by device */ 63#define SI_CONSOPEN 0x0040 /* opened by console */ 64#define SI_DUMPDEV 0x0080 /* is kernel dumpdev */ 65#define SI_CANDELETE 0x0100 /* can do BIO_DELETE */ 66#define SI_CLONELIST 0x0200 /* on a clone list */ 67 struct timespec si_atime; 68 struct timespec si_ctime; 69 struct timespec si_mtime; 70 dev_t si_udev; 71 int si_refcount; 72 LIST_ENTRY(cdev) si_list; 73 LIST_ENTRY(cdev) si_clone; 74 LIST_ENTRY(cdev) si_hash; 75 SLIST_HEAD(, vnode) si_hlist; 76 LIST_HEAD(, cdev) si_children; 77 LIST_ENTRY(cdev) si_siblings; 78 struct cdev *si_parent; 79 u_int si_inode; 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 uid_t si_uid; 85 gid_t si_gid; 86 mode_t si_mode; 87 u_long si_usecount; 88 u_long si_threadcount; 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 snapdata *__sid_snapdata; 98 int (*__sid_copyonwrite)(struct vnode *, struct buf *); 99 } __si_disk; 100 } __si_u; 101 char __si_namebuf[SPECNAMELEN + 1]; 102}; 103 104#define si_tty __si_u.__si_tty.__sit_tty 105#define si_mountpoint __si_u.__si_disk.__sid_mountpoint 106#define si_bsize_phys __si_u.__si_disk.__sid_bsize_phys 107#define si_bsize_best __si_u.__si_disk.__sid_bsize_best 108#define si_snapdata __si_u.__si_disk.__sid_snapdata 109#define si_copyonwrite __si_u.__si_disk.__sid_copyonwrite 110 111#ifdef _KERNEL 112 113/* 114 * Definitions of device driver entry switches 115 */ 116 117struct bio; 118struct buf; 119struct thread; 120struct uio; 121struct knote; 122struct clonedevs; 123 124/* 125 * Note: d_thread_t is provided as a transition aid for those drivers 126 * that treat struct proc/struct thread as an opaque data type and 127 * exist in substantially the same form in both 4.x and 5.x. Writers 128 * of drivers that dips into the d_thread_t structure should use 129 * struct thread or struct proc as appropriate for the version of the 130 * OS they are using. It is provided in lieu of each device driver 131 * inventing its own way of doing this. While it does violate style(9) 132 * in a number of ways, this violation is deemed to be less 133 * important than the benefits that a uniform API between releases 134 * gives. 135 * 136 * Users of struct thread/struct proc that aren't device drivers should 137 * not use d_thread_t. 138 */ 139 140typedef struct thread d_thread_t; 141 142typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td); 143typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, int fdidx); 144typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td); 145typedef void d_strategy_t(struct bio *bp); 146typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data, 147 int fflag, struct thread *td); 148 149typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag); 150typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag); 151typedef int d_poll_t(struct cdev *dev, int events, struct thread *td); 152typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn); 153typedef int d_mmap_t(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr, 154 int nprot); 155typedef void d_purge_t(struct cdev *dev); 156 157typedef int d_spare2_t(struct cdev *dev); 158 159typedef int dumper_t( 160 void *priv, /* Private to the driver. */ 161 void *virtual, /* Virtual (mapped) address. */ 162 vm_offset_t physical, /* Physical address of virtual. */ 163 off_t offset, /* Byte-offset to write at. */ 164 size_t length); /* Number of bytes to dump. */ 165 166#endif /* _KERNEL */ 167 168/* 169 * Types for d_flags. 170 */ 171#define D_TAPE 0x0001 172#define D_DISK 0x0002 173#define D_TTY 0x0004 174#define D_MEM 0x0008 175 176#ifdef _KERNEL 177 178#define D_TYPEMASK 0xffff 179 180/* 181 * Flags for d_flags which the drivers can set. 182 */ 183#define D_MEMDISK 0x00010000 /* memory type disk */ 184#define D_TRACKCLOSE 0x00080000 /* track all closes */ 185#define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */ 186#define D_PSEUDO 0x00200000 /* make_dev() can return NULL */ 187#define D_NEEDGIANT 0x00400000 /* driver want Giant */ 188 189/* 190 * Version numbers. 191 */ 192#define D_VERSION_00 0x20011966 193#define D_VERSION D_VERSION_00 194 195/* 196 * Flags used for internal housekeeping 197 */ 198#define D_INIT 0x80000000 /* cdevsw initialized */ 199#define D_ALLOCMAJ 0x40000000 /* major# is allocated */ 200 201/* 202 * Character device switch table 203 */ 204struct cdevsw { 205 int d_version; 206 int d_maj; 207 u_int d_flags; 208 const char *d_name; 209 d_open_t *d_open; 210 d_fdopen_t *d_fdopen; 211 d_close_t *d_close; 212 d_read_t *d_read; 213 d_write_t *d_write; 214 d_ioctl_t *d_ioctl; 215 d_poll_t *d_poll; 216 d_mmap_t *d_mmap; 217 d_strategy_t *d_strategy; 218 dumper_t *d_dump; 219 d_kqfilter_t *d_kqfilter; 220 d_purge_t *d_purge; 221 d_spare2_t *d_spare2; 222 223 /* These fields should not be messed with by drivers */ 224 LIST_ENTRY(cdevsw) d_list; 225 LIST_HEAD(, cdev) d_devs; 226 int d_spare3; 227}; 228 229#endif /* _KERNEL */ 230 231#ifdef _KERNEL 232 233#define NUMCDEVSW 256 234 235/* 236 * XXX: do not use MAJOR_AUTO unless you have no choice. In general drivers 237 * should just not initialize .d_maj and that will DTRT. 238 */ 239#define MAJOR_AUTO 0 /* XXX: Not GM */ 240 241struct module; 242 243struct devsw_module_data { 244 int (*chainevh)(struct module *, int, void *); /* next handler */ 245 void *chainarg; /* arg for next event handler */ 246 /* Do not initialize fields hereafter */ 247}; 248 249#define DEV_MODULE(name, evh, arg) \ 250static moduledata_t name##_mod = { \ 251 #name, \ 252 evh, \ 253 arg \ 254}; \ 255DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE) 256 257 258void clone_setup(struct clonedevs **cdp); 259void clone_cleanup(struct clonedevs **); 260#define CLONE_UNITMASK 0xfffff 261#define CLONE_FLAG0 (CLONE_UNITMASK + 1) 262int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, u_int extra); 263 264int count_dev(struct cdev *_dev); 265void destroy_dev(struct cdev *_dev); 266struct cdevsw *dev_refthread(struct cdev *_dev); 267void dev_relthread(struct cdev *_dev); 268const char *devtoname(struct cdev *_dev); 269int dev_named(struct cdev *_pdev, const char *_name); 270void dev_depends(struct cdev *_pdev, struct cdev *_cdev); 271void dev_ref(struct cdev *dev); 272void dev_rel(struct vnode *vp); 273void dev_strategy(struct buf *bp); 274struct cdev *makebdev(int _maj, int _min); 275struct cdev *make_dev(struct cdevsw *_devsw, int _minor, uid_t _uid, gid_t _gid, 276 int _perms, const char *_fmt, ...) __printflike(6, 7); 277struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...) __printflike(2, 3); 278int dev2unit(struct cdev *_dev); 279void dev_lock(void); 280void dev_unlock(void); 281int unit2minor(int _unit); 282void setconf(void); 283struct cdev *getdiskbyname(char *_name); 284 285void devfs_create(struct cdev *dev); 286void devfs_destroy(struct cdev *dev); 287 288#define UID_ROOT 0 289#define UID_BIN 3 290#define UID_UUCP 66 291 292#define GID_WHEEL 0 293#define GID_KMEM 2 294#define GID_OPERATOR 5 295#define GID_BIN 7 296#define GID_GAMES 13 297#define GID_DIALER 68 298 299typedef void (*dev_clone_fn)(void *arg, char *name, int namelen, struct cdev **result); 300 301int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit); 302EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn); 303 304/* Stuff relating to kernel-dump */ 305 306struct dumperinfo { 307 dumper_t *dumper; /* Dumping function. */ 308 void *priv; /* Private parts. */ 309 u_int blocksize; /* Size of block in bytes. */ 310 off_t mediaoffset; /* Initial offset in bytes. */ 311 off_t mediasize; /* Space available in bytes. */ 312}; 313 314int set_dumper(struct dumperinfo *); 315void dumpsys(struct dumperinfo *); 316extern int dumping; /* system is dumping */ 317 318/* D_TTY related functions */ 319d_close_t ttyclose; 320d_ioctl_t ttyioctl; 321d_kqfilter_t ttykqfilter; 322d_open_t ttyopen; 323d_poll_t ttypoll; 324d_read_t ttyread; 325d_write_t ttywrite; 326 327#endif /* _KERNEL */ 328 329#endif /* !_SYS_CONF_H_ */ 330