chore: make yuzu REUSE compliant
[REUSE] is a specification that aims at making file copyright
information consistent, so that it can be both human and machine
readable. It basically requires that all files have a header containing
copyright and licensing information. When this isn't possible, like
when dealing with binary assets, generated files or embedded third-party
dependencies, it is permitted to insert copyright information in the
`.reuse/dep5` file.
Oh, and it also requires that all the licenses used in the project are
present in the `LICENSES` folder, that's why the diff is so huge.
This can be done automatically with `reuse download --all`.
The `reuse` tool also contains a handy subcommand that analyzes the
project and tells whether or not the project is (still) compliant,
`reuse lint`.
Following REUSE has a few advantages over the current approach:
- Copyright information is easy to access for users / downstream
- Files like `dist/license.md` do not need to exist anymore, as
`.reuse/dep5` is used instead
- `reuse lint` makes it easy to ensure that copyright information of
files like binary assets / images is always accurate and up to date
To add copyright information of files that didn't have it I looked up
who committed what and when, for each file. As yuzu contributors do not
have to sign a CLA or similar I couldn't assume that copyright ownership
was of the "yuzu Emulator Project", so I used the name and/or email of
the commit author instead.
[REUSE]: https://reuse.software
Follow-up to 01cf05bc75b1e47beb08937439f3ed9339e7b254
2022-05-15 01:06:02 +01:00
|
|
|
// SPDX-FileCopyrightText: 2014 Jannik Vogel <email@jannikvogel.de>
|
|
|
|
// SPDX-License-Identifier: CC0-1.0
|
2016-03-11 15:15:36 +00:00
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2023-08-11 02:34:43 +01:00
|
|
|
#include <bit>
|
2016-03-11 15:15:36 +00:00
|
|
|
#include <cstddef>
|
2020-07-19 00:06:13 +01:00
|
|
|
#include <new>
|
2016-03-11 15:15:36 +00:00
|
|
|
#include <type_traits>
|
|
|
|
|
|
|
|
namespace Common {
|
|
|
|
|
|
|
|
template <typename T>
|
2023-08-11 02:34:43 +01:00
|
|
|
requires std::is_integral_v<T>
|
2023-08-12 20:18:55 +01:00
|
|
|
[[nodiscard]] constexpr T AlignUp(T value_, size_t size) {
|
|
|
|
using U = typename std::make_unsigned_t<T>;
|
|
|
|
auto value{static_cast<U>(value_)};
|
2020-07-12 15:45:49 +01:00
|
|
|
auto mod{static_cast<T>(value % size)};
|
|
|
|
value -= mod;
|
|
|
|
return static_cast<T>(mod == T{0} ? value : value + size);
|
2016-03-11 15:15:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
template <typename T>
|
2023-01-29 20:54:13 +00:00
|
|
|
requires std::is_unsigned_v<T>
|
2021-09-24 06:21:07 +01:00
|
|
|
[[nodiscard]] constexpr T AlignUpLog2(T value, size_t align_log2) {
|
2021-01-15 07:02:37 +00:00
|
|
|
return static_cast<T>((value + ((1ULL << align_log2) - 1)) >> align_log2 << align_log2);
|
2016-03-11 15:15:36 +00:00
|
|
|
}
|
|
|
|
|
2019-05-10 08:17:48 +01:00
|
|
|
template <typename T>
|
2023-08-11 02:34:43 +01:00
|
|
|
requires std::is_integral_v<T>
|
2023-08-12 20:18:55 +01:00
|
|
|
[[nodiscard]] constexpr T AlignDown(T value_, size_t size) {
|
|
|
|
using U = typename std::make_unsigned_t<T>;
|
|
|
|
const auto value{static_cast<U>(value_)};
|
2021-01-15 07:02:37 +00:00
|
|
|
return static_cast<T>(value - value % size);
|
2019-05-10 08:17:48 +01:00
|
|
|
}
|
|
|
|
|
2018-10-18 17:55:27 +01:00
|
|
|
template <typename T>
|
2023-01-29 20:54:13 +00:00
|
|
|
requires std::is_unsigned_v<T>
|
2021-09-24 06:21:07 +01:00
|
|
|
[[nodiscard]] constexpr bool Is4KBAligned(T value) {
|
2018-10-18 17:55:27 +01:00
|
|
|
return (value & 0xFFF) == 0;
|
|
|
|
}
|
|
|
|
|
2018-10-18 17:58:23 +01:00
|
|
|
template <typename T>
|
2023-01-29 20:54:13 +00:00
|
|
|
requires std::is_unsigned_v<T>
|
2021-09-24 06:21:07 +01:00
|
|
|
[[nodiscard]] constexpr bool IsWordAligned(T value) {
|
2018-10-18 17:58:23 +01:00
|
|
|
return (value & 0b11) == 0;
|
|
|
|
}
|
|
|
|
|
2020-03-31 19:15:43 +01:00
|
|
|
template <typename T>
|
2023-01-29 20:54:13 +00:00
|
|
|
requires std::is_integral_v<T>
|
2021-09-24 06:21:07 +01:00
|
|
|
[[nodiscard]] constexpr bool IsAligned(T value, size_t alignment) {
|
2021-01-15 07:05:22 +00:00
|
|
|
using U = typename std::make_unsigned_t<T>;
|
2020-03-31 19:15:43 +01:00
|
|
|
const U mask = static_cast<U>(alignment - 1);
|
|
|
|
return (value & mask) == 0;
|
|
|
|
}
|
|
|
|
|
2021-02-09 02:01:19 +00:00
|
|
|
template <typename T, typename U>
|
2023-01-29 20:54:13 +00:00
|
|
|
requires std::is_integral_v<T>
|
2021-09-24 06:21:07 +01:00
|
|
|
[[nodiscard]] constexpr T DivideUp(T x, U y) {
|
2021-02-09 02:01:19 +00:00
|
|
|
return (x + (y - 1)) / y;
|
|
|
|
}
|
|
|
|
|
2023-08-11 02:34:43 +01:00
|
|
|
template <typename T>
|
|
|
|
requires std::is_integral_v<T>
|
|
|
|
[[nodiscard]] constexpr T LeastSignificantOneBit(T x) {
|
|
|
|
return x & ~(x - 1);
|
|
|
|
}
|
|
|
|
|
|
|
|
template <typename T>
|
|
|
|
requires std::is_integral_v<T>
|
|
|
|
[[nodiscard]] constexpr T ResetLeastSignificantOneBit(T x) {
|
|
|
|
return x & (x - 1);
|
|
|
|
}
|
|
|
|
|
|
|
|
template <typename T>
|
|
|
|
requires std::is_integral_v<T>
|
|
|
|
[[nodiscard]] constexpr bool IsPowerOfTwo(T x) {
|
|
|
|
return x > 0 && ResetLeastSignificantOneBit(x) == 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
template <typename T>
|
|
|
|
requires std::is_integral_v<T>
|
|
|
|
[[nodiscard]] constexpr T FloorPowerOfTwo(T x) {
|
|
|
|
return T{1} << (sizeof(T) * 8 - std::countl_zero(x) - 1);
|
|
|
|
}
|
|
|
|
|
2021-01-15 07:05:22 +00:00
|
|
|
template <typename T, size_t Align = 16>
|
2019-07-18 23:15:53 +01:00
|
|
|
class AlignmentAllocator {
|
|
|
|
public:
|
2019-07-19 16:11:42 +01:00
|
|
|
using value_type = T;
|
2021-01-15 07:05:22 +00:00
|
|
|
using size_type = size_t;
|
|
|
|
using difference_type = ptrdiff_t;
|
2019-07-18 23:15:53 +01:00
|
|
|
|
2019-10-06 23:29:18 +01:00
|
|
|
using propagate_on_container_copy_assignment = std::true_type;
|
|
|
|
using propagate_on_container_move_assignment = std::true_type;
|
|
|
|
using propagate_on_container_swap = std::true_type;
|
2021-10-20 02:08:18 +01:00
|
|
|
using is_always_equal = std::false_type;
|
2019-10-06 23:29:18 +01:00
|
|
|
|
2019-10-06 23:43:08 +01:00
|
|
|
constexpr AlignmentAllocator() noexcept = default;
|
|
|
|
|
|
|
|
template <typename T2>
|
|
|
|
constexpr AlignmentAllocator(const AlignmentAllocator<T2, Align>&) noexcept {}
|
|
|
|
|
2020-08-14 14:38:45 +01:00
|
|
|
[[nodiscard]] T* allocate(size_type n) {
|
2023-01-29 20:54:13 +00:00
|
|
|
return static_cast<T*>(::operator new(n * sizeof(T), std::align_val_t{Align}));
|
2019-07-18 23:15:53 +01:00
|
|
|
}
|
|
|
|
|
2020-07-17 12:26:59 +01:00
|
|
|
void deallocate(T* p, size_type n) {
|
2023-01-29 20:54:13 +00:00
|
|
|
::operator delete(p, n * sizeof(T), std::align_val_t{Align});
|
2019-07-18 23:15:53 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
template <typename T2>
|
|
|
|
struct rebind {
|
2019-07-20 02:49:54 +01:00
|
|
|
using other = AlignmentAllocator<T2, Align>;
|
2019-07-18 23:15:53 +01:00
|
|
|
};
|
2021-10-20 02:08:18 +01:00
|
|
|
|
|
|
|
template <typename T2, size_t Align2>
|
|
|
|
constexpr bool operator==(const AlignmentAllocator<T2, Align2>&) const noexcept {
|
|
|
|
return std::is_same_v<T, T2> && Align == Align2;
|
|
|
|
}
|
2019-07-18 23:15:53 +01:00
|
|
|
};
|
|
|
|
|
2016-03-11 15:15:36 +00:00
|
|
|
} // namespace Common
|