rom/exec/freepooled.c

   1 /*
   2     Copyright © 1995-2011, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Free memory allocated by AllocPooled().
   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
  17 /*****************************************************************************
  18
  19     NAME */
  20
  21         AROS_LH3(void,FreePooled,
  22
  23 /*  SYNOPSIS */
  24         AROS_LHA(APTR, poolHeader,A0),
  25         AROS_LHA(APTR, memory,    A1),
  26         AROS_LHA(ULONG,memSize,   D0),
  27
  28 /* LOCATION */
  29         struct ExecBase *, SysBase, 119, Exec)
  30
  31 /*  FUNCTION
  32         Free memory allocated out of a private memory pool.
  33
  34     INPUTS
  35         poolHeader - Handle of the memory pool
  36         memory     - Pointer to the memory
  37         memSize    - Size of the memory chunk
  38
  39     RESULT
  40
  41     NOTES
  42
  43     EXAMPLE
  44
  45     BUGS
  46
  47     SEE ALSO
  48         CreatePool(), DeletePool(), AllocPooled()
  49
  50     INTERNALS
  51         In AROS memory allocated from pool remembers where it came from.
  52         Because of this poolHeader is effectively ignored and is present
  53         only for compatibility reasons. However, do not rely on this! For
  54         other operating systems of Amiga(tm) family this is not true!
  55
  56 ******************************************************************************/
  57 {
  58     AROS_LIBFUNC_INIT
  59
  60     InternalFreePooled(memory, memSize, "FreePooled", __builtin_return_address(0), CALLER_FRAME, SysBase);
  61
  62     AROS_LIBFUNC_EXIT
  63 } /* FreePooled */