blob: b7302b01262440f16e4f5712c0ab939fe5e20f93 [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 *
Richard Alpe0655f6a2014-11-20 10:29:07 +01004 * Copyright (c) 1996-2006, 2013-2014, 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"
Michal Kubeček016d0292016-12-14 13:24:58 +010041#include "msg.h"
Richard Alpe0655f6a2014-11-20 10:29:07 +010042#include <net/genetlink.h>
Per Lidenb97bf3f2006-01-02 19:04:38 +010043
Allan Stephens909234c2011-05-27 15:09:40 -040044#define MAX_BEARERS 2
Erik Hugned0f91932015-03-05 10:23:49 +010045#define MAX_MEDIA 3
Ying Xue1da46562015-01-09 15:27:07 +080046#define MAX_NODES 4096
47#define WSIZE 32
Per Lidenb97bf3f2006-01-02 19:04:38 +010048
Jon Paul Maloy38504c22014-05-14 05:39:13 -040049/* Identifiers associated with TIPC message header media address info
50 * - address info field is 32 bytes long
51 * - the field's actual content and length is defined per media
52 * - remaining unused bytes in the field are set to zero
Allan Stephens4d163a32011-10-07 13:37:34 -040053 */
Erik Hugne91e2eb52015-02-27 08:56:57 +010054#define TIPC_MEDIA_INFO_SIZE 32
Allan Stephens4d163a32011-10-07 13:37:34 -040055#define TIPC_MEDIA_TYPE_OFFSET 3
Erik Hugned76a4362015-02-27 08:56:58 +010056#define TIPC_MEDIA_ADDR_OFFSET 4
Allan Stephens4d163a32011-10-07 13:37:34 -040057
58/*
Allan Stephensd265fef2010-11-30 12:00:53 +000059 * Identifiers of supported TIPC media types
60 */
61#define TIPC_MEDIA_TYPE_ETH 1
Patrick McHardya29a1942013-04-17 06:18:28 +000062#define TIPC_MEDIA_TYPE_IB 2
Erik Hugned0f91932015-03-05 10:23:49 +010063#define TIPC_MEDIA_TYPE_UDP 3
Allan Stephensd265fef2010-11-30 12:00:53 +000064
Michal Kubeček016d0292016-12-14 13:24:58 +010065/* minimum bearer MTU */
66#define TIPC_MIN_BEARER_MTU (MAX_H_SIZE + INT_H_SIZE)
67
Ben Hutchings2c530402012-07-10 10:55:09 +000068/**
Ying Xue1da46562015-01-09 15:27:07 +080069 * struct tipc_node_map - set of node identifiers
70 * @count: # of nodes in set
71 * @map: bitmap of node identifiers that are in the set
72 */
73struct tipc_node_map {
74 u32 count;
75 u32 map[MAX_NODES / WSIZE];
76};
77
78/**
Allan Stephens3d749a62011-10-07 15:19:11 -040079 * struct tipc_media_addr - destination address used by TIPC bearers
80 * @value: address info (format defined by media)
81 * @media_id: TIPC media type identifier
82 * @broadcast: non-zero if address is a broadcast address
Allan Stephensd265fef2010-11-30 12:00:53 +000083 */
84struct tipc_media_addr {
Erik Hugne91e2eb52015-02-27 08:56:57 +010085 u8 value[TIPC_MEDIA_INFO_SIZE];
Allan Stephens3d749a62011-10-07 15:19:11 -040086 u8 media_id;
87 u8 broadcast;
Allan Stephensd265fef2010-11-30 12:00:53 +000088};
89
Allan Stephens2d627b92011-01-07 13:00:11 -050090struct tipc_bearer;
Per Lidenb97bf3f2006-01-02 19:04:38 +010091
92/**
Jon Paul Maloyef72a7e2013-12-10 20:45:40 -080093 * struct tipc_media - Media specific info exposed to generic bearer layer
Per Lidenb97bf3f2006-01-02 19:04:38 +010094 * @send_msg: routine which handles buffer transmission
Ying Xue4babbaa2013-10-18 07:23:17 +020095 * @enable_media: routine which enables a media
96 * @disable_media: routine which disables a media
Jon Paul Maloy38504c22014-05-14 05:39:13 -040097 * @addr2str: convert media address format to string
98 * @addr2msg: convert from media addr format to discovery msg addr format
99 * @msg2addr: convert from discovery msg addr format to media addr format
100 * @raw2addr: convert from raw addr format to media addr format
Per Lidenb97bf3f2006-01-02 19:04:38 +0100101 * @priority: default link (and bearer) priority
102 * @tolerance: default time (in ms) before declaring link failure
103 * @window: default window (in packets) before declaring link congestion
Allan Stephensd265fef2010-11-30 12:00:53 +0000104 * @type_id: TIPC media identifier
Ying Xuee4d050c2013-12-10 20:45:43 -0800105 * @hwaddr_len: TIPC media address len
Per Lidenb97bf3f2006-01-02 19:04:38 +0100106 * @name: media name
107 */
Paul Gortmaker358a0d12011-12-29 20:19:42 -0500108struct tipc_media {
Ying Xue1da46562015-01-09 15:27:07 +0800109 int (*send_msg)(struct net *net, struct sk_buff *buf,
Per Lidenb97bf3f2006-01-02 19:04:38 +0100110 struct tipc_bearer *b_ptr,
111 struct tipc_media_addr *dest);
Erik Hugned0f91932015-03-05 10:23:49 +0100112 int (*enable_media)(struct net *net, struct tipc_bearer *b_ptr,
113 struct nlattr *attr[]);
Ying Xue4babbaa2013-10-18 07:23:17 +0200114 void (*disable_media)(struct tipc_bearer *b_ptr);
Jon Paul Maloy38504c22014-05-14 05:39:13 -0400115 int (*addr2str)(struct tipc_media_addr *addr,
116 char *strbuf,
117 int bufsz);
118 int (*addr2msg)(char *msg, struct tipc_media_addr *addr);
119 int (*msg2addr)(struct tipc_bearer *b,
120 struct tipc_media_addr *addr,
121 char *msg);
122 int (*raw2addr)(struct tipc_bearer *b,
123 struct tipc_media_addr *addr,
124 char *raw);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100125 u32 priority;
126 u32 tolerance;
127 u32 window;
128 u32 type_id;
Ying Xuee4d050c2013-12-10 20:45:43 -0800129 u32 hwaddr_len;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100130 char name[TIPC_MAX_MEDIA_NAME];
131};
132
133/**
Jon Paul Maloyef72a7e2013-12-10 20:45:40 -0800134 * struct tipc_bearer - Generic TIPC bearer structure
Ying Xuea8304522014-02-13 17:29:17 -0500135 * @media_ptr: pointer to additional media-specific information about bearer
Allan Stephens2d627b92011-01-07 13:00:11 -0500136 * @mtu: max packet size bearer can support
Allan Stephens2d627b92011-01-07 13:00:11 -0500137 * @addr: media-specific address associated with bearer
138 * @name: bearer name (format = media:interface)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100139 * @media: ptr to media structure associated with bearer
Jon Paul Maloyef72a7e2013-12-10 20:45:40 -0800140 * @bcast_addr: media address used in broadcasting
Ying Xuef8322df2014-04-21 10:55:45 +0800141 * @rcu: rcu struct for tipc_bearer
Per Lidenb97bf3f2006-01-02 19:04:38 +0100142 * @priority: default link priority for bearer
Allan Stephens5c216e12011-10-18 11:34:29 -0400143 * @window: default window size for bearer
144 * @tolerance: default link tolerance for bearer
Erik Hugnea21a5842014-03-28 10:32:08 +0100145 * @domain: network domain to which links can be established
Per Lidenb97bf3f2006-01-02 19:04:38 +0100146 * @identity: array index of this bearer within TIPC bearer array
147 * @link_req: ptr to (optional) structure making periodic link setup requests
Per Lidenb97bf3f2006-01-02 19:04:38 +0100148 * @net_plane: network plane ('A' through 'H') currently associated with bearer
149 * @nodes: indicates which nodes in cluster can be reached through bearer
Allan Stephens2d627b92011-01-07 13:00:11 -0500150 *
151 * Note: media-specific code is responsible for initialization of the fields
152 * indicated below when a bearer is enabled; TIPC's generic bearer code takes
153 * care of initializing all other fields.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100154 */
Allan Stephens2d627b92011-01-07 13:00:11 -0500155struct tipc_bearer {
Ying Xue2231c5a2014-04-21 10:55:47 +0800156 void __rcu *media_ptr; /* initalized by media */
Allan Stephens2d627b92011-01-07 13:00:11 -0500157 u32 mtu; /* initalized by media */
Allan Stephens2d627b92011-01-07 13:00:11 -0500158 struct tipc_media_addr addr; /* initalized by media */
159 char name[TIPC_MAX_BEARER_NAME];
Paul Gortmaker358a0d12011-12-29 20:19:42 -0500160 struct tipc_media *media;
Patrick McHardy8aeb89f2013-04-17 06:18:26 +0000161 struct tipc_media_addr bcast_addr;
Ying Xuef8322df2014-04-21 10:55:45 +0800162 struct rcu_head rcu;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100163 u32 priority;
Allan Stephens5c216e12011-10-18 11:34:29 -0400164 u32 window;
165 u32 tolerance;
Erik Hugnea21a5842014-03-28 10:32:08 +0100166 u32 domain;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100167 u32 identity;
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500168 struct tipc_link_req *link_req;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100169 char net_plane;
David S. Miller6c000552008-09-02 23:38:32 -0700170 struct tipc_node_map nodes;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100171};
172
Paul Gortmakerf19765f2011-12-29 21:39:49 -0500173struct tipc_bearer_names {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100174 char media_name[TIPC_MAX_MEDIA_NAME];
175 char if_name[TIPC_MAX_IF_NAME];
176};
177
Allan Stephensd265fef2010-11-30 12:00:53 +0000178/*
179 * TIPC routines available to supported media types
180 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000181
Ying Xuec93d3ba2015-01-09 15:27:04 +0800182void tipc_rcv(struct net *net, struct sk_buff *skb, struct tipc_bearer *b_ptr);
Allan Stephensd265fef2010-11-30 12:00:53 +0000183
184/*
185 * Routines made available to TIPC by supported media types
186 */
Jon Paul Maloy5702dba2013-12-10 20:45:39 -0800187extern struct tipc_media eth_media_info;
Allan Stephensd265fef2010-11-30 12:00:53 +0000188
Patrick McHardya29a1942013-04-17 06:18:28 +0000189#ifdef CONFIG_TIPC_MEDIA_IB
Jon Paul Maloy5702dba2013-12-10 20:45:39 -0800190extern struct tipc_media ib_media_info;
Patrick McHardya29a1942013-04-17 06:18:28 +0000191#endif
Erik Hugned0f91932015-03-05 10:23:49 +0100192#ifdef CONFIG_TIPC_MEDIA_UDP
193extern struct tipc_media udp_media_info;
194#endif
Patrick McHardya29a1942013-04-17 06:18:28 +0000195
Richard Alpe0655f6a2014-11-20 10:29:07 +0100196int tipc_nl_bearer_disable(struct sk_buff *skb, struct genl_info *info);
197int tipc_nl_bearer_enable(struct sk_buff *skb, struct genl_info *info);
Richard Alpe35b9dd72014-11-20 10:29:08 +0100198int tipc_nl_bearer_dump(struct sk_buff *skb, struct netlink_callback *cb);
199int tipc_nl_bearer_get(struct sk_buff *skb, struct genl_info *info);
Richard Alpe315c00b2014-11-20 10:29:09 +0100200int tipc_nl_bearer_set(struct sk_buff *skb, struct genl_info *info);
Richard Alpe0655f6a2014-11-20 10:29:07 +0100201
Richard Alpe46f15c62014-11-20 10:29:15 +0100202int tipc_nl_media_dump(struct sk_buff *skb, struct netlink_callback *cb);
203int tipc_nl_media_get(struct sk_buff *skb, struct genl_info *info);
Richard Alpe1e554172014-11-20 10:29:16 +0100204int tipc_nl_media_set(struct sk_buff *skb, struct genl_info *info);
Richard Alpe46f15c62014-11-20 10:29:15 +0100205
Allan Stephens5c216e12011-10-18 11:34:29 -0400206int tipc_media_set_priority(const char *name, u32 new_value);
207int tipc_media_set_window(const char *name, u32 new_value);
Erik Hugnedc1aed32012-06-29 00:50:23 -0400208void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a);
Erik Hugned0f91932015-03-05 10:23:49 +0100209int tipc_enable_l2_media(struct net *net, struct tipc_bearer *b,
210 struct nlattr *attrs[]);
Ying Xuee4d050c2013-12-10 20:45:43 -0800211void tipc_disable_l2_media(struct tipc_bearer *b);
Ying Xue1da46562015-01-09 15:27:07 +0800212int tipc_l2_send_msg(struct net *net, struct sk_buff *buf,
213 struct tipc_bearer *b, struct tipc_media_addr *dest);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100214
Ying Xue7f9f95d2015-01-09 15:27:06 +0800215void tipc_bearer_add_dest(struct net *net, u32 bearer_id, u32 dest);
216void tipc_bearer_remove_dest(struct net *net, u32 bearer_id, u32 dest);
217struct tipc_bearer *tipc_bearer_find(struct net *net, const char *name);
Paul Gortmaker358a0d12011-12-29 20:19:42 -0500218struct tipc_media *tipc_media_find(const char *name);
Ying Xue6e967ad2013-12-10 20:45:42 -0800219int tipc_bearer_setup(void);
220void tipc_bearer_cleanup(void);
Ying Xuef2f98002015-01-09 15:27:05 +0800221void tipc_bearer_stop(struct net *net);
Ying Xue7f9f95d2015-01-09 15:27:06 +0800222void tipc_bearer_send(struct net *net, u32 bearer_id, struct sk_buff *buf,
Ying Xuee4d050c2013-12-10 20:45:43 -0800223 struct tipc_media_addr *dest);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100224
Michal Kubeček016d0292016-12-14 13:24:58 +0100225/* check if device MTU is too low for tipc headers */
226static inline bool tipc_mtu_bad(struct net_device *dev, unsigned int reserve)
227{
228 if (dev->mtu >= TIPC_MIN_BEARER_MTU + reserve)
229 return false;
230 netdev_warn(dev, "MTU too low for tipc bearer\n");
231 return true;
232}
233
Allan Stephensb274f4a2010-05-11 14:30:16 +0000234#endif /* _TIPC_BEARER_H */