[PATCH] Allow MemPool late initialization

[Amos Jeffries]

The problem:

> On 24/06/11 02:43, Kinkie wrote:
>> Hi all,
>>
>> 2011/06/23 16:38:39 kid3| assertion failed: mem.cc:516: "MemPools[t]"
>>
>> at startup
>>
FQDN had memDataInit() in its component setup, which moved. The assert 
is in memCheckInit() and tests that memInit() worked properly. But if a 
pool is initialized only when its component is loaded, that check will 
fail on several conditions unrelated to the operation of memory. 
Seemingly trivial changes to component loading order is one case.

This patch allows modules to initialize/register their own pools on 
demand later in the startup process.

* shuffle MEM_DONTFREE which is an existing fixed entry that must not be 
memInitCheck()'d to the end of the MemPool type enum list.

* update memCheckInit() to stop scanning for missing pools at that marker.

* shuffle pool types which are initialized by their components after the 
marker value. Such that no false problem is reported if (a) the 
component is never initialized for that worker, or (b) the component is 
only initialized during the configuration process.

* document this layout significance in the enum list to aid future pool 
additions or moves.

* add asserts to memAllocate() and memFree() to highlight the cases of 
brokenness memCheckInit() was catching. Using assert() instead of if() 
so that optimized builds can avoid the penalty of an extra test on each 
alloc/free.



NP: so far this patch gets me past the assert Kinkie hit (and two others 
similar). Then dies in Strand.cc (2 workers, minimal config) with a 
Segmentation fault that should not exist and cannot be replicated using -N.

Can someone else verify please?

Amos
--
Please be using
  Current Stable Squid 2.7.STABLE9 or 3.1.12
  Beta testers wanted for 3.2.0.9 and 3.1.12.3
=== modified file 'src/enums.h'
--- src/enums.h	2011-03-18 11:36:50 +0000
+++ src/enums.h	2011-06-29 12:20:46 +0000
@@ -216,21 +216,23 @@
     MEM_CLIENT_INFO,
     MEM_LINK_LIST,
     MEM_DLINK_NODE,
-    MEM_DONTFREE,
     MEM_DREAD_CTRL,
     MEM_DWRITE_Q,
-    MEM_FQDNCACHE_ENTRY,
-    MEM_FWD_SERVER,
     MEM_HTTP_HDR_CC,
     MEM_HTTP_HDR_CONTENT_RANGE,
-    MEM_IPCACHE_ENTRY,
     MEM_MD5_DIGEST,
     MEM_NETDBENTRY,
     MEM_NET_DB_NAME,
     MEM_RELIST,
+    // IMPORTANT: leave this here. pools above are initialized early with memInit()
+    MEM_DONTFREE,
+    // following pools are initialized late by their component if needed (or never)
+    MEM_FQDNCACHE_ENTRY,
+    MEM_FWD_SERVER,
 #if !USE_DNSSERVERS
     MEM_IDNS_QUERY,
 #endif
+    MEM_IPCACHE_ENTRY,
     MEM_MAX
 } mem_type;
 

=== modified file 'src/mem.cc'
--- src/mem.cc	2011-06-22 12:21:39 +0000
+++ src/mem.cc	2011-06-30 12:05:54 +0000
@@ -202,6 +202,7 @@
 void *
 memAllocate(mem_type type)
 {
+    assert(MemPools[type]);
     return MemPools[type]->alloc();
 }
 
@@ -209,6 +210,7 @@
 void
 memFree(void *p, int type)
 {
+    assert(MemPools[type]);
     MemPools[type]->freeOne(p);
 }
 
@@ -503,18 +505,17 @@
 void
 memCheckInit(void)
 {
-    mem_type t;
-
-    for (t = MEM_NONE, ++t; t < MEM_MAX; ++t) {
-        if (MEM_DONTFREE == t)
-            continue;
-
+    mem_type t = MEM_NONE;
+    ++t;
+
+    do {
         /*
          * If you hit this assertion, then you forgot to add a
          * memDataInit() line for type 't'.
+         * Or placed the pool type in the wrong section of the enum list.
          */
         assert(MemPools[t]);
-    }
+    } while(++t < MEM_DONTFREE);
 }
 
 void