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