jack/systemtest.h

   1 #ifndef __jack_systemtest_h__
   2 #define __jack_systemtest_h__
   3
   4 /**
   5  * GPL, yabbadabba
   6  *
   7  * Set of functions to gather system information for the jack setup wizard.
   8  *
   9  * @author Florian Faber, faber@faberman.de
  10  *
  11  * @version 0.1 (2009-01-15) [FF]
  12  *              - initial version
  13  *
  14  **/
  15
  16
  17 /**
  18  * This function checks for the existence of known frequency scaling mechanisms
  19  * in this system.
  20  *
  21  * @returns 0 if the system has no frequency scaling capabilities non-0 otherwise.
  22  **/
  23 int system_has_frequencyscaling();
  24
  25
  26 /**
  27  * This function determines wether the CPU has a variable clock speed if frequency
  28  * scaling is available.
  29  *
  30  * @returns 0 if system doesn't use frequency scaling at the moment, non-0 otherwise
  31  **/
  32 int system_uses_frequencyscaling();
  33
  34
  35 /***
  36  * Checks for a definition in /etc/security/limits.conf that looks
  37  * as if it allows RT scheduling priority.
  38  *
  39  * @returns 1 if there appears to be such a line
  40  **/
  41 int system_has_rtprio_limits_conf ();
  42
  43 /**
  44  * Checks for the existence of the 'audio' group on this system
  45  *
  46  * @returns 0 is there is no 'audio' group, non-0 otherwise
  47  **/
  48 int system_has_audiogroup();
  49
  50
  51 /**
  52  * Tests wether the owner of this process is in the 'audio' group.
  53  *
  54  * @returns 0 if the owner of this process is not in the audio group, non-0 otherwise
  55  **/
  56 int system_user_in_audiogroup();
  57
  58
  59 /**
  60  * Determines wether the owner of this process can enable rt priority.
  61  *
  62  * @returns 0 if this process can not be switched to rt prio, non-0 otherwise
  63  **/
  64 int system_user_can_rtprio();
  65
  66
  67 long long unsigned int system_memlock_amount();
  68
  69
  70 /**
  71  * Checks wether the memlock limit is unlimited
  72  *
  73  * @returns 0 if the memlock limit is limited, non-0 otherwise
  74  **/
  75 int system_memlock_is_unlimited();
  76
  77
  78 long long unsigned int system_available_physical_mem();
  79
  80
  81 /**
  82  * Gets the version of the currently running kernel
  83  *
  84  * @returns String with the full version of the kernel
  85  **/
  86 char* system_kernel_version();
  87
  88
  89 /**
  90  * Returns the username. The caller is in charge of disposal of
  91  * the returned name.
  92  *
  93  * @returns Pointer to a username or NULL
  94  **/
  95 char* system_get_username();
  96
  97 #endif /* __jack_systemtest_h__ */