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