eina freeq - add ability to set freeval and add a final freeval

this allows environment variables to set the byte falue to fill a
freeq item added to the queue and then another item to actually fill
memory with just before the free function so memory content difference
will tell you if its inside the free queue or already freed from it
completely. if you set tyhe freed value to 0 this will not fill with a
value just before free and leave the value as-is determined by the
first fill pattern value.

diff --git a/src/lib/eina/eina_freeq.c b/src/lib/eina/eina_freeq.c
index c1aff8925c865141bbd642686384bcb77208f5bd..17459dc5eeb7e77c6d59d774c5ca7c56829a61f3 100644 (file)
--- a/src/lib/eina/eina_freeq.c
+++ b/src/lib/eina/eina_freeq.c
@@ -57,21 +57,29 @@ struct _Eina_FreeQ
 
 // ========================================================================= //
 
-static Eina_FreeQ    *_eina_freeq_main        = NULL;
-static int            _eina_freeq_bypass      = -1;
-static unsigned int   _eina_freeq_fillpat_max = ITEM_FILLPAT_MAX;
-static unsigned char  _eina_freeq_fillpat_val = 0x55;
-static int            _eina_freeq_total_max   = ITEM_TOTAL_MAX;
-static size_t         _eina_freeq_mem_max     = ITEM_MEM_MAX;
+static Eina_FreeQ    *_eina_freeq_main              = NULL;
+static int            _eina_freeq_bypass            = -1;
+static unsigned int   _eina_freeq_fillpat_max       = ITEM_FILLPAT_MAX;
+static unsigned char  _eina_freeq_fillpat_val       = 0x55;
+static unsigned char  _eina_freeq_fillpat_freed_val = 0x77;
+static int            _eina_freeq_total_max         = ITEM_TOTAL_MAX;
+static size_t         _eina_freeq_mem_max           = ITEM_MEM_MAX;
 
 // ========================================================================= //
 
-static void
+static inline void
 _eina_freeq_fill_do(void *ptr, size_t size)
 {
    if (ptr) memset(ptr, _eina_freeq_fillpat_val, size);
 }
 
+static inline void
+_eina_freeq_freed_fill_do(void *ptr, size_t size)
+{
+   if (_eina_freeq_fillpat_freed_val == 0) return;
+   if (ptr) memset(ptr, _eina_freeq_fillpat_freed_val, size);
+}
+
 static void
 _eina_freeq_fill_check(void *ptr, void (*free_func) (void *ptr), size_t size)
 {
@@ -94,7 +102,10 @@ _eina_freeq_free_do(void *ptr,
                     size_t size EINA_UNUSED)
 {
    if ((size < _eina_freeq_fillpat_max) && (size > 0))
-     _eina_freeq_fill_check(ptr, free_func, size);
+     {
+        _eina_freeq_fill_check(ptr, free_func, size);
+        _eina_freeq_freed_fill_do(ptr, size);
+     }
    free_func(ptr);
    return;
 }
@@ -172,6 +183,10 @@ eina_freeq_new(void)
         if (s) _eina_freeq_total_max = atoi(s);
         s = getenv("EINA_FREEQ_MEM_MAX");
         if (s) _eina_freeq_mem_max = atoi(s) * 1024;
+        s = getenv("EINA_FREEQ_FILL");
+        if (s) _eina_freeq_fillpat_val = atoi(s);
+        s = getenv("EINA_FREEQ_FILL_FREED");
+        if (s) _eina_freeq_fillpat_freed_val = atoi(s);
      }
    fq = calloc(1, sizeof(Eina_FreeQ));
    if (!fq) return NULL;

diff --git a/src/lib/eina/eina_freeq.h b/src/lib/eina/eina_freeq.h
index 11a0bcaf47bea8d9fc639f2d7f5caa88a0d424d1..eacd3a0ca94f14f44ae5280942ee021202cf8928 100644 (file)
--- a/src/lib/eina/eina_freeq.h
+++ b/src/lib/eina/eina_freeq.h
@@ -17,10 +17,11 @@
  *
  * For debugging and tuning you may set the following envrionment variables:
  *
- * EINA_FREEQ_BYPASS=1
+ * EINA_FREEQ_BYPASS=1/0
  *
- * Set this environment variable to immediately bypass the free queue and
- * have all items submitted free with their free function immediately.
+ * Set this environment variable to 1 to immediately bypass the free queue and
+ * have all items submitted free with their free function immediately. Set
+ * it to 0 to force the free queue to work and delay freeing of items.
  * Note that you can override this by setting count or mem max by
  * eina_freeq_count_max_set() or eina_freeq_mem_max_set() which will
  * disable bypass for that specific free queue. once bypass is disabled
@@ -31,17 +32,35 @@
  * This sets the maximum number of bytes to N an item in the free queue may
  * be in size for the free queue to fill it with debugging values like
  * 0x55 in every byte, to ensure you can see what memory has been freed
- * or not when debugging in tools like gdb.
+ * or not when debugging in tools like gdb. Note that this value is
+ * actually one greater than the actual maximum, so if this is set to 100
+ * a memory blob of 100 bytes will not be filled but one of 99 bytes in
+ * size will be.
  *
  * EINA_FREEQ_TOTAL_MAX=N
  *
  * This sets the maximum number of items allowed to N on a free queue by
- * default before it starts emptying the free queue out tomake room.
+ * default before it starts emptying the free queue out to make room.
  *
  * EINA_FREEQ_MEM_MAX=N
  *
  * This sets the maximum total number of Kb (Kilobytes) of memory allowed
  * on a free queue by default to N Kb worth of data.
+ *
+ * EINA_FREEQ_FILL=N
+ *
+ * This sets the buyte value to write to every byte of an allocation that
+ * is added to the free queue when it is added to mark the data as invalid.
+ * The default value is 0x55 (85). Memory is only filled if the size of
+ * the allocation is less than the max that you can adjust with
+ * EINA_FREEQ_FILL_MAX.
+ *
+ * EINA_FREEQ_FILL_FREED=N
+ *
+ * Memory just before it is actually passed to the free function to be freed
+ * will be filled with this pattern value in every byte. The default value
+ * is 0x77 (119). Memory is only filled if the size of the allocation is
+ * less than the max that you can adjust with EINA_FREEQ_FILL_MAX.
  * 
  * @{
  *