xnu-4570.31.3.tar.gz

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

diff --git a/bsd/sys/filedesc.h b/bsd/sys/filedesc.h
index 2353a06e2701dcef9ac8e277779e1202dc8119dc..b79440b48e2066626b3293c53bf03104c42b104d 100644 (file)
--- a/bsd/sys/filedesc.h
+++ b/bsd/sys/filedesc.h
@@ -1,23 +1,29 @@
 /*
 /*

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

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * 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. 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.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE 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 */
 /*


@@ -60,7 +66,6 @@
 
 #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.


@@ -78,24 +83,57 @@
 #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 kqlist;
+

 struct filedesc {
 struct filedesc {

-       struct  file **fd_ofiles;       /* file structures for open files */
+       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 */
        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 */
+       int     fd_lastfile;            /* high-water mark of fd_ofiles */
+       int     fd_freefile;            /* approx. next free file */

        u_short fd_cmask;               /* mask for file creation */
        u_short fd_cmask;               /* mask for file creation */

-       u_short fd_refcnt;              /* reference count */
+        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 */
+       lck_mtx_t fd_knhashlock;        /* lock for hash table for attached knotes */

 };
 
 };
 

+/*
+ * definitions for fd_flags;
+ */
+#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 */
+

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

-#define        UF_EXCLOSE      0x01            /* auto-close on exec */
-#define        UF_MAPPED       0x02            /* mapped from device */
+#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_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.


@@ -106,28 +144,40 @@ struct filedesc {
 /*
  * Kernel global variables and routines.
  */
 /*
  * Kernel global variables and routines.
  */

-extern int     dupfdopen __P((struct filedesc *fdp,
-                               int indx, int dfd, int mode, int error));
-extern int     fdalloc __P((struct proc *p, int want, int *result));
-extern void    fdrelse __P((struct proc *p, int fd));
-extern int     fdavail __P((struct proc *p, int n));
-extern int     fdgetf __P((struct proc *p, int fd, struct file **resultfp));
+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)])
 #define                fdfile(p, fd)                                   \
                        (&(p)->p_fd->fd_ofiles[(fd)])
 #define                fdflags(p, fd)                                  \
                        (&(p)->p_fd->fd_ofileflags[(fd)])

-extern int     falloc __P((struct proc *p,
-                               struct file **resultfp, int *resultfd));
-extern void    ffree __P((struct file *fp));
+
+/*
+ * 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 __P((struct proc *p));
-extern void    fdfree __P((struct proc *p));
-extern void    fdexec __P((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_ */