libsyscall/wrappers/_libkernel_init.h

   1 /*
   2  * Copyright (c) 2010-2014 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 #ifndef __LIBKERNEL_INIT_H
  30 #define __LIBKERNEL_INIT_H
  31
  32 #include <sys/types.h>
  33 #include <mach/mach.h>
  34 #include <mach/message.h>
  35 #include <mach/mach_types.h>
  36
  37 #ifndef __OS_VOUCHER_PRIVATE__
  38 // We cannot include the actual os/voucher_private.h definition of voucher_t
  39 // here, as that also marks the voucher_XXX functions as exported, which causes
  40 // a compile error when we attempt to mark them hidden in the .c file.
  41 //
  42 // The Libsystem init.c file does include os/voucher_private.h though, as well
  43 // as this file, and this typedef causes an error if it is unguarded.
  44 struct voucher_s;
  45 typedef struct voucher_s *voucher_t;
  46 #endif
  47
  48 typedef const struct _libkernel_functions {
  49         /* The following functions are included in version 1 of this structure */
  50         unsigned long version;
  51         void* (*dlsym)(void*, const char*);
  52         void* (*malloc)(size_t);
  53         void  (*free)(void*);
  54         void* (*realloc)(void*, size_t);
  55         void  (*_pthread_exit_if_canceled)(int);
  56
  57         /* The following functions are included in version 2 of this structure */
  58         void *reserved1;
  59         void *reserved2;
  60         void *reserved3;
  61         void *reserved4;
  62         void *reserved5;
  63
  64         /* The following functions are included in version 3 of this structure */
  65         void (*pthread_clear_qos_tsd)(mach_port_t);
  66
  67         /* Subsequent versions must only add pointers! */
  68 } *_libkernel_functions_t;
  69
  70 typedef const struct _libkernel_string_functions {
  71         /* The following functions are included in version 1 of this structure */
  72         unsigned long version;
  73         void (*bzero)(void *s, size_t n);
  74         void * (*memchr)(const void *s, int c, size_t n);
  75         int (*memcmp)(const void *s1, const void *s2, size_t n);
  76         void * (*memmove)(void *dst, const void *src, size_t n);
  77         void * (*memccpy)(void *__restrict dst, const void *__restrict src, int c, size_t n);
  78         void * (*memset)(void *b, int c, size_t len);
  79         char * (*strchr)(const char *s, int c);
  80         int (*strcmp)(const char *s1, const char *s2);
  81         char * (*strcpy)(char * restrict dst, const char * restrict src);
  82         size_t (*strlcat)(char * restrict dst, const char * restrict src, size_t maxlen);
  83         size_t (*strlcpy)(char * restrict dst, const char * restrict src, size_t maxlen);
  84         size_t (*strlen)(const char *str);
  85         int (*strncmp)(const char *s1, const char *s2, size_t n);
  86         char * (*strncpy)(char * restrict dst, const char * restrict src, size_t maxlen);
  87         size_t (*strnlen)(const char *s, size_t maxlen);
  88         char * (*strstr)(const char *s, const char *find);
  89         /* Subsequent versions must only add pointers! */
  90 } *_libkernel_string_functions_t;
  91
  92 typedef const struct _libkernel_voucher_functions {
  93         /* The following functions are included in version 1 of this structure */
  94         unsigned long version;
  95         boolean_t (*voucher_mach_msg_set)(mach_msg_header_t*);
  96         void (*voucher_mach_msg_clear)(mach_msg_header_t*);
  97         voucher_mach_msg_state_t (*voucher_mach_msg_adopt)(mach_msg_header_t*);
  98         void (*voucher_mach_msg_revert)(voucher_mach_msg_state_t);
  99
 100         /* Subsequent versions must only add pointers! */
 101 } *_libkernel_voucher_functions_t;
 102
 103 struct ProgramVars; /* forward reference */
 104
 105 void __libkernel_init(_libkernel_functions_t fns, const char *envp[],
 106                 const char *apple[], const struct ProgramVars *vars);
 107
 108 kern_return_t __libkernel_platform_init(_libkernel_string_functions_t fns);
 109
 110 kern_return_t __libkernel_voucher_init(_libkernel_voucher_functions_t fns);
 111
 112 #endif // __LIBKERNEL_INIT_H