1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
30 #include <glib/gtypes.h>
34 typedef struct _GAllocator GAllocator;
35 typedef struct _GMemChunk GMemChunk;
36 typedef struct _GMemVTable GMemVTable;
39 #if GLIB_SIZEOF_VOID_P > GLIB_SIZEOF_LONG
40 # define G_MEM_ALIGN GLIB_SIZEOF_VOID_P
41 #else /* GLIB_SIZEOF_VOID_P <= GLIB_SIZEOF_LONG */
42 # define G_MEM_ALIGN GLIB_SIZEOF_LONG
43 #endif /* GLIB_SIZEOF_VOID_P <= GLIB_SIZEOF_LONG */
46 /* Memory allocation functions
48 gpointer g_malloc (gulong n_bytes) G_GNUC_MALLOC;
49 gpointer g_malloc0 (gulong n_bytes) G_GNUC_MALLOC;
50 gpointer g_realloc (gpointer mem,
52 void g_free (gpointer mem);
53 gpointer g_try_malloc (gulong n_bytes) G_GNUC_MALLOC;
54 gpointer g_try_realloc (gpointer mem,
58 /* Convenience memory allocators
60 #define g_new(struct_type, n_structs) \
61 ((struct_type *) g_malloc (((gsize) sizeof (struct_type)) * ((gsize) (n_structs))))
62 #define g_new0(struct_type, n_structs) \
63 ((struct_type *) g_malloc0 (((gsize) sizeof (struct_type)) * ((gsize) (n_structs))))
64 #define g_renew(struct_type, mem, n_structs) \
65 ((struct_type *) g_realloc ((mem), ((gsize) sizeof (struct_type)) * ((gsize) (n_structs))))
67 #define g_try_new(struct_type, n_structs) \
68 ((struct_type *) g_try_malloc (((gsize) sizeof (struct_type)) * ((gsize) (n_structs))))
69 #define g_try_new0(struct_type, n_structs) \
70 ((struct_type *) g_try_malloc0 (((gsize) sizeof (struct_type)) * ((gsize) (n_structs))))
71 #define g_try_renew(struct_type, mem, n_structs) \
72 ((struct_type *) g_try_realloc ((mem), ((gsize) sizeof (struct_type)) * ((gsize) (n_structs))))
75 /* Memory allocation virtualization for debugging purposes
76 * g_mem_set_vtable() has to be the very first GLib function called
81 gpointer (*malloc) (gsize n_bytes);
82 gpointer (*realloc) (gpointer mem,
84 void (*free) (gpointer mem);
85 /* optional; set to NULL if not used ! */
86 gpointer (*calloc) (gsize n_blocks,
88 gpointer (*try_malloc) (gsize n_bytes);
89 gpointer (*try_realloc) (gpointer mem,
92 void g_mem_set_vtable (GMemVTable *vtable);
93 gboolean g_mem_is_system_malloc (void);
95 /* Memory profiler and checker, has to be enabled via g_mem_set_vtable()
97 GLIB_VAR GMemVTable *glib_mem_profiler_table;
98 void g_mem_profile (void);
101 /* Memchunk convenience functions
103 #define g_mem_chunk_create(type, pre_alloc, alloc_type) ( \
104 g_mem_chunk_new (#type " mem chunks (" #pre_alloc ")", \
106 sizeof (type) * (pre_alloc), \
109 #define g_chunk_new(type, chunk) ( \
110 (type *) g_mem_chunk_alloc (chunk) \
112 #define g_chunk_new0(type, chunk) ( \
113 (type *) g_mem_chunk_alloc0 (chunk) \
115 #define g_chunk_free(mem, mem_chunk) G_STMT_START { \
116 g_mem_chunk_free ((mem_chunk), (mem)); \
120 /* "g_mem_chunk_new" creates a new memory chunk.
121 * Memory chunks are used to allocate pieces of memory which are
122 * always the same size. Lists are a good example of such a data type.
123 * The memory chunk allocates and frees blocks of memory as needed.
124 * Just be sure to call "g_mem_chunk_free" and not "g_free" on data
125 * allocated in a mem chunk. ("g_free" will most likely cause a seg
126 * fault...somewhere).
128 * Oh yeah, GMemChunk is an opaque data type. (You don't really
129 * want to know what's going on inside do you?)
132 /* ALLOC_ONLY MemChunks can only allocate memory. The free operation
133 * is interpreted as a no op. ALLOC_ONLY MemChunks save 4 bytes per
134 * atom. (They are also useful for lists which use MemChunk to allocate
135 * memory but are also part of the MemChunk implementation).
136 * ALLOC_AND_FREE MemChunks can allocate and free memory.
139 #define G_ALLOC_ONLY 1
140 #define G_ALLOC_AND_FREE 2
142 GMemChunk* g_mem_chunk_new (const gchar *name,
146 void g_mem_chunk_destroy (GMemChunk *mem_chunk);
147 gpointer g_mem_chunk_alloc (GMemChunk *mem_chunk);
148 gpointer g_mem_chunk_alloc0 (GMemChunk *mem_chunk);
149 void g_mem_chunk_free (GMemChunk *mem_chunk,
151 void g_mem_chunk_clean (GMemChunk *mem_chunk);
152 void g_mem_chunk_reset (GMemChunk *mem_chunk);
153 void g_mem_chunk_print (GMemChunk *mem_chunk);
154 void g_mem_chunk_info (void);
156 /* Ah yes...we have a "g_blow_chunks" function.
157 * "g_blow_chunks" simply compresses all the chunks. This operation
158 * consists of freeing every memory area that should be freed (but
159 * which we haven't gotten around to doing yet). And, no,
160 * "g_blow_chunks" doesn't follow the naming scheme, but it is a
161 * much better name than "g_mem_chunk_clean_all" or something
164 void g_blow_chunks (void);
167 /* Generic allocators
169 GAllocator* g_allocator_new (const gchar *name,
171 void g_allocator_free (GAllocator *allocator);
174 #define G_ALLOCATOR_LIST (1)
175 #define G_ALLOCATOR_SLIST (2)
176 #define G_ALLOCATOR_NODE (3)
181 #endif /* __G_MEM_H__ */