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
|
/* File: z-virt.h */
/*
* Copyright (c) 1997 Ben Harrison
*
* This software may be copied and distributed for educational, research,
* and not for profit purposes provided that this copyright and statement
* are included in all such copies.
*/
#ifndef INCLUDED_Z_VIRT_H
#define INCLUDED_Z_VIRT_H
#ifdef __cplusplus
extern "C" {
#endif
#include "h-basic.h"
#ifdef CHECK_MEMORY_LEAKS
#include <leak_detector.h>
#endif
/*
* Memory management routines.
*
* Set ralloc_aux to modify the memory allocation routine.
* Set rnfree_aux to modify the memory de-allocation routine.
* Set rpanic_aux to let the program react to memory failures.
*
* These routines work best as a *replacement* for malloc/free.
*
* The string_make() and string_free() routines handle dynamic strings.
* A dynamic string is a string allocated at run-time, which should not
* be modified once it has been created.
*
* Note the macros below which simplify the details of allocation,
* deallocation, setting, clearing, casting, size extraction, etc.
*
* The macros MAKE/C_MAKE and KILL/C_KILL have a "procedural" metaphor,
* and they actually modify their arguments.
*
* Note that, for some reason, some allocation macros may disallow
* "stars" in type names, but you can use typedefs to circumvent
* this. For example, instead of "type **p; MAKE(p,type*);" you
* can use "typedef type *type_ptr; type_ptr *p; MAKE(p,type_ptr)".
*
* Note that it is assumed that "memset()" will function correctly,
* in particular, that it returns its first argument.
*/
/**** Available macros ****/
/* Size of 'N' things of type 'T' */
#define C_SIZE(N,T) \
((huge)((N)*(sizeof(T))))
/* Size of one thing of type 'T' */
#define SIZE(T) \
((huge)(sizeof(T)))
/* Wipe an array of type T[N], at location P, and return P */
#define C_WIPE(P,N,T) \
(memset((char*)(P),0,C_SIZE(N,T)))
/* Wipe a thing of type T, at location P, and return P */
#define WIPE(P,T) \
(memset((char*)(P),0,SIZE(T)))
/* Load an array of type T[N], at location P1, from another, at location P2 */
#define C_COPY(P1,P2,N,T) \
(memcpy((char*)(P1),(char*)(P2),C_SIZE(N,T)))
/* Load a thing of type T, at location P1, from another, at location P2 */
#define COPY(P1,P2,T) \
(memcpy((char*)(P1),(char*)(P2),SIZE(T)))
/* Free an array of N things of type T at P, return NULL */
#define C_FREE(P,N,T) \
(rnfree(P,C_SIZE(N,T)))
/* Free one thing of type T at P, return NULL */
#define FREE(P,T) \
(rnfree(P,SIZE(T)))
/* Allocate, and return, an array of type T[N] */
#define C_RNEW(N,T) \
(ralloc(C_SIZE(N,T)))
/* Allocate, and return, a thing of type T */
#define RNEW(T) \
(ralloc(SIZE(T)))
/* Allocate, wipe, and return an array of type T[N] */
#define C_ZNEW(N,T) \
(C_WIPE(C_RNEW(N,T),N,T))
/* Allocate, wipe, and return a thing of type T */
#define ZNEW(T) \
(WIPE(RNEW(T),T))
/* Allocate a wiped array of type T[N], assign to pointer P */
#define C_MAKE(P,N,T) \
((P)=C_ZNEW(N,T))
/* Allocate a wiped thing of type T, assign to pointer P */
#define MAKE(P,T) \
((P)=ZNEW(T))
/* Free an array of type T[N], at location P, and set P to NULL */
#define C_KILL(P,N,T) \
((P)=C_FREE(P,N,T))
/* Free a thing of type T, at location P, and set P to NULL */
#define KILL(P,T) \
((P)=FREE(P,T))
/**** Available variables ****/
/* Replacement hook for "rnfree()" */
extern vptr (*rnfree_aux)(vptr, huge);
/* Replacement hook for "rpanic()" */
extern vptr (*rpanic_aux)(huge);
/* Replacement hook for "ralloc()" */
extern vptr (*ralloc_aux)(huge);
/**** Available functions ****/
/* De-allocate a given amount of memory */
extern vptr rnfree(vptr p, huge len);
/* Panic, attempt to Allocate 'len' bytes */
extern vptr rpanic(huge len);
/* Allocate (and return) 'len', or dump core */
extern vptr ralloc(huge len);
/* Create a "dynamic string" */
extern cptr string_make(cptr str);
/* Free a string allocated with "string_make()" */
extern errr string_free(cptr str);
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif
|
