]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/sys/uio_internal.h
xnu-1504.15.3.tar.gz
[apple/xnu.git] / bsd / sys / uio_internal.h
index a2a7cc0f513745d377c190d784ec3034b2751c33..470291cf44177af2f3ce2198f351775937b10417 100644 (file)
@@ -1,23 +1,29 @@
 /*
  * Copyright (c) 2000-2004 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,
- * 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 NeXT Computer, Inc. All Rights Reserved */
 /*
@@ -63,6 +69,7 @@
 #ifdef KERNEL_PRIVATE
 #include <sys/uio.h>
 #include <sys/malloc.h>
+#include <sys/param.h>
 
 /*
  * user / kernel address space type flags.
 #define UIO_USERISPACE64               9       
 #define UIO_PHYS_USERSPACE64   10
 //     UIO_SYSSPACE32                          11      defined in uio.h
-#define UIO_PHYS_SYSSPACE32            12      
-#define UIO_SYSSPACE64                 13      
-#define UIO_PHYS_SYSSPACE64            14      
+//  UIO_PHYS_SYSSPACE32                        12      reserved, never used. Use UIO_PHYS_SYSSPACE
+//  UIO_SYSSPACE64                             13      reserved, never used. Use UIO_SYSSPACE
+//  UIO_PHYS_SYSSPACE64                        14      reserved, never used. Use UIO_PHYS_SYSSPACE
 
 __BEGIN_DECLS
 struct user_iovec;
 
-// uio_iovsaddr was __private_extern__ temporary chnage for 3777436
-struct user_iovec * uio_iovsaddr( uio_t a_uio );
+#ifdef XNU_KERNEL_PRIVATE
+__private_extern__ struct user_iovec * uio_iovsaddr( uio_t a_uio );
 __private_extern__ void uio_calculateresid( uio_t a_uio );
 __private_extern__ void uio_setcurriovlen( uio_t a_uio, user_size_t a_value );
-// uio_spacetype was __private_extern__ temporary chnage for 3777436
-int uio_spacetype( uio_t a_uio );
-__private_extern__ uio_t 
-       uio_createwithbuffer( int a_iovcount, off_t a_offset, int a_spacetype,
-                                                       int a_iodirection, void *a_buf_p, int a_buffer_size );
+__private_extern__ int uio_spacetype( uio_t a_uio );
+__private_extern__ uio_t  uio_createwithbuffer( int a_iovcount, off_t a_offset, int a_spacetype, int a_iodirection, void *a_buf_p, size_t a_buffer_size );
+__private_extern__ int copyin_user_iovec_array(user_addr_t uaddr, int spacetype, int count, struct user_iovec *dst);
+/* reverse of uio_update to "undo" uncommited I/O. This only works in
+ * limited cases */
+__private_extern__ void uio_pushback( uio_t a_uio, user_size_t a_count );
+#endif /* XNU_KERNEL_PRIVATE */
 
 /* use kern_iovec for system space requests */
 struct kern_iovec {
-       u_int32_t       iov_base;       /* Base address. */
-       u_int32_t       iov_len;        /* Length. */
+       u_int64_t       iov_base;       /* Base address. */
+       u_int64_t       iov_len;        /* Length. */
 };
-       
+
 /* use user_iovec for user space requests */
 struct user_iovec {
        user_addr_t     iov_base;       /* Base address. */
        user_size_t     iov_len;        /* Length. */
 };
 
-#if 1 // LP64todo - remove this after kext adopt new KPI
-#define uio_iov uio_iovs.iovp
-#define iovec_32 kern_iovec
-#define iovec_64 user_iovec
-#define iov32p kiovp
-#define iov64p uiovp
-#endif
+/* use user32_iovec/user64_iovec for representing
+ * in-memory structures in 32-64 processes during copyin */
+struct user32_iovec {
+       uint32_t        iov_base;       /* Base address. */
+       uint32_t        iov_len;        /* Length. */
+};
+
+struct user64_iovec {
+       uint64_t        iov_base;       /* Base address. */
+       uint64_t        iov_len;        /* Length. */
+};
 
 union iovecs {
-       struct iovec            *iovp;
        struct kern_iovec       *kiovp;
        struct user_iovec       *uiovp;
 };
@@ -130,10 +142,8 @@ struct uio {
        union iovecs    uio_iovs;               /* current iovec */
        int                             uio_iovcnt;             /* active iovecs */
        off_t                   uio_offset;
-       int                             uio_resid;              /* compatibility uio_resid (pre-LP64) */
        enum uio_seg    uio_segflg;
        enum uio_rw     uio_rw;
-       proc_t                  uio_procp;              /* obsolete - not used! */
        user_ssize_t    uio_resid_64;
        int                             uio_size;               /* size for use with kfree */
        int                             uio_max_iovs;   /* max number of iovecs this uio_t can hold */
@@ -143,6 +153,7 @@ struct uio {
 /* values for uio_flags */
 #define UIO_FLAGS_INITED               0x00000001
 #define UIO_FLAGS_WE_ALLOCED   0x00000002
+#define UIO_FLAGS_IS_COMPRESSED_FILE   0x00000004
 
 __END_DECLS
 
@@ -152,20 +163,8 @@ __END_DECLS
  *  create a stack buffer that can be passed to uio_createwithbuffer.
  */
 #define UIO_SIZEOF( a_iovcount ) \
-       ( sizeof(struct uio) + (sizeof(struct user_iovec) * (a_iovcount)) )
+       ( sizeof(struct uio) + (MAX(sizeof(struct user_iovec), sizeof(struct kern_iovec)) * (a_iovcount)) )
        
-#define UIO_IS_64_BIT_SPACE( a_uio_t )  \
-       ( (a_uio_t)->uio_segflg == UIO_USERSPACE64 || (a_uio_t)->uio_segflg == UIO_USERISPACE64 || \
-         (a_uio_t)->uio_segflg == UIO_PHYS_USERSPACE64  || (a_uio_t)->uio_segflg == UIO_SYSSPACE64 || \
-         (a_uio_t)->uio_segflg == UIO_PHYS_SYSSPACE64 )
-
-#define UIO_IS_32_BIT_SPACE( a_uio_t )  \
-       ( (a_uio_t)->uio_segflg == UIO_USERSPACE || (a_uio_t)->uio_segflg == UIO_USERISPACE || \
-         (a_uio_t)->uio_segflg == UIO_SYSSPACE  || (a_uio_t)->uio_segflg == UIO_PHYS_USERSPACE || \
-         (a_uio_t)->uio_segflg == UIO_USERISPACE32  || (a_uio_t)->uio_segflg == UIO_PHYS_USERSPACE32 || \
-         (a_uio_t)->uio_segflg == UIO_SYSSPACE32  || (a_uio_t)->uio_segflg == UIO_PHYS_SYSSPACE32 || \
-         (a_uio_t)->uio_segflg == UIO_PHYS_SYSSPACE || (a_uio_t)->uio_segflg == UIO_USERSPACE32 )
-
 #define UIO_IS_USER_SPACE32( a_uio_t )  \
        ( (a_uio_t)->uio_segflg == UIO_USERSPACE32 || (a_uio_t)->uio_segflg == UIO_PHYS_USERSPACE32 || \
          (a_uio_t)->uio_segflg == UIO_USERISPACE32 )
@@ -176,270 +175,11 @@ __END_DECLS
        ( UIO_IS_USER_SPACE32((a_uio_t)) || UIO_IS_USER_SPACE64((a_uio_t)) || \
          (a_uio_t)->uio_segflg == UIO_USERSPACE || (a_uio_t)->uio_segflg == UIO_USERISPACE || \
           (a_uio_t)->uio_segflg == UIO_PHYS_USERSPACE )
+#define UIO_IS_SYS_SPACE( a_uio_t )  \
+       ( (a_uio_t)->uio_segflg == UIO_SYSSPACE || (a_uio_t)->uio_segflg == UIO_PHYS_SYSSPACE || \
+         (a_uio_t)->uio_segflg == UIO_SYSSPACE32 )
 
-       
-/*
- * W A R N I N G!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- * anything in this section will be removed.  please move to the uio KPI 
- */
-
-#if 1 // UIO_KPI - WARNING OBSOLETE!!!!   LP64todo - remove these!!!!
-// DO NOT USE THESE
-#define IS_UIO_USER_SPACE32( segflg )  \
-       ( (segflg) == UIO_USERSPACE32 || (segflg) == UIO_PHYS_USERSPACE32 || \
-         (segflg) == UIO_USERISPACE32 )
-#define IS_UIO_USER_SPACE64( segflg )  \
-       ( (segflg) == UIO_USERSPACE64 || (segflg) == UIO_PHYS_USERSPACE64 || \
-         (segflg) == UIO_USERISPACE64 )
-#define IS_UIO_USER_SPACE( segflg )  \
-       ( IS_UIO_USER_SPACE32((segflg)) || IS_UIO_USER_SPACE64((segflg)) || \
-         (segflg) == UIO_USERSPACE || (segflg) == UIO_USERISPACE || \
-          (segflg) == UIO_PHYS_USERSPACE )
-
-#define IS_UIO_SYS_SPACE32( segflg )  \
-       ( (segflg) == UIO_SYSSPACE32 || (segflg) == UIO_PHYS_SYSSPACE32 || \
-         (segflg) == UIO_SYSSPACE || (segflg) == UIO_PHYS_SYSSPACE )
-#define IS_UIO_SYS_SPACE64( segflg )  \
-       ( (segflg) == UIO_SYSSPACE64 || (segflg) == UIO_PHYS_SYSSPACE64 )
-#define IS_UIO_SYS_SPACE( segflg )  \
-       ( IS_UIO_SYS_SPACE32((segflg)) || IS_UIO_SYS_SPACE64((segflg)) )
-
-#define IS_OBSOLETE_UIO_SEGFLG(segflg)  \
-       ( (segflg) == UIO_USERSPACE || (segflg) == UIO_USERISPACE || \
-         (segflg) == UIO_SYSSPACE  || (segflg) == UIO_PHYS_USERSPACE || \
-         (segflg) == UIO_PHYS_SYSSPACE )
-#define IS_VALID_UIO_SEGFLG(segflg)  \
-       ( IS_UIO_USER_SPACE((segflg)) || IS_UIO_SYS_SPACE((segflg)) )
-
-/* accessor routines for uio and embedded iovecs */
-// WARNING all these are OBSOLETE!!!!
-static inline int64_t uio_uio_resid( struct uio *a_uiop );
-static inline void uio_uio_resid_add( struct uio *a_uiop, int64_t a_amount );
-static inline void uio_uio_resid_set( struct uio *a_uiop, int64_t a_value );
-
-static inline void uio_iov_base_add( struct uio *a_uiop, int64_t a_amount );
-static inline void uio_iov_base_add_at( struct uio *a_uiop, int64_t a_amount, int a_index );
-static inline void uio_iov_len_add( struct uio *a_uiop, int64_t a_amount );
-static inline void uio_iov_len_add_at( struct uio *a_uiop, int64_t a_amount, int a_index );
-static inline u_int64_t uio_iov_len( struct uio *a_uiop );
-static inline u_int64_t uio_iov_len_at( struct uio *a_uiop, int a_index );
-static inline u_int64_t uio_iov_base( struct uio *a_uiop );
-static inline u_int64_t uio_iov_base_at( struct uio *a_uiop, int a_index );
-static inline void uio_next_iov( struct uio *a_uiop );
-static inline void uio_iov_len_set( struct uio *a_uiop, u_int64_t a_value );
-static inline void uio_iov_len_set_at( struct uio *a_uiop, u_int64_t a_value, int a_index );
-
-
-static inline int64_t uio_uio_resid( struct uio *a_uiop )
-{
-//#warning obsolete - use uio_resid call
-       return( (int64_t)a_uiop->uio_resid );
-}
-
-static inline void uio_uio_resid_add( struct uio *a_uiop, int64_t a_amount )
-{
-//#warning obsolete - use uio_update or uio_addiov or uio_setresid if in kernel and you must
-       a_uiop->uio_resid += ((int32_t) a_amount);
-}
-
-static inline void uio_uio_resid_set( struct uio *a_uiop, int64_t a_value )
-{
-//#warning obsolete - use uio_update or uio_addiov or uio_setresid if in kernel and you must
-       a_uiop->uio_resid = a_value;
-}
-
-static inline u_int64_t uio_iov_base( struct uio *a_uiop )
-{
-//#warning obsolete - use uio_curriovbase call
-       return(uio_iov_base_at(a_uiop, 0));
-}
-
-static inline u_int64_t uio_iov_base_at( struct uio *a_uiop, int a_index )
-{
-//#warning obsolete - use uio_curriovbase call
-       if (IS_UIO_USER_SPACE32(a_uiop->uio_segflg) || IS_OBSOLETE_UIO_SEGFLG(a_uiop->uio_segflg)) {
-               /* user space iovec was most likely a struct iovec so we must cast to uintptr_t first */
-               return((u_int64_t)((uintptr_t)a_uiop->uio_iovs.iov32p[a_index].iov_base));
-       }
-       if (IS_UIO_SYS_SPACE32(a_uiop->uio_segflg)) {
-               return((u_int64_t)a_uiop->uio_iovs.iov32p[a_index].iov_base);
-       }
-       if (IS_UIO_USER_SPACE64(a_uiop->uio_segflg) || IS_UIO_SYS_SPACE64(a_uiop->uio_segflg)) {
-               return(a_uiop->uio_iovs.iov64p[a_index].iov_base);
-       }
-       return(0);
-}
-
-static inline u_int64_t uio_iov_len( struct uio *a_uiop )
-{
-//#warning obsolete - use uio_curriovlen call
-       return(uio_iov_len_at(a_uiop, 0));
-}
-
-static inline u_int64_t uio_iov_len_at( struct uio *a_uiop, int a_index )
-{
-//#warning obsolete - use uio_curriovlen call
-       if (IS_UIO_USER_SPACE32(a_uiop->uio_segflg) || 
-               IS_UIO_SYS_SPACE32(a_uiop->uio_segflg)  ||
-               IS_OBSOLETE_UIO_SEGFLG(a_uiop->uio_segflg)) {
-               return((u_int64_t)a_uiop->uio_iovs.iov32p[a_index].iov_len);
-       }
-       if (IS_UIO_USER_SPACE64(a_uiop->uio_segflg) || IS_UIO_SYS_SPACE64(a_uiop->uio_segflg)) {
-               return(a_uiop->uio_iovs.iov64p[a_index].iov_len);
-       }
-       return(0);
-}
-
-static inline void uio_iov_len_set_at( struct uio *a_uiop, u_int64_t a_value, int a_index )
-{
-//#warning obsolete - use uio_addiov call
-       if (IS_UIO_USER_SPACE32(a_uiop->uio_segflg) || 
-               IS_UIO_SYS_SPACE32(a_uiop->uio_segflg)  ||
-               IS_OBSOLETE_UIO_SEGFLG(a_uiop->uio_segflg)) {
-               a_uiop->uio_iovs.iov32p[a_index].iov_len = a_value;
-       }
-       else if (IS_UIO_USER_SPACE64(a_uiop->uio_segflg) || IS_UIO_SYS_SPACE64(a_uiop->uio_segflg)) {
-               a_uiop->uio_iovs.iov64p[a_index].iov_len = a_value;
-       }
-       return;
-}
-
-static inline void uio_iov_len_set( struct uio *a_uiop, u_int64_t a_value )
-{
-//#warning obsolete - use uio_addiov call
-       return(uio_iov_len_set_at(a_uiop, a_value, 0));
-}
-
-static inline void uio_iov_len_add_at( struct uio *a_uiop, int64_t a_amount, int a_index )
-{
-//#warning obsolete - use uio_addiov call
-       if (IS_UIO_USER_SPACE32(a_uiop->uio_segflg) || 
-               IS_UIO_SYS_SPACE32(a_uiop->uio_segflg)  ||
-               IS_OBSOLETE_UIO_SEGFLG(a_uiop->uio_segflg)) {
-               a_uiop->uio_iovs.iov32p[a_index].iov_len += ((int32_t) a_amount);
-       }
-       else if (IS_UIO_USER_SPACE64(a_uiop->uio_segflg) || IS_UIO_SYS_SPACE64(a_uiop->uio_segflg)) {
-               a_uiop->uio_iovs.iov64p[a_index].iov_len += a_amount;
-       }
-       return;
-}
-
-static inline void uio_iov_len_add( struct uio *a_uiop, int64_t a_amount )
-{
-//#warning obsolete - use uio_addiov call
-       return(uio_iov_len_add_at(a_uiop, a_amount, 0));
-}
-
-static inline void uio_iov_base_add_at( struct uio *a_uiop, int64_t a_amount, int a_index )
-{
-//#warning obsolete - use uio_addiov call
-       if (IS_UIO_USER_SPACE32(a_uiop->uio_segflg) || 
-               IS_UIO_SYS_SPACE32(a_uiop->uio_segflg)  ||
-               IS_OBSOLETE_UIO_SEGFLG(a_uiop->uio_segflg)) {
-               a_uiop->uio_iovs.iov32p[a_index].iov_base += ((int32_t) a_amount);
-       }
-       else if (IS_UIO_USER_SPACE64(a_uiop->uio_segflg) || IS_UIO_SYS_SPACE64(a_uiop->uio_segflg)) {
-               a_uiop->uio_iovs.iov64p[a_index].iov_base += a_amount;
-       }
-       return;
-}
-
-static inline void uio_iov_base_add( struct uio *a_uiop, int64_t a_amount )
-{
-//#warning obsolete - use uio_addiov call
-       return(uio_iov_base_add_at(a_uiop, a_amount, 0));
-}
-
-static inline void uio_next_iov( struct uio *a_uiop )
-{
-//#warning obsolete - use uio_update call
-       if (IS_UIO_USER_SPACE32(a_uiop->uio_segflg) || 
-               IS_UIO_SYS_SPACE32(a_uiop->uio_segflg)  ||
-               IS_OBSOLETE_UIO_SEGFLG(a_uiop->uio_segflg)) {
-               a_uiop->uio_iovs.iov32p++;
-       }
-       else if (IS_UIO_USER_SPACE64(a_uiop->uio_segflg) || IS_UIO_SYS_SPACE64(a_uiop->uio_segflg)) {
-               a_uiop->uio_iovs.iov64p++;
-       }
-       return;
-}
-       
-/*
- * WARNING - this routine relies on iovec_64 being larger than iovec_32 and will
- * not work if you are going to initialize an array of iovec_64 as an array of 
- * iovec_32 then pass that array in a uio (since uio_iov is always expected to
- * be an array of like sized iovecs - see how uio_next_iov gets to the next iovec)
- */
-static inline void init_iovec( u_int64_t a_base, 
-                                                          u_int64_t a_len, 
-                                                          struct iovec_64 *a_iovp, 
-                                                          int is_64bit_process )
-{
-//#warning obsolete - use uio_create call
-       if (is_64bit_process) {
-               a_iovp->iov_base = a_base;
-               a_iovp->iov_len = a_len;
-       }
-       else {
-               struct iovec_32 *a_iov32p = (struct iovec_32 *) a_iovp;
-               a_iov32p->iov_base = a_base;
-               a_iov32p->iov_len = a_len;
-       }
-       return;
-}
-
-#define INIT_UIO_BASE( uiop, iovcnt, offset, resid, rw, procp ) \
-{ \
-       (uiop)->uio_iovcnt = (iovcnt); \
-       (uiop)->uio_offset = (offset); \
-       (uiop)->uio_resid = (resid); \
-       (uiop)->uio_rw = (rw); \
-       (uiop)->uio_procp = (procp); \
-}
-#define INIT_UIO_USER32( uiop, iovp, iovcnt, offset, resid, rw, procp ) \
-{ \
-       (uiop)->uio_iovs.iov32p = (iovp);  \
-       (uiop)->uio_segflg = UIO_USERSPACE; \
-       INIT_UIO_BASE((uiop), (iovcnt), (offset), (resid), (rw), (procp)); \
-}
-#define INIT_UIO_USER64( uiop, iovp, iovcnt, offset, resid, rw, procp ) \
-{ \
-       (uiop)->uio_iovs.iov64p = (iovp);  \
-       (uiop)->uio_segflg = UIO_USERSPACE64; \
-       INIT_UIO_BASE((uiop), (iovcnt), (offset), (resid), (rw), (procp)); \
-}
-#define INIT_UIO_SYS32( uiop, iovp, iovcnt, offset, resid, rw, procp ) \
-{ \
-       (uiop)->uio_iovs.iov32p = (iovp);  \
-       (uiop)->uio_segflg = UIO_SYSSPACE; \
-       INIT_UIO_BASE((uiop), (iovcnt), (offset), (resid), (rw), (procp)); \
-}
-#define INIT_UIO_USERSPACE( uiop, iovp, iovcnt, offset, resid, rw, procp ) \
-{ \
-       if (IS_64BIT_PROCESS((procp))) { \
-               (uiop)->uio_iovs.iov64p = (iovp);  \
-               (uiop)->uio_segflg = UIO_USERSPACE64; \
-       } \
-       else {  \
-               (uiop)->uio_iovs.iov32p = (struct iovec_32 *)(iovp);  \
-               (uiop)->uio_segflg = UIO_USERSPACE; \
-       }  \
-       INIT_UIO_BASE((uiop), (iovcnt), (offset), (resid), (rw), (procp)); \
-}
-#define INIT_UIO_SYSSPACE( uiop, iovp, iovcnt, offset, resid, rw, procp ) \
-{ \
-       if (0) { /* we do not support 64-bit system space yet */ \
-               (uiop)->uio_iovs.iov64p = (iovp);  \
-               (uiop)->uio_segflg = UIO_SYSSPACE64; \
-       } \
-       else {  \
-               (uiop)->uio_iovs.iov32p = (struct iovec_32 *)(iovp);  \
-               (uiop)->uio_segflg = UIO_SYSSPACE; \
-       }  \
-       INIT_UIO_BASE((uiop), (iovcnt), (offset), (resid), (rw), (procp)); \
-}
-#endif // UIO_KPI - WARNING OBSOLETE!!!! 
-
+extern int ureadc(int c, struct uio *uio);
 
-#endif /* KERNEL */
+#endif /* KERNEL_PRIVATE */
 #endif /* !_SYS_UIO_INTERNAL_H_ */