]> git.proxmox.com Git - mirror_lxc.git/blame - src/lxc/conf.h
Clarify struct field comment
[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>
0ad19a3f 29#include <netinet/in.h>
74a2b586 30#include <net/if.h>
b0a33c1e 31#include <sys/param.h>
8173e600 32#include <sys/types.h>
19a26f82 33#include <stdbool.h>
0ad19a3f 34
f2363e38
ÇO
35#include "list.h"
36#include "start.h" /* for lxc_handler */
e3b4c4c4 37
769872f9
SH
38#if HAVE_SCMP_FILTER_CTX
39typedef void * scmp_filter_ctx;
40#endif
41
97e9cfa0
SH
42/* worth moving to configure.ac? */
43#define subuidfile "/etc/subuid"
44#define subgidfile "/etc/subgid"
45
13954cce 46enum {
24654103
DL
47 LXC_NET_EMPTY,
48 LXC_NET_VETH,
49 LXC_NET_MACVLAN,
50 LXC_NET_PHYS,
51 LXC_NET_VLAN,
26b797f3 52 LXC_NET_NONE,
24654103 53 LXC_NET_MAXCONFTYPE,
0ad19a3f 54};
55
56/*
57 * Defines the structure to configure an ipv4 address
58 * @address : ipv4 address
59 * @broadcast : ipv4 broadcast address
60 * @mask : network mask
61 */
62struct lxc_inetdev {
63 struct in_addr addr;
64 struct in_addr bcast;
65 int prefix;
66};
67
68struct lxc_route {
69 struct in_addr addr;
70};
71
72/*
73 * Defines the structure to configure an ipv6 address
74 * @flags : set the address up
75 * @address : ipv6 address
76 * @broadcast : ipv6 broadcast address
77 * @mask : network mask
78 */
79struct lxc_inet6dev {
80 struct in6_addr addr;
0093bb8c 81 struct in6_addr mcast;
0ad19a3f 82 struct in6_addr acast;
83 int prefix;
84};
85
86struct lxc_route6 {
87 struct in6_addr addr;
88};
26c39028 89
e892973e
DL
90struct ifla_veth {
91 char *pair; /* pair name */
74a2b586 92 char veth1[IFNAMSIZ]; /* needed for deconf */
e892973e
DL
93};
94
26c39028 95struct ifla_vlan {
85dce4a5
NC
96 unsigned int flags;
97 unsigned int fmask;
7c11d57a
SG
98 unsigned short vid;
99 unsigned short pad;
26c39028
JHS
100};
101
e892973e 102struct ifla_macvlan {
99854161 103 int mode; /* private, vepa, bridge, passthru */
e892973e
DL
104};
105
f6cc1de1 106union netdev_p {
e892973e 107 struct ifla_veth veth_attr;
f6cc1de1 108 struct ifla_vlan vlan_attr;
e892973e 109 struct ifla_macvlan macvlan_attr;
f6cc1de1
JHS
110};
111
0ad19a3f 112/*
113 * Defines a structure to configure a network device
e3b4c4c4
ST
114 * @link : lxc.network.link, name of bridge or host iface to attach if any
115 * @name : lxc.network.name, name of iface on the container side
116 * @flags : flag of the network device (IFF_UP, ... )
117 * @ipv4 : a list of ipv4 addresses to be set on the network device
118 * @ipv6 : a list of ipv6 addresses to be set on the network device
119 * @upscript : a script filename to be executed during interface configuration
74a2b586 120 * @downscript : a script filename to be executed during interface destruction
0ad19a3f 121 */
122struct lxc_netdev {
5f4535a3 123 int type;
0ad19a3f 124 int flags;
82d5ae15 125 int ifindex;
9d083402
MT
126 char *link;
127 char *name;
0ad19a3f 128 char *hwaddr;
442cbbe6 129 char *mtu;
f6cc1de1 130 union netdev_p priv;
0ad19a3f 131 struct lxc_list ipv4;
132 struct lxc_list ipv6;
f8fee0e2 133 struct in_addr *ipv4_gateway;
19a26f82 134 bool ipv4_gateway_auto;
f8fee0e2 135 struct in6_addr *ipv6_gateway;
19a26f82 136 bool ipv6_gateway_auto;
e3b4c4c4 137 char *upscript;
74a2b586 138 char *downscript;
0ad19a3f 139};
140
141/*
576f946d 142 * Defines a generic struct to configure the control group.
143 * It is up to the programmer to specify the right subsystem.
ec64264d 144 * @subsystem : the targeted subsystem
576f946d 145 * @value : the value to set
0ad19a3f 146 */
147struct lxc_cgroup {
576f946d 148 char *subsystem;
149 char *value;
0ad19a3f 150};
151
f6d3e3e4
SH
152enum idtype {
153 ID_TYPE_UID,
154 ID_TYPE_GID
155};
156
157/*
158 * id_map is an id map entry. Form in confile is:
251d0d2a
DE
159 * lxc.id_map = u 0 9800 100
160 * lxc.id_map = u 1000 9900 100
161 * lxc.id_map = g 0 9800 100
162 * lxc.id_map = g 1000 9900 100
163 * meaning the container can use uids and gids 0-99 and 1000-1099,
164 * with [ug]id 0 mapping to [ug]id 9800 on the host, and [ug]id 1000 to
165 * [ug]id 9900 on the host.
f6d3e3e4
SH
166 */
167struct id_map {
168 enum idtype idtype;
251d0d2a 169 unsigned long hostid, nsid, range;
f6d3e3e4
SH
170};
171
b0a33c1e 172/*
173 * Defines a structure containing a pty information for
174 * virtualizing a tty
175 * @name : the path name of the slave pty side
176 * @master : the file descriptor of the master
177 * @slave : the file descriptor of the slave
178 */
179struct lxc_pty_info {
180 char name[MAXPATHLEN];
181 int master;
182 int slave;
183 int busy;
184};
185
186/*
187 * Defines the number of tty configured and contains the
a589434e 188 * instantiated ptys
b0a33c1e 189 * @nbtty = number of configured ttys
190 */
191struct lxc_tty_info {
192 int nbtty;
193 struct lxc_pty_info *pty_info;
194};
195
b5159817
DE
196struct lxc_tty_state;
197
63376d7d
DL
198/*
199 * Defines the structure to store the console information
200 * @peer : the file descriptor put/get console traffic
201 * @name : the file name of the slave pty
202 */
203struct lxc_console {
204 int slave;
205 int master;
206 int peer;
b5159817
DE
207 struct lxc_pty_info peerpty;
208 struct lxc_epoll_descr *descr;
28a4b0e5 209 char *path;
596a818d
DE
210 char *log_path;
211 int log_fd;
63376d7d 212 char name[MAXPATHLEN];
e0dc0de7 213 struct termios *tios;
b5159817 214 struct lxc_tty_state *tty_state;
63376d7d
DL
215};
216
33fcb7a0
DL
217/*
218 * Defines a structure to store the rootfs location, the
219 * optionals pivot_root, rootfs mount paths
220 * @rootfs : a path to the rootfs
221 * @pivot_root : a path to a pivot_root location to be used
222 */
223struct lxc_rootfs {
224 char *path;
23b7ea69 225 char *mount;
33fcb7a0 226 char *pivot;
a17b1e65 227 char *options;
33fcb7a0
DL
228};
229
368bbc02
CS
230/*
231 * Automatic mounts for LXC to perform inside the container
232 */
233enum {
b06b8511
CS
234 LXC_AUTO_PROC_RW = 0x001, /* /proc read-write */
235 LXC_AUTO_PROC_MIXED = 0x002, /* /proc/sys and /proc/sysrq-trigger read-only */
236 LXC_AUTO_PROC_MASK = 0x003,
237
238 LXC_AUTO_SYS_RW = 0x004, /* /sys */
239 LXC_AUTO_SYS_RO = 0x008, /* /sys read-only */
f24a52d5 240 LXC_AUTO_SYS_MIXED = 0x00C, /* /sys read-only and /sys/class/net read-write */
b06b8511
CS
241 LXC_AUTO_SYS_MASK = 0x00C,
242
243 LXC_AUTO_CGROUP_RO = 0x010, /* /sys/fs/cgroup (partial mount, read-only) */
244 LXC_AUTO_CGROUP_RW = 0x020, /* /sys/fs/cgroup (partial mount, read-write) */
245 LXC_AUTO_CGROUP_MIXED = 0x030, /* /sys/fs/cgroup (partial mount, paths r/o, cgroup r/w) */
246 LXC_AUTO_CGROUP_FULL_RO = 0x040, /* /sys/fs/cgroup (full mount, read-only) */
247 LXC_AUTO_CGROUP_FULL_RW = 0x050, /* /sys/fs/cgroup (full mount, read-write) */
248 LXC_AUTO_CGROUP_FULL_MIXED = 0x060, /* /sys/fs/cgroup (full mount, parent r/o, own r/w) */
0769b82a
CS
249 /* These are defined in such a way as to retain
250 * binary compatibility with earlier versions of
251 * this code. If the previous mask is applied,
252 * both of these will default back to the _MIXED
253 * variants, which is safe. */
254 LXC_AUTO_CGROUP_NOSPEC = 0x0B0, /* /sys/fs/cgroup (partial mount, r/w or mixed, depending on caps) */
255 LXC_AUTO_CGROUP_FULL_NOSPEC = 0x0E0, /* /sys/fs/cgroup (full mount, r/w or mixed, depending on caps) */
256 LXC_AUTO_CGROUP_MASK = 0x0F0,
b06b8511 257
0769b82a 258 LXC_AUTO_ALL_MASK = 0x0FF, /* all known settings */
368bbc02
CS
259};
260
571e6ec8
DL
261/*
262 * Defines the global container configuration
63376d7d
DL
263 * @rootfs : root directory to run the container
264 * @pivotdir : pivotdir path, if not set default will be used
265 * @mount : list of mount points
266 * @tty : numbers of tty
267 * @pts : new pts instance
268 * @mount_list : list of mount point (alternative to fstab file)
269 * @network : network configuration
270 * @utsname : container utsname
271 * @fstab : path to a fstab file format
1fb86a7c
SH
272 * @caps : list of the capabilities to drop
273 * @keepcaps : list of the capabilities to keep
63376d7d
DL
274 * @tty_info : tty data
275 * @console : console data
7c6ef2a2 276 * @ttydir : directory (under /dev) in which to create console and ttys
fe4de9a6
DE
277 * @lsm_aa_profile : apparmor profile to switch to or NULL
278 * @lsm_se_context : selinux type to switch to or NULL
571e6ec8 279 */
26ddeedd 280enum lxchooks {
f7bee6c6 281 LXCHOOK_PRESTART, LXCHOOK_PREMOUNT, LXCHOOK_MOUNT, LXCHOOK_AUTODEV,
37cf711b
SY
282 LXCHOOK_START, LXCHOOK_POSTSTOP, LXCHOOK_CLONE, LXCHOOK_DESTROY,
283 NUM_LXC_HOOKS};
72d0e1cb
SG
284extern char *lxchook_names[NUM_LXC_HOOKS];
285
7b35f3d6
SH
286struct saved_nic {
287 int ifindex;
288 char *orig_name;
289};
290
571e6ec8 291struct lxc_conf {
37903589 292 int is_execute;
571e6ec8
DL
293 char *fstab;
294 int tty;
295 int pts;
91480a0f 296 int reboot;
828695d9 297 int need_utmp_watch;
9b8e3c96 298 signed long personality;
571e6ec8
DL
299 struct utsname *utsname;
300 struct lxc_list cgroup;
f6d3e3e4 301 struct lxc_list id_map;
5f4535a3 302 struct lxc_list network;
7b35f3d6
SH
303 struct saved_nic *saved_nics;
304 int num_savednics;
368bbc02 305 int auto_mounts;
e7938e9e 306 struct lxc_list mount_list;
81810dd1 307 struct lxc_list caps;
1fb86a7c 308 struct lxc_list keepcaps;
571e6ec8 309 struct lxc_tty_info tty_info;
393903d1 310 char *pty_names; // comma-separated list of lxc.tty pty names
63376d7d 311 struct lxc_console console;
33fcb7a0 312 struct lxc_rootfs rootfs;
7c6ef2a2 313 char *ttydir;
b119f362 314 int close_all_fds;
26ddeedd 315 struct lxc_list hooks[NUM_LXC_HOOKS];
4a85ce2a 316
fe4de9a6 317 char *lsm_aa_profile;
7aff4f43 318 int lsm_aa_allow_incomplete;
fe4de9a6 319 char *lsm_se_context;
5112cd70 320 int tmp_umount_proc;
8f2c3a70 321 char *seccomp; // filename with the seccomp rules
769872f9 322#if HAVE_SCMP_FILTER_CTX
d58c6ad0 323 scmp_filter_ctx seccomp_ctx;
769872f9 324#endif
72d0e1cb 325 int maincmd_fd;
c6883f38 326 int autodev; // if 1, mount and fill a /dev at start
f0f1d8c0 327 int haltsignal; // signal used to halt container
dd267776 328 int rebootsignal; // signal used to reboot container
f0f1d8c0 329 int stopsignal; // signal used to hard stop container
7e0e1d94 330 int kmsg; // if 1, create /dev/kmsg symlink
f7bee6c6 331 char *rcfile; // Copy of the top level rcfile we read
b40a606e
SH
332
333 // Logfile and logleve can be set in a container config file.
334 // Those function as defaults. The defaults can be overriden
335 // by command line. However we don't want the command line
336 // specified values to be saved on c->save_config(). So we
337 // store the config file specified values here.
338 char *logfile; // the logfile as specifed in config
339 int loglevel; // loglevel as specifed in config (if any)
858377e4 340 int logfd;
9f30a190
MM
341
342 int inherit_ns_fd[LXC_NS_MAX];
ee1e7aa0
SG
343
344 int start_auto;
345 int start_delay;
346 int start_order;
347 struct lxc_list groups;
76a26f55 348 int nbd_idx;
35120d9c
SH
349
350 /* set to true when rootfs has been setup */
351 bool rootfs_setup;
f979ac15
SH
352
353 /* list of included files */
354 struct lxc_list includes;
4184c3e1
SH
355 /* config entries which are not "lxc.*" are aliens */
356 struct lxc_list aliens;
7c661726
MP
357
358 /* list of environment variables we'll add to the container when
359 * started */
360 struct lxc_list environment;
6b0d5538
SH
361
362 /* text representation of the config file */
363 char *unexpanded_config;
364 size_t unexpanded_len, unexpanded_alloced;
67c660d0
SG
365
366 /* init command */
367 char *init_cmd;
56f8ff00 368
fd9f399b
PT
369 /* if running in a new user namespace, the UID/GID that COMMAND for
370 * lxc-execute should run under */
c5cd20ce
PT
371 uid_t init_uid;
372 gid_t init_gid;
571e6ec8
DL
373};
374
858377e4
SH
375#ifdef HAVE_TLS
376extern __thread struct lxc_conf *current_config;
377#else
378extern struct lxc_conf *current_config;
379#endif
380
283678ed
SH
381int run_lxc_hooks(const char *name, char *hook, struct lxc_conf *conf,
382 const char *lxcpath, char *argv[]);
26ddeedd 383
cc28d0b0
SH
384extern int detect_shared_rootfs(void);
385
089cd8b8
DL
386/*
387 * Initialize the lxc configuration structure
388 */
7b379ab3 389extern struct lxc_conf *lxc_conf_init(void);
8eb5694b 390extern void lxc_conf_free(struct lxc_conf *conf);
089cd8b8 391
0c547523
SH
392extern int pin_rootfs(const char *rootfs);
393
26b797f3 394extern int lxc_requests_empty_network(struct lxc_handler *handler);
e3b4c4c4 395extern int lxc_create_network(struct lxc_handler *handler);
74a2b586 396extern void lxc_delete_network(struct lxc_handler *handler);
82d5ae15 397extern int lxc_assign_network(struct lxc_list *networks, pid_t pid);
f6d3e3e4 398extern int lxc_map_ids(struct lxc_list *idmap, pid_t pid);
19a26f82 399extern int lxc_find_gateway_addresses(struct lxc_handler *handler);
0ad19a3f 400
5e4a62bf 401extern int lxc_create_tty(const char *name, struct lxc_conf *conf);
b0a33c1e 402extern void lxc_delete_tty(struct lxc_tty_info *tty_info);
403
72d0e1cb 404extern int lxc_clear_config_network(struct lxc_conf *c);
12a50cc6 405extern int lxc_clear_nic(struct lxc_conf *c, const char *key);
72d0e1cb 406extern int lxc_clear_config_caps(struct lxc_conf *c);
1fb86a7c 407extern int lxc_clear_config_keepcaps(struct lxc_conf *c);
12a50cc6 408extern int lxc_clear_cgroups(struct lxc_conf *c, const char *key);
72d0e1cb 409extern int lxc_clear_mount_entries(struct lxc_conf *c);
b099e9e9 410extern int lxc_clear_automounts(struct lxc_conf *c);
12a50cc6 411extern int lxc_clear_hooks(struct lxc_conf *c, const char *key);
7d0eb87e 412extern int lxc_clear_idmaps(struct lxc_conf *c);
ee1e7aa0 413extern int lxc_clear_groups(struct lxc_conf *c);
ab799c0b 414extern int lxc_clear_environment(struct lxc_conf *c);
f0d02950 415extern int lxc_delete_autodev(struct lxc_handler *handler);
72d0e1cb 416
35120d9c
SH
417extern int do_rootfs_setup(struct lxc_conf *conf, const char *name,
418 const char *lxcpath);
419
0ad19a3f 420/*
421 * Configure the container from inside
422 */
88d5514d 423
368bbc02 424struct cgroup_process_info;
d4ef7c50 425extern int lxc_setup(struct lxc_handler *handler);
7b35f3d6 426
2af6bd1b 427extern void lxc_rename_phys_nics_on_shutdown(int netnsfd, struct lxc_conf *conf);
cf3ef16d 428
2133f58c
SH
429extern int find_unmapped_nsuid(struct lxc_conf *conf, enum idtype idtype);
430extern int mapped_hostid(unsigned id, struct lxc_conf *conf, enum idtype idtype);
c4d10a05
SH
431extern int chown_mapped_root(char *path, struct lxc_conf *conf);
432extern int ttys_shift_ids(struct lxc_conf *c);
4355ab5f 433extern int userns_exec_1(struct lxc_conf *conf, int (*fn)(void *), void *data);
a17b1e65
SG
434extern int parse_mntopts(const char *mntopts, unsigned long *mntflags,
435 char **mntdata);
5112cd70 436extern void tmp_proc_unmount(struct lxc_conf *lxc_conf);
6a0c909a 437void remount_all_slave(void);
97e9cfa0 438extern void suggest_default_idmap(void);
9fc7f8c0 439FILE *write_mount_file(struct lxc_list *mount);
aaf26830 440struct lxc_list *sort_cgroup_settings(struct lxc_list* cgroup_settings);
0ad19a3f 441#endif