src/lxc/conf.h

   1 /*
   2  * lxc: linux Container library
   3  *
   4  * (C) Copyright IBM Corp. 2007, 2008
   5  *
   6  * Authors:
   7  * Daniel Lezcano <dlezcano at fr.ibm.com>
   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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  22  */
  23 #ifndef _conf_h
  24 #define _conf_h
  25
  26 #include <netinet/in.h>
  27 #include <sys/param.h>
  28
  29 enum {
  30         EMPTY,
  31         VETH,
  32         MACVLAN,
  33         PHYS,
  34         MAXCONFTYPE,
  35 };
  36
  37 /*
  38  * Defines the structure to configure an ipv4 address
  39  * @address   : ipv4 address
  40  * @broadcast : ipv4 broadcast address
  41  * @mask      : network mask
  42  */
  43 struct lxc_inetdev {
  44         struct in_addr addr;
  45         struct in_addr bcast;
  46         int prefix;
  47 };
  48
  49 struct lxc_route {
  50         struct in_addr addr;
  51 };
  52
  53 /*
  54  * Defines the structure to configure an ipv6 address
  55  * @flags     : set the address up
  56  * @address   : ipv6 address
  57  * @broadcast : ipv6 broadcast address
  58  * @mask      : network mask
  59  */
  60 struct lxc_inet6dev {
  61         struct in6_addr addr;
  62         struct in6_addr bcast;
  63         struct in6_addr acast;
  64         int prefix;
  65 };
  66
  67 struct lxc_route6 {
  68         struct in6_addr addr;
  69 };
  70 /*
  71  * Defines a structure to configure a network device
  72  * @ifname : network device name
  73  * @flags  : flag of the network device (IFF_UP, ... )
  74  * @ipv4   : a list of ipv4 addresses to be set on the network device
  75  * @ipv6   : a list of ipv6 addresses to be set on the network device
  76  */
  77 struct lxc_netdev {
  78         int type;
  79         int flags;
  80         int ifindex;
  81         char *ifname;
  82         char *newname;
  83         char *hwaddr;
  84         char *mtu;
  85         struct lxc_list ipv4;
  86         struct lxc_list ipv6;
  87 };
  88
  89 /*
  90  * Defines a generic struct to configure the control group.
  91  * It is up to the programmer to specify the right subsystem.
  92  * @subsystem : the targetted subsystem
  93  * @value     : the value to set
  94  */
  95 struct lxc_cgroup {
  96         char *subsystem;
  97         char *value;
  98 };
  99
 100 /*
 101  * Defines a structure containing a pty information for
 102  * virtualizing a tty
 103  * @name   : the path name of the slave pty side
 104  * @master : the file descriptor of the master
 105  * @slave  : the file descriptor of the slave
 106  */
 107 struct lxc_pty_info {
 108         char name[MAXPATHLEN];
 109         int master;
 110         int slave;
 111         int busy;
 112 };
 113
 114 /*
 115  * Defines the number of tty configured and contains the
 116  * instanciated ptys
 117  * @nbtty = number of configured ttys
 118  */
 119 struct lxc_tty_info {
 120         int nbtty;
 121         struct lxc_pty_info *pty_info;
 122 };
 123
 124 /*
 125  * Defines the global container configuration
 126  * @rootfs  : the root directory to run the container
 127  * @mount   : the list of mount points
 128  * @network : the network configuration
 129  * @utsname : the container utsname
 130  */
 131 struct lxc_conf {
 132         char *rootfs;
 133         char *fstab;
 134         int tty;
 135         int pts;
 136         struct utsname *utsname;
 137         struct lxc_list cgroup;
 138         struct lxc_list network;
 139         struct lxc_tty_info tty_info;
 140         char console[MAXPATHLEN];
 141 };
 142
 143 /*
 144  * Initialize the lxc configuration structure
 145  */
 146 extern int lxc_conf_init(struct lxc_conf *conf);
 147
 148 /*
 149  * Remove the resources created by the configuration
 150  */
 151 extern int lxc_unconfigure(const char *name);
 152
 153 extern int lxc_create_network(struct lxc_list *networks);
 154 extern int lxc_assign_network(struct lxc_list *networks, pid_t pid);
 155
 156 extern int lxc_create_tty(const char *name, struct lxc_conf *conf);
 157 extern void lxc_delete_tty(struct lxc_tty_info *tty_info);
 158
 159 /*
 160  * Configure the container from inside
 161  */
 162
 163 struct lxc_handler;
 164
 165 extern int lxc_setup(const char *name, struct lxc_conf *lxc_conf);
 166
 167 extern int conf_has(const char *name, const char *info);
 168
 169 #define conf_has_fstab(__name)   conf_has(__name, "fstab")
 170 #define conf_has_rootfs(__name)  conf_has(__name, "rootfs")
 171 #define conf_has_utsname(__name) conf_has(__name, "utsname")
 172 #define conf_has_network(__name) conf_has(__name, "network")
 173 #define conf_has_console(__name) conf_has(__name, "console")
 174 #define conf_has_cgroup(__name)  conf_has(__name, "cgroup")
 175 #define conf_has_tty(__name)     conf_has(__name, "tty")
 176 #define conf_has_pts(__name)     conf_has(__name, "pts")
 177 #endif