2 * lxc: linux Container library
4 * (C) Copyright IBM Corp. 2007, 2008
7 * Daniel Lezcano <daniel.lezcano at free.fr>
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.
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.
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
28 #include <netinet/in.h>
30 #include <sys/param.h>
31 #include <sys/types.h>
35 #include "start.h" /* for lxc_handler */
37 #if HAVE_SCMP_FILTER_CTX
38 typedef void * scmp_filter_ctx
;
41 /* worth moving to configure.ac? */
42 #define subuidfile "/etc/subuid"
43 #define subgidfile "/etc/subgid"
56 * Defines the structure to configure an ipv4 address
57 * @address : ipv4 address
58 * @broadcast : ipv4 broadcast address
59 * @mask : network mask
72 * Defines the structure to configure an ipv6 address
73 * @flags : set the address up
74 * @address : ipv6 address
75 * @broadcast : ipv6 broadcast address
76 * @mask : network mask
80 struct in6_addr mcast
;
81 struct in6_addr acast
;
90 char *pair
; /* pair name */
91 char veth1
[IFNAMSIZ
]; /* needed for deconf */
101 struct ifla_macvlan
{
102 int mode
; /* private, vepa, bridge */
106 struct ifla_veth veth_attr
;
107 struct ifla_vlan vlan_attr
;
108 struct ifla_macvlan macvlan_attr
;
112 * Defines a structure to configure a network device
113 * @link : lxc.network.link, name of bridge or host iface to attach if any
114 * @name : lxc.network.name, name of iface on the container side
115 * @flags : flag of the network device (IFF_UP, ... )
116 * @ipv4 : a list of ipv4 addresses to be set on the network device
117 * @ipv6 : a list of ipv6 addresses to be set on the network device
118 * @upscript : a script filename to be executed during interface configuration
119 * @downscript : a script filename to be executed during interface destruction
130 struct lxc_list ipv4
;
131 struct lxc_list ipv6
;
132 struct in_addr
*ipv4_gateway
;
133 bool ipv4_gateway_auto
;
134 struct in6_addr
*ipv6_gateway
;
135 bool ipv6_gateway_auto
;
141 * Defines a generic struct to configure the control group.
142 * It is up to the programmer to specify the right subsystem.
143 * @subsystem : the targetted subsystem
144 * @value : the value to set
157 * id_map is an id map entry. Form in confile is:
158 * lxc.id_map = u 0 9800 100
159 * lxc.id_map = u 1000 9900 100
160 * lxc.id_map = g 0 9800 100
161 * lxc.id_map = g 1000 9900 100
162 * meaning the container can use uids and gids 0-99 and 1000-1099,
163 * with [ug]id 0 mapping to [ug]id 9800 on the host, and [ug]id 1000 to
164 * [ug]id 9900 on the host.
168 unsigned long hostid
, nsid
, range
;
172 * Defines a structure containing a pty information for
174 * @name : the path name of the slave pty side
175 * @master : the file descriptor of the master
176 * @slave : the file descriptor of the slave
178 struct lxc_pty_info
{
179 char name
[MAXPATHLEN
];
186 * Defines the number of tty configured and contains the
188 * @nbtty = number of configured ttys
190 struct lxc_tty_info
{
192 struct lxc_pty_info
*pty_info
;
195 struct lxc_tty_state
;
198 * Defines the structure to store the console information
199 * @peer : the file descriptor put/get console traffic
200 * @name : the file name of the slave pty
206 struct lxc_pty_info peerpty
;
207 struct lxc_epoll_descr
*descr
;
211 char name
[MAXPATHLEN
];
212 struct termios
*tios
;
213 struct lxc_tty_state
*tty_state
;
217 * Defines a structure to store the rootfs location, the
218 * optionals pivot_root, rootfs mount paths
219 * @rootfs : a path to the rootfs
220 * @pivot_root : a path to a pivot_root location to be used
230 * Automatic mounts for LXC to perform inside the container
233 LXC_AUTO_PROC_RW
= 0x001, /* /proc read-write */
234 LXC_AUTO_PROC_MIXED
= 0x002, /* /proc/sys and /proc/sysrq-trigger read-only */
235 LXC_AUTO_PROC_MASK
= 0x003,
237 LXC_AUTO_SYS_RW
= 0x004, /* /sys */
238 LXC_AUTO_SYS_RO
= 0x008, /* /sys read-only */
239 LXC_AUTO_SYS_MASK
= 0x00C,
241 LXC_AUTO_CGROUP_RO
= 0x010, /* /sys/fs/cgroup (partial mount, read-only) */
242 LXC_AUTO_CGROUP_RW
= 0x020, /* /sys/fs/cgroup (partial mount, read-write) */
243 LXC_AUTO_CGROUP_MIXED
= 0x030, /* /sys/fs/cgroup (partial mount, paths r/o, cgroup r/w) */
244 LXC_AUTO_CGROUP_FULL_RO
= 0x040, /* /sys/fs/cgroup (full mount, read-only) */
245 LXC_AUTO_CGROUP_FULL_RW
= 0x050, /* /sys/fs/cgroup (full mount, read-write) */
246 LXC_AUTO_CGROUP_FULL_MIXED
= 0x060, /* /sys/fs/cgroup (full mount, parent r/o, own r/w) */
247 /* These are defined in such a way as to retain
248 * binary compatibility with earlier versions of
249 * this code. If the previous mask is applied,
250 * both of these will default back to the _MIXED
251 * variants, which is safe. */
252 LXC_AUTO_CGROUP_NOSPEC
= 0x0B0, /* /sys/fs/cgroup (partial mount, r/w or mixed, depending on caps) */
253 LXC_AUTO_CGROUP_FULL_NOSPEC
= 0x0E0, /* /sys/fs/cgroup (full mount, r/w or mixed, depending on caps) */
254 LXC_AUTO_CGROUP_MASK
= 0x0F0,
256 LXC_AUTO_ALL_MASK
= 0x0FF, /* all known settings */
260 * Defines the global container configuration
261 * @rootfs : root directory to run the container
262 * @pivotdir : pivotdir path, if not set default will be used
263 * @mount : list of mount points
264 * @tty : numbers of tty
265 * @pts : new pts instance
266 * @mount_list : list of mount point (alternative to fstab file)
267 * @network : network configuration
268 * @utsname : container utsname
269 * @fstab : path to a fstab file format
270 * @caps : list of the capabilities to drop
271 * @keepcaps : list of the capabilities to keep
272 * @tty_info : tty data
273 * @console : console data
274 * @ttydir : directory (under /dev) in which to create console and ttys
275 * @lsm_aa_profile : apparmor profile to switch to or NULL
276 * @lsm_se_context : selinux type to switch to or NULL
279 LXCHOOK_PRESTART
, LXCHOOK_PREMOUNT
, LXCHOOK_MOUNT
, LXCHOOK_AUTODEV
,
280 LXCHOOK_START
, LXCHOOK_POSTSTOP
, LXCHOOK_CLONE
, NUM_LXC_HOOKS
};
281 extern char *lxchook_names
[NUM_LXC_HOOKS
];
295 signed long personality
;
296 struct utsname
*utsname
;
297 struct lxc_list cgroup
;
298 struct lxc_list id_map
;
299 struct lxc_list network
;
300 struct saved_nic
*saved_nics
;
303 struct lxc_list mount_list
;
304 struct lxc_list caps
;
305 struct lxc_list keepcaps
;
306 struct lxc_tty_info tty_info
;
307 struct lxc_console console
;
308 struct lxc_rootfs rootfs
;
311 struct lxc_list hooks
[NUM_LXC_HOOKS
];
313 char *lsm_aa_profile
;
314 char *lsm_se_context
;
316 char *seccomp
; // filename with the seccomp rules
317 #if HAVE_SCMP_FILTER_CTX
318 scmp_filter_ctx seccomp_ctx
;
321 int autodev
; // if 1, mount and fill a /dev at start
322 int haltsignal
; // signal used to halt container
323 int stopsignal
; // signal used to hard stop container
324 int kmsg
; // if 1, create /dev/kmsg symlink
325 char *rcfile
; // Copy of the top level rcfile we read
327 // Logfile and logleve can be set in a container config file.
328 // Those function as defaults. The defaults can be overriden
329 // by command line. However we don't want the command line
330 // specified values to be saved on c->save_config(). So we
331 // store the config file specified values here.
332 char *logfile
; // the logfile as specifed in config
333 int loglevel
; // loglevel as specifed in config (if any)
335 int inherit_ns_fd
[LXC_NS_MAX
];
340 struct lxc_list groups
;
343 /* set to true when rootfs has been setup */
346 /* list of included files */
347 struct lxc_list includes
;
348 /* config entries which are not "lxc.*" are aliens */
349 struct lxc_list aliens
;
351 /* list of environment variables we'll add to the container when
353 struct lxc_list environment
;
355 /* text representation of the config file */
356 char *unexpanded_config
;
357 size_t unexpanded_len
, unexpanded_alloced
;
360 int run_lxc_hooks(const char *name
, char *hook
, struct lxc_conf
*conf
,
361 const char *lxcpath
, char *argv
[]);
363 extern int detect_shared_rootfs(void);
366 * Initialize the lxc configuration structure
368 extern struct lxc_conf
*lxc_conf_init(void);
369 extern void lxc_conf_free(struct lxc_conf
*conf
);
371 extern int pin_rootfs(const char *rootfs
);
373 extern int lxc_requests_empty_network(struct lxc_handler
*handler
);
374 extern int lxc_create_network(struct lxc_handler
*handler
);
375 extern void lxc_delete_network(struct lxc_handler
*handler
);
376 extern int lxc_assign_network(struct lxc_list
*networks
, pid_t pid
);
377 extern int lxc_map_ids(struct lxc_list
*idmap
, pid_t pid
);
378 extern int lxc_find_gateway_addresses(struct lxc_handler
*handler
);
380 extern int lxc_create_tty(const char *name
, struct lxc_conf
*conf
);
381 extern void lxc_delete_tty(struct lxc_tty_info
*tty_info
);
383 extern int lxc_clear_config_network(struct lxc_conf
*c
);
384 extern int lxc_clear_nic(struct lxc_conf
*c
, const char *key
);
385 extern int lxc_clear_config_caps(struct lxc_conf
*c
);
386 extern int lxc_clear_config_keepcaps(struct lxc_conf
*c
);
387 extern int lxc_clear_cgroups(struct lxc_conf
*c
, const char *key
);
388 extern int lxc_clear_mount_entries(struct lxc_conf
*c
);
389 extern int lxc_clear_automounts(struct lxc_conf
*c
);
390 extern int lxc_clear_hooks(struct lxc_conf
*c
, const char *key
);
391 extern int lxc_clear_idmaps(struct lxc_conf
*c
);
392 extern int lxc_clear_groups(struct lxc_conf
*c
);
393 extern int lxc_clear_environment(struct lxc_conf
*c
);
395 extern int do_rootfs_setup(struct lxc_conf
*conf
, const char *name
,
396 const char *lxcpath
);
399 * Configure the container from inside
402 struct cgroup_process_info
;
403 extern int lxc_setup(struct lxc_handler
*handler
);
405 extern void lxc_rename_phys_nics_on_shutdown(int netnsfd
, struct lxc_conf
*conf
);
407 extern int find_unmapped_nsuid(struct lxc_conf
*conf
, enum idtype idtype
);
408 extern int mapped_hostid(unsigned id
, struct lxc_conf
*conf
, enum idtype idtype
);
409 extern int chown_mapped_root(char *path
, struct lxc_conf
*conf
);
410 extern int ttys_shift_ids(struct lxc_conf
*c
);
411 extern int userns_exec_1(struct lxc_conf
*conf
, int (*fn
)(void *), void *data
);
412 extern int parse_mntopts(const char *mntopts
, unsigned long *mntflags
,
414 extern void tmp_proc_unmount(struct lxc_conf
*lxc_conf
);
415 extern void suggest_default_idmap(void);