]> git.proxmox.com Git - mirror_lxc.git/blame - src/lxc/conf.h
conf: make close_all_fds a boolean
[mirror_lxc.git] / src / lxc / conf.h
CommitLineData
0ad19a3f 1/*
2 * lxc: linux Container library
3 *
4 * (C) Copyright IBM Corp. 2007, 2008
5 *
6 * Authors:
9afe19d6 7 * Daniel Lezcano <daniel.lezcano at free.fr>
0ad19a3f 8 *
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.
13 *
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.
18 *
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
250b1eec 21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
0ad19a3f 22 */
f1a4a029
ÇO
23#ifndef __LXC_CONF_H
24#define __LXC_CONF_H
0ad19a3f 25
f424fa8f
SG
26#include "config.h"
27
9fc7f8c0 28#include <stdio.h>
74a2b586 29#include <net/if.h>
1a0e70ac 30#include <netinet/in.h>
b0a33c1e 31#include <sys/param.h>
8173e600 32#include <sys/types.h>
c6d09e15
WB
33#if HAVE_SYS_RESOURCE_H
34#include <sys/resource.h>
35#endif
19a26f82 36#include <stdbool.h>
0ad19a3f 37
f2363e38 38#include "list.h"
732375f5 39#include "ringbuf.h"
f2363e38 40#include "start.h" /* for lxc_handler */
0ed9b1bc 41#include "terminal.h"
e3b4c4c4 42
769872f9
SH
43#if HAVE_SCMP_FILTER_CTX
44typedef void * scmp_filter_ctx;
45#endif
46
97e9cfa0
SH
47/* worth moving to configure.ac? */
48#define subuidfile "/etc/subuid"
49#define subgidfile "/etc/subgid"
50
0ad19a3f 51/*
43654d34
CB
52 * Defines a generic struct to configure the control group. It is up to the
53 * programmer to specify the right subsystem.
ec64264d 54 * @subsystem : the targeted subsystem
576f946d 55 * @value : the value to set
54860ed0
CB
56 * @version : The version of the cgroup filesystem on which the controller
57 * resides.
43654d34
CB
58 *
59 * @controllers : The controllers to use for this container.
60 * @dir : The name of the directory containing the container's cgroup.
61 * Not that this is a per-container setting.
0ad19a3f 62 */
63struct lxc_cgroup {
43654d34
CB
64 union {
65 /* information about a specific controller */
66 struct /* controller */ {
54860ed0 67 int version;
43654d34
CB
68 char *subsystem;
69 char *value;
70 };
71
72 /* meta information about cgroup configuration */
73 struct /* meta */ {
74 char *controllers;
75 char *dir;
76 };
77 };
0ad19a3f 78};
79
c6d09e15 80#if !HAVE_SYS_RESOURCE_H
3a0e314d 81#define RLIM_INFINITY ((unsigned long)-1)
c6d09e15
WB
82struct rlimit {
83 unsigned long rlim_cur;
84 unsigned long rlim_max;
85};
86#endif
3a0e314d 87
c6d09e15
WB
88/*
89 * Defines a structure to configure resource limits to set via setrlimit().
90 * @resource : the resource name in lowercase without the RLIMIT_ prefix
91 * @limit : the limit to set
92 */
93struct lxc_limit {
94 char *resource;
95 struct rlimit limit;
96};
97
f6d3e3e4
SH
98enum idtype {
99 ID_TYPE_UID,
100 ID_TYPE_GID
101};
102
7edd0540
L
103/*
104 * Defines a structure to configure kernel parameters at runtime.
105 * @key : the kernel parameters will be configured without the "lxc.sysctl" prefix
106 * @value : the value to set
107 */
108struct lxc_sysctl {
109 char *key;
110 char *value;
111};
112
61d7a733
YT
113/*
114 * Defines a structure to configure proc filesystem at runtime.
115 * @filename : the proc filesystem will be configured without the "lxc.proc" prefix
116 * @value : the value to set
117 */
118struct lxc_proc {
119 char *filename;
120 char *value;
121};
122
f6d3e3e4
SH
123/*
124 * id_map is an id map entry. Form in confile is:
bdcbb6b3
CB
125 * lxc.idmap = u 0 9800 100
126 * lxc.idmap = u 1000 9900 100
127 * lxc.idmap = g 0 9800 100
128 * lxc.idmap = g 1000 9900 100
251d0d2a
DE
129 * meaning the container can use uids and gids 0-99 and 1000-1099,
130 * with [ug]id 0 mapping to [ug]id 9800 on the host, and [ug]id 1000 to
131 * [ug]id 9900 on the host.
f6d3e3e4
SH
132 */
133struct id_map {
134 enum idtype idtype;
251d0d2a 135 unsigned long hostid, nsid, range;
f6d3e3e4
SH
136};
137
0e4be3cf 138/* Defines the number of tty configured and contains the
a589434e 139 * instantiated ptys
b0a33c1e 140 * @nbtty = number of configured ttys
141 */
142struct lxc_tty_info {
143 int nbtty;
2520facd 144 struct lxc_terminal_info *tty;
b0a33c1e 145};
146
13bb312d 147/* Defines a structure to store the rootfs location, the
33fcb7a0 148 * optionals pivot_root, rootfs mount paths
59bb8698
SH
149 * @path : the rootfs source (directory or device)
150 * @mount : where it is mounted
151 * @options : mount options
b3b8c97f 152 * @bev_type : optional backing store type
33fcb7a0
DL
153 */
154struct lxc_rootfs {
155 char *path;
23b7ea69 156 char *mount;
a17b1e65 157 char *options;
b3b8c97f 158 char *bdev_type;
33fcb7a0
DL
159};
160
368bbc02
CS
161/*
162 * Automatic mounts for LXC to perform inside the container
163 */
164enum {
3a0e314d
CB
165 LXC_AUTO_PROC_RW = 0x001, /* /proc read-write */
166 LXC_AUTO_PROC_MIXED = 0x002, /* /proc/sys and /proc/sysrq-trigger read-only */
b06b8511
CS
167 LXC_AUTO_PROC_MASK = 0x003,
168
3a0e314d
CB
169 LXC_AUTO_SYS_RW = 0x004, /* /sys */
170 LXC_AUTO_SYS_RO = 0x008, /* /sys read-only */
171 LXC_AUTO_SYS_MIXED = 0x00C, /* /sys read-only and /sys/class/net read-write */
b06b8511
CS
172 LXC_AUTO_SYS_MASK = 0x00C,
173
3a0e314d
CB
174 LXC_AUTO_CGROUP_RO = 0x010, /* /sys/fs/cgroup (partial mount, read-only) */
175 LXC_AUTO_CGROUP_RW = 0x020, /* /sys/fs/cgroup (partial mount, read-write) */
176 LXC_AUTO_CGROUP_MIXED = 0x030, /* /sys/fs/cgroup (partial mount, paths r/o, cgroup r/w) */
177 LXC_AUTO_CGROUP_FULL_RO = 0x040, /* /sys/fs/cgroup (full mount, read-only) */
178 LXC_AUTO_CGROUP_FULL_RW = 0x050, /* /sys/fs/cgroup (full mount, read-write) */
179 LXC_AUTO_CGROUP_FULL_MIXED = 0x060, /* /sys/fs/cgroup (full mount, parent r/o, own r/w) */
180 /*
181 * These are defined in such a way as to retain binary compatibility
182 * with earlier versions of this code. If the previous mask is applied,
183 * both of these will default back to the _MIXED variants, which is
184 * safe.
185 */
186 LXC_AUTO_CGROUP_NOSPEC = 0x0B0, /* /sys/fs/cgroup (partial mount, r/w or mixed, depending on caps) */
187 LXC_AUTO_CGROUP_FULL_NOSPEC = 0x0E0, /* /sys/fs/cgroup (full mount, r/w or mixed, depending on caps) */
188 LXC_AUTO_CGROUP_FORCE = 0x100, /* mount cgroups even when cgroup namespaces are supported */
189 LXC_AUTO_CGROUP_MASK = 0x1F0, /* all known cgroup options, doe not contain LXC_AUTO_CGROUP_FORCE */
190 LXC_AUTO_ALL_MASK = 0x1FF, /* all known settings */
368bbc02
CS
191};
192
26ddeedd 193enum lxchooks {
1a0e70ac
CB
194 LXCHOOK_PRESTART,
195 LXCHOOK_PREMOUNT,
196 LXCHOOK_MOUNT,
197 LXCHOOK_AUTODEV,
198 LXCHOOK_START,
199 LXCHOOK_STOP,
200 LXCHOOK_POSTSTOP,
201 LXCHOOK_CLONE,
202 LXCHOOK_DESTROY,
08dd2805 203 LXCHOOK_START_HOST,
1a0e70ac
CB
204 NUM_LXC_HOOKS
205};
72d0e1cb 206
811ef482 207extern char *lxchook_names[NUM_LXC_HOOKS];
7b35f3d6 208
d39b10eb
CB
209struct lxc_state_client {
210 int clientfd;
211 lxc_state_t states[MAX_STATE];
212};
213
571e6ec8 214struct lxc_conf {
c7b17051
CB
215 /* Pointer to the name of the container. Do not free! */
216 const char *name;
571e6ec8 217 char *fstab;
1c30b4ad 218 unsigned int tty;
17919969 219 unsigned int pts;
07c4ea31 220 bool is_execute;
91480a0f 221 int reboot;
9b8e3c96 222 signed long personality;
571e6ec8 223 struct utsname *utsname;
edd64e17 224
54860ed0
CB
225 struct {
226 struct lxc_list cgroup;
227 struct lxc_list cgroup2;
228 };
edd64e17 229
46ad64ab
CB
230 struct {
231 struct lxc_list id_map;
c7e345ae 232
edd64e17
CB
233 /*
234 * Pointer to the idmap entry for the container's root uid in
235 * the id_map list. Do not free!
236 */
46ad64ab 237 struct id_map *root_nsuid_map;
c7e345ae 238
edd64e17
CB
239 /*
240 * Pointer to the idmap entry for the container's root gid in
241 * the id_map list. Do not free!
242 */
46ad64ab
CB
243 struct id_map *root_nsgid_map;
244 };
edd64e17 245
5f4535a3 246 struct lxc_list network;
368bbc02 247 int auto_mounts;
e7938e9e 248 struct lxc_list mount_list;
81810dd1 249 struct lxc_list caps;
1fb86a7c 250 struct lxc_list keepcaps;
0e4be3cf 251 struct lxc_tty_info ttys;
fe1c5887
CB
252 /* Comma-separated list of lxc.tty.max pty names. */
253 char *pty_names;
dcad02f8 254 struct lxc_terminal console;
33fcb7a0 255 struct lxc_rootfs rootfs;
7c6ef2a2 256 char *ttydir;
b3187a81 257 bool close_all_fds;
44ae0fb6
CB
258
259 struct {
260 unsigned int hooks_version;
261 struct lxc_list hooks[NUM_LXC_HOOKS];
262 };
4a85ce2a 263
fe4de9a6 264 char *lsm_aa_profile;
a56e2df9 265 unsigned int lsm_aa_allow_incomplete;
fe4de9a6 266 char *lsm_se_context;
5112cd70 267 int tmp_umount_proc;
1a0e70ac 268 char *seccomp; /* filename with the seccomp rules */
769872f9 269#if HAVE_SCMP_FILTER_CTX
d58c6ad0 270 scmp_filter_ctx seccomp_ctx;
769872f9 271#endif
72d0e1cb 272 int maincmd_fd;
1a0e70ac
CB
273 unsigned int autodev; /* if 1, mount and fill a /dev at start */
274 int haltsignal; /* signal used to halt container */
275 int rebootsignal; /* signal used to reboot container */
276 int stopsignal; /* signal used to hard stop container */
277 char *rcfile; /* Copy of the top level rcfile we read */
278
279 /* Logfile and logleve can be set in a container config file. Those
280 * function as defaults. The defaults can be overriden by command line.
281 * However we don't want the command line specified values to be saved
282 * on c->save_config(). So we store the config file specified values
283 * here. */
284 char *logfile; /* the logfile as specifed in config */
285 int loglevel; /* loglevel as specifed in config (if any) */
858377e4 286 int logfd;
9f30a190 287
3590152f
CB
288 unsigned int start_auto;
289 unsigned int start_delay;
ee1e7aa0
SG
290 int start_order;
291 struct lxc_list groups;
76a26f55 292 int nbd_idx;
35120d9c 293
a8dfe4e0 294 /* unshare the mount namespace in the monitor */
226dc30e 295 unsigned int monitor_unshare;
a8dfe4e0 296
35120d9c
SH
297 /* set to true when rootfs has been setup */
298 bool rootfs_setup;
f979ac15
SH
299
300 /* list of included files */
301 struct lxc_list includes;
4184c3e1
SH
302 /* config entries which are not "lxc.*" are aliens */
303 struct lxc_list aliens;
7c661726
MP
304
305 /* list of environment variables we'll add to the container when
306 * started */
307 struct lxc_list environment;
6b0d5538
SH
308
309 /* text representation of the config file */
310 char *unexpanded_config;
311 size_t unexpanded_len, unexpanded_alloced;
67c660d0 312
5cda27c1
SH
313 /* default command for lxc-execute */
314 char *execute_cmd;
315
67c660d0
SG
316 /* init command */
317 char *init_cmd;
56f8ff00 318
72bb04e4
PT
319 /* if running in a new user namespace, the UID/GID that init and COMMAND
320 * should run under when using lxc-execute */
c5cd20ce
PT
321 uid_t init_uid;
322 gid_t init_gid;
8796becf
CB
323
324 /* indicator if the container will be destroyed on shutdown */
66ffdb1a 325 unsigned int ephemeral;
76d0127f
CB
326
327 /* The facility to pass to syslog. Let's users establish as what type of
328 * program liblxc is supposed to write to the syslog. */
329 char *syslog;
5a46f283
CB
330
331 /* Whether PR_SET_NO_NEW_PRIVS will be set for the container. */
332 bool no_new_privs;
c6d09e15
WB
333
334 /* RLIMIT_* limits */
335 struct lxc_list limits;
7ec2e32a 336
43654d34
CB
337 /* Contains generic info about the cgroup configuration for this
338 * container. Note that struct lxc_cgroup contains a union. It is only
339 * valid to access the members of the anonymous "meta" struct within
340 * that union.
341 */
342 struct lxc_cgroup cgroup_meta;
28d9e29e 343
b074bbf1 344 struct {
1d8d3676 345 int ns_clone;
abeb5bba 346 int ns_keep;
b074bbf1
CB
347 char *ns_share[LXC_NS_MAX];
348 };
3c491553
L
349
350 /* init working directory */
9e132956 351 char *init_cwd;
3c491553 352
d39b10eb
CB
353 /* A list of clients registered to be informed about a container state. */
354 struct lxc_list state_clients;
7edd0540
L
355
356 /* sysctls */
357 struct lxc_list sysctls;
61d7a733
YT
358
359 /* procs */
360 struct lxc_list procs;
571e6ec8
DL
361};
362
a19b974f 363extern int write_id_mapping(enum idtype idtype, pid_t pid, const char *buf,
344c9d81
MPS
364 size_t buf_size);
365
858377e4
SH
366#ifdef HAVE_TLS
367extern __thread struct lxc_conf *current_config;
368#else
369extern struct lxc_conf *current_config;
370#endif
371
1a0e70ac 372extern int run_lxc_hooks(const char *name, char *hook, struct lxc_conf *conf,
14a7b0f9 373 char *argv[]);
cc28d0b0 374extern int detect_shared_rootfs(void);
7b379ab3 375extern struct lxc_conf *lxc_conf_init(void);
8eb5694b 376extern void lxc_conf_free(struct lxc_conf *conf);
0c547523 377extern int pin_rootfs(const char *rootfs);
f6d3e3e4 378extern int lxc_map_ids(struct lxc_list *idmap, pid_t pid);
5e4a62bf 379extern int lxc_create_tty(const char *name, struct lxc_conf *conf);
0e4be3cf 380extern void lxc_delete_tty(struct lxc_tty_info *ttys);
72d0e1cb 381extern int lxc_clear_config_caps(struct lxc_conf *c);
1fb86a7c 382extern int lxc_clear_config_keepcaps(struct lxc_conf *c);
54860ed0 383extern int lxc_clear_cgroups(struct lxc_conf *c, const char *key, int version);
72d0e1cb 384extern int lxc_clear_mount_entries(struct lxc_conf *c);
b099e9e9 385extern int lxc_clear_automounts(struct lxc_conf *c);
12a50cc6 386extern int lxc_clear_hooks(struct lxc_conf *c, const char *key);
7d0eb87e 387extern int lxc_clear_idmaps(struct lxc_conf *c);
ee1e7aa0 388extern int lxc_clear_groups(struct lxc_conf *c);
ab799c0b 389extern int lxc_clear_environment(struct lxc_conf *c);
c6d09e15 390extern int lxc_clear_limits(struct lxc_conf *c, const char *key);
f0d02950 391extern int lxc_delete_autodev(struct lxc_handler *handler);
c7b15d1e 392extern void lxc_clear_includes(struct lxc_conf *conf);
35120d9c
SH
393extern int do_rootfs_setup(struct lxc_conf *conf, const char *name,
394 const char *lxcpath);
3b988b33 395extern int lxc_setup(struct lxc_handler *handler);
732375f5 396extern int lxc_setup_parent(struct lxc_handler *handler);
c6d09e15 397extern int setup_resource_limits(struct lxc_list *limits, pid_t pid);
339efad9 398extern int find_unmapped_nsid(struct lxc_conf *conf, enum idtype idtype);
1a0e70ac
CB
399extern int mapped_hostid(unsigned id, struct lxc_conf *conf,
400 enum idtype idtype);
41dc7155 401extern int chown_mapped_root(const char *path, struct lxc_conf *conf);
c9b7c33e
CB
402extern int userns_exec_1(struct lxc_conf *conf, int (*fn)(void *), void *data,
403 const char *fn_name);
415a8851
CB
404extern int userns_exec_full(struct lxc_conf *conf, int (*fn)(void *),
405 void *data, const char *fn_name);
a17b1e65
SG
406extern int parse_mntopts(const char *mntopts, unsigned long *mntflags,
407 char **mntdata);
5112cd70 408extern void tmp_proc_unmount(struct lxc_conf *lxc_conf);
1a0e70ac 409extern void remount_all_slave(void);
97e9cfa0 410extern void suggest_default_idmap(void);
1a0e70ac
CB
411extern FILE *make_anonymous_mount_file(struct lxc_list *mount);
412extern struct lxc_list *sort_cgroup_settings(struct lxc_list *cgroup_settings);
413extern unsigned long add_required_remount_flags(const char *s, const char *d,
414 unsigned long flags);
811ef482
CB
415extern int run_script(const char *name, const char *section, const char *script,
416 ...);
14a7b0f9
CB
417extern int run_script_argv(const char *name, unsigned int hook_version,
418 const char *section, const char *script,
419 const char *hookname, char **argsin);
b635e92d 420extern int in_caplist(int cap, struct lxc_list *caps);
7edd0540
L
421extern int setup_sysctl_parameters(struct lxc_list *sysctls);
422extern int lxc_clear_sysctls(struct lxc_conf *c, const char *key);
61d7a733
YT
423extern int setup_proc_filesystem(struct lxc_list *procs, pid_t pid);
424extern int lxc_clear_procs(struct lxc_conf *c, const char *key);
5ae72b98 425
1a0e70ac 426#endif /* __LXC_CONF_H */