]>
Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
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. |
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: |
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) |
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 | */ |
77 | struct tipc_media_addr { | |
91e2eb56 | 78 | u8 value[TIPC_MEDIA_INFO_SIZE]; |
3d749a6a AS |
79 | u8 media_id; |
80 | u8 broadcast; | |
d265fef6 AS |
81 | }; |
82 | ||
2d627b92 | 83 | struct tipc_bearer; |
b97bf3fd PL |
84 | |
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 |
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 | |
901271e0 GM |
97 | * @mtu: max packet size bearer can support for media type not dependent on |
98 | * underlying device MTU | |
d265fef6 | 99 | * @type_id: TIPC media identifier |
e4d050cb | 100 | * @hwaddr_len: TIPC media address len |
b97bf3fd PL |
101 | * @name: media name |
102 | */ | |
358a0d1c | 103 | struct tipc_media { |
1da46568 | 104 | int (*send_msg)(struct net *net, struct sk_buff *buf, |
1a90632d | 105 | struct tipc_bearer *b, |
b97bf3fd | 106 | struct tipc_media_addr *dest); |
1a90632d | 107 | int (*enable_media)(struct net *net, struct tipc_bearer *b, |
d0f91938 | 108 | struct nlattr *attr[]); |
1a90632d | 109 | void (*disable_media)(struct tipc_bearer *b); |
38504c28 JPM |
110 | int (*addr2str)(struct tipc_media_addr *addr, |
111 | char *strbuf, | |
112 | int bufsz); | |
113 | int (*addr2msg)(char *msg, struct tipc_media_addr *addr); | |
114 | int (*msg2addr)(struct tipc_bearer *b, | |
115 | struct tipc_media_addr *addr, | |
116 | char *msg); | |
117 | int (*raw2addr)(struct tipc_bearer *b, | |
118 | struct tipc_media_addr *addr, | |
119 | char *raw); | |
b97bf3fd PL |
120 | u32 priority; |
121 | u32 tolerance; | |
122 | u32 window; | |
901271e0 | 123 | u32 mtu; |
b97bf3fd | 124 | u32 type_id; |
e4d050cb | 125 | u32 hwaddr_len; |
b97bf3fd PL |
126 | char name[TIPC_MAX_MEDIA_NAME]; |
127 | }; | |
128 | ||
129 | /** | |
ef72a7e0 | 130 | * struct tipc_bearer - Generic TIPC bearer structure |
a8304529 | 131 | * @media_ptr: pointer to additional media-specific information about bearer |
2d627b92 | 132 | * @mtu: max packet size bearer can support |
2d627b92 AS |
133 | * @addr: media-specific address associated with bearer |
134 | * @name: bearer name (format = media:interface) | |
b97bf3fd | 135 | * @media: ptr to media structure associated with bearer |
ef72a7e0 | 136 | * @bcast_addr: media address used in broadcasting |
d55c60eb | 137 | * @pt: packet type for bearer |
f8322dfc | 138 | * @rcu: rcu struct for tipc_bearer |
b97bf3fd | 139 | * @priority: default link priority for bearer |
5c216e1d AS |
140 | * @window: default window size for bearer |
141 | * @tolerance: default link tolerance for bearer | |
a21a584d | 142 | * @domain: network domain to which links can be established |
b97bf3fd PL |
143 | * @identity: array index of this bearer within TIPC bearer array |
144 | * @link_req: ptr to (optional) structure making periodic link setup requests | |
b97bf3fd | 145 | * @net_plane: network plane ('A' through 'H') currently associated with bearer |
2d627b92 AS |
146 | * |
147 | * Note: media-specific code is responsible for initialization of the fields | |
148 | * indicated below when a bearer is enabled; TIPC's generic bearer code takes | |
149 | * care of initializing all other fields. | |
b97bf3fd | 150 | */ |
2d627b92 | 151 | struct tipc_bearer { |
2231c5af | 152 | void __rcu *media_ptr; /* initalized by media */ |
2d627b92 | 153 | u32 mtu; /* initalized by media */ |
2d627b92 AS |
154 | struct tipc_media_addr addr; /* initalized by media */ |
155 | char name[TIPC_MAX_BEARER_NAME]; | |
358a0d1c | 156 | struct tipc_media *media; |
8aeb89f2 | 157 | struct tipc_media_addr bcast_addr; |
d55c60eb | 158 | struct packet_type pt; |
f8322dfc | 159 | struct rcu_head rcu; |
b97bf3fd | 160 | u32 priority; |
5c216e1d AS |
161 | u32 window; |
162 | u32 tolerance; | |
a21a584d | 163 | u32 domain; |
b97bf3fd | 164 | u32 identity; |
b39e465e | 165 | struct tipc_discoverer *disc; |
b97bf3fd | 166 | char net_plane; |
0d051bf9 | 167 | unsigned long up; |
2a7ee696 | 168 | refcount_t refcnt; |
b97bf3fd PL |
169 | }; |
170 | ||
f19765f4 | 171 | struct tipc_bearer_names { |
b97bf3fd PL |
172 | char media_name[TIPC_MAX_MEDIA_NAME]; |
173 | char if_name[TIPC_MAX_IF_NAME]; | |
174 | }; | |
175 | ||
d265fef6 AS |
176 | /* |
177 | * TIPC routines available to supported media types | |
178 | */ | |
d265fef6 | 179 | |
1a90632d | 180 | void tipc_rcv(struct net *net, struct sk_buff *skb, struct tipc_bearer *b); |
d265fef6 AS |
181 | |
182 | /* | |
183 | * Routines made available to TIPC by supported media types | |
184 | */ | |
5702dbab | 185 | extern struct tipc_media eth_media_info; |
d265fef6 | 186 | |
a29a194a | 187 | #ifdef CONFIG_TIPC_MEDIA_IB |
5702dbab | 188 | extern struct tipc_media ib_media_info; |
a29a194a | 189 | #endif |
d0f91938 EH |
190 | #ifdef CONFIG_TIPC_MEDIA_UDP |
191 | extern struct tipc_media udp_media_info; | |
192 | #endif | |
a29a194a | 193 | |
0655f6a8 | 194 | int tipc_nl_bearer_disable(struct sk_buff *skb, struct genl_info *info); |
d59d8b77 | 195 | int __tipc_nl_bearer_disable(struct sk_buff *skb, struct genl_info *info); |
0655f6a8 | 196 | int tipc_nl_bearer_enable(struct sk_buff *skb, struct genl_info *info); |
45cf7edf | 197 | int __tipc_nl_bearer_enable(struct sk_buff *skb, struct genl_info *info); |
35b9dd76 RA |
198 | int tipc_nl_bearer_dump(struct sk_buff *skb, struct netlink_callback *cb); |
199 | int tipc_nl_bearer_get(struct sk_buff *skb, struct genl_info *info); | |
315c00bc | 200 | int tipc_nl_bearer_set(struct sk_buff *skb, struct genl_info *info); |
93532bb1 | 201 | int __tipc_nl_bearer_set(struct sk_buff *skb, struct genl_info *info); |
ef20cd4d | 202 | int tipc_nl_bearer_add(struct sk_buff *skb, struct genl_info *info); |
0655f6a8 | 203 | |
46f15c67 RA |
204 | int tipc_nl_media_dump(struct sk_buff *skb, struct netlink_callback *cb); |
205 | int tipc_nl_media_get(struct sk_buff *skb, struct genl_info *info); | |
1e55417d | 206 | int tipc_nl_media_set(struct sk_buff *skb, struct genl_info *info); |
07ffb223 | 207 | int __tipc_nl_media_set(struct sk_buff *skb, struct genl_info *info); |
46f15c67 | 208 | |
5c216e1d AS |
209 | int tipc_media_set_priority(const char *name, u32 new_value); |
210 | int tipc_media_set_window(const char *name, u32 new_value); | |
b4b9771b | 211 | int tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a); |
d0f91938 EH |
212 | int tipc_enable_l2_media(struct net *net, struct tipc_bearer *b, |
213 | struct nlattr *attrs[]); | |
2a7ee696 TL |
214 | bool tipc_bearer_hold(struct tipc_bearer *b); |
215 | void tipc_bearer_put(struct tipc_bearer *b); | |
e4d050cb | 216 | void tipc_disable_l2_media(struct tipc_bearer *b); |
1da46568 YX |
217 | int tipc_l2_send_msg(struct net *net, struct sk_buff *buf, |
218 | struct tipc_bearer *b, struct tipc_media_addr *dest); | |
b97bf3fd | 219 | |
7f9f95d9 YX |
220 | void tipc_bearer_add_dest(struct net *net, u32 bearer_id, u32 dest); |
221 | void tipc_bearer_remove_dest(struct net *net, u32 bearer_id, u32 dest); | |
222 | struct tipc_bearer *tipc_bearer_find(struct net *net, const char *name); | |
ff0d3e78 | 223 | int tipc_bearer_get_name(struct net *net, char *name, u32 bearer_id); |
358a0d1c | 224 | struct tipc_media *tipc_media_find(const char *name); |
6e967adf YX |
225 | int tipc_bearer_setup(void); |
226 | void tipc_bearer_cleanup(void); | |
f2f9800d | 227 | void tipc_bearer_stop(struct net *net); |
959e1781 | 228 | int tipc_bearer_mtu(struct net *net, u32 bearer_id); |
9999974a | 229 | bool tipc_bearer_bcast_support(struct net *net, u32 bearer_id); |
60852d67 JPM |
230 | void tipc_bearer_xmit_skb(struct net *net, u32 bearer_id, |
231 | struct sk_buff *skb, | |
232 | struct tipc_media_addr *dest); | |
af9b028e JPM |
233 | void tipc_bearer_xmit(struct net *net, u32 bearer_id, |
234 | struct sk_buff_head *xmitq, | |
fc1b6d6d TL |
235 | struct tipc_media_addr *dst, |
236 | struct tipc_node *__dnode); | |
b06b281e JPM |
237 | void tipc_bearer_bc_xmit(struct net *net, u32 bearer_id, |
238 | struct sk_buff_head *xmitq); | |
6c9081a3 JR |
239 | void tipc_clone_to_loopback(struct net *net, struct sk_buff_head *pkts); |
240 | int tipc_attach_loopback(struct net *net); | |
241 | void tipc_detach_loopback(struct net *net); | |
242 | ||
243 | static inline void tipc_loopback_trace(struct net *net, | |
244 | struct sk_buff_head *pkts) | |
245 | { | |
246 | if (unlikely(dev_nit_active(net->loopback_dev))) | |
247 | tipc_clone_to_loopback(net, pkts); | |
248 | } | |
b97bf3fd | 249 | |
3de81b75 MK |
250 | /* check if device MTU is too low for tipc headers */ |
251 | static inline bool tipc_mtu_bad(struct net_device *dev, unsigned int reserve) | |
252 | { | |
253 | if (dev->mtu >= TIPC_MIN_BEARER_MTU + reserve) | |
254 | return false; | |
255 | netdev_warn(dev, "MTU too low for tipc bearer\n"); | |
256 | return true; | |
257 | } | |
258 | ||
b274f4ab | 259 | #endif /* _TIPC_BEARER_H */ |