src/lxc/commands.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2
   3 #ifndef __LXC_COMMANDS_H
   4 #define __LXC_COMMANDS_H
   5
   6 #include <stdio.h>
   7 #include <sys/types.h>
   8 #include <unistd.h>
   9
  10 #include "compiler.h"
  11 #include "lxccontainer.h"
  12 #include "macro.h"
  13 #include "state.h"
  14
  15 /*
  16  * Value command callbacks should return when they want the client fd to be
  17  * cleaned up by the main loop. This is most certainly what you want unless you
  18  * have specific reasons to keep the file descriptor alive.
  19  */
  20 #define LXC_CMD_REAP_CLIENT_FD 1
  21
  22 typedef enum {
  23         LXC_CMD_CONSOLE,
  24         LXC_CMD_TERMINAL_WINCH,
  25         LXC_CMD_STOP,
  26         LXC_CMD_GET_STATE,
  27         LXC_CMD_GET_INIT_PID,
  28         LXC_CMD_GET_CLONE_FLAGS,
  29         LXC_CMD_GET_CGROUP,
  30         LXC_CMD_GET_CONFIG_ITEM,
  31         LXC_CMD_GET_NAME,
  32         LXC_CMD_GET_LXCPATH,
  33         LXC_CMD_ADD_STATE_CLIENT,
  34         LXC_CMD_CONSOLE_LOG,
  35         LXC_CMD_SERVE_STATE_CLIENTS,
  36         LXC_CMD_SECCOMP_NOTIFY_ADD_LISTENER,
  37         LXC_CMD_ADD_BPF_DEVICE_CGROUP,
  38         LXC_CMD_FREEZE,
  39         LXC_CMD_UNFREEZE,
  40         LXC_CMD_GET_CGROUP2_FD,
  41         LXC_CMD_GET_INIT_PIDFD,
  42         LXC_CMD_GET_LIMITING_CGROUP,
  43         LXC_CMD_GET_LIMITING_CGROUP2_FD,
  44         LXC_CMD_GET_DEVPTS_FD,
  45         LXC_CMD_GET_SECCOMP_NOTIFY_FD,
  46         LXC_CMD_MAX,
  47 } lxc_cmd_t;
  48
  49 struct lxc_cmd_req {
  50         lxc_cmd_t cmd;
  51         int datalen;
  52         const void *data;
  53 };
  54
  55 struct lxc_cmd_rsp {
  56         int ret; /* 0 on success, -errno on failure */
  57         int datalen;
  58         void *data;
  59 };
  60
  61 struct lxc_cmd_rr {
  62         struct lxc_cmd_req req;
  63         struct lxc_cmd_rsp rsp;
  64 };
  65
  66 struct lxc_cmd_console_rsp_data {
  67         int ptxfd;
  68         int ttynum;
  69 };
  70
  71 struct lxc_cmd_console_log {
  72         bool clear;
  73         bool read;
  74         uint64_t read_max;
  75         bool write_logfile;
  76
  77 };
  78
  79 __hidden extern int lxc_cmd_terminal_winch(const char *name, const char *lxcpath);
  80 __hidden extern int lxc_cmd_console(const char *name, int *ttynum, int *fd, const char *lxcpath);
  81 /*
  82  * Get the 'real' cgroup path (as seen in /proc/self/cgroup) for a container
  83  * for a particular subsystem
  84  */
  85 __hidden extern char *lxc_cmd_get_cgroup_path(const char *name, const char *lxcpath,
  86                                               const char *subsystem);
  87 __hidden extern int lxc_cmd_get_clone_flags(const char *name, const char *lxcpath);
  88 __hidden extern char *lxc_cmd_get_config_item(const char *name, const char *item,
  89                                               const char *lxcpath);
  90 __hidden extern char *lxc_cmd_get_name(const char *hashed_sock);
  91 __hidden extern char *lxc_cmd_get_lxcpath(const char *hashed_sock);
  92 __hidden extern pid_t lxc_cmd_get_init_pid(const char *name, const char *lxcpath);
  93 __hidden extern int lxc_cmd_get_init_pidfd(const char *name, const char *lxcpath);
  94 __hidden extern int lxc_cmd_get_state(const char *name, const char *lxcpath);
  95 __hidden extern int lxc_cmd_stop(const char *name, const char *lxcpath);
  96
  97 /* lxc_cmd_add_state_client    Register a new state client fd in the container's
  98  *                             in-memory handler.
  99  *
 100  * @param[in] name             Name of container to connect to.
 101  * @param[in] lxcpath          The lxcpath in which the container is running.
 102  * @param[in] states           The states to wait for.
 103  * @param[out] state_client_fd The state client fd from which the state can be
 104  *                             received.
 105  * @return                     Return  < 0 on error
 106  *                                    == MAX_STATE when state needs to retrieved
 107  *                                                 via socket fd
 108  *                                     < MAX_STATE current container state
 109  */
 110 __hidden extern int lxc_cmd_add_state_client(const char *name, const char *lxcpath,
 111                                              lxc_state_t states[MAX_STATE], int *state_client_fd);
 112 __hidden extern int lxc_cmd_serve_state_clients(const char *name, const char *lxcpath,
 113                                                 lxc_state_t state);
 114
 115 struct lxc_epoll_descr;
 116 struct lxc_handler;
 117
 118 __hidden extern int lxc_cmd_init(const char *name, const char *lxcpath, const char *suffix);
 119 __hidden extern int lxc_cmd_mainloop_add(const char *name, struct lxc_epoll_descr *descr,
 120                                          struct lxc_handler *handler);
 121 __hidden extern int lxc_try_cmd(const char *name, const char *lxcpath);
 122 __hidden extern int lxc_cmd_console_log(const char *name, const char *lxcpath,
 123                                         struct lxc_console_log *log);
 124 __hidden extern int lxc_cmd_get_seccomp_notify_fd(const char *name, const char *lxcpath);
 125 __hidden extern int lxc_cmd_seccomp_notify_add_listener(const char *name, const char *lxcpath, int fd,
 126                                                         /* unused */ unsigned int command,
 127                                                         /* unused */ unsigned int flags);
 128
 129 struct device_item;
 130 __hidden extern int lxc_cmd_add_bpf_device_cgroup(const char *name, const char *lxcpath,
 131                                                   struct device_item *device);
 132 __hidden extern int lxc_cmd_freeze(const char *name, const char *lxcpath, int timeout);
 133 __hidden extern int lxc_cmd_unfreeze(const char *name, const char *lxcpath, int timeout);
 134 __hidden extern int lxc_cmd_get_cgroup2_fd(const char *name, const char *lxcpath);
 135 __hidden extern char *lxc_cmd_get_limiting_cgroup_path(const char *name, const char *lxcpath,
 136                                                        const char *subsystem);
 137 __hidden extern int lxc_cmd_get_limiting_cgroup2_fd(const char *name, const char *lxcpath);
 138 __hidden extern int lxc_cmd_get_devpts_fd(const char *name, const char *lxcpath);
 139
 140 #endif /* __commands_h */