xnu-2782.40.9.tar.gz

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

diff --git a/bsd/libkern/libkern.h b/bsd/libkern/libkern.h
index 58e0224f65c9e528936f182048b793ec7dcf0875..651a013901c53d5030eb460ebd02879eff2a74f0 100644 (file)
--- a/bsd/libkern/libkern.h
+++ b/bsd/libkern/libkern.h
@@ -1,14 +1,19 @@
 /*
 /*

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

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @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

- * 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
  * 
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER


@@ -18,7 +23,7 @@
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * 
  * 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) 1992, 1993
  */
 /*-
  * Copyright (c) 1992, 1993


@@ -54,17 +59,25 @@
  *
  *     @(#)libkern.h   8.1 (Berkeley) 6/10/93
  */
  *
  *     @(#)libkern.h   8.1 (Berkeley) 6/10/93
  */

+/*
+ * NOTICE: This file was modified by SPARTA, Inc. in 2005 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 _LIBKERN_LIBKERN_H_
 #define _LIBKERN_LIBKERN_H_
 
 #include <sys/appleapiopts.h>
 #include <stdint.h>
 
 #ifndef _LIBKERN_LIBKERN_H_
 #define _LIBKERN_LIBKERN_H_
 
 #include <sys/appleapiopts.h>
 #include <stdint.h>

+#include <stdarg.h>    /* for platform-specific va_list */

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

+

 #ifdef __APPLE_API_OBSOLETE
 /* BCD conversions. */
 extern u_char const    bcd2bin_data[];
 #ifdef __APPLE_API_OBSOLETE
 /* BCD conversions. */
 extern u_char const    bcd2bin_data[];


@@ -111,33 +124,49 @@ min(u_int a, u_int b)
 {
        return (a < b ? a : b);
 }
 {
        return (a < b ? a : b);
 }

-static inline u_long
-ulmax(u_long a, u_long b)
+static inline u_int32_t
+ulmax(u_int32_t a, u_int32_t b)

 {
        return (a > b ? a : b);
 }
 {
        return (a > b ? a : b);
 }

-static inline u_long
-ulmin(u_long a, u_long b)
+static inline u_int32_t
+ulmin(u_int32_t a, u_int32_t b)

 {
        return (a < b ? a : b);
 }
 
 {
        return (a < b ? a : 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 u_long  random(void);
-extern char    *rindex(const char *, int);
+extern u_int32_t       random(void);

 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 **, const char *);
+extern void    *memchr(const void *, int, size_t);
+
+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    sscanf(const char *, char const *, ...) __scanflike(2,3);
+int    printf(const char *, ...) __printflike(1,2);

 
 

-int    snprintf(char *, size_t, const char *, ...);
-int    sprintf(char *bufp, const char *, ...);
-int    sscanf(const char *, char const *, ...);
-void printf(const char *, ...);
+#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

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


@@ -147,15 +176,37 @@ 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);
 
 int    copyin(const user_addr_t uaddr, void *kaddr, size_t len);
 int    copyout(const void *kaddr, user_addr_t udaddr, size_t len);
 

-int vsscanf(const char *, char const *, __darwin_va_list);
-extern int     vsnprintf(char *, size_t, const char *, __darwin_va_list);
-extern int     vsprintf(char *bufp, const char *, __darwin_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);

 
 

+/* vsprintf() is being deprecated. Please use vsnprintf() instead. */
+extern int     vsprintf(char *bufp, const char *, va_list) __deprecated;
+
+#ifdef KERNEL_PRIVATE
+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);
 extern void invalidate_icache(vm_offset_t, unsigned, int);
 extern void flush_dcache(vm_offset_t, unsigned, int);

+#endif

 extern void invalidate_icache64(addr64_t, unsigned, int);
 extern void flush_dcache64(addr64_t, unsigned, int);
 
 extern void invalidate_icache64(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
+clz(unsigned int num)
+{
+       return num?__builtin_clz(num):__builtin_clz(0);
+}
+
+

 __END_DECLS
 
 #endif /* _LIBKERN_LIBKERN_H_ */
 __END_DECLS
 
 #endif /* _LIBKERN_LIBKERN_H_ */