]>
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>
25 #define array_size(ar) (sizeof(ar) / sizeof(ar[0]))
29 struct memtype
*next
, **ref
;
31 _Atomic
size_t n_alloc
;
36 struct memgroup
*next
, **ref
;
37 struct memtype
*types
, **insert
;
44 * DECLARE_MGROUP(MYDAEMON)
45 * DECLARE_MTYPE(MYDAEMON_COMMON)
48 * DEFINE_MGROUP(MYDAEMON, "my daemon memory")
49 * DEFINE_MTYPE(MYDAEMON, MYDAEMON_COMMON,
50 * "this mtype is used in multiple files in mydaemon")
51 * foo = qmalloc(MTYPE_MYDAEMON_COMMON, sizeof(*foo))
54 * bar = qmalloc(MTYPE_MYDAEMON_COMMON, sizeof(*bar))
56 * DEFINE_MTYPE_STATIC(MYDAEMON, MYDAEMON_IO,
57 * "this mtype is used only in this file")
58 * baz = qmalloc(MTYPE_MYDAEMON_IO, sizeof(*baz))
60 * Note: Naming conventions (MGROUP_ and MTYPE_ prefixes are enforced
61 * by not having these as part of the macro arguments)
62 * Note: MTYPE_* are symbols to the compiler (of type struct memtype *),
63 * but MGROUP_* aren't.
66 #define DECLARE_MGROUP(name) extern struct memgroup _mg_##name;
67 #define DEFINE_MGROUP(mname, desc) \
68 struct memgroup _mg_##mname \
69 __attribute__((section(".data.mgroups"))) = { \
76 static void _mginit_##mname(void) __attribute__((_CONSTRUCTOR(1000))); \
77 static void _mginit_##mname(void) \
79 extern struct memgroup **mg_insert; \
80 _mg_##mname.ref = mg_insert; \
81 *mg_insert = &_mg_##mname; \
82 mg_insert = &_mg_##mname.next; \
84 static void _mgfini_##mname(void) __attribute__((_DESTRUCTOR(1000))); \
85 static void _mgfini_##mname(void) \
87 if (_mg_##mname.next) \
88 _mg_##mname.next->ref = _mg_##mname.ref; \
89 *_mg_##mname.ref = _mg_##mname.next; \
93 #define DECLARE_MTYPE(name) \
94 extern struct memtype _mt_##name; \
95 static struct memtype *const MTYPE_##name = &_mt_##name;
97 #define DEFINE_MTYPE_ATTR(group, mname, attr, desc) \
98 attr struct memtype _mt_##mname \
99 __attribute__((section(".data.mtypes"))) = { \
106 static void _mtinit_##mname(void) __attribute__((_CONSTRUCTOR(1001))); \
107 static void _mtinit_##mname(void) \
109 if (_mg_##group.insert == NULL) \
110 _mg_##group.insert = &_mg_##group.types; \
111 _mt_##mname.ref = _mg_##group.insert; \
112 *_mg_##group.insert = &_mt_##mname; \
113 _mg_##group.insert = &_mt_##mname.next; \
115 static void _mtfini_##mname(void) __attribute__((_DESTRUCTOR(1001))); \
116 static void _mtfini_##mname(void) \
118 if (_mt_##mname.next) \
119 _mt_##mname.next->ref = _mt_##mname.ref; \
120 *_mt_##mname.ref = _mt_##mname.next; \
123 #define DEFINE_MTYPE(group, name, desc) DEFINE_MTYPE_ATTR(group, name, , desc)
124 #define DEFINE_MTYPE_STATIC(group, name, desc) \
125 DEFINE_MTYPE_ATTR(group, name, static, desc) \
126 static struct memtype *const MTYPE_##name = &_mt_##name;
132 extern void *qmalloc(struct memtype
*mt
, size_t size
)
133 __attribute__((malloc
, _ALLOC_SIZE(2), nonnull(1) _RET_NONNULL
));
134 extern void *qcalloc(struct memtype
*mt
, size_t size
)
135 __attribute__((malloc
, _ALLOC_SIZE(2), nonnull(1) _RET_NONNULL
));
136 extern void *qrealloc(struct memtype
*mt
, void *ptr
, size_t size
)
137 __attribute__((_ALLOC_SIZE(3), nonnull(1) _RET_NONNULL
));
138 extern void *qstrdup(struct memtype
*mt
, const char *str
)
139 __attribute__((malloc
, nonnull(1) _RET_NONNULL
));
140 extern void qfree(struct memtype
*mt
, void *ptr
) __attribute__((nonnull(1)));
142 #define XMALLOC(mtype, size) qmalloc(mtype, size)
143 #define XCALLOC(mtype, size) qcalloc(mtype, size)
144 #define XREALLOC(mtype, ptr, size) qrealloc(mtype, ptr, size)
145 #define XSTRDUP(mtype, str) qstrdup(mtype, str)
146 #define XFREE(mtype, ptr) \
152 static inline size_t mtype_stats_alloc(struct memtype
*mt
)
157 /* NB: calls are ordered by memgroup; and there is a call with mt == NULL for
158 * each memgroup (so that a header can be printed, and empty memgroups show)
160 * return value: 0: continue, !0: abort walk. qmem_walk will return the
161 * last value from qmem_walk_fn. */
162 typedef int qmem_walk_fn(void *arg
, struct memgroup
*mg
, struct memtype
*mt
);
163 extern int qmem_walk(qmem_walk_fn
*func
, void *arg
);
164 extern int log_memstats(FILE *fp
, const char *);
165 #define log_memstats_stderr(prefix) log_memstats(stderr, prefix)
167 extern void memory_oom(size_t size
, const char *name
);
169 #endif /* _QUAGGA_MEMORY_H */