2 * lxc: linux Container library
4 * (C) Copyright IBM Corp. 2007, 2008
7 * Daniel Lezcano <daniel.lezcano at free.fr>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30 #include <netinet/in.h>
31 #include <sys/param.h>
32 #include <sys/types.h>
33 #if HAVE_SYS_RESOURCE_H
34 #include <sys/resource.h>
40 #include "start.h" /* for lxc_handler */
42 #if HAVE_SCMP_FILTER_CTX
43 typedef void * scmp_filter_ctx
;
46 /* worth moving to configure.ac? */
47 #define subuidfile "/etc/subuid"
48 #define subgidfile "/etc/subgid"
51 * Defines a generic struct to configure the control group. It is up to the
52 * programmer to specify the right subsystem.
53 * @subsystem : the targeted subsystem
54 * @value : the value to set
56 * @controllers : The controllers to use for this container.
57 * @dir : The name of the directory containing the container's cgroup.
58 * Not that this is a per-container setting.
62 /* information about a specific controller */
63 struct /* controller */ {
68 /* meta information about cgroup configuration */
76 #if !HAVE_SYS_RESOURCE_H
77 # define RLIM_INFINITY ((unsigned long)-1)
79 unsigned long rlim_cur
;
80 unsigned long rlim_max
;
84 * Defines a structure to configure resource limits to set via setrlimit().
85 * @resource : the resource name in lowercase without the RLIMIT_ prefix
86 * @limit : the limit to set
99 * Defines a structure to configure kernel parameters at runtime.
100 * @key : the kernel parameters will be configured without the "lxc.sysctl" prefix
101 * @value : the value to set
109 * Defines a structure to configure proc filesystem at runtime.
110 * @filename : the proc filesystem will be configured without the "lxc.proc" prefix
111 * @value : the value to set
119 * id_map is an id map entry. Form in confile is:
120 * lxc.idmap = u 0 9800 100
121 * lxc.idmap = u 1000 9900 100
122 * lxc.idmap = g 0 9800 100
123 * lxc.idmap = g 1000 9900 100
124 * meaning the container can use uids and gids 0-99 and 1000-1099,
125 * with [ug]id 0 mapping to [ug]id 9800 on the host, and [ug]id 1000 to
126 * [ug]id 9900 on the host.
130 unsigned long hostid
, nsid
, range
;
134 * Defines a structure containing a pty information for
136 * @name : the path name of the slave pty side
137 * @master : the file descriptor of the master
138 * @slave : the file descriptor of the slave
140 struct lxc_pty_info
{
141 char name
[MAXPATHLEN
];
148 * Defines the number of tty configured and contains the
150 * @nbtty = number of configured ttys
152 struct lxc_tty_info
{
154 struct lxc_pty_info
*pty_info
;
157 struct lxc_tty_state
;
160 * Defines the structure to store the console information
161 * @peer : the file descriptor put/get console traffic
162 * @name : the file name of the slave pty
168 struct lxc_pty_info peerpty
;
169 struct lxc_epoll_descr
*descr
;
173 unsigned int log_rotate
;
174 char name
[MAXPATHLEN
];
175 struct termios
*tios
;
176 struct lxc_tty_state
*tty_state
;
178 /* size of the ringbuffer */
179 uint64_t buffer_size
;
181 /* path to the log file for the ringbuffer */
182 char *buffer_log_file
;
184 /* fd to the log file for the ringbuffer */
185 int buffer_log_file_fd
;
187 /* the in-memory ringbuffer */
188 struct lxc_ringbuf ringbuf
;
192 * Defines a structure to store the rootfs location, the
193 * optionals pivot_root, rootfs mount paths
194 * @path : the rootfs source (directory or device)
195 * @mount : where it is mounted
196 * @options : mount options
197 * @bev_type : optional backing store type
207 * Automatic mounts for LXC to perform inside the container
210 LXC_AUTO_PROC_RW
= 0x001, /* /proc read-write */
211 LXC_AUTO_PROC_MIXED
= 0x002, /* /proc/sys and /proc/sysrq-trigger read-only */
212 LXC_AUTO_PROC_MASK
= 0x003,
214 LXC_AUTO_SYS_RW
= 0x004, /* /sys */
215 LXC_AUTO_SYS_RO
= 0x008, /* /sys read-only */
216 LXC_AUTO_SYS_MIXED
= 0x00C, /* /sys read-only and /sys/class/net read-write */
217 LXC_AUTO_SYS_MASK
= 0x00C,
219 LXC_AUTO_CGROUP_RO
= 0x010, /* /sys/fs/cgroup (partial mount, read-only) */
220 LXC_AUTO_CGROUP_RW
= 0x020, /* /sys/fs/cgroup (partial mount, read-write) */
221 LXC_AUTO_CGROUP_MIXED
= 0x030, /* /sys/fs/cgroup (partial mount, paths r/o, cgroup r/w) */
222 LXC_AUTO_CGROUP_FULL_RO
= 0x040, /* /sys/fs/cgroup (full mount, read-only) */
223 LXC_AUTO_CGROUP_FULL_RW
= 0x050, /* /sys/fs/cgroup (full mount, read-write) */
224 LXC_AUTO_CGROUP_FULL_MIXED
= 0x060, /* /sys/fs/cgroup (full mount, parent r/o, own r/w) */
225 /* These are defined in such a way as to retain
226 * binary compatibility with earlier versions of
227 * this code. If the previous mask is applied,
228 * both of these will default back to the _MIXED
229 * variants, which is safe. */
230 LXC_AUTO_CGROUP_NOSPEC
= 0x0B0, /* /sys/fs/cgroup (partial mount, r/w or mixed, depending on caps) */
231 LXC_AUTO_CGROUP_FULL_NOSPEC
= 0x0E0, /* /sys/fs/cgroup (full mount, r/w or mixed, depending on caps) */
232 LXC_AUTO_CGROUP_MASK
= 0x0F0,
234 LXC_AUTO_ALL_MASK
= 0x0FF, /* all known settings */
238 * Defines the global container configuration
239 * @rootfs : root directory to run the container
240 * @mount : list of mount points
241 * @tty : numbers of tty
242 * @pts : new pts instance
243 * @mount_list : list of mount point (alternative to fstab file)
244 * @network : network configuration
245 * @utsname : container utsname
246 * @fstab : path to a fstab file format
247 * @caps : list of the capabilities to drop
248 * @keepcaps : list of the capabilities to keep
249 * @tty_info : tty data
250 * @console : console data
251 * @ttydir : directory (under /dev) in which to create console and ttys
252 * @lsm_aa_profile : apparmor profile to switch to or NULL
253 * @lsm_se_context : selinux type to switch to or NULL
269 extern char *lxchook_names
[NUM_LXC_HOOKS
];
271 struct lxc_state_client
{
273 lxc_state_t states
[MAX_STATE
];
282 signed long personality
;
283 struct utsname
*utsname
;
284 struct lxc_list cgroup
;
285 struct lxc_list id_map
;
286 struct lxc_list network
;
288 struct lxc_list mount_list
;
289 struct lxc_list caps
;
290 struct lxc_list keepcaps
;
291 struct lxc_tty_info tty_info
;
292 /* Comma-separated list of lxc.tty.max pty names. */
294 struct lxc_console console
;
295 struct lxc_rootfs rootfs
;
298 struct lxc_list hooks
[NUM_LXC_HOOKS
];
300 char *lsm_aa_profile
;
301 unsigned int lsm_aa_allow_incomplete
;
302 char *lsm_se_context
;
304 char *seccomp
; /* filename with the seccomp rules */
305 #if HAVE_SCMP_FILTER_CTX
306 scmp_filter_ctx seccomp_ctx
;
309 unsigned int autodev
; /* if 1, mount and fill a /dev at start */
310 int haltsignal
; /* signal used to halt container */
311 int rebootsignal
; /* signal used to reboot container */
312 int stopsignal
; /* signal used to hard stop container */
313 char *rcfile
; /* Copy of the top level rcfile we read */
315 /* Logfile and logleve can be set in a container config file. Those
316 * function as defaults. The defaults can be overriden by command line.
317 * However we don't want the command line specified values to be saved
318 * on c->save_config(). So we store the config file specified values
320 char *logfile
; /* the logfile as specifed in config */
321 int loglevel
; /* loglevel as specifed in config (if any) */
324 unsigned int start_auto
;
325 unsigned int start_delay
;
327 struct lxc_list groups
;
330 /* unshare the mount namespace in the monitor */
331 unsigned int monitor_unshare
;
333 /* set to true when rootfs has been setup */
336 /* list of included files */
337 struct lxc_list includes
;
338 /* config entries which are not "lxc.*" are aliens */
339 struct lxc_list aliens
;
341 /* list of environment variables we'll add to the container when
343 struct lxc_list environment
;
345 /* text representation of the config file */
346 char *unexpanded_config
;
347 size_t unexpanded_len
, unexpanded_alloced
;
349 /* default command for lxc-execute */
355 /* if running in a new user namespace, the UID/GID that init and COMMAND
356 * should run under when using lxc-execute */
360 /* indicator if the container will be destroyed on shutdown */
361 unsigned int ephemeral
;
363 /* The facility to pass to syslog. Let's users establish as what type of
364 * program liblxc is supposed to write to the syslog. */
367 /* Whether PR_SET_NO_NEW_PRIVS will be set for the container. */
370 /* RLIMIT_* limits */
371 struct lxc_list limits
;
374 * Indicator whether the current config file we're using contained any
375 * legacy configuration keys.
377 bool contains_legacy_key
;
379 /* Contains generic info about the cgroup configuration for this
380 * container. Note that struct lxc_cgroup contains a union. It is only
381 * valid to access the members of the anonymous "meta" struct within
384 struct lxc_cgroup cgroup_meta
;
386 char *inherit_ns
[LXC_NS_MAX
];
388 /* init working directory */
391 /* A list of clients registered to be informed about a container state. */
392 struct lxc_list state_clients
;
395 struct lxc_list sysctls
;
398 struct lxc_list procs
;
401 int write_id_mapping(enum idtype idtype
, pid_t pid
, const char *buf
,
405 extern __thread
struct lxc_conf
*current_config
;
407 extern struct lxc_conf
*current_config
;
410 extern int run_lxc_hooks(const char *name
, char *hook
, struct lxc_conf
*conf
,
411 const char *lxcpath
, char *argv
[]);
412 extern int detect_shared_rootfs(void);
413 extern struct lxc_conf
*lxc_conf_init(void);
414 extern void lxc_conf_free(struct lxc_conf
*conf
);
415 extern int pin_rootfs(const char *rootfs
);
416 extern int lxc_map_ids(struct lxc_list
*idmap
, pid_t pid
);
417 extern int lxc_create_tty(const char *name
, struct lxc_conf
*conf
);
418 extern void lxc_delete_tty(struct lxc_tty_info
*tty_info
);
419 extern int lxc_clear_config_caps(struct lxc_conf
*c
);
420 extern int lxc_clear_config_keepcaps(struct lxc_conf
*c
);
421 extern int lxc_clear_cgroups(struct lxc_conf
*c
, const char *key
);
422 extern int lxc_clear_mount_entries(struct lxc_conf
*c
);
423 extern int lxc_clear_automounts(struct lxc_conf
*c
);
424 extern int lxc_clear_hooks(struct lxc_conf
*c
, const char *key
);
425 extern int lxc_clear_idmaps(struct lxc_conf
*c
);
426 extern int lxc_clear_groups(struct lxc_conf
*c
);
427 extern int lxc_clear_environment(struct lxc_conf
*c
);
428 extern int lxc_clear_limits(struct lxc_conf
*c
, const char *key
);
429 extern int lxc_delete_autodev(struct lxc_handler
*handler
);
430 extern void lxc_clear_includes(struct lxc_conf
*conf
);
431 extern int do_rootfs_setup(struct lxc_conf
*conf
, const char *name
,
432 const char *lxcpath
);
433 extern int lxc_setup(struct lxc_handler
*handler
);
434 extern int lxc_setup_parent(struct lxc_handler
*handler
);
435 extern int setup_resource_limits(struct lxc_list
*limits
, pid_t pid
);
436 extern int find_unmapped_nsid(struct lxc_conf
*conf
, enum idtype idtype
);
437 extern int mapped_hostid(unsigned id
, struct lxc_conf
*conf
,
439 extern int chown_mapped_root(const char *path
, struct lxc_conf
*conf
);
440 extern int lxc_ttys_shift_ids(struct lxc_conf
*c
);
441 extern int userns_exec_1(struct lxc_conf
*conf
, int (*fn
)(void *), void *data
,
442 const char *fn_name
);
443 extern int userns_exec_full(struct lxc_conf
*conf
, int (*fn
)(void *),
444 void *data
, const char *fn_name
);
445 extern int parse_mntopts(const char *mntopts
, unsigned long *mntflags
,
447 extern void tmp_proc_unmount(struct lxc_conf
*lxc_conf
);
448 extern void remount_all_slave(void);
449 extern void suggest_default_idmap(void);
450 extern FILE *make_anonymous_mount_file(struct lxc_list
*mount
);
451 extern struct lxc_list
*sort_cgroup_settings(struct lxc_list
*cgroup_settings
);
452 extern unsigned long add_required_remount_flags(const char *s
, const char *d
,
453 unsigned long flags
);
454 extern int run_script(const char *name
, const char *section
, const char *script
,
456 extern int in_caplist(int cap
, struct lxc_list
*caps
);
457 extern int setup_sysctl_parameters(struct lxc_list
*sysctls
);
458 extern int lxc_clear_sysctls(struct lxc_conf
*c
, const char *key
);
459 extern int setup_proc_filesystem(struct lxc_list
*procs
, pid_t pid
);
460 extern int lxc_clear_procs(struct lxc_conf
*c
, const char *key
);
462 #endif /* __LXC_CONF_H */