libkern/kxld/kxld_vtable.h

   1 /*
   2  * Copyright (c) 2008 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_VTABLE_H_
  29 #define _KXLD_VTABLE_H_
  30
  31 #include <sys/types.h>
  32 #if KERNEL
  33     #include <libkern/kxld_types.h>
  34 #else
  35     #include "kxld_types.h"
  36 #endif
  37
  38 #include "kxld_array.h"
  39
  40 struct kxld_array;
  41 struct kxld_reloc;
  42 struct kxld_relocator;
  43 struct kxld_sect;
  44 struct kxld_sym;
  45 struct kxld_symtab;
  46 struct kxld_vtable_hdr;
  47 struct section;
  48
  49 typedef struct kxld_vtable KXLDVTable;
  50 typedef union kxld_vtable_entry KXLDVTableEntry;
  51
  52 struct kxld_vtable {
  53     u_char *vtable;
  54     const char *name;
  55     KXLDArray entries;
  56     boolean_t is_patched;
  57 };
  58
  59 struct kxld_vtable_patched_entry {
  60     char *name;
  61     kxld_addr_t addr;
  62 };
  63
  64 struct kxld_vtable_unpatched_entry {
  65     struct kxld_sym *sym;
  66     struct kxld_reloc *reloc;
  67 };
  68
  69 union kxld_vtable_entry {
  70     struct kxld_vtable_patched_entry patched;
  71     struct kxld_vtable_unpatched_entry unpatched;
  72 };
  73
  74 /*******************************************************************************
  75 * Constructors and destructors
  76 *******************************************************************************/
  77
  78 kern_return_t kxld_vtable_init_from_kernel_macho(KXLDVTable *vtable,
  79     const struct kxld_sym *sym, const struct kxld_sect *sect,
  80     const struct kxld_symtab *symtab, const struct kxld_relocator *relocator)
  81     __attribute__((nonnull, visibility("hidden")));
  82
  83 kern_return_t kxld_vtable_init_from_final_macho(KXLDVTable *vtable,
  84     const struct kxld_sym *sym, const struct kxld_sect *sect,
  85     const struct kxld_symtab *symtab, const struct kxld_relocator *relocator,
  86     const struct kxld_array *relocs)
  87     __attribute__((nonnull, visibility("hidden")));
  88
  89 kern_return_t kxld_vtable_init_from_object_macho(KXLDVTable *vtable,
  90     const struct kxld_sym *sym, const struct kxld_sect *sect,
  91     const struct kxld_symtab *symtab, const struct kxld_relocator *relocator)
  92     __attribute__((nonnull, visibility("hidden")));
  93
  94 kern_return_t kxld_vtable_init_from_link_state_32(KXLDVTable *vtable, u_char *state,
  95     struct kxld_vtable_hdr *hdr)
  96     __attribute__((nonnull, visibility("hidden")));
  97
  98 kern_return_t kxld_vtable_init_from_link_state_64(KXLDVTable *vtable, u_char *state,
  99     struct kxld_vtable_hdr *hdr)
 100     __attribute__((nonnull, visibility("hidden")));
 101
 102 kern_return_t kxld_vtable_copy(KXLDVTable *vtable, const KXLDVTable *src)
 103     __attribute__((nonnull, visibility("hidden")));
 104
 105 void kxld_vtable_clear(KXLDVTable *vtable)
 106     __attribute__((visibility("hidden")));
 107
 108 void kxld_vtable_deinit(KXLDVTable *vtable)
 109     __attribute__((visibility("hidden")));
 110
 111 /*******************************************************************************
 112 * Modifiers
 113 *******************************************************************************/
 114
 115 /* With strict patching, the vtable patcher with only patch pad slots */
 116 kern_return_t kxld_vtable_patch(KXLDVTable *vtable, const KXLDVTable *super_vtable,
 117     struct kxld_symtab *symtab, boolean_t strict_patching)
 118     __attribute__((nonnull, visibility("hidden")));
 119
 120 #endif /* _KXLD_VTABLE_H_ */
 121