conf.h revision 135138
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 135138 2004-09-13 07:29:45Z phk $ 38 */ 39 40#ifndef _SYS_CONF_H_ 41#define _SYS_CONF_H_ 42 43#ifdef _KERNEL 44#include <sys/eventhandler.h> 45 46struct tty; 47struct disk; 48struct vnode; 49struct buf; 50struct snapdata; 51 52struct cdev { 53 u_int si_flags; 54#define SI_STASHED 0x0001 /* created in stashed storage */ 55#define SI_ALIAS 0x0002 /* carrier of alias name */ 56#define SI_NAMED 0x0004 /* make_dev{_alias} has been called */ 57#define SI_CHEAPCLONE 0x0008 /* can be removed_dev'ed when vnode reclaims */ 58#define SI_CHILD 0x0010 /* child of another struct cdev **/ 59#define SI_DEVOPEN 0x0020 /* opened by device */ 60#define SI_CONSOPEN 0x0040 /* opened by console */ 61#define SI_DUMPDEV 0x0080 /* is kernel dumpdev */ 62#define SI_CANDELETE 0x0100 /* can do BIO_DELETE */ 63#define SI_CLONELIST 0x0200 /* on a clone list */ 64 struct timespec si_atime; 65 struct timespec si_ctime; 66 struct timespec si_mtime; 67 dev_t si_udev; 68 int si_refcount; 69 LIST_ENTRY(cdev) si_list; 70 LIST_ENTRY(cdev) si_clone; 71 LIST_ENTRY(cdev) si_hash; 72 SLIST_HEAD(, vnode) si_hlist; 73 LIST_HEAD(, cdev) si_children; 74 LIST_ENTRY(cdev) si_siblings; 75 struct cdev *si_parent; 76 u_int si_inode; 77 char *si_name; 78 void *si_drv1, *si_drv2; 79 struct cdevsw *si_devsw; 80 int si_iosize_max; /* maximum I/O size (for physio &al) */ 81 u_int si_stripesize; 82 u_int si_stripeoffset; 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 int (*__sid_copyonwrite)(struct vnode *, struct buf *); 98 } __si_disk; 99 } __si_u; 100 char __si_namebuf[SPECNAMELEN + 1]; 101}; 102 103#define si_tty __si_u.__si_tty.__sit_tty 104#define si_mountpoint __si_u.__si_disk.__sid_mountpoint 105#define si_bsize_phys __si_u.__si_disk.__sid_bsize_phys 106#define si_bsize_best __si_u.__si_disk.__sid_bsize_best 107#define si_snapdata __si_u.__si_disk.__sid_snapdata 108#define si_copyonwrite __si_u.__si_disk.__sid_copyonwrite 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); 152 153typedef int d_spare1_t(struct cdev *dev); 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#define DEV_STRATEGY(bp) dev_strategy(bp) 164 165#endif /* _KERNEL */ 166 167/* 168 * Types for d_flags. 169 */ 170#define D_TAPE 0x0001 171#define D_DISK 0x0002 172#define D_TTY 0x0004 173#define D_MEM 0x0008 174 175#ifdef _KERNEL 176 177#define D_TYPEMASK 0xffff 178 179/* 180 * Flags for d_flags which the drivers can set. 181 */ 182#define D_MEMDISK 0x00010000 /* memory type disk */ 183#define D_TRACKCLOSE 0x00080000 /* track all closes */ 184#define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */ 185#define D_PSEUDO 0x00200000 /* make_dev() can return NULL */ 186#define D_NEEDGIANT 0x00400000 /* driver want Giant */ 187 188/* 189 * Version numbers. 190 */ 191#define D_VERSION_00 0x20011966 192#define D_VERSION D_VERSION_00 193 194/* 195 * Flags used for internal housekeeping 196 */ 197#define D_INIT 0x80000000 /* cdevsw initialized */ 198#define D_ALLOCMAJ 0x40000000 /* major# is allocated */ 199 200/* 201 * Character device switch table 202 */ 203struct cdevsw { 204 int d_version; 205 int d_maj; 206 u_int d_flags; 207 const char *d_name; 208 d_open_t *d_open; 209 d_fdopen_t *d_fdopen; 210 d_close_t *d_close; 211 d_read_t *d_read; 212 d_write_t *d_write; 213 d_ioctl_t *d_ioctl; 214 d_poll_t *d_poll; 215 d_mmap_t *d_mmap; 216 d_strategy_t *d_strategy; 217 dumper_t *d_dump; 218 d_kqfilter_t *d_kqfilter; 219 d_spare1_t *d_spare1; 220 d_spare2_t *d_spare2; 221 222 /* These fields should not be messed with by drivers */ 223 LIST_ENTRY(cdevsw) d_list; 224 LIST_HEAD(, cdev) d_devs; 225 int d_refcount; 226}; 227 228#endif /* _KERNEL */ 229 230#ifdef _KERNEL 231 232#define NUMCDEVSW 256 233 234/* 235 * XXX: do not use MAJOR_AUTO unless you have no choice. In general drivers 236 * should just not initialize .d_maj and that will DTRT. 237 */ 238#define MAJOR_AUTO 0 /* XXX: Not GM */ 239 240struct module; 241 242struct devsw_module_data { 243 int (*chainevh)(struct module *, int, void *); /* next handler */ 244 void *chainarg; /* arg for next event handler */ 245 /* Do not initialize fields hereafter */ 246}; 247 248#define DEV_MODULE(name, evh, arg) \ 249static moduledata_t name##_mod = { \ 250 #name, \ 251 evh, \ 252 arg \ 253}; \ 254DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE) 255 256 257void clone_setup(struct clonedevs **cdp); 258void clone_cleanup(struct clonedevs **); 259#define CLONE_UNITMASK 0xfffff 260#define CLONE_FLAG0 (CLONE_UNITMASK + 1) 261int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, u_int extra); 262 263int count_dev(struct cdev *_dev); 264void destroy_dev(struct cdev *_dev); 265struct cdevsw *devsw(struct cdev *_dev); 266void cdevsw_ref(struct cdevsw *); 267void cdevsw_rel(struct cdevsw *); 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 cdev *dev); 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); 279int unit2minor(int _unit); 280void setconf(void); 281struct cdev *getdiskbyname(char *_name); 282 283void devfs_create(struct cdev *dev); 284void devfs_destroy(struct cdev *dev); 285 286#define UID_ROOT 0 287#define UID_BIN 3 288#define UID_UUCP 66 289 290#define GID_WHEEL 0 291#define GID_KMEM 2 292#define GID_OPERATOR 5 293#define GID_BIN 7 294#define GID_GAMES 13 295#define GID_DIALER 68 296 297typedef void (*dev_clone_fn)(void *arg, char *name, int namelen, struct cdev **result); 298 299int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit); 300EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn); 301 302/* Stuff relating to kernel-dump */ 303 304struct dumperinfo { 305 dumper_t *dumper; /* Dumping function. */ 306 void *priv; /* Private parts. */ 307 u_int blocksize; /* Size of block in bytes. */ 308 off_t mediaoffset; /* Initial offset in bytes. */ 309 off_t mediasize; /* Space available in bytes. */ 310}; 311 312int set_dumper(struct dumperinfo *); 313void dumpsys(struct dumperinfo *); 314extern int dumping; /* system is dumping */ 315 316/* D_TTY related functions */ 317d_ioctl_t ttyioctl; 318d_kqfilter_t ttykqfilter; 319d_poll_t ttypoll; 320d_read_t ttyread; 321d_write_t ttywrite; 322 323#endif /* _KERNEL */ 324 325#endif /* !_SYS_CONF_H_ */ 326