]> git.proxmox.com Git - mirror_lxc.git/blame - src/lxc/conf.h
Merge pull request #1836 from lifeng68/ns_share_pid
[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
ÇO
38#include "list.h"
39#include "start.h" /* for lxc_handler */
e3b4c4c4 40
769872f9
SH
41#if HAVE_SCMP_FILTER_CTX
42typedef void * scmp_filter_ctx;
43#endif
44
97e9cfa0
SH
45/* worth moving to configure.ac? */
46#define subuidfile "/etc/subuid"
47#define subgidfile "/etc/subgid"
48
0ad19a3f 49/*
43654d34
CB
50 * Defines a generic struct to configure the control group. It is up to the
51 * programmer to specify the right subsystem.
ec64264d 52 * @subsystem : the targeted subsystem
576f946d 53 * @value : the value to set
43654d34
CB
54 *
55 * @controllers : The controllers to use for this container.
56 * @dir : The name of the directory containing the container's cgroup.
57 * Not that this is a per-container setting.
0ad19a3f 58 */
59struct lxc_cgroup {
43654d34
CB
60 union {
61 /* information about a specific controller */
62 struct /* controller */ {
63 char *subsystem;
64 char *value;
65 };
66
67 /* meta information about cgroup configuration */
68 struct /* meta */ {
69 char *controllers;
70 char *dir;
71 };
72 };
0ad19a3f 73};
74
c6d09e15
WB
75#if !HAVE_SYS_RESOURCE_H
76# define RLIM_INFINITY ((unsigned long)-1)
77struct rlimit {
78 unsigned long rlim_cur;
79 unsigned long rlim_max;
80};
81#endif
82/*
83 * Defines a structure to configure resource limits to set via setrlimit().
84 * @resource : the resource name in lowercase without the RLIMIT_ prefix
85 * @limit : the limit to set
86 */
87struct lxc_limit {
88 char *resource;
89 struct rlimit limit;
90};
91
f6d3e3e4
SH
92enum idtype {
93 ID_TYPE_UID,
94 ID_TYPE_GID
95};
96
97/*
98 * id_map is an id map entry. Form in confile is:
bdcbb6b3
CB
99 * lxc.idmap = u 0 9800 100
100 * lxc.idmap = u 1000 9900 100
101 * lxc.idmap = g 0 9800 100
102 * lxc.idmap = g 1000 9900 100
251d0d2a
DE
103 * meaning the container can use uids and gids 0-99 and 1000-1099,
104 * with [ug]id 0 mapping to [ug]id 9800 on the host, and [ug]id 1000 to
105 * [ug]id 9900 on the host.
f6d3e3e4
SH
106 */
107struct id_map {
108 enum idtype idtype;
251d0d2a 109 unsigned long hostid, nsid, range;
f6d3e3e4
SH
110};
111
b0a33c1e 112/*
113 * Defines a structure containing a pty information for
114 * virtualizing a tty
115 * @name : the path name of the slave pty side
116 * @master : the file descriptor of the master
117 * @slave : the file descriptor of the slave
118 */
119struct lxc_pty_info {
120 char name[MAXPATHLEN];
121 int master;
122 int slave;
123 int busy;
124};
125
126/*
127 * Defines the number of tty configured and contains the
a589434e 128 * instantiated ptys
b0a33c1e 129 * @nbtty = number of configured ttys
130 */
131struct lxc_tty_info {
132 int nbtty;
133 struct lxc_pty_info *pty_info;
134};
135
b5159817
DE
136struct lxc_tty_state;
137
63376d7d
DL
138/*
139 * Defines the structure to store the console information
140 * @peer : the file descriptor put/get console traffic
141 * @name : the file name of the slave pty
142 */
143struct lxc_console {
144 int slave;
145 int master;
146 int peer;
b5159817
DE
147 struct lxc_pty_info peerpty;
148 struct lxc_epoll_descr *descr;
28a4b0e5 149 char *path;
596a818d
DE
150 char *log_path;
151 int log_fd;
63376d7d 152 char name[MAXPATHLEN];
e0dc0de7 153 struct termios *tios;
b5159817 154 struct lxc_tty_state *tty_state;
63376d7d
DL
155};
156
33fcb7a0
DL
157/*
158 * Defines a structure to store the rootfs location, the
159 * optionals pivot_root, rootfs mount paths
59bb8698
SH
160 * @path : the rootfs source (directory or device)
161 * @mount : where it is mounted
162 * @options : mount options
b3b8c97f 163 * @bev_type : optional backing store type
33fcb7a0
DL
164 */
165struct lxc_rootfs {
166 char *path;
23b7ea69 167 char *mount;
a17b1e65 168 char *options;
b3b8c97f 169 char *bdev_type;
33fcb7a0
DL
170};
171
368bbc02
CS
172/*
173 * Automatic mounts for LXC to perform inside the container
174 */
175enum {
b06b8511
CS
176 LXC_AUTO_PROC_RW = 0x001, /* /proc read-write */
177 LXC_AUTO_PROC_MIXED = 0x002, /* /proc/sys and /proc/sysrq-trigger read-only */
178 LXC_AUTO_PROC_MASK = 0x003,
179
180 LXC_AUTO_SYS_RW = 0x004, /* /sys */
181 LXC_AUTO_SYS_RO = 0x008, /* /sys read-only */
f24a52d5 182 LXC_AUTO_SYS_MIXED = 0x00C, /* /sys read-only and /sys/class/net read-write */
b06b8511
CS
183 LXC_AUTO_SYS_MASK = 0x00C,
184
185 LXC_AUTO_CGROUP_RO = 0x010, /* /sys/fs/cgroup (partial mount, read-only) */
186 LXC_AUTO_CGROUP_RW = 0x020, /* /sys/fs/cgroup (partial mount, read-write) */
187 LXC_AUTO_CGROUP_MIXED = 0x030, /* /sys/fs/cgroup (partial mount, paths r/o, cgroup r/w) */
188 LXC_AUTO_CGROUP_FULL_RO = 0x040, /* /sys/fs/cgroup (full mount, read-only) */
189 LXC_AUTO_CGROUP_FULL_RW = 0x050, /* /sys/fs/cgroup (full mount, read-write) */
190 LXC_AUTO_CGROUP_FULL_MIXED = 0x060, /* /sys/fs/cgroup (full mount, parent r/o, own r/w) */
0769b82a
CS
191 /* These are defined in such a way as to retain
192 * binary compatibility with earlier versions of
193 * this code. If the previous mask is applied,
194 * both of these will default back to the _MIXED
195 * variants, which is safe. */
196 LXC_AUTO_CGROUP_NOSPEC = 0x0B0, /* /sys/fs/cgroup (partial mount, r/w or mixed, depending on caps) */
197 LXC_AUTO_CGROUP_FULL_NOSPEC = 0x0E0, /* /sys/fs/cgroup (full mount, r/w or mixed, depending on caps) */
198 LXC_AUTO_CGROUP_MASK = 0x0F0,
b06b8511 199
0769b82a 200 LXC_AUTO_ALL_MASK = 0x0FF, /* all known settings */
368bbc02
CS
201};
202
571e6ec8
DL
203/*
204 * Defines the global container configuration
63376d7d 205 * @rootfs : root directory to run the container
63376d7d
DL
206 * @mount : list of mount points
207 * @tty : numbers of tty
208 * @pts : new pts instance
209 * @mount_list : list of mount point (alternative to fstab file)
210 * @network : network configuration
211 * @utsname : container utsname
212 * @fstab : path to a fstab file format
1fb86a7c
SH
213 * @caps : list of the capabilities to drop
214 * @keepcaps : list of the capabilities to keep
63376d7d
DL
215 * @tty_info : tty data
216 * @console : console data
7c6ef2a2 217 * @ttydir : directory (under /dev) in which to create console and ttys
fe4de9a6
DE
218 * @lsm_aa_profile : apparmor profile to switch to or NULL
219 * @lsm_se_context : selinux type to switch to or NULL
571e6ec8 220 */
26ddeedd 221enum lxchooks {
1a0e70ac
CB
222 LXCHOOK_PRESTART,
223 LXCHOOK_PREMOUNT,
224 LXCHOOK_MOUNT,
225 LXCHOOK_AUTODEV,
226 LXCHOOK_START,
227 LXCHOOK_STOP,
228 LXCHOOK_POSTSTOP,
229 LXCHOOK_CLONE,
230 LXCHOOK_DESTROY,
231 NUM_LXC_HOOKS
232};
72d0e1cb 233
811ef482 234extern char *lxchook_names[NUM_LXC_HOOKS];
7b35f3d6 235
571e6ec8 236struct lxc_conf {
37903589 237 int is_execute;
571e6ec8 238 char *fstab;
1c30b4ad 239 unsigned int tty;
17919969 240 unsigned int pts;
91480a0f 241 int reboot;
9b8e3c96 242 signed long personality;
571e6ec8
DL
243 struct utsname *utsname;
244 struct lxc_list cgroup;
f6d3e3e4 245 struct lxc_list id_map;
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;
571e6ec8 251 struct lxc_tty_info tty_info;
fe1c5887
CB
252 /* Comma-separated list of lxc.tty.max pty names. */
253 char *pty_names;
63376d7d 254 struct lxc_console console;
33fcb7a0 255 struct lxc_rootfs rootfs;
7c6ef2a2 256 char *ttydir;
b119f362 257 int close_all_fds;
26ddeedd 258 struct lxc_list hooks[NUM_LXC_HOOKS];
4a85ce2a 259
fe4de9a6 260 char *lsm_aa_profile;
a56e2df9 261 unsigned int lsm_aa_allow_incomplete;
fe4de9a6 262 char *lsm_se_context;
5112cd70 263 int tmp_umount_proc;
1a0e70ac 264 char *seccomp; /* filename with the seccomp rules */
769872f9 265#if HAVE_SCMP_FILTER_CTX
d58c6ad0 266 scmp_filter_ctx seccomp_ctx;
769872f9 267#endif
72d0e1cb 268 int maincmd_fd;
1a0e70ac
CB
269 unsigned int autodev; /* if 1, mount and fill a /dev at start */
270 int haltsignal; /* signal used to halt container */
271 int rebootsignal; /* signal used to reboot container */
272 int stopsignal; /* signal used to hard stop container */
273 char *rcfile; /* Copy of the top level rcfile we read */
274
275 /* Logfile and logleve can be set in a container config file. Those
276 * function as defaults. The defaults can be overriden by command line.
277 * However we don't want the command line specified values to be saved
278 * on c->save_config(). So we store the config file specified values
279 * here. */
280 char *logfile; /* the logfile as specifed in config */
281 int loglevel; /* loglevel as specifed in config (if any) */
858377e4 282 int logfd;
9f30a190
MM
283
284 int inherit_ns_fd[LXC_NS_MAX];
ee1e7aa0 285
3590152f
CB
286 unsigned int start_auto;
287 unsigned int start_delay;
ee1e7aa0
SG
288 int start_order;
289 struct lxc_list groups;
76a26f55 290 int nbd_idx;
35120d9c 291
a8dfe4e0 292 /* unshare the mount namespace in the monitor */
226dc30e 293 unsigned int monitor_unshare;
a8dfe4e0 294
35120d9c
SH
295 /* set to true when rootfs has been setup */
296 bool rootfs_setup;
f979ac15
SH
297
298 /* list of included files */
299 struct lxc_list includes;
4184c3e1
SH
300 /* config entries which are not "lxc.*" are aliens */
301 struct lxc_list aliens;
7c661726
MP
302
303 /* list of environment variables we'll add to the container when
304 * started */
305 struct lxc_list environment;
6b0d5538
SH
306
307 /* text representation of the config file */
308 char *unexpanded_config;
309 size_t unexpanded_len, unexpanded_alloced;
67c660d0
SG
310
311 /* init command */
312 char *init_cmd;
56f8ff00 313
72bb04e4
PT
314 /* if running in a new user namespace, the UID/GID that init and COMMAND
315 * should run under when using lxc-execute */
c5cd20ce
PT
316 uid_t init_uid;
317 gid_t init_gid;
8796becf
CB
318
319 /* indicator if the container will be destroyed on shutdown */
66ffdb1a 320 unsigned int ephemeral;
76d0127f
CB
321
322 /* The facility to pass to syslog. Let's users establish as what type of
323 * program liblxc is supposed to write to the syslog. */
324 char *syslog;
5a46f283
CB
325
326 /* Whether PR_SET_NO_NEW_PRIVS will be set for the container. */
327 bool no_new_privs;
c6d09e15
WB
328
329 /* RLIMIT_* limits */
330 struct lxc_list limits;
7ec2e32a
CB
331
332 /* REMOVE IN LXC 3.0
333 * Indicator whether the current config file we're using contained any
334 * legacy configuration keys.
335 */
336 bool contains_legacy_key;
43654d34
CB
337
338 /* Contains generic info about the cgroup configuration for this
339 * container. Note that struct lxc_cgroup contains a union. It is only
340 * valid to access the members of the anonymous "meta" struct within
341 * that union.
342 */
343 struct lxc_cgroup cgroup_meta;
571e6ec8
DL
344};
345
858377e4
SH
346#ifdef HAVE_TLS
347extern __thread struct lxc_conf *current_config;
348#else
349extern struct lxc_conf *current_config;
350#endif
351
1a0e70ac
CB
352extern int run_lxc_hooks(const char *name, char *hook, struct lxc_conf *conf,
353 const char *lxcpath, char *argv[]);
cc28d0b0 354extern int detect_shared_rootfs(void);
7b379ab3 355extern struct lxc_conf *lxc_conf_init(void);
8eb5694b 356extern void lxc_conf_free(struct lxc_conf *conf);
0c547523 357extern int pin_rootfs(const char *rootfs);
f6d3e3e4 358extern int lxc_map_ids(struct lxc_list *idmap, pid_t pid);
5e4a62bf 359extern int lxc_create_tty(const char *name, struct lxc_conf *conf);
b0a33c1e 360extern void lxc_delete_tty(struct lxc_tty_info *tty_info);
72d0e1cb 361extern int lxc_clear_config_caps(struct lxc_conf *c);
1fb86a7c 362extern int lxc_clear_config_keepcaps(struct lxc_conf *c);
12a50cc6 363extern int lxc_clear_cgroups(struct lxc_conf *c, const char *key);
72d0e1cb 364extern int lxc_clear_mount_entries(struct lxc_conf *c);
b099e9e9 365extern int lxc_clear_automounts(struct lxc_conf *c);
12a50cc6 366extern int lxc_clear_hooks(struct lxc_conf *c, const char *key);
7d0eb87e 367extern int lxc_clear_idmaps(struct lxc_conf *c);
ee1e7aa0 368extern int lxc_clear_groups(struct lxc_conf *c);
ab799c0b 369extern int lxc_clear_environment(struct lxc_conf *c);
c6d09e15 370extern int lxc_clear_limits(struct lxc_conf *c, const char *key);
f0d02950 371extern int lxc_delete_autodev(struct lxc_handler *handler);
c7b15d1e 372extern void lxc_clear_includes(struct lxc_conf *conf);
35120d9c
SH
373extern int do_rootfs_setup(struct lxc_conf *conf, const char *name,
374 const char *lxcpath);
d4ef7c50 375extern int lxc_setup(struct lxc_handler *handler);
c6d09e15 376extern int setup_resource_limits(struct lxc_list *limits, pid_t pid);
339efad9 377extern int find_unmapped_nsid(struct lxc_conf *conf, enum idtype idtype);
1a0e70ac
CB
378extern int mapped_hostid(unsigned id, struct lxc_conf *conf,
379 enum idtype idtype);
c4d10a05 380extern int chown_mapped_root(char *path, struct lxc_conf *conf);
54117de5 381extern int lxc_ttys_shift_ids(struct lxc_conf *c);
c9b7c33e
CB
382extern int userns_exec_1(struct lxc_conf *conf, int (*fn)(void *), void *data,
383 const char *fn_name);
415a8851
CB
384extern int userns_exec_full(struct lxc_conf *conf, int (*fn)(void *),
385 void *data, const char *fn_name);
a17b1e65
SG
386extern int parse_mntopts(const char *mntopts, unsigned long *mntflags,
387 char **mntdata);
5112cd70 388extern void tmp_proc_unmount(struct lxc_conf *lxc_conf);
1a0e70ac 389extern void remount_all_slave(void);
97e9cfa0 390extern void suggest_default_idmap(void);
1a0e70ac
CB
391extern FILE *make_anonymous_mount_file(struct lxc_list *mount);
392extern struct lxc_list *sort_cgroup_settings(struct lxc_list *cgroup_settings);
393extern unsigned long add_required_remount_flags(const char *s, const char *d,
394 unsigned long flags);
811ef482
CB
395extern int run_script(const char *name, const char *section, const char *script,
396 ...);
5ae72b98 397
1a0e70ac 398#endif /* __LXC_CONF_H */