]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/kern/misc_protos.h
xnu-6153.121.1.tar.gz
[apple/xnu.git] / osfmk / kern / misc_protos.h
index 14770bdac804e4477cda3269834c710e4ef80c30..21742d6649ed3759bf2f34b158c8e77909a38c1f 100644 (file)
@@ -1,17 +1,20 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  *
- * @APPLE_LICENSE_HEADER_START@
- * 
- * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
- * 
  * 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,
  * 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@
  */
 /*
  * @OSF_COPYRIGHT@
  */
+/*
+ * NOTICE: This file was modified by McAfee Research in 2004 to introduce
+ * support for mandatory and extensible security protections.  This notice
+ * is included in support of clause 2.2 (b) of the Apple Public License,
+ * 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 <mach/message.h>
 #include <mach/machine/vm_types.h>
 #include <ipc/ipc_types.h>
+#include <kern/debug.h>
+#include <libkern/copyio.h>
+
+#ifndef MIN
+#define MIN(a, b) (((a)<(b))?(a):(b))
+#endif /* MIN */
+#ifndef MAX
+#define MAX(a, b) (((a)>(b))?(a):(b))
+#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(
-       int             which,
-       int             *bitmap);
+       int             which,
+       int             *bitmap);
 
 /* Find the first set bit in a bit array */
 extern int ffsbit(
-       int             *bitmap);
+       int             *bitmap);
 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(
+       unsigned int    mask);
+extern int flsll(
+       unsigned long long mask);
 
 /*
  * Test if indicated bit is set in bit string.
  */
 extern int testbit(
-       int             which,
-       int             *bitmap);
-
-/* Move arbitrarily-aligned data from one array to another */
-extern void bcopy(
-       const char      *from,
-       char            *to,
-       vm_size_t       nbytes);
-
-/* Move overlapping, arbitrarily aligned data from one array to another */
-/* Not present on all ports */
-extern void ovbcopy(
-       const char      *from,
-       char            *to,
-       vm_size_t       nbytes);
-
-extern int bcmp(
-               const char *a,
-               const char *b,
-               vm_size_t len);
-
-/* Zero an arbitrarily aligned array */
-extern void bzero(
-       char    *from,
-       vm_size_t       nbytes);
+       int             which,
+       int             *bitmap);
 
-/* Move arbitrarily-aligned data from a user space to kernel space */
-extern boolean_t copyin(
-       const char      *user_addr,
-       char            *kernel_addr,
-       vm_size_t       nbytes);
+/*
+ * 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,
+       uint32_t            *kernel_addr);
+
+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
+ *
+ * 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_atomic32_wait_if_equals(
+       const user_addr_t   user_addr,
+       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 boolean_t copyinstr(
-       const char      *user_addr,
-       char            *kernel_addr,
-       vm_size_t       max,
-       vm_size_t       *actual);
+extern int copyinstr(
+       const user_addr_t   user_addr,
+       char                *kernel_addr,
+       vm_size_t           max,
+       vm_size_t           *actual);
 
 /* Move arbitrarily-aligned data from a user space to kernel space */
-extern boolean_t copyinmsg(
-       const char      *user_addr,
-       char            *kernel_addr,
-       mach_msg_size_t nbytes);
+extern int copyinmsg(
+       const user_addr_t   user_addr,
+       char                *kernel_addr,
+       mach_msg_size_t     nbytes);
 
 /* Move arbitrarily-aligned data from a kernel space to user space */
-extern boolean_t copyout(
-       const char      *kernel_addr,
-       char            *user_addr,
-       vm_size_t        nbytes);
-
-/* Move arbitrarily-aligned data from a kernel space to user space */
-extern boolean_t copyoutmsg(
-       const char      *kernel_addr,
-       char            *user_addr,
+extern int copyoutmsg(
+       const char      *kernel_addr,
+       user_addr_t     user_addr,
        mach_msg_size_t nbytes);
 
-extern int sscanf(const char *input, const char *fmt, ...);
+/* Invalidate copy window(s) cache */
+extern void inval_copy_windows(thread_t);
+extern void copy_window_fault(thread_t, vm_map_t, int);
 
-extern integer_t sprintf(char *buf, const char *fmt, ...);
+extern int sscanf(const char *input, const char *fmt, ...) __scanflike(2, 3);
 
-extern void printf(const char *format, ...);
+/* sprintf() is being deprecated. Please use snprintf() instead. */
+extern integer_t sprintf(char *buf, const char *fmt, ...) __deprecated;
 
-extern void kdp_printf(const char *format, ...);
+extern int printf(const char *format, ...) __printflike(1, 2);
+extern int vprintf(const char *format, va_list ap);
 
-extern void printf_init(void);
+#if KERNEL_PRIVATE
+int     _consume_printf_args(int, ...);
+#endif
+
+#if CONFIG_NO_PRINTF_STRINGS
+#if KERNEL_PRIVATE
+#define printf(x, ...)  _consume_printf_args( 0, ## __VA_ARGS__ )
+#else
+#define printf(x, ...)  do {} while (0)
+#endif
+#endif
 
-extern void panic(const char *string, ...);
+extern int paniclog_append_noflush(const char *format, ...) __printflike(1, 2);
 
-extern void panic_init(void);
+extern int kdb_printf(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 void printf_init(void);
+
+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, ...);
 
-void 
+void
 _doprnt(
-       register 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(
+       const char      *fmt,
+       va_list                 *argp,
+       void                    (*putc)(char),
+       int                     radix);
+
 int
 __doprnt(
-       register const char     *fmt,
-       va_list                 *argp,
-       void                    (*putc)(int, void *),
+       const char      *fmt,
+       va_list                 argp,
+       void                    (*putc)(int, void *),
        void                    *arg,
-       int                     radix);
+       int                     radix,
+       int                     is_log);
 
 extern void safe_gets(
-       char    *str,
-       int     maxlen);
+       char    *str,
+       int     maxlen);
 
 extern void cnputcusr(char);
 
+extern void cnputsusr(char *, int);
+
 extern void conslog_putc(char);
 
+extern void cons_putc_locked(char);
+
 extern void consdebug_putc(char);
 
+extern void consdebug_log(char);
+
+extern void consdebug_putc_unbuffered(char);
+
 extern void cnputc(char);
 
+extern void cnputc_unbuffered(char);
+
+extern void console_write(char *, int);
+
+extern void console_suspend(void);
+
+extern void console_resume(void);
+
 extern int cngetc(void);
 
 extern int cnmaygetc(void);
 
 extern int _setjmp(
-       jmp_buf_t       *jmp_buf);
+       jmp_buf_t       *jmp_buf);
 
 extern int _longjmp(
-       jmp_buf_t       *jmp_buf,
-       int             value);
+       jmp_buf_t       *jmp_buf,
+       int             value);
 
 extern void bootstrap_create(void);
 
-extern void halt_cpu(void);
+#if     DIPC
+extern boolean_t        no_bootstrap_task(void);
+extern ipc_port_t       get_root_master_device_port(void);
+#endif  /* DIPC */
 
-extern void halt_all_cpus(
-               boolean_t       reboot);
+extern kern_return_t    kernel_set_special_port(
+       host_priv_t     host_priv,
+       int             which,
+       ipc_port_t      port);
 
-extern void Debugger(
-               const char      * message);
-
-extern void delay(
-               int             n);
-
-extern char *machine_boot_info(
-               char            *buf,
-               vm_size_t       buf_len);
-
-/*
- * Machine-dependent routine to fill in an array with up to callstack_max
- * levels of return pc information.
- */
-extern void machine_callstack(
-               natural_t       *buf,
-               vm_size_t       callstack_max);
+extern kern_return_t    kernel_get_special_port(
+       host_priv_t     host_priv,
+       int             which,
+       ipc_port_t      *portp);
 
-extern void consider_machine_collect(void);
+user_addr_t get_useraddr(void);
 
-extern void norma_bootstrap(void);
+/* symbol lookup */
+struct kmod_info_t;
 
-#if    DIPC
-extern boolean_t       no_bootstrap_task(void);
-extern ipc_port_t      get_root_master_device_port(void);
-#endif /* DIPC */
+extern uint64_t early_random(void);
 
-#endif /* _MISC_PROTOS_H_ */
+#endif  /* _MISC_PROTOS_H_ */