xnu-4903.231.4.tar.gz

[apple/xnu.git] / bsd / libkern / libkern.h

diff --git a/bsd/libkern/libkern.h b/bsd/libkern/libkern.h
index 223f3a526a763e27da902d2941a97f600e99d7aa..73545298d305961360af39e1b3e25e6c93d5ef70 100644 (file)
--- a/bsd/libkern/libkern.h
+++ b/bsd/libkern/libkern.h
@@ -1,5 +1,5 @@
 /*
 /*

- * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2012 Apple Inc. All rights reserved.

  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 


@@ -73,10 +73,16 @@
 #include <stdint.h>
 #include <stdarg.h>    /* for platform-specific va_list */
 #include <string.h>
 #include <stdint.h>
 #include <stdarg.h>    /* for platform-specific va_list */
 #include <string.h>

+#include <machine/limits.h>

 #include <sys/cdefs.h>
 #include <sys/types.h>
 #include <mach/vm_param.h>
 #include <sys/cdefs.h>
 #include <sys/types.h>
 #include <mach/vm_param.h>

+#include <libkern/crc.h>
+#include <libkern/copyio.h>

 
 

+#if defined(__arm__) || defined(__arm64__)
+#include <arm/arch.h> /* for _ARM_ARCH_* */
+#endif

 
 #ifdef __APPLE_API_OBSOLETE
 /* BCD conversions. */
 
 #ifdef __APPLE_API_OBSOLETE
 /* BCD conversions. */


@@ -139,21 +145,24 @@ ulmin(u_int32_t a, u_int32_t b)
 
 /* Prototypes for non-quad routines. */
 extern int     ffs(int);
 
 /* Prototypes for non-quad routines. */
 extern int     ffs(int);

-extern int     locc(int, char *, u_int);
+extern int     ffsll(unsigned long long);
+extern int     fls(int);
+extern int     flsll(unsigned long long);

 extern u_int32_t       random(void);
 extern u_int32_t       random(void);

-extern char    *rindex(const char *, int);

 extern int     scanc(u_int, u_char *, const u_char *, int);
 extern int     skpc(int, int, char *);
 extern long    strtol(const char*, char **, int);
 extern u_long  strtoul(const char *, char **, int);
 extern quad_t  strtoq(const char *, char **, int);
 extern u_quad_t strtouq(const char *, char **, int);
 extern int     scanc(u_int, u_char *, const u_char *, int);
 extern int     skpc(int, int, char *);
 extern long    strtol(const char*, char **, int);
 extern u_long  strtoul(const char *, char **, int);
 extern quad_t  strtoq(const char *, char **, int);
 extern u_quad_t strtouq(const char *, char **, int);

-extern char    *strsep(char **stringp, const char *delim);
+extern char    *strsep(char **, const char *);
+extern void    *memchr(const void *, int, size_t);
+extern void    url_decode(char *str);

 
 int    snprintf(char *, size_t, const char *, ...) __printflike(3,4);
 
 /* sprintf() is being deprecated. Please use snprintf() instead. */
 
 int    snprintf(char *, size_t, const char *, ...) __printflike(3,4);
 
 /* sprintf() is being deprecated. Please use snprintf() instead. */

-int    sprintf(char *bufp, const char *, ...) __deprecated;
+int    sprintf(char *bufp, const char *, ...) __deprecated __printflike(2,3);

 int    sscanf(const char *, char const *, ...) __scanflike(2,3);
 int    printf(const char *, ...) __printflike(1,2);
 
 int    sscanf(const char *, char const *, ...) __scanflike(2,3);
 int    printf(const char *, ...) __printflike(1,2);
 


@@ -169,23 +178,44 @@ int       _consume_printf_args(int, ...);
 #endif
 #endif
 
 #endif
 #endif
 

+uint16_t       crc16(uint16_t crc, const void *bufp, size_t len);

 uint32_t       crc32(uint32_t crc, const void *bufp, size_t len);
 
 uint32_t       crc32(uint32_t crc, const void *bufp, size_t len);
 

+#if XNU_KERNEL_PRIVATE
+#if KASAN
+uint16_t __nosan_crc16(uint16_t crc, const void *bufp, size_t len);
+#else
+static inline uint16_t
+__nosan_crc16(uint16_t crc, const void *bufp, size_t len) { return crc16(crc, bufp, len); }
+#endif
+#endif
+

 int    copystr(const void *kfaddr, void *kdaddr, size_t len, size_t *done);
 int    copyinstr(const user_addr_t uaddr, void *kaddr, size_t len, size_t *done);
 int    copyoutstr(const void *kaddr, user_addr_t udaddr, size_t len, size_t *done);
 int    copystr(const void *kfaddr, void *kdaddr, size_t len, size_t *done);
 int    copyinstr(const user_addr_t uaddr, void *kaddr, size_t len, size_t *done);
 int    copyoutstr(const void *kaddr, user_addr_t udaddr, size_t len, size_t *done);

-int    copyin(const user_addr_t uaddr, void *kaddr, size_t len);
-int    copyout(const void *kaddr, user_addr_t udaddr, size_t len);
+#if XNU_KERNEL_PRIVATE
+extern int copyin_word(const user_addr_t user_addr, uint64_t *kernel_addr, vm_size_t nbytes);
+#endif

 
 int vsscanf(const char *, char const *, va_list);
 
 
 int vsscanf(const char *, char const *, va_list);
 

-extern int     vprintf(const char *, va_list);
-extern int     vsnprintf(char *, size_t, const char *, va_list);
+extern int     vprintf(const char *, va_list) __printflike(1,0);
+extern int     vsnprintf(char *, size_t, const char *, va_list) __printflike(3,0);
+
+#if XNU_KERNEL_PRIVATE
+extern int     vprintf_log_locked(const char *, va_list) __printflike(1,0);
+extern void    osobject_retain(void * object);
+extern void    osobject_release(void * object);
+#endif

 
 /* vsprintf() is being deprecated. Please use vsnprintf() instead. */
 
 /* vsprintf() is being deprecated. Please use vsnprintf() instead. */

-extern int     vsprintf(char *bufp, const char *, va_list) __deprecated;
+extern int     vsprintf(char *bufp, const char *, va_list) __deprecated __printflike(2,0);

 
 #ifdef KERNEL_PRIVATE
 
 #ifdef KERNEL_PRIVATE

+#ifdef __arm__
+void flush_inner_dcaches(void);
+void clean_inner_dcaches(void);
+#endif

 extern void invalidate_icache(vm_offset_t, unsigned, int);
 extern void flush_dcache(vm_offset_t, unsigned, int);
 #else
 extern void invalidate_icache(vm_offset_t, unsigned, int);
 extern void flush_dcache(vm_offset_t, unsigned, int);
 #else


@@ -196,29 +226,31 @@ extern void invalidate_icache64(addr64_t, unsigned, int);
 extern void flush_dcache64(addr64_t, unsigned, int);
 
 
 extern void flush_dcache64(addr64_t, unsigned, int);
 
 

-/*
- * assembly versions of clz... ideally we would just call
- * __builtin_clz(num), unfortunately this one is ill defined
- * by gcc for num=0
- */
-static __inline__ unsigned int
+static inline int

 clz(unsigned int num)
 {
 clz(unsigned int num)
 {

-#if __i386__
-       unsigned int result;
-       __asm__ volatile(
-               "bsrl   %1, %0\n\t"
-               "cmovel %2, %0"
-               : "=r" (result)
-               : "rm" (num), "r" (63)
-       );
-       return 31 ^ result;
-
+#if (__arm__ || __arm64__)
+       // On ARM, clz(0) is defined to return number of bits in the input type
+       return __builtin_clz(num);

 #else
 #else

-       return num?__builtin_clz(num):__builtin_clz(0);
+       // On Intel, clz(0) is undefined
+       return num ? __builtin_clz(num) : sizeof(num) * CHAR_BIT;

 #endif
 }
 
 #endif
 }
 

+#if XNU_KERNEL_PRIVATE
+
+/*
+ * Define a function that for whatever reason needs to exist, but must never be
+ * called.
+ */
+#define UNSUPPORTED_API(funcname, ...) \
+       _Pragma("clang diagnostic push") \
+       _Pragma("clang diagnostic ignored \"-Wunused-parameter\"") \
+       funcname(__VA_ARGS__) { panic(__func__ ": unsupported API\n"); } \
+       _Pragma("clang diagnostic pop")
+
+#endif

 
 __END_DECLS
 
 
 __END_DECLS