File: arena.c

package info (click to toggle)
graphviz 14.0.5-2
  • links: PTS
  • area: main
  • in suites:
  • size: 139,388 kB
  • sloc: ansic: 141,938; cpp: 11,957; python: 7,766; makefile: 4,043; yacc: 3,030; xml: 2,972; tcl: 2,495; sh: 1,388; objc: 1,159; java: 560; lex: 423; perl: 243; awk: 156; pascal: 139; php: 58; ruby: 49; cs: 31; sed: 1
file content (172 lines) | stat: -rw-r--r-- 5,446 bytes parent folder | download | duplicates (2)
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/// @file
/// @brief Implementation of the arena.h API

#include <assert.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <util/alloc.h>
#include <util/arena.h>
#include <util/asan.h>
#include <util/unused.h>

/// a block of backing memory
///
/// Note that this is only the header metadata. When one of these structures is
/// allocated, it is followed by raw bytes used for allocations themselves.
struct arena_chunk {
  arena_chunk_t *previous; ///< previous chunk that was in use
};

/// `popcount(value) == 1`?
static UNUSED bool is_power_of_2(size_t value) {
  if (value == 0) {
    return false;
  }
  while ((value & 1) != 1) {
    value >>= 1;
  }
  return value == 1;
}

/// get some more memory from the system allocator
///
/// @param arena Arena to install the new memory into
/// @param req_alignment Alignment request that led to this call
/// @param req_size Size request that led to this call
static void more_core(arena_t *arena, size_t req_alignment, size_t req_size) {
  assert(arena != NULL);
  assert(req_alignment != 0);

  // A default number of bytes to allocate in a chunk. The aim is for the
  // resulting allocation to be a multiple of the system page size, to encourage
  // the system to give us entire pages. If this does not work out, it is not
  // critical.
  enum { DEFAULT_CHUNK = 16384 - sizeof(arena_chunk_t) };

  size_t chunk_size = DEFAULT_CHUNK;
  // override the default size if we are allocating something too large
  if (chunk_size < req_size + req_alignment - 1) {
    chunk_size = req_size + req_alignment - 1;
  }

  arena_chunk_t *const more = gv_alloc(sizeof(arena_chunk_t) + chunk_size);

  // mark the newly available space as unused
  ASAN_POISON((char *)more + sizeof(arena_chunk_t), chunk_size);

  // install the new chunk
  more->previous = arena->source;
  arena->source = more;
  arena->remaining = chunk_size;
}

/// allocate new dynamic memory
///
/// @param arena Arena to allocate from
/// @param alignment Requested alignment
/// @param size Requested size in bytes
/// @return Pointer to allocated memory or `NULL` on failure
static void *alloc(arena_t *arena, size_t alignment, size_t size) {
  assert(arena != NULL);
  assert(alignment != 0);
  assert(is_power_of_2(alignment));

  if (arena->remaining < size) {
    return NULL;
  }

  const uintptr_t base = (uintptr_t)arena->source + sizeof(arena_chunk_t);
  const uintptr_t limit = base + arena->remaining;

  // Allocate from the end of the chunk memory, for simplicity. E.g.:
  //
  //                actual allocation ┐     ┌ wasted space
  //                              ┌───┴───┬─┴─┐
  //          ┌────────┬──────────┬───────┬───┬───────────────┐
  //   chunk: │previous│ <free> … │       │   │ <allocated> … │
  //          └────────┴──────────┴───────┴───┴───────────────┘
  //                   ▲          ▲       ▲   ▲
  //              base ┘    start ┘       │   └ limit
  //                                      └ start + size
  const uintptr_t start = (limit - size) & ~(alignment - 1);

  if (start < base) {
    // we had enough bytes, but not enough aligned bytes
    return NULL;
  }

  arena->remaining -= limit - start;

  // Only unpoison the narrow allocation, not the full area we are carving off.
  // Repeating the diagram from above:
  //
  //                 unpoisoning this ┐     ┌ not unpoisoning this
  //                              ┌───┴───┬─┴─┐
  //          ┌────────┬──────────┬───────┬───┬───────────────┐
  //   chunk: │previous│ <free> … │       │   │ <allocated> … │
  //          └────────┴──────────┴───────┴───┴───────────────┘
  void *const ret = (void *)start;
  ASAN_UNPOISON(ret, size);

  return ret;
}

void *gv_arena_alloc(arena_t *arena, size_t alignment, size_t size) {
  assert(arena != NULL);

  if (size == 0) {
    return NULL;
  }

  void *ptr = alloc(arena, alignment, size);

  // if we failed, get some more memory and try again
  if (ptr == NULL) {
    more_core(arena, alignment, size);
    ptr = alloc(arena, alignment, size);
  }

  return ptr;
}

char *gv_arena_strdup(arena_t *arena, const char *s) {
  assert(arena != NULL);
  assert(s != NULL);

  const size_t len = strlen(s);
  char *const ret = gv_arena_alloc(arena, 1, len + 1);
  assert(ret != NULL);
  memcpy(ret, s, len);
  ret[len] = '\0';

  return ret;
}

void gv_arena_free(arena_t *arena, void *ptr, size_t size) {
  assert(arena != NULL);

  if (ptr == NULL) {
    return;
  }

  // teach ASan that this region should no longer be accessible
  ASAN_POISON(ptr, size);

  // we do not actually deallocate the memory, but leave it to be freed when the
  // arena is eventually reset
  (void)arena;
}

void gv_arena_reset(arena_t *arena) {
  assert(arena != NULL);

  while (arena->source != NULL) {
    arena_chunk_t *const previous = arena->source->previous;
    free(arena->source);
    arena->source = previous;
  }

  *arena = (arena_t){0};
}