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_KEXT_H_
29#define _KXLD_KEXT_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
38struct kxld_array;
39struct kxld_kext;
40struct kxld_dict;
41struct kxld_object;
42struct kxld_sect;
43struct kxld_seg;
44struct kxld_symtab;
45struct kxld_vtable;
46typedef struct kxld_kext KXLDKext;
47
48/*******************************************************************************
49* Constructors and Destructors
50*******************************************************************************/
51
52size_t kxld_kext_sizeof(void)
53 __attribute__((const, visibility("hidden")));
54
55kern_return_t kxld_kext_init(KXLDKext *kext, struct kxld_object *kext_object,
56 struct kxld_object *interface_object)
57 __attribute__((nonnull(1,2), visibility("hidden")));
58
59void kxld_kext_clear(KXLDKext *kext)
60 __attribute__((nonnull, visibility("hidden")));
61
62void kxld_kext_deinit(KXLDKext *kext)
63 __attribute__((nonnull, visibility("hidden")));
64
65/*******************************************************************************
66* Accessors
67*******************************************************************************/
68
69kern_return_t kxld_kext_export_symbols(const KXLDKext *kext,
70 struct kxld_dict *defined_symbols_by_name,
71 struct kxld_dict *obsolete_symbols_by_name,
72 struct kxld_dict *defined_cxx_symbols_by_value)
73 __attribute__((nonnull(1), visibility("hidden")));
74
75void kxld_kext_get_vmsize_for_seg_by_name(const KXLDKext *kext,
76 const char *segname,
77 u_long *vmsize)
78__attribute__((nonnull, visibility("hidden")));
79
80void kxld_kext_get_vmsize(const KXLDKext *kext,
81 u_long *header_size, u_long *vmsize)
82 __attribute__((nonnull, visibility("hidden")));
83
84void kxld_kext_set_linked_object_size(KXLDKext *kext, u_long vmsize)
85__attribute__((nonnull, visibility("hidden")));
86
87kern_return_t kxld_kext_export_linked_object(const KXLDKext *kext,
88 void *linked_object,
89 kxld_addr_t *kmod_info)
90 __attribute__((nonnull, visibility("hidden")));
91
92/*******************************************************************************
93* Modifiers
94*******************************************************************************/
95kern_return_t kxld_kext_export_vtables(KXLDKext *kext,
96 const struct kxld_dict *defined_cxx_symbols,
97 const struct kxld_dict *defined_symbols,
98 struct kxld_dict *vtables)
99 __attribute__((nonnull, visibility("hidden")));
100
101kern_return_t kxld_kext_relocate(KXLDKext *kext,
102 kxld_addr_t link_address,
103 struct kxld_dict *patched_vtables,
104 const struct kxld_dict *defined_symbols,
105 const struct kxld_dict *obsolete_symbols,
106 const struct kxld_dict *defined_cxx_symbols)
107__attribute__((nonnull(1,3,4), visibility("hidden")));
108
109
110#endif /* _KXLD_KEXT_H_ */
111