-
-
Notifications
You must be signed in to change notification settings - Fork 288
/
mm.cpp
502 lines (379 loc) · 13.3 KB
/
mm.cpp
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
/****************************************************************************
*
* MODULE: iostream
*
* COPYRIGHT (C) 2007 Laura Toma
*
*
* Iostream is a library that implements streams, external memory
* sorting on streams, and an external memory priority queue on
* streams. These are the fundamental components used in external
* memory algorithms.
* Credits: The library was developed by Laura Toma. The kernel of
* class STREAM is based on the similar class existent in the GPL TPIE
* project developed at Duke University. The sorting and priority
* queue have been developed by Laura Toma based on communications
* with Rajiv Wickremesinghe. The library was developed as part of
* porting Terraflow to GRASS in 2001. PEARL upgrades in 2003 by
* Rajiv Wickremesinghe as part of the Terracost project.
*
* 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. *
* **************************************************************************/
// A simple registration based memory manager.
#include <stdio.h>
#include <stdlib.h>
#include <assert.h>
#include <iostream>
using std::cout;
using std::cerr;
using std::endl;
//#include <mm.h>
#include <grass/iostream/mm.h>
#define MM_DEBUG if(0)
/* ************************************************************ */
MM_register::MM_register() {
instances++;
if (instances > 1) {
cerr << "MM_register(): Only 1 instance of MM_register should exist.\n";
assert(0); //core dump if debugging
exit(1);
}
assert(instances == 1);
// by default, we ignore if memory limit is exceeded
register_new = MM_IGNORE_MEMORY_EXCEEDED;
}
/* ************************************************************ */
MM_register::~MM_register(void) {
if (instances > 1) {
cerr << "MM_register(): Only 1 instance of MM_register should exist.\n";
assert(0); //core dump if debugging
exit(1);
}
assert(instances == 1);
instances--;
}
/* ************************************************************ */
void MM_register::print() {
size_t availMB = (remaining >> 20);
if (remaining) {
cout << "available memory: " << availMB << "MB "
<< "(" << remaining << "B)"
<< endl;
} else {
cout << "available memory: " << remaining << "B, exceeding: "
<< used - user_limit << "B"
<< endl;
}
}
/* ************************************************************ */
// User-callable method to set allowable memory size
MM_err MM_register::set_memory_limit (size_t new_limit) {
assert( new_limit > 0);
if (used > new_limit) {
// return MM_ERROR_EXCESSIVE_ALLOCATION;
switch (register_new) {
case MM_ABORT_ON_MEMORY_EXCEEDED:
cerr << " MM_register::set_memory_limit to " << new_limit
<< ", used " << used << ". allocation exceeds new limit.\n";
cerr.flush();
assert(0); //core dump if debugging
exit(1);
break;
case MM_WARN_ON_MEMORY_EXCEEDED:
cerr << " MM_register::set_memory_limit to " << new_limit
<< ", used " << used << ". allocation exceeds new limit.\n";
break;
case MM_IGNORE_MEMORY_EXCEEDED:
break;
}
user_limit = new_limit;
remaining = 0;
return MM_ERROR_NO_ERROR;
}
assert(used <= new_limit);
// These are unsigned, so be careful.
if (new_limit < user_limit) {
remaining -= user_limit - new_limit;
} else {
remaining += new_limit - user_limit;
}
user_limit = new_limit;
return MM_ERROR_NO_ERROR;
}
/* ************************************************************ */
//only warn if memory limit exceeded
void MM_register::warn_memory_limit() {
register_new = MM_WARN_ON_MEMORY_EXCEEDED;
}
/* ************************************************************ */
//abort if memory limit exceeded
void MM_register::enforce_memory_limit() {
register_new = MM_ABORT_ON_MEMORY_EXCEEDED;
if (used > user_limit) {
cerr << " MM_register::enforce_memory_limit: limit=" << user_limit
<< ", used=" << used << ". allocation exceeds limit.\n";
assert(0); //core dump if debugging
exit(1);
}
}
/* ************************************************************ */
//ignore memory limit accounting
void MM_register::ignore_memory_limit() {
register_new = MM_IGNORE_MEMORY_EXCEEDED;
}
/* ************************************************************ */
// provide accounting state
MM_mode MM_register::get_limit_mode() {
return register_new;
}
/* ************************************************************ */
// provide print ccounting state
void MM_register::print_limit_mode() {
cout << "Memory manager registering memory in ";
switch (register_new) {
case MM_ABORT_ON_MEMORY_EXCEEDED:
cout << "MM_ABORT_ON_MEMORY_EXCEEDED";
break;
case MM_WARN_ON_MEMORY_EXCEEDED:
cout << "MM_WARN_ON_MEMORY_EXCEEDED";
break;
case MM_IGNORE_MEMORY_EXCEEDED:
cout << "MM_IGNORE_MEMORY_EXCEEDED";
break;
}
cout << " mode." << endl;
}
/* ************************************************************ */
//return the amount of memory available before user-specified memory
//limit will be exceeded
size_t MM_register::memory_available() {
return remaining;
}
/* ************************************************************ */
size_t MM_register::memory_used() {
return used;
}
/* ************************************************************ */
size_t MM_register::memory_limit() {
return user_limit;
}
/* ---------------------------------------------------------------------- */
// return the overhead on each memory allocation request
// SIZE_SPACE is to ensure alignment on quad word boundaries. It may be
// possible to check whether a machine needs this at configuration
// time or if dword alignment is ok. On the HP 9000, bus errors occur
// when loading doubles that are not qword aligned.
static const size_t SIZE_SPACE=(sizeof(size_t) > 8 ? sizeof(size_t) : 8);
int MM_register::space_overhead () {
return SIZE_SPACE;
}
/* ************************************************************ */
// check that new allocation request is below user-defined limit.
// This should be a private method, only called by operator new.
MM_err MM_register::register_allocation(size_t request) {
if (request > remaining) {
remaining = 0;
used += request;
return MM_ERROR_INSUFFICIENT_SPACE;
} else {
used += request;
remaining -= request;
return MM_ERROR_NO_ERROR;
}
}
/* ************************************************************ */
// do the accounting for a memory deallocation request.
// This should be a private method, only called by operators
// delete and delete [].
MM_err MM_register::register_deallocation(size_t sz) {
if (sz > used) {
used = 0;
remaining = user_limit;
return MM_ERROR_UNDERFLOW;
} else {
used -= sz;
if (used < user_limit) {
remaining = user_limit - used;
} else {
assert(remaining == 0);
}
return MM_ERROR_NO_ERROR;
}
}
/* ************************************************************ */
#ifdef GRASS_MM_USE_EXCEPTION_SPECIFIER
void* operator new[] (size_t sz) throw (std::bad_alloc) {
#else
void* operator new[] (size_t sz) {
#endif /* GRASS_MM_USE_EXCEPTION_SPECIFIER */
void *p;
MM_DEBUG cout << "new: sz=" << sz << ", register "
<< sz+SIZE_SPACE << "B ,";
if (MM_manager.register_allocation (sz + SIZE_SPACE) != MM_ERROR_NO_ERROR){
//must be MM_ERROR_INSUF_SPACE
switch(MM_manager.register_new) {
case MM_ABORT_ON_MEMORY_EXCEEDED:
cerr << "MM error: limit ="<< MM_manager.memory_limit() <<"B. "
<< "allocating " << sz << "B. "
<< "limit exceeded by "
<< MM_manager.memory_used() - MM_manager.memory_limit()<<"B."
<< endl;
assert (0); // core dump if debugging
exit (1);
break;
case MM_WARN_ON_MEMORY_EXCEEDED:
cerr << "MM warning: limit="<<MM_manager.memory_limit() <<"B. "
<< "allocating " << sz << "B. "
<< " limit exceeded by "
<< MM_manager.memory_used() - MM_manager.memory_limit()<<"B."
<< endl;
break;
case MM_IGNORE_MEMORY_EXCEEDED:
break;
}
}
p = malloc(sz + SIZE_SPACE);
if (!p) {
cerr << "new: out of memory while allocating " << sz << "B" << endl;
assert(0);
exit (1);
}
*((size_t *) p) = sz;
MM_DEBUG cout << "ptr=" << (void*) (((char *) p) + SIZE_SPACE) << endl;
return ((char *) p) + SIZE_SPACE;
}
/* ************************************************************ */
#ifdef GRASS_MM_USE_EXCEPTION_SPECIFIER
void* operator new (size_t sz) throw (std::bad_alloc) {
#else
void* operator new (size_t sz) {
#endif /* GRASS_MM_USE_EXCEPTION_SPECIFIER */
void *p;
MM_DEBUG cout << "new: sz=" << sz << ", register "
<< sz+SIZE_SPACE << "B ,";
if (MM_manager.register_allocation (sz + SIZE_SPACE) != MM_ERROR_NO_ERROR){
//must be MM_ERROR_INSUF_SPACE
switch(MM_manager.register_new) {
case MM_ABORT_ON_MEMORY_EXCEEDED:
cerr << "MM error: limit ="<< MM_manager.memory_limit() <<"B. "
<< "allocating " << sz << "B. "
<< "limit exceeded by "
<< MM_manager.memory_used() - MM_manager.memory_limit()<<"B."
<< endl;
assert (0); // core dump if debugging
exit (1);
break;
case MM_WARN_ON_MEMORY_EXCEEDED:
cerr << "MM warning: limit="<<MM_manager.memory_limit() <<"B. "
<< "allocating " << sz << "B. "
<< " limit exceeded by "
<< MM_manager.memory_used() - MM_manager.memory_limit()<<"B."
<< endl;
break;
case MM_IGNORE_MEMORY_EXCEEDED:
break;
}
}
p = malloc(sz + SIZE_SPACE);
if (!p) {
cerr << "new: out of memory while allocating " << sz << "B" << endl;
assert(0);
exit (1);
}
*((size_t *) p) = sz;
MM_DEBUG cout << "ptr=" << (void*) (((char *) p) + SIZE_SPACE) << endl;
return ((char *) p) + SIZE_SPACE;
}
/* ---------------------------------------------------------------------- */
#ifdef GRASS_MM_USE_EXCEPTION_SPECIFIER
void operator delete (void *ptr) throw() {
#else
void operator delete (void *ptr) noexcept {
#endif /* GRASS_MM_USE_EXCEPTION_SPECIFIER */
size_t sz;
void *p;
MM_DEBUG cout << "delete: ptr=" << ptr << ",";
if (!ptr) {
cerr << "MM warning: operator delete was given a NULL pointer\n";
cerr.flush();
//this may actually happen: for instance when calling a default
//destructor for something that was not allocated with new
//e.g. ofstream str(name) ---- ~ofstream() called ==> ptr=NULL
//who wrote the above comment? -RW
assert(0);
//exit(1);
return;
}
assert(ptr);
p = ((char *)ptr) - SIZE_SPACE; // the base of memory
sz = *((size_t *)p);
MM_DEBUG cout << "size=" << sz <<", free " << p << "B and deallocate "
<< sz + SIZE_SPACE << endl;
if(MM_manager.register_deallocation (sz + SIZE_SPACE) != MM_ERROR_NO_ERROR){
//must be MM_ERROR_UNDERFLOW
cerr << "delete: MM_manager.register_deallocation failed\n";
assert(0);
exit(1);
}
free(p);
}
/* ---------------------------------------------------------------------- */
#ifdef GRASS_MM_USE_EXCEPTION_SPECIFIER
void operator delete[] (void *ptr) throw() {
#else
void operator delete[] (void *ptr) noexcept {
#endif /* GRASS_MM_USE_EXCEPTION_SPECIFIER */
size_t sz;
void *p;
MM_DEBUG cout << "delete[]: ptr=" << ptr << ",";
if (!ptr) {
//can this happen? -- it does: see delete above
cerr << "MM warning: operator delete [] was given a NULL pointer\n";
cerr.flush();
//assert(0);
//exit(1);
return;
}
assert(ptr);
p = ((char *)ptr) - SIZE_SPACE; // the base of memory
sz = *((size_t *)p);
MM_DEBUG cout << "size=" << sz <<", free " << p << "B and deallocate "
<< sz + SIZE_SPACE << endl;
if(MM_manager.register_deallocation (sz + SIZE_SPACE)!= MM_ERROR_NO_ERROR){
//must be MM_ERROR_UNDERFLOW
cerr << "delete[]: MM_manager.register_deallocation failed\n";
assert(0);
exit(1);
}
free(p);
}
/* ************************************************************ */
// Instantiate the actual memory manager, and allocate the
// its static data members
MM_register MM_manager;
int MM_register::instances = 0; // Number of instances. (init)
// TPIE's "register memory requests" flag
MM_mode MM_register::register_new = MM_IGNORE_MEMORY_EXCEEDED;
//This causes constructors for static variables to fail
//MM_mode MM_register::register_new = MM_ABORT_ON_MEMORY_EXCEEDED;
/* ************************************************************ */
// The counter of mm_register_init instances. It is implicitly set to 0.
unsigned int mm_register_init::count;
// The constructor and destructor that ensure that the memory manager is
// created exactly once, and destroyed when appropriate.
mm_register_init::mm_register_init(void) {
if (count++ == 0) {
MM_manager.set_memory_limit(MM_DEFAULT_MM_SIZE);
}
}
mm_register_init::~mm_register_init(void) {
--count;
}