[mirror_ubuntu-bionic-kernel.git] / net / tipc / bearer.h

/*
 * net/tipc/bearer.h: Include file for TIPC bearer code
 *
 * Copyright (c) 1996-2006, 2013-2016, Ericsson AB
 * Copyright (c) 2005, 2010-2011, Wind River Systems
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the names of the copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _TIPC_BEARER_H
#define _TIPC_BEARER_H

#include "netlink.h"
#include "core.h"
#include "msg.h"
#include <net/genetlink.h>

#define MAX_MEDIA	3

/* Identifiers associated with TIPC message header media address info
 * - address info field is 32 bytes long
 * - the field's actual content and length is defined per media
 * - remaining unused bytes in the field are set to zero
 */
#define TIPC_MEDIA_INFO_SIZE	32
#define TIPC_MEDIA_TYPE_OFFSET	3
#define TIPC_MEDIA_ADDR_OFFSET	4

/*
 * Identifiers of supported TIPC media types
 */
#define TIPC_MEDIA_TYPE_ETH	1
#define TIPC_MEDIA_TYPE_IB	2
#define TIPC_MEDIA_TYPE_UDP	3

/* Minimum bearer MTU */
#define TIPC_MIN_BEARER_MTU	(MAX_H_SIZE + INT_H_SIZE)

/* Identifiers for distinguishing between broadcast/multicast and replicast
 */
#define TIPC_BROADCAST_SUPPORT  1
#define TIPC_REPLICAST_SUPPORT  2

/**
 * struct tipc_media_addr - destination address used by TIPC bearers
 * @value: address info (format defined by media)
 * @media_id: TIPC media type identifier
 * @broadcast: non-zero if address is a broadcast address
 */
struct tipc_media_addr {
	u8 value[TIPC_MEDIA_INFO_SIZE];
	u8 media_id;
	u8 broadcast;
};

struct tipc_bearer;

/**
 * struct tipc_media - Media specific info exposed to generic bearer layer
 * @send_msg: routine which handles buffer transmission
 * @enable_media: routine which enables a media
 * @disable_media: routine which disables a media
 * @addr2str: convert media address format to string
 * @addr2msg: convert from media addr format to discovery msg addr format
 * @msg2addr: convert from discovery msg addr format to media addr format
 * @raw2addr: convert from raw addr format to media addr format
 * @priority: default link (and bearer) priority
 * @tolerance: default time (in ms) before declaring link failure
 * @window: default window (in packets) before declaring link congestion
 * @type_id: TIPC media identifier
 * @hwaddr_len: TIPC media address len
 * @name: media name
 */
struct tipc_media {
	int (*send_msg)(struct net *net, struct sk_buff *buf,
			struct tipc_bearer *b,
			struct tipc_media_addr *dest);
	int (*enable_media)(struct net *net, struct tipc_bearer *b,
			    struct nlattr *attr[]);
	void (*disable_media)(struct tipc_bearer *b);
	int (*addr2str)(struct tipc_media_addr *addr,
			char *strbuf,
			int bufsz);
	int (*addr2msg)(char *msg, struct tipc_media_addr *addr);
	int (*msg2addr)(struct tipc_bearer *b,
			struct tipc_media_addr *addr,
			char *msg);
	int (*raw2addr)(struct tipc_bearer *b,
			struct tipc_media_addr *addr,
			char *raw);
	u32 priority;
	u32 tolerance;
	u32 window;
	u32 type_id;
	u32 hwaddr_len;
	char name[TIPC_MAX_MEDIA_NAME];
};

/**
 * struct tipc_bearer - Generic TIPC bearer structure
 * @media_ptr: pointer to additional media-specific information about bearer
 * @mtu: max packet size bearer can support
 * @addr: media-specific address associated with bearer
 * @name: bearer name (format = media:interface)
 * @media: ptr to media structure associated with bearer
 * @bcast_addr: media address used in broadcasting
 * @pt: packet type for bearer
 * @rcu: rcu struct for tipc_bearer
 * @priority: default link priority for bearer
 * @window: default window size for bearer
 * @tolerance: default link tolerance for bearer
 * @domain: network domain to which links can be established
 * @identity: array index of this bearer within TIPC bearer array
 * @link_req: ptr to (optional) structure making periodic link setup requests
 * @net_plane: network plane ('A' through 'H') currently associated with bearer
 *
 * Note: media-specific code is responsible for initialization of the fields
 * indicated below when a bearer is enabled; TIPC's generic bearer code takes
 * care of initializing all other fields.
 */
struct tipc_bearer {
	void __rcu *media_ptr;			/* initalized by media */
	u32 mtu;				/* initalized by media */
	struct tipc_media_addr addr;		/* initalized by media */
	char name[TIPC_MAX_BEARER_NAME];
	struct tipc_media *media;
	struct tipc_media_addr bcast_addr;
	struct packet_type pt;
	struct rcu_head rcu;
	u32 priority;
	u32 window;
	u32 tolerance;
	u32 domain;
	u32 identity;
	struct tipc_link_req *link_req;
	char net_plane;
	unsigned long up;
};

struct tipc_bearer_names {
	char media_name[TIPC_MAX_MEDIA_NAME];
	char if_name[TIPC_MAX_IF_NAME];
};

/*
 * TIPC routines available to supported media types
 */

void tipc_rcv(struct net *net, struct sk_buff *skb, struct tipc_bearer *b);

/*
 * Routines made available to TIPC by supported media types
 */
extern struct tipc_media eth_media_info;

#ifdef CONFIG_TIPC_MEDIA_IB
extern struct tipc_media ib_media_info;
#endif
#ifdef CONFIG_TIPC_MEDIA_UDP
extern struct tipc_media udp_media_info;
#endif

int tipc_nl_bearer_disable(struct sk_buff *skb, struct genl_info *info);
int tipc_nl_bearer_enable(struct sk_buff *skb, struct genl_info *info);
int tipc_nl_bearer_dump(struct sk_buff *skb, struct netlink_callback *cb);
int tipc_nl_bearer_get(struct sk_buff *skb, struct genl_info *info);
int tipc_nl_bearer_set(struct sk_buff *skb, struct genl_info *info);
int tipc_nl_bearer_add(struct sk_buff *skb, struct genl_info *info);

int tipc_nl_media_dump(struct sk_buff *skb, struct netlink_callback *cb);
int tipc_nl_media_get(struct sk_buff *skb, struct genl_info *info);
int tipc_nl_media_set(struct sk_buff *skb, struct genl_info *info);

int tipc_media_set_priority(const char *name, u32 new_value);
int tipc_media_set_window(const char *name, u32 new_value);
void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a);
int tipc_enable_l2_media(struct net *net, struct tipc_bearer *b,
			 struct nlattr *attrs[]);
void tipc_disable_l2_media(struct tipc_bearer *b);
int tipc_l2_send_msg(struct net *net, struct sk_buff *buf,
		     struct tipc_bearer *b, struct tipc_media_addr *dest);

void tipc_bearer_add_dest(struct net *net, u32 bearer_id, u32 dest);
void tipc_bearer_remove_dest(struct net *net, u32 bearer_id, u32 dest);
struct tipc_bearer *tipc_bearer_find(struct net *net, const char *name);
int tipc_bearer_get_name(struct net *net, char *name, u32 bearer_id);
struct tipc_media *tipc_media_find(const char *name);
int tipc_bearer_setup(void);
void tipc_bearer_cleanup(void);
void tipc_bearer_stop(struct net *net);
int tipc_bearer_mtu(struct net *net, u32 bearer_id);
bool tipc_bearer_bcast_support(struct net *net, u32 bearer_id);
void tipc_bearer_xmit_skb(struct net *net, u32 bearer_id,
			  struct sk_buff *skb,
			  struct tipc_media_addr *dest);
void tipc_bearer_xmit(struct net *net, u32 bearer_id,
		      struct sk_buff_head *xmitq,
		      struct tipc_media_addr *dst);
void tipc_bearer_bc_xmit(struct net *net, u32 bearer_id,
			 struct sk_buff_head *xmitq);

/* check if device MTU is too low for tipc headers */
static inline bool tipc_mtu_bad(struct net_device *dev, unsigned int reserve)
{
	if (dev->mtu >= TIPC_MIN_BEARER_MTU + reserve)
		return false;
	netdev_warn(dev, "MTU too low for tipc bearer\n");
	return true;
}

#endif	/* _TIPC_BEARER_H */
Commit	Line	Data
b97bf3fd PL	1	/*
b97bf3fd PL	2	* net/tipc/bearer.h: Include file for TIPC bearer code
c4307285	3	*
35c55c98	4	* Copyright (c) 1996-2006, 2013-2016, Ericsson AB
2d627b92	5	* Copyright (c) 2005, 2010-2011, Wind River Systems
b97bf3fd PL	6	* All rights reserved.
b97bf3fd PL	7	*
9ea1fd3c	8	* Redistribution and use in source and binary forms, with or without
b97bf3fd PL	9	* modification, are permitted provided that the following conditions are met:
b97bf3fd PL	10	*
9ea1fd3c PL	11	* 1. Redistributions of source code must retain the above copyright
	12	* notice, this list of conditions and the following disclaimer.
	13	* 2. Redistributions in binary form must reproduce the above copyright
	14	* notice, this list of conditions and the following disclaimer in the
	15	* documentation and/or other materials provided with the distribution.
	16	* 3. Neither the names of the copyright holders nor the names of its
	17	* contributors may be used to endorse or promote products derived from
	18	* this software without specific prior written permission.
b97bf3fd	19	*
9ea1fd3c PL	20	* Alternatively, this software may be distributed under the terms of the
	21	* GNU General Public License ("GPL") version 2 as published by the Free
	22	* Software Foundation.
	23	*
	24	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
	25	* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	26	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	27	* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
	28	* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	29	* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	30	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	31	* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	32	* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	33	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
b97bf3fd PL	34	* POSSIBILITY OF SUCH DAMAGE.
	35	*/
	36
	37	#ifndef _TIPC_BEARER_H
	38	#define _TIPC_BEARER_H
	39
0655f6a8	40	#include "netlink.h"
a6bf70f7	41	#include "core.h"
3de81b75	42	#include "msg.h"
0655f6a8	43	#include <net/genetlink.h>
b97bf3fd	44
d0f91938	45	#define MAX_MEDIA 3
b97bf3fd	46
38504c28 JPM	47	/* Identifiers associated with TIPC message header media address info
	48	* - address info field is 32 bytes long
	49	* - the field's actual content and length is defined per media
	50	* - remaining unused bytes in the field are set to zero
4d163a32	51	*/
91e2eb56	52	#define TIPC_MEDIA_INFO_SIZE 32
4d163a32	53	#define TIPC_MEDIA_TYPE_OFFSET 3
d76a436d	54	#define TIPC_MEDIA_ADDR_OFFSET 4
4d163a32	55
d265fef6 AS	56	/*
	57	* Identifiers of supported TIPC media types
	58	*/
	59	#define TIPC_MEDIA_TYPE_ETH 1
a29a194a	60	#define TIPC_MEDIA_TYPE_IB 2
d0f91938	61	#define TIPC_MEDIA_TYPE_UDP 3
d265fef6	62
9999974a	63	/* Minimum bearer MTU */
3de81b75 MK	64	#define TIPC_MIN_BEARER_MTU (MAX_H_SIZE + INT_H_SIZE)
3de81b75 MK	65
9999974a JPM	66	/* Identifiers for distinguishing between broadcast/multicast and replicast
	67	*/
	68	#define TIPC_BROADCAST_SUPPORT 1
	69	#define TIPC_REPLICAST_SUPPORT 2
	70
2c53040f	71	/**
3d749a6a AS	72	* struct tipc_media_addr - destination address used by TIPC bearers
	73	* @value: address info (format defined by media)
	74	* @media_id: TIPC media type identifier
	75	* @broadcast: non-zero if address is a broadcast address
d265fef6 AS	76	*/
d265fef6 AS	77	struct tipc_media_addr {
91e2eb56	78	u8 value[TIPC_MEDIA_INFO_SIZE];
3d749a6a AS	79	u8 media_id;
3d749a6a AS	80	u8 broadcast;
d265fef6 AS	81	};
d265fef6 AS	82
2d627b92	83	struct tipc_bearer;
b97bf3fd PL	84
b97bf3fd PL	85	/**
ef72a7e0	86	* struct tipc_media - Media specific info exposed to generic bearer layer
b97bf3fd	87	* @send_msg: routine which handles buffer transmission
4babbaa8 YX	88	* @enable_media: routine which enables a media
4babbaa8 YX	89	* @disable_media: routine which disables a media
38504c28 JPM	90	* @addr2str: convert media address format to string
	91	* @addr2msg: convert from media addr format to discovery msg addr format
	92	* @msg2addr: convert from discovery msg addr format to media addr format
	93	* @raw2addr: convert from raw addr format to media addr format
b97bf3fd PL	94	* @priority: default link (and bearer) priority
	95	* @tolerance: default time (in ms) before declaring link failure
	96	* @window: default window (in packets) before declaring link congestion
d265fef6	97	* @type_id: TIPC media identifier
e4d050cb	98	* @hwaddr_len: TIPC media address len
b97bf3fd PL	99	* @name: media name
b97bf3fd PL	100	*/
358a0d1c	101	struct tipc_media {
1da46568	102	int (send_msg)(struct net net, struct sk_buff *buf,
1a90632d	103	struct tipc_bearer *b,
b97bf3fd	104	struct tipc_media_addr *dest);
1a90632d	105	int (enable_media)(struct net net, struct tipc_bearer *b,
d0f91938	106	struct nlattr *attr[]);
1a90632d	107	void (disable_media)(struct tipc_bearer b);
38504c28 JPM	108	int (addr2str)(struct tipc_media_addr addr,
	109	char *strbuf,
	110	int bufsz);
	111	int (addr2msg)(char msg, struct tipc_media_addr *addr);
	112	int (msg2addr)(struct tipc_bearer b,
	113	struct tipc_media_addr *addr,
	114	char *msg);
	115	int (raw2addr)(struct tipc_bearer b,
	116	struct tipc_media_addr *addr,
	117	char *raw);
b97bf3fd PL	118	u32 priority;
	119	u32 tolerance;
	120	u32 window;
	121	u32 type_id;
e4d050cb	122	u32 hwaddr_len;
b97bf3fd PL	123	char name[TIPC_MAX_MEDIA_NAME];
	124	};
	125
	126	/**
ef72a7e0	127	* struct tipc_bearer - Generic TIPC bearer structure
a8304529	128	* @media_ptr: pointer to additional media-specific information about bearer
2d627b92	129	* @mtu: max packet size bearer can support
2d627b92 AS	130	* @addr: media-specific address associated with bearer
2d627b92 AS	131	* @name: bearer name (format = media:interface)
b97bf3fd	132	* @media: ptr to media structure associated with bearer
ef72a7e0	133	* @bcast_addr: media address used in broadcasting
d55c60eb	134	* @pt: packet type for bearer
f8322dfc	135	* @rcu: rcu struct for tipc_bearer
b97bf3fd	136	* @priority: default link priority for bearer
5c216e1d AS	137	* @window: default window size for bearer
5c216e1d AS	138	* @tolerance: default link tolerance for bearer
a21a584d	139	* @domain: network domain to which links can be established
b97bf3fd PL	140	* @identity: array index of this bearer within TIPC bearer array
b97bf3fd PL	141	* @link_req: ptr to (optional) structure making periodic link setup requests
b97bf3fd	142	* @net_plane: network plane ('A' through 'H') currently associated with bearer
2d627b92 AS	143	*
	144	* Note: media-specific code is responsible for initialization of the fields
	145	* indicated below when a bearer is enabled; TIPC's generic bearer code takes
	146	* care of initializing all other fields.
b97bf3fd	147	*/
2d627b92	148	struct tipc_bearer {
2231c5af	149	void __rcu media_ptr; / initalized by media */
2d627b92	150	u32 mtu; /* initalized by media */
2d627b92 AS	151	struct tipc_media_addr addr; /* initalized by media */
2d627b92 AS	152	char name[TIPC_MAX_BEARER_NAME];
358a0d1c	153	struct tipc_media *media;
8aeb89f2	154	struct tipc_media_addr bcast_addr;
d55c60eb	155	struct packet_type pt;
f8322dfc	156	struct rcu_head rcu;
b97bf3fd	157	u32 priority;
5c216e1d AS	158	u32 window;
5c216e1d AS	159	u32 tolerance;
a21a584d	160	u32 domain;
b97bf3fd	161	u32 identity;
a18c4bc3	162	struct tipc_link_req *link_req;
b97bf3fd	163	char net_plane;
0d051bf9	164	unsigned long up;
b97bf3fd PL	165	};
b97bf3fd PL	166
f19765f4	167	struct tipc_bearer_names {
b97bf3fd PL	168	char media_name[TIPC_MAX_MEDIA_NAME];
	169	char if_name[TIPC_MAX_IF_NAME];
	170	};
	171
d265fef6 AS	172	/*
	173	* TIPC routines available to supported media types
	174	*/
d265fef6	175
1a90632d	176	void tipc_rcv(struct net net, struct sk_buff skb, struct tipc_bearer *b);
d265fef6 AS	177
	178	/*
	179	* Routines made available to TIPC by supported media types
	180	*/
5702dbab	181	extern struct tipc_media eth_media_info;
d265fef6	182
a29a194a	183	#ifdef CONFIG_TIPC_MEDIA_IB
5702dbab	184	extern struct tipc_media ib_media_info;
a29a194a	185	#endif
d0f91938 EH	186	#ifdef CONFIG_TIPC_MEDIA_UDP
	187	extern struct tipc_media udp_media_info;
	188	#endif
a29a194a	189
0655f6a8 RA	190	int tipc_nl_bearer_disable(struct sk_buff skb, struct genl_info info);
0655f6a8 RA	191	int tipc_nl_bearer_enable(struct sk_buff skb, struct genl_info info);
35b9dd76 RA	192	int tipc_nl_bearer_dump(struct sk_buff skb, struct netlink_callback cb);
35b9dd76 RA	193	int tipc_nl_bearer_get(struct sk_buff skb, struct genl_info info);
315c00bc	194	int tipc_nl_bearer_set(struct sk_buff skb, struct genl_info info);
ef20cd4d	195	int tipc_nl_bearer_add(struct sk_buff skb, struct genl_info info);
0655f6a8	196
46f15c67 RA	197	int tipc_nl_media_dump(struct sk_buff skb, struct netlink_callback cb);
46f15c67 RA	198	int tipc_nl_media_get(struct sk_buff skb, struct genl_info info);
1e55417d	199	int tipc_nl_media_set(struct sk_buff skb, struct genl_info info);
46f15c67	200
5c216e1d AS	201	int tipc_media_set_priority(const char *name, u32 new_value);
5c216e1d AS	202	int tipc_media_set_window(const char *name, u32 new_value);
dc1aed37	203	void tipc_media_addr_printf(char buf, int len, struct tipc_media_addr a);
d0f91938 EH	204	int tipc_enable_l2_media(struct net net, struct tipc_bearer b,
d0f91938 EH	205	struct nlattr *attrs[]);
e4d050cb	206	void tipc_disable_l2_media(struct tipc_bearer *b);
1da46568 YX	207	int tipc_l2_send_msg(struct net net, struct sk_buff buf,
1da46568 YX	208	struct tipc_bearer b, struct tipc_media_addr dest);
b97bf3fd	209
7f9f95d9 YX	210	void tipc_bearer_add_dest(struct net *net, u32 bearer_id, u32 dest);
	211	void tipc_bearer_remove_dest(struct net *net, u32 bearer_id, u32 dest);
	212	struct tipc_bearer tipc_bearer_find(struct net net, const char *name);
ff0d3e78	213	int tipc_bearer_get_name(struct net net, char name, u32 bearer_id);
358a0d1c	214	struct tipc_media tipc_media_find(const char name);
6e967adf YX	215	int tipc_bearer_setup(void);
6e967adf YX	216	void tipc_bearer_cleanup(void);
f2f9800d	217	void tipc_bearer_stop(struct net *net);
959e1781	218	int tipc_bearer_mtu(struct net *net, u32 bearer_id);
9999974a	219	bool tipc_bearer_bcast_support(struct net *net, u32 bearer_id);
60852d67 JPM	220	void tipc_bearer_xmit_skb(struct net *net, u32 bearer_id,
	221	struct sk_buff *skb,
	222	struct tipc_media_addr *dest);
af9b028e JPM	223	void tipc_bearer_xmit(struct net *net, u32 bearer_id,
	224	struct sk_buff_head *xmitq,
	225	struct tipc_media_addr *dst);
b06b281e JPM	226	void tipc_bearer_bc_xmit(struct net *net, u32 bearer_id,
b06b281e JPM	227	struct sk_buff_head *xmitq);
b97bf3fd	228
3de81b75 MK	229	/* check if device MTU is too low for tipc headers */
	230	static inline bool tipc_mtu_bad(struct net_device *dev, unsigned int reserve)
	231	{
	232	if (dev->mtu >= TIPC_MIN_BEARER_MTU + reserve)
	233	return false;
	234	netdev_warn(dev, "MTU too low for tipc bearer\n");
	235	return true;
	236	}
	237
b274f4ab	238	#endif /* _TIPC_BEARER_H */