1 //===-- NSException.cpp ---------------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8
9 #include "clang/AST/DeclCXX.h"
10
11 #include "Cocoa.h"
12
13 #include "lldb/Core/ValueObject.h"
14 #include "lldb/Core/ValueObjectConstResult.h"
15 #include "lldb/DataFormatters/FormattersHelpers.h"
16 #include "lldb/Target/ProcessStructReader.h"
17 #include "lldb/Target/Target.h"
18 #include "lldb/Utility/DataBufferHeap.h"
19 #include "lldb/Utility/Endian.h"
20 #include "lldb/Utility/Status.h"
21 #include "lldb/Utility/Stream.h"
22
23 #include "Plugins/Language/ObjC/NSString.h"
24 #include "Plugins/LanguageRuntime/ObjC/ObjCLanguageRuntime.h"
25 #include "Plugins/TypeSystem/Clang/TypeSystemClang.h"
26
27 using namespace lldb;
28 using namespace lldb_private;
29 using namespace lldb_private::formatters;
30
ExtractFields(ValueObject & valobj,ValueObjectSP * name_sp,ValueObjectSP * reason_sp,ValueObjectSP * userinfo_sp,ValueObjectSP * reserved_sp)31 static bool ExtractFields(ValueObject &valobj, ValueObjectSP *name_sp,
32 ValueObjectSP *reason_sp, ValueObjectSP *userinfo_sp,
33 ValueObjectSP *reserved_sp) {
34 ProcessSP process_sp(valobj.GetProcessSP());
35 if (!process_sp)
36 return false;
37
38 lldb::addr_t ptr = LLDB_INVALID_ADDRESS;
39
40 CompilerType valobj_type(valobj.GetCompilerType());
41 Flags type_flags(valobj_type.GetTypeInfo());
42 if (type_flags.AllClear(eTypeHasValue)) {
43 if (valobj.IsBaseClass() && valobj.GetParent())
44 ptr = valobj.GetParent()->GetValueAsUnsigned(LLDB_INVALID_ADDRESS);
45 } else {
46 ptr = valobj.GetValueAsUnsigned(LLDB_INVALID_ADDRESS);
47 }
48
49 if (ptr == LLDB_INVALID_ADDRESS)
50 return false;
51 size_t ptr_size = process_sp->GetAddressByteSize();
52
53 Status error;
54 auto name = process_sp->ReadPointerFromMemory(ptr + 1 * ptr_size, error);
55 if (error.Fail() || name == LLDB_INVALID_ADDRESS)
56 return false;
57 auto reason = process_sp->ReadPointerFromMemory(ptr + 2 * ptr_size, error);
58 if (error.Fail() || reason == LLDB_INVALID_ADDRESS)
59 return false;
60 auto userinfo = process_sp->ReadPointerFromMemory(ptr + 3 * ptr_size, error);
61 if (error.Fail() || userinfo == LLDB_INVALID_ADDRESS)
62 return false;
63 auto reserved = process_sp->ReadPointerFromMemory(ptr + 4 * ptr_size, error);
64 if (error.Fail() || reserved == LLDB_INVALID_ADDRESS)
65 return false;
66
67 InferiorSizedWord name_isw(name, *process_sp);
68 InferiorSizedWord reason_isw(reason, *process_sp);
69 InferiorSizedWord userinfo_isw(userinfo, *process_sp);
70 InferiorSizedWord reserved_isw(reserved, *process_sp);
71
72 auto *clang_ast_context =
73 ScratchTypeSystemClang::GetForTarget(process_sp->GetTarget());
74 if (!clang_ast_context)
75 return false;
76
77 CompilerType voidstar =
78 clang_ast_context->GetBasicType(lldb::eBasicTypeVoid).GetPointerType();
79
80 if (name_sp)
81 *name_sp = ValueObject::CreateValueObjectFromData(
82 "name", name_isw.GetAsData(process_sp->GetByteOrder()),
83 valobj.GetExecutionContextRef(), voidstar);
84 if (reason_sp)
85 *reason_sp = ValueObject::CreateValueObjectFromData(
86 "reason", reason_isw.GetAsData(process_sp->GetByteOrder()),
87 valobj.GetExecutionContextRef(), voidstar);
88 if (userinfo_sp)
89 *userinfo_sp = ValueObject::CreateValueObjectFromData(
90 "userInfo", userinfo_isw.GetAsData(process_sp->GetByteOrder()),
91 valobj.GetExecutionContextRef(), voidstar);
92 if (reserved_sp)
93 *reserved_sp = ValueObject::CreateValueObjectFromData(
94 "reserved", reserved_isw.GetAsData(process_sp->GetByteOrder()),
95 valobj.GetExecutionContextRef(), voidstar);
96
97 return true;
98 }
99
NSException_SummaryProvider(ValueObject & valobj,Stream & stream,const TypeSummaryOptions & options)100 bool lldb_private::formatters::NSException_SummaryProvider(
101 ValueObject &valobj, Stream &stream, const TypeSummaryOptions &options) {
102 lldb::ValueObjectSP reason_sp;
103 if (!ExtractFields(valobj, nullptr, &reason_sp, nullptr, nullptr))
104 return false;
105
106 if (!reason_sp) {
107 stream.Printf("No reason");
108 return false;
109 }
110
111 StreamString reason_str_summary;
112 if (NSStringSummaryProvider(*reason_sp, reason_str_summary, options) &&
113 !reason_str_summary.Empty()) {
114 stream.Printf("%s", reason_str_summary.GetData());
115 return true;
116 } else
117 return false;
118 }
119
120 class NSExceptionSyntheticFrontEnd : public SyntheticChildrenFrontEnd {
121 public:
NSExceptionSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp)122 NSExceptionSyntheticFrontEnd(lldb::ValueObjectSP valobj_sp)
123 : SyntheticChildrenFrontEnd(*valobj_sp) {}
124
125 ~NSExceptionSyntheticFrontEnd() override = default;
126
CalculateNumChildren()127 size_t CalculateNumChildren() override {
128 return 4;
129 }
130
GetChildAtIndex(size_t idx)131 lldb::ValueObjectSP GetChildAtIndex(size_t idx) override {
132 switch (idx) {
133 case 0: return m_name_sp;
134 case 1: return m_reason_sp;
135 case 2: return m_userinfo_sp;
136 case 3: return m_reserved_sp;
137 }
138 return lldb::ValueObjectSP();
139 }
140
Update()141 bool Update() override {
142 m_name_sp.reset();
143 m_reason_sp.reset();
144 m_userinfo_sp.reset();
145 m_reserved_sp.reset();
146
147 return ExtractFields(m_backend, &m_name_sp, &m_reason_sp, &m_userinfo_sp,
148 &m_reserved_sp);
149 }
150
MightHaveChildren()151 bool MightHaveChildren() override { return true; }
152
GetIndexOfChildWithName(ConstString name)153 size_t GetIndexOfChildWithName(ConstString name) override {
154 // NSException has 4 members:
155 // NSString *name;
156 // NSString *reason;
157 // NSDictionary *userInfo;
158 // id reserved;
159 static ConstString g___name("name");
160 static ConstString g___reason("reason");
161 static ConstString g___userInfo("userInfo");
162 static ConstString g___reserved("reserved");
163 if (name == g___name) return 0;
164 if (name == g___reason) return 1;
165 if (name == g___userInfo) return 2;
166 if (name == g___reserved) return 3;
167 return UINT32_MAX;
168 }
169
170 private:
171 ValueObjectSP m_name_sp;
172 ValueObjectSP m_reason_sp;
173 ValueObjectSP m_userinfo_sp;
174 ValueObjectSP m_reserved_sp;
175 };
176
177 SyntheticChildrenFrontEnd *
NSExceptionSyntheticFrontEndCreator(CXXSyntheticChildren *,lldb::ValueObjectSP valobj_sp)178 lldb_private::formatters::NSExceptionSyntheticFrontEndCreator(
179 CXXSyntheticChildren *, lldb::ValueObjectSP valobj_sp) {
180 lldb::ProcessSP process_sp(valobj_sp->GetProcessSP());
181 if (!process_sp)
182 return nullptr;
183 ObjCLanguageRuntime *runtime = ObjCLanguageRuntime::Get(*process_sp);
184 if (!runtime)
185 return nullptr;
186
187 ObjCLanguageRuntime::ClassDescriptorSP descriptor(
188 runtime->GetClassDescriptor(*valobj_sp.get()));
189
190 if (!descriptor.get() || !descriptor->IsValid())
191 return nullptr;
192
193 const char *class_name = descriptor->GetClassName().GetCString();
194
195 if (!class_name || !*class_name)
196 return nullptr;
197
198 if (!strcmp(class_name, "NSException"))
199 return (new NSExceptionSyntheticFrontEnd(valobj_sp));
200 else if (!strcmp(class_name, "NSCFException"))
201 return (new NSExceptionSyntheticFrontEnd(valobj_sp));
202 else if (!strcmp(class_name, "__NSCFException"))
203 return (new NSExceptionSyntheticFrontEnd(valobj_sp));
204
205 return nullptr;
206 }
207