src/lxc/conf.h

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