conf.h revision 207729
1177548Scsjp/*- 2177548Scsjp * Copyright (c) 1990, 1993 3177548Scsjp * The Regents of the University of California. All rights reserved. 4177548Scsjp * Copyright (c) 2000 5230108Seadler * Poul-Henning Kamp. All rights reserved. 6177548Scsjp * (c) UNIX System Laboratories, Inc. 7177548Scsjp * All or some portions of this file are derived from material licensed 8177548Scsjp * to the University of California by American Telephone and Telegraph 9177548Scsjp * Co. or Unix System Laboratories, Inc. and are reproduced herein with 10177548Scsjp * the permission of UNIX System Laboratories, Inc. 11177548Scsjp * 12177548Scsjp * Redistribution and use in source and binary forms, with or without 13177548Scsjp * modification, are permitted provided that the following conditions 14177548Scsjp * are met: 15177548Scsjp * 1. Redistributions of source code must retain the above copyright 16177548Scsjp * notice, this list of conditions and the following disclaimer. 17177548Scsjp * 2. Redistributions in binary form must reproduce the above copyright 18177548Scsjp * notice, this list of conditions and the following disclaimer in the 19177548Scsjp * documentation and/or other materials provided with the distribution. 20177548Scsjp * 4. Neither the name of the University nor the names of its contributors 21177548Scsjp * may be used to endorse or promote products derived from this software 22177548Scsjp * without specific prior written permission. 23177548Scsjp * 24177548Scsjp * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25177548Scsjp * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26177548Scsjp * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27177548Scsjp * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28177548Scsjp * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29177548Scsjp * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30177548Scsjp * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31177548Scsjp * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32177548Scsjp * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33177548Scsjp * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34177548Scsjp * SUCH DAMAGE. 35177548Scsjp * 36177548Scsjp * @(#)conf.h 8.5 (Berkeley) 1/9/95 37177548Scsjp * $FreeBSD: head/sys/sys/conf.h 207729 2010-05-06 19:22:50Z kib $ 38177548Scsjp */ 39177548Scsjp 40177548Scsjp#ifndef _SYS_CONF_H_ 41177548Scsjp#define _SYS_CONF_H_ 42177548Scsjp 43177966Srwatson#ifdef _KERNEL 44177548Scsjp#include <sys/eventhandler.h> 45180310Scsjp#else 46177548Scsjp#include <sys/queue.h> 47177966Srwatson#endif 48177548Scsjp 49177548Scsjpstruct snapdata; 50177548Scsjpstruct devfs_dirent; 51177548Scsjpstruct cdevsw; 52177548Scsjpstruct file; 53177548Scsjp 54177548Scsjpstruct cdev { 55177548Scsjp void *__si_reserved; 56177548Scsjp 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 uid_t si_uid; 70 gid_t si_gid; 71 mode_t si_mode; 72 struct ucred *si_cred; /* cached clone-time credential */ 73 int si_drv0; 74 int si_refcount; 75 LIST_ENTRY(cdev) si_list; 76 LIST_ENTRY(cdev) si_clone; 77 LIST_HEAD(, cdev) si_children; 78 LIST_ENTRY(cdev) si_siblings; 79 struct cdev *si_parent; 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_long si_usecount; 85 u_long si_threadcount; 86 union { 87 struct snapdata *__sid_snapdata; 88 } __si_u; 89 char __si_namebuf[SPECNAMELEN + 1]; 90}; 91 92#define si_snapdata __si_u.__sid_snapdata 93 94#ifdef _KERNEL 95 96/* 97 * Definitions of device driver entry switches 98 */ 99 100struct bio; 101struct buf; 102struct thread; 103struct uio; 104struct knote; 105struct clonedevs; 106struct vm_object; 107struct vnode; 108 109/* 110 * Note: d_thread_t is provided as a transition aid for those drivers 111 * that treat struct proc/struct thread as an opaque data type and 112 * exist in substantially the same form in both 4.x and 5.x. Writers 113 * of drivers that dips into the d_thread_t structure should use 114 * struct thread or struct proc as appropriate for the version of the 115 * OS they are using. It is provided in lieu of each device driver 116 * inventing its own way of doing this. While it does violate style(9) 117 * in a number of ways, this violation is deemed to be less 118 * important than the benefits that a uniform API between releases 119 * gives. 120 * 121 * Users of struct thread/struct proc that aren't device drivers should 122 * not use d_thread_t. 123 */ 124 125typedef struct thread d_thread_t; 126 127typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td); 128typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, struct file *fp); 129typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td); 130typedef void d_strategy_t(struct bio *bp); 131typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data, 132 int fflag, struct thread *td); 133 134typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag); 135typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag); 136typedef int d_poll_t(struct cdev *dev, int events, struct thread *td); 137typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn); 138typedef int d_mmap_t(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr, 139 int nprot, vm_memattr_t *memattr); 140typedef int d_mmap_single_t(struct cdev *cdev, vm_ooffset_t *offset, 141 vm_size_t size, struct vm_object **object, int nprot); 142typedef void d_purge_t(struct cdev *dev); 143 144typedef int dumper_t( 145 void *_priv, /* Private to the driver. */ 146 void *_virtual, /* Virtual (mapped) address. */ 147 vm_offset_t _physical, /* Physical address of virtual. */ 148 off_t _offset, /* Byte-offset to write at. */ 149 size_t _length); /* Number of bytes to dump. */ 150 151#endif /* _KERNEL */ 152 153/* 154 * Types for d_flags. 155 */ 156#define D_TAPE 0x0001 157#define D_DISK 0x0002 158#define D_TTY 0x0004 159#define D_MEM 0x0008 160 161#ifdef _KERNEL 162 163#define D_TYPEMASK 0xffff 164 165/* 166 * Flags for d_flags which the drivers can set. 167 */ 168#define D_TRACKCLOSE 0x00080000 /* track all closes */ 169#define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */ 170#define D_PSEUDO 0x00200000 /* make_dev() can return NULL */ 171#define D_NEEDGIANT 0x00400000 /* driver want Giant */ 172#define D_NEEDMINOR 0x00800000 /* driver uses clone_create() */ 173 174/* 175 * Version numbers. 176 */ 177#define D_VERSION_00 0x20011966 178#define D_VERSION_01 0x17032005 /* Add d_uid,gid,mode & kind */ 179#define D_VERSION_02 0x28042009 /* Add d_mmap_single */ 180#define D_VERSION_03 0x17122009 /* d_mmap takes memattr,vm_ooffset_t */ 181#define D_VERSION D_VERSION_03 182 183/* 184 * Flags used for internal housekeeping 185 */ 186#define D_INIT 0x80000000 /* cdevsw initialized */ 187 188/* 189 * Character device switch table 190 */ 191struct cdevsw { 192 int d_version; 193 u_int d_flags; 194 const char *d_name; 195 d_open_t *d_open; 196 d_fdopen_t *d_fdopen; 197 d_close_t *d_close; 198 d_read_t *d_read; 199 d_write_t *d_write; 200 d_ioctl_t *d_ioctl; 201 d_poll_t *d_poll; 202 d_mmap_t *d_mmap; 203 d_strategy_t *d_strategy; 204 dumper_t *d_dump; 205 d_kqfilter_t *d_kqfilter; 206 d_purge_t *d_purge; 207 d_mmap_single_t *d_mmap_single; 208 209 int32_t d_spare0[3]; 210 void *d_spare1[3]; 211 212 /* These fields should not be messed with by drivers */ 213 LIST_HEAD(, cdev) d_devs; 214 int d_spare2; 215 union { 216 struct cdevsw *gianttrick; 217 SLIST_ENTRY(cdevsw) postfree_list; 218 } __d_giant; 219}; 220#define d_gianttrick __d_giant.gianttrick 221#define d_postfree_list __d_giant.postfree_list 222 223struct module; 224 225struct devsw_module_data { 226 int (*chainevh)(struct module *, int, void *); /* next handler */ 227 void *chainarg; /* arg for next event handler */ 228 /* Do not initialize fields hereafter */ 229}; 230 231#define DEV_MODULE(name, evh, arg) \ 232static moduledata_t name##_mod = { \ 233 #name, \ 234 evh, \ 235 arg \ 236}; \ 237DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE) 238 239 240void clone_setup(struct clonedevs **cdp); 241void clone_cleanup(struct clonedevs **); 242#define CLONE_UNITMASK 0xfffff 243#define CLONE_FLAG0 (CLONE_UNITMASK + 1) 244int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra); 245 246int count_dev(struct cdev *_dev); 247void destroy_dev(struct cdev *_dev); 248int destroy_dev_sched(struct cdev *dev); 249int destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg); 250void destroy_dev_drain(struct cdevsw *csw); 251void drain_dev_clone_events(void); 252struct cdevsw *dev_refthread(struct cdev *_dev); 253struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp); 254void dev_relthread(struct cdev *_dev); 255void dev_depends(struct cdev *_pdev, struct cdev *_cdev); 256void dev_ref(struct cdev *dev); 257void dev_refl(struct cdev *dev); 258void dev_rel(struct cdev *dev); 259void dev_strategy(struct cdev *dev, struct buf *bp); 260struct cdev *make_dev(struct cdevsw *_devsw, int _unit, uid_t _uid, gid_t _gid, 261 int _perms, const char *_fmt, ...) __printflike(6, 7); 262struct cdev *make_dev_cred(struct cdevsw *_devsw, int _unit, 263 struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms, 264 const char *_fmt, ...) __printflike(7, 8); 265#define MAKEDEV_REF 0x1 266#define MAKEDEV_WHTOUT 0x2 267#define MAKEDEV_NOWAIT 0x4 268#define MAKEDEV_WAITOK 0x8 269struct cdev *make_dev_credf(int _flags, 270 struct cdevsw *_devsw, int _unit, 271 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, 272 const char *_fmt, ...) __printflike(8, 9); 273struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...) __printflike(2, 3); 274void dev_lock(void); 275void dev_unlock(void); 276void setconf(void); 277 278#define dev2unit(d) ((d)->si_drv0) 279 280typedef void (*cdevpriv_dtr_t)(void *data); 281int devfs_get_cdevpriv(void **datap); 282int devfs_set_cdevpriv(void *priv, cdevpriv_dtr_t dtr); 283void devfs_clear_cdevpriv(void); 284void devfs_fpdrop(struct file *fp); /* XXX This is not public KPI */ 285 286#define UID_ROOT 0 287#define UID_BIN 3 288#define UID_UUCP 66 289#define UID_NOBODY 65534 290 291#define GID_WHEEL 0 292#define GID_KMEM 2 293#define GID_TTY 4 294#define GID_OPERATOR 5 295#define GID_BIN 7 296#define GID_GAMES 13 297#define GID_DIALER 68 298#define GID_NOBODY 65534 299 300typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name, 301 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 u_int maxiosize; /* Max size allowed for an individual I/O */ 313 off_t mediaoffset; /* Initial offset in bytes. */ 314 off_t mediasize; /* Space available in bytes. */ 315}; 316 317int set_dumper(struct dumperinfo *); 318int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t); 319void dumpsys(struct dumperinfo *); 320extern int dumping; /* system is dumping */ 321 322#endif /* _KERNEL */ 323 324#endif /* !_SYS_CONF_H_ */ 325