conf.h revision 126845
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 * 3. All advertising materials mentioning features or use of this software 21 * must display the following acknowledgement: 22 * This product includes software developed by the University of 23 * California, Berkeley and its contributors. 24 * 4. Neither the name of the University nor the names of its contributors 25 * may be used to endorse or promote products derived from this software 26 * without specific prior written permission. 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 31 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 38 * SUCH DAMAGE. 39 * 40 * @(#)conf.h 8.5 (Berkeley) 1/9/95 41 * $FreeBSD: head/sys/sys/conf.h 126845 2004-03-11 12:58:55Z phk $ 42 */ 43 44#ifndef _SYS_CONF_H_ 45#define _SYS_CONF_H_ 46 47#ifdef _KERNEL 48#include <sys/eventhandler.h> 49 50struct tty; 51struct disk; 52struct vnode; 53struct buf; 54TAILQ_HEAD(snaphead, inode); 55 56struct cdev { 57 u_int si_flags; 58#define SI_STASHED 0x0001 /* created in stashed storage */ 59#define SI_ALIAS 0x0002 /* carrier of alias name */ 60#define SI_NAMED 0x0004 /* make_dev{_alias} has been called */ 61#define SI_CHEAPCLONE 0x0008 /* can be removed_dev'ed when vnode reclaims */ 62#define SI_CHILD 0x0010 /* child of another dev_t */ 63#define SI_DEVOPEN 0x0020 /* opened by device */ 64#define SI_CONSOPEN 0x0040 /* opened by console */ 65#define SI_DUMPDEV 0x0080 /* is kernel dumpdev */ 66#define SI_CANDELETE 0x0100 /* can do BIO_DELETE */ 67#define SI_CLONELIST 0x0200 /* on a clone list */ 68 struct timespec si_atime; 69 struct timespec si_ctime; 70 struct timespec si_mtime; 71 udev_t si_udev; 72 int si_refcount; 73 LIST_ENTRY(cdev) si_list; 74 LIST_ENTRY(cdev) si_clone; 75 LIST_ENTRY(cdev) si_hash; 76 SLIST_HEAD(, vnode) si_hlist; 77 LIST_HEAD(, cdev) si_children; 78 LIST_ENTRY(cdev) si_siblings; 79 dev_t si_parent; 80 u_int si_inode; 81 char *si_name; 82 void *si_drv1, *si_drv2; 83 struct cdevsw *si_devsw; 84 int si_iosize_max; /* maximum I/O size (for physio &al) */ 85 u_int si_stripesize; 86 u_int si_stripeoffset; 87 uid_t si_uid; 88 gid_t si_gid; 89 mode_t si_mode; 90 u_long si_usecount; 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 snaphead __sid_snapshots; 100 daddr_t __sid_snaplistsize; /* size of snapblklist. */ 101 daddr_t *__sid_snapblklist; /* known snapshot blocks. */ 102 int (*__sid_copyonwrite)(struct vnode *, struct buf *); 103 } __si_disk; 104 } __si_u; 105 char __si_namebuf[SPECNAMELEN + 1]; 106}; 107 108#define si_tty __si_u.__si_tty.__sit_tty 109#define si_mountpoint __si_u.__si_disk.__sid_mountpoint 110#define si_bsize_phys __si_u.__si_disk.__sid_bsize_phys 111#define si_bsize_best __si_u.__si_disk.__sid_bsize_best 112#define si_snapshots __si_u.__si_disk.__sid_snapshots 113#define si_snaplistsize __si_u.__si_disk.__sid_snaplistsize 114#define si_snapblklist __si_u.__si_disk.__sid_snapblklist 115#define si_copyonwrite __si_u.__si_disk.__sid_copyonwrite 116 117/* 118 * Special device management 119 */ 120#define SPECHSZ 64 121#define SPECHASH(rdev) (((unsigned)(minor(rdev)))%SPECHSZ) 122 123/* 124 * Definitions of device driver entry switches 125 */ 126 127struct bio; 128struct buf; 129struct thread; 130struct uio; 131struct knote; 132struct clonedevs; 133 134/* 135 * Note: d_thread_t is provided as a transition aid for those drivers 136 * that treat struct proc/struct thread as an opaque data type and 137 * exist in substantially the same form in both 4.x and 5.x. Writers 138 * of drivers that dips into the d_thread_t structure should use 139 * struct thread or struct proc as appropriate for the version of the 140 * OS they are using. It is provided in lieu of each device driver 141 * inventing its own way of doing this. While it does violate style(9) 142 * in a number of ways, this violation is deemed to be less 143 * important than the benefits that a uniform API between releases 144 * gives. 145 * 146 * Users of struct thread/struct proc that aren't device drivers should 147 * not use d_thread_t. 148 */ 149 150typedef struct thread d_thread_t; 151 152typedef int d_open_t(dev_t dev, int oflags, int devtype, struct thread *td); 153typedef int d_fdopen_t(dev_t dev, int oflags, struct thread *td, int fdidx); 154typedef int d_close_t(dev_t dev, int fflag, int devtype, struct thread *td); 155typedef void d_strategy_t(struct bio *bp); 156typedef int d_ioctl_t(dev_t dev, u_long cmd, caddr_t data, 157 int fflag, struct thread *td); 158 159typedef int d_read_t(dev_t dev, struct uio *uio, int ioflag); 160typedef int d_write_t(dev_t dev, struct uio *uio, int ioflag); 161typedef int d_poll_t(dev_t dev, int events, struct thread *td); 162typedef int d_kqfilter_t(dev_t dev, struct knote *kn); 163typedef int d_mmap_t(dev_t dev, vm_offset_t offset, vm_paddr_t *paddr, 164 int nprot); 165 166typedef int l_open_t(dev_t dev, struct tty *tp); 167typedef int l_close_t(struct tty *tp, int flag); 168typedef int l_read_t(struct tty *tp, struct uio *uio, int flag); 169typedef int l_write_t(struct tty *tp, struct uio *uio, int flag); 170typedef int l_ioctl_t(struct tty *tp, u_long cmd, caddr_t data, 171 int flag, struct thread *td); 172typedef int l_rint_t(int c, struct tty *tp); 173typedef int l_start_t(struct tty *tp); 174typedef int l_modem_t(struct tty *tp, int flag); 175 176typedef int dumper_t( 177 void *priv, /* Private to the driver. */ 178 void *virtual, /* Virtual (mapped) address. */ 179 vm_offset_t physical, /* Physical address of virtual. */ 180 off_t offset, /* Byte-offset to write at. */ 181 size_t length); /* Number of bytes to dump. */ 182 183#define DEV_STRATEGY(bp) dev_strategy(bp) 184 185#endif /* _KERNEL */ 186 187/* 188 * Types for d_flags. 189 */ 190#define D_TAPE 0x0001 191#define D_DISK 0x0002 192#define D_TTY 0x0004 193#define D_MEM 0x0008 194 195#ifdef _KERNEL 196 197#define D_TYPEMASK 0xffff 198 199/* 200 * Flags for d_flags which the drivers can set. 201 */ 202#define D_MEMDISK 0x00010000 /* memory type disk */ 203#define D_TRACKCLOSE 0x00080000 /* track all closes */ 204#define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */ 205#define D_PSEUDO 0x00200000 /* make_dev() can return NULL */ 206#define D_NEEDGIANT 0x00400000 /* driver want Giant */ 207 208/* 209 * Version numbers. 210 */ 211#define D_VERSION_00 0x20011966 212#define D_VERSION D_VERSION_00 213 214/* 215 * Flags used for internal housekeeping 216 */ 217#define D_INIT 0x80000000 /* cdevsw initialized */ 218#define D_ALLOCMAJ 0x40000000 /* major# is allocated */ 219 220/* 221 * Character device switch table 222 */ 223struct cdevsw { 224 int d_version; 225 int d_maj; 226 u_int d_flags; 227 const char *d_name; 228 d_open_t *d_open; 229 d_fdopen_t *d_fdopen; 230 d_close_t *d_close; 231 d_read_t *d_read; 232 d_write_t *d_write; 233 d_ioctl_t *d_ioctl; 234 d_poll_t *d_poll; 235 d_mmap_t *d_mmap; 236 d_strategy_t *d_strategy; 237 dumper_t *d_dump; 238 d_kqfilter_t *d_kqfilter; 239 240 /* These fields should not be messed with by drivers */ 241 LIST_ENTRY(cdevsw) d_list; 242 LIST_HEAD(, cdev) d_devs; 243 int d_refcount; 244}; 245 246/* 247 * Line discipline switch table 248 */ 249struct linesw { 250 l_open_t *l_open; 251 l_close_t *l_close; 252 l_read_t *l_read; 253 l_write_t *l_write; 254 l_ioctl_t *l_ioctl; 255 l_rint_t *l_rint; 256 l_start_t *l_start; 257 l_modem_t *l_modem; 258 u_char l_hotchar; 259}; 260 261extern struct linesw linesw[]; 262extern int nlinesw; 263 264int ldisc_register(int , struct linesw *); 265void ldisc_deregister(int); 266#define LDISC_LOAD -1 /* Loadable line discipline */ 267#endif /* _KERNEL */ 268 269#ifdef _KERNEL 270 271#define NUMCDEVSW 256 272 273/* 274 * XXX: do not use MAJOR_AUTO unless you have no choice. In general drivers 275 * should just not initialize .d_maj and that will DTRT. 276 */ 277#define MAJOR_AUTO 0 /* XXX: Not GM */ 278 279l_ioctl_t l_nullioctl; 280l_read_t l_noread; 281l_write_t l_nowrite; 282 283struct module; 284 285struct devsw_module_data { 286 int (*chainevh)(struct module *, int, void *); /* next handler */ 287 void *chainarg; /* arg for next event handler */ 288 /* Do not initialize fields hereafter */ 289}; 290 291#define DEV_MODULE(name, evh, arg) \ 292static moduledata_t name##_mod = { \ 293 #name, \ 294 evh, \ 295 arg \ 296}; \ 297DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE) 298 299 300void clone_setup(struct clonedevs **cdp); 301void clone_cleanup(struct clonedevs **); 302#define CLONE_UNITMASK 0xfffff 303#define CLONE_FLAG0 (CLONE_UNITMASK + 1) 304int clone_create(struct clonedevs **, struct cdevsw *, int *unit, dev_t *dev, u_int extra); 305 306int count_dev(dev_t _dev); 307void destroy_dev(dev_t _dev); 308struct cdevsw *devsw(dev_t _dev); 309void cdevsw_ref(struct cdevsw *); 310void cdevsw_rel(struct cdevsw *); 311const char *devtoname(dev_t _dev); 312int dev_named(dev_t _pdev, const char *_name); 313void dev_depends(dev_t _pdev, dev_t _cdev); 314void dev_ref(dev_t dev); 315void dev_rel(dev_t dev); 316void dev_strategy(struct buf *bp); 317dev_t makebdev(int _maj, int _min); 318dev_t make_dev(struct cdevsw *_devsw, int _minor, uid_t _uid, gid_t _gid, 319 int _perms, const char *_fmt, ...) __printflike(6, 7); 320dev_t make_dev_alias(dev_t _pdev, const char *_fmt, ...) __printflike(2, 3); 321int dev2unit(dev_t _dev); 322int unit2minor(int _unit); 323void setconf(void); 324dev_t getdiskbyname(char *_name); 325 326void devfs_create(dev_t dev); 327void devfs_destroy(dev_t dev); 328 329#define UID_ROOT 0 330#define UID_BIN 3 331#define UID_UUCP 66 332 333#define GID_WHEEL 0 334#define GID_KMEM 2 335#define GID_OPERATOR 5 336#define GID_BIN 7 337#define GID_GAMES 13 338#define GID_DIALER 68 339 340typedef void (*dev_clone_fn)(void *arg, char *name, int namelen, dev_t *result); 341 342int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit); 343EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn); 344 345/* Stuff relating to kernel-dump */ 346 347struct dumperinfo { 348 dumper_t *dumper; /* Dumping function. */ 349 void *priv; /* Private parts. */ 350 u_int blocksize; /* Size of block in bytes. */ 351 off_t mediaoffset; /* Initial offset in bytes. */ 352 off_t mediasize; /* Space available in bytes. */ 353}; 354 355int set_dumper(struct dumperinfo *); 356void dumpsys(struct dumperinfo *); 357extern int dumping; /* system is dumping */ 358 359#endif /* _KERNEL */ 360 361#endif /* !_SYS_CONF_H_ */ 362