sys/sys/filedesc.h

   1 /*
   2  * Copyright (c) 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)filedesc.h  8.1 (Berkeley) 6/2/93
  34  * $FreeBSD: src/sys/sys/filedesc.h,v 1.19.2.5 2003/06/06 20:21:32 tegge Exp $
  35  * $DragonFly: src/sys/sys/filedesc.h,v 1.20 2006/10/27 04:56:33 dillon Exp $
  36  */
  37
  38 #ifndef _SYS_FILEDESC_H_
  39 #define _SYS_FILEDESC_H_
  40
  41 #ifndef _SYS_TYPES_H_
  42 #include <sys/types.h>
  43 #endif
  44 #ifndef _SYS_QUEUE_H_
  45 #include <sys/queue.h>
  46 #endif
  47 #ifndef _SYS_SPINLOCK_H_
  48 #include <sys/spinlock.h>
  49 #endif
  50 #ifndef _SYS_NAMECACHE_H_
  51 #include <sys/namecache.h>
  52 #endif
  53
  54 /*
  55  * This structure is used for the management of descriptors.  It may be
  56  * shared by multiple processes.
  57  *
  58  * A process is initially started out with NDFILE descriptors stored within
  59  * this structure, selected to be enough for typical applications based on
  60  * the historical limit of 20 open files (and the usage of descriptors by
  61  * shells) and the constraint of being one less than a power of 2.
  62  * If these descriptors are exhausted, a larger descriptor table
  63  * may be allocated, up to a process' resource limit; the internal arrays
  64  * are then unused.  Each time the file table runs out, it is doubled until
  65  * the resource limit is reached.
  66  */
  67 #define NDFILE          15              /* must be of the form 2^n - 1 */
  68
  69 struct file;
  70 struct klist;
  71
  72 struct fdnode {
  73         struct file *fp;
  74         char    fileflags;
  75         char    unused01;
  76         char    unused02;
  77         char    reserved;               /* descriptor has been reserved */
  78         int     allocated;              /* subtree allocation count */
  79 };
  80
  81 struct filedesc {
  82         struct fdnode *fd_files;        /* file structures for open files */
  83         struct  vnode *fd_cdir;         /* current directory (phaseout) */
  84         struct  vnode *fd_rdir;         /* root directory (phaseout) */
  85         struct  vnode *fd_jdir;         /* jail root directory (phaseout) */
  86         struct  nchandle fd_ncdir;      /* current directory */
  87         struct  nchandle fd_nrdir;      /* root directory */
  88         struct  nchandle fd_njdir;      /* jail directory */
  89         int     fd_nfiles;              /* number of open files allocated */
  90         int     fd_lastfile;            /* high-water mark of fd_files */
  91         int     fd_freefile;            /* approx. next free file */
  92         int     fd_cmask;               /* mask for file creation */
  93         int     fd_refcnt;              /* reference count */
  94         int     fd_softrefs;            /* softrefs to prevent destruction */
  95
  96         int     fd_knlistsize;          /* size of knlist */
  97         struct  klist *fd_knlist;       /* list of attached knotes */
  98         u_long  fd_knhashmask;          /* size of knhash */
  99         struct  klist *fd_knhash;       /* hash table for attached knotes */
 100         int     fd_holdleaderscount;    /* block fdfree() for shared close() */
 101         int     fd_holdleaderswakeup;   /* fdfree() needs wakeup */
 102         struct spinlock fd_spin;
 103         struct  fdnode  fd_builtin_files[NDFILE];
 104 };
 105
 106 /*
 107  * Structure to keep track of (process leader, struct fildedesc) tuples.
 108  * Each process has a pointer to such a structure when detailed tracking
 109  * is needed. e.g. when rfork(RFPROC | RFMEM) causes a file descriptor
 110  * table to be shared by processes having different "p_leader" pointers
 111  * and thus distinct POSIX style locks.
 112  */
 113 struct filedesc_to_leader {
 114         int             fdl_refcount;   /* references from struct proc */
 115         int             fdl_holdcount;  /* temporary hold during closef */
 116         int             fdl_wakeup;     /* fdfree() waits on closef() */
 117         struct proc     *fdl_leader;    /* owner of POSIX locks */
 118         /* Circular list */
 119         struct filedesc_to_leader *fdl_prev;
 120         struct filedesc_to_leader *fdl_next;
 121 };
 122
 123 /*
 124  * Per-process open flags.
 125  */
 126 #define UF_EXCLOSE      0x01            /* auto-close on exec */
 127
 128 /*
 129  * This structure that holds the information needed to send a SIGIO or
 130  * a SIGURG signal to a process or process group when new data arrives
 131  * on a device or socket.  The structure is placed on an SLIST belonging
 132  * to the proc or pgrp so that the entire list may be revoked when the
 133  * process exits or the process group disappears.
 134  */
 135 struct  sigio {
 136         union {
 137                 struct  proc *siu_proc; /* process to receive SIGIO/SIGURG */
 138                 struct  pgrp *siu_pgrp; /* process group to receive ... */
 139         } sio_u;
 140         SLIST_ENTRY(sigio) sio_pgsigio; /* sigio's for process or group */
 141         struct  sigio **sio_myref;      /* location of the pointer that holds
 142                                          * the reference to this structure */
 143         struct  ucred *sio_ucred;       /* current credentials */
 144         uid_t   sio_ruid;               /* real user id */
 145         pid_t   sio_pgid;               /* pgid for signals */
 146 };
 147 #define sio_proc        sio_u.siu_proc
 148 #define sio_pgrp        sio_u.siu_pgrp
 149
 150 SLIST_HEAD(sigiolst, sigio);
 151
 152 #ifdef _KERNEL
 153
 154 struct thread;
 155 struct proc;
 156
 157 /*
 158  * Kernel global variables and routines.
 159  */
 160 int     dupfdopen (struct proc *, int, int, int, int);
 161 int     fdalloc (struct proc *p, int want, int *result);
 162 int     fdavail (struct proc *p, int n);
 163 int     falloc (struct proc *p, struct file **resultfp, int *resultfd);
 164 void    fsetfd (struct proc *p, struct file *fp, int fd);
 165 int     fgetfdflags(struct filedesc *fdp, int fd, int *flagsp);
 166 int     fsetfdflags(struct filedesc *fdp, int fd, int add_flags);
 167 int     fclrfdflags(struct filedesc *fdp, int fd, int rem_flags);
 168 void    fsetcred (struct file *fp, struct ucred *cr);
 169 void    fdinit_bootstrap(struct proc *p0, struct filedesc *fdp0, int cmask);
 170 struct  filedesc *fdinit (struct proc *p);
 171 struct  filedesc *fdshare (struct proc *p);
 172 struct  filedesc *fdcopy (struct proc *p);
 173 void    fdfree (struct proc *p, struct filedesc *repl);
 174 int     fdrevoke(void *f_data, short f_type, struct ucred *cred);
 175 int     closef (struct file *fp, struct proc *p);
 176 void    fdcloseexec (struct proc *p);
 177 int     fdcheckstd (struct proc *p);
 178 struct  file *holdfp (struct filedesc *fdp, int fd, int flag);
 179 int     holdsock (struct filedesc *fdp, int fdes, struct file **fpp);
 180 int     holdvnode (struct filedesc *fdp, int fd, struct file **fpp);
 181 int     fdissequential (struct file *);
 182 void    fdsequential (struct file *, int);
 183 pid_t   fgetown (struct sigio *);
 184 int     fsetown (pid_t, struct sigio **);
 185 void    funsetown (struct sigio *);
 186 void    funsetownlst (struct sigiolst *);
 187 void    setugidsafety (struct proc *p);
 188 void    allfiles_scan_exclusive(int (*callback)(struct file *, void *), void *data);
 189
 190 struct filedesc_to_leader *
 191 filedesc_to_leader_alloc(struct filedesc_to_leader *old,
 192                          struct proc *leader);
 193
 194 #endif
 195
 196 #endif