-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Expand file tree
/
Copy pathCorpseSymbol.h
More file actions
113 lines (96 loc) · 5.04 KB
/
Copy pathCorpseSymbol.h
File metadata and controls
113 lines (96 loc) · 5.04 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/*
* Copyright (C) 2026 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#if (OS(MACOS) || USE(APPLE_INTERNAL_SDK)) && !PLATFORM(MACCATALYST) && !PLATFORM(IOS_FAMILY_SIMULATOR)
#include <JavaScriptCore/CorpseAddress.h>
#include <mach/mach.h>
#include <stdint.h>
#include <string>
#include <string_view>
#include <wtf/TZoneMalloc.h>
// Enable for more detailed error messages on what may have caused a symbol lookup failure.
#define CORPSE_SYMBOL_LOOKUP_DIAGNOSTICS 0
namespace JSC {
namespace Corpse {
class Snapshot;
// A symbol looked up in a corpse by name. The lookup happens on construction.
//
// Only regular and absolute exports are read out of an image's trie. A re-export is
// skipped rather than followed, so a name that one image re-exports resolves in the
// image that defines it, as long as that image is loaded in the corpse. A
// thread-local is not found at all.
//
// A re-export may also rename, and then no image exports the name at all: memcpy
// exists only as libsystem_c's re-export of __platform_memmove from
// libsystem_platform, so a lookup of memcpy finds nothing while a lookup of
// __platform_memmove succeeds.
class Symbol {
WTF_MAKE_TZONE_ALLOCATED(Symbol);
public:
Symbol(const Snapshot&, const char* name);
const std::string& name() const { return m_name; }
Address address() const { return m_address; } // Null means not found.
bool isValid() const { return static_cast<bool>(m_address); }
private:
Address lookUpName(const Snapshot&);
Address resolveInImage(mach_port_t, Address loadAddress, std::string_view name);
bool hasReadBudget(size_t length);
#if CORPSE_SYMBOL_LOOKUP_DIAGNOSTICS
// How far a search got, so a failure can name the stage that fell short.
struct Diagnostics {
bool readDyldInfo { false };
Address allImageInfosAddress;
bool readAllImageInfos { false };
uint32_t version { 0 }; // dyld_all_image_infos::version.
Address rawImageArrayAddress; // As stored, possibly signed.
Address imageArrayAddress; // ...with any signature stripped.
unsigned images { 0 }; // Images dyld reported.
bool implausibleImageCount { false }; // ...but too many to be believed.
unsigned examined { 0 }; // ...whose Mach header we read.
unsigned inSharedCache { 0 }; // ...of those, in the shared cache.
unsigned unreadableInfo { 0 }; // dyld_image_info unreadable.
unsigned unreadableHeader { 0 }; // Header missing or not 64-bit.
unsigned implausibleCommandsSize { 0 }; // sizeofcmds too large to believe.
unsigned unreadableCommands { 0 }; // Load commands unreadable.
unsigned withoutTrie { 0 }; // No trie, or no __TEXT/__LINKEDIT.
unsigned implausibleTrieSize { 0 }; // Trie size too large to believe.
unsigned trieOutsideLinkedit { 0 }; // Trie not within __LINKEDIT.
unsigned unreadableTrie { 0 }; // Trie located but not readable.
unsigned readBudgetExhausted { 0 }; // Gave up: the lookup hit its read budget.
unsigned searched { 0 }; // Tries actually walked.
unsigned reExports { 0 }; // Matched, but re-exported.
unsigned unsupportedKind { 0 }; // Matched, but not an export kind with one address.
};
void reportFailure(const Snapshot&) const;
Diagnostics m_diagnostics;
#endif
std::string m_name;
Address m_address;
// What this lookup may still copy out of the corpse. Set when the search starts.
size_t m_readBudget { 0 };
};
} // namespace Corpse
} // namespace JSC
#endif // (OS(MACOS) || USE(APPLE_INTERNAL_SDK)) && !PLATFORM(MACCATALYST) && !PLATFORM(IOS_FAMILY_SIMULATOR)