rom/exec/deletepool.c

   1 /*
   2     Copyright © 1995-2011, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Delete a memory pool including all its memory.
   6     Lang: english
   7 */
   8
   9 #include <aros/libcall.h>
  10 #include <exec/memory.h>
  11 #include <proto/exec.h>
  12
  13 #include "exec_intern.h"
  14 #include "exec_util.h"
  15 #include "memory.h"
  16 #include "mungwall.h"
  17
  18 /*****************************************************************************
  19
  20     NAME */
  21
  22         AROS_LH1(void, DeletePool,
  23
  24 /*  SYNOPSIS */
  25         AROS_LHA(APTR, poolHeader, A0),
  26
  27 /*  LOCATION */
  28         struct ExecBase *, SysBase, 117, Exec)
  29
  30 /*  FUNCTION
  31         Delete a pool including all it's memory.
  32
  33     INPUTS
  34         poolHeader - The pool allocated with CreatePool() or NULL.
  35
  36     RESULT
  37
  38     NOTES
  39
  40     EXAMPLE
  41
  42     BUGS
  43
  44     SEE ALSO
  45         CreatePool(), AllocPooled(), FreePooled()
  46
  47     INTERNALS
  48
  49 ******************************************************************************/
  50 {
  51     AROS_LIBFUNC_INIT
  52
  53     ASSERT_VALID_PTR_OR_NULL(poolHeader);
  54
  55     D(bug("[exec] DeletePool(0x%p)\n", poolHeader));
  56
  57     /* It is legal to DeletePool(NULL) */
  58     if (poolHeader != NULL)
  59     {
  60         struct Pool *pool = poolHeader + MEMHEADER_TOTAL;
  61         struct Node *p, *p2; /* Avoid casts */
  62
  63         D(bug("[DeletePool] Pool header 0x%p\n", pool));
  64
  65         /*
  66          * We are going to deallocate the whole pool.
  67          * Scan mungwall's allocations list and remove all chunks
  68          * belonging to the pool.
  69          * For mungwall we provide also called function name, return address and caller's stack frame.
  70          * This will be displayed in alerts.
  71          */
  72         MungWall_Scan(pool, "DeletePool", __builtin_return_address(0), CALLER_FRAME, SysBase);
  73
  74         /*
  75          * Free the list of puddles.
  76          * Remember that initial puddle containing the pool structure is also in this list.
  77          * We do not need to free it until everything else is freed.
  78          */
  79         for (p = (struct Node *)pool->PuddleList.mlh_Head; p->ln_Succ; p = p2)
  80         {
  81             p2 = p->ln_Succ;
  82
  83             D(bug("[DeletePool] Puddle 0x%p...", p));
  84
  85             if (p != poolHeader)
  86             {
  87                 D(bug(" freeing"));
  88                 FreeMemHeader(p, SysBase);
  89             }
  90             D(bug("\n"));
  91         }
  92
  93         /* Free the last puddle, containing the pool header */
  94         D(bug("[DeletePool] Freeing initial puddle 0x%p\n", poolHeader));
  95         FreeMemHeader(poolHeader, SysBase);
  96     }
  97
  98     AROS_LIBFUNC_EXIT
  99 } /* DeletePool */