3#ifndef __LXC_CONTAINER_H
4#define __LXC_CONTAINER_H
12#include <lxc/attach_options.h>
18#define LXC_CLONE_KEEPNAME (1 << 0)
19#define LXC_CLONE_KEEPMACADDR (1 << 1)
20#define LXC_CLONE_SNAPSHOT (1 << 2)
21#define LXC_CLONE_KEEPBDEVTYPE (1 << 3)
22#define LXC_CLONE_MAYBE_SNAPSHOT (1 << 4)
23#define LXC_CLONE_MAXFLAGS (1 << 5)
24#define LXC_CLONE_ALLOW_RUNNING (1 << 6)
25#define LXC_CREATE_QUIET (1 << 0)
26#define LXC_CREATE_MAXFLAGS (1 << 1)
27#define LXC_MOUNT_API_V1 1
30#define LXC_IMAGE_OCI_KEY "lxc.imagetype.oci"
48struct lxc_blkio_metrics {
54struct lxc_container_metrics {
60 uint64_t pids_current;
62 uint64_t cpu_use_nanos;
63 uint64_t cpu_use_user;
66 struct lxc_blkio_metrics io_service_bytes;
67 struct lxc_blkio_metrics io_serviced;
71 uint64_t avaliable_bytes;
75 uint64_t major_page_faults;
83 uint64_t inactive_file_total;
139 struct lxc_conf *lxc_conf;
177 unsigned int start_timeout;
386 struct bdev_specs *specs,
int flags,
char *
const argv[]);
543 char** (*get_ips)(
struct lxc_container *c,
const char* interface,
const char* family,
int scope);
633 const char *lxcpath,
int flags,
const char *bdevtype,
634 const char *bdevdata, uint64_t newsize,
char **hookargs);
674 int stdinfd,
int stdoutfd,
int stderrfd,
int escape);
917 const char *target,
const char *filesystemtype,
918 unsigned long mountflags,
const void *data,
925 unsigned long mountflags,
struct lxc_mount *mnt);
954 bool (*set_container_info_file) (
struct lxc_container *c,
const char *info_file);
964 bool (*set_terminal_init_fifos)(
struct lxc_container *c,
const char *in,
const char *out,
const char *err);
974 bool (*add_terminal_fifos)(
struct lxc_container *c,
const char *in,
const char *out,
const char *err);
976 bool (*set_terminal_winch)(
struct lxc_container *c,
unsigned int height,
unsigned int width);
978 bool (*set_exec_terminal_winch)(
struct lxc_container *c,
const char *suffix,
unsigned int height,
unsigned int width);
1010 bool (*clean_container_resource) (
struct lxc_container *c, pid_t pid);
1021 bool (*get_container_pids)(
struct lxc_container *c,pid_t **pids,
size_t *pids_len);
1031 bool (*set_start_timeout)(
struct lxc_container *c,
unsigned int start_timeout);
1041 bool (*set_oci_type)(
struct lxc_container *c,
bool image_type_oci);
1051 bool (*get_container_metrics)(
struct lxc_container *c,
struct lxc_container_metrics *metrics);
1100 MIGRATE_FEATURE_CHECK,
1106#define FEATURE_MEM_TRACK (1ULL << 0)
1107#define FEATURE_LAZY_PAGES (1ULL << 1)
1119 char *pageserver_address;
1120 char *pageserver_port;
1127 bool preserves_inodes;
1132 char *action_script;
1138 bool disable_skip_in_flight;
1144 uint64_t ghost_limit;
1151 uint64_t features_to_check;
1184struct lxc_container *lxc_container_new(
const char *name,
const char *configpath);
1197struct lxc_container *lxc_container_without_config_new(
const char *name,
const char *configpath);
1233int lxc_get_wait_states(
const char **states);
1242const char *lxc_get_global_config_item(
const char *key);
1250const char *lxc_get_version(
void);
1263int list_defined_containers(
const char *lxcpath,
char ***names,
struct lxc_container ***cret);
1279int list_active_containers(
const char *lxcpath,
char ***names,
struct lxc_container ***cret);
1295int list_all_containers(
const char *lxcpath,
char ***names,
struct lxc_container ***cret);
1299 const char *lxcpath;
1311int lxc_log_init(
struct lxc_log *log);
1316void lxc_log_close(
void);
1323bool lxc_config_item_is_supported(
const char *key);
1330bool lxc_has_api_extension(
const char *extension);
Specifications for how to create a new backing store.
Definition: lxccontainer.h:1075
char * zfsroot
Definition: lxccontainer.h:1079
char * vg
Definition: lxccontainer.h:1082
char * fstype
Definition: lxccontainer.h:1076
char * dir
Definition: lxccontainer.h:1086
char * lv
Definition: lxccontainer.h:1083
char * rbdname
Definition: lxccontainer.h:1088
uint64_t fssize
Definition: lxccontainer.h:1077
char * rbdpool
Definition: lxccontainer.h:1089
char * thinpool
Definition: lxccontainer.h:1084
Definition: attach_options.h:61
Definition: lxccontainer.h:1154
Definition: lxccontainer.h:94
bool(* checkpoint)(struct lxc_container *c, char *directory, bool stop, bool verbose)
Checkpoint a container.
Definition: lxccontainer.h:846
bool(* wait)(struct lxc_container *c, const char *state, int timeout)
Wait for container to reach a particular state.
Definition: lxccontainer.h:334
bool(* createl)(struct lxc_container *c, const char *t, const char *bdevtype, struct bdev_specs *specs, int flags,...)
Create a container (list variant).
Definition: lxccontainer.h:408
bool(* load_config)(struct lxc_container *c, const char *alt_file)
Load the specified configuration for the container.
Definition: lxccontainer.h:252
bool(* snapshot_destroy_all)(struct lxc_container *c)
Destroy all the container's snapshot.
Definition: lxccontainer.h:878
int(* console_log)(struct lxc_container *c, struct lxc_console_log *log)
Query the console log of a container.
Definition: lxccontainer.h:900
int(* attach)(struct lxc_container *c, lxc_attach_exec_t exec_function, void *exec_payload, lxc_attach_options_t *options, pid_t *attached_process)
Create a sub-process attached to a container and run a function inside it.
Definition: lxccontainer.h:689
int(* attach_run_waitl)(struct lxc_container *c, lxc_attach_options_t *options, const char *program, const char *arg,...)
Run a program inside a container and wait for it to exit (list variant).
Definition: lxccontainer.h:716
bool(* add_device_node)(struct lxc_container *c, const char *src_path, const char *dest_path)
Add specified device to the container.
Definition: lxccontainer.h:800
bool(* destroy)(struct lxc_container *c)
Delete the container.
Definition: lxccontainer.h:356
bool(* want_close_all_fds)(struct lxc_container *c, bool state)
Change whether the container wishes all file descriptors to be closed on startup.
Definition: lxccontainer.h:309
void(* clear_config)(struct lxc_container *c)
Completely clear the containers in-memory configuration.
Definition: lxccontainer.h:447
char * error_string
Definition: lxccontainer.h:143
bool(* attach_interface)(struct lxc_container *c, const char *dev, const char *dst_dev)
Add specified netdev to the container.
Definition: lxccontainer.h:824
bool(* set_config_item)(struct lxc_container *c, const char *key, const char *value)
Set a key/value configuration option.
Definition: lxccontainer.h:345
bool(* rename)(struct lxc_container *c, const char *newname)
Rename a container.
Definition: lxccontainer.h:419
bool(* remove_device_node)(struct lxc_container *c, const char *src_path, const char *dest_path)
Remove specified device from the container.
Definition: lxccontainer.h:812
const char *(* state)(struct lxc_container *c)
Determine state of container.
Definition: lxccontainer.h:204
bool(* clear_config_item)(struct lxc_container *c, const char *key)
Clear a configuration item.
Definition: lxccontainer.h:459
bool(* startl)(struct lxc_container *c, int useinit,...)
Start the container (list variant).
Definition: lxccontainer.h:278
int(* umount)(struct lxc_container *c, const char *target, unsigned long mountflags, struct lxc_mount *mnt)
Unmount the container's path target.
Definition: lxccontainer.h:924
bool(* start)(struct lxc_container *c, int useinit, char *const argv[])
Start the container.
Definition: lxccontainer.h:263
bool(* reboot2)(struct lxc_container *c, int timeout)
Request the container reboot by sending it SIGINT.
Definition: lxccontainer.h:911
int(* console)(struct lxc_container *c, int ttynum, int stdinfd, int stdoutfd, int stderrfd, int escape)
Allocate and run a console tty.
Definition: lxccontainer.h:673
int(* get_cgroup_item)(struct lxc_container *c, const char *subsys, char *retv, int inlen)
Retrieve the specified cgroup subsystem value for the container.
Definition: lxccontainer.h:560
bool(* stop)(struct lxc_container *c)
Stop the container.
Definition: lxccontainer.h:287
int(* mount)(struct lxc_container *c, const char *source, const char *target, const char *filesystemtype, unsigned long mountflags, const void *data, struct lxc_mount *mnt)
Mount the host's path source onto the container's path target.
Definition: lxccontainer.h:916
char * config_path
Definition: lxccontainer.h:152
int(* get_config_item)(struct lxc_container *c, const char *key, char *retv, int inlen)
Retrieve the value of a config item.
Definition: lxccontainer.h:479
bool(* may_control)(struct lxc_container *c)
Determine if the caller may control the container.
Definition: lxccontainer.h:788
bool(* snapshot_destroy)(struct lxc_container *c, const char *snapname)
Destroy the specified snapshot.
Definition: lxccontainer.h:777
bool(* is_defined)(struct lxc_container *c)
Determine if /var/lib/lxc/$name/config exists.
Definition: lxccontainer.h:193
int(* get_keys)(struct lxc_container *c, const char *key, char *retv, int inlen)
Retrieve a list of config item keys given a key prefix.
Definition: lxccontainer.h:515
int(* attach_run_wait)(struct lxc_container *c, lxc_attach_options_t *options, const char *program, const char *const argv[])
Run a program inside a container and wait for it to exit.
Definition: lxccontainer.h:703
int(* init_pidfd)(struct lxc_container *c)
Retrieve a pidfd for the container's init process.
Definition: lxccontainer.h:943
pid_t(* init_pid)(struct lxc_container *c)
Determine process ID of the containers init process.
Definition: lxccontainer.h:241
bool(* want_daemonize)(struct lxc_container *c, bool state)
Change whether the container wants to run disconnected from the terminal.
Definition: lxccontainer.h:298
bool(* shutdown)(struct lxc_container *c, int timeout)
Request the container shutdown by sending it SIGPWR.
Definition: lxccontainer.h:440
int(* console_getfd)(struct lxc_container *c, int *ttynum, int *ptmxfd)
Allocate a console tty for the container.
Definition: lxccontainer.h:654
int(* seccomp_notify_fd)(struct lxc_container *c)
Retrieve a file descriptor for the container's seccomp filter.
Definition: lxccontainer.h:934
int(* migrate)(struct lxc_container *c, unsigned int cmd, struct migrate_opts *opts, unsigned int size)
An API call to perform various migration operations.
Definition: lxccontainer.h:890
int error_num
Definition: lxccontainer.h:146
bool daemonize
Definition: lxccontainer.h:149
bool(* is_running)(struct lxc_container *c)
Determine if container is running.
Definition: lxccontainer.h:213
int(* snapshot)(struct lxc_container *c, const char *commentfile)
Create a container snapshot.
Definition: lxccontainer.h:734
bool(* freeze)(struct lxc_container *c)
Freeze running container.
Definition: lxccontainer.h:222
int(* snapshot_list)(struct lxc_container *c, struct lxc_snapshot **snapshots)
Obtain a list of container snapshots.
Definition: lxccontainer.h:748
bool(* save_config)(struct lxc_container *c, const char *alt_file)
Save configuration to a file.
Definition: lxccontainer.h:366
bool(* detach_interface)(struct lxc_container *c, const char *dev, const char *dst_dev)
Remove specified netdev from the container.
Definition: lxccontainer.h:834
bool(* unfreeze)(struct lxc_container *c)
Thaw a frozen container.
Definition: lxccontainer.h:231
bool(* restore)(struct lxc_container *c, char *directory, bool verbose)
Restore a container from a checkpoint.
Definition: lxccontainer.h:858
bool(* reboot)(struct lxc_container *c)
Request the container reboot by sending it SIGINT.
Definition: lxccontainer.h:428
bool(* snapshot_restore)(struct lxc_container *c, const char *snapname, const char *newname)
Create a new container based on a snapshot.
Definition: lxccontainer.h:767
bool(* set_config_path)(struct lxc_container *c, const char *path)
Set the full path to the containers configuration file.
Definition: lxccontainer.h:600
bool(* create)(struct lxc_container *c, const char *t, const char *bdevtype, struct bdev_specs *specs, int flags, char *const argv[])
Create a container.
Definition: lxccontainer.h:385
bool(* destroy_with_snapshots)(struct lxc_container *c)
Delete the container and all its snapshots.
Definition: lxccontainer.h:869
bool(* set_cgroup_item)(struct lxc_container *c, const char *subsys, const char *value)
Set the specified cgroup subsystem value for the container.
Definition: lxccontainer.h:571
Definition: lxccontainer.h:1297
Definition: lxccontainer.h:43
An LXC container snapshot.
Definition: lxccontainer.h:1058
void(* free)(struct lxc_snapshot *s)
De-allocate the snapshot.
Definition: lxccontainer.h:1068
char * name
Definition: lxccontainer.h:1059
char * lxcpath
Definition: lxccontainer.h:1062
char * timestamp
Definition: lxccontainer.h:1061
char * comment_pathname
Definition: lxccontainer.h:1060
Options for the migrate API call.
Definition: lxccontainer.h:1112