blob: 635c9086e19af86b81b4dc572a7c2ee0374b02fc [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/bearer.h: Include file for TIPC bearer code
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Jon Paul Maloy35c55c92016-06-13 20:46:22 -04004 * Copyright (c) 1996-2006, 2013-2016, Ericsson AB
Allan Stephens2d627b92011-01-07 13:00:11 -05005 * Copyright (c) 2005, 2010-2011, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_BEARER_H
38#define _TIPC_BEARER_H
39
Richard Alpe0655f6a2014-11-20 10:29:07 +010040#include "netlink.h"
Jon Paul Maloya6bf70f2015-05-14 10:46:13 -040041#include "core.h"
Michal Kubeček3de81b72016-12-02 09:33:41 +010042#include "msg.h"
Richard Alpe0655f6a2014-11-20 10:29:07 +010043#include <net/genetlink.h>
Per Lidenb97bf3f2006-01-02 19:04:38 +010044
Erik Hugned0f91932015-03-05 10:23:49 +010045#define MAX_MEDIA 3
Per Lidenb97bf3f2006-01-02 19:04:38 +010046
Jon Paul Maloy38504c22014-05-14 05:39:13 -040047/* 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
Allan Stephens4d163a32011-10-07 13:37:34 -040051 */
Erik Hugne91e2eb52015-02-27 08:56:57 +010052#define TIPC_MEDIA_INFO_SIZE 32
Allan Stephens4d163a32011-10-07 13:37:34 -040053#define TIPC_MEDIA_TYPE_OFFSET 3
Erik Hugned76a4362015-02-27 08:56:58 +010054#define TIPC_MEDIA_ADDR_OFFSET 4
Allan Stephens4d163a32011-10-07 13:37:34 -040055
56/*
Allan Stephensd265fef2010-11-30 12:00:53 +000057 * Identifiers of supported TIPC media types
58 */
59#define TIPC_MEDIA_TYPE_ETH 1
Patrick McHardya29a1942013-04-17 06:18:28 +000060#define TIPC_MEDIA_TYPE_IB 2
Erik Hugned0f91932015-03-05 10:23:49 +010061#define TIPC_MEDIA_TYPE_UDP 3
Allan Stephensd265fef2010-11-30 12:00:53 +000062
Jon Paul Maloy99999742017-01-18 13:50:50 -050063/* Minimum bearer MTU */
Michal Kubeček3de81b72016-12-02 09:33:41 +010064#define TIPC_MIN_BEARER_MTU (MAX_H_SIZE + INT_H_SIZE)
65
Jon Paul Maloy99999742017-01-18 13:50:50 -050066/* Identifiers for distinguishing between broadcast/multicast and replicast
67 */
68#define TIPC_BROADCAST_SUPPORT 1
69#define TIPC_REPLICAST_SUPPORT 2
70
Ben Hutchings2c530402012-07-10 10:55:09 +000071/**
Allan Stephens3d749a62011-10-07 15:19:11 -040072 * 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
Allan Stephensd265fef2010-11-30 12:00:53 +000076 */
77struct tipc_media_addr {
Erik Hugne91e2eb52015-02-27 08:56:57 +010078 u8 value[TIPC_MEDIA_INFO_SIZE];
Allan Stephens3d749a62011-10-07 15:19:11 -040079 u8 media_id;
80 u8 broadcast;
Allan Stephensd265fef2010-11-30 12:00:53 +000081};
82
Allan Stephens2d627b92011-01-07 13:00:11 -050083struct tipc_bearer;
Per Lidenb97bf3f2006-01-02 19:04:38 +010084
85/**
Jon Paul Maloyef72a7e2013-12-10 20:45:40 -080086 * struct tipc_media - Media specific info exposed to generic bearer layer
Per Lidenb97bf3f2006-01-02 19:04:38 +010087 * @send_msg: routine which handles buffer transmission
Ying Xue4babbaa2013-10-18 07:23:17 +020088 * @enable_media: routine which enables a media
89 * @disable_media: routine which disables a media
Jon Paul Maloy38504c22014-05-14 05:39:13 -040090 * @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
Per Lidenb97bf3f2006-01-02 19:04:38 +010094 * @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
Allan Stephensd265fef2010-11-30 12:00:53 +000097 * @type_id: TIPC media identifier
Ying Xuee4d050c2013-12-10 20:45:43 -080098 * @hwaddr_len: TIPC media address len
Per Lidenb97bf3f2006-01-02 19:04:38 +010099 * @name: media name
100 */
Paul Gortmaker358a0d12011-12-29 20:19:42 -0500101struct tipc_media {
Ying Xue1da46562015-01-09 15:27:07 +0800102 int (*send_msg)(struct net *net, struct sk_buff *buf,
Jon Paul Maloy1a906322015-11-19 14:30:47 -0500103 struct tipc_bearer *b,
Per Lidenb97bf3f2006-01-02 19:04:38 +0100104 struct tipc_media_addr *dest);
Jon Paul Maloy1a906322015-11-19 14:30:47 -0500105 int (*enable_media)(struct net *net, struct tipc_bearer *b,
Erik Hugned0f91932015-03-05 10:23:49 +0100106 struct nlattr *attr[]);
Jon Paul Maloy1a906322015-11-19 14:30:47 -0500107 void (*disable_media)(struct tipc_bearer *b);
Jon Paul Maloy38504c22014-05-14 05:39:13 -0400108 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);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100118 u32 priority;
119 u32 tolerance;
120 u32 window;
121 u32 type_id;
Ying Xuee4d050c2013-12-10 20:45:43 -0800122 u32 hwaddr_len;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100123 char name[TIPC_MAX_MEDIA_NAME];
124};
125
126/**
Jon Paul Maloyef72a7e2013-12-10 20:45:40 -0800127 * struct tipc_bearer - Generic TIPC bearer structure
Ying Xuea8304522014-02-13 17:29:17 -0500128 * @media_ptr: pointer to additional media-specific information about bearer
Allan Stephens2d627b92011-01-07 13:00:11 -0500129 * @mtu: max packet size bearer can support
Allan Stephens2d627b92011-01-07 13:00:11 -0500130 * @addr: media-specific address associated with bearer
131 * @name: bearer name (format = media:interface)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100132 * @media: ptr to media structure associated with bearer
Jon Paul Maloyef72a7e2013-12-10 20:45:40 -0800133 * @bcast_addr: media address used in broadcasting
Ying Xuef8322df2014-04-21 10:55:45 +0800134 * @rcu: rcu struct for tipc_bearer
Per Lidenb97bf3f2006-01-02 19:04:38 +0100135 * @priority: default link priority for bearer
Allan Stephens5c216e12011-10-18 11:34:29 -0400136 * @window: default window size for bearer
137 * @tolerance: default link tolerance for bearer
Erik Hugnea21a5842014-03-28 10:32:08 +0100138 * @domain: network domain to which links can be established
Per Lidenb97bf3f2006-01-02 19:04:38 +0100139 * @identity: array index of this bearer within TIPC bearer array
140 * @link_req: ptr to (optional) structure making periodic link setup requests
Per Lidenb97bf3f2006-01-02 19:04:38 +0100141 * @net_plane: network plane ('A' through 'H') currently associated with bearer
Allan Stephens2d627b92011-01-07 13:00:11 -0500142 *
143 * Note: media-specific code is responsible for initialization of the fields
144 * indicated below when a bearer is enabled; TIPC's generic bearer code takes
145 * care of initializing all other fields.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100146 */
Allan Stephens2d627b92011-01-07 13:00:11 -0500147struct tipc_bearer {
Ying Xue2231c5a2014-04-21 10:55:47 +0800148 void __rcu *media_ptr; /* initalized by media */
Allan Stephens2d627b92011-01-07 13:00:11 -0500149 u32 mtu; /* initalized by media */
Allan Stephens2d627b92011-01-07 13:00:11 -0500150 struct tipc_media_addr addr; /* initalized by media */
151 char name[TIPC_MAX_BEARER_NAME];
Paul Gortmaker358a0d12011-12-29 20:19:42 -0500152 struct tipc_media *media;
Patrick McHardy8aeb89f2013-04-17 06:18:26 +0000153 struct tipc_media_addr bcast_addr;
Ying Xuef8322df2014-04-21 10:55:45 +0800154 struct rcu_head rcu;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100155 u32 priority;
Allan Stephens5c216e12011-10-18 11:34:29 -0400156 u32 window;
157 u32 tolerance;
Erik Hugnea21a5842014-03-28 10:32:08 +0100158 u32 domain;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100159 u32 identity;
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500160 struct tipc_link_req *link_req;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100161 char net_plane;
Jon Paul Maloy0d051bf2016-08-16 11:53:50 -0400162 unsigned long up;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100163};
164
Paul Gortmakerf19765f2011-12-29 21:39:49 -0500165struct tipc_bearer_names {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100166 char media_name[TIPC_MAX_MEDIA_NAME];
167 char if_name[TIPC_MAX_IF_NAME];
168};
169
Allan Stephensd265fef2010-11-30 12:00:53 +0000170/*
171 * TIPC routines available to supported media types
172 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000173
Jon Paul Maloy1a906322015-11-19 14:30:47 -0500174void tipc_rcv(struct net *net, struct sk_buff *skb, struct tipc_bearer *b);
Allan Stephensd265fef2010-11-30 12:00:53 +0000175
176/*
177 * Routines made available to TIPC by supported media types
178 */
Jon Paul Maloy5702dba2013-12-10 20:45:39 -0800179extern struct tipc_media eth_media_info;
Allan Stephensd265fef2010-11-30 12:00:53 +0000180
Patrick McHardya29a1942013-04-17 06:18:28 +0000181#ifdef CONFIG_TIPC_MEDIA_IB
Jon Paul Maloy5702dba2013-12-10 20:45:39 -0800182extern struct tipc_media ib_media_info;
Patrick McHardya29a1942013-04-17 06:18:28 +0000183#endif
Erik Hugned0f91932015-03-05 10:23:49 +0100184#ifdef CONFIG_TIPC_MEDIA_UDP
185extern struct tipc_media udp_media_info;
186#endif
Patrick McHardya29a1942013-04-17 06:18:28 +0000187
Richard Alpe0655f6a2014-11-20 10:29:07 +0100188int tipc_nl_bearer_disable(struct sk_buff *skb, struct genl_info *info);
189int tipc_nl_bearer_enable(struct sk_buff *skb, struct genl_info *info);
Richard Alpe35b9dd72014-11-20 10:29:08 +0100190int tipc_nl_bearer_dump(struct sk_buff *skb, struct netlink_callback *cb);
191int tipc_nl_bearer_get(struct sk_buff *skb, struct genl_info *info);
Richard Alpe315c00b2014-11-20 10:29:09 +0100192int tipc_nl_bearer_set(struct sk_buff *skb, struct genl_info *info);
Richard Alpeef20cd42016-08-26 10:52:53 +0200193int tipc_nl_bearer_add(struct sk_buff *skb, struct genl_info *info);
Richard Alpe0655f6a2014-11-20 10:29:07 +0100194
Richard Alpe46f15c62014-11-20 10:29:15 +0100195int tipc_nl_media_dump(struct sk_buff *skb, struct netlink_callback *cb);
196int tipc_nl_media_get(struct sk_buff *skb, struct genl_info *info);
Richard Alpe1e554172014-11-20 10:29:16 +0100197int tipc_nl_media_set(struct sk_buff *skb, struct genl_info *info);
Richard Alpe46f15c62014-11-20 10:29:15 +0100198
Allan Stephens5c216e12011-10-18 11:34:29 -0400199int tipc_media_set_priority(const char *name, u32 new_value);
200int tipc_media_set_window(const char *name, u32 new_value);
Erik Hugnedc1aed32012-06-29 00:50:23 -0400201void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a);
Erik Hugned0f91932015-03-05 10:23:49 +0100202int tipc_enable_l2_media(struct net *net, struct tipc_bearer *b,
203 struct nlattr *attrs[]);
Ying Xuee4d050c2013-12-10 20:45:43 -0800204void tipc_disable_l2_media(struct tipc_bearer *b);
Ying Xue1da46562015-01-09 15:27:07 +0800205int tipc_l2_send_msg(struct net *net, struct sk_buff *buf,
206 struct tipc_bearer *b, struct tipc_media_addr *dest);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100207
Ying Xue7f9f95d2015-01-09 15:27:06 +0800208void tipc_bearer_add_dest(struct net *net, u32 bearer_id, u32 dest);
209void tipc_bearer_remove_dest(struct net *net, u32 bearer_id, u32 dest);
210struct tipc_bearer *tipc_bearer_find(struct net *net, const char *name);
Parthasarathy Bhuvaraganff0d3e72016-07-26 08:47:21 +0200211int tipc_bearer_get_name(struct net *net, char *name, u32 bearer_id);
Paul Gortmaker358a0d12011-12-29 20:19:42 -0500212struct tipc_media *tipc_media_find(const char *name);
Jon Paul Maloy1fc07f32016-07-11 16:08:37 -0400213void tipc_bearer_reset_all(struct net *net);
Ying Xue6e967ad2013-12-10 20:45:42 -0800214int tipc_bearer_setup(void);
215void tipc_bearer_cleanup(void);
Ying Xuef2f98002015-01-09 15:27:05 +0800216void tipc_bearer_stop(struct net *net);
Jon Paul Maloy959e1782015-10-22 08:51:43 -0400217int tipc_bearer_mtu(struct net *net, u32 bearer_id);
Jon Paul Maloy99999742017-01-18 13:50:50 -0500218bool tipc_bearer_bcast_support(struct net *net, u32 bearer_id);
Jon Paul Maloy60852d62015-10-22 08:51:44 -0400219void tipc_bearer_xmit_skb(struct net *net, u32 bearer_id,
220 struct sk_buff *skb,
221 struct tipc_media_addr *dest);
Jon Paul Maloyaf9b0282015-07-16 16:54:24 -0400222void tipc_bearer_xmit(struct net *net, u32 bearer_id,
223 struct sk_buff_head *xmitq,
224 struct tipc_media_addr *dst);
Jon Paul Maloyb06b2812015-10-22 08:51:42 -0400225void tipc_bearer_bc_xmit(struct net *net, u32 bearer_id,
226 struct sk_buff_head *xmitq);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100227
Michal Kubeček3de81b72016-12-02 09:33:41 +0100228/* check if device MTU is too low for tipc headers */
229static inline bool tipc_mtu_bad(struct net_device *dev, unsigned int reserve)
230{
231 if (dev->mtu >= TIPC_MIN_BEARER_MTU + reserve)
232 return false;
233 netdev_warn(dev, "MTU too low for tipc bearer\n");
234 return true;
235}
236
Allan Stephensb274f4a2010-05-11 14:30:16 +0000237#endif /* _TIPC_BEARER_H */