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 _conf_h
  24 #define _conf_h
  25
  26 #include "config.h"
  27
  28 #include <netinet/in.h>
  29 #include <net/if.h>
  30 #include <sys/param.h>
  31 #include <sys/types.h>
  32 #include <stdbool.h>
  33
  34 #include <lxc/list.h>
  35
  36 #include <lxc/start.h> /* for lxc_handler */
  37
  38 #if HAVE_SCMP_FILTER_CTX
  39 typedef void * scmp_filter_ctx;
  40 #endif
  41
  42 enum {
  43         LXC_NET_EMPTY,
  44         LXC_NET_VETH,
  45         LXC_NET_MACVLAN,
  46         LXC_NET_PHYS,
  47         LXC_NET_VLAN,
  48         LXC_NET_MAXCONFTYPE,
  49 };
  50
  51 /*
  52  * Defines the structure to configure an ipv4 address
  53  * @address   : ipv4 address
  54  * @broadcast : ipv4 broadcast address
  55  * @mask      : network mask
  56  */
  57 struct lxc_inetdev {
  58         struct in_addr addr;
  59         struct in_addr bcast;
  60         int prefix;
  61 };
  62
  63 struct lxc_route {
  64         struct in_addr addr;
  65 };
  66
  67 /*
  68  * Defines the structure to configure an ipv6 address
  69  * @flags     : set the address up
  70  * @address   : ipv6 address
  71  * @broadcast : ipv6 broadcast address
  72  * @mask      : network mask
  73  */
  74 struct lxc_inet6dev {
  75         struct in6_addr addr;
  76         struct in6_addr mcast;
  77         struct in6_addr acast;
  78         int prefix;
  79 };
  80
  81 struct lxc_route6 {
  82         struct in6_addr addr;
  83 };
  84
  85 struct ifla_veth {
  86         char *pair; /* pair name */
  87         char veth1[IFNAMSIZ]; /* needed for deconf */
  88 };
  89
  90 struct ifla_vlan {
  91         uint   flags;
  92         uint   fmask;
  93         unsigned short   vid;
  94         unsigned short   pad;
  95 };
  96
  97 struct ifla_macvlan {
  98         int mode; /* private, vepa, bridge */
  99 };
 100
 101 union netdev_p {
 102         struct ifla_veth veth_attr;
 103         struct ifla_vlan vlan_attr;
 104         struct ifla_macvlan macvlan_attr;
 105 };
 106
 107 /*
 108  * Defines a structure to configure a network device
 109  * @link       : lxc.network.link, name of bridge or host iface to attach if any
 110  * @name       : lxc.network.name, name of iface on the container side
 111  * @flags      : flag of the network device (IFF_UP, ... )
 112  * @ipv4       : a list of ipv4 addresses to be set on the network device
 113  * @ipv6       : a list of ipv6 addresses to be set on the network device
 114  * @upscript   : a script filename to be executed during interface configuration
 115  * @downscript : a script filename to be executed during interface destruction
 116  */
 117 struct lxc_netdev {
 118         int type;
 119         int flags;
 120         int ifindex;
 121         char *link;
 122         char *name;
 123         char *hwaddr;
 124         char *mtu;
 125         union netdev_p priv;
 126         struct lxc_list ipv4;
 127         struct lxc_list ipv6;
 128         struct in_addr *ipv4_gateway;
 129         bool ipv4_gateway_auto;
 130         struct in6_addr *ipv6_gateway;
 131         bool ipv6_gateway_auto;
 132         char *upscript;
 133         char *downscript;
 134 };
 135
 136 /*
 137  * Defines a generic struct to configure the control group.
 138  * It is up to the programmer to specify the right subsystem.
 139  * @subsystem : the targetted subsystem
 140  * @value     : the value to set
 141  */
 142 struct lxc_cgroup {
 143         char *subsystem;
 144         char *value;
 145 };
 146
 147 enum idtype {
 148         ID_TYPE_UID,
 149         ID_TYPE_GID
 150 };
 151
 152 /*
 153  * id_map is an id map entry.  Form in confile is:
 154  * lxc.id_map = u 0    9800 100
 155  * lxc.id_map = u 1000 9900 100
 156  * lxc.id_map = g 0    9800 100
 157  * lxc.id_map = g 1000 9900 100
 158  * meaning the container can use uids and gids 0-99 and 1000-1099,
 159  * with [ug]id 0 mapping to [ug]id 9800 on the host, and [ug]id 1000 to
 160  * [ug]id 9900 on the host.
 161  */
 162 struct id_map {
 163         enum idtype idtype;
 164         unsigned long hostid, nsid, range;
 165 };
 166
 167 /*
 168  * Defines a structure containing a pty information for
 169  * virtualizing a tty
 170  * @name   : the path name of the slave pty side
 171  * @master : the file descriptor of the master
 172  * @slave  : the file descriptor of the slave
 173  */
 174 struct lxc_pty_info {
 175         char name[MAXPATHLEN];
 176         int master;
 177         int slave;
 178         int busy;
 179 };
 180
 181 /*
 182  * Defines the number of tty configured and contains the
 183  * instanciated ptys
 184  * @nbtty = number of configured ttys
 185  */
 186 struct lxc_tty_info {
 187         int nbtty;
 188         struct lxc_pty_info *pty_info;
 189 };
 190
 191 struct lxc_tty_state;
 192
 193 /*
 194  * Defines the structure to store the console information
 195  * @peer   : the file descriptor put/get console traffic
 196  * @name   : the file name of the slave pty
 197  */
 198 struct lxc_console {
 199         int slave;
 200         int master;
 201         int peer;
 202         struct lxc_pty_info peerpty;
 203         struct lxc_epoll_descr *descr;
 204         char *path;
 205         char *log_path;
 206         int log_fd;
 207         char name[MAXPATHLEN];
 208         struct termios *tios;
 209         struct lxc_tty_state *tty_state;
 210 };
 211
 212 /*
 213  * Defines a structure to store the rootfs location, the
 214  * optionals pivot_root, rootfs mount paths
 215  * @rootfs     : a path to the rootfs
 216  * @pivot_root : a path to a pivot_root location to be used
 217  */
 218 struct lxc_rootfs {
 219         char *path;
 220         char *mount;
 221         char *pivot;
 222 };
 223
 224 /*
 225  * Automatic mounts for LXC to perform inside the container
 226  */
 227 enum {
 228         LXC_AUTO_PROC        = 0x01,   /* /proc */
 229         LXC_AUTO_SYS         = 0x02,   /* /sys*/
 230         LXC_AUTO_CGROUP      = 0x04,   /* /sys/fs/cgroup */
 231         LXC_AUTO_PROC_SYSRQ  = 0x08,   /* /proc/sysrq-trigger over-bind-mounted with /dev/null */
 232 };
 233
 234 /*
 235  * Defines the global container configuration
 236  * @rootfs     : root directory to run the container
 237  * @pivotdir   : pivotdir path, if not set default will be used
 238  * @mount      : list of mount points
 239  * @tty        : numbers of tty
 240  * @pts        : new pts instance
 241  * @mount_list : list of mount point (alternative to fstab file)
 242  * @network    : network configuration
 243  * @utsname    : container utsname
 244  * @fstab      : path to a fstab file format
 245  * @caps       : list of the capabilities to drop
 246  * @keepcaps   : list of the capabilities to keep
 247  * @tty_info   : tty data
 248  * @console    : console data
 249  * @ttydir     : directory (under /dev) in which to create console and ttys
 250 #if HAVE_APPARMOR
 251  * @aa_profile : apparmor profile to switch to
 252 #endif
 253  */
 254 enum lxchooks {
 255         LXCHOOK_PRESTART, LXCHOOK_PREMOUNT, LXCHOOK_MOUNT, LXCHOOK_AUTODEV,
 256         LXCHOOK_START, LXCHOOK_POSTSTOP, LXCHOOK_CLONE, NUM_LXC_HOOKS};
 257 extern char *lxchook_names[NUM_LXC_HOOKS];
 258
 259 struct saved_nic {
 260         int ifindex;
 261         char *orig_name;
 262 };
 263
 264 struct lxc_conf {
 265         int is_execute;
 266         char *fstab;
 267         int tty;
 268         int pts;
 269         int reboot;
 270         int need_utmp_watch;
 271         int personality;
 272         struct utsname *utsname;
 273         struct lxc_list cgroup;
 274         struct lxc_list id_map;
 275         struct lxc_list network;
 276         struct saved_nic *saved_nics;
 277         int num_savednics;
 278         int auto_mounts;
 279         struct lxc_list mount_list;
 280         struct lxc_list caps;
 281         struct lxc_list keepcaps;
 282         struct lxc_tty_info tty_info;
 283         struct lxc_console console;
 284         struct lxc_rootfs rootfs;
 285         char *ttydir;
 286         int close_all_fds;
 287         struct lxc_list hooks[NUM_LXC_HOOKS];
 288 #if HAVE_APPARMOR
 289         char *aa_profile;
 290 #endif
 291
 292 #if HAVE_APPARMOR /* || HAVE_SELINUX || HAVE_SMACK */
 293         int lsm_umount_proc;
 294 #endif
 295         char *seccomp;  // filename with the seccomp rules
 296 #if HAVE_SCMP_FILTER_CTX
 297         scmp_filter_ctx *seccomp_ctx;
 298 #endif
 299         int maincmd_fd;
 300         int autodev;  // if 1, mount and fill a /dev at start
 301         int stopsignal; // signal used to stop container
 302         int kmsg;  // if 1, create /dev/kmsg symlink
 303         char *rcfile;   // Copy of the top level rcfile we read
 304
 305         // Logfile and logleve can be set in a container config file.
 306         // Those function as defaults.  The defaults can be overriden
 307         // by command line.  However we don't want the command line
 308         // specified values to be saved on c->save_config().  So we
 309         // store the config file specified values here.
 310         char *logfile;  // the logfile as specifed in config
 311         int loglevel;   // loglevel as specifed in config (if any)
 312 };
 313
 314 int run_lxc_hooks(const char *name, char *hook, struct lxc_conf *conf,
 315                   const char *lxcpath, char *argv[]);
 316
 317 extern int detect_shared_rootfs(void);
 318
 319 /*
 320  * Initialize the lxc configuration structure
 321  */
 322 extern struct lxc_conf *lxc_conf_init(void);
 323 extern void lxc_conf_free(struct lxc_conf *conf);
 324
 325 extern int pin_rootfs(const char *rootfs);
 326
 327 extern int lxc_create_network(struct lxc_handler *handler);
 328 extern void lxc_delete_network(struct lxc_handler *handler);
 329 extern int lxc_assign_network(struct lxc_list *networks, pid_t pid);
 330 extern int lxc_map_ids(struct lxc_list *idmap, pid_t pid);
 331 extern int lxc_find_gateway_addresses(struct lxc_handler *handler);
 332
 333 extern int lxc_create_tty(const char *name, struct lxc_conf *conf);
 334 extern void lxc_delete_tty(struct lxc_tty_info *tty_info);
 335
 336 extern int lxc_clear_config_network(struct lxc_conf *c);
 337 extern int lxc_clear_nic(struct lxc_conf *c, const char *key);
 338 extern int lxc_clear_config_caps(struct lxc_conf *c);
 339 extern int lxc_clear_config_keepcaps(struct lxc_conf *c);
 340 extern int lxc_clear_cgroups(struct lxc_conf *c, const char *key);
 341 extern int lxc_clear_mount_entries(struct lxc_conf *c);
 342 extern int lxc_clear_hooks(struct lxc_conf *c, const char *key);
 343
 344 extern int uid_shift_ttys(int pid, struct lxc_conf *conf);
 345
 346 /*
 347  * Configure the container from inside
 348  */
 349
 350 struct cgroup_process_info;
 351 extern int lxc_setup(const char *name, struct lxc_conf *lxc_conf,
 352                         const char *lxcpath, struct cgroup_process_info *cgroup_info);
 353
 354 extern void lxc_rename_phys_nics_on_shutdown(struct lxc_conf *conf);
 355 #endif