slitter 0.1.0

A C- and Rust-callable slab allocator with a focus on safety
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

#pragma once

#include <stddef.h>

/*
 * Define default constants
 */
#ifndef SLITTER__SMALL_CONSTANTS
# define SLITTER__MAGAZINE_SIZE 30
# define SLITTER__DATA_ALIGNMENT (1UL << 30)
# define SLITTER__GUARD_PAGE_SIZE (2UL << 20)
# define SLITTER__METADATA_PAGE_SIZE (2UL << 20)
# define SLITTER__SPAN_ALIGNMENT (16UL << 10)

/*
 * The default of classes we can handle in the thread-local cache's
 * preallocated array of `cache_magazines`.  We need one more for the
 * dummy 0 class.
 *
 * At 32 bytes per class, 15 classes take up 512 thread-local bytes.
 */
#ifndef SLITTER__CACHE_PREALLOC
# define SLITTER__CACHE_PREALLOC 15
#endif

#else
# define SLITTER__MAGAZINE_SIZE 6
# define SLITTER__DATA_ALIGNMENT (2UL << 20)
# define SLITTER__GUARD_PAGE_SIZE (16UL << 10)
# define SLITTER__METADATA_PAGE_SIZE (16UL << 10)
# define SLITTER__SPAN_ALIGNMENT (4UL << 10)

#ifndef SLITTER__CACHE_PREALLOC
# define SLITTER__CACHE_PREALLOC 3
#endif

#endif

/**
 * Returns the value of the `SLITTER__MAGAZINE_SIZE` constant on the C
 * side.
 *
 * The Rust code uses this function to confirm that the constant has
 * the same value on both sides.
 */
size_t slitter__magazine_size(void);

/**
 * Returns the value of the `SLITTER__DATA_ALIGNMENT` constant on the
 * C side.
 */
size_t slitter__data_alignment(void);

/**
 * Returns the value of the `SLITTER__GUARD_PAGE_SIZE` constant on the
 * C side.
 */
size_t slitter__guard_page_size(void);

/**
 * Returns the value of the `SLITTER__METADATA_PAGE_SIZE` constant on
 * the C side.
 */
size_t slitter__metadata_page_size(void);

/**
 * Returns the value of the `SLITTER__SPAN_ALIGNMENT` constant on the
 * C side.
 */
size_t slitter__span_alignment(void);