1//===-- Section.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 "lldb/Core/Section.h"
10#include "lldb/Core/Address.h"
11#include "lldb/Core/Module.h"
12#include "lldb/Symbol/ObjectFile.h"
13#include "lldb/Target/SectionLoadList.h"
14#include "lldb/Target/Target.h"
15#include "lldb/Utility/FileSpec.h"
16#include "lldb/Utility/VMRange.h"
17
18#include <inttypes.h>
19#include <limits>
20#include <utility>
21
22namespace lldb_private {
23class DataExtractor;
24}
25using namespace lldb;
26using namespace lldb_private;
27
28const char *Section::GetTypeAsCString() const {
29 switch (m_type) {
30 case eSectionTypeInvalid:
31 return "invalid";
32 case eSectionTypeCode:
33 return "code";
34 case eSectionTypeContainer:
35 return "container";
36 case eSectionTypeData:
37 return "data";
38 case eSectionTypeDataCString:
39 return "data-cstr";
40 case eSectionTypeDataCStringPointers:
41 return "data-cstr-ptr";
42 case eSectionTypeDataSymbolAddress:
43 return "data-symbol-addr";
44 case eSectionTypeData4:
45 return "data-4-byte";
46 case eSectionTypeData8:
47 return "data-8-byte";
48 case eSectionTypeData16:
49 return "data-16-byte";
50 case eSectionTypeDataPointers:
51 return "data-ptrs";
52 case eSectionTypeDebug:
53 return "debug";
54 case eSectionTypeZeroFill:
55 return "zero-fill";
56 case eSectionTypeDataObjCMessageRefs:
57 return "objc-message-refs";
58 case eSectionTypeDataObjCCFStrings:
59 return "objc-cfstrings";
60 case eSectionTypeDWARFDebugAbbrev:
61 return "dwarf-abbrev";
62 case eSectionTypeDWARFDebugAbbrevDwo:
63 return "dwarf-abbrev-dwo";
64 case eSectionTypeDWARFDebugAddr:
65 return "dwarf-addr";
66 case eSectionTypeDWARFDebugAranges:
67 return "dwarf-aranges";
68 case eSectionTypeDWARFDebugCuIndex:
69 return "dwarf-cu-index";
70 case eSectionTypeDWARFDebugTuIndex:
71 return "dwarf-tu-index";
72 case eSectionTypeDWARFDebugFrame:
73 return "dwarf-frame";
74 case eSectionTypeDWARFDebugInfo:
75 return "dwarf-info";
76 case eSectionTypeDWARFDebugInfoDwo:
77 return "dwarf-info-dwo";
78 case eSectionTypeDWARFDebugLine:
79 return "dwarf-line";
80 case eSectionTypeDWARFDebugLineStr:
81 return "dwarf-line-str";
82 case eSectionTypeDWARFDebugLoc:
83 return "dwarf-loc";
84 case eSectionTypeDWARFDebugLocDwo:
85 return "dwarf-loc-dwo";
86 case eSectionTypeDWARFDebugLocLists:
87 return "dwarf-loclists";
88 case eSectionTypeDWARFDebugLocListsDwo:
89 return "dwarf-loclists-dwo";
90 case eSectionTypeDWARFDebugMacInfo:
91 return "dwarf-macinfo";
92 case eSectionTypeDWARFDebugMacro:
93 return "dwarf-macro";
94 case eSectionTypeDWARFDebugPubNames:
95 return "dwarf-pubnames";
96 case eSectionTypeDWARFDebugPubTypes:
97 return "dwarf-pubtypes";
98 case eSectionTypeDWARFDebugRanges:
99 return "dwarf-ranges";
100 case eSectionTypeDWARFDebugRngLists:
101 return "dwarf-rnglists";
102 case eSectionTypeDWARFDebugRngListsDwo:
103 return "dwarf-rnglists-dwo";
104 case eSectionTypeDWARFDebugStr:
105 return "dwarf-str";
106 case eSectionTypeDWARFDebugStrDwo:
107 return "dwarf-str-dwo";
108 case eSectionTypeDWARFDebugStrOffsets:
109 return "dwarf-str-offsets";
110 case eSectionTypeDWARFDebugStrOffsetsDwo:
111 return "dwarf-str-offsets-dwo";
112 case eSectionTypeDWARFDebugTypes:
113 return "dwarf-types";
114 case eSectionTypeDWARFDebugTypesDwo:
115 return "dwarf-types-dwo";
116 case eSectionTypeDWARFDebugNames:
117 return "dwarf-names";
118 case eSectionTypeELFSymbolTable:
119 return "elf-symbol-table";
120 case eSectionTypeELFDynamicSymbols:
121 return "elf-dynamic-symbols";
122 case eSectionTypeELFRelocationEntries:
123 return "elf-relocation-entries";
124 case eSectionTypeELFDynamicLinkInfo:
125 return "elf-dynamic-link-info";
126 case eSectionTypeDWARFAppleNames:
127 return "apple-names";
128 case eSectionTypeDWARFAppleTypes:
129 return "apple-types";
130 case eSectionTypeDWARFAppleNamespaces:
131 return "apple-namespaces";
132 case eSectionTypeDWARFAppleObjC:
133 return "apple-objc";
134 case eSectionTypeEHFrame:
135 return "eh-frame";
136 case eSectionTypeARMexidx:
137 return "ARM.exidx";
138 case eSectionTypeARMextab:
139 return "ARM.extab";
140 case eSectionTypeCompactUnwind:
141 return "compact-unwind";
142 case eSectionTypeGoSymtab:
143 return "go-symtab";
144 case eSectionTypeAbsoluteAddress:
145 return "absolute";
146 case eSectionTypeDWARFGNUDebugAltLink:
147 return "dwarf-gnu-debugaltlink";
148 case eSectionTypeOther:
149 return "regular";
150 }
151 return "unknown";
152}
153
154Section::Section(const ModuleSP &module_sp, ObjectFile *obj_file,
155 user_id_t sect_id, ConstString name,
156 SectionType sect_type, addr_t file_addr, addr_t byte_size,
157 lldb::offset_t file_offset, lldb::offset_t file_size,
158 uint32_t log2align, uint32_t flags,
159 uint32_t target_byte_size /*=1*/)
160 : ModuleChild(module_sp), UserID(sect_id), Flags(flags),
161 m_obj_file(obj_file), m_type(sect_type), m_parent_wp(), m_name(name),
162 m_file_addr(file_addr), m_byte_size(byte_size),
163 m_file_offset(file_offset), m_file_size(file_size),
164 m_log2align(log2align), m_children(), m_fake(false), m_encrypted(false),
165 m_thread_specific(false), m_readable(false), m_writable(false),
166 m_executable(false), m_relocated(false), m_target_byte_size(target_byte_size) {
167 // printf ("Section::Section(%p): module=%p, sect_id = 0x%16.16" PRIx64 ",
168 // addr=[0x%16.16" PRIx64 " - 0x%16.16" PRIx64 "), file [0x%16.16" PRIx64 "
169 // - 0x%16.16" PRIx64 "), flags = 0x%8.8x, name = %s\n",
170 // this, module_sp.get(), sect_id, file_addr, file_addr +
171 // byte_size, file_offset, file_offset + file_size, flags,
172 // name.GetCString());
173}
174
175Section::Section(const lldb::SectionSP &parent_section_sp,
176 const ModuleSP &module_sp, ObjectFile *obj_file,
177 user_id_t sect_id, ConstString name,
178 SectionType sect_type, addr_t file_addr, addr_t byte_size,
179 lldb::offset_t file_offset, lldb::offset_t file_size,
180 uint32_t log2align, uint32_t flags,
181 uint32_t target_byte_size /*=1*/)
182 : ModuleChild(module_sp), UserID(sect_id), Flags(flags),
183 m_obj_file(obj_file), m_type(sect_type), m_parent_wp(), m_name(name),
184 m_file_addr(file_addr), m_byte_size(byte_size),
185 m_file_offset(file_offset), m_file_size(file_size),
186 m_log2align(log2align), m_children(), m_fake(false), m_encrypted(false),
187 m_thread_specific(false), m_readable(false), m_writable(false),
188 m_executable(false), m_relocated(false), m_target_byte_size(target_byte_size) {
189 // printf ("Section::Section(%p): module=%p, sect_id = 0x%16.16" PRIx64 ",
190 // addr=[0x%16.16" PRIx64 " - 0x%16.16" PRIx64 "), file [0x%16.16" PRIx64 "
191 // - 0x%16.16" PRIx64 "), flags = 0x%8.8x, name = %s.%s\n",
192 // this, module_sp.get(), sect_id, file_addr, file_addr +
193 // byte_size, file_offset, file_offset + file_size, flags,
194 // parent_section_sp->GetName().GetCString(), name.GetCString());
195 if (parent_section_sp)
196 m_parent_wp = parent_section_sp;
197}
198
199Section::~Section() {
200 // printf ("Section::~Section(%p)\n", this);
201}
202
203addr_t Section::GetFileAddress() const {
204 SectionSP parent_sp(GetParent());
205 if (parent_sp) {
206 // This section has a parent which means m_file_addr is an offset into the
207 // parent section, so the file address for this section is the file address
208 // of the parent plus the offset
209 return parent_sp->GetFileAddress() + m_file_addr;
210 }
211 // This section has no parent, so m_file_addr is the file base address
212 return m_file_addr;
213}
214
215bool Section::SetFileAddress(lldb::addr_t file_addr) {
216 SectionSP parent_sp(GetParent());
217 if (parent_sp) {
218 if (m_file_addr >= file_addr)
219 return parent_sp->SetFileAddress(m_file_addr - file_addr);
220 return false;
221 } else {
222 // This section has no parent, so m_file_addr is the file base address
223 m_file_addr = file_addr;
224 return true;
225 }
226}
227
228lldb::addr_t Section::GetOffset() const {
229 // This section has a parent which means m_file_addr is an offset.
230 SectionSP parent_sp(GetParent());
231 if (parent_sp)
232 return m_file_addr;
233
234 // This section has no parent, so there is no offset to be had
235 return 0;
236}
237
238addr_t Section::GetLoadBaseAddress(Target *target) const {
239 addr_t load_base_addr = LLDB_INVALID_ADDRESS;
240 SectionSP parent_sp(GetParent());
241 if (parent_sp) {
242 load_base_addr = parent_sp->GetLoadBaseAddress(target);
243 if (load_base_addr != LLDB_INVALID_ADDRESS)
244 load_base_addr += GetOffset();
245 }
246 if (load_base_addr == LLDB_INVALID_ADDRESS) {
247 load_base_addr = target->GetSectionLoadList().GetSectionLoadAddress(
248 const_cast<Section *>(this)->shared_from_this());
249 }
250 return load_base_addr;
251}
252
253bool Section::ResolveContainedAddress(addr_t offset, Address &so_addr,
254 bool allow_section_end) const {
255 const size_t num_children = m_children.GetSize();
256 for (size_t i = 0; i < num_children; i++) {
257 Section *child_section = m_children.GetSectionAtIndex(i).get();
258
259 addr_t child_offset = child_section->GetOffset();
260 if (child_offset <= offset &&
261 offset - child_offset <
262 child_section->GetByteSize() + (allow_section_end ? 1 : 0))
263 return child_section->ResolveContainedAddress(offset - child_offset,
264 so_addr, allow_section_end);
265 }
266 so_addr.SetOffset(offset);
267 so_addr.SetSection(const_cast<Section *>(this)->shared_from_this());
268
269 // Ensure that there are no orphaned (i.e., moduleless) sections.
270 assert(GetModule().get());
271 return true;
272}
273
274bool Section::ContainsFileAddress(addr_t vm_addr) const {
275 const addr_t file_addr = GetFileAddress();
276 if (file_addr != LLDB_INVALID_ADDRESS && !IsThreadSpecific()) {
277 if (file_addr <= vm_addr) {
278 const addr_t offset = (vm_addr - file_addr) * m_target_byte_size;
279 return offset < GetByteSize();
280 }
281 }
282 return false;
283}
284
285void Section::Dump(llvm::raw_ostream &s, unsigned indent, Target *target,
286 uint32_t depth) const {
287 s.indent(indent);
288 s << llvm::format("0x%8.8" PRIx64 " %-16s ", GetID(), GetTypeAsCString());
289 bool resolved = true;
290 addr_t addr = LLDB_INVALID_ADDRESS;
291
292 if (GetByteSize() == 0)
293 s.indent(39);
294 else {
295 if (target)
296 addr = GetLoadBaseAddress(target);
297
298 if (addr == LLDB_INVALID_ADDRESS) {
299 if (target)
300 resolved = false;
301 addr = GetFileAddress();
302 }
303
304 VMRange range(addr, addr + m_byte_size);
305 range.Dump(s, 0);
306 }
307
308 s << llvm::format("%c %c%c%c 0x%8.8" PRIx64 " 0x%8.8" PRIx64 " 0x%8.8x ",
309 resolved ? ' ' : '*', m_readable ? 'r' : '-',
310 m_writable ? 'w' : '-', m_executable ? 'x' : '-',
311 m_file_offset, m_file_size, Get());
312
313 DumpName(s);
314
315 s << "\n";
316
317 if (depth > 0)
318 m_children.Dump(s, indent, target, false, depth - 1);
319}
320
321void Section::DumpName(llvm::raw_ostream &s) const {
322 SectionSP parent_sp(GetParent());
323 if (parent_sp) {
324 parent_sp->DumpName(s);
325 s << '.';
326 } else {
327 // The top most section prints the module basename
328 const char *name = nullptr;
329 ModuleSP module_sp(GetModule());
330
331 if (m_obj_file) {
332 const FileSpec &file_spec = m_obj_file->GetFileSpec();
333 name = file_spec.GetFilename().AsCString();
334 }
335 if ((!name || !name[0]) && module_sp)
336 name = module_sp->GetFileSpec().GetFilename().AsCString();
337 if (name && name[0])
338 s << name << '.';
339 }
340 s << m_name;
341}
342
343bool Section::IsDescendant(const Section *section) {
344 if (this == section)
345 return true;
346 SectionSP parent_sp(GetParent());
347 if (parent_sp)
348 return parent_sp->IsDescendant(section);
349 return false;
350}
351
352bool Section::Slide(addr_t slide_amount, bool slide_children) {
353 if (m_file_addr != LLDB_INVALID_ADDRESS) {
354 if (slide_amount == 0)
355 return true;
356
357 m_file_addr += slide_amount;
358
359 if (slide_children)
360 m_children.Slide(slide_amount, slide_children);
361
362 return true;
363 }
364 return false;
365}
366
367/// Get the permissions as OR'ed bits from lldb::Permissions
368uint32_t Section::GetPermissions() const {
369 uint32_t permissions = 0;
370 if (m_readable)
371 permissions |= ePermissionsReadable;
372 if (m_writable)
373 permissions |= ePermissionsWritable;
374 if (m_executable)
375 permissions |= ePermissionsExecutable;
376 return permissions;
377}
378
379/// Set the permissions using bits OR'ed from lldb::Permissions
380void Section::SetPermissions(uint32_t permissions) {
381 m_readable = (permissions & ePermissionsReadable) != 0;
382 m_writable = (permissions & ePermissionsWritable) != 0;
383 m_executable = (permissions & ePermissionsExecutable) != 0;
384}
385
386lldb::offset_t Section::GetSectionData(void *dst, lldb::offset_t dst_len,
387 lldb::offset_t offset) {
388 if (m_obj_file)
389 return m_obj_file->ReadSectionData(this, offset, dst, dst_len);
390 return 0;
391}
392
393lldb::offset_t Section::GetSectionData(DataExtractor &section_data) {
394 if (m_obj_file)
395 return m_obj_file->ReadSectionData(this, section_data);
396 return 0;
397}
398
399#pragma mark SectionList
400
401SectionList &SectionList::operator=(const SectionList &rhs) {
402 if (this != &rhs)
403 m_sections = rhs.m_sections;
404 return *this;
405}
406
407size_t SectionList::AddSection(const lldb::SectionSP &section_sp) {
408 if (section_sp) {
409 size_t section_index = m_sections.size();
410 m_sections.push_back(section_sp);
411 return section_index;
412 }
413
414 return std::numeric_limits<size_t>::max();
415}
416
417// Warning, this can be slow as it's removing items from a std::vector.
418bool SectionList::DeleteSection(size_t idx) {
419 if (idx < m_sections.size()) {
420 m_sections.erase(m_sections.begin() + idx);
421 return true;
422 }
423 return false;
424}
425
426size_t SectionList::FindSectionIndex(const Section *sect) {
427 iterator sect_iter;
428 iterator begin = m_sections.begin();
429 iterator end = m_sections.end();
430 for (sect_iter = begin; sect_iter != end; ++sect_iter) {
431 if (sect_iter->get() == sect) {
432 // The secton was already in this section list
433 return std::distance(begin, sect_iter);
434 }
435 }
436 return UINT32_MAX;
437}
438
439size_t SectionList::AddUniqueSection(const lldb::SectionSP &sect_sp) {
440 size_t sect_idx = FindSectionIndex(sect_sp.get());
441 if (sect_idx == UINT32_MAX) {
442 sect_idx = AddSection(sect_sp);
443 }
444 return sect_idx;
445}
446
447bool SectionList::ReplaceSection(user_id_t sect_id,
448 const lldb::SectionSP &sect_sp,
449 uint32_t depth) {
450 iterator sect_iter, end = m_sections.end();
451 for (sect_iter = m_sections.begin(); sect_iter != end; ++sect_iter) {
452 if ((*sect_iter)->GetID() == sect_id) {
453 *sect_iter = sect_sp;
454 return true;
455 } else if (depth > 0) {
456 if ((*sect_iter)
457 ->GetChildren()
458 .ReplaceSection(sect_id, sect_sp, depth - 1))
459 return true;
460 }
461 }
462 return false;
463}
464
465size_t SectionList::GetNumSections(uint32_t depth) const {
466 size_t count = m_sections.size();
467 if (depth > 0) {
468 const_iterator sect_iter, end = m_sections.end();
469 for (sect_iter = m_sections.begin(); sect_iter != end; ++sect_iter) {
470 count += (*sect_iter)->GetChildren().GetNumSections(depth - 1);
471 }
472 }
473 return count;
474}
475
476SectionSP SectionList::GetSectionAtIndex(size_t idx) const {
477 SectionSP sect_sp;
478 if (idx < m_sections.size())
479 sect_sp = m_sections[idx];
480 return sect_sp;
481}
482
483SectionSP
484SectionList::FindSectionByName(ConstString section_dstr) const {
485 SectionSP sect_sp;
486 // Check if we have a valid section string
487 if (section_dstr && !m_sections.empty()) {
488 const_iterator sect_iter;
489 const_iterator end = m_sections.end();
490 for (sect_iter = m_sections.begin();
491 sect_iter != end && sect_sp.get() == nullptr; ++sect_iter) {
492 Section *child_section = sect_iter->get();
493 if (child_section) {
494 if (child_section->GetName() == section_dstr) {
495 sect_sp = *sect_iter;
496 } else {
497 sect_sp =
498 child_section->GetChildren().FindSectionByName(section_dstr);
499 }
500 }
501 }
502 }
503 return sect_sp;
504}
505
506SectionSP SectionList::FindSectionByID(user_id_t sect_id) const {
507 SectionSP sect_sp;
508 if (sect_id) {
509 const_iterator sect_iter;
510 const_iterator end = m_sections.end();
511 for (sect_iter = m_sections.begin();
512 sect_iter != end && sect_sp.get() == nullptr; ++sect_iter) {
513 if ((*sect_iter)->GetID() == sect_id) {
514 sect_sp = *sect_iter;
515 break;
516 } else {
517 sect_sp = (*sect_iter)->GetChildren().FindSectionByID(sect_id);
518 }
519 }
520 }
521 return sect_sp;
522}
523
524SectionSP SectionList::FindSectionByType(SectionType sect_type,
525 bool check_children,
526 size_t start_idx) const {
527 SectionSP sect_sp;
528 size_t num_sections = m_sections.size();
529 for (size_t idx = start_idx; idx < num_sections; ++idx) {
530 if (m_sections[idx]->GetType() == sect_type) {
531 sect_sp = m_sections[idx];
532 break;
533 } else if (check_children) {
534 sect_sp = m_sections[idx]->GetChildren().FindSectionByType(
535 sect_type, check_children, 0);
536 if (sect_sp)
537 break;
538 }
539 }
540 return sect_sp;
541}
542
543SectionSP SectionList::FindSectionContainingFileAddress(addr_t vm_addr,
544 uint32_t depth) const {
545 SectionSP sect_sp;
546 const_iterator sect_iter;
547 const_iterator end = m_sections.end();
548 for (sect_iter = m_sections.begin();
549 sect_iter != end && sect_sp.get() == nullptr; ++sect_iter) {
550 Section *sect = sect_iter->get();
551 if (sect->ContainsFileAddress(vm_addr)) {
552 // The file address is in this section. We need to make sure one of our
553 // child sections doesn't contain this address as well as obeying the
554 // depth limit that was passed in.
555 if (depth > 0)
556 sect_sp = sect->GetChildren().FindSectionContainingFileAddress(
557 vm_addr, depth - 1);
558
559 if (sect_sp.get() == nullptr && !sect->IsFake())
560 sect_sp = *sect_iter;
561 }
562 }
563 return sect_sp;
564}
565
566bool SectionList::ContainsSection(user_id_t sect_id) const {
567 return FindSectionByID(sect_id).get() != nullptr;
568}
569
570void SectionList::Dump(llvm::raw_ostream &s, unsigned indent, Target *target,
571 bool show_header, uint32_t depth) const {
572 bool target_has_loaded_sections =
573 target && !target->GetSectionLoadList().IsEmpty();
574 if (show_header && !m_sections.empty()) {
575 s.indent(indent);
576 s << llvm::formatv(
577 "SectID Type {0} Address "
578 " Perm File Off. File Size Flags "
579 " Section Name\n",
580 target_has_loaded_sections ? "Load" : "File");
581 s.indent(indent);
582 s << "---------- ---------------- "
583 "--------------------------------------- ---- ---------- "
584 "---------- "
585 "---------- ----------------------------\n";
586 }
587
588 for (const auto &section_sp : m_sections)
589 section_sp->Dump(s, indent, target_has_loaded_sections ? target : nullptr,
590 depth);
591}
592
593size_t SectionList::Slide(addr_t slide_amount, bool slide_children) {
594 size_t count = 0;
595 const_iterator pos, end = m_sections.end();
596 for (pos = m_sections.begin(); pos != end; ++pos) {
597 if ((*pos)->Slide(slide_amount, slide_children))
598 ++count;
599 }
600 return count;
601}
602