ELF/Symbol.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_ELF_SYMBOL_H
#define LIEF_ELF_SYMBOL_H
 
#include <string>
#include <ostream>
 
#include "LIEF/visibility.h"
#include "LIEF/Abstract/Symbol.hpp"
#include "LIEF/ELF/enums.hpp"
 
namespace LIEF {
namespace ELF {
class Parser;
class Binary;
class SymbolVersion;
class Section;

class LIEF_API Symbol : public LIEF::Symbol {
  friend class Parser;
  friend class Binary;
 
  public:
  enum class BINDING {
    LOCAL = 0,       
    GLOBAL,          
    WEAK,            
    GNU_UNIQUE = 10, 
  };

  enum class TYPE {
    NOTYPE = 0,     
    OBJECT,         
    FUNC,           
    SECTION,        
    FILE,           
    COMMON,         
    TLS,            
    GNU_IFUNC = 10, 
  };

  enum class VISIBILITY {
    DEFAULT = 0, 
    INTERNAL,    
    HIDDEN,      
    PROTECTED,   
  };

  enum SECTION_INDEX {
    UNDEF = 0,       
    ABS = 0xfff1,    
    COMMON = 0xfff2, 
  };
 
  public:
  Symbol(std::string name) :
    LIEF::Symbol(std::move(name), 0, 0) {}
 
  static BINDING binding_from(uint32_t value, ARCH) {
    return BINDING(value);
  }
 
  static TYPE type_from(uint32_t value, ARCH) {
    return TYPE(value);
  }
 
  static uint8_t to_value(BINDING binding) {
    return static_cast<uint8_t>(binding);
  }
 
  static uint8_t to_value(TYPE type) {
    return static_cast<uint8_t>(type);
  }
 
  Symbol() = default;
  ~Symbol() override = default;
 
  Symbol& operator=(Symbol other);
  Symbol(const Symbol& other);
  void swap(Symbol& other);

  TYPE type() const {
    return type_;
  }

  BINDING binding() const {
    return binding_;
  }

  uint8_t information() const;

  uint8_t other() const {
    return other_;
  }

  uint16_t section_idx() const {
    return shndx();
  }

  VISIBILITY visibility() const {
    return VISIBILITY(other_);
  }

  Section* section() LIEF_LIFETIMEBOUND {
    return section_;
  }
 
  const Section* section() const LIEF_LIFETIMEBOUND {
    return section_;
  }

  uint64_t value() const override {
    return value_;
  }

  uint64_t size() const override {
    return size_;
  }

  uint16_t shndx() const {
    return shndx_;
  }

  bool has_version() const {
    return symbol_version_ != nullptr;
  }

  SymbolVersion* symbol_version() LIEF_LIFETIMEBOUND {
    return symbol_version_;
  }
 
  const SymbolVersion* symbol_version() const LIEF_LIFETIMEBOUND {
    return symbol_version_;
  }
 
  bool is_local() const {
    return binding() == BINDING::LOCAL;
  }
 
  bool is_global() const {
    return binding() == BINDING::GLOBAL;
  }
 
  bool is_weak() const {
    return binding() == BINDING::WEAK;
  }

  std::string demangled_name() const;
 
  void type(TYPE type) {
    type_ = type;
  }
 
  void binding(BINDING binding) {
    binding_ = binding;
  }
 
  void other(uint8_t other) {
    other_ = other;
  }
 
  void visibility(VISIBILITY visibility) {
    other_ = static_cast<uint8_t>(visibility);
  }
 
  void information(uint8_t info);
 
  void shndx(uint16_t idx) {
    shndx_ = idx;
  }
 
  void value(uint64_t value) override {
    value_ = value;
  }
 
  void size(uint64_t size) override {
    size_ = size;
  }

  bool is_exported() const;

  void set_exported(bool flag = true);

  bool is_imported() const;

  void set_imported(bool flag = true);

  bool is_static() const {
    return this->binding() == BINDING::GLOBAL;
  }

  bool is_function() const {
    return this->type() == TYPE::FUNC;
  }

  bool is_variable() const {
    return this->type() == TYPE::OBJECT;
  }
 
  void accept(Visitor& visitor) const override;
 
  LIEF_API friend std::ostream& operator<<(std::ostream& os, const Symbol& entry);
 
  private:
  template<class T>
  LIEF_API Symbol(const T& header, ARCH arch);
 
  TYPE type_ = TYPE::NOTYPE;
  BINDING binding_ = BINDING::LOCAL;
  uint8_t other_ = 0;
  uint16_t shndx_ = 0;
  Section* section_ = nullptr;
  SymbolVersion* symbol_version_ = nullptr;
  ARCH arch_ = ARCH::NONE;
};
 
LIEF_API const char* to_string(Symbol::BINDING binding);
LIEF_API const char* to_string(Symbol::TYPE type);
LIEF_API const char* to_string(Symbol::VISIBILITY viz);
}
}
#endif