|
1318
|
1 /* Support for dynamic arrays.
|
|
428
|
2 Copyright (C) 1993 Sun Microsystems, Inc.
|
|
1318
|
3 Copyright (C) 2002, 2003 Ben Wing.
|
|
428
|
4
|
|
|
5 This file is part of XEmacs.
|
|
|
6
|
|
|
7 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
8 under the terms of the GNU General Public License as published by the
|
|
|
9 Free Software Foundation; either version 2, or (at your option) any
|
|
|
10 later version.
|
|
|
11
|
|
|
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
15 for more details.
|
|
|
16
|
|
|
17 You should have received a copy of the GNU General Public License
|
|
|
18 along with XEmacs; see the file COPYING. If not, write to
|
|
|
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
20 Boston, MA 02111-1307, USA. */
|
|
|
21
|
|
|
22 /* Synched up with: Not in FSF. */
|
|
|
23
|
|
|
24 /* Written by Ben Wing, December 1993. */
|
|
|
25
|
|
|
26 /*
|
|
|
27
|
|
|
28 A "dynamic array" is a contiguous array of fixed-size elements where there
|
|
|
29 is no upper limit (except available memory) on the number of elements in the
|
|
|
30 array. Because the elements are maintained contiguously, space is used
|
|
|
31 efficiently (no per-element pointers necessary) and random access to a
|
|
|
32 particular element is in constant time. At any one point, the block of memory
|
|
|
33 that holds the array has an upper limit; if this limit is exceeded, the
|
|
|
34 memory is realloc()ed into a new array that is twice as big. Assuming that
|
|
|
35 the time to grow the array is on the order of the new size of the array
|
|
|
36 block, this scheme has a provably constant amortized time (i.e. average
|
|
|
37 time over all additions).
|
|
|
38
|
|
|
39 When you add elements or retrieve elements, pointers are used. Note that
|
|
|
40 the element itself (of whatever size it is), and not the pointer to it,
|
|
|
41 is stored in the array; thus you do not have to allocate any heap memory
|
|
|
42 on your own. Also, returned pointers are only guaranteed to be valid
|
|
|
43 until the next operation that changes the length of the array.
|
|
|
44
|
|
|
45 This is a container object. Declare a dynamic array of a specific type
|
|
|
46 as follows:
|
|
|
47
|
|
|
48 typedef struct
|
|
|
49 {
|
|
|
50 Dynarr_declare (mytype);
|
|
|
51 } mytype_dynarr;
|
|
|
52
|
|
|
53 Use the following functions/macros:
|
|
|
54
|
|
|
55 void *Dynarr_new(type)
|
|
|
56 [MACRO] Create a new dynamic-array object, with each element of the
|
|
|
57 specified type. The return value is cast to (type##_dynarr).
|
|
|
58 This requires following the convention that types are declared in
|
|
|
59 such a way that this type concatenation works. In particular, TYPE
|
|
|
60 must be a symbol, not an arbitrary C type.
|
|
|
61
|
|
|
62 Dynarr_add(d, el)
|
|
|
63 [MACRO] Add an element to the end of a dynamic array. EL is a pointer
|
|
|
64 to the element; the element itself is stored in the array, however.
|
|
|
65 No function call is performed unless the array needs to be resized.
|
|
|
66
|
|
|
67 Dynarr_add_many(d, base, len)
|
|
|
68 [MACRO] Add LEN elements to the end of the dynamic array. The elements
|
|
771
|
69 should be contiguous in memory, starting at BASE. If BASE if NULL,
|
|
|
70 just make space for the elements; don't actually add them.
|
|
428
|
71
|
|
|
72 Dynarr_insert_many_at_start(d, base, len)
|
|
|
73 [MACRO] Append LEN elements to the beginning of the dynamic array.
|
|
|
74 The elements should be contiguous in memory, starting at BASE.
|
|
771
|
75 If BASE if NULL, just make space for the elements; don't actually
|
|
|
76 add them.
|
|
428
|
77
|
|
|
78 Dynarr_insert_many(d, base, len, start)
|
|
|
79 Insert LEN elements to the dynamic array starting at position
|
|
|
80 START. The elements should be contiguous in memory, starting at BASE.
|
|
771
|
81 If BASE if NULL, just make space for the elements; don't actually
|
|
|
82 add them.
|
|
|
83
|
|
|
84 Dynarr_delete(d, i)
|
|
|
85 [MACRO] Delete an element from the dynamic array at position I.
|
|
|
86
|
|
|
87 Dynarr_delete_many(d, start, len)
|
|
|
88 Delete LEN elements from the dynamic array starting at position
|
|
|
89 START.
|
|
|
90
|
|
|
91 Dynarr_delete_by_pointer(d, p)
|
|
|
92 [MACRO] Delete an element from the dynamic array at pointer P,
|
|
|
93 which must point within the block of memory that stores the data.
|
|
|
94 P should be obtained using Dynarr_atp().
|
|
428
|
95
|
|
|
96 int Dynarr_length(d)
|
|
|
97 [MACRO] Return the number of elements currently in a dynamic array.
|
|
|
98
|
|
|
99 int Dynarr_largest(d)
|
|
|
100 [MACRO] Return the maximum value that Dynarr_length(d) would
|
|
|
101 ever have returned.
|
|
|
102
|
|
|
103 type Dynarr_at(d, i)
|
|
|
104 [MACRO] Return the element at the specified index (no bounds checking
|
|
|
105 done on the index). The element itself is returned, not a pointer
|
|
|
106 to it.
|
|
|
107
|
|
|
108 type *Dynarr_atp(d, i)
|
|
|
109 [MACRO] Return a pointer to the element at the specified index (no
|
|
|
110 bounds checking done on the index). The pointer may not be valid
|
|
|
111 after an element is added to or removed from the array.
|
|
|
112
|
|
|
113 Dynarr_reset(d)
|
|
|
114 [MACRO] Reset the length of a dynamic array to 0.
|
|
|
115
|
|
|
116 Dynarr_free(d)
|
|
|
117 Destroy a dynamic array and the memory allocated to it.
|
|
|
118
|
|
|
119 Use the following global variable:
|
|
|
120
|
|
|
121 Dynarr_min_size
|
|
440
|
122 Minimum allowable size for a dynamic array when it is resized.
|
|
428
|
123
|
|
|
124 */
|
|
|
125
|
|
|
126 #include <config.h>
|
|
|
127 #include "lisp.h"
|
|
|
128
|
|
440
|
129 static int Dynarr_min_size = 8;
|
|
428
|
130
|
|
|
131 static void
|
|
|
132 Dynarr_realloc (Dynarr *dy, int new_size)
|
|
|
133 {
|
|
|
134 if (DUMPEDP (dy->base))
|
|
|
135 {
|
|
|
136 void *new_base = malloc (new_size);
|
|
771
|
137 memcpy (new_base, dy->base, dy->max > new_size ? dy->max : new_size);
|
|
428
|
138 dy->base = new_base;
|
|
|
139 }
|
|
|
140 else
|
|
|
141 dy->base = xrealloc (dy->base, new_size);
|
|
|
142 }
|
|
|
143
|
|
|
144 void *
|
|
|
145 Dynarr_newf (int elsize)
|
|
|
146 {
|
|
|
147 Dynarr *d = xnew_and_zero (Dynarr);
|
|
|
148 d->elsize = elsize;
|
|
|
149
|
|
|
150 return d;
|
|
|
151 }
|
|
|
152
|
|
|
153 void
|
|
|
154 Dynarr_resize (void *d, int size)
|
|
|
155 {
|
|
|
156 int newsize;
|
|
|
157 double multiplier;
|
|
1318
|
158 Dynarr *dy = (Dynarr *) Dynarr_verify (d);
|
|
428
|
159
|
|
|
160 if (dy->max <= 8)
|
|
|
161 multiplier = 2;
|
|
|
162 else
|
|
|
163 multiplier = 1.5;
|
|
|
164
|
|
|
165 for (newsize = dy->max; newsize < size;)
|
|
|
166 newsize = max (Dynarr_min_size, (int) (multiplier * newsize));
|
|
|
167
|
|
|
168 /* Don't do anything if the array is already big enough. */
|
|
|
169 if (newsize > dy->max)
|
|
|
170 {
|
|
|
171 Dynarr_realloc (dy, newsize*dy->elsize);
|
|
|
172 dy->max = newsize;
|
|
|
173 }
|
|
|
174 }
|
|
|
175
|
|
|
176 /* Add a number of contiguous elements to the array starting at START. */
|
|
|
177 void
|
|
442
|
178 Dynarr_insert_many (void *d, const void *el, int len, int start)
|
|
428
|
179 {
|
|
793
|
180 Dynarr *dy = (Dynarr *) Dynarr_verify (d);
|
|
|
181
|
|
428
|
182 Dynarr_resize (dy, dy->cur+len);
|
|
1318
|
183 #if 0
|
|
|
184 /* WTF? We should be catching these problems. */
|
|
428
|
185 /* Silently adjust start to be valid. */
|
|
|
186 if (start > dy->cur)
|
|
|
187 start = dy->cur;
|
|
|
188 else if (start < 0)
|
|
|
189 start = 0;
|
|
1318
|
190 #else
|
|
|
191 assert (start >= 0 && start <= dy->cur);
|
|
|
192 #endif
|
|
428
|
193
|
|
|
194 if (start != dy->cur)
|
|
|
195 {
|
|
|
196 memmove ((char *) dy->base + (start + len)*dy->elsize,
|
|
|
197 (char *) dy->base + start*dy->elsize,
|
|
|
198 (dy->cur - start)*dy->elsize);
|
|
|
199 }
|
|
771
|
200 if (el)
|
|
|
201 memcpy ((char *) dy->base + start*dy->elsize, el, len*dy->elsize);
|
|
428
|
202 dy->cur += len;
|
|
|
203
|
|
|
204 if (dy->cur > dy->largest)
|
|
|
205 dy->largest = dy->cur;
|
|
|
206 }
|
|
|
207
|
|
|
208 void
|
|
|
209 Dynarr_delete_many (void *d, int start, int len)
|
|
|
210 {
|
|
1318
|
211 Dynarr *dy = (Dynarr *) Dynarr_verify (d);
|
|
428
|
212
|
|
|
213 assert (start >= 0 && len >= 0 && start + len <= dy->cur);
|
|
|
214 memmove ((char *) dy->base + start*dy->elsize,
|
|
|
215 (char *) dy->base + (start + len)*dy->elsize,
|
|
|
216 (dy->cur - start - len)*dy->elsize);
|
|
|
217 dy->cur -= len;
|
|
|
218 }
|
|
|
219
|
|
|
220 void
|
|
|
221 Dynarr_free (void *d)
|
|
|
222 {
|
|
|
223 Dynarr *dy = (Dynarr *) d;
|
|
|
224
|
|
|
225 if (dy->base && !DUMPEDP (dy->base))
|
|
1726
|
226 xfree (dy->base, void *);
|
|
428
|
227 if(!DUMPEDP (dy))
|
|
1726
|
228 xfree (dy, Dynarr *);
|
|
428
|
229 }
|
|
|
230
|
|
|
231 #ifdef MEMORY_USAGE_STATS
|
|
|
232
|
|
|
233 /* Return memory usage for Dynarr D. The returned value is the total
|
|
|
234 amount of bytes actually being used for the Dynarr, including all
|
|
|
235 overhead. The extra amount of space in the Dynarr that is
|
|
|
236 allocated beyond what was requested is returned in DYNARR_OVERHEAD
|
|
|
237 in STATS. The extra amount of space that malloc() allocates beyond
|
|
|
238 what was requested of it is returned in MALLOC_OVERHEAD in STATS.
|
|
|
239 See the comment above the definition of this structure. */
|
|
|
240
|
|
665
|
241 Bytecount
|
|
428
|
242 Dynarr_memory_usage (void *d, struct overhead_stats *stats)
|
|
|
243 {
|
|
665
|
244 Bytecount total = 0;
|
|
428
|
245 Dynarr *dy = (Dynarr *) d;
|
|
|
246
|
|
|
247 /* We have to be a bit tricky here because not all of the
|
|
|
248 memory that malloc() will claim as "requested" was actually
|
|
|
249 requested. */
|
|
|
250
|
|
|
251 if (dy->base)
|
|
|
252 {
|
|
665
|
253 Bytecount malloc_used = malloced_storage_size (dy->base,
|
|
1318
|
254 dy->elsize * dy->max, 0);
|
|
428
|
255 /* #### This may or may not be correct. Some Dynarrs would
|
|
|
256 prefer that we use dy->cur instead of dy->largest here. */
|
|
1318
|
257 Bytecount was_requested = dy->elsize * dy->largest;
|
|
|
258 Bytecount dynarr_overhead = dy->elsize * (dy->max - dy->largest);
|
|
428
|
259
|
|
|
260 total += malloc_used;
|
|
|
261 stats->was_requested += was_requested;
|
|
|
262 stats->dynarr_overhead += dynarr_overhead;
|
|
|
263 /* And the remainder must be malloc overhead. */
|
|
|
264 stats->malloc_overhead +=
|
|
|
265 malloc_used - was_requested - dynarr_overhead;
|
|
|
266 }
|
|
|
267
|
|
|
268 total += malloced_storage_size (d, sizeof (*dy), stats);
|
|
|
269
|
|
|
270 return total;
|
|
|
271 }
|
|
|
272
|
|
|
273 #endif /* MEMORY_USAGE_STATS */
|
