folly/experimental/symbolizer/Elf-inl.h

   1 /*
   2  * Copyright 2017 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef FOLLY_EXPERIMENTAL_SYMBOLIZER_ELF_H_
  18 #error This file must be included from Elf.h
  19 #endif
  20
  21 namespace folly {
  22 namespace symbolizer {
  23
  24 template <class Fn>
  25 const ElfPhdr* ElfFile::iterateProgramHeaders(Fn fn) const {
  26   const ElfPhdr* ptr = &at<ElfPhdr>(elfHeader().e_phoff);
  27   for (size_t i = 0; i < elfHeader().e_phnum; i++, ptr++) {
  28     if (fn(*ptr)) {
  29       return ptr;
  30     }
  31   }
  32
  33   return nullptr;
  34 }
  35
  36 template <class Fn>
  37 const ElfShdr* ElfFile::iterateSections(Fn fn) const {
  38   const ElfShdr* ptr = &at<ElfShdr>(elfHeader().e_shoff);
  39   for (size_t i = 0; i < elfHeader().e_shnum; i++, ptr++) {
  40     if (fn(*ptr)) {
  41       return ptr;
  42     }
  43   }
  44
  45   return nullptr;
  46 }
  47
  48 template <class Fn>
  49 const ElfShdr* ElfFile::iterateSectionsWithType(uint32_t type, Fn fn) const {
  50   return iterateSections(
  51       [&](const ElfShdr& sh) { return sh.sh_type == type && fn(sh); });
  52 }
  53
  54 template <class Fn>
  55 const char* ElfFile::iterateStrings(const ElfShdr& stringTable, Fn fn) const {
  56   validateStringTable(stringTable);
  57
  58   const char* start = file_ + stringTable.sh_offset;
  59   const char* end = start + stringTable.sh_size;
  60
  61   const char* ptr = start;
  62   while (ptr != end && !fn(ptr)) {
  63     ptr += strlen(ptr) + 1;
  64   }
  65
  66   return ptr != end ? ptr : nullptr;
  67 }
  68
  69 template <class Fn>
  70 const ElfSym* ElfFile::iterateSymbols(const ElfShdr& section, Fn fn) const {
  71   FOLLY_SAFE_CHECK(
  72       section.sh_entsize == sizeof(ElfSym),
  73       "invalid entry size in symbol table");
  74
  75   const ElfSym* sym = &at<ElfSym>(section.sh_offset);
  76   const ElfSym* end = sym + (section.sh_size / section.sh_entsize);
  77
  78   while (sym < end) {
  79     if (fn(*sym)) {
  80       return sym;
  81     }
  82
  83     ++sym;
  84   }
  85
  86   return nullptr;
  87 }
  88
  89 template <class Fn>
  90 const ElfSym* ElfFile::iterateSymbolsWithType(
  91     const ElfShdr& section,
  92     uint32_t type,
  93     Fn fn) const {
  94   // N.B. st_info has the same representation on 32- and 64-bit platforms
  95   return iterateSymbols(section, [&](const ElfSym& sym) -> bool {
  96     return ELF32_ST_TYPE(sym.st_info) == type && fn(sym);
  97   });
  98 }
  99
 100 template <class Fn>
 101 const ElfSym* ElfFile::iterateSymbolsWithTypes(
 102     const ElfShdr& section,
 103     std::initializer_list<uint32_t> types,
 104     Fn fn) const {
 105   // N.B. st_info has the same representation on 32- and 64-bit platforms
 106   return iterateSymbols(section, [&](const ElfSym& sym) -> bool {
 107     auto const elfType = ELF32_ST_TYPE(sym.st_info);
 108     auto const it = std::find(types.begin(), types.end(), elfType);
 109     return it != types.end() && fn(sym);
 110   });
 111 }
 112
 113 } // namespace symbolizer
 114 } // namespace folly