lib/dpkg/meminfo.h

   1 /*
   2  * libdpkg - Debian packaging suite library routines
   3  * meminfo.h - system memory information functions
   4  *
   5  * Copyright © 2022 Guillem Jover <guillem@debian.org>
   6  *
   7  * This is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  */
  20
  21 #ifndef LIBDPKG_MEMINFO_H
  22 #define LIBDPKG_MEMINFO_H
  23
  24 #include <stdint.h>
  25
  26 #include <dpkg/macros.h>
  27
  28 DPKG_BEGIN_DECLS
  29
  30 /**
  31  * @defgroup meminfo Memory information handling
  32  * @ingroup dpkg-internal
  33  * @{
  34  */
  35
  36 enum meminfo_error_code {
  37         MEMINFO_OK = 0,
  38         MEMINFO_NO_FILE = -1,
  39         MEMINFO_NO_DATA = -2,
  40         MEMINFO_INT_NEG = -3,
  41         MEMINFO_INT_MAX = -4,
  42         MEMINFO_NO_UNIT = -5,
  43         MEMINFO_NO_INFO = -6,
  44 };
  45
  46 enum meminfo_error_code
  47 meminfo_get_available_from_file(const char *filename, uint64_t *val);
  48 enum meminfo_error_code
  49 meminfo_get_available(uint64_t *val);
  50
  51 /** @} */
  52
  53 DPKG_END_DECLS
  54
  55 #endif /* LIBDPKG_MEMINFO_H */