conf.h revision 179828
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 179828 2008-06-16 17:34:59Z kib $ 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 snapdata; 51struct devfs_dirent; 52struct cdevsw; 53struct file; 54 55struct cdev { 56 void *__si_reserved; 57 u_int si_flags; 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 tty *__sit_tty; 89 struct snapdata *__sid_snapdata; 90 } __si_u; 91 char __si_namebuf[SPECNAMELEN + 1]; 92}; 93 94#define si_tty __si_u.__sit_tty 95#define si_snapdata __si_u.__sid_snapdata 96 97#ifdef _KERNEL 98 99/* 100 * Definitions of device driver entry switches 101 */ 102 103struct bio; 104struct buf; 105struct thread; 106struct uio; 107struct knote; 108struct clonedevs; 109struct vnode; 110 111/* 112 * Note: d_thread_t is provided as a transition aid for those drivers 113 * that treat struct proc/struct thread as an opaque data type and 114 * exist in substantially the same form in both 4.x and 5.x. Writers 115 * of drivers that dips into the d_thread_t structure should use 116 * struct thread or struct proc as appropriate for the version of the 117 * OS they are using. It is provided in lieu of each device driver 118 * inventing its own way of doing this. While it does violate style(9) 119 * in a number of ways, this violation is deemed to be less 120 * important than the benefits that a uniform API between releases 121 * gives. 122 * 123 * Users of struct thread/struct proc that aren't device drivers should 124 * not use d_thread_t. 125 */ 126 127typedef struct thread d_thread_t; 128 129typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td); 130typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, struct file *fp); 131typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td); 132typedef void d_strategy_t(struct bio *bp); 133typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data, 134 int fflag, struct thread *td); 135 136typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag); 137typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag); 138typedef int d_poll_t(struct cdev *dev, int events, struct thread *td); 139typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn); 140typedef int d_mmap_t(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr, 141 int nprot); 142typedef void d_purge_t(struct cdev *dev); 143 144typedef int d_spare2_t(struct cdev *dev); 145 146typedef int dumper_t( 147 void *priv, /* Private to the driver. */ 148 void *virtual, /* Virtual (mapped) address. */ 149 vm_offset_t physical, /* Physical address of virtual. */ 150 off_t offset, /* Byte-offset to write at. */ 151 size_t length); /* Number of bytes to dump. */ 152 153#endif /* _KERNEL */ 154 155/* 156 * Types for d_flags. 157 */ 158#define D_TAPE 0x0001 159#define D_DISK 0x0002 160#define D_TTY 0x0004 161#define D_MEM 0x0008 162 163#ifdef _KERNEL 164 165#define D_TYPEMASK 0xffff 166 167/* 168 * Flags for d_flags which the drivers can set. 169 */ 170#define D_TRACKCLOSE 0x00080000 /* track all closes */ 171#define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */ 172#define D_PSEUDO 0x00200000 /* make_dev() can return NULL */ 173#define D_NEEDGIANT 0x00400000 /* driver want Giant */ 174#define D_NEEDMINOR 0x00800000 /* driver uses clone_create() */ 175 176/* 177 * Version numbers. 178 */ 179#define D_VERSION_00 0x20011966 180#define D_VERSION_01 0x17032005 /* Add d_uid,gid,mode & kind */ 181#define D_VERSION D_VERSION_01 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_spare2_t *d_spare2; 208 uid_t d_uid; 209 gid_t d_gid; 210 mode_t d_mode; 211 const char *d_kind; 212 213 /* These fields should not be messed with by drivers */ 214 LIST_ENTRY(cdevsw) d_list; 215 LIST_HEAD(, cdev) d_devs; 216 int d_spare3; 217 union { 218 struct cdevsw *gianttrick; 219 SLIST_ENTRY(cdevsw) postfree_list; 220 } __d_giant; 221}; 222#define d_gianttrick __d_giant.gianttrick 223#define d_postfree_list __d_giant.postfree_list 224 225#define NUMCDEVSW 256 226 227struct module; 228 229struct devsw_module_data { 230 int (*chainevh)(struct module *, int, void *); /* next handler */ 231 void *chainarg; /* arg for next event handler */ 232 /* Do not initialize fields hereafter */ 233}; 234 235#define DEV_MODULE(name, evh, arg) \ 236static moduledata_t name##_mod = { \ 237 #name, \ 238 evh, \ 239 arg \ 240}; \ 241DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE) 242 243 244void clone_setup(struct clonedevs **cdp); 245void clone_cleanup(struct clonedevs **); 246#define CLONE_UNITMASK 0xfffff 247#define CLONE_FLAG0 (CLONE_UNITMASK + 1) 248int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra); 249 250int count_dev(struct cdev *_dev); 251void destroy_dev(struct cdev *_dev); 252int destroy_dev_sched(struct cdev *dev); 253int destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg); 254void destroy_dev_drain(struct cdevsw *csw); 255void drain_dev_clone_events(void); 256struct cdevsw *dev_refthread(struct cdev *_dev); 257struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp); 258void dev_relthread(struct cdev *_dev); 259void dev_depends(struct cdev *_pdev, struct cdev *_cdev); 260void dev_ref(struct cdev *dev); 261void dev_refl(struct cdev *dev); 262void dev_rel(struct cdev *dev); 263void dev_strategy(struct cdev *dev, struct buf *bp); 264struct cdev *make_dev(struct cdevsw *_devsw, int _minor, uid_t _uid, gid_t _gid, 265 int _perms, const char *_fmt, ...) __printflike(6, 7); 266struct cdev *make_dev_cred(struct cdevsw *_devsw, int _minor, 267 struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms, 268 const char *_fmt, ...) __printflike(7, 8); 269#define MAKEDEV_REF 0x1 270#define MAKEDEV_WHTOUT 0x2 271struct cdev *make_dev_credf(int _flags, 272 struct cdevsw *_devsw, int _minornr, 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, ...) __printflike(2, 3); 276void dev_lock(void); 277void dev_unlock(void); 278void setconf(void); 279 280#define dev2unit(d) ((d) ? (d)->si_drv0 : NODEV) 281#define minor(d) ((d) ? (d)->si_drv0 : NODEV) 282#define unit2minor(u) (u) 283#define minor2unit(m) (m) 284 285typedef void (*cdevpriv_dtr_t)(void *data); 286int devfs_get_cdevpriv(void **datap); 287int devfs_set_cdevpriv(void *priv, cdevpriv_dtr_t dtr); 288void devfs_clear_cdevpriv(void); 289void devfs_fpdrop(struct file *fp); /* XXX This is not public KPI */ 290 291#define UID_ROOT 0 292#define UID_BIN 3 293#define UID_UUCP 66 294 295#define GID_WHEEL 0 296#define GID_KMEM 2 297#define GID_TTY 4 298#define GID_OPERATOR 5 299#define GID_BIN 7 300#define GID_GAMES 13 301#define GID_DIALER 68 302 303typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name, 304 int namelen, struct cdev **result); 305 306int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit); 307EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn); 308 309/* Stuff relating to kernel-dump */ 310 311struct dumperinfo { 312 dumper_t *dumper; /* Dumping function. */ 313 void *priv; /* Private parts. */ 314 u_int blocksize; /* Size of block in bytes. */ 315 u_int maxiosize; /* Max size allowed for an individual I/O */ 316 off_t mediaoffset; /* Initial offset in bytes. */ 317 off_t mediasize; /* Space available in bytes. */ 318}; 319 320int set_dumper(struct dumperinfo *); 321int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t); 322void dumpsys(struct dumperinfo *); 323extern int dumping; /* system is dumping */ 324 325/* D_TTY related functions */ 326d_close_t ttyclose; 327d_ioctl_t ttyioctl; 328d_kqfilter_t ttykqfilter; 329d_open_t ttyopen; 330d_poll_t ttypoll; 331d_read_t ttyread; 332d_write_t ttywrite; 333 334#endif /* _KERNEL */ 335 336#endif /* !_SYS_CONF_H_ */ 337