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