source: lib/data-struct/object_cache.c @ 6e41e73

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivelibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since 6e41e73 was 6e41e73, checked in by Richard Sanger <rsangerarj@…>, 7 years ago

Fixes bug where packets could be destroyed by unregistered threads
We now destroy the packet object cache thread caches before unresistering a thread

Also includes some whitespace fixes.

  • Property mode set to 100644
File size: 14.1 KB
Line 
1#include "object_cache.h"
2#include <assert.h>
3#include <stdio.h>
4#include <stdlib.h>
5#include <string.h>
6
7
8// pthread tls is most likely slower than __thread, but they have destructors so
9// we use a combination of the two here!!
10struct local_cache {
11        libtrace_ocache_t *oc;
12        size_t total;
13        size_t used;
14        void **cache;
15        bool invalid;
16};
17
18struct mem_stats {
19        struct memfail {
20           uint64_t cache_hit;
21           uint64_t ring_hit;
22           uint64_t miss;
23           uint64_t recycled;
24        } readbulk, read, write, writebulk;
25};
26
27extern __thread struct mem_stats mem_hits;
28static __thread size_t t_mem_caches_used = 0;
29static __thread size_t t_mem_caches_total = 0;
30static __thread struct local_cache *t_mem_caches = NULL;
31static pthread_key_t memory_destructor_key;
32static pthread_once_t memory_destructor_once = PTHREAD_ONCE_INIT;
33
34/**
35 * @brief unregister_thread assumes we DONT hold spin
36 */
37static inline void unregister_thread(struct local_cache *lc) {
38        size_t i;
39        if (lc->invalid)
40                fprintf(stderr, "Already free'd the thread cache!!\n");
41        pthread_spin_lock(&lc->oc->spin);
42        // Remove it from our thread list
43        for (i=0; i < lc->oc->nb_thread_list; ++i) {
44                if (lc->oc->thread_list[i] == lc) {
45                        --lc->oc->nb_thread_list;
46                        lc->oc->thread_list[i] = lc->oc->thread_list[lc->oc->nb_thread_list];
47                        lc->oc->thread_list[lc->oc->nb_thread_list] = NULL;
48                        i = ~0U;
49                        break;
50                }
51        }
52        if (i != ~0U) {
53                fprintf(stderr, "Umm this wasn't registered with us in the first place!!!!IGNORGING!!!!ANGRY\n");
54                pthread_spin_unlock(&lc->oc->spin);
55                return;
56        }
57        lc->invalid = true;
58
59        if (lc->oc->max_allocations) {
60                libtrace_ringbuffer_swrite_bulk(&lc->oc->rb, lc->cache, lc->used, lc->used);
61        } else {
62                size_t i;
63                // We just run the free these
64                for(i = 0; i < lc->used; ++i) {
65                        lc->oc->free(lc->cache[i]);
66                }
67        }
68        pthread_spin_unlock(&lc->oc->spin);
69}
70
71/**
72 * @brief register_thread assumes we DONT hold spin
73 */
74static inline void register_thread(libtrace_ocache_t *oc, struct local_cache *lc) {
75        lc->invalid = false;
76        pthread_spin_lock(&oc->spin);
77        if (oc->nb_thread_list == oc->max_nb_thread_list) {
78                oc->max_nb_thread_list += 0x10;
79                oc->thread_list = realloc(oc->thread_list, sizeof(void*) * oc->max_nb_thread_list);
80        }
81        oc->thread_list[oc->nb_thread_list] = lc;
82        ++oc->nb_thread_list;
83        pthread_spin_unlock(&oc->spin);
84}
85
86static void destroy_memory_cache(void *tlsaddr) {
87        assert(tlsaddr == t_mem_caches);
88        size_t a;
89
90        for (a = 0; a < t_mem_caches_used; ++a) {
91                unregister_thread(&t_mem_caches[a]);
92                // Write these all back to the main buffer, this might have issues we would want to free these
93                free(t_mem_caches[a].cache);
94        }
95        free(t_mem_caches);
96        t_mem_caches = NULL;
97}
98
99static void once_memory_cache_key_init() {
100        ASSERT_RET(pthread_key_create(&memory_destructor_key, &destroy_memory_cache), == 0);
101}
102
103/**
104 * Adds more space to our mem_caches
105 */
106static void resize_memory_caches() {
107        if (t_mem_caches == NULL) {
108                pthread_once(&memory_destructor_once, &once_memory_cache_key_init);
109                t_mem_caches_total = 0x10;
110                t_mem_caches = calloc(0x10, sizeof(struct local_cache));
111                pthread_setspecific(memory_destructor_key, (void *) t_mem_caches);
112        } else {
113                t_mem_caches += 0x10;
114                t_mem_caches = realloc(t_mem_caches, t_mem_caches_total * sizeof(struct local_cache));
115                pthread_setspecific(memory_destructor_key, t_mem_caches);
116        }
117}
118
119static inline struct local_cache * find_cache(libtrace_ocache_t *oc) {
120        struct local_cache *lc = NULL;
121        size_t i;
122
123        for (i = 0; i < t_mem_caches_used; ++i) {
124                if (t_mem_caches[i].oc == oc) {
125                        lc = &t_mem_caches[i];
126                        break;
127                }
128        }
129
130        if (!oc->thread_cache_size)
131                return 0;
132
133        // Create a cache
134        if (!lc) {
135                if (t_mem_caches_used == t_mem_caches_total)
136                        resize_memory_caches();
137                t_mem_caches[t_mem_caches_used].oc = oc;
138                t_mem_caches[t_mem_caches_used].used = 0;
139                t_mem_caches[t_mem_caches_used].total = oc->thread_cache_size;
140                t_mem_caches[t_mem_caches_used].cache = malloc(sizeof(void*) * oc->thread_cache_size);
141                t_mem_caches[t_mem_caches_used].invalid = false;
142                lc = &t_mem_caches[t_mem_caches_used];
143                // Register it with the underlying ring_buffer
144                register_thread(lc->oc, lc);
145                ++t_mem_caches_used;
146        }
147
148        assert(!lc->invalid);
149        return lc;
150}
151
152/**
153  * Creates a object cache, that is a pool of dynamically allocated and recycled
154  * objects of a fixed size. This should be faster than malloc and free.
155  * The alloc and free methods are supplied by the user and are used when no
156  * recycled objects are available, or to tidy the final results.
157  *
158  * The performance of these pools will decrease if thread caches are used
159  * as this results in a list to lookup per thread. The pool is added when
160  * to this list when first encountered, these persist untill the thread exits.
161  *
162  * NOTE: If limit_size is true do not attempt to 'free' any objects that were
163  * not created by this pool back otherwise the 'free' might deadlock. Also
164  * be cautious when picking the buffer size, upto thread_cache_size*(threads-1)
165  * could be unusable at any given time if these are stuck in thread local caches.
166  *
167  * @param oc A pointer to the object cache structure which is to be initialised.
168  * @param alloc The allocation method, must not be NULL. [void *alloc()]
169  * @param free The free method used to destroy packets. [void free(void * obj)]
170  * @param thread_cache_size A small cache kept on a per thread basis, this can be 0
171  *             however should only be done if bulk reads of packets are being performed
172  *             or contention is minimal.
173  * @param buffer_size The number of packets to be stored in the main buffer.
174  * @param limit_size If true no more objects than buffer_size will be allocated,
175  *             reads will block (free never should).Otherwise packets can be freely
176  *     allocated upon requested and are free'd if there is not enough space for them.
177  * @return Returns The number of packets outstanding, or extra object recevied
178  *             Ideally this should be zero (0) otherwise some form of memory leak
179  *             is likely present.
180  */
181DLLEXPORT void libtrace_ocache_init(libtrace_ocache_t *oc, void *(*alloc)(void), void (*free)(void *),
182                                                                          size_t thread_cache_size, size_t buffer_size, bool limit_size) {
183
184        assert(buffer_size);
185        assert(alloc);
186        assert(free);
187        libtrace_ringbuffer_init(&oc->rb, buffer_size, LIBTRACE_RINGBUFFER_BLOCKING);
188        oc->alloc = alloc;
189        oc->free = free;
190        oc->current_allocations = 0;
191        oc->thread_cache_size = thread_cache_size;
192        oc->nb_thread_list = 0;
193        oc->max_nb_thread_list = 0x10;
194        oc->thread_list = calloc(0x10, sizeof(void*));
195        pthread_spin_init(&oc->spin, 0);
196        if (limit_size)
197                oc->max_allocations = buffer_size;
198        else
199                oc->max_allocations = 0;
200}
201
202/**
203  * Destroys the object cache. Call this only once all memory has
204  * been free'd back and no more accesses will be made.
205  *
206  * @return Returns the number of packets outstanding, or extra object recevied
207  *             Ideally this should be zero (0) otherwise some form of memory leak
208  *             is likely present. Currenty only implemented in the case limit_size
209  *     is true.
210  */
211DLLEXPORT int libtrace_ocache_destroy(libtrace_ocache_t *oc) {
212        void *ele;
213
214        while (oc->nb_thread_list)
215                unregister_thread(oc->thread_list[0]);
216
217        pthread_spin_lock(&oc->spin);
218        while (libtrace_ringbuffer_try_read(&oc->rb, &ele)) {
219                oc->free(ele);
220                if (oc->max_allocations)
221                        --oc->current_allocations;
222        }
223        pthread_spin_unlock(&oc->spin);
224
225        // Make sure we haven't lost too many packets
226        if (oc->current_allocations)
227                fprintf(stderr, "!!OCache closing lost, %d packets!!\n", (int) oc->current_allocations);
228        else
229                /* This is clearly a bug, but I don't know what to replace it with... */
230                fprintf(stderr, "!!OCache closing lost, %d packets!!\n", (int) oc->current_allocations);
231        libtrace_ringbuffer_destroy(&oc->rb);
232        pthread_spin_destroy(&oc->spin);
233        free(oc->thread_list);
234        libtrace_zero_ocache(oc);
235        if (oc->current_allocations)
236                return (int) oc->current_allocations;
237        else
238                return 0;
239}
240
241static inline size_t libtrace_ocache_alloc_cache(libtrace_ocache_t *oc, void *values[], size_t nb_buffers, size_t min_nb_buffers,
242                                                                                 struct local_cache *lc) {
243        libtrace_ringbuffer_t *rb = &oc->rb;
244        size_t i;
245
246        // We have enough cached!! Yay
247        if (nb_buffers <= lc->used) {
248                // Copy all from cache
249                memcpy(values, &lc->cache[lc->used - nb_buffers], sizeof(void *) * nb_buffers);
250                lc->used -= nb_buffers;
251                mem_hits.read.cache_hit += nb_buffers;
252                mem_hits.readbulk.cache_hit += 1;
253                return nb_buffers;
254        }
255        // Cache is not big enough try read all from ringbuffer
256        else if (nb_buffers > lc->total) {
257                i = libtrace_ringbuffer_sread_bulk(rb, values, nb_buffers, min_nb_buffers);
258                if (i)
259                        mem_hits.readbulk.ring_hit += 1;
260                else
261                        mem_hits.readbulk.miss += 1;
262                mem_hits.read.ring_hit += i;
263        } else { // Not enough cached
264                // Empty the cache and re-fill it and then see what we're left with
265                i = lc->used;
266                memcpy(values, lc->cache, sizeof(void *) * lc->used);
267                mem_hits.read.cache_hit += i;
268
269                // Make sure we still meet the minimum requirement
270                if (i < min_nb_buffers)
271                        lc->used = libtrace_ringbuffer_sread_bulk(rb, lc->cache, lc->total, min_nb_buffers - i);
272                else
273                        lc->used = libtrace_ringbuffer_sread_bulk(rb, lc->cache, lc->total, 0);
274
275                if (lc->used == lc->total)
276                        mem_hits.readbulk.ring_hit += 1;
277                else
278                        mem_hits.readbulk.miss += 1;
279                mem_hits.read.ring_hit += lc->used;
280        }
281
282        // Try fill the remaining
283        if (i < nb_buffers && lc->used) {
284                size_t remaining;
285                remaining = MIN(lc->used, nb_buffers - i);
286                memcpy(&values[i], &lc->cache[lc->used - remaining], sizeof(void *) * remaining);
287                lc->used -= remaining;
288                i += remaining;
289        }
290        mem_hits.read.miss += nb_buffers - i;
291        assert(i >= min_nb_buffers);
292        return i;
293}
294
295DLLEXPORT size_t libtrace_ocache_alloc(libtrace_ocache_t *oc, void *values[], size_t nb_buffers, size_t min_nb_buffers) {
296        struct local_cache *lc = find_cache(oc);
297        size_t i;
298        size_t min;
299        bool try_alloc = !(oc->max_allocations && oc->max_allocations <= oc->current_allocations);
300
301        assert(oc->max_allocations ? nb_buffers < oc->max_allocations : 1);
302        min = try_alloc ? 0: min_nb_buffers;
303        if (lc)
304                i = libtrace_ocache_alloc_cache(oc, values, nb_buffers, min,  lc);
305        else
306                i = libtrace_ringbuffer_sread_bulk(&oc->rb, values, nb_buffers, min);
307
308        if (try_alloc) {
309                size_t nb;
310
311                // Try alloc the rest
312                if (oc->max_allocations) {
313                        pthread_spin_lock(&oc->spin);
314                        nb = MIN(oc->max_allocations - oc->current_allocations, nb_buffers - i);
315                        oc->current_allocations += nb;
316                        pthread_spin_unlock(&oc->spin);
317                        nb += i;
318                } else {
319                        nb = nb_buffers;
320                }
321
322                for (;i < nb; ++i) {
323                        values[i] = (*oc->alloc)();
324                        assert(values[i]);
325                }
326                assert (i == nb);
327                // Still got to wait for more
328                if (nb < min_nb_buffers) {
329                        if (lc)
330                                i += libtrace_ocache_alloc_cache(oc, &values[nb], nb_buffers - nb, min_nb_buffers - nb, lc);
331                        else
332                                i += libtrace_ringbuffer_sread_bulk(&oc->rb, &values[nb], nb_buffers - nb, min_nb_buffers - nb);
333                }
334        }
335        assert(i >= min_nb_buffers);
336        return i;
337}
338
339
340static inline size_t libtrace_ocache_free_cache(libtrace_ocache_t *oc, void *values[], size_t nb_buffers, size_t min_nb_buffers,
341                                                                                        struct local_cache *lc) {
342        libtrace_ringbuffer_t *rb = &oc->rb;
343        size_t i;
344
345        // We have enough cached!! Yay
346        if (nb_buffers <= lc->total - lc->used) {
347                // Copy all to the cache
348                memcpy(&lc->cache[lc->used], values, sizeof(void *) * nb_buffers);
349                lc->used += nb_buffers;
350                mem_hits.write.cache_hit += nb_buffers;
351                mem_hits.writebulk.cache_hit += 1;
352                return nb_buffers;
353        }
354        // Cache is not big enough try write all to the ringbuffer
355        else if (nb_buffers > lc->total) {
356                i = libtrace_ringbuffer_swrite_bulk(rb, values, nb_buffers, min_nb_buffers);
357                if (i)
358                        mem_hits.writebulk.ring_hit += 1;
359                else
360                        mem_hits.writebulk.miss += 1;
361                mem_hits.write.ring_hit += i;
362        } else { // Not enough cache space but there might later
363                // Fill the cache and empty it and then see what we're left with
364                i = (lc->total - lc->used);
365                memcpy(&lc->cache[lc->used], values, sizeof(void *) * i);
366                mem_hits.write.cache_hit += i;
367
368                // Make sure we still meet the minimum requirement
369                if (i < min_nb_buffers)
370                        lc->used = lc->total - libtrace_ringbuffer_swrite_bulk(rb, lc->cache, lc->total, min_nb_buffers - i);
371                else
372                        lc->used = lc->total - libtrace_ringbuffer_swrite_bulk(rb, lc->cache, lc->total, 0);
373
374                // Re originise fulls to the front
375                if (lc->used)
376                        memmove(lc->cache, &lc->cache[lc->total - lc->used], sizeof(void *) * lc->used);
377
378                if (lc->used)
379                        mem_hits.writebulk.miss += 1;
380                else
381                        mem_hits.writebulk.ring_hit += 1;
382                mem_hits.write.ring_hit += lc->total - lc->used;
383        }
384
385        // Try empty the remaining
386        if (i < nb_buffers && lc->used != lc->total) {
387                size_t remaining;
388                remaining = MIN(lc->total - lc->used, nb_buffers - i);
389                memcpy(&lc->cache[lc->used], &values[i], sizeof(void *) * remaining);
390                lc->used += remaining;
391                i += remaining;
392        }
393        mem_hits.write.miss += nb_buffers - i;
394        return i;
395}
396
397DLLEXPORT size_t libtrace_ocache_free(libtrace_ocache_t *oc, void *values[], size_t nb_buffers, size_t min_nb_buffers) {
398        struct local_cache *lc = find_cache(oc);
399        size_t i;
400        size_t min;
401
402        assert(oc->max_allocations ? nb_buffers < oc->max_allocations : 1);
403        min = oc->max_allocations ? min_nb_buffers : 0;
404        if (lc)
405                i = libtrace_ocache_free_cache(oc, values, nb_buffers, min, lc);
406        else
407                i = libtrace_ringbuffer_swrite_bulk(&oc->rb, values, nb_buffers, min);
408
409        if (!oc->max_allocations) {
410                // Free these normally
411                for (;i < min_nb_buffers; ++i) {
412                        oc->free(values[i]);
413                }
414        }
415        return i;
416}
417
418DLLEXPORT void libtrace_zero_ocache(libtrace_ocache_t *oc) {
419        libtrace_zero_ringbuffer(&oc->rb);
420        oc->thread_cache_size = 0;
421        oc->alloc = NULL;
422        oc->free = NULL;
423        oc->current_allocations = 0;
424        oc->max_allocations = 0;
425        oc->nb_thread_list = 0;
426        oc->max_nb_thread_list = 0;
427        oc->thread_list = NULL;
428}
429
430/**
431 * @brief ocache_unregister_thread removes a thread from an ocache.
432 * @param The ocache to remove this thread, this will free any packets in the TLS cache
433 */
434DLLEXPORT void libtrace_ocache_unregister_thread(libtrace_ocache_t *oc) {
435        size_t i;
436        struct local_cache *lc = find_cache(oc);
437
438        if (lc) {
439                for (i = 0; i < t_mem_caches_used; ++i) {
440                        if (&t_mem_caches[i] == lc) {
441                                // Free the cache against the ocache
442                                unregister_thread(&t_mem_caches[i]);
443                                free(t_mem_caches[i].cache);
444                                // And remove it from the thread itself
445                                --t_mem_caches_used;
446                                t_mem_caches[i] = t_mem_caches[t_mem_caches_used];
447                                memset(&t_mem_caches[t_mem_caches_used], 0, sizeof(struct local_cache));
448                        }
449                }
450        }
451}
Note: See TracBrowser for help on using the repository browser.