[mirror_lxc.git] / src / lxc / network.h

/*
 * lxc: linux Container library
 *
 * (C) Copyright IBM Corp. 2007, 2008
 *
 * Authors:
 * Daniel Lezcano <daniel.lezcano at free.fr>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
#ifndef __LXC_NETWORK_H
#define __LXC_NETWORK_H

#include <arpa/inet.h>
#include <linux/types.h>
#include <stdbool.h>
#include <stdio.h>
#include <sys/socket.h>
#include <unistd.h>

#include "list.h"

struct lxc_conf;
struct lxc_handler;
struct lxc_netdev;

enum {
	LXC_NET_EMPTY,
	LXC_NET_VETH,
	LXC_NET_MACVLAN,
	LXC_NET_PHYS,
	LXC_NET_VLAN,
	LXC_NET_NONE,
	LXC_NET_MAXCONFTYPE,
};

/*
 * Defines the structure to configure an ipv4 address
 * @address   : ipv4 address
 * @broadcast : ipv4 broadcast address
 * @mask      : network mask
 */
struct lxc_inetdev {
	struct in_addr addr;
	struct in_addr bcast;
	unsigned int prefix;
};

struct lxc_route {
	struct in_addr addr;
};

/*
 * Defines the structure to configure an ipv6 address
 * @flags     : set the address up
 * @address   : ipv6 address
 * @broadcast : ipv6 broadcast address
 * @mask      : network mask
 */
struct lxc_inet6dev {
	struct in6_addr addr;
	struct in6_addr mcast;
	struct in6_addr acast;
	unsigned int prefix;
};

struct lxc_route6 {
	struct in6_addr addr;
};

/* Contains information about the host side veth device.
 * @pair    : Name of the host side veth device.
 *            If the user requested that the host veth device be created with a
 *            specific names this field will be set. If this field is set @veth1
 *            is not set.
 * @veth1   : Name of the host side veth device.
 *            If the user did not request that the host veth device be created
 *            with a specific name this field will be set. If this field is set
 *            @pair is not set.
 * @ifindex : Ifindex of the network device.
 */
struct ifla_veth {
	char pair[IFNAMSIZ];
	char veth1[IFNAMSIZ];
	int ifindex;
};

struct ifla_vlan {
	unsigned int   flags;
	unsigned int   fmask;
	unsigned short   vid;
	unsigned short   pad;
};

struct ifla_macvlan {
	int mode; /* private, vepa, bridge, passthru */
};

/* Contains information about the physical network device as seen from the host.
 * @ifindex : The ifindex of the physical network device in the host's network
 *            namespace.
 */
struct ifla_phys {
	int ifindex;
};

union netdev_p {
	struct ifla_macvlan macvlan_attr;
	struct ifla_phys phys_attr;
	struct ifla_veth veth_attr;
	struct ifla_vlan vlan_attr;
};

/*
 * Defines a structure to configure a network device
 * @idx               : network counter
 * @ifindex           : ifindex of the network device
 *                      Note that this is the ifindex of the network device in
 *                      the container's network namespace. If the network device
 *                      consists of a pair of network devices (e.g. veth pairs
 *                      attached to a network bridge) then this index cannot be
 *                      used to identify or modify the host veth device. See
 *                      struct ifla_veth for the host side information.
 * @type              : network type (veth, macvlan, vlan, ...)
 * @flags             : flag of the network device (IFF_UP, ... )
 * @link              : lxc.net.[i].link, name of bridge or host iface to attach
 *                      if any
 * @name              : lxc.net.[i].name, name of iface on the container side
 * @hwaddr            : mac address
 * @mtu               : maximum transmission unit
 * @priv              : information specific to the specificed network type
 *                      Note that this is a union so whether accessing a struct
 *                      is possible is dependent on the network type.
 * @ipv4              : a list of ipv4 addresses to be set on the network device
 * @ipv6              : a list of ipv6 addresses to be set on the network device
 * @ipv4_gateway_auto : whether the ipv4 gateway is to be automatically gathered
 *                      from the associated @link
 * @ipv4_gateway      : ipv4 gateway
 * @ipv6_gateway_auto : whether the ipv6 gateway is to be automatically gathered
 *                      from the associated @link
 * @ipv6_gateway      : ipv6 gateway
 * @upscript          : a script filename to be executed during interface
 *                      configuration
 * @downscript        : a script filename to be executed during interface
 *                      destruction
 */
struct lxc_netdev {
	ssize_t idx;
	int ifindex;
	int type;
	int flags;
	char link[IFNAMSIZ];
	char name[IFNAMSIZ];
	char *hwaddr;
	char *mtu;
	union netdev_p priv;
	struct lxc_list ipv4;
	struct lxc_list ipv6;
	bool ipv4_gateway_auto;
	struct in_addr *ipv4_gateway;
	bool ipv6_gateway_auto;
	struct in6_addr *ipv6_gateway;
	char *upscript;
	char *downscript;
};

/* Convert a string mac address to a socket structure. */
extern int lxc_convert_mac(char *macaddr, struct sockaddr *sockaddr);

/* Move a device between namespaces. */
extern int lxc_netdev_move_by_index(int ifindex, pid_t pid, const char *ifname);
extern int lxc_netdev_move_by_name(const char *ifname, pid_t pid,
				   const char *newname);

/* Delete a network device. */
extern int lxc_netdev_delete_by_name(const char *name);
extern int lxc_netdev_delete_by_index(int ifindex);

/* Change the device name. */
extern int lxc_netdev_rename_by_name(const char *oldname, const char *newname);
extern int lxc_netdev_rename_by_index(int ifindex, const char *newname);

extern int netdev_set_flag(const char *name, int flag);

/* Set the device network up or down. */
extern int lxc_netdev_isup(const char *name);
extern int lxc_netdev_up(const char *name);
extern int lxc_netdev_down(const char *name);

/* Change the mtu size for the specified device. */
extern int lxc_netdev_set_mtu(const char *name, int mtu);

/* Create a virtual network devices. */
extern int lxc_veth_create(const char *name1, const char *name2);
extern int lxc_macvlan_create(const char *master, const char *name, int mode);
extern int lxc_vlan_create(const char *master, const char *name,
			   unsigned short vid);

/* Set ip address. */
extern int lxc_ipv6_addr_add(int ifindex, struct in6_addr *addr,
			     struct in6_addr *mcast,
			     struct in6_addr *acast, int prefix);

extern int lxc_ipv4_addr_add(int ifindex, struct in_addr *addr,
			     struct in_addr *bcast, int prefix);

/* Get ip address. */
extern int lxc_ipv4_addr_get(int ifindex, struct in_addr **res);
extern int lxc_ipv6_addr_get(int ifindex, struct in6_addr **res);

/* Set a destination route to an interface. */
extern int lxc_ipv4_dest_add(int ifindex, struct in_addr *dest);
extern int lxc_ipv6_dest_add(int ifindex, struct in6_addr *dest);

/* Set default route. */
extern int lxc_ipv4_gateway_add(int ifindex, struct in_addr *gw);
extern int lxc_ipv6_gateway_add(int ifindex, struct in6_addr *gw);

/* Attach an interface to the bridge. */
extern int lxc_bridge_attach(const char *bridge, const char *ifname);
extern int lxc_ovs_delete_port(const char *bridge, const char *nic);

extern bool is_ovs_bridge(const char *bridge);

/* Create default gateway. */
extern int lxc_route_create_default(const char *addr, const char *ifname,
				    int gateway);

/* Delete default gateway. */
extern int lxc_route_delete_default(const char *addr, const char *ifname,
				    int gateway);

/* Activate neighbor proxying. */
extern int lxc_neigh_proxy_on(const char *name, int family);

/* Disable neighbor proxying. */
extern int lxc_neigh_proxy_off(const char *name, int family);

/* Generate a new unique network interface name.
 * Allocated memory must be freed by caller.
 */
extern char *lxc_mkifname(char *template);

extern const char *lxc_net_type_to_str(int type);
extern int setup_private_host_hw_addr(char *veth1);
extern int netdev_get_mtu(int ifindex);
extern int lxc_create_network_priv(struct lxc_handler *handler);
extern int lxc_network_move_created_netdev_priv(const char *lxcpath,
						const char *lxcname,
						struct lxc_list *network,
						pid_t pid);
extern void lxc_delete_network(struct lxc_handler *handler);
extern int lxc_find_gateway_addresses(struct lxc_handler *handler);
extern int lxc_create_network_unpriv(const char *lxcpath, const char *lxcname,
				     struct lxc_list *network, pid_t pid, unsigned int hook_version);
extern int lxc_requests_empty_network(struct lxc_handler *handler);
extern int lxc_restore_phys_nics_to_netns(struct lxc_handler *handler);
extern int lxc_setup_network_in_child_namespaces(const struct lxc_conf *conf,
						 struct lxc_list *network);
extern int lxc_network_send_veth_names_to_child(struct lxc_handler *handler);
extern int lxc_network_recv_veth_names_from_parent(struct lxc_handler *handler);
extern int lxc_network_send_name_and_ifindex_to_parent(struct lxc_handler *handler);
extern int lxc_network_recv_name_and_ifindex_from_child(struct lxc_handler *handler);
extern int lxc_netns_set_nsid(int netns_fd);
extern int lxc_netns_get_nsid(__s32 fd);

#endif /* __LXC_NETWORK_H */
Commit	Line	Data
0ad19a3f	1	/*
	2	* lxc: linux Container library
	3	*
	4	* (C) Copyright IBM Corp. 2007, 2008
	5	*
	6	* Authors:
9afe19d6	7	* Daniel Lezcano <daniel.lezcano at free.fr>
0ad19a3f	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
250b1eec	21	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
0ad19a3f	22	*/
f1a4a029 ÇO	23	#ifndef __LXC_NETWORK_H
f1a4a029 ÇO	24	#define __LXC_NETWORK_H
0ad19a3f	25
ebc73a67	26	#include <arpa/inet.h>
938980ba	27	#include <linux/types.h>
d38dd64a CB	28	#include <stdbool.h>
d38dd64a CB	29	#include <stdio.h>
ebc73a67	30	#include <sys/socket.h>
d38dd64a	31	#include <unistd.h>
ebc73a67	32
811ef482 CB	33	#include "list.h"
	34
	35	struct lxc_conf;
	36	struct lxc_handler;
	37	struct lxc_netdev;
	38
	39	enum {
	40	LXC_NET_EMPTY,
	41	LXC_NET_VETH,
	42	LXC_NET_MACVLAN,
	43	LXC_NET_PHYS,
	44	LXC_NET_VLAN,
	45	LXC_NET_NONE,
	46	LXC_NET_MAXCONFTYPE,
	47	};
	48
	49	/*
	50	* Defines the structure to configure an ipv4 address
	51	* @address : ipv4 address
	52	* @broadcast : ipv4 broadcast address
	53	* @mask : network mask
	54	*/
	55	struct lxc_inetdev {
	56	struct in_addr addr;
	57	struct in_addr bcast;
	58	unsigned int prefix;
	59	};
	60
	61	struct lxc_route {
	62	struct in_addr addr;
	63	};
	64
	65	/*
	66	* Defines the structure to configure an ipv6 address
	67	* @flags : set the address up
	68	* @address : ipv6 address
	69	* @broadcast : ipv6 broadcast address
	70	* @mask : network mask
	71	*/
	72	struct lxc_inet6dev {
	73	struct in6_addr addr;
	74	struct in6_addr mcast;
	75	struct in6_addr acast;
	76	unsigned int prefix;
	77	};
	78
	79	struct lxc_route6 {
	80	struct in6_addr addr;
	81	};
	82
4239e9c3 CB	83	/* Contains information about the host side veth device.
	84	* @pair : Name of the host side veth device.
	85	* If the user requested that the host veth device be created with a
	86	* specific names this field will be set. If this field is set @veth1
	87	* is not set.
	88	* @veth1 : Name of the host side veth device.
	89	* If the user did not request that the host veth device be created
	90	* with a specific name this field will be set. If this field is set
	91	* @pair is not set.
	92	* @ifindex : Ifindex of the network device.
	93	*/
811ef482	94	struct ifla_veth {
de4855a8	95	char pair[IFNAMSIZ];
4239e9c3 CB	96	char veth1[IFNAMSIZ];
4239e9c3 CB	97	int ifindex;
811ef482 CB	98	};
	99
	100	struct ifla_vlan {
	101	unsigned int flags;
	102	unsigned int fmask;
	103	unsigned short vid;
	104	unsigned short pad;
	105	};
	106
	107	struct ifla_macvlan {
	108	int mode; /* private, vepa, bridge, passthru */
	109	};
	110
790255cf CB	111	/* Contains information about the physical network device as seen from the host.
	112	* @ifindex : The ifindex of the physical network device in the host's network
	113	* namespace.
	114	*/
	115	struct ifla_phys {
	116	int ifindex;
	117	};
	118
811ef482	119	union netdev_p {
790255cf CB	120	struct ifla_macvlan macvlan_attr;
790255cf CB	121	struct ifla_phys phys_attr;
811ef482 CB	122	struct ifla_veth veth_attr;
811ef482 CB	123	struct ifla_vlan vlan_attr;
811ef482 CB	124	};
	125
	126	/*
	127	* Defines a structure to configure a network device
085bb443 CB	128	* @idx : network counter
	129	* @ifindex : ifindex of the network device
	130	* Note that this is the ifindex of the network device in
	131	* the container's network namespace. If the network device
	132	* consists of a pair of network devices (e.g. veth pairs
	133	* attached to a network bridge) then this index cannot be
	134	* used to identify or modify the host veth device. See
	135	* struct ifla_veth for the host side information.
	136	* @type : network type (veth, macvlan, vlan, ...)
	137	* @flags : flag of the network device (IFF_UP, ... )
	138	* @link : lxc.net.[i].link, name of bridge or host iface to attach
	139	* if any
	140	* @name : lxc.net.[i].name, name of iface on the container side
	141	* @hwaddr : mac address
	142	* @mtu : maximum transmission unit
	143	* @priv : information specific to the specificed network type
	144	* Note that this is a union so whether accessing a struct
	145	* is possible is dependent on the network type.
	146	* @ipv4 : a list of ipv4 addresses to be set on the network device
	147	* @ipv6 : a list of ipv6 addresses to be set on the network device
	148	* @ipv4_gateway_auto : whether the ipv4 gateway is to be automatically gathered
	149	* from the associated @link
	150	* @ipv4_gateway : ipv4 gateway
	151	* @ipv6_gateway_auto : whether the ipv6 gateway is to be automatically gathered
	152	* from the associated @link
	153	* @ipv6_gateway : ipv6 gateway
	154	* @upscript : a script filename to be executed during interface
	155	* configuration
	156	* @downscript : a script filename to be executed during interface
	157	* destruction
811ef482 CB	158	*/
	159	struct lxc_netdev {
	160	ssize_t idx;
085bb443	161	int ifindex;
811ef482 CB	162	int type;
811ef482 CB	163	int flags;
de4855a8 CB	164	char link[IFNAMSIZ];
de4855a8 CB	165	char name[IFNAMSIZ];
811ef482 CB	166	char *hwaddr;
	167	char *mtu;
	168	union netdev_p priv;
	169	struct lxc_list ipv4;
	170	struct lxc_list ipv6;
811ef482	171	bool ipv4_gateway_auto;
085bb443	172	struct in_addr *ipv4_gateway;
811ef482	173	bool ipv6_gateway_auto;
085bb443	174	struct in6_addr *ipv6_gateway;
811ef482 CB	175	char *upscript;
	176	char *downscript;
	177	};
	178
ebc73a67	179	/* Convert a string mac address to a socket structure. */
0ad19a3f	180	extern int lxc_convert_mac(char macaddr, struct sockaddr sockaddr);
0ad19a3f	181
ebc73a67	182	/* Move a device between namespaces. */
535e8859	183	extern int lxc_netdev_move_by_index(int ifindex, pid_t pid, const char *ifname);
ebc73a67 CB	184	extern int lxc_netdev_move_by_name(const char *ifname, pid_t pid,
ebc73a67 CB	185	const char *newname);
0ad19a3f	186
ebc73a67	187	/* Delete a network device. */
b84f58b9 DL	188	extern int lxc_netdev_delete_by_name(const char *name);
b84f58b9 DL	189	extern int lxc_netdev_delete_by_index(int ifindex);
0ad19a3f	190
ebc73a67	191	/* Change the device name. */
b84f58b9 DL	192	extern int lxc_netdev_rename_by_name(const char oldname, const char newname);
b84f58b9 DL	193	extern int lxc_netdev_rename_by_index(int ifindex, const char *newname);
b9a5bb58	194
8befa924 SH	195	extern int netdev_set_flag(const char *name, int flag);
8befa924 SH	196
ebc73a67	197	/* Set the device network up or down. */
efa1cf45	198	extern int lxc_netdev_isup(const char *name);
d472214b DL	199	extern int lxc_netdev_up(const char *name);
d472214b DL	200	extern int lxc_netdev_down(const char *name);
0ad19a3f	201
ebc73a67	202	/* Change the mtu size for the specified device. */
d472214b	203	extern int lxc_netdev_set_mtu(const char *name, int mtu);
75d09f83	204
ebc73a67	205	/* Create a virtual network devices. */
497353b6	206	extern int lxc_veth_create(const char name1, const char name2);
e892973e	207	extern int lxc_macvlan_create(const char master, const char name, int mode);
ebc73a67 CB	208	extern int lxc_vlan_create(const char master, const char name,
ebc73a67 CB	209	unsigned short vid);
26c39028	210
ebc73a67	211	/* Set ip address. */
1f1b18e7 DL	212	extern int lxc_ipv6_addr_add(int ifindex, struct in6_addr *addr,
	213	struct in6_addr *mcast,
	214	struct in6_addr *acast, int prefix);
	215
	216	extern int lxc_ipv4_addr_add(int ifindex, struct in_addr *addr,
	217	struct in_addr *bcast, int prefix);
0ad19a3f	218
ebc73a67	219	/* Get ip address. */
19a26f82 MK	220	extern int lxc_ipv4_addr_get(int ifindex, struct in_addr **res);
	221	extern int lxc_ipv6_addr_get(int ifindex, struct in6_addr **res);
	222
ebc73a67	223	/* Set a destination route to an interface. */
77dcf03a GL	224	extern int lxc_ipv4_dest_add(int ifindex, struct in_addr *dest);
	225	extern int lxc_ipv6_dest_add(int ifindex, struct in6_addr *dest);
	226
ebc73a67	227	/* Set default route. */
f8fee0e2 MK	228	extern int lxc_ipv4_gateway_add(int ifindex, struct in_addr *gw);
	229	extern int lxc_ipv6_gateway_add(int ifindex, struct in6_addr *gw);
	230
ebc73a67	231	/* Attach an interface to the bridge. */
581c75e7 CB	232	extern int lxc_bridge_attach(const char bridge, const char ifname);
	233	extern int lxc_ovs_delete_port(const char bridge, const char nic);
	234
	235	extern bool is_ovs_bridge(const char *bridge);
0ad19a3f	236
ebc73a67	237	/* Create default gateway. */
497353b6 DL	238	extern int lxc_route_create_default(const char addr, const char ifname,
497353b6 DL	239	int gateway);
0ad19a3f	240
ebc73a67	241	/* Delete default gateway. */
497353b6 DL	242	extern int lxc_route_delete_default(const char addr, const char ifname,
497353b6 DL	243	int gateway);
0ad19a3f	244
ebc73a67	245	/* Activate neighbor proxying. */
497353b6	246	extern int lxc_neigh_proxy_on(const char *name, int family);
0ad19a3f	247
ebc73a67	248	/* Disable neighbor proxying. */
497353b6	249	extern int lxc_neigh_proxy_off(const char *name, int family);
0ad19a3f	250
811ef482 CB	251	/* Generate a new unique network interface name.
	252	* Allocated memory must be freed by caller.
	253	*/
966e9f1f	254	extern char lxc_mkifname(char template);
a0265685	255
72d0e1cb	256	extern const char *lxc_net_type_to_str(int type);
8befa924	257	extern int setup_private_host_hw_addr(char *veth1);
0130df54	258	extern int netdev_get_mtu(int ifindex);
811ef482	259	extern int lxc_create_network_priv(struct lxc_handler *handler);
74c6e2b0	260	extern int lxc_network_move_created_netdev_priv(const char *lxcpath,
f0ecc19d	261	const char *lxcname,
74c6e2b0 CB	262	struct lxc_list *network,
74c6e2b0 CB	263	pid_t pid);
bb84beda	264	extern void lxc_delete_network(struct lxc_handler *handler);
811ef482	265	extern int lxc_find_gateway_addresses(struct lxc_handler *handler);
f0ecc19d	266	extern int lxc_create_network_unpriv(const char lxcpath, const char lxcname,
4d781681	267	struct lxc_list *network, pid_t pid, unsigned int hook_version);
811ef482	268	extern int lxc_requests_empty_network(struct lxc_handler *handler);
b809f232	269	extern int lxc_restore_phys_nics_to_netns(struct lxc_handler *handler);
811ef482 CB	270	extern int lxc_setup_network_in_child_namespaces(const struct lxc_conf *conf,
811ef482 CB	271	struct lxc_list *network);
7ab1ba02 CB	272	extern int lxc_network_send_veth_names_to_child(struct lxc_handler *handler);
7ab1ba02 CB	273	extern int lxc_network_recv_veth_names_from_parent(struct lxc_handler *handler);
a1ae535a CB	274	extern int lxc_network_send_name_and_ifindex_to_parent(struct lxc_handler *handler);
a1ae535a CB	275	extern int lxc_network_recv_name_and_ifindex_from_child(struct lxc_handler *handler);
1cd95214	276	extern int lxc_netns_set_nsid(int netns_fd);
938980ba	277	extern int lxc_netns_get_nsid(__s32 fd);
ebc73a67 CB	278
ebc73a67 CB	279	#endif /* __LXC_NETWORK_H */