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