forked from google/bloaty
-
Notifications
You must be signed in to change notification settings - Fork 0
/
elf.cc
1431 lines (1227 loc) · 45.6 KB
/
elf.cc
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2016 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <algorithm>
#include <string>
#include <iostream>
#include "absl/numeric/int128.h"
#include "absl/strings/escaping.h"
#include "absl/strings/string_view.h"
#include "absl/strings/substitute.h"
#include "third_party/freebsd_elf/elf.h"
#include "bloaty.h"
#include "util.h"
#include <assert.h>
#include <limits.h>
#include <stdlib.h>
using absl::string_view;
namespace bloaty {
namespace {
struct ByteSwapFunc {
template <class T>
T operator()(T val) {
return ByteSwap(val);
}
};
struct NullFunc {
template <class T>
T operator()(T val) { return val; }
};
size_t StringViewToSize(string_view str) {
size_t ret;
if (!absl::SimpleAtoi(str, &ret)) {
THROWF("couldn't convert string '$0' to integer.", str);
}
return ret;
}
template <class T>
void AdvancePastStruct(string_view* data) {
*data = data->substr(sizeof(T));
}
// ElfFile /////////////////////////////////////////////////////////////////////
// For parsing the pieces we need out of an ELF file (.o, .so, and binaries).
class ElfFile {
public:
ElfFile(string_view data) : data_(data) {
ok_ = Initialize();
}
bool IsOpen() { return ok_; }
// Regions of the file where different headers live.
string_view entire_file() const { return data_; }
string_view header_region() const { return header_region_; }
string_view section_headers() const { return section_headers_; }
string_view segment_headers() const { return segment_headers_; }
const Elf64_Ehdr& header() const { return header_; }
Elf64_Xword section_count() const { return section_count_; }
Elf64_Xword section_string_index() const { return section_string_index_; }
// Represents an ELF segment (data used by the loader / dynamic linker).
class Segment {
public:
const Elf64_Phdr& header() const { return header_; }
string_view contents() const { return contents_; }
string_view range() const { return range_; }
private:
friend class ElfFile;
Elf64_Phdr header_;
string_view contents_;
string_view range_;
};
// Represents an ELF section (.text, .data, .bss, etc.)
class Section {
public:
const Elf64_Shdr& header() const { return header_; }
string_view contents() const { return contents_; }
string_view range() const { return range_; }
// For SHN_UNDEF (undefined name), returns [nullptr, 0].
string_view GetName() const;
// Requires: this is a section with fixed-width entries (symbol table,
// relocation table, etc).
Elf64_Word GetEntryCount() const;
// Requires: header().sh_type == SHT_STRTAB.
string_view ReadString(Elf64_Word index) const;
// Requires: header().sh_type == SHT_SYMTAB || header().sh_type ==
// SHT_DYNSYM
void ReadSymbol(Elf64_Word index, Elf64_Sym* sym,
string_view* file_range) const;
// Requires: header().sh_type == SHT_REL
void ReadRelocation(Elf64_Word index, Elf64_Rel* rel,
string_view* file_range) const;
// Requires: header().sh_type == SHT_RELA
void ReadRelocationWithAddend(Elf64_Word index, Elf64_Rela* rel,
string_view* file_range) const;
const ElfFile& elf() const { return *elf_; }
private:
friend class ElfFile;
const ElfFile* elf_;
Elf64_Shdr header_;
string_view contents_;
string_view range_;
};
class NoteIter {
public:
NoteIter(const Section& section)
: elf_(§ion.elf()), remaining_(section.contents()) {
Next();
}
bool IsDone() const { return done_; }
uint32_t type() const { return type_; }
string_view name() const { return name_; }
string_view descriptor() const { return descriptor_; }
void Next();
public:
const ElfFile* elf_;
string_view name_;
string_view descriptor_;
string_view remaining_;
uint32_t type_;
bool done_ = false;
};
void ReadSegment(Elf64_Word index, Segment* segment) const;
void ReadSection(Elf64_Word index, Section* section) const;
bool FindSectionByName(absl::string_view name, Section* section) const;
bool is_64bit() const { return is_64bit_; }
bool is_native_endian() const { return is_native_endian_; }
template <class T32, class T64, class Munger>
void ReadStruct(absl::string_view contents, uint64_t offset, Munger munger,
absl::string_view* range, T64* out) const {
StructReader(*this, contents).Read<T32>(offset, munger, range, out);
}
private:
friend class Section;
bool Initialize();
string_view GetRegion(uint64_t start, uint64_t n) const {
return StrictSubstr(data_, start, n);
}
// Shared code for reading various ELF structures. Handles endianness
// conversion and 32->64 bit conversion, when necessary.
class StructReader {
public:
StructReader(const ElfFile& elf, string_view data)
: elf_(elf), data_(data) {}
template <class T32, class T64, class Munger>
void Read(uint64_t offset, Munger /*munger*/, absl::string_view* range,
T64* out) const {
if (elf_.is_64bit() && elf_.is_native_endian()) {
return Memcpy(offset, range, out);
} else {
return ReadFallback<T32, T64, Munger>(offset, range, out);
}
}
private:
const ElfFile& elf_;
string_view data_;
template <class T32, class T64, class Munger>
void ReadFallback(uint64_t offset, absl::string_view* range,
T64* out) const;
template <class T>
void Memcpy(uint64_t offset, absl::string_view* out_range, T* out) const {
absl::string_view range = StrictSubstr(data_, offset, sizeof(*out));
if (out_range) {
*out_range = range;
}
memcpy(out, data_.data() + offset, sizeof(*out));
}
};
bool ok_;
bool is_64bit_;
bool is_native_endian_;
string_view data_;
Elf64_Ehdr header_;
Elf64_Xword section_count_;
Elf64_Xword section_string_index_;
string_view header_region_;
string_view section_headers_;
string_view segment_headers_;
Section section_name_table_;
};
// ELF uses different structure definitions for 32/64 bit files. The sizes of
// members are different, and members are even in a different order!
//
// These mungers can convert 32 bit structures to 64-bit ones. They can also
// handle converting endianness. We use templates so a single template function
// can handle all three patterns:
//
// 32 native -> 64 native
// 32 swapped -> 64 native
// 64 swapped -> 64 native
struct EhdrMunger {
template <class From, class Func>
void operator()(const From& from, Elf64_Ehdr* to, Func func) {
memmove(&to->e_ident[0], &from.e_ident[0], EI_NIDENT);
to->e_type = func(from.e_type);
to->e_machine = func(from.e_machine);
to->e_version = func(from.e_version);
to->e_entry = func(from.e_entry);
to->e_phoff = func(from.e_phoff);
to->e_shoff = func(from.e_shoff);
to->e_flags = func(from.e_flags);
to->e_ehsize = func(from.e_ehsize);
to->e_phentsize = func(from.e_phentsize);
to->e_phnum = func(from.e_phnum);
to->e_shentsize = func(from.e_shentsize);
to->e_shnum = func(from.e_shnum);
to->e_shstrndx = func(from.e_shstrndx);
}
};
struct ShdrMunger {
template <class From, class Func>
void operator()(const From& from, Elf64_Shdr* to, Func func) {
to->sh_name = func(from.sh_name);
to->sh_type = func(from.sh_type);
to->sh_flags = func(from.sh_flags);
to->sh_addr = func(from.sh_addr);
to->sh_offset = func(from.sh_offset);
to->sh_size = func(from.sh_size);
to->sh_link = func(from.sh_link);
to->sh_info = func(from.sh_info);
to->sh_addralign = func(from.sh_addralign);
to->sh_entsize = func(from.sh_entsize);
}
};
struct PhdrMunger {
template <class From, class Func>
void operator()(const From& from, Elf64_Phdr* to, Func func) {
to->p_type = func(from.p_type);
to->p_flags = func(from.p_flags);
to->p_offset = func(from.p_offset);
to->p_vaddr = func(from.p_vaddr);
to->p_paddr = func(from.p_paddr);
to->p_filesz = func(from.p_filesz);
to->p_memsz = func(from.p_memsz);
to->p_align = func(from.p_align);
}
};
struct SymMunger {
template <class From, class Func>
void operator()(const From& from, Elf64_Sym* to, Func func) {
to->st_name = func(from.st_name);
to->st_info = func(from.st_info);
to->st_other = func(from.st_other);
to->st_shndx = func(from.st_shndx);
to->st_value = func(from.st_value);
to->st_size = func(from.st_size);
}
};
struct RelMunger {
template <class From, class Func>
void operator()(const From& from, Elf64_Rel* to, Func func) {
to->r_offset = func(from.r_offset);
to->r_info = func(from.r_info);
}
};
struct RelaMunger {
template <class From, class Func>
void operator()(const From& from, Elf64_Rela* to, Func func) {
to->r_offset = func(from.r_offset);
to->r_info = func(from.r_info);
to->r_addend = func(from.r_addend);
}
};
struct NoteMunger {
template <class From, class Func>
void operator()(const From& from, Elf64_Nhdr* to, Func func) {
to->n_namesz = func(from.n_namesz);
to->n_descsz = func(from.n_descsz);
to->n_type = func(from.n_type);
}
};
struct ChdrMunger {
template <class From, class Func>
void operator()(const From& from, Elf64_Chdr* to, Func func) {
to->ch_type = func(from.ch_type);
to->ch_size = func(from.ch_size);
to->ch_addralign = func(from.ch_addralign);
}
};
template <class T32, class T64, class Munger>
void ElfFile::StructReader::ReadFallback(uint64_t offset,
absl::string_view* range,
T64* out) const {
// Fallback for either 32-bit ELF file or non-native endian.
if (elf_.is_64bit()) {
assert(!elf_.is_native_endian());
Memcpy(offset, range, out);
Munger()(*out, out, ByteSwapFunc());
} else {
T32 data32;
Memcpy(offset, range, &data32);
if (elf_.is_native_endian()) {
Munger()(data32, out, NullFunc());
} else {
Munger()(data32, out, ByteSwapFunc());
}
}
}
string_view ElfFile::Section::GetName() const {
if (header_.sh_name == SHN_UNDEF) {
return string_view(nullptr, 0);
}
return elf_->section_name_table_.ReadString(header_.sh_name);
}
string_view ElfFile::Section::ReadString(Elf64_Word index) const {
assert(header().sh_type == SHT_STRTAB);
if (index == SHN_UNDEF || index >= contents_.size()) {
THROWF("can't read index $0 from strtab, total size is $1", index,
contents_.size());
}
string_view ret = StrictSubstr(contents_, index);
const char* null_pos =
static_cast<const char*>(memchr(ret.data(), '\0', ret.size()));
if (null_pos == NULL) {
THROW("no NULL terminator found");
}
size_t len = null_pos - ret.data();
ret = ret.substr(0, len);
return ret;
}
Elf64_Word ElfFile::Section::GetEntryCount() const {
if (header_.sh_entsize == 0) {
THROW("sh_entsize is zero");
}
return contents_.size() / header_.sh_entsize;
}
void ElfFile::Section::ReadSymbol(Elf64_Word index, Elf64_Sym* sym,
string_view* file_range) const {
assert(header().sh_type == SHT_SYMTAB || header().sh_type == SHT_DYNSYM);
size_t offset = header_.sh_entsize * index;
elf_->ReadStruct<Elf32_Sym>(contents(), offset, SymMunger(), file_range, sym);
}
void ElfFile::Section::ReadRelocation(Elf64_Word index, Elf64_Rel* rel,
string_view* file_range) const {
assert(header().sh_type == SHT_REL);
size_t offset = header_.sh_entsize * index;
elf_->ReadStruct<Elf32_Rel>(contents(), offset, RelMunger(), file_range, rel);
}
void ElfFile::Section::ReadRelocationWithAddend(Elf64_Word index,
Elf64_Rela* rela,
string_view* file_range) const {
assert(header().sh_type == SHT_RELA);
size_t offset = header_.sh_entsize * index;
elf_->ReadStruct<Elf32_Rela>(contents(), offset, RelaMunger(), file_range,
rela);
}
void ElfFile::NoteIter::Next() {
if (remaining_.empty()) {
done_ = true;
return;
}
Elf_Note note;
elf_->ReadStruct<Elf_Note>(remaining_, 0, NoteMunger(), nullptr, ¬e);
// 32-bit and 64-bit note are the same size, so we don't have to treat
// them separately when advancing.
AdvancePastStruct<Elf_Note>(&remaining_);
type_ = note.n_type;
name_ = StrictSubstr(remaining_, 0, note.n_namesz);
// Size might include NULL terminator.
if (name_[name_.size() - 1] == 0) {
name_ = name_.substr(0, name_.size() - 1);
}
remaining_ = StrictSubstr(remaining_, AlignUp(note.n_namesz, 4));
descriptor_ = StrictSubstr(remaining_, 0, note.n_descsz);
remaining_ = StrictSubstr(remaining_, AlignUp(note.n_descsz, 4));
}
bool ElfFile::Initialize() {
if (data_.size() < EI_NIDENT) {
return false;
}
unsigned char ident[EI_NIDENT];
memcpy(ident, data_.data(), EI_NIDENT);
if (memcmp(ident, "\177ELF", 4) != 0) {
// Not an ELF file.
return false;
}
switch (ident[EI_CLASS]) {
case ELFCLASS32:
is_64bit_ = false;
break;
case ELFCLASS64:
is_64bit_ = true;
break;
default:
THROWF("unexpected ELF class: $0", ident[EI_CLASS]);
}
switch (ident[EI_DATA]) {
case ELFDATA2LSB:
is_native_endian_ = GetMachineEndian() == Endian::kLittle;
break;
case ELFDATA2MSB:
is_native_endian_ = GetMachineEndian() == Endian::kBig;
break;
default:
THROWF("unexpected ELF data: $0", ident[EI_DATA]);
}
absl::string_view range;
ReadStruct<Elf32_Ehdr>(entire_file(), 0, EhdrMunger(), &range, &header_);
Section section0;
bool has_section0 = 0;
// ELF extensions: if certain fields overflow, we have to find their true data
// from elsewhere. For more info see:
// https://docs.oracle.com/cd/E19683-01/817-3677/chapter6-94076/index.html
if (header_.e_shoff > 0 &&
data_.size() > (header_.e_shoff + header_.e_shentsize)) {
section_count_ = 1;
ReadSection(0, §ion0);
has_section0 = true;
}
section_count_ = header_.e_shnum;
section_string_index_ = header_.e_shstrndx;
if (section_count_ == 0 && has_section0) {
section_count_ = section0.header().sh_size;
}
if (section_string_index_ == SHN_XINDEX && has_section0) {
section_string_index_ = section0.header().sh_link;
}
header_region_ = GetRegion(0, header_.e_ehsize);
section_headers_ = GetRegion(header_.e_shoff,
CheckedMul(header_.e_shentsize, section_count_));
segment_headers_ = GetRegion(
header_.e_phoff, CheckedMul(header_.e_phentsize, header_.e_phnum));
if (section_count_ > 0) {
ReadSection(section_string_index_, §ion_name_table_);
if (section_name_table_.header().sh_type != SHT_STRTAB) {
THROW("section string index pointed to non-strtab");
}
}
return true;
}
void ElfFile::ReadSegment(Elf64_Word index, Segment* segment) const {
if (index >= header_.e_phnum) {
THROWF("segment $0 doesn't exist, only $1 segments", index,
header_.e_phnum);
}
Elf64_Phdr* header = &segment->header_;
ReadStruct<Elf32_Phdr>(
entire_file(),
CheckedAdd(header_.e_phoff, CheckedMul(header_.e_phentsize, index)),
PhdrMunger(), &segment->range_, header);
segment->contents_ = GetRegion(header->p_offset, header->p_filesz);
}
void ElfFile::ReadSection(Elf64_Word index, Section* section) const {
if (index >= section_count_) {
THROWF("tried to read section $0, but there are only $1", index,
section_count_);
}
Elf64_Shdr* header = §ion->header_;
ReadStruct<Elf32_Shdr>(
entire_file(),
CheckedAdd(header_.e_shoff, CheckedMul(header_.e_shentsize, index)),
ShdrMunger(), §ion->range_, header);
if (header->sh_type == SHT_NOBITS) {
section->contents_ = string_view();
} else {
section->contents_ = GetRegion(header->sh_offset, header->sh_size);
}
section->elf_ = this;
}
bool ElfFile::FindSectionByName(absl::string_view name, Section* section) const {
for (Elf64_Word i = 0; i < section_count_; i++) {
ReadSection(i, section);
if (section->GetName() == name) {
return true;
}
}
return false;
}
// ArFile //////////////////////////////////////////////////////////////////////
// For parsing .a files (static libraries).
//
// The best documentation I've been able to find for this file format is
// Wikipedia: https://en.wikipedia.org/wiki/Ar_(Unix)
//
// So far we only parse the System V / GNU variant.
class ArFile {
public:
ArFile(string_view data)
: magic_(StrictSubstr(data, 0, kMagicSize)),
contents_(data.substr(std::min<size_t>(data.size(), kMagicSize))) {}
bool IsOpen() const { return magic() == string_view(kMagic); }
string_view magic() const { return magic_; }
string_view contents() const { return contents_; }
struct MemberFile {
enum {
kSymbolTable, // Stores a symbol table.
kLongFilenameTable, // Stores long filenames, users should ignore.
kNormal, // Regular data file.
} file_type;
string_view filename; // Only when file_type == kNormal
size_t size;
string_view header;
string_view contents;
};
class MemberReader {
public:
MemberReader(const ArFile& ar) : remaining_(ar.contents()) {}
bool ReadMember(MemberFile* file);
bool IsEof() const { return remaining_.size() == 0; }
private:
string_view Consume(size_t n) {
n = (n % 2 == 0 ? n : n + 1);
if (remaining_.size() < n) {
THROW("premature end of file");
}
string_view ret = remaining_.substr(0, n);
remaining_.remove_prefix(n);
return ret;
}
string_view long_filenames_;
string_view remaining_;
};
private:
const string_view magic_;
const string_view contents_;
static constexpr const char* kMagic = "!<arch>\n";
static constexpr int kMagicSize = 8;
};
bool ArFile::MemberReader::ReadMember(MemberFile* file) {
struct Header {
char file_id[16];
char modified_timestamp[12];
char owner_id[6];
char group_id[6];
char mode[8];
char size[10];
char end[2];
};
if (remaining_.size() == 0) {
return false;
} else if (remaining_.size() < sizeof(Header)) {
THROW("Premature EOF in AR data");
}
const Header* header = reinterpret_cast<const Header*>(remaining_.data());
file->header = Consume(sizeof(Header));
string_view file_id(&header->file_id[0], sizeof(header->file_id));
string_view size_str(&header->size[0], sizeof(header->size));
file->size = StringViewToSize(size_str);
file->contents = Consume(file->size);
file->file_type = MemberFile::kNormal;
if (file_id[0] == '/') {
// Special filename, internal to the format.
if (file_id[1] == ' ') {
file->file_type = MemberFile::kSymbolTable;
} else if (file_id[1] == '/') {
file->file_type = MemberFile::kLongFilenameTable;
long_filenames_ = file->contents;
} else if (isdigit(file_id[1])) {
size_t offset = StringViewToSize(file_id.substr(1));
size_t end = long_filenames_.find('/', offset);
if (end == std::string::npos) {
THROW("Unterminated long filename");
}
file->filename = long_filenames_.substr(offset, end - offset);
} else {
THROW("Unexpected special filename in AR archive");
}
} else {
// Normal filename, slash-terminated.
size_t slash = file_id.find('/');
if (slash == std::string::npos) {
THROW("BSD-style AR not yet implemented");
}
file->filename = file_id.substr(0, slash);
}
return true;
}
void MaybeAddFileRange(const char* analyzer, RangeSink* sink, string_view label,
string_view range) {
if (sink) {
sink->AddFileRange(analyzer, label, range);
}
}
// Iterate over each ELF file, agnostic to whether it is inside a .a (AR) file
// or not.
template <class Func>
void ForEachElf(const InputFile& file, RangeSink* sink, Func func) {
ArFile ar_file(file.data());
uint64_t index_base = 0;
if (ar_file.IsOpen()) {
ArFile::MemberFile member;
ArFile::MemberReader reader(ar_file);
MaybeAddFileRange("ar_archive", sink, "[AR Headers]", ar_file.magic());
while (reader.ReadMember(&member)) {
MaybeAddFileRange("ar_archive", sink, "[AR Headers]", member.header);
switch (member.file_type) {
case ArFile::MemberFile::kNormal: {
ElfFile elf(member.contents);
if (elf.IsOpen()) {
func(elf, member.filename, index_base);
index_base += elf.section_count();
} else {
MaybeAddFileRange("ar_archive", sink, "[AR Non-ELF Member File]",
member.contents);
}
break;
}
case ArFile::MemberFile::kSymbolTable:
MaybeAddFileRange("ar_archive", sink, "[AR Symbol Table]",
member.contents);
break;
case ArFile::MemberFile::kLongFilenameTable:
MaybeAddFileRange("ar_archive", sink, "[AR Headers]",
member.contents);
break;
}
}
} else {
ElfFile elf(file.data());
if (!elf.IsOpen()) {
THROWF("Not an ELF or Archive file: $0", file.filename());
}
func(elf, file.filename(), index_base);
}
}
// For object files, addresses are relative to the section they live in, which
// is indicated by ndx. We split this into:
//
// - 24 bits for index (up to 16M symbols with -ffunction-sections)
// - 40 bits for address (up to 1TB section)
static uint64_t ToVMAddr(uint64_t addr, uint64_t ndx, bool is_object) {
if (is_object) {
if (ndx >= 1 << 24) {
THROW("ndx overflow: too many sections");
}
if (addr >= ((uint64_t)1) << 40) {
THROW("address overflow: section too big");
}
return (ndx << 40) | addr;
} else {
return addr;
}
}
static bool IsArchiveFile(string_view data) {
ArFile ar(data);
return ar.IsOpen();
}
static bool IsObjectFile(string_view data) {
ElfFile elf(data);
return IsArchiveFile(data) || (elf.IsOpen() && elf.header().e_type == ET_REL);
}
static void CheckNotObject(const char* source, RangeSink* sink) {
if (IsObjectFile(sink->input_file().data())) {
THROWF(
"can't use data source '$0' on object files (only binaries and shared "
"libraries)",
source);
}
}
static bool ElfMachineToCapstone(Elf64_Half e_machine, cs_arch* arch,
cs_mode* mode) {
switch (e_machine) {
case EM_386:
*arch = CS_ARCH_X86;
*mode = CS_MODE_32;
return true;
case EM_X86_64:
*arch = CS_ARCH_X86;
*mode = CS_MODE_64;
return true;
// These aren't tested, but we include them on the off-chance
// that it will work.
case EM_ARM:
*arch = CS_ARCH_ARM;
*mode = CS_MODE_LITTLE_ENDIAN;
return true;
case EM_AARCH64:
*arch = CS_ARCH_ARM64;
*mode = CS_MODE_ARM;
return true;
case EM_MIPS:
*arch = CS_ARCH_MIPS;
return true;
case EM_PPC:
*arch = CS_ARCH_PPC;
*mode = CS_MODE_32;
return true;
case EM_PPC64:
*arch = CS_ARCH_PPC;
*mode = CS_MODE_64;
return true;
case EM_SPARC:
*arch = CS_ARCH_SPARC;
*mode = CS_MODE_BIG_ENDIAN;
return true;
case EM_SPARCV9:
*arch = CS_ARCH_SPARC;
*mode = CS_MODE_V9;
return true;
default:
if (verbose_level > 1) {
printf(
"Unable to map to capstone target, disassembly will be "
"unavailable");
}
return false;
}
}
static bool ReadElfArchMode(const InputFile& file, cs_arch* arch, cs_mode* mode) {
bool capstone_available = true;
ForEachElf(file, nullptr,
[&capstone_available, arch, mode](const ElfFile& elf,
string_view /*filename*/,
uint32_t /*index_base*/) {
// Last .o file wins? (For .a files)? It's kind of arbitrary,
// but a single .a file shouldn't have multiple archs in it.
capstone_available &=
ElfMachineToCapstone(elf.header().e_machine, arch, mode);
});
return capstone_available;
}
static void ReadELFSymbols(const InputFile& file, RangeSink* sink,
SymbolTable* table, bool disassemble) {
bool is_object = IsObjectFile(file.data());
DisassemblyInfo info;
DisassemblyInfo* infop = &info;
bool capstone_available = ReadElfArchMode(file, &info.arch, &info.mode);
ForEachElf(
file, sink,
[=](const ElfFile& elf, string_view /*filename*/, uint64_t index_base) {
for (Elf64_Xword i = 1; i < elf.section_count(); i++) {
ElfFile::Section section;
elf.ReadSection(i, §ion);
if (section.header().sh_type != SHT_SYMTAB) {
continue;
}
Elf64_Word symbol_count = section.GetEntryCount();
// Find the corresponding section where the strings for the symbol
// table can be found.
ElfFile::Section strtab_section;
elf.ReadSection(section.header().sh_link, &strtab_section);
if (strtab_section.header().sh_type != SHT_STRTAB) {
THROW("symtab section pointed to non-strtab section");
}
for (Elf64_Word i = 1; i < symbol_count; i++) {
Elf64_Sym sym;
section.ReadSymbol(i, &sym, nullptr);
if (ELF64_ST_TYPE(sym.st_info) == STT_SECTION) {
continue;
}
if (sym.st_shndx == STN_UNDEF) {
continue;
}
if (sym.st_size == 0) {
// Maybe try to refine? See ReadELFSectionsRefineSymbols below.
continue;
}
string_view name = strtab_section.ReadString(sym.st_name);
uint64_t full_addr =
ToVMAddr(sym.st_value, index_base + sym.st_shndx, is_object);
if (sink && !(capstone_available && disassemble)) {
sink->AddVMRangeAllowAlias(
"elf_symbols", full_addr, sym.st_size,
ItaniumDemangle(name, sink->data_source()));
}
if (table) {
table->insert(
std::make_pair(name, std::make_pair(full_addr, sym.st_size)));
}
if (capstone_available && disassemble &&
ELF64_ST_TYPE(sym.st_info) == STT_FUNC) {
if (verbose_level > 1) {
printf("Disassembling function: %s\n", name.data());
}
// TODO(brandonvu) Continue if VM pointer cannot be translated. Issue #315
uint64_t unused;
if (!sink->Translator()->vm_map.Translate(full_addr, &unused)) {
WARN("Can't translate VM pointer ($0) to file", full_addr);
continue;
}
infop->text = sink->TranslateVMToFile(full_addr).substr(0, sym.st_size);
infop->start_address = full_addr;
DisassembleFindReferences(*infop, sink);
}
}
}
});
}
static void ReadELFSymbolTableEntries(const ElfFile& elf,
const ElfFile::Section& section,
uint64_t index_base, bool is_object,
RangeSink* sink) {
Elf64_Word symbol_count = section.GetEntryCount();
// Find the corresponding section where the strings for the symbol
// table can be found.
ElfFile::Section strtab_section;
elf.ReadSection(section.header().sh_link, &strtab_section);
if (strtab_section.header().sh_type != SHT_STRTAB) {
THROW("symtab section pointed to non-strtab section");
}
for (Elf64_Word i = 1; i < symbol_count; i++) {
Elf64_Sym sym;
string_view sym_range;
section.ReadSymbol(i, &sym, &sym_range);
if (ELF64_ST_TYPE(sym.st_info) == STT_SECTION ||
sym.st_shndx == STN_UNDEF ||
sym.st_name == SHN_UNDEF) {
continue;
}
string_view name = strtab_section.ReadString(sym.st_name);
uint64_t full_addr =
ToVMAddr(sym.st_value, index_base + sym.st_shndx, is_object);
// Capture the trailing NULL.
name = string_view(name.data(), name.size() + 1);
sink->AddFileRangeForVMAddr("elf_symtab_name", full_addr, name);
sink->AddFileRangeForVMAddr("elf_symtab_sym", full_addr, sym_range);
}
}
static void ReadELFRelaEntries(const ElfFile::Section& section,
uint64_t index_base, bool is_object,
RangeSink* sink) {
Elf64_Word rela_count = section.GetEntryCount();
Elf64_Word sh_info = section.header().sh_info;
for (Elf64_Word i = 1; i < rela_count; i++) {
Elf64_Rela rela;
string_view rela_range;
section.ReadRelocationWithAddend(i, &rela, &rela_range);
uint64_t full_addr =
ToVMAddr(rela.r_offset, index_base + sh_info, is_object);
sink->AddFileRangeForVMAddr("elf_rela", full_addr, rela_range);
}
}
// Adds file ranges for the symbol tables and string tables *themselves* (ie.
// the space that the symtab/strtab take up in the file). This will cover
// .symtab
// .strtab
// .dynsym
// .dynstr
static void ReadELFTables(const InputFile& file, RangeSink* sink) {
bool is_object = IsObjectFile(file.data());
// Disassemble first, because sometimes other tables will refer to things we
// discovered through disassembling.
ReadELFSymbols(file, sink, nullptr, true);
// Now scan other tables.
ForEachElf(file, sink,
[sink, is_object](const ElfFile& elf, string_view /*filename*/,
uint32_t index_base) {
for (Elf64_Xword i = 1; i < elf.section_count(); i++) {
ElfFile::Section section;
elf.ReadSection(i, §ion);
switch (section.header().sh_type) {
case SHT_SYMTAB:
case SHT_DYNSYM:
ReadELFSymbolTableEntries(elf, section, index_base,
is_object, sink);
break;