Merge remote branch 'gvdb/master'
[platform/upstream/glib.git] / glib / gslice.h
1 /* GLIB sliced memory - fast threaded memory chunk allocator
2  * Copyright (C) 2005 Tim Janik
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
21 #error "Only <glib.h> can be included directly."
22 #endif
23
24 #ifndef __G_SLICE_H__
25 #define __G_SLICE_H__
26
27 #include <glib/gtypes.h>
28
29 G_BEGIN_DECLS
30
31 /* slices - fast allocation/release of small memory blocks
32  */
33 gpointer g_slice_alloc                  (gsize         block_size) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1);
34 gpointer g_slice_alloc0                 (gsize         block_size) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1);
35 gpointer g_slice_copy                   (gsize         block_size,
36                                          gconstpointer mem_block) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1);
37 void     g_slice_free1                  (gsize         block_size,
38                                          gpointer      mem_block);
39 void     g_slice_free_chain_with_offset (gsize         block_size,
40                                          gpointer      mem_chain,
41                                          gsize         next_offset);
42 #define  g_slice_new(type)      ((type*) g_slice_alloc (sizeof (type)))
43 #define  g_slice_new0(type)     ((type*) g_slice_alloc0 (sizeof (type)))
44 /* MemoryBlockType *
45  *       g_slice_dup                    (MemoryBlockType,
46  *                                       MemoryBlockType *mem_block);
47  *       g_slice_free                   (MemoryBlockType,
48  *                                       MemoryBlockType *mem_block);
49  *       g_slice_free_chain             (MemoryBlockType,
50  *                                       MemoryBlockType *first_chain_block,
51  *                                       memory_block_next_field);
52  * pseudo prototypes for the macro
53  * definitions following below.
54  */
55
56 /* we go through extra hoops to ensure type safety */
57 #define g_slice_dup(type, mem)                                  \
58   (1 ? (type*) g_slice_copy (sizeof (type), (mem))              \
59      : ((void) ((type*) 0 == (mem)), (type*) 0))
60 #define g_slice_free(type, mem)                         do {    \
61   if (1) g_slice_free1 (sizeof (type), (mem));                  \
62   else   (void) ((type*) 0 == (mem));                           \
63 } while (0)
64 #define g_slice_free_chain(type, mem_chain, next)       do {    \
65   if (1) g_slice_free_chain_with_offset (sizeof (type),         \
66                  (mem_chain), G_STRUCT_OFFSET (type, next));    \
67   else   (void) ((type*) 0 == (mem_chain));                     \
68 } while (0)
69
70
71 /* --- internal debugging API --- */
72 typedef enum {
73   G_SLICE_CONFIG_ALWAYS_MALLOC = 1,
74   G_SLICE_CONFIG_BYPASS_MAGAZINES,
75   G_SLICE_CONFIG_WORKING_SET_MSECS,
76   G_SLICE_CONFIG_COLOR_INCREMENT,
77   G_SLICE_CONFIG_CHUNK_SIZES,
78   G_SLICE_CONFIG_CONTENTION_COUNTER
79 } GSliceConfig;
80 void     g_slice_set_config        (GSliceConfig ckey, gint64 value);
81 gint64   g_slice_get_config        (GSliceConfig ckey);
82 gint64*  g_slice_get_config_state  (GSliceConfig ckey, gint64 address, guint *n_values);
83
84 G_END_DECLS
85
86 #endif /* __G_SLICE_H__ */