xnu-6153.81.5.tar.gz

[apple/xnu.git] / osfmk / kern / misc_protos.h

diff --git a/osfmk/kern/misc_protos.h b/osfmk/kern/misc_protos.h
index 63eb58c09e36d2c1791335e6d01cdf18905d283c..21742d6649ed3759bf2f34b158c8e77909a38c1f 100644 (file)
--- a/osfmk/kern/misc_protos.h
+++ b/osfmk/kern/misc_protos.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@
  */
 /*
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*


@@ -35,8 +35,8 @@
  * Version 2.0.
  */
 
  * Version 2.0.
  */
 

-#ifndef        _MISC_PROTOS_H_
-#define        _MISC_PROTOS_H_
+#ifndef _MISC_PROTOS_H_
+#define _MISC_PROTOS_H_

 
 #include <stdarg.h>
 #include <string.h>
 
 #include <stdarg.h>
 #include <string.h>


@@ -46,35 +46,36 @@
 #include <mach/machine/vm_types.h>
 #include <ipc/ipc_types.h>
 #include <kern/debug.h>
 #include <mach/machine/vm_types.h>
 #include <ipc/ipc_types.h>
 #include <kern/debug.h>

+#include <libkern/copyio.h>

 
 #ifndef MIN
 
 #ifndef MIN

-#define MIN(a,b) (((a)<(b))?(a):(b))
+#define MIN(a, b) (((a)<(b))?(a):(b))

 #endif /* MIN */
 #ifndef MAX
 #endif /* MIN */
 #ifndef MAX

-#define MAX(a,b) (((a)>(b))?(a):(b))
+#define MAX(a, b) (((a)>(b))?(a):(b))

 #endif  /* MAX */
 
 /* Set a bit in a bit array */
 extern void setbit(
 #endif  /* MAX */
 
 /* Set a bit in a bit array */
 extern void setbit(

-       int             which,
-       int             *bitmap);
+       int             which,
+       int             *bitmap);

 
 /* Clear a bit in a bit array */
 extern void clrbit(
 
 /* Clear a bit in a bit array */
 extern void clrbit(

-       int             which,
-       int             *bitmap);
+       int             which,
+       int             *bitmap);

 
 /* Find the first set bit in a bit array */
 extern int ffsbit(
 
 /* Find the first set bit in a bit array */
 extern int ffsbit(

-       int             *bitmap);
+       int             *bitmap);

 extern int ffs(
 extern int ffs(

-       unsigned int    mask);
+       unsigned int    mask);

 extern int ffsll(
        unsigned long long mask);
 
 /* Find the last set bit in a bit array */
 extern int fls(
 extern int ffsll(
        unsigned long long mask);
 
 /* Find the last set bit in a bit array */
 extern int fls(

-       unsigned int    mask);
+       unsigned int    mask);

 extern int flsll(
        unsigned long long mask);
 
 extern int flsll(
        unsigned long long mask);
 


@@ -82,26 +83,47 @@ extern int flsll(
  * Test if indicated bit is set in bit string.
  */
 extern int testbit(
  * Test if indicated bit is set in bit string.
  */
 extern int testbit(

-       int             which,
-       int             *bitmap);
+       int             which,
+       int             *bitmap);

 
 

-/* Move arbitrarily-aligned data from a user space to kernel space */
-extern int copyin(
+/*
+ * Move an aligned 32 or 64-bit word from user space to kernel space
+ * using a single read instruction
+ */
+extern int copyin_atomic32(

        const user_addr_t   user_addr,
        const user_addr_t   user_addr,

-       char                *kernel_addr,
-       vm_size_t           nbytes);
+       uint32_t            *kernel_addr);

 
 

-/* Move an aligned 32 or 64-bit word from user space to kernel space
- * using a single read instruction
+extern int copyin_atomic64(
+       const user_addr_t   user_addr,
+       uint64_t            *kernel_addr);
+
+/*
+ * Does an atomic copyin at the specified user_address and compares
+ * it to the passed in value, and if it matches, waits.
+ *
+ * This is used to implement adaptive spinning for userspace synchronization

  *
  *

- * when reading a 32-bit word, the value is 0-extended into the kernel space
- * 64-bit buffer passed as `kernel_addr`
- * (think `*kernel_addr = *(uint32_t *)user_addr`)
+ * Returns:
+ * 0:       the value mached, and it paused efficiently for the platform
+ * ESTALE:  the value didn't match, and it returned immediately
+ * other:   the copyin failed (EFAULT, EINVAL, ...)

  */
  */

-extern int copyin_word(
+extern int copyin_atomic32_wait_if_equals(

        const user_addr_t   user_addr,
        const user_addr_t   user_addr,

-       uint64_t            *kernel_addr,
-       vm_size_t           nbytes);
+       uint32_t            value);
+
+/*
+ * Move a 32 or 64-bit word from kernel space to user space
+ * using a single write instruction
+ */
+extern int copyout_atomic32(
+       uint32_t            u32,
+       user_addr_t         user_addr);
+
+extern int copyout_atomic64(
+       uint64_t            u64,
+       user_addr_t         user_addr);

 
 /* Move a NUL-terminated string from a user space to kernel space */
 extern int copyinstr(
 
 /* Move a NUL-terminated string from a user space to kernel space */
 extern int copyinstr(


@@ -116,12 +138,6 @@ extern int copyinmsg(
        char                *kernel_addr,
        mach_msg_size_t     nbytes);
 
        char                *kernel_addr,
        mach_msg_size_t     nbytes);
 

-/* Move arbitrarily-aligned data from a kernel space to user space */
-extern int copyout(
-       const void      *kernel_addr,
-       user_addr_t     user_addr,
-       vm_size_t       nbytes);
-

 /* Move arbitrarily-aligned data from a kernel space to user space */
 extern int copyoutmsg(
        const char      *kernel_addr,
 /* Move arbitrarily-aligned data from a kernel space to user space */
 extern int copyoutmsg(
        const char      *kernel_addr,


@@ -132,15 +148,12 @@ extern int copyoutmsg(
 extern void inval_copy_windows(thread_t);
 extern void copy_window_fault(thread_t, vm_map_t, int);
 
 extern void inval_copy_windows(thread_t);
 extern void copy_window_fault(thread_t, vm_map_t, int);
 

-extern int copyin_validate(const user_addr_t, uintptr_t, vm_size_t);
-extern int copyout_validate(uintptr_t, const user_addr_t, vm_size_t);
+extern int sscanf(const char *input, const char *fmt, ...) __scanflike(2, 3);

 
 

-extern int sscanf(const char *input, const char *fmt, ...) __scanflike(2,3);
-
-/* sprintf() is being deprecated. Please use snprintf() instead. */ 
+/* sprintf() is being deprecated. Please use snprintf() instead. */

 extern integer_t sprintf(char *buf, const char *fmt, ...) __deprecated;
 
 extern integer_t sprintf(char *buf, const char *fmt, ...) __deprecated;
 

-extern int printf(const char *format, ...) __printflike(1,2);
+extern int printf(const char *format, ...) __printflike(1, 2);

 extern int vprintf(const char *format, va_list ap);
 
 #if KERNEL_PRIVATE
 extern int vprintf(const char *format, va_list ap);
 
 #if KERNEL_PRIVATE


@@ -155,46 +168,47 @@ int     _consume_printf_args(int, ...);
 #endif
 #endif
 
 #endif
 #endif
 

-extern int paniclog_append_noflush(const char *format, ...) __printflike(1,2);
+extern int paniclog_append_noflush(const char *format, ...) __printflike(1, 2);

 
 

-extern int kdb_printf(const char *format, ...) __printflike(1,2);
+extern int kdb_printf(const char *format, ...) __printflike(1, 2);

 
 

-extern int kdb_log(const char *format, ...) __printflike(1,2);
+extern int kdb_log(const char *format, ...) __printflike(1, 2);

 
 

-extern int kdb_printf_unbuffered(const char *format, ...) __printflike(1,2);
+extern int kdb_printf_unbuffered(const char *format, ...) __printflike(1, 2);

 
 extern void printf_init(void);
 
 
 extern void printf_init(void);
 

-extern int snprintf(char *, size_t, const char *, ...) __printflike(3,4);
+extern int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
+extern int scnprintf(char *, size_t, const char *, ...) __printflike(3, 4);

 
 extern void log(int level, char *fmt, ...);
 
 
 extern void log(int level, char *fmt, ...);
 

-void 
+void

 _doprnt(
 _doprnt(

-       const char      *fmt,
-       va_list                 *argp,
-       void                    (*putc)(char),
-       int                     radix);
+       const char      *fmt,
+       va_list                 *argp,
+       void                    (*putc)(char),
+       int                     radix);

 
 void
 _doprnt_log(
 
 void
 _doprnt_log(

-       const char      *fmt,
-       va_list                 *argp,
-       void                    (*putc)(char),
-       int                     radix);
+       const char      *fmt,
+       va_list                 *argp,
+       void                    (*putc)(char),
+       int                     radix);

 
 int
 __doprnt(
 
 int
 __doprnt(

-       const char      *fmt,
-       va_list                 argp,
-       void                    (*putc)(int, void *),
+       const char      *fmt,
+       va_list                 argp,
+       void                    (*putc)(int, void *),

        void                    *arg,
        void                    *arg,

-       int                     radix,
-       int                     is_log);
+       int                     radix,
+       int                     is_log);

 
 extern void safe_gets(
 
 extern void safe_gets(

-       char    *str,
-       int     maxlen);
+       char    *str,
+       int     maxlen);

 
 extern void cnputcusr(char);
 
 
 extern void cnputcusr(char);
 


@@ -225,28 +239,28 @@ extern int cngetc(void);
 extern int cnmaygetc(void);
 
 extern int _setjmp(
 extern int cnmaygetc(void);
 
 extern int _setjmp(

-       jmp_buf_t       *jmp_buf);
+       jmp_buf_t       *jmp_buf);

 
 extern int _longjmp(
 
 extern int _longjmp(

-       jmp_buf_t       *jmp_buf,
-       int             value);
+       jmp_buf_t       *jmp_buf,
+       int             value);

 
 extern void bootstrap_create(void);
 
 
 extern void bootstrap_create(void);
 

-#if    DIPC
-extern boolean_t       no_bootstrap_task(void);
-extern ipc_port_t      get_root_master_device_port(void);
-#endif /* DIPC */
+#if     DIPC
+extern boolean_t        no_bootstrap_task(void);
+extern ipc_port_t       get_root_master_device_port(void);
+#endif  /* DIPC */

 
 

-extern kern_return_t   kernel_set_special_port(
-               host_priv_t     host_priv,
-               int             which,
-               ipc_port_t      port);
+extern kern_return_t    kernel_set_special_port(
+       host_priv_t     host_priv,
+       int             which,
+       ipc_port_t      port);

 
 

-extern kern_return_t   kernel_get_special_port(
-               host_priv_t     host_priv,
-               int             which,
-               ipc_port_t      *portp);
+extern kern_return_t    kernel_get_special_port(
+       host_priv_t     host_priv,
+       int             which,
+       ipc_port_t      *portp);

 
 user_addr_t get_useraddr(void);
 
 
 user_addr_t get_useraddr(void);
 


@@ -255,4 +269,4 @@ struct kmod_info_t;
 
 extern uint64_t early_random(void);
 
 
 extern uint64_t early_random(void);
 

-#endif /* _MISC_PROTOS_H_ */
+#endif  /* _MISC_PROTOS_H_ */