5 * Copyright © 2012 Serge Hallyn <serge.hallyn@ubuntu.com>.
6 * Copyright © 2012 Canonical Ltd.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #ifndef __LXC_CONTAINER_H
24 #define __LXC_CONTAINER_H
26 #include <semaphore.h>
31 #include <lxc/attach_options.h>
37 #define LXC_CLONE_KEEPNAME (1 << 0) /*!< Do not edit the rootfs to change the hostname */
38 #define LXC_CLONE_KEEPMACADDR (1 << 1) /*!< Do not change the MAC address on network interfaces */
39 #define LXC_CLONE_SNAPSHOT (1 << 2) /*!< Snapshot the original filesystem(s) */
40 #define LXC_CLONE_KEEPBDEVTYPE (1 << 3) /*!< Use the same bdev type */
41 #define LXC_CLONE_MAYBE_SNAPSHOT (1 << 4) /*!< Snapshot only if bdev supports it, else copy */
42 #define LXC_CLONE_MAXFLAGS (1 << 5) /*!< Number of \c LXC_CLONE_* flags */
43 #define LXC_CREATE_QUIET (1 << 0) /*!< Redirect \c stdin to \c /dev/zero and \c stdout and \c stderr to \c /dev/null */
44 #define LXC_CREATE_MAXFLAGS (1 << 1) /*!< Number of \c LXC_CREATE* flags */
45 #define LXC_MOUNT_API_V1 1
55 struct lxc_console_log
;
64 * Note that changing the order of struct members is an API change, as callers
65 * will end up having the wrong offset when calling a function. So when making
66 * changes, whenever possible stick to simply appending new members.
68 struct lxc_container
{
78 * Full path to configuration file.
90 * Container semaphore lock.
92 struct lxc_lock
*slock
;
96 * Container private lock.
98 struct lxc_lock
*privlock
;
102 * Number of references to this container.
103 * \note protected by privlock.
109 * Container configuration.
111 * \internal FIXME: do we want the whole lxc_handler?
113 struct lxc_conf
*lxc_conf
;
116 /*! Human-readable string representing last error */
119 /*! Last error number */
122 /*! Whether container wishes to be daemonized */
125 /*! Full path to configuration file */
129 * \brief Determine if \c /var/lib/lxc/$name/config exists.
131 * \param c Container.
133 * \return \c true if container is defined, else \c false.
135 bool (*is_defined
)(struct lxc_container
*c
);
138 * \brief Determine state of container.
140 * \param c Container.
142 * \return Static upper-case string representing state of container.
144 * \note Returned string must not be freed.
146 const char *(*state
)(struct lxc_container
*c
);
149 * \brief Determine if container is running.
151 * \param c Container.
153 * \return \c true on success, else \c false.
155 bool (*is_running
)(struct lxc_container
*c
);
158 * \brief Freeze running container.
160 * \param c Container.
162 * \return \c true on success, else \c false.
164 bool (*freeze
)(struct lxc_container
*c
);
167 * \brief Thaw a frozen container.
169 * \param c Container.
171 * \return \c true on success, else \c false.
173 bool (*unfreeze
)(struct lxc_container
*c
);
176 * \brief Determine process ID of the containers init process.
178 * \param c Container.
180 * \return pid of init process as seen from outside the
183 pid_t (*init_pid
)(struct lxc_container
*c
);
186 * \brief Load the specified configuration for the container.
188 * \param c Container.
189 * \param alt_file Full path to alternate configuration file, or
190 * \c NULL to use the default configuration file.
192 * \return \c true on success, else \c false.
194 bool (*load_config
)(struct lxc_container
*c
, const char *alt_file
);
197 * \brief Start the container.
199 * \param c Container.
200 * \param useinit Use lxcinit rather than \c /sbin/init.
201 * \param argv Array of arguments to pass to init.
203 * \return \c true on success, else \c false.
205 bool (*start
)(struct lxc_container
*c
, int useinit
, char * const argv
[]);
208 * \brief Start the container (list variant).
210 * \param c Container.
211 * \param useinit Use lxcinit rather than \c /sbin/init.
212 * \param ... Command-line to pass to init (must end in \c NULL).
214 * \return \c true on success, else \c false.
216 * \note Identical to \ref start except that that the init
217 * arguments are specified via a list rather than an array of
220 bool (*startl
)(struct lxc_container
*c
, int useinit
, ...);
223 * \brief Stop the container.
225 * \param c Container.
227 * \return \c true on success, else \c false.
229 bool (*stop
)(struct lxc_container
*c
);
232 * \brief Change whether the container wants to run disconnected
235 * \param c Container.
236 * \param state Value for the daemonize bit (0 or 1).
238 * \return \c true on success, else \c false.
240 bool (*want_daemonize
)(struct lxc_container
*c
, bool state
);
243 * \brief Change whether the container wishes all file descriptors
244 * to be closed on startup.
246 * \param c Container.
247 * \param state Value for the close_all_fds bit (0 or 1).
249 * \return \c true on success, else \c false.
251 bool (*want_close_all_fds
)(struct lxc_container
*c
, bool state
);
254 * \brief Return current config file name.
256 * \param c Container.
258 * \return config file name, or \c NULL on error.
260 * \note The result is allocated, so the caller must free the result.
262 char *(*config_file_name
)(struct lxc_container
*c
);
265 * \brief Wait for container to reach a particular state.
267 * \param c Container.
268 * \param state State to wait for.
269 * \param timeout Timeout in seconds.
271 * \return \c true if state reached within \p timeout, else \c false.
273 * \note A \p timeout of \c -1 means wait forever. A \p timeout
274 * of \c 0 means do not wait.
276 bool (*wait
)(struct lxc_container
*c
, const char *state
, int timeout
);
279 * \brief Set a key/value configuration option.
281 * \param c Container.
282 * \param key Name of option to set.
283 * \param value Value of \p name to set.
285 * \return \c true on success, else \c false.
287 bool (*set_config_item
)(struct lxc_container
*c
, const char *key
, const char *value
);
290 * \brief Delete the container.
292 * \param c Container.
294 * \return \c true on success, else \c false.
296 * \note Container must be stopped and have no dependent snapshots.
298 bool (*destroy
)(struct lxc_container
*c
);
301 * \brief Save configuaration to a file.
303 * \param c Container.
304 * \param alt_file Full path to file to save configuration in.
306 * \return \c true on success, else \c false.
308 bool (*save_config
)(struct lxc_container
*c
, const char *alt_file
);
311 * \brief Create a container.
313 * \param c Container (with lxcpath, name and a starting
314 * configuration set).
315 * \param t Template to execute to instantiate the root
316 * filesystem and adjust the configuration.
317 * \param bdevtype Backing store type to use (if \c NULL, \c dir will be used).
318 * \param specs Additional parameters for the backing store (for
319 * example LVM volume group to use).
320 * \param flags \c LXC_CREATE_* options (currently only \ref
321 * LXC_CREATE_QUIET is supported).
322 * \param argv Arguments to pass to the template, terminated by \c NULL (if no
323 * arguments are required, just pass \c NULL).
325 * \return \c true on success, else \c false.
327 bool (*create
)(struct lxc_container
*c
, const char *t
, const char *bdevtype
,
328 struct bdev_specs
*specs
, int flags
, char *const argv
[]);
331 * \brief Create a container (list variant).
333 * \param c Container (with lxcpath, name and a starting
334 * configuration set).
335 * \param t Template to execute to instantiate the root
336 * filesystem and adjust the configuration.
337 * \param bdevtype Backing store type to use (if \c NULL, \c dir will be used).
338 * \param specs Additional parameters for the backing store (for
339 * example LVM volume group to use).
340 * \param flags \c LXC_CREATE_* options (currently only \ref
341 * LXC_CREATE_QUIET is supported).
342 * \param ... Command-line to pass to init (must end in \c NULL).
344 * \return \c true on success, else \c false.
346 * \note Identical to \ref create except that the template
347 * arguments are specified as a list rather than an array of
350 bool (*createl
)(struct lxc_container
*c
, const char *t
, const char *bdevtype
,
351 struct bdev_specs
*specs
, int flags
, ...);
354 * \brief Rename a container
356 * \param c Container.
357 * \param newname New name to be used for the container.
359 * \return \c true on success, else \c false.
361 bool (*rename
)(struct lxc_container
*c
, const char *newname
);
364 * \brief Request the container reboot by sending it \c SIGINT.
366 * \param c Container.
368 * \return \c true if reboot request successful, else \c false.
370 bool (*reboot
)(struct lxc_container
*c
);
373 * \brief Request the container shutdown by sending it \c
376 * \param c Container.
377 * \param timeout Seconds to wait before returning false.
378 * (-1 to wait forever, 0 to avoid waiting).
380 * \return \c true if the container was shutdown successfully, else \c false.
382 bool (*shutdown
)(struct lxc_container
*c
, int timeout
);
385 * \brief Completely clear the containers in-memory configuration.
387 * \param c Container.
389 void (*clear_config
)(struct lxc_container
*c
);
392 * \brief Clear a configuration item.
394 * \param c Container.
395 * \param key Name of option to clear.
397 * \return \c true on success, else \c false.
399 * \note Analog of \ref set_config_item.
401 bool (*clear_config_item
)(struct lxc_container
*c
, const char *key
);
404 * \brief Retrieve the value of a config item.
406 * \param c Container.
407 * \param key Name of option to get.
408 * \param[out] retv Caller-allocated buffer to write value of \p key
409 * into (or \c NULL to determine length of value).
410 * \param inlen Length of \p retv (may be zero).
412 * \return Length of config items value, or < 0 on error.
414 * \note The caller can (and should) determine how large a buffer to allocate for
415 * \p retv by initially passing its value as \c NULL and considering the return value.
416 * This function can then be called again passing a newly-allocated suitably-sized buffer.
417 * \note If \p retv is NULL, \p inlen is ignored.
418 * \note If \p inlen is smaller than required, nothing will be written to \p retv and still return
419 * the length of config item value.
421 int (*get_config_item
)(struct lxc_container
*c
, const char *key
, char *retv
, int inlen
);
425 * \brief Retrieve the value of a config item from running container.
427 * \param c Container.
428 * \param key Name of option to get.
430 * \return the item or NULL on error.
432 * \note Returned string must be freed by the caller.
434 char* (*get_running_config_item
)(struct lxc_container
*c
, const char *key
);
437 * \brief Retrieve a list of config item keys given a key
440 * \param c Container.
441 * \param key Name of option to get.
442 * \param[out] retv Caller-allocated buffer to write list of keys to
443 * (or \c NULL to determine overall length of keys list).
444 * \param inlen Length of \p retv (may be zero).
446 * \return Length of keys list, or < 0 on error.
448 * \note The list values written to \p retv are separated by
449 * a newline character ('\\n').
450 * \note The caller can (and should) determine how large a buffer to allocate for
451 * \p retv by initially passing its value as \c NULL and considering the return value.
452 * This function can then be called again passing a newly-allocated suitably-sized buffer.
453 * \note If \p retv is NULL, \p inlen is ignored.
454 * \note If \p inlen is smaller than required, the value written
455 * to \p retv will be truncated.
457 int (*get_keys
)(struct lxc_container
*c
, const char *key
, char *retv
, int inlen
);
460 * \brief Obtain a list of network interfaces.
461 * \param c Container.
463 * \return Newly-allocated array of network interfaces, or \c
466 * \note The returned array is allocated, so the caller must free it.
467 * \note The returned array is terminated with a \c NULL entry.
469 char** (*get_interfaces
)(struct lxc_container
*c
);
472 * \brief Determine the list of container IP addresses.
474 * \param c Container.
475 * \param interface Network interface name to consider.
476 * \param family Network family (for example "inet", "inet6").
477 * \param scope IPv6 scope id (ignored if \p family is not "inet6").
479 * \return Newly-allocated array of network interfaces, or \c
482 * \note The returned array is allocated, so the caller must free it.
483 * \note The returned array is terminated with a \c NULL entry.
485 char** (*get_ips
)(struct lxc_container
*c
, const char* interface
, const char* family
, int scope
);
488 * \brief Retrieve the specified cgroup subsystem value for the container.
490 * \param c Container.
491 * \param subsys cgroup subsystem to retrieve.
492 * \param[out] retv Caller-allocated buffer to write value of \p
493 * subsys into (or \c NULL to determine length of value).
494 * \param inlen length of \p retv (may be zero).
496 * \return Length of \p subsys value, or < 0 on error.
498 * \note If \p retv is \c NULL, \p inlen is ignored.
499 * \note If \p inlen is smaller than required, the value written
500 * to \p retv will be truncated.
502 int (*get_cgroup_item
)(struct lxc_container
*c
, const char *subsys
, char *retv
, int inlen
);
505 * \brief Set the specified cgroup subsystem value for the container.
507 * \param c Container.
508 * \param subsys cgroup subsystem to consider.
509 * \param value Value to set for \p subsys.
511 * \return \c true on success, else \c false.
513 bool (*set_cgroup_item
)(struct lxc_container
*c
, const char *subsys
, const char *value
);
516 * \brief Determine full path to the containers configuration file.
517 * Each container can have a custom configuration path. However
518 * by default it will be set to either the \c LXCPATH configure
519 * variable, or the lxcpath value in the \c LXC_GLOBAL_CONF configuration
520 * file (i.e. \c /etc/lxc/lxc.conf).
521 * The value for a specific container can be changed using
522 * \ref set_config_path. There is no other way to specify this in general at the moment.
524 * \param c Container.
526 * \return Static string representing full path to configuration
529 * \note Returned string must not be freed.
531 const char *(*get_config_path
)(struct lxc_container
*c
);
534 * \brief Set the full path to the containers configuration
537 * \param c Container.
538 * \param path Full path to configuration file.
540 * \return \c true on success, else \c false.
542 bool (*set_config_path
)(struct lxc_container
*c
, const char *path
);
545 * \brief Copy a stopped container.
547 * \param c Original container.
548 * \param newname New name for the container. If \c NULL, the same
549 * name is used and a new lxcpath MUST be specified.
550 * \param lxcpath lxcpath in which to create the new container. If
551 * \c NULL, the original container's lxcpath will be used.
552 * (XXX: should we use the default instead?)
553 * \param flags Additional \c LXC_CLONE* flags to change the cloning behaviour:
554 * - \ref LXC_CLONE_KEEPNAME
555 * - \ref LXC_CLONE_KEEPMACADDR
556 * - \ref LXC_CLONE_SNAPSHOT
557 * \param bdevtype Optionally force the cloned bdevtype to a specified plugin.
558 * By default the original is used (subject to snapshot requirements).
559 * \param bdevdata Information about how to create the new storage
560 * (i.e. fstype and fsdata).
561 * \param newsize In case of a block device backing store, an
562 * optional size. If \c 0, the original backing store's size will
563 * be used if possible. Note this only applies to the rootfs. For
564 * any other filesystems, the original size will be duplicated.
565 * \param hookargs Additional arguments to pass to the clone hook script.
567 * \return Newly-allocated copy of container \p c, or \p NULL on
570 * \note If devtype was not specified, and \p flags contains \ref
571 * LXC_CLONE_SNAPSHOT then use the native \p bdevtype if possible,
572 * else use an overlayfs.
574 struct lxc_container
*(*clone
)(struct lxc_container
*c
, const char *newname
,
575 const char *lxcpath
, int flags
, const char *bdevtype
,
576 const char *bdevdata
, uint64_t newsize
, char **hookargs
);
579 * \brief Allocate a console tty for the container.
581 * \param c Container.
582 * \param[in,out] ttynum Terminal number to attempt to allocate,
583 * or \c -1 to allocate the first available tty.
584 * \param[out] masterfd File descriptor referring to the master side of the pty.
586 * \return tty file descriptor number on success, or \c -1 on
589 * \note On successful return, \p ttynum will contain the tty number
590 * that was allocated.
591 * \note The returned file descriptor is used to keep the tty
592 * allocated. The caller should call close(2) on the returned file
593 * descriptor when no longer required so that it may be allocated
596 int (*console_getfd
)(struct lxc_container
*c
, int *ttynum
, int *masterfd
);
599 * \brief Allocate and run a console tty.
601 * \param c Container.
602 * \param ttynum Terminal number to attempt to allocate, \c -1 to
603 * allocate the first available tty or \c 0 to allocate the
605 * \param stdinfd File descriptor to read input from.
606 * \param stdoutfd File descriptor to write output to.
607 * \param stderrfd File descriptor to write error output to.
608 * \param escape The escape character (1 == 'a', 2 == 'b', ...).
610 * \return \c 0 on success, \c -1 on failure.
612 * \note This function will not return until the console has been
613 * exited by the user.
615 int (*console
)(struct lxc_container
*c
, int ttynum
,
616 int stdinfd
, int stdoutfd
, int stderrfd
, int escape
);
619 * \brief Create a sub-process attached to a container and run
620 * a function inside it.
622 * \param c Container.
623 * \param exec_function Function to run.
624 * \param exec_payload Data to pass to \p exec_function.
625 * \param options \ref lxc_attach_options_t.
626 * \param[out] attached_process Process ID of process running inside
627 * container \p c that is running \p exec_function.
629 * \return \c 0 on success, \c -1 on error.
631 int (*attach
)(struct lxc_container
*c
, lxc_attach_exec_t exec_function
,
632 void *exec_payload
, lxc_attach_options_t
*options
, pid_t
*attached_process
);
635 * \brief Run a program inside a container and wait for it to exit.
637 * \param c Container.
638 * \param options See \ref attach options.
639 * \param program Full path inside container of program to run.
640 * \param argv Array of arguments to pass to \p program.
642 * \return \c waitpid(2) status of exited process that ran \p
643 * program, or \c -1 on error.
645 int (*attach_run_wait
)(struct lxc_container
*c
, lxc_attach_options_t
*options
, const char *program
, const char * const argv
[]);
648 * \brief Run a program inside a container and wait for it to exit (list variant).
650 * \param c Container.
651 * \param options See \ref attach options.
652 * \param program Full path inside container of program to run.
653 * \param ... Command-line to pass to \p program (must end in \c NULL).
655 * \return \c waitpid(2) status of exited process that ran \p
656 * program, or \c -1 on error.
658 int (*attach_run_waitl
)(struct lxc_container
*c
, lxc_attach_options_t
*options
, const char *program
, const char *arg
, ...);
661 * \brief Create a container snapshot.
663 * Assuming default paths, snapshots will be created as
664 * \c /var/lib/lxc/\<c\>/snaps/snap\<n\>
665 * where \c \<c\> represents the container name and \c \<n\>
666 * represents the zero-based snapshot number.
668 * \param c Container.
669 * \param commentfile Full path to file containing a description
672 * \return -1 on error, or zero-based snapshot number.
674 * \note \p commentfile may be \c NULL but this is discouraged.
676 int (*snapshot
)(struct lxc_container
*c
, const char *commentfile
);
679 * \brief Obtain a list of container snapshots.
681 * \param c Container.
682 * \param[out] snapshots Dynamically-allocated Array of lxc_snapshot's.
684 * \return Number of snapshots.
686 * \note The array returned in \p snapshots is allocated, so the caller must free it.
687 * \note To free an individual snapshot as returned in \p
688 * snapshots, call the snapshots \c free function (see \c src/tests/snapshot.c for an example).
690 int (*snapshot_list
)(struct lxc_container
*c
, struct lxc_snapshot
**snapshots
);
693 * \brief Create a new container based on a snapshot.
695 * The restored container will be a copy (not snapshot) of the snapshot,
696 * and restored in the lxcpath of the original container.
697 * \param c Container.
698 * \param snapname Name of snapshot.
699 * \param newname Name to be used for the restored snapshot.
700 * \return \c true on success, else \c false.
701 * \warning If \p newname is the same as the current container
702 * name, the container will be destroyed. However, this will
703 * fail if the snapshot is overlay-based, since the snapshots
704 * will pin the original container.
705 * \note As an example, if the container exists as \c /var/lib/lxc/c1, snapname might be \c 'snap0'
706 * (representing \c /var/lib/lxc/c1/snaps/snap0). If \p newname is \p c2,
707 * then \c snap0 will be copied to \c /var/lib/lxc/c2.
709 bool (*snapshot_restore
)(struct lxc_container
*c
, const char *snapname
, const char *newname
);
712 * \brief Destroy the specified snapshot.
714 * \param c Container.
715 * \param snapname Name of snapshot.
717 * \return \c true on success, else \c false.
719 bool (*snapshot_destroy
)(struct lxc_container
*c
, const char *snapname
);
722 * \brief Determine if the caller may control the container.
724 * \param c Container.
726 * \return \c false if there is a control socket for the
727 * container monitor and the caller may not access it, otherwise
730 bool (*may_control
)(struct lxc_container
*c
);
733 * \brief Add specified device to the container.
735 * \param c Container.
736 * \param src_path Full path of the device.
737 * \param dest_path Alternate path in the container (or \p NULL
738 * to use \p src_path).
740 * \return \c true on success, else \c false.
742 bool (*add_device_node
)(struct lxc_container
*c
, const char *src_path
, const char *dest_path
);
745 * \brief Remove specified device from the container.
747 * \param c Container.
748 * \param src_path Full path of the device.
749 * \param dest_path Alternate path in the container (or \p NULL
750 * to use \p src_path).
752 * \return \c true on success, else \c false.
754 bool (*remove_device_node
)(struct lxc_container
*c
, const char *src_path
, const char *dest_path
);
756 /* Post LXC-1.0 additions */
759 * \brief Add specified netdev to the container.
761 * \param c Container.
762 * \param dev name of net device.
764 * \return \c true on success, else \c false.
766 bool (*attach_interface
)(struct lxc_container
*c
, const char *dev
, const char *dst_dev
);
769 * \brief Remove specified netdev from the container.
771 * \param c Container.
772 * \param dev name of net device.
774 * \return \c true on success, else \c false.
776 bool (*detach_interface
)(struct lxc_container
*c
, const char *dev
, const char *dst_dev
);
778 * \brief Checkpoint a container.
780 * \param c Container.
781 * \param directory The directory to dump the container to.
782 * \param stop Whether or not to stop the container after checkpointing.
783 * \param verbose Enable criu's verbose logs.
785 * \return \c true on success, else \c false.
786 * present at compile time).
788 bool (*checkpoint
)(struct lxc_container
*c
, char *directory
, bool stop
, bool verbose
);
791 * \brief Restore a container from a checkpoint.
793 * \param c Container.
794 * \param directory The directory to restore the container from.
795 * \param verbose Enable criu's verbose logs.
797 * \return \c true on success, else \c false.
800 bool (*restore
)(struct lxc_container
*c
, char *directory
, bool verbose
);
803 * \brief Delete the container and all its snapshots.
805 * \param c Container.
807 * \return \c true on success, else \c false.
809 * \note Container must be stopped.
811 bool (*destroy_with_snapshots
)(struct lxc_container
*c
);
814 * \brief Destroy all the container's snapshot.
816 * \param c Container.
818 * \return \c true on success, else \c false.
820 bool (*snapshot_destroy_all
)(struct lxc_container
*c
);
822 /* Post LXC-1.1 additions */
824 * \brief An API call to perform various migration operations
826 * \param cmd One of the MIGRATE_ contstants.
827 * \param opts A migrate_opts struct filled with relevant options.
828 * \param size The size of the migrate_opts struct, i.e. sizeof(struct migrate_opts).
830 * \return \c 0 on success, nonzero on failure.
832 int (*migrate
)(struct lxc_container
*c
, unsigned int cmd
, struct migrate_opts
*opts
, unsigned int size
);
835 * \brief Query the console log of a container.
837 * \param c Container.
838 * \param opts A lxc_console_log struct filled with relevant options.
840 * \return \c 0 on success, nonzero on failure.
842 int (*console_log
)(struct lxc_container
*c
, struct lxc_console_log
*log
);
845 * \brief Request the container reboot by sending it \c SIGINT.
847 * \param c Container.
848 * \param timeout Seconds to wait before returning false.
849 * (-1 to wait forever, 0 to avoid waiting).
851 * \return \c true if the container was rebooted successfully, else \c false.
853 bool (*reboot2
)(struct lxc_container
*c
, int timeout
);
856 * \brief Mount the host's path `source` onto the container's path `target`.
858 int (*mount
)(struct lxc_container
*c
, const char *source
,
859 const char *target
, const char *filesystemtype
,
860 unsigned long mountflags
, const void *data
,
861 struct lxc_mount
*mnt
);
864 * \brief Unmount the container's path `target`.
866 int (*umount
)(struct lxc_container
*c
, const char *target
,
867 unsigned long mountflags
, struct lxc_mount
*mnt
);
871 * \brief An LXC container snapshot.
873 struct lxc_snapshot
{
874 char *name
; /*!< Name of snapshot */
875 char *comment_pathname
; /*!< Full path to snapshots comment file (may be \c NULL) */
876 char *timestamp
; /*!< Time snapshot was created */
877 char *lxcpath
; /*!< Full path to LXCPATH for snapshot */
880 * \brief De-allocate the snapshot.
883 void (*free
)(struct lxc_snapshot
*s
);
888 * \brief Specifications for how to create a new backing store
891 char *fstype
; /*!< Filesystem type */
892 uint64_t fssize
; /*!< Filesystem size in bytes */
894 char *zfsroot
; /*!< ZFS root path */
897 char *vg
; /*!< LVM Volume Group name */
898 char *lv
; /*!< LVM Logical Volume name */
899 char *thinpool
; /*!< LVM thin pool to use, if any */
901 char *dir
; /*!< Directory path */
903 char *rbdname
; /*!< RBD image name */
904 char *rbdpool
; /*!< Ceph pool name */
909 * \brief Commands for the migrate API call.
915 MIGRATE_FEATURE_CHECK
,
919 * \brief Available feature checks.
921 #define FEATURE_MEM_TRACK (1ULL << 0)
922 #define FEATURE_LAZY_PAGES (1ULL << 1)
925 * \brief Options for the migrate API call.
927 struct migrate_opts
{
928 /* new members should be added at the end */
932 bool stop
; /* stop the container after dump? */
933 char *predump_dir
; /* relative to directory above */
934 char *pageserver_address
; /* where should memory pages be send? */
935 char *pageserver_port
;
937 /* This flag indicates whether or not the container's rootfs will have
938 * the same inodes on checkpoint and restore. In the case of e.g. zfs
939 * send or btrfs send, or an LVM snapshot, this will be true, but it
940 * won't if e.g. you rsync the filesystems between two machines.
942 bool preserves_inodes
;
944 /* Path to an executable script that will be registered as a criu
949 /* If CRIU >= 2.4 is detected the option to skip in-flight connections
950 * will be enabled by default. The flag 'disable_skip_in_flight' will
951 * unconditionally disable this feature. In-flight connections are
952 * not fully established TCP connections: SYN, SYN-ACK */
953 bool disable_skip_in_flight
;
955 /* This is the maximum file size for deleted files (which CRIU calls
956 * "ghost" files) that will be handled. 0 indicates the CRIU default,
957 * which at this time is 1MB.
959 uint64_t ghost_limit
;
961 /* Some features cannot be checked by comparing the CRIU version.
962 * Features like dirty page tracking or userfaultfd depend on
963 * the architecture/kernel/criu combination. This is a bitmask
964 * in which the desired feature checks can be encoded.
966 uint64_t features_to_check
;
969 struct lxc_console_log
{
970 /* Clear the console log. */
973 /* Retrieve the console log. */
976 /* This specifies the maximum size to read from the ringbuffer. Setting
977 * it to 0 means that the a read can be as big as the whole ringbuffer.
978 * On return callers can check how many bytes were actually read.
979 * If "read" and "clear" are set to false and a non-zero value is
980 * specified then up to "read_max" bytes of data will be discarded from
985 /* Data that was read from the ringbuffer. If "read_max" is 0 on return
992 * \brief Create a new container.
994 * \param name Name to use for container.
995 * \param configpath Full path to configuration file to use.
997 * \return Newly-allocated container, or \c NULL on error.
999 struct lxc_container
*lxc_container_new(const char *name
, const char *configpath
);
1002 * \brief Add a reference to the specified container.
1004 * \param c Container.
1006 * \return \c true on success, \c false on error.
1008 int lxc_container_get(struct lxc_container
*c
);
1011 * \brief Drop a reference to the specified container.
1013 * \param c Container.
1015 * \return \c 0 on success, \c 1 if reference was successfully dropped
1016 * and container has been freed, and \c -1 on error.
1018 * \warning If \c 1 is returned, \p c is no longer valid.
1020 int lxc_container_put(struct lxc_container
*c
);
1023 * \brief Obtain a list of all container states.
1024 * \param[out] states Caller-allocated array to hold all states (may be \c NULL).
1026 * \return Number of container states.
1028 * \note Passing \c NULL for \p states allows the caller to first
1029 * calculate how many states there are before calling the function again, the second time
1030 * providing a suitably-sized array to store the static string pointers
1032 * \note The \p states array should be freed by the caller, but not the strings the elements point to.
1034 int lxc_get_wait_states(const char **states
);
1037 * \brief Get the value for a global config key
1039 * \param key The name of the config key
1041 * \return String representing the current value for the key.
1043 const char *lxc_get_global_config_item(const char *key
);
1046 * \brief Determine version of LXC.
1047 * \return Static string representing version of LXC in use.
1049 * \note Returned string must not be freed.
1051 const char *lxc_get_version(void);
1054 * \brief Get a list of defined containers in a lxcpath.
1056 * \param lxcpath lxcpath under which to look.
1057 * \param names If not \c NULL, then a list of container names will be returned here.
1058 * \param cret If not \c NULL, then a list of lxc_containers will be returned here.
1060 * \return Number of containers found, or \c -1 on error.
1062 * \note Values returned in \p cret are sorted by container name.
1064 int list_defined_containers(const char *lxcpath
, char ***names
, struct lxc_container
***cret
);
1067 * \brief Get a list of active containers for a given lxcpath.
1069 * \param lxcpath Full \c LXCPATH path to consider.
1070 * \param[out] names Dynamically-allocated array of container names.
1071 * \param[out] cret Dynamically-allocated list of containers.
1073 * \return Number of containers found, or -1 on error.
1075 * \note Some of the containers may not be "defined".
1076 * \note Values returned in \p cret are sorted by container name.
1077 * \note \p names and \p cret may both (or either) be specified as \c NULL.
1078 * \note \p names and \p cret must be freed by the caller.
1080 int list_active_containers(const char *lxcpath
, char ***names
, struct lxc_container
***cret
);
1083 * \brief Get a complete list of all containers for a given lxcpath.
1085 * \param lxcpath Full \c LXCPATH path to consider.
1086 * \param[out] names Dynamically-allocated array of container name.
1087 * \param[out] cret Dynamically-allocated list of containers.
1089 * \return Number of containers, or -1 on error.
1091 * \note Some of the containers may not be "defined".
1092 * \note Values returned in \p cret are sorted by container name.
1093 * \note \p names and \p cret may both (or either) be specified as \c NULL.
1094 * \note \p names and \p cret must be freed by the caller.
1096 int list_all_containers(const char *lxcpath
, char ***names
, struct lxc_container
***cret
);
1100 const char *lxcpath
;
1108 *\brief Initialize the log
1110 *\param log lxc log configuration.
1112 int lxc_log_init(struct lxc_log
*log
);
1115 * \brief Close log file.
1117 void lxc_log_close(void);
1120 * \brief Check if the configuration item is supported by this LXC instance.
1122 * \param key Configuration item to check for.
1124 bool lxc_config_item_is_supported(const char *key
);
1127 * \brief Check if an API extension is supported by this LXC instance.
1129 * \param extension API extension to check for.
1131 bool lxc_has_api_extension(const char *extension
);