OAT/Binary.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_BINARY_H
#define LIEF_OAT_BINARY_H
#include <string_view>
#include <ostream>
 
#include "LIEF/visibility.h"
 
#include "LIEF/DEX/deopt.hpp"
#include "LIEF/ELF/Binary.hpp"
#include "LIEF/OAT/Header.hpp"
 
namespace LIEF {
namespace DEX {
class File;
}
 
namespace VDEX {
class File;
}
 
namespace OAT {
class Parser;
class Class;
class Method;
class DexFile;
 
class LIEF_API Binary : public ELF::Binary {
  friend class Parser;
 
  public:
  using dex_files_t = std::vector<std::unique_ptr<DEX::File>>;
  using it_dex_files = ref_iterator<dex_files_t&, DEX::File*>;
  using it_const_dex_files =
      const_ref_iterator<const dex_files_t&, const DEX::File*>;
 
  using classes_t = std::unordered_map<std::string, Class*>;
  using classes_list_t = std::vector<std::unique_ptr<Class>>;
  using it_classes = ref_iterator<classes_list_t&, Class*>;
  using it_const_classes = const_ref_iterator<const classes_list_t&, const Class*>;
 
  using oat_dex_files_t = std::vector<std::unique_ptr<DexFile>>;
  using it_oat_dex_files = ref_iterator<oat_dex_files_t&, DexFile*>;
  using it_const_oat_dex_files =
      const_ref_iterator<const oat_dex_files_t&, const DexFile*>;
 
  using methods_t = std::vector<std::unique_ptr<Method>>;
  using it_methods = ref_iterator<methods_t&, Method*>;
  using it_const_methods = const_ref_iterator<const methods_t&, const Method*>;
 
  using dex2dex_info_t = std::unordered_map<const DEX::File*, DEX::dex2dex_info_t>;
 
  public:
  Binary& operator=(const Binary& copy) = delete;
  Binary(const Binary& copy) = delete;

  const Header& header() const LIEF_LIFETIMEBOUND;
  Header& header() LIEF_LIFETIMEBOUND;

  it_dex_files dex_files() LIEF_LIFETIMEBOUND;
  it_const_dex_files dex_files() const LIEF_LIFETIMEBOUND;

  it_oat_dex_files oat_dex_files() LIEF_LIFETIMEBOUND;
  it_const_oat_dex_files oat_dex_files() const LIEF_LIFETIMEBOUND;

  it_const_classes classes() const LIEF_LIFETIMEBOUND;
  it_classes classes() LIEF_LIFETIMEBOUND;

  bool has_class(std::string_view class_name) const;
 

  const Class* get_class(std::string_view class_name) const LIEF_LIFETIMEBOUND;
 
  Class* get_class(std::string_view class_name) LIEF_LIFETIMEBOUND;

  const Class* get_class(size_t index) const LIEF_LIFETIMEBOUND;
 
  Class* get_class(size_t index) LIEF_LIFETIMEBOUND;

  it_const_methods methods() const LIEF_LIFETIMEBOUND;
  it_methods methods() LIEF_LIFETIMEBOUND;
 
  dex2dex_info_t dex2dex_info() const;
 
  std::string dex2dex_json_info();
 
  bool has_vdex() const {
    return vdex_ != nullptr;
  }
 
  static bool classof(const LIEF::Binary* bin) {
    return bin->format() == Binary::FORMATS::OAT;
  }
 
  void accept(Visitor& visitor) const override;
 
  ~Binary() override;
 
  LIEF_API friend std::ostream& operator<<(std::ostream& os, const Binary& binary);
 
  private:
  Binary();
  void add_class(std::unique_ptr<Class> cls);
 
  Header header_;
  methods_t methods_;
  dex_files_t dex_files_;
  oat_dex_files_t oat_dex_files_;
 
  classes_t classes_;
  classes_list_t classes_list_;
 
  // For OAT > 79
  std::unique_ptr<VDEX::File> vdex_;
};
 
}
}
 
#endif