xnu-4903.270.47.tar.gz

[apple/xnu.git] / bsd / sys / filedesc.h

diff --git a/bsd/sys/filedesc.h b/bsd/sys/filedesc.h
index 5b0b65ef05087cf5dc668c708724857fccd058a6..80d91f2e4ed6fe7e49e015418c44c71d55353a3c 100644 (file)
--- a/bsd/sys/filedesc.h
+++ b/bsd/sys/filedesc.h
@@ -1,15 +1,20 @@
 /*
 /*

- * Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2012 Apple Computer, Inc. All rights reserved.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  *
  *

- * @APPLE_LICENSE_HEADER_START@
- * 

  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in

- * compliance with the License. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
- * 
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *

  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,


@@ -17,8 +22,8 @@
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.

- * 
- * @APPLE_LICENSE_HEADER_END@
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
 /*
  */
 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
 /*


@@ -57,11 +62,10 @@
  */
 
 #ifndef _SYS_FILEDESC_H_
  */
 
 #ifndef _SYS_FILEDESC_H_

-#define        _SYS_FILEDESC_H_
+#define _SYS_FILEDESC_H_

 
 #include <sys/appleapiopts.h>
 
 
 #include <sys/appleapiopts.h>
 

-#ifdef __APPLE_API_UNSTABLE

 /*
  * This structure is used for the management of descriptors.  It may be
  * shared by multiple processes.
 /*
  * This structure is used for the management of descriptors.  It may be
  * shared by multiple processes.


@@ -76,42 +80,63 @@
  * should be selected to be the biggest multiple of OFILESIZE (see below)
  * that will fit in a power-of-two sized piece of memory.
  */
  * should be selected to be the biggest multiple of OFILESIZE (see below)
  * that will fit in a power-of-two sized piece of memory.
  */

-#define NDFILE         25              /* 125 bytes */
-#define NDEXTENT       50              /* 250 bytes in 256-byte alloc. */ 
+#define NDFILE          25              /* 125 bytes */
+#define NDEXTENT        50              /* 250 bytes in 256-byte alloc. */
+
+#ifdef BSD_KERNEL_PRIVATE
+
+#include <kern/locks.h>

 
 struct klist;
 
 struct klist;

+struct kqlist;

 
 struct filedesc {
 
 struct filedesc {

-       struct  fileproc **fd_ofiles;   /* file structures for open files */
-       char    *fd_ofileflags;         /* per-process open file flags */
-       struct  vnode *fd_cdir;         /* current directory */
-       struct  vnode *fd_rdir;         /* root directory */
-       int     fd_nfiles;              /* number of open files allocated */
-       u_short fd_lastfile;            /* high-water mark of fd_ofiles */
-       u_short fd_freefile;            /* approx. next free file */
-       u_short fd_cmask;               /* mask for file creation */
-       u_short fd_refcnt;              /* reference count */
-
+       struct  fileproc **fd_ofiles;   /* file structures for open files */
+       lck_mtx_t fd_kqhashlock;        /* lock for dynamic kqueue hash */
+       u_long  fd_kqhashmask;          /* size of dynamic kqueue hash */
+       struct  kqlist *fd_kqhash;      /* hash table for dynamic kqueues */
+       struct  kqueue *fd_wqkqueue;    /* the workq kqueue */
+       char    *fd_ofileflags;         /* per-process open file flags */
+       struct  vnode *fd_cdir;         /* current directory */
+       struct  vnode *fd_rdir;         /* root directory */
+       int     fd_nfiles;              /* number of open files allocated */
+       int     fd_lastfile;            /* high-water mark of fd_ofiles */
+       int     fd_freefile;            /* approx. next free file */
+       u_short fd_cmask;               /* mask for file creation */
+       int     fd_flags;

        int     fd_knlistsize;          /* size of knlist */
        struct  klist *fd_knlist;       /* list of attached knotes */
        u_long  fd_knhashmask;          /* size of knhash */
        struct  klist *fd_knhash;       /* hash table for attached knotes */
        int     fd_knlistsize;          /* size of knlist */
        struct  klist *fd_knlist;       /* list of attached knotes */
        u_long  fd_knhashmask;          /* size of knhash */
        struct  klist *fd_knhash;       /* hash table for attached knotes */

-        int    fd_flags;
+       lck_mtx_t fd_knhashlock;        /* lock for hash table for attached knotes */

 };
 
 /*
  * definitions for fd_flags;
  */
 };
 
 /*
  * definitions for fd_flags;
  */

-#define        FD_CHROOT       0x01    /* process was chrooted... keep track even */
+#define FD_CHROOT       0x01    /* process was chrooted... keep track even */

                                 /* if we're force unmounted and unable to */
                                 /* take a vnode_ref on fd_rdir during a fork */
 
                                 /* if we're force unmounted and unable to */
                                 /* take a vnode_ref on fd_rdir during a fork */
 

+#define FD_WORKLOOP     0x02    /* process has created a kqworkloop that */
+                                /* requires manual cleanup on exit */
+

 /*
  * Per-process open flags.
  */
 /*
  * Per-process open flags.
  */

-#define        UF_EXCLOSE      0x01            /* auto-close on exec */
-#define UF_RESERVED    0x04            /* open pending / in progress */
-#define UF_CLOSING     0x08            /* close in progress */
+#define UF_EXCLOSE      0x01            /* auto-close on exec */
+#define UF_FORKCLOSE    0x02            /* auto-close on fork */
+#define UF_RESERVED     0x04            /* open pending / in progress */
+#define UF_CLOSING      0x08            /* close in progress */
+
+#ifdef KERNEL
+#define UF_RESVWAIT     0x10            /* close in progress */
+#define UF_INHERIT      0x20            /* "inherit-on-exec" */
+
+#define UF_VALID_FLAGS  \
+       (UF_EXCLOSE | UF_FORKCLOSE | UF_RESERVED | UF_CLOSING |\
+       UF_RESVWAIT | UF_INHERIT)
+#endif /* KERNEL */

 
 /*
  * Storage required per open file descriptor.
 
 /*
  * Storage required per open file descriptor.


@@ -122,27 +147,40 @@ struct filedesc {
 /*
  * Kernel global variables and routines.
  */
 /*
  * Kernel global variables and routines.
  */

-extern int     dupfdopen(struct filedesc *fdp,
-                               int indx, int dfd, int mode, int error);
-extern int     fdalloc(struct proc *p, int want, int *result);
-extern void    fdrelse(struct proc *p, int fd);
-extern int     fdavail(struct proc *p, int n);
-#define                fdfile(p, fd)                                   \
-                       (&(p)->p_fd->fd_ofiles[(fd)])
-#define                fdflags(p, fd)                                  \
-                       (&(p)->p_fd->fd_ofileflags[(fd)])
-extern int     falloc(struct proc *p,
-                               struct fileproc **resultfp, int *resultfd);
-extern void    ffree(struct file *fp);
+extern int      dupfdopen(struct filedesc *fdp,
+    int indx, int dfd, int mode, int error);
+extern int      fdalloc(proc_t p, int want, int *result);
+extern void     fdrelse(proc_t p, int fd);
+extern int      fdavail(proc_t p, int n);
+#define         fdfile(p, fd)                                   \
+                       (&(p)->p_fd->fd_ofiles[(fd)])
+#define         fdflags(p, fd)                                  \
+                       (&(p)->p_fd->fd_ofileflags[(fd)])
+
+/*
+ * Accesor macros for fd flags
+ */
+#define FDFLAGS_GET(p, fd) (*fdflags(p, fd) & (UF_EXCLOSE|UF_FORKCLOSE))
+#define FDFLAGS_SET(p, fd, bits) \
+          (*fdflags(p, fd) |= ((bits) & (UF_EXCLOSE|UF_FORKCLOSE)))
+#define FDFLAGS_CLR(p, fd, bits) \
+          (*fdflags(p, fd) &= ~((bits) & (UF_EXCLOSE|UF_FORKCLOSE)))
+
+extern int      falloc(proc_t p, struct fileproc **resultfp, int *resultfd, vfs_context_t ctx);

 
 #ifdef __APPLE_API_PRIVATE
 
 #ifdef __APPLE_API_PRIVATE

-extern struct  filedesc *fdcopy(struct proc *p);
-extern void    fdfree(struct proc *p);
-extern void    fdexec(struct proc *p);
+typedef struct fileproc *(*fp_allocfn_t)(void *);
+extern int      falloc_withalloc(proc_t p, struct fileproc **resultfp,
+    int *resultfd, vfs_context_t ctx,
+    fp_allocfn_t fp_zalloc, void *crarg);
+
+extern struct   filedesc *fdcopy(proc_t p, struct vnode *uth_cdir);
+extern void     fdfree(proc_t p);
+extern void     fdexec(proc_t p, short flags, int self_exec);

 #endif /* __APPLE_API_PRIVATE */
 
 #endif /* KERNEL */
 
 #endif /* __APPLE_API_PRIVATE */
 
 #endif /* KERNEL */
 

-#endif /* __APPLE_API_UNSTABLE */
+#endif /* BSD_KERNEL_PRIVATE */

 
 #endif /* !_SYS_FILEDESC_H_ */
 
 #endif /* !_SYS_FILEDESC_H_ */