src/common/runas.hpp

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