1/* Memory management routine
2   Copyright (C) 1998 Kunihiro Ishiguro
3
4This file is part of GNU Zebra.
5
6GNU Zebra is free software; you can redistribute it and/or modify it
7under the terms of the GNU General Public License as published by the
8Free Software Foundation; either version 2, or (at your option) any
9later version.
10
11GNU Zebra is distributed in the hope that it will be useful, but
12WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Zebra; see the file COPYING.  If not, write to the Free
18Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
1902111-1307, USA.  */
20
21#ifndef _ZEBRA_MEMORY_H
22#define _ZEBRA_MEMORY_H
23
24#define array_size(ar) (sizeof(ar) / sizeof(ar[0]))
25
26/* For pretty printing of memory allocate information. */
27struct memory_list
28{
29  int index;
30  const char *format;
31};
32
33struct mlist {
34  struct memory_list *list;
35  const char *name;
36};
37
38#include "lib/memtypes.h"
39
40extern struct mlist mlists[];
41
42/* #define MEMORY_LOG */
43#ifdef MEMORY_LOG
44#define XMALLOC(mtype, size) \
45  mtype_zmalloc (__FILE__, __LINE__, (mtype), (size))
46#define XCALLOC(mtype, size) \
47  mtype_zcalloc (__FILE__, __LINE__, (mtype), (size))
48#define XREALLOC(mtype, ptr, size)  \
49  mtype_zrealloc (__FILE__, __LINE__, (mtype), (ptr), (size))
50#define XFREE(mtype, ptr) \
51  do { \
52    mtype_zfree (__FILE__, __LINE__, (mtype), (ptr)); \
53    ptr = NULL; } \
54  while (0)
55#define XSTRDUP(mtype, str) \
56  mtype_zstrdup (__FILE__, __LINE__, (mtype), (str))
57#else
58#define XMALLOC(mtype, size)       zmalloc ((mtype), (size))
59#define XCALLOC(mtype, size)       zcalloc ((mtype), (size))
60#define XREALLOC(mtype, ptr, size) zrealloc ((mtype), (ptr), (size))
61#define XFREE(mtype, ptr)          do { \
62                                     zfree ((mtype), (ptr)); \
63                                     ptr = NULL; } \
64                                   while (0)
65#define XSTRDUP(mtype, str)        zstrdup ((mtype), (str))
66#endif /* MEMORY_LOG */
67
68/* Prototypes of memory function. */
69extern void *zmalloc (int type, size_t size);
70extern void *zcalloc (int type, size_t size);
71extern void *zrealloc (int type, void *ptr, size_t size);
72extern void  zfree (int type, void *ptr);
73extern char *zstrdup (int type, const char *str);
74
75extern void *mtype_zmalloc (const char *file, int line, int type, size_t size);
76
77extern void *mtype_zcalloc (const char *file, int line, int type, size_t size);
78
79extern void *mtype_zrealloc (const char *file, int line, int type, void *ptr,
80		             size_t size);
81
82extern void mtype_zfree (const char *file, int line, int type,
83		         void *ptr);
84
85extern char *mtype_zstrdup (const char *file, int line, int type,
86		            const char *str);
87extern void memory_init (void);
88extern void log_memstats_stderr (const char *);
89
90/* return number of allocations outstanding for the type */
91extern unsigned long mtype_stats_alloc (int);
92
93/* Human friendly string for given byte count */
94#define MTYPE_MEMSTR_LEN 20
95extern const char *mtype_memstr (char *, size_t, unsigned long);
96#endif /* _ZEBRA_MEMORY_H */
97