xnu-4903.270.47.tar.gz

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

diff --git a/bsd/sys/file_internal.h b/bsd/sys/file_internal.h
index 0b9ed96b2957dc21313f13c72be7b0209b8ba6b0..fbd615cbde0be546c38581c13b8a0f3132c5c17a 100644 (file)
--- a/bsd/sys/file_internal.h
+++ b/bsd/sys/file_internal.h
@@ -2,7 +2,7 @@
  * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_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


@@ -11,10 +11,10 @@
  * 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.
  * 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.
  * 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,


@@ -22,7 +22,7 @@
  * 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_OSREFERENCE_LICENSE_HEADER_END@
  */
 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */


@@ -62,7 +62,7 @@
  */
 
 #ifndef _SYS_FILE_INTERNAL_H_
  */
 
 #ifndef _SYS_FILE_INTERNAL_H_

-#define        _SYS_FILE_INTERNAL_H_
+#define _SYS_FILE_INTERNAL_H_

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


@@ -100,97 +100,97 @@ struct fileproc {
 
 #define FILEPROC_NULL (struct fileproc *)0
 
 
 #define FILEPROC_NULL (struct fileproc *)0
 

-#define FP_INCREATE    0x0001
-#define FP_INCLOSE     0x0002
-#define FP_INSELECT    0x0004
-#define FP_UNUSED      0x0008  /* unused (was FP_INCHRREAD) */
-#define FP_WRITTEN     0x0010
-#define FP_CLOSING     0x0020
-#define FP_WAITCLOSE   0x0040
-#define FP_AIOISSUED   0x0080
-#define FP_WAITEVENT   0x0100
-#define FP_SELCONFLICT 0x0200  /* select conflict on an individual fp */
+#define FP_INCREATE     0x0001
+#define FP_INCLOSE      0x0002
+#define FP_INSELECT     0x0004
+#define FP_UNUSED       0x0008  /* unused (was FP_INCHRREAD) */
+#define FP_WRITTEN      0x0010
+#define FP_CLOSING      0x0020
+#define FP_WAITCLOSE    0x0040
+#define FP_AIOISSUED    0x0080
+#define FP_WAITEVENT    0x0100
+#define FP_SELCONFLICT  0x0200  /* select conflict on an individual fp */

 
 /* squeeze a "type" value into the upper flag bits */
 
 
 /* squeeze a "type" value into the upper flag bits */
 

-#define        _FP_TYPESHIFT   24
-#define        FP_TYPEMASK     (0x7 << _FP_TYPESHIFT)  /* 8 "types" of fileproc */
+#define _FP_TYPESHIFT   24
+#define FP_TYPEMASK     (0x7 << _FP_TYPESHIFT)  /* 8 "types" of fileproc */

 
 

-#define        FILEPROC_TYPE(fp)       ((fp)->f_flags & FP_TYPEMASK)
+#define FILEPROC_TYPE(fp)       ((fp)->f_flags & FP_TYPEMASK)

 
 #define FP_ISGUARDED(fp, attribs)  \
                ((FILEPROC_TYPE(fp) == FTYPE_GUARDED) ? fp_isguarded(fp, attribs) : 0)
 
 typedef enum {
 
 #define FP_ISGUARDED(fp, attribs)  \
                ((FILEPROC_TYPE(fp) == FTYPE_GUARDED) ? fp_isguarded(fp, attribs) : 0)
 
 typedef enum {

-       FTYPE_SIMPLE    = 0,
-       FTYPE_GUARDED   = (1 << _FP_TYPESHIFT)
+       FTYPE_SIMPLE    = 0,
+       FTYPE_GUARDED   = (1 << _FP_TYPESHIFT)

 } fileproc_type_t;
 
 } fileproc_type_t;
 

-#define FP_VALID_FLAGS (FP_INCREATE | FP_INCLOSE | FP_INSELECT |\
-               FP_WRITTEN | FP_CLOSING | FP_WAITCLOSE |\
-               FP_AIOISSUED | FP_WAITEVENT | FP_SELCONFLICT | _FP_TYPEMASK)
+#define FP_VALID_FLAGS  (FP_INCREATE | FP_INCLOSE | FP_INSELECT |\
+               FP_WRITTEN | FP_CLOSING | FP_WAITCLOSE |\
+               FP_AIOISSUED | FP_WAITEVENT | FP_SELCONFLICT | _FP_TYPEMASK)

 
 #ifndef _KAUTH_CRED_T
 
 #ifndef _KAUTH_CRED_T

-#define        _KAUTH_CRED_T
+#define _KAUTH_CRED_T

 struct ucred;
 typedef struct ucred *kauth_cred_t;
 struct posix_cred;
 typedef struct posix_cred *posix_cred_t;
 struct ucred;
 typedef struct ucred *kauth_cred_t;
 struct posix_cred;
 typedef struct posix_cred *posix_cred_t;

-#endif /* !_KAUTH_CRED_T */
+#endif  /* !_KAUTH_CRED_T */

 
 /* file types */
 typedef enum {
 
 /* file types */
 typedef enum {

-       DTYPE_VNODE     = 1,    /* file */
-       DTYPE_SOCKET,           /* communications endpoint */
-       DTYPE_PSXSHM,           /* POSIX Shared memory */
-       DTYPE_PSXSEM,           /* POSIX Semaphores */
-       DTYPE_KQUEUE,           /* kqueue */
-       DTYPE_PIPE,             /* pipe */
-       DTYPE_FSEVENTS,         /* fsevents */
-       DTYPE_ATALK,            /* (obsolete) */
-       DTYPE_NETPOLICY,        /* networking policy */
+       DTYPE_VNODE     = 1,    /* file */
+       DTYPE_SOCKET,           /* communications endpoint */
+       DTYPE_PSXSHM,           /* POSIX Shared memory */
+       DTYPE_PSXSEM,           /* POSIX Semaphores */
+       DTYPE_KQUEUE,           /* kqueue */
+       DTYPE_PIPE,             /* pipe */
+       DTYPE_FSEVENTS,         /* fsevents */
+       DTYPE_ATALK,            /* (obsolete) */
+       DTYPE_NETPOLICY,        /* networking policy */

 } file_type_t;
 
 /* defines for fg_lflags */
 } file_type_t;
 
 /* defines for fg_lflags */

-#define FG_TERM        0x01    /* the fileglob is terminating .. */
-#define FG_INSMSGQ     0x02    /* insert to msgqueue pending .. */
-#define FG_WINSMSGQ    0x04    /* wait for the fielglob is in msgque */
-#define FG_RMMSGQ      0x08    /* the fileglob is being removed from msgqueue */
-#define FG_WRMMSGQ     0x10    /* wait for the fileglob to  be removed from msgqueue */
-#define FG_PORTMADE    0x20    /* a port was at some point created for this fileglob */
-#define FG_NOSIGPIPE   0x40    /* don't deliver SIGPIPE with EPIPE return */
-#define FG_OFF_LOCKED  0x80    /* Used as a mutex for offset changes (for vnodes) */
-#define FG_OFF_LOCKWANT 0x100  /* Somebody's wating for the lock */
-#define FG_CONFINED    0x200   /* fileglob confined to process, immutably */
-#define FG_HAS_OFDLOCK 0x400   /* Has or has had an OFD lock */
+#define FG_TERM         0x01    /* the fileglob is terminating .. */
+#define FG_INSMSGQ      0x02    /* insert to msgqueue pending .. */
+#define FG_WINSMSGQ     0x04    /* wait for the fielglob is in msgque */
+#define FG_RMMSGQ       0x08    /* the fileglob is being removed from msgqueue */
+#define FG_WRMMSGQ      0x10    /* wait for the fileglob to  be removed from msgqueue */
+#define FG_PORTMADE     0x20    /* a port was at some point created for this fileglob */
+#define FG_NOSIGPIPE    0x40    /* don't deliver SIGPIPE with EPIPE return */
+#define FG_OFF_LOCKED   0x80    /* Used as a mutex for offset changes (for vnodes) */
+#define FG_OFF_LOCKWANT 0x100   /* Somebody's wating for the lock */
+#define FG_CONFINED     0x200   /* fileglob confined to process, immutably */
+#define FG_HAS_OFDLOCK  0x400   /* Has or has had an OFD lock */

 
 struct fileglob {
        LIST_ENTRY(fileglob) f_msglist;/* list of active files */
 
 struct fileglob {
        LIST_ENTRY(fileglob) f_msglist;/* list of active files */

-       int32_t fg_flag;                /* see fcntl.h */
-       int32_t fg_count;       /* reference count */
-       int32_t fg_msgcount;    /* references from message queue */
-       int32_t fg_lflags;      /* file global flags */
-       kauth_cred_t fg_cred;   /* credentials associated with descriptor */
+       int32_t fg_flag;                /* see fcntl.h */
+       int32_t fg_count;       /* reference count */
+       int32_t fg_msgcount;    /* references from message queue */
+       int32_t fg_lflags;      /* file global flags */
+       kauth_cred_t fg_cred;   /* credentials associated with descriptor */

        const struct fileops {
        const struct fileops {

-               file_type_t     fo_type;        /* descriptor type */
-               int     (*fo_read)      (struct fileproc *fp, struct uio *uio,
-                                        int flags, vfs_context_t ctx);
-               int     (*fo_write)     (struct fileproc *fp, struct uio *uio,
-                                        int flags, vfs_context_t ctx);
-#define        FOF_OFFSET      0x00000001      /* offset supplied to vn_write */
-#define FOF_PCRED      0x00000002      /* cred from proc, not current thread */
-               int     (*fo_ioctl)     (struct fileproc *fp, u_long com,
-                                        caddr_t data, vfs_context_t ctx);
-               int     (*fo_select)    (struct fileproc *fp, int which,
-                                        void *wql, vfs_context_t ctx);
-               int     (*fo_close)     (struct fileglob *fg, vfs_context_t ctx);
-               int     (*fo_kqfilter)  (struct fileproc *fp, struct knote *kn,
-                                        struct kevent_internal_s *kev, vfs_context_t ctx);
-               int     (*fo_drain)     (struct fileproc *fp, vfs_context_t ctx);
+               file_type_t     fo_type;        /* descriptor type */
+               int     (*fo_read)      (struct fileproc *fp, struct uio *uio,
+                   int flags, vfs_context_t ctx);
+               int     (*fo_write)     (struct fileproc *fp, struct uio *uio,
+                   int flags, vfs_context_t ctx);
+#define FOF_OFFSET      0x00000001      /* offset supplied to vn_write */
+#define FOF_PCRED       0x00000002      /* cred from proc, not current thread */
+               int     (*fo_ioctl)(struct fileproc *fp, u_long com,
+                   caddr_t data, vfs_context_t ctx);
+               int     (*fo_select)    (struct fileproc *fp, int which,
+                   void *wql, vfs_context_t ctx);
+               int     (*fo_close)     (struct fileglob *fg, vfs_context_t ctx);
+               int     (*fo_kqfilter)  (struct fileproc *fp, struct knote *kn,
+                   struct kevent_internal_s *kev, vfs_context_t ctx);
+               int     (*fo_drain)     (struct fileproc *fp, vfs_context_t ctx);

        } *fg_ops;
        } *fg_ops;

-       off_t   fg_offset;
-       void    *fg_data;       /* vnode or socket or SHM or semaphore */
-       void    *fg_vn_data;    /* Per fd vnode data, used for directories */
+       off_t   fg_offset;
+       void    *fg_data;       /* vnode or socket or SHM or semaphore */
+       void    *fg_vn_data;    /* Per fd vnode data, used for directories */

        lck_mtx_t fg_lock;
 #if CONFIG_MACF
        struct label *fg_label;  /* JMM - use the one in the cred? */
        lck_mtx_t fg_lock;
 #if CONFIG_MACF
        struct label *fg_label;  /* JMM - use the one in the cred? */


@@ -199,24 +199,24 @@ struct fileglob {
 
 #ifdef __APPLE_API_PRIVATE
 LIST_HEAD(fmsglist, fileglob);
 
 #ifdef __APPLE_API_PRIVATE
 LIST_HEAD(fmsglist, fileglob);

-extern struct fmsglist fmsghead;       /* head of list of open files */
-extern int maxfiles;                   /* kernel limit on number of open files */
-extern int nfiles;                     /* actual number of open files */
+extern struct fmsglist fmsghead;        /* head of list of open files */
+extern int maxfiles;                    /* kernel limit on number of open files */
+extern int nfiles;                      /* actual number of open files */

 extern int maxfilesperproc;
 
 extern int maxfilesperproc;
 

-#define        FILEGLOB_DTYPE(fg)              ((const file_type_t)((fg)->fg_ops->fo_type))
+#define FILEGLOB_DTYPE(fg)              ((const file_type_t)((fg)->fg_ops->fo_type))

 #endif /* __APPLE_API_PRIVATE */
 
 
 __BEGIN_DECLS
 int fo_read(struct fileproc *fp, struct uio *uio, int flags, vfs_context_t ctx);
 int fo_write(struct fileproc *fp, struct uio *uio, int flags,
 #endif /* __APPLE_API_PRIVATE */
 
 
 __BEGIN_DECLS
 int fo_read(struct fileproc *fp, struct uio *uio, int flags, vfs_context_t ctx);
 int fo_write(struct fileproc *fp, struct uio *uio, int flags,

-               vfs_context_t ctx);
+    vfs_context_t ctx);

 int fo_ioctl(struct fileproc *fp, u_long com, caddr_t data, vfs_context_t ctx);
 int fo_select(struct fileproc *fp, int which, void *wql, vfs_context_t ctx);
 int fo_close(struct fileglob *fg, vfs_context_t ctx);
 int fo_kqfilter(struct fileproc *fp, struct knote *kn,
 int fo_ioctl(struct fileproc *fp, u_long com, caddr_t data, vfs_context_t ctx);
 int fo_select(struct fileproc *fp, int which, void *wql, vfs_context_t ctx);
 int fo_close(struct fileglob *fg, vfs_context_t ctx);
 int fo_kqfilter(struct fileproc *fp, struct knote *kn,

-               struct kevent_internal_s *kev, vfs_context_t ctx);
+    struct kevent_internal_s *kev, vfs_context_t ctx);

 void fileproc_drain(proc_t, struct fileproc *);
 int fp_tryswap(proc_t, int fd, struct fileproc *nfp);
 int fp_drop(struct proc *p, int fd, struct fileproc *fp, int locked);
 void fileproc_drain(proc_t, struct fileproc *);
 int fp_tryswap(proc_t, int fd, struct fileproc *nfp);
 int fp_drop(struct proc *p, int fd, struct fileproc *fp, int locked);