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