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