libkern/libkern/kxld_types.h

   1 /*
   2  * Copyright (c) 2007-2012 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 #ifndef _KXLD_TYPES_H
  29 #define _KXLD_TYPES_H
  30
  31 #include <stdarg.h>
  32 #include <stdint.h>
  33 #include <mach/boolean.h>       // boolean_t
  34 #include <mach/kern_return.h>
  35
  36 /*******************************************************************************
  37 * Macros
  38 *******************************************************************************/
  39
  40 /* For 32-bit-specific linking code */
  41 #if (!KERNEL || !__LP64__)
  42     #define KXLD_USER_OR_ILP32 1
  43 #endif
  44
  45 /* For 64-bit-specific linking code */
  46 #if (!KERNEL || __LP64__)
  47     #define KXLD_USER_OR_LP64 1
  48 #endif
  49
  50 /* For i386-specific linking code */
  51 #if (!KERNEL || __i386__)
  52     #define KXLD_USER_OR_I386 1
  53 #endif
  54
  55 /* For x86_64-specific linking code */
  56 #if (!KERNEL || __x86_64__)
  57     #define KXLD_USER_OR_X86_64 1
  58 #endif
  59
  60 /* For arm-specific linking code */
  61 #if (!KERNEL || __arm__)
  62     #define KXLD_USER_OR_ARM 1
  63 #endif
  64
  65 /* For arm64-specific linking code */
  66 #if (!KERNEL || __arm64__)
  67     #define KXLD_USER_OR_ARM64 1
  68 #endif
  69
  70 /* For linking code specific to architectures that support common symbols */
  71 #if (!KERNEL || __i386__)
  72     #define KXLD_USER_OR_COMMON 1
  73 #endif
  74
  75 /* For linking code specific to architectures that support strict patching */
  76     #define KXLD_USER_OR_STRICT_PATCHING 1
  77
  78 /* For linking code specific to architectures that use MH_OBJECT */
  79 #if (!KERNEL || __i386__)
  80     #define KXLD_USER_OR_OBJECT 1
  81 #endif
  82
  83 /* For linking code specific to architectures that use MH_KEXT_BUNDLE */
  84 #define KXLD_USER_OR_BUNDLE 1
  85
  86 /* We no longer need to generate our own GOT for any architectures, but the code
  87  * required to do this will be saved inside this macro.
  88  */
  89 #define KXLD_USER_OR_GOT 0
  90
  91 /* for building the dysymtab command generation into the dylib */
  92 #if (!KERNEL)
  93     #define KXLD_PIC_KEXTS 1
  94 #endif
  95
  96 /*******************************************************************************
  97 * Types
  98 *******************************************************************************/
  99
 100 /* Maintains linker state across links.  One context should be allocate for
 101  * each link thread.
 102  */
 103 typedef struct kxld_context KXLDContext;
 104
 105 /* Unless we're in a 32-bit kernel, all internal math is performed in 64 bits
 106  * and cast to smaller values as needed by the architecture for which we are
 107  * linking.  All returned arguments should be handled similarly.
 108  * Note: This size can be increased for future architectural size increases
 109  */
 110 #if KERNEL && !__LP64__
 111 typedef uint32_t kxld_addr_t;
 112 typedef uint32_t kxld_size_t;
 113 #else
 114 typedef uint64_t kxld_addr_t;
 115 typedef uint64_t kxld_size_t;
 116 #endif /* KERNEL && !__LP64__ */
 117
 118 /* Flags for general linker behavior */
 119 enum kxld_flags {
 120     kKxldFlagDefault = 0x0,
 121     kKXLDFlagIncludeRelocs = 0x01
 122 };
 123 typedef enum kxld_flags KXLDFlags;
 124
 125 /* Flags for the allocation callback */
 126 enum kxld_allocate_flags {
 127     kKxldAllocateDefault = 0x0,
 128     kKxldAllocateWritable = 0x1,        /* kxld may write into the allocated memory */
 129 };
 130 typedef enum kxld_allocate_flags KXLDAllocateFlags;
 131
 132 /* This specifies the function type of the callback that the linker uses to get
 133  * the base address and allocated memory for relocation and linker output,
 134  * respectively.  Note that it is compatible with the standard allocators (e.g.
 135  * malloc).
 136  */
 137 typedef kxld_addr_t (*KXLDAllocateCallback)(size_t size,
 138     KXLDAllocateFlags *flags, void *user_data);
 139
 140 /* Flags for the logging callback */
 141 typedef enum kxld_log_subsystem {
 142     kKxldLogLinking = 0x0,
 143     kKxldLogPatching = 0x01
 144 } KXLDLogSubsystem;
 145
 146 typedef enum kxld_log_level {
 147     kKxldLogExplicit = 0x0,
 148     kKxldLogErr = 0x1,
 149     kKxldLogWarn = 0x2,
 150     kKxldLogBasic = 0x3,
 151     kKxldLogDetail = 0x4,
 152     kKxldLogDebug = 0x5
 153 } KXLDLogLevel;
 154
 155 /* This structure is used to describe a dependency kext. The kext field
 156  * is a pointer to the binary executable of the dependency. The interface
 157  * field is a pointer to an optional interface kext that restricts the
 158  * symbols that may be accessed in the dependency kext.
 159  *
 160  * For example, to use this structure with the KPIs, set the kext field
 161  * to point to the kernel's Mach-O binary, and set interface to point
 162  * to the KPI's Mach-O binary.
 163  */
 164 typedef struct kxld_dependency {
 165     u_char      * kext;
 166     u_long        kext_size;
 167     char        * kext_name;
 168     u_char      * interface;
 169     u_long        interface_size;
 170     char        * interface_name;
 171     boolean_t     is_direct_dependency;
 172 } KXLDDependency;
 173
 174 typedef void (*KXLDLoggingCallback) (KXLDLogSubsystem sys, KXLDLogLevel level,
 175     const char *format, va_list ap, void *user_data);
 176
 177 #endif /* _KXLD_TYPES_H */
 178