#ifndef __LXC_CONTAINER_H
#define __LXC_CONTAINER_H
+
#include <malloc.h>
#include <semaphore.h>
#include <stdbool.h>
-#include <stdlib.h>
#include <stdint.h>
+#include <stdlib.h>
#include <lxc/attach_options.h>
#define LXC_CLONE_MAXFLAGS (1 << 5) /*!< Number of \c LXC_CLONE_* flags */
#define LXC_CREATE_QUIET (1 << 0) /*!< Redirect \c stdin to \c /dev/zero and \c stdout and \c stderr to \c /dev/null */
#define LXC_CREATE_MAXFLAGS (1 << 1) /*!< Number of \c LXC_CREATE* flags */
+#define LXC_MOUNT_API_V1 1
struct bdev_specs;
struct migrate_opts;
+struct lxc_console_log;
+
+struct lxc_mount {
+ int version;
+};
+
/*!
* An LXC container.
*
* changes, whenever possible stick to simply appending new members.
*/
struct lxc_container {
- // private fields
+ /* private fields */
/*!
* \private
* Name of container.
*/
struct lxc_conf *lxc_conf;
- // public fields
+ /* public fields */
/*! Human-readable string representing last error */
char *error_string;
bool (*destroy)(struct lxc_container *c);
/*!
- * \brief Save configuaration to a file.
+ * \brief Save configuration to a file.
*
* \param c Container.
* \param alt_file Full path to file to save configuration in.
* \p retv by initially passing its value as \c NULL and considering the return value.
* This function can then be called again passing a newly-allocated suitably-sized buffer.
* \note If \p retv is NULL, \p inlen is ignored.
- * \note If \p inlen is smaller than required, the value written
- * to \p retv will be truncated.
+ * \note If \p inlen is smaller than required, nothing will be written to \p retv and still return
+ * the length of config item value.
*/
int (*get_config_item)(struct lxc_container *c, const char *key, char *retv, int inlen);
/*!
* \brief An API call to perform various migration operations
*
- * \param cmd One of the MIGRATE_ contstants.
+ * \param cmd One of the MIGRATE_ constants.
* \param opts A migrate_opts struct filled with relevant options.
* \param size The size of the migrate_opts struct, i.e. sizeof(struct migrate_opts).
*
* \return \c 0 on success, nonzero on failure.
*/
int (*migrate)(struct lxc_container *c, unsigned int cmd, struct migrate_opts *opts, unsigned int size);
+
+ /*!
+ * \brief Query the console log of a container.
+ *
+ * \param c Container.
+ * \param opts A lxc_console_log struct filled with relevant options.
+ *
+ * \return \c 0 on success, nonzero on failure.
+ */
+ int (*console_log)(struct lxc_container *c, struct lxc_console_log *log);
+
+ /*!
+ * \brief Request the container reboot by sending it \c SIGINT.
+ *
+ * \param c Container.
+ * \param timeout Seconds to wait before returning false.
+ * (-1 to wait forever, 0 to avoid waiting).
+ *
+ * \return \c true if the container was rebooted successfully, else \c false.
+ */
+ bool (*reboot2)(struct lxc_container *c, int timeout);
+
+ /*!
+ * \brief Mount the host's path `source` onto the container's path `target`.
+ */
+ 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);
+
+ /*!
+ * \brief Unmount the container's path `target`.
+ */
+ int (*umount)(struct lxc_container *c, const char *target,
+ unsigned long mountflags, struct lxc_mount *mnt);
};
/*!
MIGRATE_PRE_DUMP,
MIGRATE_DUMP,
MIGRATE_RESTORE,
+ MIGRATE_FEATURE_CHECK,
};
+/*!
+ * \brief Available feature checks.
+ */
+#define FEATURE_MEM_TRACK (1ULL << 0)
+#define FEATURE_LAZY_PAGES (1ULL << 1)
+
/*!
* \brief Options for the migrate API call.
*/
* unconditionally disable this feature. In-flight connections are
* not fully established TCP connections: SYN, SYN-ACK */
bool disable_skip_in_flight;
+
+ /* This is the maximum file size for deleted files (which CRIU calls
+ * "ghost" files) that will be handled. 0 indicates the CRIU default,
+ * which at this time is 1MB.
+ */
+ uint64_t ghost_limit;
+
+ /* Some features cannot be checked by comparing the CRIU version.
+ * Features like dirty page tracking or userfaultfd depend on
+ * the architecture/kernel/criu combination. This is a bitmask
+ * in which the desired feature checks can be encoded.
+ */
+ uint64_t features_to_check;
+};
+
+struct lxc_console_log {
+ /* Clear the console log. */
+ bool clear;
+
+ /* Retrieve the console log. */
+ bool read;
+
+ /* This specifies the maximum size to read from the ringbuffer. Setting
+ * it to 0 means that the a read can be as big as the whole ringbuffer.
+ * On return callers can check how many bytes were actually read.
+ * If "read" and "clear" are set to false and a non-zero value is
+ * specified then up to "read_max" bytes of data will be discarded from
+ * the ringbuffer.
+ */
+ uint64_t *read_max;
+
+ /* Data that was read from the ringbuffer. If "read_max" is 0 on return
+ * "data" is invalid.
+ */
+ char *data;
};
/*!
*/
int list_all_containers(const char *lxcpath, char ***names, struct lxc_container ***cret);
+struct lxc_log {
+ const char *name;
+ const char *lxcpath;
+ const char *file;
+ const char *level;
+ const char *prefix;
+ bool quiet;
+};
+
+/*!
+ *\brief Initialize the log
+ *
+ *\param log lxc log configuration.
+ */
+int lxc_log_init(struct lxc_log *log);
+
/*!
* \brief Close log file.
*/
void lxc_log_close(void);
+/*!
+ * \brief Check if the configuration item is supported by this LXC instance.
+ *
+ * \param key Configuration item to check for.
+ */
+bool lxc_config_item_is_supported(const char *key);
+
+/*!
+ * \brief Check if an API extension is supported by this LXC instance.
+ *
+ * \param extension API extension to check for.
+ */
+bool lxc_has_api_extension(const char *extension);
+
#ifdef __cplusplus
}
#endif
projects / mirror_lxc.git / blobdiff