SymbolVersion.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_VERSION_H
#define LIEF_ELF_SYMBOL_VERSION_H
#include <cassert>
#include <cstdint>
#include <ostream>
 
#include "LIEF/Object.hpp"
#include "LIEF/visibility.h"
 
 
namespace LIEF::ELF {
class Parser;
class SymbolVersionAux;
class SymbolVersionAuxRequirement;

class LIEF_API SymbolVersion : public Object {
  friend class Parser;
 
  public:
  static constexpr uint16_t LOCAL_VERSION = 0;
  static constexpr uint16_t GLOBAL_VERSION = 1;

  static constexpr uint16_t HIDDEN_MASK = 0x8000;

  static constexpr uint16_t VERSION_MASK = 0x7fff;
 
  SymbolVersion(uint16_t value) :
    value_(value) {}
  SymbolVersion() = default;

  static SymbolVersion local() {
    return LOCAL_VERSION;
  }

  static SymbolVersion global() {
    return GLOBAL_VERSION;
  }
 
  ~SymbolVersion() override = default;
 
  SymbolVersion& operator=(const SymbolVersion&) = default;
  SymbolVersion(const SymbolVersion&) = default;

  uint16_t value() const {
    return value_;
  }

  uint16_t version() const {
    return value() & VERSION_MASK;
  }

  bool is_local() const {
    return version() == LOCAL_VERSION;
  }

  bool is_global() const {
    return version() == GLOBAL_VERSION;
  }

  bool is_hidden() const {
    return (value() & HIDDEN_MASK) != 0;
  }

  void set_hidden(bool value = true) {
    if (value) {
      value_ |= HIDDEN_MASK;
    } else {
      value_ &= VERSION_MASK;
    }
  }

  bool has_auxiliary_version() const {
    return symbol_version_auxiliary() != nullptr;
  }

  SymbolVersionAux* symbol_version_auxiliary() LIEF_LIFETIMEBOUND {
    return symbol_aux_;
  }
 
  const SymbolVersionAux* symbol_version_auxiliary() const LIEF_LIFETIMEBOUND {
    return symbol_aux_;
  }

  void symbol_version_auxiliary(SymbolVersionAuxRequirement& svauxr);

  void drop_version(uint16_t value) {
    assert(value == LOCAL_VERSION || value == GLOBAL_VERSION);
    value_ = value;
    symbol_aux_ = nullptr;
  }

  void as_global() {
    return drop_version(GLOBAL_VERSION);
  }

  void as_local() {
    return drop_version(LOCAL_VERSION);
  }
 
  void value(uint16_t v) {
    value_ = v;
  }
 
  void accept(Visitor& visitor) const override;
 
  LIEF_API friend std::ostream& operator<<(std::ostream& os,
                                           const SymbolVersion& symv);
 
  private:
  uint16_t value_ = 0;
  SymbolVersionAux* symbol_aux_ = nullptr;
};
}
 
#endif