]>
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 | |
13bb312d | 38 | #include "console.h" |
f2363e38 | 39 | #include "list.h" |
732375f5 | 40 | #include "ringbuf.h" |
f2363e38 | 41 | #include "start.h" /* for lxc_handler */ |
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 WB |
80 | #if !HAVE_SYS_RESOURCE_H |
81 | # define RLIM_INFINITY ((unsigned long)-1) | |
82 | struct rlimit { | |
83 | unsigned long rlim_cur; | |
84 | unsigned long rlim_max; | |
85 | }; | |
86 | #endif | |
87 | /* | |
88 | * Defines a structure to configure resource limits to set via setrlimit(). | |
89 | * @resource : the resource name in lowercase without the RLIMIT_ prefix | |
90 | * @limit : the limit to set | |
91 | */ | |
92 | struct lxc_limit { | |
93 | char *resource; | |
94 | struct rlimit limit; | |
95 | }; | |
96 | ||
f6d3e3e4 SH |
97 | enum idtype { |
98 | ID_TYPE_UID, | |
99 | ID_TYPE_GID | |
100 | }; | |
101 | ||
7edd0540 L |
102 | /* |
103 | * Defines a structure to configure kernel parameters at runtime. | |
104 | * @key : the kernel parameters will be configured without the "lxc.sysctl" prefix | |
105 | * @value : the value to set | |
106 | */ | |
107 | struct lxc_sysctl { | |
108 | char *key; | |
109 | char *value; | |
110 | }; | |
111 | ||
61d7a733 YT |
112 | /* |
113 | * Defines a structure to configure proc filesystem at runtime. | |
114 | * @filename : the proc filesystem will be configured without the "lxc.proc" prefix | |
115 | * @value : the value to set | |
116 | */ | |
117 | struct lxc_proc { | |
118 | char *filename; | |
119 | char *value; | |
120 | }; | |
121 | ||
f6d3e3e4 SH |
122 | /* |
123 | * id_map is an id map entry. Form in confile is: | |
bdcbb6b3 CB |
124 | * lxc.idmap = u 0 9800 100 |
125 | * lxc.idmap = u 1000 9900 100 | |
126 | * lxc.idmap = g 0 9800 100 | |
127 | * lxc.idmap = g 1000 9900 100 | |
251d0d2a DE |
128 | * meaning the container can use uids and gids 0-99 and 1000-1099, |
129 | * with [ug]id 0 mapping to [ug]id 9800 on the host, and [ug]id 1000 to | |
130 | * [ug]id 9900 on the host. | |
f6d3e3e4 SH |
131 | */ |
132 | struct id_map { | |
133 | enum idtype idtype; | |
251d0d2a | 134 | unsigned long hostid, nsid, range; |
f6d3e3e4 SH |
135 | }; |
136 | ||
b0a33c1e | 137 | /* |
138 | * Defines the number of tty configured and contains the | |
a589434e | 139 | * instantiated ptys |
b0a33c1e | 140 | * @nbtty = number of configured ttys |
141 | */ | |
142 | struct lxc_tty_info { | |
143 | int nbtty; | |
99a04585 | 144 | struct lxc_terminal_info *pty_info; |
b0a33c1e | 145 | }; |
146 | ||
b5159817 DE |
147 | struct lxc_tty_state; |
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 { | |
b06b8511 CS |
167 | LXC_AUTO_PROC_RW = 0x001, /* /proc read-write */ |
168 | LXC_AUTO_PROC_MIXED = 0x002, /* /proc/sys and /proc/sysrq-trigger read-only */ | |
169 | LXC_AUTO_PROC_MASK = 0x003, | |
170 | ||
171 | LXC_AUTO_SYS_RW = 0x004, /* /sys */ | |
172 | LXC_AUTO_SYS_RO = 0x008, /* /sys read-only */ | |
f24a52d5 | 173 | LXC_AUTO_SYS_MIXED = 0x00C, /* /sys read-only and /sys/class/net read-write */ |
b06b8511 CS |
174 | LXC_AUTO_SYS_MASK = 0x00C, |
175 | ||
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) */ | |
0769b82a CS |
182 | /* These are defined in such a way as to retain |
183 | * binary compatibility with earlier versions of | |
184 | * this code. If the previous mask is applied, | |
185 | * both of these will default back to the _MIXED | |
186 | * variants, which is safe. */ | |
187 | LXC_AUTO_CGROUP_NOSPEC = 0x0B0, /* /sys/fs/cgroup (partial mount, r/w or mixed, depending on caps) */ | |
188 | LXC_AUTO_CGROUP_FULL_NOSPEC = 0x0E0, /* /sys/fs/cgroup (full mount, r/w or mixed, depending on caps) */ | |
3f69fb12 SY |
189 | LXC_AUTO_CGROUP_FORCE = 0x100, /* mount cgroups even when cgroup namespaces are supported */ |
190 | LXC_AUTO_CGROUP_MASK = 0x1F0, /* all known cgroup options, doe not contain LXC_AUTO_CGROUP_FORCE */ | |
191 | LXC_AUTO_ALL_MASK = 0x1FF, /* all known settings */ | |
368bbc02 CS |
192 | }; |
193 | ||
571e6ec8 DL |
194 | /* |
195 | * Defines the global container configuration | |
63376d7d | 196 | * @rootfs : root directory to run the container |
63376d7d DL |
197 | * @mount : list of mount points |
198 | * @tty : numbers of tty | |
199 | * @pts : new pts instance | |
200 | * @mount_list : list of mount point (alternative to fstab file) | |
201 | * @network : network configuration | |
202 | * @utsname : container utsname | |
203 | * @fstab : path to a fstab file format | |
1fb86a7c SH |
204 | * @caps : list of the capabilities to drop |
205 | * @keepcaps : list of the capabilities to keep | |
63376d7d DL |
206 | * @tty_info : tty data |
207 | * @console : console data | |
7c6ef2a2 | 208 | * @ttydir : directory (under /dev) in which to create console and ttys |
fe4de9a6 DE |
209 | * @lsm_aa_profile : apparmor profile to switch to or NULL |
210 | * @lsm_se_context : selinux type to switch to or NULL | |
571e6ec8 | 211 | */ |
26ddeedd | 212 | enum lxchooks { |
1a0e70ac CB |
213 | LXCHOOK_PRESTART, |
214 | LXCHOOK_PREMOUNT, | |
215 | LXCHOOK_MOUNT, | |
216 | LXCHOOK_AUTODEV, | |
217 | LXCHOOK_START, | |
218 | LXCHOOK_STOP, | |
219 | LXCHOOK_POSTSTOP, | |
220 | LXCHOOK_CLONE, | |
221 | LXCHOOK_DESTROY, | |
08dd2805 | 222 | LXCHOOK_START_HOST, |
1a0e70ac CB |
223 | NUM_LXC_HOOKS |
224 | }; | |
72d0e1cb | 225 | |
811ef482 | 226 | extern char *lxchook_names[NUM_LXC_HOOKS]; |
7b35f3d6 | 227 | |
d39b10eb CB |
228 | struct lxc_state_client { |
229 | int clientfd; | |
230 | lxc_state_t states[MAX_STATE]; | |
231 | }; | |
232 | ||
571e6ec8 | 233 | struct lxc_conf { |
37903589 | 234 | int is_execute; |
571e6ec8 | 235 | char *fstab; |
1c30b4ad | 236 | unsigned int tty; |
17919969 | 237 | unsigned int pts; |
91480a0f | 238 | int reboot; |
9b8e3c96 | 239 | signed long personality; |
571e6ec8 | 240 | struct utsname *utsname; |
54860ed0 CB |
241 | struct { |
242 | struct lxc_list cgroup; | |
243 | struct lxc_list cgroup2; | |
244 | }; | |
46ad64ab CB |
245 | struct { |
246 | struct lxc_list id_map; | |
c7e345ae | 247 | |
46ad64ab CB |
248 | /* Pointer to the idmap entry for the container's root uid in |
249 | * the id_map list. Do not free! */ | |
250 | struct id_map *root_nsuid_map; | |
c7e345ae | 251 | |
46ad64ab CB |
252 | /* Pointer to the idmap entry for the container's root gid in |
253 | * the id_map list. Do not free! */ | |
254 | struct id_map *root_nsgid_map; | |
255 | }; | |
5f4535a3 | 256 | struct lxc_list network; |
368bbc02 | 257 | int auto_mounts; |
e7938e9e | 258 | struct lxc_list mount_list; |
81810dd1 | 259 | struct lxc_list caps; |
1fb86a7c | 260 | struct lxc_list keepcaps; |
571e6ec8 | 261 | struct lxc_tty_info tty_info; |
fe1c5887 CB |
262 | /* Comma-separated list of lxc.tty.max pty names. */ |
263 | char *pty_names; | |
dcad02f8 | 264 | struct lxc_terminal console; |
33fcb7a0 | 265 | struct lxc_rootfs rootfs; |
7c6ef2a2 | 266 | char *ttydir; |
b119f362 | 267 | int close_all_fds; |
44ae0fb6 CB |
268 | |
269 | struct { | |
270 | unsigned int hooks_version; | |
271 | struct lxc_list hooks[NUM_LXC_HOOKS]; | |
272 | }; | |
4a85ce2a | 273 | |
fe4de9a6 | 274 | char *lsm_aa_profile; |
a56e2df9 | 275 | unsigned int lsm_aa_allow_incomplete; |
fe4de9a6 | 276 | char *lsm_se_context; |
5112cd70 | 277 | int tmp_umount_proc; |
1a0e70ac | 278 | char *seccomp; /* filename with the seccomp rules */ |
769872f9 | 279 | #if HAVE_SCMP_FILTER_CTX |
d58c6ad0 | 280 | scmp_filter_ctx seccomp_ctx; |
769872f9 | 281 | #endif |
72d0e1cb | 282 | int maincmd_fd; |
1a0e70ac CB |
283 | unsigned int autodev; /* if 1, mount and fill a /dev at start */ |
284 | int haltsignal; /* signal used to halt container */ | |
285 | int rebootsignal; /* signal used to reboot container */ | |
286 | int stopsignal; /* signal used to hard stop container */ | |
287 | char *rcfile; /* Copy of the top level rcfile we read */ | |
288 | ||
289 | /* Logfile and logleve can be set in a container config file. Those | |
290 | * function as defaults. The defaults can be overriden by command line. | |
291 | * However we don't want the command line specified values to be saved | |
292 | * on c->save_config(). So we store the config file specified values | |
293 | * here. */ | |
294 | char *logfile; /* the logfile as specifed in config */ | |
295 | int loglevel; /* loglevel as specifed in config (if any) */ | |
858377e4 | 296 | int logfd; |
9f30a190 | 297 | |
3590152f CB |
298 | unsigned int start_auto; |
299 | unsigned int start_delay; | |
ee1e7aa0 SG |
300 | int start_order; |
301 | struct lxc_list groups; | |
76a26f55 | 302 | int nbd_idx; |
35120d9c | 303 | |
a8dfe4e0 | 304 | /* unshare the mount namespace in the monitor */ |
226dc30e | 305 | unsigned int monitor_unshare; |
a8dfe4e0 | 306 | |
35120d9c SH |
307 | /* set to true when rootfs has been setup */ |
308 | bool rootfs_setup; | |
f979ac15 SH |
309 | |
310 | /* list of included files */ | |
311 | struct lxc_list includes; | |
4184c3e1 SH |
312 | /* config entries which are not "lxc.*" are aliens */ |
313 | struct lxc_list aliens; | |
7c661726 MP |
314 | |
315 | /* list of environment variables we'll add to the container when | |
316 | * started */ | |
317 | struct lxc_list environment; | |
6b0d5538 SH |
318 | |
319 | /* text representation of the config file */ | |
320 | char *unexpanded_config; | |
321 | size_t unexpanded_len, unexpanded_alloced; | |
67c660d0 | 322 | |
5cda27c1 SH |
323 | /* default command for lxc-execute */ |
324 | char *execute_cmd; | |
325 | ||
67c660d0 SG |
326 | /* init command */ |
327 | char *init_cmd; | |
56f8ff00 | 328 | |
72bb04e4 PT |
329 | /* if running in a new user namespace, the UID/GID that init and COMMAND |
330 | * should run under when using lxc-execute */ | |
c5cd20ce PT |
331 | uid_t init_uid; |
332 | gid_t init_gid; | |
8796becf CB |
333 | |
334 | /* indicator if the container will be destroyed on shutdown */ | |
66ffdb1a | 335 | unsigned int ephemeral; |
76d0127f CB |
336 | |
337 | /* The facility to pass to syslog. Let's users establish as what type of | |
338 | * program liblxc is supposed to write to the syslog. */ | |
339 | char *syslog; | |
5a46f283 CB |
340 | |
341 | /* Whether PR_SET_NO_NEW_PRIVS will be set for the container. */ | |
342 | bool no_new_privs; | |
c6d09e15 WB |
343 | |
344 | /* RLIMIT_* limits */ | |
345 | struct lxc_list limits; | |
7ec2e32a | 346 | |
43654d34 CB |
347 | /* Contains generic info about the cgroup configuration for this |
348 | * container. Note that struct lxc_cgroup contains a union. It is only | |
349 | * valid to access the members of the anonymous "meta" struct within | |
350 | * that union. | |
351 | */ | |
352 | struct lxc_cgroup cgroup_meta; | |
28d9e29e | 353 | |
b074bbf1 | 354 | struct { |
1d8d3676 | 355 | int ns_clone; |
abeb5bba | 356 | int ns_keep; |
b074bbf1 CB |
357 | char *ns_share[LXC_NS_MAX]; |
358 | }; | |
3c491553 L |
359 | |
360 | /* init working directory */ | |
9e132956 | 361 | char *init_cwd; |
3c491553 | 362 | |
d39b10eb CB |
363 | /* A list of clients registered to be informed about a container state. */ |
364 | struct lxc_list state_clients; | |
7edd0540 L |
365 | |
366 | /* sysctls */ | |
367 | struct lxc_list sysctls; | |
61d7a733 YT |
368 | |
369 | /* procs */ | |
370 | struct lxc_list procs; | |
571e6ec8 DL |
371 | }; |
372 | ||
a19b974f | 373 | extern int write_id_mapping(enum idtype idtype, pid_t pid, const char *buf, |
344c9d81 MPS |
374 | size_t buf_size); |
375 | ||
858377e4 SH |
376 | #ifdef HAVE_TLS |
377 | extern __thread struct lxc_conf *current_config; | |
378 | #else | |
379 | extern struct lxc_conf *current_config; | |
380 | #endif | |
381 | ||
1a0e70ac | 382 | extern int run_lxc_hooks(const char *name, char *hook, struct lxc_conf *conf, |
14a7b0f9 | 383 | char *argv[]); |
cc28d0b0 | 384 | extern int detect_shared_rootfs(void); |
7b379ab3 | 385 | extern struct lxc_conf *lxc_conf_init(void); |
8eb5694b | 386 | extern void lxc_conf_free(struct lxc_conf *conf); |
0c547523 | 387 | extern int pin_rootfs(const char *rootfs); |
f6d3e3e4 | 388 | extern int lxc_map_ids(struct lxc_list *idmap, pid_t pid); |
5e4a62bf | 389 | extern int lxc_create_tty(const char *name, struct lxc_conf *conf); |
b0a33c1e | 390 | extern void lxc_delete_tty(struct lxc_tty_info *tty_info); |
72d0e1cb | 391 | extern int lxc_clear_config_caps(struct lxc_conf *c); |
1fb86a7c | 392 | extern int lxc_clear_config_keepcaps(struct lxc_conf *c); |
54860ed0 | 393 | extern int lxc_clear_cgroups(struct lxc_conf *c, const char *key, int version); |
72d0e1cb | 394 | extern int lxc_clear_mount_entries(struct lxc_conf *c); |
b099e9e9 | 395 | extern int lxc_clear_automounts(struct lxc_conf *c); |
12a50cc6 | 396 | extern int lxc_clear_hooks(struct lxc_conf *c, const char *key); |
7d0eb87e | 397 | extern int lxc_clear_idmaps(struct lxc_conf *c); |
ee1e7aa0 | 398 | extern int lxc_clear_groups(struct lxc_conf *c); |
ab799c0b | 399 | extern int lxc_clear_environment(struct lxc_conf *c); |
c6d09e15 | 400 | extern int lxc_clear_limits(struct lxc_conf *c, const char *key); |
f0d02950 | 401 | extern int lxc_delete_autodev(struct lxc_handler *handler); |
c7b15d1e | 402 | extern void lxc_clear_includes(struct lxc_conf *conf); |
35120d9c SH |
403 | extern int do_rootfs_setup(struct lxc_conf *conf, const char *name, |
404 | const char *lxcpath); | |
3b988b33 | 405 | extern int lxc_setup(struct lxc_handler *handler); |
732375f5 | 406 | extern int lxc_setup_parent(struct lxc_handler *handler); |
c6d09e15 | 407 | extern int setup_resource_limits(struct lxc_list *limits, pid_t pid); |
339efad9 | 408 | extern int find_unmapped_nsid(struct lxc_conf *conf, enum idtype idtype); |
1a0e70ac CB |
409 | extern int mapped_hostid(unsigned id, struct lxc_conf *conf, |
410 | enum idtype idtype); | |
41dc7155 | 411 | extern int chown_mapped_root(const char *path, struct lxc_conf *conf); |
c9b7c33e CB |
412 | extern int userns_exec_1(struct lxc_conf *conf, int (*fn)(void *), void *data, |
413 | const char *fn_name); | |
415a8851 CB |
414 | extern int userns_exec_full(struct lxc_conf *conf, int (*fn)(void *), |
415 | void *data, const char *fn_name); | |
a17b1e65 SG |
416 | extern int parse_mntopts(const char *mntopts, unsigned long *mntflags, |
417 | char **mntdata); | |
5112cd70 | 418 | extern void tmp_proc_unmount(struct lxc_conf *lxc_conf); |
1a0e70ac | 419 | extern void remount_all_slave(void); |
97e9cfa0 | 420 | extern void suggest_default_idmap(void); |
1a0e70ac CB |
421 | extern FILE *make_anonymous_mount_file(struct lxc_list *mount); |
422 | extern struct lxc_list *sort_cgroup_settings(struct lxc_list *cgroup_settings); | |
423 | extern unsigned long add_required_remount_flags(const char *s, const char *d, | |
424 | unsigned long flags); | |
811ef482 CB |
425 | extern int run_script(const char *name, const char *section, const char *script, |
426 | ...); | |
14a7b0f9 CB |
427 | extern int run_script_argv(const char *name, unsigned int hook_version, |
428 | const char *section, const char *script, | |
429 | const char *hookname, char **argsin); | |
b635e92d | 430 | extern int in_caplist(int cap, struct lxc_list *caps); |
7edd0540 L |
431 | extern int setup_sysctl_parameters(struct lxc_list *sysctls); |
432 | extern int lxc_clear_sysctls(struct lxc_conf *c, const char *key); | |
61d7a733 YT |
433 | extern int setup_proc_filesystem(struct lxc_list *procs, pid_t pid); |
434 | extern int lxc_clear_procs(struct lxc_conf *c, const char *key); | |
5ae72b98 | 435 | |
1a0e70ac | 436 | #endif /* __LXC_CONF_H */ |