2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2011 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version three of the GNU Affero General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU Affero General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
31 Smart Memory Allocator
33 Evolved over several years, starting with the initial
34 SMARTALLOC code for AutoSketch in 1986, guided by the Blind
35 Watchbreaker, John Walker. Isolated in this general-purpose
36 form in September of 1989. Updated with be more POSIX
37 compliant and to include Web-friendly HTML documentation in
38 October of 1998 by the same culprit. For additional
39 information and the current version visit the Web page:
41 http://www.fourmilab.ch/smartall/
45 #define _LOCKMGR_COMPLIANT
48 /* Use the real routines here */
54 /* We normally turn off debugging here.
55 * If you want it, simply #ifdef all the
64 #define Dmsg2(l,f,a1,a2)
65 #define Dmsg3(l,f,a1,a2,a3)
66 #define Dmsg4(l,f,a1,a2,a3,a4)
70 uint64_t sm_max_bytes = 0;
71 uint64_t sm_bytes = 0;
72 uint32_t sm_max_buffers = 0;
73 uint32_t sm_buffers = 0;
77 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
79 extern char my_name[]; /* daemon name */
81 #define EOS '\0' /* End of string sentinel */
82 #define sm_min(a, b) ((a) < (b) ? (a) : (b))
84 /* Queue data structures */
86 /* Memory allocation control structures and storage. */
89 struct b_queue abq; /* Links on allocated queue */
90 uint32_t ablen; /* Buffer length in bytes */
91 const char *abfname; /* File name pointer */
92 uint32_t ablineno; /* Line number of allocation */
93 bool abin_use; /* set when malloced and cleared when free */
96 static struct b_queue abqueue = { /* Allocated buffer queue */
101 static bool bufimode = false; /* Buffers not tracked when True */
103 #define HEAD_SIZE BALIGN(sizeof(struct abufhead))
106 /* SMALLOC -- Allocate buffer, enqueing on the orphaned buffer
109 static void *smalloc(const char *fname, int lineno, unsigned int nbytes)
113 /* Note: Unix MALLOC actually permits a zero length to be
114 passed and allocates a valid block with zero user bytes.
115 Such a block can later be expanded with realloc(). We
116 disallow this based on the belief that it's better to make
117 a special case and allocate one byte in the rare case this
118 is desired than to miss all the erroneous occurrences where
119 buffer length calculation code results in a zero. */
123 nbytes += HEAD_SIZE + 1;
124 if ((buf = (char *)malloc(nbytes)) != NULL) {
125 struct abufhead *head = (struct abufhead *)buf;
127 /* Enqueue buffer on allocated list */
128 qinsert(&abqueue, (struct b_queue *) buf);
129 head->ablen = nbytes;
130 head->abfname = bufimode ? NULL : fname;
131 head->ablineno = (uint32_t)lineno;
132 head->abin_use = true;
133 /* Emplace end-clobber detector at end of buffer */
134 buf[nbytes - 1] = (uint8_t)((((intptr_t) buf) & 0xFF) ^ 0xC5);
135 buf += HEAD_SIZE; /* Increment to user data start */
136 if (++sm_buffers > sm_max_buffers) {
137 sm_max_buffers = sm_buffers;
140 if (sm_bytes > sm_max_bytes) {
141 sm_max_bytes = sm_bytes;
145 Emsg0(M_ABORT, 0, _("Out of memory\n"));
147 Dmsg4(1150, "smalloc %d at %p from %s:%d\n", nbytes, buf, fname, lineno);
148 #if SMALLOC_SANITY_CHECK > 0
149 if (sm_bytes > SMALLOC_SANITY_CHECK) {
150 Emsg0(M_ABORT, 0, _("Too much memory used."));
156 /* SM_NEW_OWNER -- Update the File and line number for a buffer
157 This is to accomodate mem_pool. */
159 void sm_new_owner(const char *fname, int lineno, char *buf)
161 buf -= HEAD_SIZE; /* Decrement to header */
162 ((struct abufhead *)buf)->abfname = bufimode ? NULL : fname;
163 ((struct abufhead *)buf)->ablineno = (uint32_t) lineno;
164 ((struct abufhead *)buf)->abin_use = true;
168 /* SM_FREE -- Update free pool availability. FREE is never called
169 except through this interface or by actuallyfree().
170 free(x) is defined to generate a call to this
173 void sm_free(const char *file, int line, void *fp)
175 char *cp = (char *) fp;
177 uint32_t lineno = line;
180 Emsg2(M_ABORT, 0, _("Attempt to free NULL called from %s:%d\n"), file, lineno);
184 qp = (struct b_queue *)cp;
185 struct abufhead *head = (struct abufhead *)cp;
188 Dmsg4(1150, "sm_free %d at %p from %s:%d\n",
190 get_basename(head->abfname), head->ablineno);
192 if (!head->abin_use) {
194 Emsg2(M_ABORT, 0, _("double free from %s:%d\n"), file, lineno);
196 head->abin_use = false;
198 /* The following assertions will catch virtually every release
199 of an address which isn't an allocated buffer. */
200 if (qp->qnext->qprev != qp) {
202 Emsg2(M_ABORT, 0, _("qp->qnext->qprev != qp called from %s:%d\n"), file, lineno);
204 if (qp->qprev->qnext != qp) {
206 Emsg2(M_ABORT, 0, _("qp->qprev->qnext != qp called from %s:%d\n"), file, lineno);
209 /* The following assertion detects storing off the end of the
210 allocated space in the buffer by comparing the end of buffer
211 checksum with the address of the buffer. */
213 if (((unsigned char *)cp)[head->ablen - 1] != ((((intptr_t) cp) & 0xFF) ^ 0xC5)) {
215 Emsg6(M_ABORT, 0, _("Overrun buffer: len=%d addr=%p allocated: %s:%d called from %s:%d\n"),
216 head->ablen, fp, get_basename(head->abfname), head->ablineno, file, line);
218 if (sm_buffers > 0) {
220 sm_bytes -= head->ablen;
226 /* Now we wipe the contents of the just-released buffer with
227 "designer garbage" (Duff Kurland's phrase) of alternating
228 bits. This is intended to ruin the day for any miscreant who
229 attempts to access data through a pointer into storage that's
230 been previously released.
232 Modified, kes May, 2007 to not zap the header. This allows us
233 to check the in_use bit and detect doubly freed buffers.
236 memset(cp+HEAD_SIZE, 0xAA, (int)(head->ablen - HEAD_SIZE));
241 /* SM_MALLOC -- Allocate buffer. NULL is returned if no memory
244 void *sm_malloc(const char *fname, int lineno, unsigned int nbytes)
248 if ((buf = smalloc(fname, lineno, nbytes)) != NULL) {
250 /* To catch sloppy code that assumes buffers obtained from
251 malloc() are zeroed, we preset the buffer contents to
252 "designer garbage" consisting of alternating bits. */
254 memset(buf, 0x55, (int) nbytes);
256 Emsg0(M_ABORT, 0, _("Out of memory\n"));
261 /* SM_CALLOC -- Allocate an array and clear it to zero. */
263 void *sm_calloc(const char *fname, int lineno,
264 unsigned int nelem, unsigned int elsize)
268 if ((buf = smalloc(fname, lineno, nelem * elsize)) != NULL) {
269 memset(buf, 0, (int) (nelem * elsize));
271 Emsg0(M_ABORT, 0, _("Out of memory\n"));
276 /* SM_REALLOC -- Adjust the size of a previously allocated buffer.
277 Note that the trick of "resurrecting" a previously
278 freed buffer with realloc() is NOT supported by this
279 function. Further, because of the need to maintain
280 our control storage, SM_REALLOC must always allocate
281 a new block and copy the data in the old block.
282 This may result in programs which make heavy use of
283 realloc() running much slower than normally. */
285 void *sm_realloc(const char *fname, int lineno, void *ptr, unsigned int size)
289 char *cp = (char *) ptr;
291 Dmsg4(1400, "sm_realloc %s:%d %p %d\n", get_basename(fname), (uint32_t)lineno, ptr, size);
293 e_msg(fname, lineno, M_ABORT, 0, _("sm_realloc size: %d\n"), size);
296 /* If the old block pointer is NULL, treat realloc() as a
297 malloc(). SVID is silent on this, but many C libraries
300 return sm_malloc(fname, lineno, size);
303 /* If the old and new sizes are the same, be a nice guy and just
304 return the buffer passed in. */
306 struct abufhead *head = (struct abufhead *)cp;
307 osize = head->ablen - (HEAD_SIZE + 1);
312 /* Sizes differ. Allocate a new buffer of the requested size.
313 If we can't obtain such a buffer, act as defined in SVID:
314 return NULL from realloc() and leave the buffer in PTR
318 // sm_bytes -= head->ablen;
320 if ((buf = smalloc(fname, lineno, size)) != NULL) {
321 memcpy(buf, ptr, (int)sm_min(size, osize));
322 /* If the new buffer is larger than the old, fill the balance
323 of it with "designer garbage". */
325 memset(((char *) buf) + osize, 0x55, (int) (size - osize));
328 /* All done. Free and dechain the original buffer. */
329 sm_free(fname, lineno, ptr);
331 Dmsg4(4150, _("sm_realloc %d at %p from %s:%d\n"), size, buf, get_basename(fname), (uint32_t)lineno);
335 /* ACTUALLYMALLOC -- Call the system malloc() function to obtain
336 storage which will eventually be released
337 by system or library routines not compiled
340 void *actuallymalloc(unsigned int size)
345 /* ACTUALLYCALLOC -- Call the system calloc() function to obtain
346 storage which will eventually be released
347 by system or library routines not compiled
350 void *actuallycalloc(unsigned int nelem, unsigned int elsize)
352 return calloc(nelem, elsize);
355 /* ACTUALLYREALLOC -- Call the system realloc() function to obtain
356 storage which will eventually be released
357 by system or library routines not compiled
360 void *actuallyrealloc(void *ptr, unsigned int size)
362 Dmsg2(1400, "Actuallyrealloc %p %d\n", ptr, size);
363 return realloc(ptr, size);
366 /* ACTUALLYFREE -- Interface to system free() function to release
367 buffers allocated by low-level routines. */
369 void actuallyfree(void *cp)
374 /* SM_DUMP -- Print orphaned buffers (and dump them if BUFDUMP is
377 void sm_dump(bool bufdump, bool in_use)
383 ap = (struct abufhead *)abqueue.qnext;
385 while (ap != (struct abufhead *) &abqueue) {
388 (ap->abq.qnext->qprev != (struct b_queue *) ap) ||
389 (ap->abq.qprev->qnext != (struct b_queue *) ap)) {
391 "\nOrphaned buffers exist. Dump terminated following\n"
392 " discovery of bad links in chain of orphaned buffers.\n"
393 " Buffer address with bad links: %p\n"), ap);
397 if (ap->abfname != NULL) {
399 uint32_t memsize = ap->ablen - (HEAD_SIZE + 1);
400 char *cp = ((char *)ap) + HEAD_SIZE;
402 Pmsg6(0, "%s buffer: %s %d bytes at %p from %s:%d\n",
403 in_use?"In use":"Orphaned",
404 my_name, memsize, cp, get_basename(ap->abfname), ap->ablineno);
412 bstrncat(errmsg, "\n", sizeof(errmsg));
414 Pmsg1(0, "%s", errmsg);
417 bsnprintf(buf, sizeof(buf), " %02X",
419 bstrncat(errmsg, buf, sizeof(errmsg));
423 Pmsg1(0, "%s\n", errmsg);
426 ap = (struct abufhead *) ap->abq.qnext;
432 /* SM_CHECK -- Check the buffers and dump if any damage exists. */
433 void sm_check(const char *fname, int lineno, bool bufdump)
435 if (!sm_check_rtn(fname, lineno, bufdump)) {
436 Emsg2(M_ABORT, 0, _("Damaged buffer found. Called from %s:%d\n"),
437 get_basename(fname), (uint32_t)lineno);
442 /* SM_CHECK_RTN -- Check the buffers and return 1 if OK otherwise 0 */
443 int sm_check_rtn(const char *fname, int lineno, bool bufdump)
449 ap = (struct abufhead *) abqueue.qnext;
450 while (ap != (struct abufhead *)&abqueue) {
453 if (ap->abq.qnext->qprev != (struct b_queue *)ap) {
456 if (ap->abq.qprev->qnext != (struct b_queue *)ap) {
459 if (((unsigned char *) ap)[((struct abufhead *)ap)->ablen - 1] !=
460 ((((intptr_t) ap) & 0xFF) ^ 0xC5)) {
469 _("\nDamaged buffers found at %s:%d\n"), get_basename(fname), (uint32_t)lineno);
472 Pmsg0(0, _(" discovery of bad prev link.\n"));
475 Pmsg0(0, _(" discovery of bad next link.\n"));
478 Pmsg0(0, _(" discovery of data overrun.\n"));
481 Pmsg0(0, _(" NULL pointer.\n"));
487 Pmsg1(0, _(" Buffer address: %p\n"), ap);
489 if (ap->abfname != NULL) {
490 uint32_t memsize = ap->ablen - (HEAD_SIZE + 1);
494 _("Damaged buffer: %6u bytes allocated at line %d of %s %s\n"),
495 memsize, ap->ablineno, my_name, get_basename(ap->abfname)
499 char *cp = ((char *) ap) + HEAD_SIZE;
504 strcat(errmsg, "\n");
506 Pmsg1(0, "%s", errmsg);
510 sprintf(errmsg + strlen(errmsg), " %02X",
513 sprintf(errmsg + strlen(errmsg), " %c ",
519 Pmsg1(0, "%s\n", errmsg);
523 ap = (struct abufhead *)ap->abq.qnext;
527 return badbuf ? 0 : 1;
531 /* SM_STATIC -- Orphaned buffer detection can be disabled (for such
532 items as buffers allocated during initialisation) by
533 calling sm_static(1). Normal orphaned buffer
534 detection can be re-enabled with sm_static(0). Note
535 that all the other safeguards still apply to buffers
536 allocated when sm_static(1) mode is in effect. */
538 void sm_static(bool mode)
544 * Here we overload C++'s global new and delete operators
545 * so that the memory is allocated through smartalloc.
549 void * operator new(size_t size)
551 // Dmsg1(000, "new called %d\n", size);
552 return sm_malloc(__FILE__, __LINE__, size);
555 void operator delete(void *buf)
557 // Dmsg1(000, "free called %p\n", buf);
558 sm_free(__FILE__, __LINE__, buf);