simpleperf/read_elf.h

   1 /*
   2  * Copyright (C) 2015 The Android Open Source Project
   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 SIMPLE_PERF_READ_ELF_H_
  18 #define SIMPLE_PERF_READ_ELF_H_
  19
  20 #include <functional>
  21 #include <string>
  22 #include "build_id.h"
  23
  24 bool GetBuildIdFromNoteFile(const std::string& filename, BuildId* build_id);
  25 bool GetBuildIdFromElfFile(const std::string& filename, BuildId* build_id);
  26 bool GetBuildIdFromEmbeddedElfFile(const std::string& filename, uint64_t file_offset,
  27                                    uint32_t file_size, BuildId* build_id);
  28
  29 // The symbol prefix used to indicate that the symbol belongs to android linker.
  30 static const std::string linker_prefix = "__dl_";
  31
  32 struct ElfFileSymbol {
  33   uint64_t vaddr;
  34   uint64_t len;
  35   bool is_func;
  36   bool is_label;
  37   bool is_in_text_section;
  38   std::string name;
  39
  40   ElfFileSymbol() : vaddr(0), len(0), is_func(false), is_label(false), is_in_text_section(false) {
  41   }
  42 };
  43
  44 bool ParseSymbolsFromElfFile(const std::string& filename, const BuildId& expected_build_id,
  45                              std::function<void(const ElfFileSymbol&)> callback);
  46 bool ParseSymbolsFromEmbeddedElfFile(const std::string& filename, uint64_t file_offset,
  47                                      uint32_t file_size, const BuildId& expected_build_id,
  48                                      std::function<void(const ElfFileSymbol&)> callback);
  49
  50 bool ReadMinExecutableVirtualAddressFromElfFile(const std::string& filename,
  51                                                 const BuildId& expected_build_id,
  52                                                 uint64_t* min_addr);
  53
  54 bool ReadSectionFromElfFile(const std::string& filename, const std::string& section_name,
  55                             std::string* content);
  56
  57 // Expose the following functions for unit tests.
  58 bool IsArmMappingSymbol(const char* name);
  59 bool IsValidElfFile(int fd);
  60 bool IsValidElfPath(const std::string& filename);
  61
  62 #endif  // SIMPLE_PERF_READ_ELF_H_