/* * 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 * 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, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * 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@ */ /* * @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_ #include #include #include #include #include #include #include #include #include #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); /* Clear a bit in a bit array */ extern void clrbit( int which, int *bitmap); /* Find the first set bit in a bit array */ extern int ffsbit( int *bitmap); extern int ffs( 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 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); #if CONFIG_DTRACE extern int dtrace_nofault_copy8( const uintptr_t kernel_addr, uint8_t *value); extern int dtrace_nofault_copy16( const uintptr_t kernel_addr, uint16_t *value); extern int dtrace_nofault_copy32( const uintptr_t kernel_addr, uint32_t *value); extern int dtrace_nofault_copy64( const uintptr_t kernel_addr, uint64_t *value); #endif /* CONFIG_DTRACE */ /* * 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 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 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 int copyoutmsg( const char *kernel_addr, user_addr_t user_addr, mach_msg_size_t nbytes); #if (DEBUG || DEVELOPMENT) extern int verify_write(const void *source, void *dst, size_t size); #endif extern int sscanf(const char *input, const char *fmt, ...) __scanflike(2, 3); /* sprintf() is being deprecated. Please use snprintf() instead. */ extern integer_t sprintf(char *buf, const char *fmt, ...) __printflike(2, 3) __deprecated; extern int printf(const char *format, ...) __printflike(1, 2); extern int vprintf(const char *format, va_list ap) __printflike(1, 0); #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 int paniclog_append_noflush(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_printf_unbuffered(const char *format, ...) __printflike(1, 2); 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, ...) __printflike(2, 3); void _doprnt( const char *fmt, va_list *argp, void (*putc)(char), int radix) __printflike(1, 0); void _doprnt_log( const char *fmt, va_list *argp, void (*putc)(char), int radix) __printflike(1, 0); int __doprnt( const char *fmt, va_list argp, void (*putc)(int, void *), void *arg, int radix, int is_log) __printflike(1, 0); extern void console_write_char(char); 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 console_write_unbuffered(char); extern void console_write(char *, int); extern void console_suspend(void); extern void console_resume(void); extern int console_read_char(void); extern int console_try_read_char(void); extern int _setjmp( jmp_buf_t *jmp_buf); extern int _longjmp( jmp_buf_t *jmp_buf, int value); extern void bootstrap_create(void); 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); user_addr_t get_useraddr(void); /* symbol lookup */ #ifndef __cplusplus struct kmod_info_t; #endif extern uint64_t early_random(void); #endif /* _MISC_PROTOS_H_ */