contrib/xz/src/xz/hardware.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 //
   3 /// \file       hardware.h
   4 /// \brief      Detection of available hardware resources
   5 //
   6 //  Author:     Lasse Collin
   7 //
   8 //  This file has been put into the public domain.
   9 //  You can do whatever you want with this file.
  10 //
  11 ///////////////////////////////////////////////////////////////////////////////
  12
  13 /// Initialize some hardware-specific variables, which are needed by other
  14 /// hardware_* functions.
  15 extern void hardware_init(void);
  16
  17
  18 /// Set custom value for maximum number of coder threads.
  19 extern void hardware_threadlimit_set(uint32_t threadlimit);
  20
  21 /// Get the maximum number of coder threads. Some additional helper threads
  22 /// are allowed on top of this).
  23 extern uint32_t hardware_threadlimit_get(void);
  24
  25
  26 /// Set the memory usage limit. There are separate limits for compression
  27 /// and decompression (the latter includes also --list), one or both can
  28 /// be set with a single call to this function. Zero indicates resetting
  29 /// the limit back to the defaults. The limit can also be set as a percentage
  30 /// of installed RAM; the percentage must be in the range [1, 100].
  31 extern void hardware_memlimit_set(uint64_t new_memlimit,
  32                 bool set_compress, bool set_decompress, bool is_percentage);
  33
  34 /// Get the current memory usage limit for compression or decompression.
  35 extern uint64_t hardware_memlimit_get(enum operation_mode mode);
  36
  37 /// Display the amount of RAM and memory usage limits and exit.
  38 extern void hardware_memlimit_show(void) lzma_attribute((__noreturn__));