Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
be07e6a
implement coroutine allocator
LLirikkkk Aug 10, 2026
e0b5002
apply code style
LLirikkkk Aug 10, 2026
0189223
move coroutine-allocator into kphp::coro namespace
LLirikkkk Aug 10, 2026
8825f2c
add noexcept to methods in coroutine-allocator
LLirikkkk Aug 10, 2026
2f7eccb
add coroutine-allocator to cmake
LLirikkkk Aug 10, 2026
2eaaf2a
add coroutine malloc interface
LLirikkkk Aug 10, 2026
f4ca83c
remove excess include in control-block
LLirikkkk Aug 10, 2026
1a3b585
rename coroutine-allocator to runtime-coroutine-allocator
LLirikkkk Aug 10, 2026
43064ba
add std-like wrapper for coroutine-allocator
LLirikkkk Aug 10, 2026
49c32ca
add runtime-coroutine-allocator to coroutine-instance-state
LLirikkkk Aug 11, 2026
5911649
move coroutines related data to coroutine memory
LLirikkkk Aug 11, 2026
9b7ebc2
add default values and parsing of args for runtime-coroutine-allocator
LLirikkkk Aug 11, 2026
3b1ed03
add includes
LLirikkkk Aug 11, 2026
81bde55
change default values for memory size
LLirikkkk Aug 13, 2026
4ce05f3
enlarge extra-coroutine-memory-pool-size value to 4MB
LLirikkkk Aug 13, 2026
d4286f5
small fixes
LLirikkkk Aug 13, 2026
10d174f
add methods to allocate global memory for coroutines
LLirikkkk Aug 13, 2026
7b5b08d
reduce code duplication
LLirikkkk Aug 13, 2026
2eaa303
add definitions of methods into runtime-allocator
LLirikkkk Aug 13, 2026
5ae2125
replace inheritance with composition
LLirikkkk Aug 13, 2026
d531939
add copyright header
LLirikkkk Aug 13, 2026
ab8a7ae
add get_memory_resource method into runtime-allocator and runtime-cor…
LLirikkkk Aug 13, 2026
3ea686b
add sources to cmake
LLirikkkk Aug 13, 2026
d5f7f2a
revert replacing script allocator with coroutine allocator in stdlib …
LLirikkkk Aug 17, 2026
21a1943
revert some more changes in stdlib files
LLirikkkk Aug 17, 2026
082ce48
revert some more changes in stdlib files
LLirikkkk Aug 17, 2026
e108e78
small fixes
LLirikkkk Aug 18, 2026
434a76d
add global-memory-allocator
LLirikkkk Aug 18, 2026
cced678
delete redundant file
LLirikkkk Aug 18, 2026
3eec5f2
fix compilation error
LLirikkkk Aug 18, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 165 additions & 0 deletions runtime-common/core/allocator/details/malloc-interface.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
// Compiler for PHP (aka KPHP)
// Copyright (c) 2026 LLC «V Kontakte»
// Distributed under the GPL v3 License, see LICENSE.notice.txt

#pragma once

#include <algorithm>
#include <cinttypes>
#include <cstddef>
#include <cstdint>
#include <cstring>
#include <limits>

#include "common/wrappers/likely.h"
#include "runtime-common/core/utils/kphp-assert-core.h"

namespace kphp::memory::details {

struct control_block {
private:
static constexpr auto SIZE_FIELD_BITSIZE{48};
static constexpr auto BASE_OFFSET_FIELD_BITSIZE{16};
static constexpr uint64_t BLOCK_SIZE_MASK{(1UL << SIZE_FIELD_BITSIZE) - 1};
static constexpr uint64_t BASE_OFFSET_MASK{(1UL << BASE_OFFSET_FIELD_BITSIZE) - 1};

static_assert(SIZE_FIELD_BITSIZE + BASE_OFFSET_FIELD_BITSIZE == std::numeric_limits<uint64_t>::digits);

public:
static constexpr uint64_t max_size() noexcept {
return 1UL << SIZE_FIELD_BITSIZE;
}

static constexpr uint64_t max_alignment() noexcept {
return 1UL << BASE_OFFSET_FIELD_BITSIZE;
}

uint64_t raw() const noexcept {
return (static_cast<uint64_t>(base_offset) << SIZE_FIELD_BITSIZE) | (static_cast<uint64_t>(size) & BLOCK_SIZE_MASK);
}

static control_block from_raw(uint64_t raw) noexcept {
return control_block{.size = raw & BLOCK_SIZE_MASK, .base_offset = static_cast<uint16_t>((raw >> SIZE_FIELD_BITSIZE) & BASE_OFFSET_MASK)};
}

uint64_t size : SIZE_FIELD_BITSIZE;
uint16_t base_offset : BASE_OFFSET_FIELD_BITSIZE;
};

inline bool is_power_of_2(uint64_t v) noexcept {
return v && !(v & (v - 1));
}

static_assert(sizeof(control_block) == sizeof(uint64_t), "Control block's size must be equal to uint64");

constexpr uint64_t MALLOC_REPLACER_MAX_ALLOC = 0xFFFFFF00; // 4GiB

template<auto get_allocator_func>
struct malloc_interface {
static auto alloc(size_t size) noexcept -> void* {
constexpr size_t cb_size{sizeof(kphp::memory::details::control_block)};
if (unlikely(size > std::min(kphp::memory::details::control_block::max_size(), MALLOC_REPLACER_MAX_ALLOC) - cb_size)) {
php_warning("attempt to allocate too much memory by malloc replacer, requested : %lu", size);
return nullptr;
}
const size_t total_size{size + cb_size};
void* base{get_allocator_func().alloc_script_memory(total_size)};
if (unlikely(base == nullptr)) {
php_warning("not enough script memory to allocate, requested : %lu, actual requested: %lu", size, total_size);
return base;
}
*(static_cast<uint64_t*>(base)) = kphp::memory::details::control_block{.size = total_size, .base_offset = cb_size}.raw();
return static_cast<void*>(static_cast<uint8_t*>(base) + cb_size);
}

static auto alloc_aligned(size_t size, std::align_val_t alignment) noexcept -> void* {
// Check that provided alignment is power of two
const size_t align{static_cast<uint64_t>(alignment)};
if (unlikely(align == 0 || !kphp::memory::details::is_power_of_2(align) || align >= kphp::memory::details::control_block::max_alignment())) {
php_warning("allocation alignment have to be non-zero power of two and not greater than %" PRIu64 ", got : %lu",
kphp::memory::details::control_block::max_alignment(), align);
return nullptr;
}

// Check that memory is enough
constexpr size_t cb_size{sizeof(kphp::memory::details::control_block)};
if (unlikely(size > std::min(kphp::memory::details::control_block::max_size(), MALLOC_REPLACER_MAX_ALLOC) - (align - 1) - cb_size)) {
php_warning("attempt to allocate too much memory by malloc replacer, requested : %lu", size);
return nullptr;
}

// Request mem from underlying memory manager
const size_t total_size{size + (align - 1) + cb_size};
void* base{get_allocator_func().alloc_script_memory(total_size)};
if (unlikely(base == nullptr)) {
php_warning("not enough script memory to allocate, requested : %lu, actual requested: %lu", size, total_size);
return base;
}

const uint64_t base_u{reinterpret_cast<uint64_t>(base)};
// The smallest multiple of `align` greater than or equal to requested memory
const uint64_t aligned_u{((base_u + cb_size) + (align - 1)) & ~(align - 1)};
const uint64_t base_offset_u{aligned_u - base_u};

// Save control block
*(reinterpret_cast<uint64_t*>(aligned_u - cb_size)) = // NOLINT
kphp::memory::details::control_block{.size = total_size, .base_offset = static_cast<std::uint16_t>(base_offset_u)}.raw();

return reinterpret_cast<void*>(aligned_u); // NOLINT
}

static auto calloc(size_t num, size_t size) noexcept -> void* {
void* ptr{alloc(num * size)};
if (unlikely(ptr == nullptr)) {
return nullptr;
}
return std::memset(ptr, 0, num * size);
}

static auto free(void* ptr) noexcept -> void {
if (unlikely(ptr == nullptr)) {
return;
}

constexpr size_t cb_size{sizeof(kphp::memory::details::control_block)};
const auto mem{reinterpret_cast<uint64_t>(ptr)};

const auto cb{kphp::memory::details::control_block::from_raw(*reinterpret_cast<uint64_t*>(mem - cb_size))}; // NOLINT
void* base{reinterpret_cast<void*>(mem - cb.base_offset)}; // NOLINT

get_allocator_func().free_script_memory(base, cb.size);
}

static auto realloc(void* ptr, size_t new_size) noexcept -> void* {
if (unlikely(ptr == nullptr)) {
return alloc(new_size);
}

if (unlikely(new_size == 0)) {
free(ptr);
return nullptr;
}

constexpr size_t cb_size{sizeof(kphp::memory::details::control_block)};
const auto mem{reinterpret_cast<uint64_t>(ptr)};

const auto cb{kphp::memory::details::control_block::from_raw(*reinterpret_cast<uint64_t*>(mem - cb_size))}; // NOLINT

void* old_base{reinterpret_cast<void*>(mem - cb.base_offset)}; // NOLINT
const size_t old_size{cb.size};

void* new_ptr{alloc(new_size)};
if (likely(new_ptr != nullptr)) {
std::memcpy(new_ptr, ptr, std::min(new_size, old_size));
get_allocator_func().free_script_memory(old_base, old_size);
}
return new_ptr;
}

static auto strdup(const char* str1) noexcept -> char* {
auto* str2{static_cast<char*>(alloc(std::strlen(str1) + 1))};
return std::strcpy(str2, str1);
}
};

} // namespace kphp::memory::details
38 changes: 38 additions & 0 deletions runtime-common/core/allocator/details/pool-allocator.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Compiler for PHP (aka KPHP)
// Copyright (c) 2026 LLC «V Kontakte»
// Distributed under the GPL v3 License, see LICENSE.notice.txt

#pragma once

#include <cstddef>

#include "common/mixin/not_copyable.h"
#include "runtime-common/core/memory-resource/unsynchronized_pool_resource.h"

namespace kphp::memory::details {

struct pool_allocator : private vk::not_copyable {
pool_allocator() = default;
pool_allocator(size_t script_mem_size, size_t min_extra_mem_size, size_t oom_handling_mem_size) noexcept;

auto init(void* buffer, size_t script_mem_size, size_t oom_handling_mem_size) noexcept -> void;
auto free() noexcept -> void;

auto alloc_script_memory(size_t size) noexcept -> void*;
auto alloc0_script_memory(size_t size) noexcept -> void*;
auto realloc_script_memory(void* mem, size_t new_size, size_t old_size) noexcept -> void*;
auto free_script_memory(void* mem, size_t size) noexcept -> void;

auto get_memory_resource() noexcept -> memory_resource::unsynchronized_pool_resource&;

private:
auto request_extra_memory(size_t requested_size) noexcept -> void;

public:
memory_resource::unsynchronized_pool_resource memory_resource;

private:
size_t m_min_extra_mem_size{0};
};

} // namespace kphp::memory::details
18 changes: 18 additions & 0 deletions runtime-common/core/allocator/global-memory-allocator.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// Compiler for PHP (aka KPHP)
// Copyright (c) 2026 LLC «V Kontakte»
// Distributed under the GPL v3 License, see LICENSE.notice.txt

#pragma once

#include <cstddef>

#include "common/mixin/not_copyable.h"

struct GlobalMemoryAllocator final : private vk::not_copyable {
static auto get() noexcept -> GlobalMemoryAllocator&;

auto alloc_global_memory(size_t size) noexcept -> void*;
auto alloc0_global_memory(size_t size) noexcept -> void*;
auto realloc_global_memory(void* mem, size_t new_size, size_t old_size) noexcept -> void*;
auto free_global_memory(void* mem, size_t size) noexcept -> void;
};
6 changes: 3 additions & 3 deletions runtime-common/core/allocator/platform-allocator.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

#include <cstddef>

#include "runtime-common/core/allocator/runtime-allocator.h"
#include "runtime-common/core/allocator/global-memory-allocator.h"

namespace kphp::memory {

Expand All @@ -25,11 +25,11 @@ struct platform_allocator {
};

constexpr value_type* allocate(size_t n) noexcept {
return static_cast<value_type*>(RuntimeAllocator::get().alloc_global_memory(n * sizeof(T)));
return static_cast<value_type*>(GlobalMemoryAllocator::get().alloc_global_memory(n * sizeof(T)));
}

constexpr void deallocate(T* p, size_t n) noexcept {
RuntimeAllocator::get().free_global_memory(p, n * sizeof(T));
GlobalMemoryAllocator::get().free_global_memory(p, n * sizeof(T));
}
};

Expand Down
8 changes: 4 additions & 4 deletions runtime-common/core/allocator/platform-malloc-interface.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
#include <cstring>

#include "common/wrappers/likely.h"
#include "runtime-common/core/allocator/runtime-allocator.h"
#include "runtime-common/core/allocator/global-memory-allocator.h"
#include "runtime-common/core/utils/kphp-assert-core.h"

namespace kphp::memory::platform {
Expand All @@ -24,7 +24,7 @@ inline void* alloc(size_t size) noexcept {
return nullptr;
}
const size_t real_size{size + MALLOC_REPLACER_SIZE_OFFSET};
void* ptr{RuntimeAllocator::get().alloc_global_memory(real_size)};
void* ptr{GlobalMemoryAllocator::get().alloc_global_memory(real_size)};

if (unlikely(ptr == nullptr)) {
php_warning("not enough platform memory to allocate: %lu", size);
Expand All @@ -45,7 +45,7 @@ inline void* calloc(size_t num, size_t size) noexcept {
inline void free(void* ptr) noexcept {
if (likely(ptr != nullptr)) {
void* real_ptr{static_cast<std::byte*>(ptr) - MALLOC_REPLACER_SIZE_OFFSET};
RuntimeAllocator::get().free_global_memory(real_ptr, *static_cast<size_t*>(real_ptr));
GlobalMemoryAllocator::get().free_global_memory(real_ptr, *static_cast<size_t*>(real_ptr));
}
}

Expand All @@ -65,7 +65,7 @@ inline void* realloc(void* ptr, size_t new_size) noexcept {
void* new_ptr{kphp::memory::platform::alloc(new_size)};
if (likely(new_ptr != nullptr)) {
std::memcpy(new_ptr, ptr, std::min(new_size, old_size));
RuntimeAllocator::get().free_global_memory(real_ptr, old_size);
GlobalMemoryAllocator::get().free_global_memory(real_ptr, old_size);
}
return new_ptr;
}
Expand Down
41 changes: 17 additions & 24 deletions runtime-common/core/allocator/runtime-allocator.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,27 @@

#include <cstddef>

#include "common/mixin/not_copyable.h"
#include "runtime-common/core/memory-resource/unsynchronized_pool_resource.h"
#include "runtime-common/core/allocator/details/pool-allocator.h"

struct RuntimeAllocator final : vk::not_copyable {
static RuntimeAllocator& get() noexcept;

RuntimeAllocator() = default;
RuntimeAllocator(size_t script_mem_size, size_t min_extra_mem_size, size_t oom_handling_mem_size);

void init(void* buffer, size_t script_mem_size, size_t oom_handling_mem_size);
void free();
struct RuntimeAllocator final {
private:
kphp::memory::details::pool_allocator m_allocator;

void* alloc_script_memory(size_t size) noexcept;
void* alloc0_script_memory(size_t size) noexcept;
void* realloc_script_memory(void* mem, size_t new_size, size_t old_size) noexcept;
void free_script_memory(void* mem, size_t size) noexcept;
public:
static auto get() noexcept -> RuntimeAllocator&;

void* alloc_global_memory(size_t size) noexcept;
void* alloc0_global_memory(size_t size) noexcept;
void* realloc_global_memory(void* mem, size_t new_size, size_t old_size) noexcept;
void free_global_memory(void* mem, size_t size) noexcept;
RuntimeAllocator() = default;
RuntimeAllocator(size_t script_mem_size, size_t min_extra_mem_size, size_t oom_handling_mem_size) noexcept;

private:
void request_extra_memory(size_t requested_size) noexcept;
auto init(void* buffer, size_t script_mem_size, size_t oom_handling_mem_size) noexcept -> void;
auto free() noexcept -> void;

public:
memory_resource::unsynchronized_pool_resource memory_resource;
auto alloc_script_memory(size_t size) noexcept -> void*;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we have common implementations for some of these methods?

@LLirikkkk LLirikkkk Aug 18, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only for get_memory_resource, but legacy runtime doesn't need to have get_memory_resource implementation, because it doesn't use pool allocator for allocations

anyway common implementation of get_memory_resource is added to RuntimeAllocator

auto alloc0_script_memory(size_t size) noexcept -> void*;
auto realloc_script_memory(void* mem, size_t new_size, size_t old_size) noexcept -> void*;
auto free_script_memory(void* mem, size_t size) noexcept -> void;

private:
size_t m_min_extra_mem_size{0};
auto get_memory_resource() noexcept -> memory_resource::unsynchronized_pool_resource& {
return m_allocator.get_memory_resource();
}
};
Loading
Loading