Skip to content

refactor benchmark file structure #1031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 10, 2025
Merged

refactor benchmark file structure #1031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
162 changes: 15 additions & 147 deletions benchmark/benchmark.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,161 +6,29 @@
*
*/

#include <benchmark/benchmark.h>
#include <umf/pools/pool_proxy.h>
#ifdef UMF_POOL_SCALABLE_ENABLED
#include <umf/pools/pool_scalable.h>
#endif
#include <umf/providers/provider_os_memory.h>

#ifdef UMF_POOL_DISJOINT_ENABLED
#include <umf/pools/pool_disjoint.h>
#endif

#ifdef UMF_POOL_JEMALLOC_ENABLED
#include <umf/pools/pool_jemalloc.h>
#endif

#include "benchmark.hpp"

struct glibc_malloc : public allocator_interface {
unsigned SetUp([[maybe_unused]] ::benchmark::State &state,
unsigned argPos) override {
return argPos;
}
void TearDown([[maybe_unused]] ::benchmark::State &state) override{};
void *benchAlloc(size_t size) override { return malloc(size); }
void benchFree(void *ptr, [[maybe_unused]] size_t size) override {
free(ptr);
#define UMF_BENCHMARK_TEMPLATE_DEFINE(BaseClass, Method, ...) \
BENCHMARK_TEMPLATE_DEFINE_F(BaseClass, Method, __VA_ARGS__) \
(benchmark::State & state) { \
for (auto _ : state) { \
bench(state); \
} \
}
static std::string name() { return "glibc"; }
};

struct os_provider : public provider_interface {
provider_interface::params_ptr
getParams(::benchmark::State &state) override {
umf_os_memory_provider_params_handle_t raw_params = nullptr;
umfOsMemoryProviderParamsCreate(&raw_params);
if (!raw_params) {
state.SkipWithError("Failed to create os provider params");
return {nullptr, [](void *) {}};
}

// Use a lambda as the custom deleter
auto deleter = [](void *p) {
auto handle =
static_cast<umf_os_memory_provider_params_handle_t>(p);
umfOsMemoryProviderParamsDestroy(handle);
};

return {static_cast<void *>(raw_params), deleter};
}

umf_memory_provider_ops_t *
getOps([[maybe_unused]] ::benchmark::State &state) override {
return umfOsMemoryProviderOps();
}
static std::string name() { return "os_provider"; }
};

template <typename Provider>
struct proxy_pool : public pool_interface<Provider> {
umf_memory_pool_ops_t *
getOps([[maybe_unused]] ::benchmark::State &state) override {
return umfProxyPoolOps();
}

static std::string name() { return "proxy_pool<" + Provider::name() + ">"; }
};

#ifdef UMF_POOL_DISJOINT_ENABLED
template <typename Provider>
struct disjoint_pool : public pool_interface<Provider> {
umf_memory_pool_ops_t *
getOps([[maybe_unused]] ::benchmark::State &state) override {
return umfDisjointPoolOps();
}

typename pool_interface<Provider>::params_ptr
getParams(::benchmark::State &state) override {
umf_disjoint_pool_params_handle_t raw_params = nullptr;
auto ret = umfDisjointPoolParamsCreate(&raw_params);
if (ret != UMF_RESULT_SUCCESS) {
state.SkipWithError("Failed to create disjoint pool params");
return {nullptr, [](void *) {}};
}

typename pool_interface<Provider>::params_ptr params(
raw_params, [](void *p) {
umfDisjointPoolParamsDestroy(
static_cast<umf_disjoint_pool_params_handle_t>(p));
});

ret = umfDisjointPoolParamsSetSlabMinSize(raw_params, 4096);
if (ret != UMF_RESULT_SUCCESS) {
state.SkipWithError("Failed to set slab min size");
return {nullptr, [](void *) {}};
}

ret = umfDisjointPoolParamsSetCapacity(raw_params, 4);
if (ret != UMF_RESULT_SUCCESS) {
state.SkipWithError("Failed to set capacity");
return {nullptr, [](void *) {}};
}

ret = umfDisjointPoolParamsSetMinBucketSize(raw_params, 4096);
if (ret != UMF_RESULT_SUCCESS) {
state.SkipWithError("Failed to set min bucket size");
return {nullptr, [](void *) {}};
}

ret = umfDisjointPoolParamsSetMaxPoolableSize(raw_params, 4096 * 16);
if (ret != UMF_RESULT_SUCCESS) {
state.SkipWithError("Failed to set max poolable size");
return {nullptr, [](void *) {}};
}

return params;
}

static std::string name() {
return "disjoint_pool<" + Provider::name() + ">";
}
};
#endif

#ifdef UMF_POOL_JEMALLOC_ENABLED
template <typename Provider>
struct jemalloc_pool : public pool_interface<Provider> {
umf_memory_pool_ops_t *
getOps([[maybe_unused]] ::benchmark::State &state) override {
return umfJemallocPoolOps();
}

static std::string name() {
return "jemalloc_pool<" + Provider::name() + ">";
}
};
#endif

#ifdef UMF_POOL_SCALABLE_ENABLED
template <typename Provider>
struct scalable_pool : public pool_interface<Provider> {
virtual umf_memory_pool_ops_t *
getOps([[maybe_unused]] ::benchmark::State &state) override {
return umfScalablePoolOps();
}

static std::string name() {
return "scalable_pool<" + Provider::name() + ">";
}
};
#endif
// Benchmarks scenarios:
#define UMF_BENCHMARK_REGISTER_F(BaseClass, Method) \
BENCHMARK_REGISTER_F(BaseClass, Method) \
->ArgNames( \
BENCHMARK_PRIVATE_CONCAT_NAME(BaseClass, Method)::argsName()) \
->Name(BENCHMARK_PRIVATE_CONCAT_NAME(BaseClass, Method)::name()) \
->Iterations( \
BENCHMARK_PRIVATE_CONCAT_NAME(BaseClass, Method)::iterations())

UMF_BENCHMARK_TEMPLATE_DEFINE(alloc_benchmark, glibc_fix, fixed_alloc_size,
glibc_malloc);

// Benchmarks scenarios:

// The benchmark arguments specified in Args() are, in order:
// benchmark arguments, allocator arguments, size generator arguments.
// The exact meaning of each argument depends on the benchmark, allocator, and size components used.
Expand Down
171 changes: 71 additions & 100 deletions benchmark/benchmark.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,70 +75,97 @@
#include <umf/memory_pool.h>
#include <umf/memory_provider.h>

#include "benchmark_interfaces.hpp"
#include "benchmark_size.hpp"
#include "benchmark_umf.hpp"

struct alloc_data {
void *ptr;
size_t size;
};

#define UMF_BENCHMARK_TEMPLATE_DEFINE(BaseClass, Method, ...) \
BENCHMARK_TEMPLATE_DEFINE_F(BaseClass, Method, __VA_ARGS__) \
(benchmark::State & state) { \
for (auto _ : state) { \
bench(state); \
} \
template <typename Provider, typename = std::enable_if_t<std::is_base_of<
provider_interface, Provider>::value>>
class provider_allocator : public allocator_interface {
public:
unsigned SetUp(::benchmark::State &state, unsigned r) override {
provider.SetUp(state);
return r;
}

#define UMF_BENCHMARK_REGISTER_F(BaseClass, Method) \
BENCHMARK_REGISTER_F(BaseClass, Method) \
->ArgNames( \
BENCHMARK_PRIVATE_CONCAT_NAME(BaseClass, Method)::argsName()) \
->Name(BENCHMARK_PRIVATE_CONCAT_NAME(BaseClass, Method)::name()) \
->Iterations( \
BENCHMARK_PRIVATE_CONCAT_NAME(BaseClass, Method)::iterations())
void TearDown(::benchmark::State &state) override {
provider.TearDown(state);
}

class fixed_alloc_size : public alloc_size_interface {
public:
unsigned SetUp(::benchmark::State &state, unsigned argPos) override {
size = state.range(argPos);
return argPos + 1;
void *benchAlloc(size_t size) override {
void *ptr;
if (umfMemoryProviderAlloc(provider.provider, size, 0, &ptr) !=
UMF_RESULT_SUCCESS) {
return NULL;
}
return ptr;
}

void benchFree(void *ptr, size_t size) override {
umfMemoryProviderFree(provider.provider, ptr, size);
}
void TearDown([[maybe_unused]] ::benchmark::State &state) override {}
size_t nextSize() override { return size; };
static std::vector<std::string> argsName() { return {"size"}; }

static std::string name() { return Provider::name(); }

private:
size_t size;
Provider provider;
};

class uniform_alloc_size : public alloc_size_interface {
using distribution = std::uniform_int_distribution<int64_t>;

// TODO: assert Pool to be a pool_interface<provider_interface>.
template <typename Pool> class pool_allocator : public allocator_interface {
public:
unsigned SetUp(::benchmark::State &state, unsigned argPos) override {
auto min = state.range(argPos++);
auto max = state.range(argPos++);
auto gran = state.range(argPos++);
if (min % gran != 0 && max % gran != 0) {
state.SkipWithError("min and max must be divisible by granularity");
return argPos;
}
unsigned SetUp(::benchmark::State &state, unsigned r) override {
pool.SetUp(state);
return r;
}

void TearDown(::benchmark::State &state) override { pool.TearDown(state); }

dist.param(distribution::param_type(min / gran, max / gran));
multiplier = gran;
return argPos;
virtual void *benchAlloc(size_t size) override {
return umfPoolMalloc(pool.pool, size);
}
void TearDown([[maybe_unused]] ::benchmark::State &state) override {}
size_t nextSize() override { return dist(generator) * multiplier; }
static std::vector<std::string> argsName() {
return {"min size", "max size", "granularity"};

virtual void benchFree(void *ptr, [[maybe_unused]] size_t size) override {
umfPoolFree(pool.pool, ptr);
}

static std::string name() { return Pool::name(); }

private:
std::default_random_engine generator;
distribution dist;
size_t multiplier;
Pool pool;
};

template <typename Size, typename Allocator>
struct benchmark_interface : public benchmark::Fixture {
void SetUp(::benchmark::State &state) {
int argPos = alloc_size.SetUp(state, 0);
allocator.SetUp(state, argPos);
}

void TearDown(::benchmark::State &state) {
alloc_size.TearDown(state);
allocator.TearDown(state);
}

virtual void bench(::benchmark::State &state) = 0;

static std::vector<std::string> argsName() {
auto s = Size::argsName();
auto a = Allocator::argsName();
std::vector<std::string> res = {};
res.insert(res.end(), s.begin(), s.end());
res.insert(res.end(), a.begin(), a.end());
return res;
}

static std::string name() { return Allocator::name(); }
static int64_t iterations() { return 10000; }
Size alloc_size;
Allocator allocator;
};

// This class benchmarks speed of alloc() operations.
Expand Down Expand Up @@ -335,59 +362,3 @@ class multiple_malloc_free_benchmark : public alloc_benchmark<Size, Alloc> {
std::default_random_engine generator;
distribution dist;
};

template <typename Provider, typename = std::enable_if_t<std::is_base_of<
provider_interface, Provider>::value>>
class provider_allocator : public allocator_interface {
public:
unsigned SetUp(::benchmark::State &state, unsigned r) override {
provider.SetUp(state);
return r;
}

void TearDown(::benchmark::State &state) override {
provider.TearDown(state);
}

void *benchAlloc(size_t size) override {
void *ptr;
if (umfMemoryProviderAlloc(provider.provider, size, 0, &ptr) !=
UMF_RESULT_SUCCESS) {
return NULL;
}
return ptr;
}

void benchFree(void *ptr, size_t size) override {
umfMemoryProviderFree(provider.provider, ptr, size);
}

static std::string name() { return Provider::name(); }

private:
Provider provider;
};

// TODO: assert Pool to be a pool_interface<provider_interface>.
template <typename Pool> class pool_allocator : public allocator_interface {
public:
unsigned SetUp(::benchmark::State &state, unsigned r) override {
pool.SetUp(state);
return r;
}

void TearDown(::benchmark::State &state) override { pool.TearDown(state); }

virtual void *benchAlloc(size_t size) override {
return umfPoolMalloc(pool.pool, size);
}

virtual void benchFree(void *ptr, [[maybe_unused]] size_t size) override {
umfPoolFree(pool.pool, ptr);
}

static std::string name() { return Pool::name(); }

private:
Pool pool;
};
Loading
Loading