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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*
*/
/** This header file defines a portable library for allocating memory safely
** throughout FreeSCI.
** Implementations of basic functions found here are in this file and
** $(SRCDIR)/src/scicore/sci_memory.c
*
**************
*
* Sets behaviour if memory allocation call fails.
* UNCHECKED_MALLOCS: use C library routine without checks
* (nothing defined): check mallocs and exit immediately on fail (recommended)
*
** -- Alex Angas
**
**/
#ifndef _SCI_MEMORY_H
#define _SCI_MEMORY_H
#include "common/scummsys.h"
namespace Sci {
/********** the memory allocation macros **********/
#ifdef UNCHECKED_MALLOCS
#define ALLOC_MEM(alloc_statement, size, filename, linenum, funcname)\
do {\
alloc_statement;\
} while (0);
#else /* !UNCHECKED_MALLOCS */
#define ALLOC_MEM(alloc_statement, size, filename, linenum, funcname)\
do {\
if (size == 0) {\
warning("Allocating zero bytes of memory [%s (%s) : %u]", filename, funcname, linenum);\
} else if (!(size > 0)) {\
error("Cannot allocate negative bytes of memory [%s (%s) : %u]", filename, funcname, linenum);\
}\
\
alloc_statement; /* attempt to allocate the memory */\
\
if (res == NULL) {\
/* exit immediately */\
error("Memory allocation of %lu bytes failed [%s (%s) : %u]", size, filename, funcname, linenum);\
}\
} while (0);
#endif /* !UNCHECKED_MALLOCS */
/********** memory allocation routines **********/
extern void *sci_malloc(size_t size);
/* Allocates the specified amount of memory.
** Parameters: (size_t) size: Number of bytes to allocate
** Returns : (void *) A pointer to the allocated memory chunk
** To free this string, use the free() command.
** If the call fails, behaviour is dependent on the definition of SCI_ALLOC.
*/
extern void *sci_calloc(size_t num, size_t size);
/* Allocates num * size bytes of zeroed-out memory.
** Parameters: (size_t) num: Number of elements to allocate
** (size_t) size: Amount of memory per element to allocate
** Returns : (void *) A pointer to the allocated memory chunk
** To free this string, use the free() command.
** See _SCI_MALLOC() for more information if call fails.
*/
extern void *sci_realloc(void *ptr, size_t size);
/* Increases the size of an allocated memory chunk.
** Parameters: (void *) ptr: The original pointer
** (size_t) size: New size of the memory chunk
** Returns : (void *) A possibly new pointer, containing 'size'
** bytes of memory and everything contained in the original 'ptr'
** (possibly minus some trailing data if the new memory area is
** smaller than the old one).
** To free this string, use the free() command.
** See _SCI_MALLOC() for more information if call fails.
*/
extern char *sci_strdup(const char *src);
/* Duplicates a string.
** Parameters: (const char *) src: The original pointer
** Returns : (char *) a pointer to the storage location for the copied
** string.
** To free this string, use the free() command.
** See _SCI_MALLOC() for more information if call fails.
*/
extern char *sci_strndup(const char *src, size_t length);
/* Copies a string into a newly allocated memory part, up to a certain length.
** Parameters: (char *) src: The source string
** (int) length: The maximum length of the string (not counting
** a trailing \0).
** Returns : (char *) The resulting copy, allocated with sci_malloc().
** To free this string, use the free() command.
** See _SCI_MALLOC() for more information if call fails.
*/
/****************************************/
/* Refcounting garbage collected memory */
/****************************************/
/* Refcounting memory calls are a little slower than the others,
** and using it improperly may cause memory leaks. It conserves
** memory, though. */
extern void *sci_refcount_alloc(size_t length);
/* Allocates "garbage" memory
** Parameters: (size_t) length: Number of bytes to allocate
** Returns : (void *) The allocated memory
** Memory allocated in this fashion will be marked as holding one reference.
** It cannot be freed with 'free()', only by using sci_refcount_decref().
*/
extern void *sci_refcount_incref(void *data);
/* Adds another reference to refcounted memory
** Parameters: (void *) data: The data to add a reference to
** Returns : (void *) data
*/
extern void sci_refcount_decref(void *data);
/* Decrements the reference count for refcounted memory
** Parameters: (void *) data: The data to add a reference to
** Returns : (void *) data
** If the refcount reaches zero, the memory will be deallocated
*/
extern void *sci_refcount_memdup(void *data, size_t len);
/* Duplicates non-refcounted memory into a refcounted block
** Parameters: (void *) data: The memory to copy from
** (size_t) len: The number of bytes to copy/allocate
** Returns : (void *) Newly allocated refcounted memory
** The number of references accounted for will be one.
*/
} // End of namespace Sci
#endif /* _SCI_MEMORY_H */
|
