]> git.proxmox.com Git - mirror_lxc.git/blame - src/lxc/conf.h
Makefile: remove last pam_cgfs special-casing
[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
885766f5 140 * @max = number of configured ttys
b0a33c1e 141 */
142struct lxc_tty_info {
885766f5
CB
143 size_t max;
144 char *dir;
145 char *tty_names;
2520facd 146 struct lxc_terminal_info *tty;
b0a33c1e 147};
148
13bb312d 149/* Defines a structure to store the rootfs location, the
33fcb7a0 150 * optionals pivot_root, rootfs mount paths
59bb8698
SH
151 * @path : the rootfs source (directory or device)
152 * @mount : where it is mounted
b3b8c97f 153 * @bev_type : optional backing store type
3437f95c
CB
154 * @options : mount options
155 * @mountflags : the portion of @options that are flags
156 * @data : the porition of @options that are not flags
33fcb7a0
DL
157 */
158struct lxc_rootfs {
159 char *path;
23b7ea69 160 char *mount;
b3b8c97f 161 char *bdev_type;
3437f95c
CB
162 char *options;
163 unsigned long mountflags;
164 char *data;
33fcb7a0
DL
165};
166
368bbc02
CS
167/*
168 * Automatic mounts for LXC to perform inside the container
169 */
170enum {
3a0e314d
CB
171 LXC_AUTO_PROC_RW = 0x001, /* /proc read-write */
172 LXC_AUTO_PROC_MIXED = 0x002, /* /proc/sys and /proc/sysrq-trigger read-only */
b06b8511
CS
173 LXC_AUTO_PROC_MASK = 0x003,
174
3a0e314d
CB
175 LXC_AUTO_SYS_RW = 0x004, /* /sys */
176 LXC_AUTO_SYS_RO = 0x008, /* /sys read-only */
177 LXC_AUTO_SYS_MIXED = 0x00C, /* /sys read-only and /sys/class/net read-write */
b06b8511
CS
178 LXC_AUTO_SYS_MASK = 0x00C,
179
3a0e314d
CB
180 LXC_AUTO_CGROUP_RO = 0x010, /* /sys/fs/cgroup (partial mount, read-only) */
181 LXC_AUTO_CGROUP_RW = 0x020, /* /sys/fs/cgroup (partial mount, read-write) */
182 LXC_AUTO_CGROUP_MIXED = 0x030, /* /sys/fs/cgroup (partial mount, paths r/o, cgroup r/w) */
183 LXC_AUTO_CGROUP_FULL_RO = 0x040, /* /sys/fs/cgroup (full mount, read-only) */
184 LXC_AUTO_CGROUP_FULL_RW = 0x050, /* /sys/fs/cgroup (full mount, read-write) */
185 LXC_AUTO_CGROUP_FULL_MIXED = 0x060, /* /sys/fs/cgroup (full mount, parent r/o, own r/w) */
186 /*
187 * These are defined in such a way as to retain binary compatibility
188 * with earlier versions of this code. If the previous mask is applied,
189 * both of these will default back to the _MIXED variants, which is
190 * safe.
191 */
192 LXC_AUTO_CGROUP_NOSPEC = 0x0B0, /* /sys/fs/cgroup (partial mount, r/w or mixed, depending on caps) */
193 LXC_AUTO_CGROUP_FULL_NOSPEC = 0x0E0, /* /sys/fs/cgroup (full mount, r/w or mixed, depending on caps) */
194 LXC_AUTO_CGROUP_FORCE = 0x100, /* mount cgroups even when cgroup namespaces are supported */
195 LXC_AUTO_CGROUP_MASK = 0x1F0, /* all known cgroup options, doe not contain LXC_AUTO_CGROUP_FORCE */
adf0ba1f
LT
196
197 LXC_AUTO_SHMOUNTS = 0x200, /* shared mount point */
198 LXC_AUTO_SHMOUNTS_MASK = 0x200, /* shared mount point mask */
3a0e314d 199 LXC_AUTO_ALL_MASK = 0x1FF, /* all known settings */
368bbc02
CS
200};
201
26ddeedd 202enum lxchooks {
1a0e70ac
CB
203 LXCHOOK_PRESTART,
204 LXCHOOK_PREMOUNT,
205 LXCHOOK_MOUNT,
206 LXCHOOK_AUTODEV,
207 LXCHOOK_START,
208 LXCHOOK_STOP,
209 LXCHOOK_POSTSTOP,
210 LXCHOOK_CLONE,
211 LXCHOOK_DESTROY,
08dd2805 212 LXCHOOK_START_HOST,
1a0e70ac
CB
213 NUM_LXC_HOOKS
214};
72d0e1cb 215
811ef482 216extern char *lxchook_names[NUM_LXC_HOOKS];
7b35f3d6 217
d39b10eb
CB
218struct lxc_state_client {
219 int clientfd;
220 lxc_state_t states[MAX_STATE];
221};
222
571e6ec8 223struct lxc_conf {
c7b17051
CB
224 /* Pointer to the name of the container. Do not free! */
225 const char *name;
07c4ea31 226 bool is_execute;
91480a0f 227 int reboot;
9b8e3c96 228 signed long personality;
571e6ec8 229 struct utsname *utsname;
edd64e17 230
54860ed0
CB
231 struct {
232 struct lxc_list cgroup;
233 struct lxc_list cgroup2;
234 };
edd64e17 235
46ad64ab
CB
236 struct {
237 struct lxc_list id_map;
c7e345ae 238
edd64e17
CB
239 /*
240 * Pointer to the idmap entry for the container's root uid in
241 * the id_map list. Do not free!
242 */
5173b710 243 const struct id_map *root_nsuid_map;
c7e345ae 244
edd64e17
CB
245 /*
246 * Pointer to the idmap entry for the container's root gid in
247 * the id_map list. Do not free!
248 */
5173b710 249 const struct id_map *root_nsgid_map;
46ad64ab 250 };
edd64e17 251
5f4535a3 252 struct lxc_list network;
448d7b0c
CB
253
254 struct {
255 char *fstab;
256 int auto_mounts;
257 struct lxc_list mount_list;
258 };
259
81810dd1 260 struct lxc_list caps;
1fb86a7c 261 struct lxc_list keepcaps;
885766f5 262
a2db71c0 263 /* /dev/tty<idx> devices */
885766f5 264 struct lxc_tty_info ttys;
a2db71c0
CB
265 /* /dev/console device */
266 struct lxc_terminal console;
267 /* maximum pty devices allowed by devpts mount */
e528c735 268 size_t pty_max;
885766f5 269
32fd6cf3
CB
270 /* set to true when rootfs has been setup */
271 bool rootfs_setup;
33fcb7a0 272 struct lxc_rootfs rootfs;
32fd6cf3 273
b3187a81 274 bool close_all_fds;
44ae0fb6
CB
275
276 struct {
277 unsigned int hooks_version;
278 struct lxc_list hooks[NUM_LXC_HOOKS];
279 };
4a85ce2a 280
fe4de9a6 281 char *lsm_aa_profile;
1800f924
WB
282 char *lsm_aa_profile_computed;
283 bool lsm_aa_profile_created;
284 unsigned int lsm_aa_allow_nesting;
a56e2df9 285 unsigned int lsm_aa_allow_incomplete;
1800f924 286 struct lxc_list lsm_aa_raw;
fe4de9a6 287 char *lsm_se_context;
7a0bcca3 288 bool tmp_umount_proc;
1a0e70ac 289 char *seccomp; /* filename with the seccomp rules */
769872f9 290#if HAVE_SCMP_FILTER_CTX
d58c6ad0 291 scmp_filter_ctx seccomp_ctx;
769872f9 292#endif
72d0e1cb 293 int maincmd_fd;
1a0e70ac
CB
294 unsigned int autodev; /* if 1, mount and fill a /dev at start */
295 int haltsignal; /* signal used to halt container */
296 int rebootsignal; /* signal used to reboot container */
297 int stopsignal; /* signal used to hard stop container */
298 char *rcfile; /* Copy of the top level rcfile we read */
299
300 /* Logfile and logleve can be set in a container config file. Those
301 * function as defaults. The defaults can be overriden by command line.
302 * However we don't want the command line specified values to be saved
303 * on c->save_config(). So we store the config file specified values
304 * here. */
305 char *logfile; /* the logfile as specifed in config */
306 int loglevel; /* loglevel as specifed in config (if any) */
858377e4 307 int logfd;
9f30a190 308
3590152f
CB
309 unsigned int start_auto;
310 unsigned int start_delay;
ee1e7aa0
SG
311 int start_order;
312 struct lxc_list groups;
76a26f55 313 int nbd_idx;
35120d9c 314
a8dfe4e0 315 /* unshare the mount namespace in the monitor */
226dc30e 316 unsigned int monitor_unshare;
258f8051 317 unsigned int monitor_signal_pdeath;
a8dfe4e0 318
f979ac15
SH
319 /* list of included files */
320 struct lxc_list includes;
4184c3e1
SH
321 /* config entries which are not "lxc.*" are aliens */
322 struct lxc_list aliens;
7c661726
MP
323
324 /* list of environment variables we'll add to the container when
325 * started */
326 struct lxc_list environment;
6b0d5538
SH
327
328 /* text representation of the config file */
329 char *unexpanded_config;
32fd6cf3
CB
330 size_t unexpanded_len;
331 size_t unexpanded_alloced;
67c660d0 332
5cda27c1
SH
333 /* default command for lxc-execute */
334 char *execute_cmd;
335
67c660d0
SG
336 /* init command */
337 char *init_cmd;
56f8ff00 338
72bb04e4
PT
339 /* if running in a new user namespace, the UID/GID that init and COMMAND
340 * should run under when using lxc-execute */
c5cd20ce
PT
341 uid_t init_uid;
342 gid_t init_gid;
8796becf
CB
343
344 /* indicator if the container will be destroyed on shutdown */
66ffdb1a 345 unsigned int ephemeral;
76d0127f
CB
346
347 /* The facility to pass to syslog. Let's users establish as what type of
348 * program liblxc is supposed to write to the syslog. */
349 char *syslog;
5a46f283
CB
350
351 /* Whether PR_SET_NO_NEW_PRIVS will be set for the container. */
352 bool no_new_privs;
c6d09e15
WB
353
354 /* RLIMIT_* limits */
355 struct lxc_list limits;
7ec2e32a 356
43654d34
CB
357 /* Contains generic info about the cgroup configuration for this
358 * container. Note that struct lxc_cgroup contains a union. It is only
359 * valid to access the members of the anonymous "meta" struct within
360 * that union.
361 */
362 struct lxc_cgroup cgroup_meta;
28d9e29e 363
b074bbf1 364 struct {
1d8d3676 365 int ns_clone;
abeb5bba 366 int ns_keep;
b074bbf1
CB
367 char *ns_share[LXC_NS_MAX];
368 };
3c491553
L
369
370 /* init working directory */
9e132956 371 char *init_cwd;
3c491553 372
d39b10eb
CB
373 /* A list of clients registered to be informed about a container state. */
374 struct lxc_list state_clients;
7edd0540
L
375
376 /* sysctls */
377 struct lxc_list sysctls;
61d7a733
YT
378
379 /* procs */
380 struct lxc_list procs;
adf0ba1f 381
7a41e857 382 struct shmount {
adf0ba1f
LT
383 /* Absolute path to the shared mount point on the host */
384 char *path_host;
385 /* Absolute path (in the container) to the shared mount point */
386 char *path_cont;
7a41e857 387 } shmount;
571e6ec8
DL
388};
389
a19b974f 390extern int write_id_mapping(enum idtype idtype, pid_t pid, const char *buf,
344c9d81
MPS
391 size_t buf_size);
392
858377e4
SH
393#ifdef HAVE_TLS
394extern __thread struct lxc_conf *current_config;
395#else
396extern struct lxc_conf *current_config;
397#endif
398
1a0e70ac 399extern int run_lxc_hooks(const char *name, char *hook, struct lxc_conf *conf,
14a7b0f9 400 char *argv[]);
cc28d0b0 401extern int detect_shared_rootfs(void);
7b379ab3 402extern struct lxc_conf *lxc_conf_init(void);
8eb5694b 403extern void lxc_conf_free(struct lxc_conf *conf);
0c547523 404extern int pin_rootfs(const char *rootfs);
f6d3e3e4 405extern int lxc_map_ids(struct lxc_list *idmap, pid_t pid);
5e4a62bf 406extern int lxc_create_tty(const char *name, struct lxc_conf *conf);
0e4be3cf 407extern void lxc_delete_tty(struct lxc_tty_info *ttys);
72d0e1cb 408extern int lxc_clear_config_caps(struct lxc_conf *c);
1fb86a7c 409extern int lxc_clear_config_keepcaps(struct lxc_conf *c);
54860ed0 410extern int lxc_clear_cgroups(struct lxc_conf *c, const char *key, int version);
72d0e1cb 411extern int lxc_clear_mount_entries(struct lxc_conf *c);
b099e9e9 412extern int lxc_clear_automounts(struct lxc_conf *c);
12a50cc6 413extern int lxc_clear_hooks(struct lxc_conf *c, const char *key);
7d0eb87e 414extern int lxc_clear_idmaps(struct lxc_conf *c);
ee1e7aa0 415extern int lxc_clear_groups(struct lxc_conf *c);
ab799c0b 416extern int lxc_clear_environment(struct lxc_conf *c);
c6d09e15 417extern int lxc_clear_limits(struct lxc_conf *c, const char *key);
f0d02950 418extern int lxc_delete_autodev(struct lxc_handler *handler);
c7b15d1e 419extern void lxc_clear_includes(struct lxc_conf *conf);
8ce1abc2
CB
420extern int lxc_setup_rootfs_prepare_root(struct lxc_conf *conf,
421 const char *name, const char *lxcpath);
3b988b33 422extern int lxc_setup(struct lxc_handler *handler);
732375f5 423extern int lxc_setup_parent(struct lxc_handler *handler);
c6d09e15 424extern int setup_resource_limits(struct lxc_list *limits, pid_t pid);
339efad9 425extern int find_unmapped_nsid(struct lxc_conf *conf, enum idtype idtype);
1a0e70ac
CB
426extern int mapped_hostid(unsigned id, struct lxc_conf *conf,
427 enum idtype idtype);
41dc7155 428extern int chown_mapped_root(const char *path, struct lxc_conf *conf);
c9b7c33e
CB
429extern int userns_exec_1(struct lxc_conf *conf, int (*fn)(void *), void *data,
430 const char *fn_name);
415a8851
CB
431extern int userns_exec_full(struct lxc_conf *conf, int (*fn)(void *),
432 void *data, const char *fn_name);
a17b1e65
SG
433extern int parse_mntopts(const char *mntopts, unsigned long *mntflags,
434 char **mntdata);
8ce1abc2 435extern int parse_propagationopts(const char *mntopts, unsigned long *pflags);
5112cd70 436extern void tmp_proc_unmount(struct lxc_conf *lxc_conf);
1a0e70ac 437extern void remount_all_slave(void);
97e9cfa0 438extern void suggest_default_idmap(void);
1800f924
WB
439extern FILE *make_anonymous_mount_file(struct lxc_list *mount,
440 bool include_nesting_helpers);
1a0e70ac
CB
441extern struct lxc_list *sort_cgroup_settings(struct lxc_list *cgroup_settings);
442extern unsigned long add_required_remount_flags(const char *s, const char *d,
443 unsigned long flags);
811ef482
CB
444extern int run_script(const char *name, const char *section, const char *script,
445 ...);
14a7b0f9
CB
446extern int run_script_argv(const char *name, unsigned int hook_version,
447 const char *section, const char *script,
448 const char *hookname, char **argsin);
b635e92d 449extern int in_caplist(int cap, struct lxc_list *caps);
7edd0540
L
450extern int setup_sysctl_parameters(struct lxc_list *sysctls);
451extern int lxc_clear_sysctls(struct lxc_conf *c, const char *key);
61d7a733
YT
452extern int setup_proc_filesystem(struct lxc_list *procs, pid_t pid);
453extern int lxc_clear_procs(struct lxc_conf *c, const char *key);
1800f924 454extern int lxc_clear_apparmor_raw(struct lxc_conf *c);
5ae72b98 455
1a0e70ac 456#endif /* __LXC_CONF_H */