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