1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/* -*- mode: C; c-file-style: "gnu" -*- */
/* dbus-memory.c D-BUS memory handling
*
* Copyright (C) 2002 Red Hat Inc.
*
* Licensed under the Academic Free License version 1.2
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#include "dbus-memory.h"
#include <stdlib.h>
/**
* @defgroup DBusMemory Memory Allocation
* @ingroup DBus
* @brief dbus_malloc(), dbus_free(), etc.
*
* Functions and macros related to allocating and releasing
* blocks of memory.
*
* @{
*/
/**
* @def dbus_new
*
* Safe macro for using dbus_malloc(). Accepts the type
* to allocate and the number of type instances to
* allocate as arguments, and returns a memory block
* cast to the desired type, instead of as a void*.
*
* @param type type name to allocate
* @param count number of instances in the allocated array
* @returns the new memory block or #NULL on failure
*/
/**
* @def dbus_new0
*
* Safe macro for using dbus_malloc0(). Accepts the type
* to allocate and the number of type instances to
* allocate as arguments, and returns a memory block
* cast to the desired type, instead of as a void*.
* The allocated array is initialized to all-bits-zero.
*
* @param type type name to allocate
* @param count number of instances in the allocated array
* @returns the new memory block or #NULL on failure
*/
/**
* @typedef DBusFreeFunction
*
* The type of a function which frees a block of memory.
*
* @param memory the memory to free
*/
/**
* Allocates the given number of bytes, as with standard
* malloc(). Guaranteed to return #NULL if bytes is zero
* on all platforms. Returns #NULL if the allocation fails.
* The memory must be released with dbus_free().
*
* @param bytes number of bytes to allocate
* @return allocated memory, or #NULL if the allocation fails.
*/
void*
dbus_malloc (size_t bytes)
{
if (bytes == 0) /* some system mallocs handle this, some don't */
return NULL;
else
return malloc (bytes);
}
/**
* Allocates the given number of bytes, as with standard malloc(), but
* all bytes are initialized to zero as with calloc(). Guaranteed to
* return #NULL if bytes is zero on all platforms. Returns #NULL if the
* allocation fails. The memory must be released with dbus_free().
*
* @param bytes number of bytes to allocate
* @return allocated memory, or #NULL if the allocation fails.
*/
void*
dbus_malloc0 (size_t bytes)
{
if (bytes == 0)
return NULL;
else
return calloc (bytes, 1);
}
/**
* Resizes a block of memory previously allocated by dbus_malloc() or
* dbus_malloc0(). Guaranteed to free the memory and return #NULL if bytes
* is zero on all platforms. Returns #NULL if the resize fails.
* If the resize fails, the memory is not freed.
*
* @param memory block to be resized
* @param bytes new size of the memory block
* @return allocated memory, or #NULL if the resize fails.
*/
void*
dbus_realloc (void *memory,
size_t bytes)
{
if (bytes == 0) /* guarantee this is safe */
{
dbus_free (memory);
return NULL;
}
else
{
return realloc (memory, bytes);
}
}
/**
* Frees a block of memory previously allocated by dbus_malloc() or
* dbus_malloc0(). If passed #NULL, does nothing.
*
* @param memory block to be freed
*/
void
dbus_free (void *memory)
{
if (memory) /* we guarantee it's safe to free (NULL) */
free (memory);
}
/** @} */
|
