1 /**************************************************************************
2 *
3 * Copyright 2008 VMware, Inc.
4 * All Rights Reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 *
26 **************************************************************************/
27
28
29 /*
30 * Memory functions
31 */
32
33
34 #ifndef U_MEMORY_H
35 #define U_MEMORY_H
36
37 #include "util/u_debug.h"
38 #include "util/os_memory.h"
39
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45
46 #define MALLOC(_size) os_malloc(_size)
47
48 #define CALLOC(_count, _size) os_calloc(_count, _size)
49
50 #define FREE(_ptr ) os_free(_ptr)
51
52 #define REALLOC(_ptr, _old_size, _size) os_realloc(_ptr, _old_size, _size)
53
54 #define MALLOC_STRUCT(T) (struct T *) MALLOC(sizeof(struct T))
55
56 #define CALLOC_STRUCT(T) (struct T *) CALLOC(1, sizeof(struct T))
57
58 #define CALLOC_VARIANT_LENGTH_STRUCT(T,more_size) ((struct T *) CALLOC(1, sizeof(struct T) + more_size))
59
60
61 #define align_malloc(_size, _alignment) os_malloc_aligned(_size, _alignment)
62 #define align_free(_ptr) os_free_aligned(_ptr)
63 #define align_realloc(_ptr, _oldsize, _newsize, _alignment) os_realloc_aligned(_ptr, _oldsize, _newsize, _alignment)
64
65 static inline void *
align_calloc(size_t size,unsigned long alignment)66 align_calloc(size_t size, unsigned long alignment)
67 {
68 void *ptr = align_malloc(size, alignment);
69 if (ptr)
70 memset(ptr, 0, size);
71 return ptr;
72 }
73
74 /**
75 * Duplicate a block of memory.
76 */
77 static inline void *
mem_dup(const void * src,size_t size)78 mem_dup(const void *src, size_t size)
79 {
80 void *dup = MALLOC(size);
81 if (dup)
82 memcpy(dup, src, size);
83 return dup;
84 }
85
86 /* TODO: this could be different on non-x86 architectures. */
87 #define CACHE_LINE_SIZE 64
88
89 /**
90 * Declare a variable on its own cache line.
91 *
92 * This helps eliminate "False sharing" to make atomic operations
93 * on pipe_reference::count faster and/or access to adjacent fields faster.
94 *
95 * https://en.wikipedia.org/wiki/False_sharing
96 *
97 * CALLOC_STRUCT_CL or MALLOC_STRUCT_CL and FREE_CL should be used to allocate
98 * structures that contain this.
99 *
100 * NOTE: Don't use c11 alignas because it causes the whole structure to be
101 * aligned, but we only want to align the field.
102 */
103 #define EXCLUSIVE_CACHELINE(decl) \
104 union { char __cl_space[CACHE_LINE_SIZE]; \
105 decl; }
106
107 /* Allocate a structure aligned to a cache line. (used to make atomic ops faster) */
108 #define MALLOC_STRUCT_CL(T) (struct T *)align_malloc(sizeof(struct T), CACHE_LINE_SIZE)
109 #define CALLOC_STRUCT_CL(T) (struct T *)align_calloc(sizeof(struct T), CACHE_LINE_SIZE)
110 #define FREE_CL(ptr) align_free(ptr)
111
112 #ifdef __cplusplus
113 }
114 #endif
115
116
117 #endif /* U_MEMORY_H */
118