rom/exec/availmem.c

   1 /*
   2     Copyright © 1995-2010, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Tell how much memory is available.
   6     Lang: english
   7 */
   8
   9 #include <exec/alerts.h>
  10 #include <exec/execbase.h>
  11 #include <aros/libcall.h>
  12 #include <aros/macros.h>
  13 #include <exec/memory.h>
  14 #include <exec/memheaderext.h>
  15 #include <proto/exec.h>
  16
  17 #include "exec_intern.h"
  18 #include "memory.h"
  19 #include "mungwall.h"
  20
  21 /*****************************************************************************
  22
  23     NAME */
  24
  25         AROS_LH1(ULONG, AvailMem,
  26
  27 /*  SYNOPSIS */
  28         AROS_LHA(ULONG, attributes, D1),
  29
  30 /*  LOCATION */
  31         struct ExecBase *, SysBase, 36, Exec)
  32
  33 /*  FUNCTION
  34         Return either the total available memory or the largest available
  35         chunk of a given type of memory.
  36
  37     INPUTS
  38         attributes - The same attributes you would give to AllocMem().
  39
  40     RESULT
  41         Either the total of the available memory or the largest chunk if
  42         MEMF_LARGEST is set in the attributes.
  43
  44     NOTES
  45         Due to the nature of multitasking the returned value may already
  46         be obsolete when this function returns.
  47
  48     EXAMPLE
  49         Print the total available memory.
  50
  51         printf("Free memory: %lu bytes\n", AvailMem(0));
  52
  53         Print the size of the largest chunk of chip memory.
  54
  55         printf("Largest chipmem chunk: %lu bytes\n",
  56                AvailMem(MEMF_CHIP|MEMF_LARGEST));
  57
  58     BUGS
  59
  60     SEE ALSO
  61
  62     INTERNALS
  63
  64 ******************************************************************************/
  65 {
  66     AROS_LIBFUNC_INIT
  67
  68     ULONG ret;
  69
  70     ret = nommu_AvailMem(attributes, SysBase);
  71
  72     if (attributes & MEMF_CLEAR)
  73         MungWall_Scan(NULL, SysBase);
  74
  75     return ret;
  76     AROS_LIBFUNC_EXIT
  77 } /* AvailMem */
  78