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 16c005525af5786dab9d0a12d3adf6c217442846..651a013901c53d5030eb460ebd02879eff2a74f0 100644 (file)
--- a/bsd/libkern/libkern.h
+++ b/bsd/libkern/libkern.h
@@ -1,23 +1,29 @@
 /*
 /*

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

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * 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.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE 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_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*-
  * Copyright (c) 1992, 1993
  */
 /*-
  * Copyright (c) 1992, 1993


@@ -53,13 +59,24 @@
  *
  *     @(#)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>
 
 #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 <sys/cdefs.h>
 #include <sys/types.h>

+#include <mach/vm_param.h>
+

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


@@ -107,30 +124,89 @@ 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. */
 /* Prototypes for non-quad routines. */

-int     bcmp __P((const void *, const void *, size_t));
-int     ffs __P((int));
-int     locc __P((int, char *, u_int));
-u_long  random __P((void));
-char   *rindex __P((const char *, int));
-int     scanc __P((u_int, u_char *, u_char *, int));
-int     skpc __P((int, int, char *));
-char   *strcat __P((char *, const char *));
-char   *strcpy __P((char *, const char *));
-size_t  strlen __P((const char *));
-char   *strncpy __P((char *, const char *, size_t));
-long   strtol __P((const char*, char **, int));
+extern int     ffs(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 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);
+
+#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);
+
+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);
+
+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);
+#endif
+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_ */