step-prep: on debian/ubuntu machines, attempt "apt-get -y install"

[systemtap.git] / privilege.h

#ifndef PRIVILEGE_H
#define PRIVILEGE_H

typedef enum privilege_t {
  // NOTE:
  //   - Values must be a power of 2 between 0x1 and 0x80000000 inclusive, since they will be used
  //     to form a bit set.
  //   - These values cannot change in the future because they will be encoded into the generated
  //     modules in order to identify their required privilege level now and in the future.
  pr_none    = 0x00000000,  // No privileges
  pr_unknown = 0x00000001,  // Unknown privileges
  pr_stapusr = 0x00000002,  // Member of stapusr
  pr_stapsys = 0x00000004,  // Member of stapsys
  pr_stapdev = 0x00000008,  // Member of stapdev

  // Predefined sets
  pr_highest = pr_stapdev,
  pr_unprivileged = pr_stapusr,
  pr_privileged = pr_stapsys | pr_stapdev,
  pr_all = pr_stapusr | pr_stapsys | pr_stapdev
} privilege_t;

// Name of the section in the module used to store privilege information.
#define STAP_PRIVILEGE_SECTION ".stap_privilege"

// Privilege management.
#if defined(c_plusplus) || defined(__cplusplus)
extern "C" {
#endif
const char *pr_name (privilege_t p);
int pr_contains (privilege_t actual, privilege_t required);
privilege_t get_privilege_credentials (void);
#if defined(c_plusplus) || defined(__cplusplus)
}
#endif

#endif // PRIVILEGE_H