MachO/Symbol.hpp

Go to the documentation of this file.

/* Copyright 2017 - 2024 R. Thomas
 * Copyright 2017 - 2024 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_MACHO_SYMBOL_H
#define LIEF_MACHO_SYMBOL_H
 
#include <ostream>
 
#include "LIEF/visibility.h"
 
#include "LIEF/Abstract/Symbol.hpp"
 
#include "LIEF/MachO/LoadCommand.hpp"
 
namespace LIEF {
namespace MachO {
 
class BinaryParser;
class BindingInfo;
class ExportInfo;
class DylibCommand;
class Binary;
 
namespace details {
struct nlist_32;
struct nlist_64;
}
class LIEF_API Symbol : public LIEF::Symbol {
 
  friend class BinaryParser;
  friend class Binary;
 
  public:
  static constexpr int SELF_LIBRARY_ORD = 0x0; // Mirror SELF_LIBRARY_ORDINAL
  static constexpr int MAIN_EXECUTABLE_ORD = 0xff; // Mirror DYNAMIC_LOOKUP_ORDINAL
  static constexpr int DYNAMIC_LOOKUP_ORD = 0xfe; // EXECUTABLE_ORDINAL
  enum class CATEGORY : uint32_t {
    NONE = 0,
    LOCAL,
    EXTERNAL,
    UNDEFINED,
 
    INDIRECT_ABS,
    INDIRECT_LOCAL,
    INDIRECT_ABS_LOCAL,
  };

enum class ORIGIN : uint32_t {

UNKNOWN = 0,

DYLD_EXPORT = 1,

DYLD_BIND = 2,

LC_SYMTAB = 3,

};

enum class TYPE : uint32_t{

UNDEFINED = 0x0u,

ABSOLUTE_SYM = 0x2u,

SECTION = 0xeu,

PREBOUND = 0xcu,

INDIRECT = 0xau

};

static constexpr uint32_t TYPE_MASK = 0x0e;

Symbol() = default;

Symbol(const details::nlist_32& cmd);

Symbol(const details::nlist_64& cmd);

Symbol(uint8_t n_type, uint8_t n_sect, uint8_t n_desc, uint64_t value) :

type_{n_type},

numberof_sections_{n_sect},

description_{n_desc},

origin_{ORIGIN::LC_SYMTAB}

{

value_ = value;

}

Symbol& operator=(Symbol other);

Symbol(const Symbol& other);

void swap(Symbol& other) noexcept;

~Symbol() override = default;

static bool is_valid_index_ordinal(int idx) {

return idx != SELF_LIBRARY_ORD && idx != MAIN_EXECUTABLE_ORD &&

idx != DYNAMIC_LOOKUP_ORD;

}

int library_ordinal() const {

return (description() >> 8) & 0xff;

}

uint8_t raw_type() const {

return type_;

}