TLS.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_PE_TLS_H
#define LIEF_PE_TLS_H
 
#include <vector>
#include <ostream>
 
#include "LIEF/span.hpp"
#include "LIEF/Object.hpp"
#include "LIEF/compiler_attributes.hpp"
#include "LIEF/visibility.h"
 
namespace LIEF {
namespace PE {
 
class Parser;
class Builder;
class DataDirectory;
class Section;
class Binary;
 
namespace details {
struct pe32_tls;
struct pe64_tls;
}

class LIEF_API TLS : public Object {
  friend class Parser;
  friend class Builder;
  friend class Binary;
 
  public:
  TLS() = default;
 
  LIEF_LOCAL TLS(const details::pe32_tls& header);
  LIEF_LOCAL TLS(const details::pe64_tls& header);
 
  ~TLS() override = default;
 
  TLS(const TLS& copy) = default;
  TLS& operator=(const TLS& copy) = default;
 
  TLS(TLS&& other) noexcept = default;
  TLS& operator=(TLS&& other) noexcept = default;

  const std::vector<uint64_t>& callbacks() const {
    return callbacks_;
  }

  TLS& add_callback(uint64_t addr) LIEF_LIFETIMEBOUND {
    callbacks_.push_back(addr);
    return *this;
  }

  const std::pair<uint64_t, uint64_t>& addressof_raw_data() const {
    return va_rawdata_;
  }

  uint64_t addressof_index() const {
    return addressof_index_;
  }

  uint64_t addressof_callbacks() const {
    return addressof_callbacks_;
  }

  uint32_t sizeof_zero_fill() const {
    return sizeof_zero_fill_;
  }

  uint32_t characteristics() const {
    return characteristics_;
  }

  span<const uint8_t> data_template() const LIEF_LIFETIMEBOUND {
    return data_template_;
  }

  bool has_data_directory() const {
    return directory_ != nullptr;
  }

  DataDirectory* directory() LIEF_LIFETIMEBOUND {
    return directory_;
  }
 
  const DataDirectory* directory() const LIEF_LIFETIMEBOUND {
    return directory_;
  }

  bool has_section() const {
    return section_ != nullptr;
  }

  Section* section() LIEF_LIFETIMEBOUND {
    return section_;
  }
 
  const Section* section() const LIEF_LIFETIMEBOUND {
    return section_;
  }
 
  void callbacks(std::vector<uint64_t> callbacks) {
    callbacks_ = std::move(callbacks);
  }
 
  void addressof_raw_data(std::pair<uint64_t, uint64_t> addresses) {
    va_rawdata_ = addresses;
  }
 
  void addressof_index(uint64_t addr_idx) {
    addressof_index_ = addr_idx;
  }
 
  void addressof_callbacks(uint64_t addr) {
    addressof_callbacks_ = addr;
  }
 
  void sizeof_zero_fill(uint32_t size) {
    sizeof_zero_fill_ = size;
  }
 
  void characteristics(uint32_t characteristics) {
    characteristics_ = characteristics;
  }
 
  void data_template(std::vector<uint8_t> data_template) {
    data_template_ = std::move(data_template);
  }
 
  void accept(Visitor& visitor) const override;
 
  LIEF_API friend std::ostream& operator<<(std::ostream& os, const TLS& entry);
 
  private:
  std::vector<uint64_t> callbacks_;
  std::pair<uint64_t, uint64_t> va_rawdata_;
  uint64_t addressof_index_ = 0;
  uint64_t addressof_callbacks_ = 0;
  uint32_t sizeof_zero_fill_ = 0;
  uint32_t characteristics_ = 0;
  DataDirectory* directory_ = nullptr;
  Section* section_ = nullptr;
  std::vector<uint8_t> data_template_;
};
}
}
#endif