]>
git.proxmox.com Git - mirror_frr.git/blob - lib/memory.h
2 * Copyright (c) 2015-16 David Lamparter, for NetDEF, Inc.
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 #ifndef _QUAGGA_MEMORY_H
18 #define _QUAGGA_MEMORY_H
22 #include <frratomic.h>
29 #if defined(HAVE_MALLOC_SIZE) && !defined(HAVE_MALLOC_USABLE_SIZE)
30 #define malloc_usable_size(x) malloc_size(x)
31 #define HAVE_MALLOC_USABLE_SIZE
36 struct memtype
*next
, **ref
;
38 atomic_size_t n_alloc
;
41 #ifdef HAVE_MALLOC_USABLE_SIZE
43 atomic_size_t max_size
;
48 struct memgroup
*next
, **ref
;
49 struct memtype
*types
, **insert
;
56 * DECLARE_MGROUP(MYDAEMON)
57 * DECLARE_MTYPE(MYDAEMON_COMMON)
60 * DEFINE_MGROUP(MYDAEMON, "my daemon memory")
61 * DEFINE_MTYPE(MYDAEMON, MYDAEMON_COMMON,
62 * "this mtype is used in multiple files in mydaemon")
63 * foo = qmalloc(MTYPE_MYDAEMON_COMMON, sizeof(*foo))
66 * bar = qmalloc(MTYPE_MYDAEMON_COMMON, sizeof(*bar))
68 * DEFINE_MTYPE_STATIC(MYDAEMON, MYDAEMON_IO,
69 * "this mtype is used only in this file")
70 * baz = qmalloc(MTYPE_MYDAEMON_IO, sizeof(*baz))
72 * Note: Naming conventions (MGROUP_ and MTYPE_ prefixes are enforced
73 * by not having these as part of the macro arguments)
74 * Note: MTYPE_* are symbols to the compiler (of type struct memtype *),
75 * but MGROUP_* aren't.
78 #define DECLARE_MGROUP(name) extern struct memgroup _mg_##name;
79 #define DEFINE_MGROUP(mname, desc) \
80 struct memgroup _mg_##mname \
81 __attribute__((section(".data.mgroups"))) = { \
88 static void _mginit_##mname(void) __attribute__((_CONSTRUCTOR(1000))); \
89 static void _mginit_##mname(void) \
91 extern struct memgroup **mg_insert; \
92 _mg_##mname.ref = mg_insert; \
93 *mg_insert = &_mg_##mname; \
94 mg_insert = &_mg_##mname.next; \
96 static void _mgfini_##mname(void) __attribute__((_DESTRUCTOR(1000))); \
97 static void _mgfini_##mname(void) \
99 if (_mg_##mname.next) \
100 _mg_##mname.next->ref = _mg_##mname.ref; \
101 *_mg_##mname.ref = _mg_##mname.next; \
105 /* the array is a trick to make the "MTYPE_FOO" name work as a pointer without
106 * putting a & in front of it, so we can do "XMALLOC(MTYPE_FOO, ...)" instead
107 * of "XMALLOC(&MTYPE_FOO, ...)".
109 #define DECLARE_MTYPE(name) \
110 extern struct memtype _mt_##name; \
111 extern struct memtype MTYPE_##name[1]; \
114 #define DEFINE_MTYPE_ATTR(group, mname, attr, desc) \
115 attr struct memtype _mt_##mname \
116 __attribute__((section(".data.mtypes"))) = { \
123 static void _mtinit_##mname(void) __attribute__((_CONSTRUCTOR(1001))); \
124 static void _mtinit_##mname(void) \
126 if (_mg_##group.insert == NULL) \
127 _mg_##group.insert = &_mg_##group.types; \
128 _mt_##mname.ref = _mg_##group.insert; \
129 *_mg_##group.insert = &_mt_##mname; \
130 _mg_##group.insert = &_mt_##mname.next; \
132 static void _mtfini_##mname(void) __attribute__((_DESTRUCTOR(1001))); \
133 static void _mtfini_##mname(void) \
135 if (_mt_##mname.next) \
136 _mt_##mname.next->ref = _mt_##mname.ref; \
137 *_mt_##mname.ref = _mt_##mname.next; \
141 /* can't quite get gcc to emit the alias correctly, so asm-alias it is :/ */
142 #define DEFINE_MTYPE(group, name, desc) \
143 DEFINE_MTYPE_ATTR(group, name, , desc) \
144 __asm__(".equiv MTYPE_" #name ", _mt_" #name "\n\t" \
145 ".global MTYPE_" #name "\n"); \
147 /* and this one's borked on clang, it drops static on aliases :/, so... asm */
148 #define DEFINE_MTYPE_STATIC(group, name, desc) \
149 DEFINE_MTYPE_ATTR(group, name, static, desc) \
150 extern struct memtype MTYPE_##name[1]; \
151 __asm__(".equiv MTYPE_" #name ", _mt_" #name "\n"); \
158 extern void *qmalloc(struct memtype
*mt
, size_t size
)
159 __attribute__((malloc
, _ALLOC_SIZE(2), nonnull(1) _RET_NONNULL
));
160 extern void *qcalloc(struct memtype
*mt
, size_t size
)
161 __attribute__((malloc
, _ALLOC_SIZE(2), nonnull(1) _RET_NONNULL
));
162 extern void *qrealloc(struct memtype
*mt
, void *ptr
, size_t size
)
163 __attribute__((_ALLOC_SIZE(3), nonnull(1) _RET_NONNULL
));
164 extern void *qstrdup(struct memtype
*mt
, const char *str
)
165 __attribute__((malloc
, nonnull(1) _RET_NONNULL
));
166 extern void qfree(struct memtype
*mt
, void *ptr
) __attribute__((nonnull(1)));
168 #define XMALLOC(mtype, size) qmalloc(mtype, size)
169 #define XCALLOC(mtype, size) qcalloc(mtype, size)
170 #define XREALLOC(mtype, ptr, size) qrealloc(mtype, ptr, size)
171 #define XSTRDUP(mtype, str) qstrdup(mtype, str)
172 #define XFREE(mtype, ptr) \
178 static inline size_t mtype_stats_alloc(struct memtype
*mt
)
183 /* NB: calls are ordered by memgroup; and there is a call with mt == NULL for
184 * each memgroup (so that a header can be printed, and empty memgroups show)
186 * return value: 0: continue, !0: abort walk. qmem_walk will return the
187 * last value from qmem_walk_fn. */
188 typedef int qmem_walk_fn(void *arg
, struct memgroup
*mg
, struct memtype
*mt
);
189 extern int qmem_walk(qmem_walk_fn
*func
, void *arg
);
190 extern int log_memstats(FILE *fp
, const char *);
191 #define log_memstats_stderr(prefix) log_memstats(stderr, prefix)
193 extern void memory_oom(size_t size
, const char *name
);
199 #endif /* _QUAGGA_MEMORY_H */