utils.hpp

Go to the documentation of this file.

/* Copyright 2017 - 2026 R. Thomasliefuthp
 * 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_UTILS_HEADER
#define LIEF_UTILS_HEADER
#include <ostream>
#include <string>
#include <vector>
 
#include "LIEF/visibility.h"
#include "LIEF/span.hpp"
 
#include "LIEF/errors.hpp"
 
namespace LIEF {
inline uint64_t align(uint64_t value, uint64_t align_on) {
  if (align_on == 0) {
    return value;
  }
  const auto r = value % align_on;
  if (r > 0) {
    return value + (align_on - r);
  }
  return value;
}
 
inline uint64_t align_down(uint64_t value, uint64_t align_on) {
  if (align_on == 0) {
    return value;
  }
  const auto r = value % align_on;
  if (r > 0) {
    return value - r;
  }
  return value;
}
 
inline uint64_t align_with_offset(uint64_t value, uint64_t align_on,
                                  uint64_t offset) {
  return align(value - offset, align_on) + offset;
}
 
// Align up with alignment being a power of 2
template<class T>
constexpr T align_up(T value, T alignment) noexcept {
  return (value + (alignment - 1)) & ~(alignment - 1);
}
 
template<typename T>
inline constexpr T round(T x) {
  return static_cast<T>(round<uint64_t>(x));
}
 
 
template<>
inline uint64_t round<uint64_t>(uint64_t x) {
  // From http://graphics.stanford.edu/~seander/bithacks.html#RoundUpPowerOf2
  x--;
  x |= x >> 1;  // handle  2 bit numbers
  x |= x >> 2;  // handle  4 bit numbers
  x |= x >> 4;  // handle  8 bit numbers
  x |= x >> 8;  // handle 16 bit numbers
  x |= x >> 16; // handle 32 bit numbers
  x |= x >> 32; // handle 64 bit numbers
  x++;
  return x;
}
 
 
constexpr size_t operator""_KB(unsigned long long kbs) {
  return 1024LLU * kbs;
}
 
constexpr size_t operator""_MB(unsigned long long mbs) {
  return 1024LLU * 1024LLU * mbs;
}
 
constexpr size_t operator""_GB(unsigned long long gbs) {
  return 1024LLU * 1024LLU * 1024LLU * gbs;
}
 
struct lief_version_t {
  uint64_t major = 0;
  uint64_t minor = 0;
  uint64_t patch = 0;
  uint64_t id = 0;
 
  LIEF_API std::string to_string() const;
 
  friend LIEF_API std::ostream& operator<<(std::ostream& os,
                                           const lief_version_t& version) {
    os << version.to_string();
    return os;
  }
};
 
LIEF_API std::string u16tou8(const char16_t* buffer, size_t size,
                             bool remove_null_char = false);

inline std::string u16tou8(const std::u16string& string,
                           bool remove_null_char = false) {
  return u16tou8(string.data(), string.size(), remove_null_char);
}

LIEF_API result<std::u16string> u8tou16(const std::string& string);

LIEF_API bool is_extended();

LIEF_API std::string extended_version_info();

LIEF_API lief_version_t extended_version();

LIEF_API lief_version_t version();

LIEF_API result<std::string> demangle(const std::string& mangled);

LIEF_API std::string dump(const uint8_t* buffer, size_t size,
                          const std::string& title = "",
                          const std::string& prefix = "", size_t limit = 0);
 
inline std::string dump(span<const uint8_t> data, const std::string& title = "",
                        const std::string& prefix = "", size_t limit = 0) {
  return dump(data.data(), data.size(), title, prefix, limit);
}
 
inline std::string dump(const std::vector<uint8_t>& data,
                        const std::string& title = "",
                        const std::string& prefix = "", size_t limit = 0) {
  return dump(data.data(), data.size(), title, prefix, limit);
}
}
 
 
#endif