conf.h revision 226477
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 226477 2011-10-17 19:40:26Z ed $ 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 snapdata; 50struct devfs_dirent; 51struct cdevsw; 52struct file; 53 54struct cdev { 55 void *__si_reserved; 56 u_int si_flags; 57#define SI_ETERNAL 0x0001 /* never destroyed */ 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 uid_t si_uid; 71 gid_t si_gid; 72 mode_t si_mode; 73 struct ucred *si_cred; /* cached clone-time credential */ 74 int si_drv0; 75 int si_refcount; 76 LIST_ENTRY(cdev) si_list; 77 LIST_ENTRY(cdev) si_clone; 78 LIST_HEAD(, cdev) si_children; 79 LIST_ENTRY(cdev) si_siblings; 80 struct cdev *si_parent; 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_long si_usecount; 86 u_long si_threadcount; 87 union { 88 struct snapdata *__sid_snapdata; 89 } __si_u; 90 char __si_namebuf[SPECNAMELEN + 1]; 91}; 92 93#define si_snapdata __si_u.__sid_snapdata 94 95#ifdef _KERNEL 96 97/* 98 * Definitions of device driver entry switches 99 */ 100 101struct bio; 102struct buf; 103struct thread; 104struct uio; 105struct knote; 106struct clonedevs; 107struct vm_object; 108struct vnode; 109 110/* 111 * Note: d_thread_t is provided as a transition aid for those drivers 112 * that treat struct proc/struct thread as an opaque data type and 113 * exist in substantially the same form in both 4.x and 5.x. Writers 114 * of drivers that dips into the d_thread_t structure should use 115 * struct thread or struct proc as appropriate for the version of the 116 * OS they are using. It is provided in lieu of each device driver 117 * inventing its own way of doing this. While it does violate style(9) 118 * in a number of ways, this violation is deemed to be less 119 * important than the benefits that a uniform API between releases 120 * gives. 121 * 122 * Users of struct thread/struct proc that aren't device drivers should 123 * not use d_thread_t. 124 */ 125 126typedef struct thread d_thread_t; 127 128typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td); 129typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, struct file *fp); 130typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td); 131typedef void d_strategy_t(struct bio *bp); 132typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data, 133 int fflag, struct thread *td); 134 135typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag); 136typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag); 137typedef int d_poll_t(struct cdev *dev, int events, struct thread *td); 138typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn); 139typedef int d_mmap_t(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr, 140 int nprot, vm_memattr_t *memattr); 141typedef int d_mmap_single_t(struct cdev *cdev, vm_ooffset_t *offset, 142 vm_size_t size, struct vm_object **object, int nprot); 143typedef void d_purge_t(struct cdev *dev); 144 145typedef int dumper_t( 146 void *_priv, /* Private to the driver. */ 147 void *_virtual, /* Virtual (mapped) address. */ 148 vm_offset_t _physical, /* Physical address of virtual. */ 149 off_t _offset, /* Byte-offset to write at. */ 150 size_t _length); /* Number of bytes to dump. */ 151 152#endif /* _KERNEL */ 153 154/* 155 * Types for d_flags. 156 */ 157#define D_TAPE 0x0001 158#define D_DISK 0x0002 159#define D_TTY 0x0004 160#define D_MEM 0x0008 161 162#ifdef _KERNEL 163 164#define D_TYPEMASK 0xffff 165 166/* 167 * Flags for d_flags which the drivers can set. 168 */ 169#define D_TRACKCLOSE 0x00080000 /* track all closes */ 170#define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */ 171#define D_PSEUDO 0x00200000 /* make_dev() can return NULL */ 172#define D_NEEDGIANT 0x00400000 /* driver want Giant */ 173#define D_NEEDMINOR 0x00800000 /* driver uses clone_create() */ 174 175/* 176 * Version numbers. 177 */ 178#define D_VERSION_00 0x20011966 179#define D_VERSION_01 0x17032005 /* Add d_uid,gid,mode & kind */ 180#define D_VERSION_02 0x28042009 /* Add d_mmap_single */ 181#define D_VERSION_03 0x17122009 /* d_mmap takes memattr,vm_ooffset_t */ 182#define D_VERSION D_VERSION_03 183 184/* 185 * Flags used for internal housekeeping 186 */ 187#define D_INIT 0x80000000 /* cdevsw initialized */ 188 189/* 190 * Character device switch table 191 */ 192struct cdevsw { 193 int d_version; 194 u_int d_flags; 195 const char *d_name; 196 d_open_t *d_open; 197 d_fdopen_t *d_fdopen; 198 d_close_t *d_close; 199 d_read_t *d_read; 200 d_write_t *d_write; 201 d_ioctl_t *d_ioctl; 202 d_poll_t *d_poll; 203 d_mmap_t *d_mmap; 204 d_strategy_t *d_strategy; 205 dumper_t *d_dump; 206 d_kqfilter_t *d_kqfilter; 207 d_purge_t *d_purge; 208 d_mmap_single_t *d_mmap_single; 209 210 int32_t d_spare0[3]; 211 void *d_spare1[3]; 212 213 /* These fields should not be messed with by drivers */ 214 LIST_HEAD(, cdev) d_devs; 215 int d_spare2; 216 union { 217 struct cdevsw *gianttrick; 218 SLIST_ENTRY(cdevsw) postfree_list; 219 } __d_giant; 220}; 221#define d_gianttrick __d_giant.gianttrick 222#define d_postfree_list __d_giant.postfree_list 223 224struct module; 225 226struct devsw_module_data { 227 int (*chainevh)(struct module *, int, void *); /* next handler */ 228 void *chainarg; /* arg for next event handler */ 229 /* Do not initialize fields hereafter */ 230}; 231 232#define DEV_MODULE(name, evh, arg) \ 233static moduledata_t name##_mod = { \ 234 #name, \ 235 evh, \ 236 arg \ 237}; \ 238DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE) 239 240 241void clone_setup(struct clonedevs **cdp); 242void clone_cleanup(struct clonedevs **); 243#define CLONE_UNITMASK 0xfffff 244#define CLONE_FLAG0 (CLONE_UNITMASK + 1) 245int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra); 246 247int count_dev(struct cdev *_dev); 248void destroy_dev(struct cdev *_dev); 249int destroy_dev_sched(struct cdev *dev); 250int destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg); 251void destroy_dev_drain(struct cdevsw *csw); 252void drain_dev_clone_events(void); 253struct cdevsw *dev_refthread(struct cdev *_dev, int *_ref); 254struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp, int *_ref); 255void dev_relthread(struct cdev *_dev, int _ref); 256void dev_depends(struct cdev *_pdev, struct cdev *_cdev); 257void dev_ref(struct cdev *dev); 258void dev_refl(struct cdev *dev); 259void dev_rel(struct cdev *dev); 260void dev_strategy(struct cdev *dev, struct buf *bp); 261struct cdev *make_dev(struct cdevsw *_devsw, int _unit, uid_t _uid, gid_t _gid, 262 int _perms, const char *_fmt, ...) __printflike(6, 7); 263struct cdev *make_dev_cred(struct cdevsw *_devsw, int _unit, 264 struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms, 265 const char *_fmt, ...) __printflike(7, 8); 266#define MAKEDEV_REF 0x01 267#define MAKEDEV_WHTOUT 0x02 268#define MAKEDEV_NOWAIT 0x04 269#define MAKEDEV_WAITOK 0x08 270#define MAKEDEV_ETERNAL 0x10 271#define MAKEDEV_CHECKNAME 0x20 272struct cdev *make_dev_credf(int _flags, 273 struct cdevsw *_devsw, int _unit, 274 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, 275 const char *_fmt, ...) __printflike(8, 9); 276int make_dev_p(int _flags, struct cdev **_cdev, struct cdevsw *_devsw, 277 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, 278 const char *_fmt, ...) __printflike(8, 9); 279struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...) 280 __printflike(2, 3); 281int make_dev_alias_p(int _flags, struct cdev **_cdev, struct cdev *_pdev, 282 const char *_fmt, ...) __printflike(4, 5); 283int make_dev_physpath_alias(int _flags, struct cdev **_cdev, 284 struct cdev *_pdev, struct cdev *_old_alias, 285 const char *_physpath); 286void dev_lock(void); 287void dev_unlock(void); 288void setconf(void); 289 290#ifdef KLD_MODULE 291#define MAKEDEV_ETERNAL_KLD 0 292#else 293#define MAKEDEV_ETERNAL_KLD MAKEDEV_ETERNAL 294#endif 295 296#define dev2unit(d) ((d)->si_drv0) 297 298typedef void (*cdevpriv_dtr_t)(void *data); 299int devfs_get_cdevpriv(void **datap); 300int devfs_set_cdevpriv(void *priv, cdevpriv_dtr_t dtr); 301void devfs_clear_cdevpriv(void); 302void devfs_fpdrop(struct file *fp); /* XXX This is not public KPI */ 303 304ino_t devfs_alloc_cdp_inode(void); 305void devfs_free_cdp_inode(ino_t ino); 306 307#define UID_ROOT 0 308#define UID_BIN 3 309#define UID_UUCP 66 310#define UID_NOBODY 65534 311 312#define GID_WHEEL 0 313#define GID_KMEM 2 314#define GID_TTY 4 315#define GID_OPERATOR 5 316#define GID_BIN 7 317#define GID_GAMES 13 318#define GID_DIALER 68 319#define GID_NOBODY 65534 320 321typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name, 322 int namelen, struct cdev **result); 323 324int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit); 325EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn); 326 327/* Stuff relating to kernel-dump */ 328 329struct dumperinfo { 330 dumper_t *dumper; /* Dumping function. */ 331 void *priv; /* Private parts. */ 332 u_int blocksize; /* Size of block in bytes. */ 333 u_int maxiosize; /* Max size allowed for an individual I/O */ 334 off_t mediaoffset; /* Initial offset in bytes. */ 335 off_t mediasize; /* Space available in bytes. */ 336}; 337 338int set_dumper(struct dumperinfo *); 339int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t); 340void dumpsys(struct dumperinfo *); 341int doadump(boolean_t); 342extern int dumping; /* system is dumping */ 343 344#endif /* _KERNEL */ 345 346#endif /* !_SYS_CONF_H_ */ 347