2005-01-16 Havoc Pennington <hp@redhat.com>
[platform/upstream/dbus.git] / dbus / dbus-memory.c
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-memory.c  D-BUS memory handling
3  *
4  * Copyright (C) 2002, 2003  Red Hat Inc.
5  *
6  * Licensed under the Academic Free License version 2.1
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  */
23
24 #include "dbus-memory.h"
25 #include "dbus-internals.h"
26 #include "dbus-sysdeps.h"
27 #include "dbus-list.h"
28 #include <stdlib.h>
29
30 /**
31  * @defgroup DBusMemory Memory Allocation
32  * @ingroup  DBus
33  * @brief dbus_malloc(), dbus_free(), etc.
34  *
35  * Functions and macros related to allocating and releasing
36  * blocks of memory.
37  *
38  */
39
40 /**
41  * @defgroup DBusMemoryInternals Memory allocation implementation details
42  * @ingroup  DBusInternals
43  * @brief internals of dbus_malloc() etc.
44  *
45  * Implementation details related to allocating and releasing blocks
46  * of memory.
47  */
48
49 /**
50  * @addtogroup DBusMemory
51  *
52  * @{
53  */
54
55 /**
56  * @def dbus_new
57  *
58  * Safe macro for using dbus_malloc(). Accepts the type
59  * to allocate and the number of type instances to
60  * allocate as arguments, and returns a memory block
61  * cast to the desired type, instead of as a void*.
62  *
63  * @param type type name to allocate
64  * @param count number of instances in the allocated array
65  * @returns the new memory block or #NULL on failure
66  */
67
68 /**
69  * @def dbus_new0
70  *
71  * Safe macro for using dbus_malloc0(). Accepts the type
72  * to allocate and the number of type instances to
73  * allocate as arguments, and returns a memory block
74  * cast to the desired type, instead of as a void*.
75  * The allocated array is initialized to all-bits-zero.
76  *
77  * @param type type name to allocate
78  * @param count number of instances in the allocated array
79  * @returns the new memory block or #NULL on failure
80  */
81
82 /**
83  * @typedef DBusFreeFunction
84  *
85  * The type of a function which frees a block of memory.
86  *
87  * @param memory the memory to free
88  */
89
90 /** @} */ /* end of public API docs */
91
92 /**
93  * @addtogroup DBusMemoryInternals
94  *
95  * @{
96  */
97
98 #ifdef DBUS_BUILD_TESTS
99 static dbus_bool_t debug_initialized = FALSE;
100 static int fail_nth = -1;
101 static size_t fail_size = 0;
102 static int fail_alloc_counter = _DBUS_INT_MAX;
103 static int n_failures_per_failure = 1;
104 static int n_failures_this_failure = 0;
105 static dbus_bool_t guards = FALSE;
106 static dbus_bool_t disable_mem_pools = FALSE;
107 static dbus_bool_t backtrace_on_fail_alloc = FALSE;
108 static int n_blocks_outstanding = 0;
109
110 /** value stored in guard padding for debugging buffer overrun */
111 #define GUARD_VALUE 0xdeadbeef
112 /** size of the information about the block stored in guard mode */
113 #define GUARD_INFO_SIZE 8
114 /** size of the GUARD_VALUE-filled padding after the header info  */
115 #define GUARD_START_PAD 16
116 /** size of the GUARD_VALUE-filled padding at the end of the block */
117 #define GUARD_END_PAD 16
118 /** size of stuff at start of block */
119 #define GUARD_START_OFFSET (GUARD_START_PAD + GUARD_INFO_SIZE)
120 /** total extra size over the requested allocation for guard stuff */
121 #define GUARD_EXTRA_SIZE (GUARD_START_OFFSET + GUARD_END_PAD)
122
123 static void
124 _dbus_initialize_malloc_debug (void)
125 {
126   if (!debug_initialized)
127     {
128       debug_initialized = TRUE;
129       
130       if (_dbus_getenv ("DBUS_MALLOC_FAIL_NTH") != NULL)
131         {
132           fail_nth = atoi (_dbus_getenv ("DBUS_MALLOC_FAIL_NTH"));
133           fail_alloc_counter = fail_nth;
134           _dbus_verbose ("Will fail malloc every %d times\n", fail_nth);
135         }
136       
137       if (_dbus_getenv ("DBUS_MALLOC_FAIL_GREATER_THAN") != NULL)
138         {
139           fail_size = atoi (_dbus_getenv ("DBUS_MALLOC_FAIL_GREATER_THAN"));
140           _dbus_verbose ("Will fail mallocs over %ld bytes\n",
141                          (long) fail_size);
142         }
143
144       if (_dbus_getenv ("DBUS_MALLOC_GUARDS") != NULL)
145         {
146           guards = TRUE;
147           _dbus_verbose ("Will use malloc guards\n");
148         }
149
150       if (_dbus_getenv ("DBUS_DISABLE_MEM_POOLS") != NULL)
151         {
152           disable_mem_pools = TRUE;
153           _dbus_verbose ("Will disable memory pools\n");
154         }
155
156       if (_dbus_getenv ("DBUS_MALLOC_BACKTRACES") != NULL)
157         {
158           backtrace_on_fail_alloc = TRUE;
159           _dbus_verbose ("Will backtrace on failing a malloc\n");
160         }
161     }
162 }
163
164 /**
165  * Whether to turn off mem pools, useful for leak checking.
166  *
167  * @returns #TRUE if mempools should not be used.
168  */
169 dbus_bool_t
170 _dbus_disable_mem_pools (void)
171 {
172   _dbus_initialize_malloc_debug ();
173   return disable_mem_pools;
174 }
175
176 /**
177  * Sets the number of allocations until we simulate a failed
178  * allocation. If set to 0, the next allocation to run
179  * fails; if set to 1, one succeeds then the next fails; etc.
180  * Set to _DBUS_INT_MAX to not fail anything. 
181  *
182  * @param until_next_fail number of successful allocs before one fails
183  */
184 void
185 _dbus_set_fail_alloc_counter (int until_next_fail)
186 {
187   _dbus_initialize_malloc_debug ();
188
189   fail_alloc_counter = until_next_fail;
190
191 #if 0
192   _dbus_verbose ("Set fail alloc counter = %d\n", fail_alloc_counter);
193 #endif
194 }
195
196 /**
197  * Gets the number of successful allocs until we'll simulate
198  * a failed alloc.
199  *
200  * @returns current counter value
201  */
202 int
203 _dbus_get_fail_alloc_counter (void)
204 {
205   _dbus_initialize_malloc_debug ();
206
207   return fail_alloc_counter;
208 }
209
210 /**
211  * Sets how many mallocs to fail when the fail alloc counter reaches
212  * 0.
213  *
214  * @param failures_per_failure number to fail
215  */
216 void
217 _dbus_set_fail_alloc_failures (int failures_per_failure)
218 {
219   n_failures_per_failure = failures_per_failure;
220 }
221
222 /**
223  * Gets the number of failures we'll have when the fail malloc
224  * counter reaches 0.
225  *
226  * @returns number of failures planned
227  */
228 int
229 _dbus_get_fail_alloc_failures (void)
230 {
231   return n_failures_per_failure;
232 }
233
234 #ifdef DBUS_BUILD_TESTS
235 /**
236  * Called when about to alloc some memory; if
237  * it returns #TRUE, then the allocation should
238  * fail. If it returns #FALSE, then the allocation
239  * should not fail.
240  *
241  * @returns #TRUE if this alloc should fail
242  */
243 dbus_bool_t
244 _dbus_decrement_fail_alloc_counter (void)
245 {
246   _dbus_initialize_malloc_debug ();
247   
248   if (fail_alloc_counter <= 0)
249     {
250       if (backtrace_on_fail_alloc)
251         _dbus_print_backtrace ();
252
253       _dbus_verbose ("failure %d\n", n_failures_this_failure);
254       
255       n_failures_this_failure += 1;
256       if (n_failures_this_failure >= n_failures_per_failure)
257         {
258           if (fail_nth >= 0)
259             fail_alloc_counter = fail_nth;
260           else
261             fail_alloc_counter = _DBUS_INT_MAX;
262
263           n_failures_this_failure = 0;
264
265           _dbus_verbose ("reset fail alloc counter to %d\n", fail_alloc_counter);
266         }
267       
268       return TRUE;
269     }
270   else
271     {
272       fail_alloc_counter -= 1;
273       return FALSE;
274     }
275 }
276 #endif /* DBUS_BUILD_TESTS */
277
278 /**
279  * Get the number of outstanding malloc()'d blocks.
280  *
281  * @returns number of blocks
282  */
283 int
284 _dbus_get_malloc_blocks_outstanding (void)
285 {
286   return n_blocks_outstanding;
287 }
288
289 /**
290  * Where the block came from.
291  */
292 typedef enum
293 {
294   SOURCE_UNKNOWN,
295   SOURCE_MALLOC,
296   SOURCE_REALLOC,
297   SOURCE_MALLOC_ZERO,
298   SOURCE_REALLOC_NULL
299 } BlockSource;
300
301 static const char*
302 source_string (BlockSource source)
303 {
304   switch (source)
305     {
306     case SOURCE_UNKNOWN:
307       return "unknown";
308     case SOURCE_MALLOC:
309       return "malloc";
310     case SOURCE_REALLOC:
311       return "realloc";
312     case SOURCE_MALLOC_ZERO:
313       return "malloc0";
314     case SOURCE_REALLOC_NULL:
315       return "realloc(NULL)";
316     }
317   _dbus_assert_not_reached ("Invalid malloc block source ID");
318   return "invalid!";
319 }
320
321 static void
322 check_guards (void       *free_block,
323               dbus_bool_t overwrite)
324 {
325   if (free_block != NULL)
326     {
327       unsigned char *block = ((unsigned char*)free_block) - GUARD_START_OFFSET;
328       size_t requested_bytes = *(dbus_uint32_t*)block;
329       BlockSource source = *(dbus_uint32_t*)(block + 4);
330       unsigned int i;
331       dbus_bool_t failed;
332
333       failed = FALSE;
334
335 #if 0
336       _dbus_verbose ("Checking %d bytes request from source %s\n",
337                      requested_bytes, source_string (source));
338 #endif
339       
340       i = GUARD_INFO_SIZE;
341       while (i < GUARD_START_OFFSET)
342         {
343           dbus_uint32_t value = *(dbus_uint32_t*) &block[i];
344           if (value != GUARD_VALUE)
345             {
346               _dbus_warn ("Block of %lu bytes from %s had start guard value 0x%ux at %d expected 0x%x\n",
347                           (long) requested_bytes, source_string (source),
348                           value, i, GUARD_VALUE);
349               failed = TRUE;
350             }
351           
352           i += 4;
353         }
354
355       i = GUARD_START_OFFSET + requested_bytes;
356       while (i < (GUARD_START_OFFSET + requested_bytes + GUARD_END_PAD))
357         {
358           dbus_uint32_t value = *(dbus_uint32_t*) &block[i];
359           if (value != GUARD_VALUE)
360             {
361               _dbus_warn ("Block of %lu bytes from %s had end guard value 0x%ux at %d expected 0x%x\n",
362                           (long) requested_bytes, source_string (source),
363                           value, i, GUARD_VALUE);
364               failed = TRUE;
365             }
366           
367           i += 4;
368         }
369
370       /* set memory to anything but nul bytes */
371       if (overwrite)
372         memset (free_block, 'g', requested_bytes);
373       
374       if (failed)
375         _dbus_assert_not_reached ("guard value corruption");
376     }
377 }
378
379 static void*
380 set_guards (void       *real_block,
381             size_t      requested_bytes,
382             BlockSource source)
383 {
384   unsigned char *block = real_block;
385   unsigned int i;
386   
387   if (block == NULL)
388     return NULL;
389
390   _dbus_assert (GUARD_START_OFFSET + GUARD_END_PAD == GUARD_EXTRA_SIZE);
391   
392   *((dbus_uint32_t*)block) = requested_bytes;
393   *((dbus_uint32_t*)(block + 4)) = source;
394
395   i = GUARD_INFO_SIZE;
396   while (i < GUARD_START_OFFSET)
397     {
398       (*(dbus_uint32_t*) &block[i]) = GUARD_VALUE;
399       
400       i += 4;
401     }
402
403   i = GUARD_START_OFFSET + requested_bytes;
404   while (i < (GUARD_START_OFFSET + requested_bytes + GUARD_END_PAD))
405     {
406       (*(dbus_uint32_t*) &block[i]) = GUARD_VALUE;
407       
408       i += 4;
409     }
410   
411   check_guards (block + GUARD_START_OFFSET, FALSE);
412   
413   return block + GUARD_START_OFFSET;
414 }
415
416 #endif
417
418 /** @} */ /* End of internals docs */
419
420
421 /**
422  * @addtogroup DBusMemory
423  *
424  * @{
425  */
426
427 /**
428  * Allocates the given number of bytes, as with standard
429  * malloc(). Guaranteed to return #NULL if bytes is zero
430  * on all platforms. Returns #NULL if the allocation fails.
431  * The memory must be released with dbus_free().
432  *
433  * @param bytes number of bytes to allocate
434  * @return allocated memory, or #NULL if the allocation fails.
435  */
436 void*
437 dbus_malloc (size_t bytes)
438 {
439 #ifdef DBUS_BUILD_TESTS
440   _dbus_initialize_malloc_debug ();
441   
442   if (_dbus_decrement_fail_alloc_counter ())
443     {
444       _dbus_verbose (" FAILING malloc of %ld bytes\n", (long) bytes);
445       
446       return NULL;
447     }
448 #endif
449   
450   if (bytes == 0) /* some system mallocs handle this, some don't */
451     return NULL;
452 #ifdef DBUS_BUILD_TESTS
453   else if (fail_size != 0 && bytes > fail_size)
454     return NULL;
455   else if (guards)
456     {
457       void *block;
458
459       block = malloc (bytes + GUARD_EXTRA_SIZE);
460       if (block)
461         n_blocks_outstanding += 1;
462       
463       return set_guards (block, bytes, SOURCE_MALLOC);
464     }
465 #endif
466   else
467     {
468       void *mem;
469       mem = malloc (bytes);
470 #ifdef DBUS_BUILD_TESTS
471       if (mem)
472         n_blocks_outstanding += 1;
473 #endif
474       return mem;
475     }
476 }
477
478 /**
479  * Allocates the given number of bytes, as with standard malloc(), but
480  * all bytes are initialized to zero as with calloc(). Guaranteed to
481  * return #NULL if bytes is zero on all platforms. Returns #NULL if the
482  * allocation fails.  The memory must be released with dbus_free().
483  *
484  * @param bytes number of bytes to allocate
485  * @return allocated memory, or #NULL if the allocation fails.
486  */
487 void*
488 dbus_malloc0 (size_t bytes)
489 {
490 #ifdef DBUS_BUILD_TESTS
491   _dbus_initialize_malloc_debug ();
492   
493   if (_dbus_decrement_fail_alloc_counter ())
494     {
495       _dbus_verbose (" FAILING malloc0 of %ld bytes\n", (long) bytes);
496       
497       return NULL;
498     }
499 #endif
500
501   if (bytes == 0)
502     return NULL;
503 #ifdef DBUS_BUILD_TESTS
504   else if (fail_size != 0 && bytes > fail_size)
505     return NULL;
506   else if (guards)
507     {
508       void *block;
509
510       block = calloc (bytes + GUARD_EXTRA_SIZE, 1);
511       if (block)
512         n_blocks_outstanding += 1;
513       return set_guards (block, bytes, SOURCE_MALLOC_ZERO);
514     }
515 #endif
516   else
517     {
518       void *mem;
519       mem = calloc (bytes, 1);
520 #ifdef DBUS_BUILD_TESTS
521       if (mem)
522         n_blocks_outstanding += 1;
523 #endif
524       return mem;
525     }
526 }
527
528 /**
529  * Resizes a block of memory previously allocated by dbus_malloc() or
530  * dbus_malloc0(). Guaranteed to free the memory and return #NULL if bytes
531  * is zero on all platforms. Returns #NULL if the resize fails.
532  * If the resize fails, the memory is not freed.
533  *
534  * @param memory block to be resized
535  * @param bytes new size of the memory block
536  * @return allocated memory, or #NULL if the resize fails.
537  */
538 void*
539 dbus_realloc (void  *memory,
540               size_t bytes)
541 {
542 #ifdef DBUS_BUILD_TESTS
543   _dbus_initialize_malloc_debug ();
544   
545   if (_dbus_decrement_fail_alloc_counter ())
546     {
547       _dbus_verbose (" FAILING realloc of %ld bytes\n", (long) bytes);
548       
549       return NULL;
550     }
551 #endif
552   
553   if (bytes == 0) /* guarantee this is safe */
554     {
555       dbus_free (memory);
556       return NULL;
557     }
558 #ifdef DBUS_BUILD_TESTS
559   else if (fail_size != 0 && bytes > fail_size)
560     return NULL;
561   else if (guards)
562     {
563       if (memory)
564         {
565           size_t old_bytes;
566           void *block;
567           
568           check_guards (memory, FALSE);
569           
570           block = realloc (((unsigned char*)memory) - GUARD_START_OFFSET,
571                            bytes + GUARD_EXTRA_SIZE);
572
573           old_bytes = *(dbus_uint32_t*)block;
574           if (block && bytes >= old_bytes)
575             /* old guards shouldn't have moved */
576             check_guards (((unsigned char*)block) + GUARD_START_OFFSET, FALSE);
577           
578           return set_guards (block, bytes, SOURCE_REALLOC);
579         }
580       else
581         {
582           void *block;
583           
584           block = malloc (bytes + GUARD_EXTRA_SIZE);
585
586           if (block)
587             n_blocks_outstanding += 1;
588           
589           return set_guards (block, bytes, SOURCE_REALLOC_NULL);   
590         }
591     }
592 #endif
593   else
594     {
595       void *mem;
596       mem = realloc (memory, bytes);
597 #ifdef DBUS_BUILD_TESTS
598       if (memory == NULL && mem != NULL)
599         n_blocks_outstanding += 1;
600 #endif
601       return mem;
602     }
603 }
604
605 /**
606  * Frees a block of memory previously allocated by dbus_malloc() or
607  * dbus_malloc0(). If passed #NULL, does nothing.
608  * 
609  * @param memory block to be freed
610  */
611 void
612 dbus_free (void  *memory)
613 {
614 #ifdef DBUS_BUILD_TESTS
615   if (guards)
616     {
617       check_guards (memory, TRUE);
618       if (memory)
619         {
620           n_blocks_outstanding -= 1;
621           
622           _dbus_assert (n_blocks_outstanding >= 0);
623           
624           free (((unsigned char*)memory) - GUARD_START_OFFSET);
625         }
626       
627       return;
628     }
629 #endif
630     
631   if (memory) /* we guarantee it's safe to free (NULL) */
632     {
633 #ifdef DBUS_BUILD_TESTS
634       n_blocks_outstanding -= 1;
635       
636       _dbus_assert (n_blocks_outstanding >= 0);
637 #endif
638
639       free (memory);
640     }
641 }
642
643 /**
644  * Frees a #NULL-terminated array of strings.
645  * If passed #NULL, does nothing.
646  *
647  * @param str_array the array to be freed
648  */
649 void
650 dbus_free_string_array (char **str_array)
651 {
652   if (str_array)
653     {
654       int i;
655
656       i = 0;
657       while (str_array[i])
658         {
659           dbus_free (str_array[i]);
660           i++;
661         }
662
663       dbus_free (str_array);
664     }
665 }
666
667 /** @} */ /* End of public API docs block */
668
669
670 /**
671  * @addtogroup DBusMemoryInternals
672  *
673  * @{
674  */
675
676 /**
677  * _dbus_current_generation is used to track each
678  * time that dbus_shutdown() is called, so we can
679  * reinit things after it's been called. It is simply
680  * incremented each time we shut down.
681  */
682 int _dbus_current_generation = 1;
683
684 /**
685  * Represents a function to be called on shutdown.
686  */
687 typedef struct ShutdownClosure ShutdownClosure;
688
689 /**
690  * This struct represents a function to be called on shutdown.
691  */
692 struct ShutdownClosure
693 {
694   ShutdownClosure *next;     /**< Next ShutdownClosure */
695   DBusShutdownFunction func; /**< Function to call */
696   void *data;                /**< Data for function */
697 };
698
699 _DBUS_DEFINE_GLOBAL_LOCK (shutdown_funcs);
700 static ShutdownClosure *registered_globals = NULL;
701
702 /**
703  * Register a cleanup function to be called exactly once
704  * the next time dbus_shutdown() is called.
705  *
706  * @param func the function
707  * @param data data to pass to the function
708  * @returns #FALSE on not enough memory
709  */
710 dbus_bool_t
711 _dbus_register_shutdown_func (DBusShutdownFunction  func,
712                               void                 *data)
713 {
714   ShutdownClosure *c;
715
716   c = dbus_new (ShutdownClosure, 1);
717
718   if (c == NULL)
719     return FALSE;
720
721   c->func = func;
722   c->data = data;
723
724   _DBUS_LOCK (shutdown_funcs);
725   
726   c->next = registered_globals;
727   registered_globals = c;
728
729   _DBUS_UNLOCK (shutdown_funcs);
730   
731   return TRUE;
732 }
733
734 /** @} */ /* End of private API docs block */
735
736
737 /**
738  * @addtogroup DBusMemory
739  *
740  * @{
741  */
742
743 /**
744  * The D-BUS library keeps some internal global variables, for example
745  * to cache the username of the current process.  This function is
746  * used to free these global variables.  It is really useful only for
747  * leak-checking cleanliness and the like. WARNING: this function is
748  * NOT thread safe, it must be called while NO other threads are using
749  * D-BUS. You cannot continue using D-BUS after calling this function,
750  * as it does things like free global mutexes created by
751  * dbus_threads_init(). To use a D-BUS function after calling
752  * dbus_shutdown(), you have to start over from scratch, e.g. calling
753  * dbus_threads_init() again.
754  */
755 void
756 dbus_shutdown (void)
757 {
758   while (registered_globals != NULL)
759     {
760       ShutdownClosure *c;
761
762       c = registered_globals;
763       registered_globals = c->next;
764       
765       (* c->func) (c->data);
766       
767       dbus_free (c);
768     }
769
770   _dbus_current_generation += 1;
771 }
772
773 /** @} */ /** End of public API docs block */
774
775 #ifdef DBUS_BUILD_TESTS
776 #include "dbus-test.h"
777
778 /**
779  * @ingroup DBusMemoryInternals
780  * Unit test for DBusMemory
781  * @returns #TRUE on success.
782  */
783 dbus_bool_t
784 _dbus_memory_test (void)
785 {
786   dbus_bool_t old_guards;
787   void *p;
788   size_t size;
789
790   old_guards = guards;
791   guards = TRUE;
792   p = dbus_malloc (4);
793   if (p == NULL)
794     _dbus_assert_not_reached ("no memory");
795   for (size = 4; size < 256; size += 4)
796     {
797       p = dbus_realloc (p, size);
798       if (p == NULL)
799         _dbus_assert_not_reached ("no memory");
800     }
801   for (size = 256; size != 0; size -= 4)
802     {
803       p = dbus_realloc (p, size);
804       if (p == NULL)
805         _dbus_assert_not_reached ("no memory");
806     }
807   dbus_free (p);
808   guards = old_guards;
809   return TRUE;
810 }
811
812 #endif