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 custom memory usage limit. This is used for both encoding and
  27 /// decoding. Zero indicates resetting the limit back to defaults.
  28 extern void hardware_memlimit_set(uint64_t memlimit);
  29
  30 /// Get the memory usage limit for encoding. By default this is 90 % of RAM.
  31 extern uint64_t hardware_memlimit_encoder(void);
  32
  33
  34 /// Get the memory usage limit for decoding. By default this is 30 % of RAM.
  35 extern uint64_t hardware_memlimit_decoder(void);