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$
  35  */
  36
  37 #ifndef _SYS_FILEDESC_H_
  38 #define _SYS_FILEDESC_H_
  39
  40 #include <sys/queue.h>
  41
  42 /*
  43  * This structure is used for the management of descriptors.  It may be
  44  * shared by multiple processes.
  45  *
  46  * A process is initially started out with NDFILE descriptors stored within
  47  * this structure, selected to be enough for typical applications based on
  48  * the historical limit of 20 open files (and the usage of descriptors by
  49  * shells).  If these descriptors are exhausted, a larger descriptor table
  50  * may be allocated, up to a process' resource limit; the internal arrays
  51  * are then unused.  The initial expansion is set to NDEXTENT; each time
  52  * it runs out, it is doubled until the resource limit is reached. NDEXTENT
  53  * should be selected to be the biggest multiple of OFILESIZE (see below)
  54  * that will fit in a power-of-two sized piece of memory.
  55  */
  56 #define NDFILE          20
  57 #define NDEXTENT        50              /* 250 bytes in 256-byte alloc. */
  58
  59 struct filedesc {
  60         struct  file **fd_ofiles;       /* file structures for open files */
  61         char    *fd_ofileflags;         /* per-process open file flags */
  62         struct  vnode *fd_cdir;         /* current directory */
  63         struct  vnode *fd_rdir;         /* root directory */
  64         struct  vnode *fd_jdir;         /* jail root directory */
  65         int     fd_nfiles;              /* number of open files allocated */
  66         u_short fd_lastfile;            /* high-water mark of fd_ofiles */
  67         u_short fd_freefile;            /* approx. next free file */
  68         u_short fd_cmask;               /* mask for file creation */
  69         u_short fd_refcnt;              /* reference count */
  70
  71         int     fd_knlistsize;          /* size of knlist */
  72         struct  klist *fd_knlist;       /* list of attached knotes */
  73         u_long  fd_knhashmask;          /* size of knhash */
  74         struct  klist *fd_knhash;       /* hash table for attached knotes */
  75 };
  76
  77 /*
  78  * Basic allocation of descriptors:
  79  * one of the above, plus arrays for NDFILE descriptors.
  80  */
  81 struct filedesc0 {
  82         struct  filedesc fd_fd;
  83         /*
  84          * These arrays are used when the number of open files is
  85          * <= NDFILE, and are then pointed to by the pointers above.
  86          */
  87         struct  file *fd_dfiles[NDFILE];
  88         char    fd_dfileflags[NDFILE];
  89 };
  90
  91 /*
  92  * Per-process open flags.
  93  */
  94 #define UF_EXCLOSE      0x01            /* auto-close on exec */
  95 #if 0
  96 #define UF_MAPPED       0x02            /* mapped from device */
  97 #endif
  98
  99 /*
 100  * Storage required per open file descriptor.
 101  */
 102 #define OFILESIZE (sizeof(struct file *) + sizeof(char))
 103
 104 /*
 105  * This structure holds the information needed to send a SIGIO or
 106  * a SIGURG signal to a process or process group when new data arrives
 107  * on a device or socket.  The structure is placed on an SLIST belonging
 108  * to the proc or pgrp so that the entire list may be revoked when the
 109  * process exits or the process group disappears.
 110  */
 111 struct  sigio {
 112         union {
 113                 struct  proc *siu_proc; /* process to receive SIGIO/SIGURG */
 114                 struct  pgrp *siu_pgrp; /* process group to receive ... */
 115         } sio_u;
 116         SLIST_ENTRY(sigio) sio_pgsigio; /* sigio's for process or group */
 117         struct  sigio **sio_myref;      /* location of the pointer that holds
 118                                          * the reference to this structure */
 119         struct  ucred *sio_ucred;       /* current credentials */
 120         pid_t   sio_pgid;               /* pgid for signals */
 121 };
 122 #define sio_proc        sio_u.siu_proc
 123 #define sio_pgrp        sio_u.siu_pgrp
 124
 125 SLIST_HEAD(sigiolst, sigio);
 126
 127 #ifdef _KERNEL
 128 int     closef __P((struct file *fp, struct proc *p));
 129 int     dupfdopen __P((struct proc *p, struct filedesc *fdp, int indx, int dfd, int mode,
 130                        int error));
 131 int     falloc __P((struct proc *p, struct file **resultfp, int *resultfd));
 132 int     fdalloc __P((struct proc *p, int want, int *result));
 133 int     fdavail __P((struct proc *p, int n));
 134 void    fdcloseexec __P((struct proc *p));
 135 struct  filedesc *fdcopy __P((struct proc *p));
 136 void    fdfree __P((struct proc *p));
 137 struct  filedesc *fdinit __P((struct proc *p));
 138 struct  filedesc *fdshare __P((struct proc *p));
 139 void    ffree __P((struct file *fp));
 140 pid_t   fgetown __P((struct sigio *sigio));
 141 int     fsetown __P((pid_t pgid, struct sigio **sigiop));
 142 void    funsetown __P((struct sigio *sigio));
 143 void    funsetownlst __P((struct sigiolst *sigiolst));
 144 struct  file *holdfp __P((struct filedesc *fdp, int fd, int flag));
 145 int     getvnode __P((struct filedesc *fdp, int fd, struct file **fpp));
 146 void    setugidsafety __P((struct proc *p));
 147
 148 #endif /* _KERNEL */
 149
 150 #endif /* !_SYS_FILEDESC_H_ */