libcruft-util/pointer.hpp

92 lines
2.5 KiB
C++
Raw Normal View History

2015-11-17 17:21:14 +11:00
/*
2018-08-04 15:14:06 +10:00
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
2015-11-17 17:21:14 +11:00
*
* Copyright 2011-2019 Danny Robson <danny@nerdcruft.net>
2015-11-17 17:21:14 +11:00
*/
#pragma once
#include <type_traits>
2015-11-17 17:21:14 +11:00
#include <cstddef>
#include <cstdint>
namespace cruft::align {
2015-11-17 17:21:14 +11:00
///////////////////////////////////////////////////////////////////////////
2017-08-30 15:38:13 +10:00
/// round the pointer upwards to satisfy the provided alignment
constexpr inline uintptr_t
up (uintptr_t ptr, size_t alignment)
2015-11-17 17:21:14 +11:00
{
2017-08-30 15:38:13 +10:00
// we perform this as two steps to avoid unnecessarily incrementing when
// remainder is zero.
if (auto mod = ptr % alignment; mod)
ptr += alignment - mod;
return ptr;
2015-11-17 17:21:14 +11:00
}
2016-03-11 09:40:12 +11:00
///////////////////////////////////////////////////////////////////////////
2017-08-30 15:38:13 +10:00
/// round the pointer upwards to satisfy the provided alignment
template <typename T>
constexpr T*
up (T *ptr, size_t alignment)
2016-03-11 09:40:12 +11:00
{
2017-08-30 15:38:13 +10:00
// we perform this as two steps to avoid unnecessarily incrementing when
// remainder is zero.
return reinterpret_cast<T*>(
up (reinterpret_cast<uintptr_t> (ptr), alignment)
);
2017-08-30 15:38:13 +10:00
}
//-------------------------------------------------------------------------
template <typename T>
constexpr T*
up (T *ptr, std::align_val_t _alignment)
{
auto alignment = std::underlying_type_t<decltype(_alignment)> (_alignment);
return up (ptr, alignment);
}
2017-08-30 15:38:13 +10:00
///------------------------------------------------------------------------
/// round the pointer upwards to the nearest valid alignment for T
template <typename T>
constexpr auto
up (T *t)
2017-08-30 15:38:13 +10:00
{
return up (t, alignof (T));
2017-08-30 15:38:13 +10:00
}
///------------------------------------------------------------------------
/// round the pointer upwards to the nearest valid alignment for T
template <typename T>
constexpr auto
up (uintptr_t ptr)
2017-08-30 15:38:13 +10:00
{
return up (ptr, alignof (T));
}
///////////////////////////////////////////////////////////////////////////
constexpr inline uintptr_t
down (uintptr_t ptr, size_t alignment)
{
return ptr - ptr % alignment;
2016-03-11 09:40:12 +11:00
}
2015-11-17 17:21:14 +11:00
//-------------------------------------------------------------------------
template <typename T>
constexpr T*
down (T *ptr, size_t alignment)
{
return reinterpret_cast<T*> (
down (reinterpret_cast<uintptr_t> (ptr), alignment)
);
}
}