OAT/Parser.hpp

Go to the documentation of this file.

/* Copyright 2017 - 2026 R. Thomas
 * Copyright 2017 - 2026 Quarkslab
 *
 * 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.
 */
#ifndef LIEF_OAT_PARSER_H
#define LIEF_OAT_PARSER_H
#include <string_view>
#include <cstdint>
#include <memory>
 
#include "LIEF/ELF/Parser.hpp"
#include "LIEF/errors.hpp"
#include "LIEF/path.hpp"
#include "LIEF/visibility.h"
 
namespace LIEF {
 
namespace VDEX {
class File;
}
 
namespace DEX {
class Class;
}
 
namespace OAT {
class Binary;
class Class;

class LIEF_API Parser : public ELF::Parser {
  public:
  static std::unique_ptr<Binary> parse(std::string_view oat_file);
  static std::unique_ptr<Binary> parse(std::string_view oat_file,
                                       std::string_view vdex_file);

  template<class PathT, enable_if_path_t<PathT> = 0>
  static std::unique_ptr<Binary> parse(const PathT& oat_file) {
    return parse(oat_file.string());
  }

  template<class OatT, class VdexT, enable_if_path_t<OatT, VdexT> = 0>
  static std::unique_ptr<Binary> parse(const OatT& oat_file,
                                       const VdexT& vdex_file) {
    return parse(std::filesystem::path(oat_file).string(),
                 std::filesystem::path(vdex_file).string());
  }
 
  static std::unique_ptr<Binary> parse(std::vector<uint8_t> data);
 
  Parser& operator=(const Parser& copy) = delete;
  Parser(const Parser& copy) = delete;
 
  protected:
  Parser();
  Parser(std::string_view oat_file);
  Parser(std::vector<uint8_t> data);
  ~Parser();
 
  Binary& oat_binary() {
    // The type of the parent binary_ is guaranteed by the constructor
    return *reinterpret_cast<Binary*>(binary_.get());
  }
 
  bool has_vdex() const;
  void set_vdex(std::unique_ptr<VDEX::File> file);
 
  template<typename OAT_T>
  void parse_binary();
 
  template<typename OAT_T>
  void parse_header();
 
  template<typename OAT_T>
  void parse_header_keys();
 
  template<typename OAT_T>
  void parse_dex_files();
 
  template<typename OAT_T>
  void parse_type_lookup_table();
 
  template<typename OAT_T>
  void parse_oat_classes();
 
  template<typename OAT_T>
  void parse_oat_methods(uint64_t methods_offsets, Class& clazz,
                         const DEX::Class& dex_class);
 
  void init();
 
  result<uint64_t> oat_data_exec_gap() const;
 
  std::unique_ptr<LIEF::VDEX::File> vdex_file_;
 
  uint64_t data_address_ = 0;
  uint64_t data_size_ = 0;
 
  uint64_t exec_start_ = 0;
  uint64_t exec_size_ = 0;
};
 
}
}
#endif