src/common/runas.h

   1 #ifndef _RUNAS_H
   2 #define _RUNAS_H
   3
   4 /*
   5  * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
   6  * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   7  *
   8  * SPDX-License-Identifier: GPL-2.0-only
   9  *
  10  */
  11
  12 #include <stdint.h>
  13 #include <sys/types.h>
  14 #include <unistd.h>
  15
  16 #include <common/macros.h>
  17
  18 /*
  19  * The run-as process is launched by forking without an exec*() call. This means
  20  * that any resource allocated before the run-as worker is launched should be
  21  * cleaned-up after the fork(). This callback allows the user to perform this
  22  * clean-up.
  23  *
  24  * Note that the callback will _not_ be invoked if the LTTNG_DEBUG_NOCLONE
  25  * environment variable is set as the clean-up is not needed (and may not be
  26  * expected).
  27  *
  28  * A negative return value will cause the run-as process to exit with a non-zero
  29  * value.
  30  */
  31 typedef int (*post_fork_cleanup_cb)(void *user_data);
  32
  33 LTTNG_HIDDEN
  34 int run_as_mkdir_recursive(const char *path, mode_t mode, uid_t uid, gid_t gid);
  35 LTTNG_HIDDEN
  36 int run_as_mkdirat_recursive(int dirfd, const char *path, mode_t mode,
  37                 uid_t uid, gid_t gid);
  38 LTTNG_HIDDEN
  39 int run_as_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid);
  40 LTTNG_HIDDEN
  41 int run_as_mkdirat(int dirfd, const char *path, mode_t mode,
  42                 uid_t uid, gid_t gid);
  43 LTTNG_HIDDEN
  44 int run_as_open(const char *path, int flags, mode_t mode, uid_t uid, gid_t gid);
  45 LTTNG_HIDDEN
  46 int run_as_openat(int dirfd, const char *filename, int flags, mode_t mode,
  47                 uid_t uid, gid_t gid);
  48 LTTNG_HIDDEN
  49 int run_as_unlink(const char *path, uid_t uid, gid_t gid);
  50 LTTNG_HIDDEN
  51 int run_as_unlinkat(int dirfd, const char *filename, uid_t uid, gid_t gid);
  52 LTTNG_HIDDEN
  53 int run_as_rmdir(const char *path, uid_t uid, gid_t gid);
  54 LTTNG_HIDDEN
  55 int run_as_rmdir_recursive(const char *path, uid_t uid, gid_t gid, int flags);
  56 LTTNG_HIDDEN
  57 int run_as_rmdirat(int dirfd, const char *path, uid_t uid, gid_t gid);
  58 LTTNG_HIDDEN
  59 int run_as_rmdirat_recursive(int dirfd, const char *path, uid_t uid, gid_t gid, int flags);
  60 LTTNG_HIDDEN
  61 int run_as_rename(const char *old, const char *new, uid_t uid, gid_t gid);
  62 LTTNG_HIDDEN
  63 int run_as_renameat(int old_dirfd, const char *old,
  64                 int new_dirfd, const char *new, uid_t uid, gid_t gid);
  65 LTTNG_HIDDEN
  66 int run_as_extract_elf_symbol_offset(int fd, const char* function,
  67                 uid_t uid, gid_t gid, uint64_t *offset);
  68 LTTNG_HIDDEN
  69 int run_as_extract_sdt_probe_offsets(int fd, const char *provider_name,
  70                 const char* probe_name, uid_t uid, gid_t gid,
  71                 uint64_t **offsets, uint32_t *num_offset);
  72 LTTNG_HIDDEN
  73 int run_as_create_worker(const char *procname,
  74                 post_fork_cleanup_cb clean_up_func, void *clean_up_user_data);
  75 LTTNG_HIDDEN
  76 void run_as_destroy_worker(void);
  77
  78 #endif /* _RUNAS_H */