procps/free.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Mini free implementation for busybox
   4  *
   5  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
   6  *
   7  * Licensed under GPLv2, see file LICENSE in this source tree.
   8  */
   9 //config:config FREE
  10 //config:       bool "free (2.4 kb)"
  11 //config:       default y
  12 //config:       select PLATFORM_LINUX #sysinfo()
  13 //config:       help
  14 //config:       free displays the total amount of free and used physical and swap
  15 //config:       memory in the system, as well as the buffers used by the kernel.
  16 //config:       The shared memory column should be ignored; it is obsolete.
  17
  18 //applet:IF_FREE(APPLET_NOEXEC(free, free, BB_DIR_USR_BIN, BB_SUID_DROP, free))
  19
  20 //kbuild:lib-$(CONFIG_FREE) += free.o
  21
  22 //usage:#define free_trivial_usage
  23 //usage:       "" IF_DESKTOP("[-b/k/m/g]")
  24 //usage:#define free_full_usage "\n\n"
  25 //usage:       "Display the amount of free and used system memory"
  26 //usage:
  27 //usage:#define free_example_usage
  28 //usage:       "$ free\n"
  29 //usage:       "              total         used         free       shared      buffers\n"
  30 //usage:       "  Mem:       257628       248724         8904        59644        93124\n"
  31 //usage:       " Swap:       128516         8404       120112\n"
  32 //usage:       "Total:       386144       257128       129016\n"
  33
  34 #include "libbb.h"
  35 #include "common_bufsiz.h"
  36 #ifdef __linux__
  37 # include <sys/sysinfo.h>
  38 #endif
  39
  40 struct globals {
  41         unsigned mem_unit;
  42 #if ENABLE_DESKTOP
  43         unsigned unit_steps;
  44 # define G_unit_steps G.unit_steps
  45 #else
  46 # define G_unit_steps 10
  47 #endif
  48 } FIX_ALIASING;
  49 #define G (*(struct globals*)bb_common_bufsiz1)
  50 #define INIT_G() do { \
  51         setup_common_bufsiz(); \
  52         /* NB: noexec applet - globals not zeroed */ \
  53 } while (0)
  54
  55
  56 static unsigned long long scale(unsigned long d)
  57 {
  58         return ((unsigned long long)d * G.mem_unit) >> G_unit_steps;
  59 }
  60
  61 static unsigned long parse_cached_kb(void)
  62 {
  63         char buf[60]; /* actual lines we expect are ~30 chars or less */
  64         FILE *fp;
  65         unsigned long cached = 0;
  66
  67         fp = xfopen_for_read("/proc/meminfo");
  68         while (fgets(buf, sizeof(buf), fp) != NULL) {
  69                 if (sscanf(buf, "Cached: %lu %*s\n", &cached) == 1)
  70                         break;
  71         }
  72         if (ENABLE_FEATURE_CLEAN_UP)
  73                 fclose(fp);
  74
  75         return cached;
  76 }
  77
  78 int free_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
  79 int free_main(int argc UNUSED_PARAM, char **argv IF_NOT_DESKTOP(UNUSED_PARAM))
  80 {
  81         struct sysinfo info;
  82         unsigned long long cached;
  83
  84         INIT_G();
  85
  86 #if ENABLE_DESKTOP
  87         G.unit_steps = 10;
  88         if (argv[1] && argv[1][0] == '-') {
  89                 switch (argv[1][1]) {
  90                 case 'b':
  91                         G.unit_steps = 0;
  92                         break;
  93                 case 'k': /* 2^10 */
  94                         /* G.unit_steps = 10; - already is */
  95                         break;
  96                 case 'm': /* 2^(2*10) */
  97                         G.unit_steps = 20;
  98                         break;
  99                 case 'g': /* 2^(3*10) */
 100                         G.unit_steps = 30;
 101                         break;
 102                 default:
 103                         bb_show_usage();
 104                 }
 105         }
 106 #endif
 107         printf("       %11s%11s%11s%11s%11s%11s\n"
 108         "Mem:   ",
 109                 "total",
 110                 "used",
 111                 "free",
 112                 "shared", "buffers", "cached" /* swap and total don't have these columns */
 113         );
 114
 115         sysinfo(&info);
 116         /* Kernels prior to 2.4.x will return info.mem_unit==0, so cope... */
 117         G.mem_unit = (info.mem_unit ? info.mem_unit : 1);
 118         /* Extract cached from /proc/meminfo and convert to mem_units */
 119         cached = ((unsigned long long) parse_cached_kb() * 1024) / G.mem_unit;
 120
 121 #define FIELDS_6 "%11llu%11llu%11llu%11llu%11llu%11llu\n"
 122 #define FIELDS_3 (FIELDS_6 + 3*6)
 123 #define FIELDS_2 (FIELDS_6 + 4*6)
 124
 125         printf(FIELDS_6,
 126                 scale(info.totalram),                //total
 127                 scale(info.totalram - info.freeram), //used
 128                 scale(info.freeram),                 //free
 129                 scale(info.sharedram),               //shared
 130                 scale(info.bufferram),               //buffers
 131                 scale(cached)                        //cached
 132         );
 133         /* Show alternate, more meaningful busy/free numbers by counting
 134          * buffer cache as free memory. */
 135         printf("-/+ buffers/cache:");
 136         cached += info.freeram;
 137         cached += info.bufferram;
 138         printf(FIELDS_2,
 139                 scale(info.totalram - cached), //used
 140                 scale(cached)                  //free
 141         );
 142 #if BB_MMU
 143         printf("Swap:  ");
 144         printf(FIELDS_3,
 145                 scale(info.totalswap),                 //total
 146                 scale(info.totalswap - info.freeswap), //used
 147                 scale(info.freeswap)                   //free
 148         );
 149 #endif
 150         return EXIT_SUCCESS;
 151 }