]>
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" |
0655f6a8 | 42 | #include <net/genetlink.h> |
b97bf3fd | 43 | |
d0f91938 | 44 | #define MAX_MEDIA 3 |
b97bf3fd | 45 | |
38504c28 JPM |
46 | /* Identifiers associated with TIPC message header media address info |
47 | * - address info field is 32 bytes long | |
48 | * - the field's actual content and length is defined per media | |
49 | * - remaining unused bytes in the field are set to zero | |
4d163a32 | 50 | */ |
91e2eb56 | 51 | #define TIPC_MEDIA_INFO_SIZE 32 |
4d163a32 | 52 | #define TIPC_MEDIA_TYPE_OFFSET 3 |
d76a436d | 53 | #define TIPC_MEDIA_ADDR_OFFSET 4 |
4d163a32 | 54 | |
d265fef6 AS |
55 | /* |
56 | * Identifiers of supported TIPC media types | |
57 | */ | |
58 | #define TIPC_MEDIA_TYPE_ETH 1 | |
a29a194a | 59 | #define TIPC_MEDIA_TYPE_IB 2 |
d0f91938 | 60 | #define TIPC_MEDIA_TYPE_UDP 3 |
d265fef6 | 61 | |
2c53040f | 62 | /** |
3d749a6a AS |
63 | * struct tipc_media_addr - destination address used by TIPC bearers |
64 | * @value: address info (format defined by media) | |
65 | * @media_id: TIPC media type identifier | |
66 | * @broadcast: non-zero if address is a broadcast address | |
d265fef6 AS |
67 | */ |
68 | struct tipc_media_addr { | |
91e2eb56 | 69 | u8 value[TIPC_MEDIA_INFO_SIZE]; |
3d749a6a AS |
70 | u8 media_id; |
71 | u8 broadcast; | |
d265fef6 AS |
72 | }; |
73 | ||
2d627b92 | 74 | struct tipc_bearer; |
b97bf3fd PL |
75 | |
76 | /** | |
ef72a7e0 | 77 | * struct tipc_media - Media specific info exposed to generic bearer layer |
b97bf3fd | 78 | * @send_msg: routine which handles buffer transmission |
4babbaa8 YX |
79 | * @enable_media: routine which enables a media |
80 | * @disable_media: routine which disables a media | |
38504c28 JPM |
81 | * @addr2str: convert media address format to string |
82 | * @addr2msg: convert from media addr format to discovery msg addr format | |
83 | * @msg2addr: convert from discovery msg addr format to media addr format | |
84 | * @raw2addr: convert from raw addr format to media addr format | |
b97bf3fd PL |
85 | * @priority: default link (and bearer) priority |
86 | * @tolerance: default time (in ms) before declaring link failure | |
87 | * @window: default window (in packets) before declaring link congestion | |
d265fef6 | 88 | * @type_id: TIPC media identifier |
e4d050cb | 89 | * @hwaddr_len: TIPC media address len |
b97bf3fd PL |
90 | * @name: media name |
91 | */ | |
358a0d1c | 92 | struct tipc_media { |
1da46568 | 93 | int (*send_msg)(struct net *net, struct sk_buff *buf, |
1a90632d | 94 | struct tipc_bearer *b, |
b97bf3fd | 95 | struct tipc_media_addr *dest); |
1a90632d | 96 | int (*enable_media)(struct net *net, struct tipc_bearer *b, |
d0f91938 | 97 | struct nlattr *attr[]); |
1a90632d | 98 | void (*disable_media)(struct tipc_bearer *b); |
38504c28 JPM |
99 | int (*addr2str)(struct tipc_media_addr *addr, |
100 | char *strbuf, | |
101 | int bufsz); | |
102 | int (*addr2msg)(char *msg, struct tipc_media_addr *addr); | |
103 | int (*msg2addr)(struct tipc_bearer *b, | |
104 | struct tipc_media_addr *addr, | |
105 | char *msg); | |
106 | int (*raw2addr)(struct tipc_bearer *b, | |
107 | struct tipc_media_addr *addr, | |
108 | char *raw); | |
b97bf3fd PL |
109 | u32 priority; |
110 | u32 tolerance; | |
111 | u32 window; | |
112 | u32 type_id; | |
e4d050cb | 113 | u32 hwaddr_len; |
b97bf3fd PL |
114 | char name[TIPC_MAX_MEDIA_NAME]; |
115 | }; | |
116 | ||
117 | /** | |
ef72a7e0 | 118 | * struct tipc_bearer - Generic TIPC bearer structure |
a8304529 | 119 | * @media_ptr: pointer to additional media-specific information about bearer |
2d627b92 | 120 | * @mtu: max packet size bearer can support |
2d627b92 AS |
121 | * @addr: media-specific address associated with bearer |
122 | * @name: bearer name (format = media:interface) | |
b97bf3fd | 123 | * @media: ptr to media structure associated with bearer |
ef72a7e0 | 124 | * @bcast_addr: media address used in broadcasting |
f8322dfc | 125 | * @rcu: rcu struct for tipc_bearer |
b97bf3fd | 126 | * @priority: default link priority for bearer |
5c216e1d AS |
127 | * @window: default window size for bearer |
128 | * @tolerance: default link tolerance for bearer | |
a21a584d | 129 | * @domain: network domain to which links can be established |
b97bf3fd PL |
130 | * @identity: array index of this bearer within TIPC bearer array |
131 | * @link_req: ptr to (optional) structure making periodic link setup requests | |
b97bf3fd | 132 | * @net_plane: network plane ('A' through 'H') currently associated with bearer |
2d627b92 AS |
133 | * |
134 | * Note: media-specific code is responsible for initialization of the fields | |
135 | * indicated below when a bearer is enabled; TIPC's generic bearer code takes | |
136 | * care of initializing all other fields. | |
b97bf3fd | 137 | */ |
2d627b92 | 138 | struct tipc_bearer { |
2231c5af | 139 | void __rcu *media_ptr; /* initalized by media */ |
2d627b92 | 140 | u32 mtu; /* initalized by media */ |
2d627b92 AS |
141 | struct tipc_media_addr addr; /* initalized by media */ |
142 | char name[TIPC_MAX_BEARER_NAME]; | |
358a0d1c | 143 | struct tipc_media *media; |
8aeb89f2 | 144 | struct tipc_media_addr bcast_addr; |
f8322dfc | 145 | struct rcu_head rcu; |
b97bf3fd | 146 | u32 priority; |
5c216e1d AS |
147 | u32 window; |
148 | u32 tolerance; | |
a21a584d | 149 | u32 domain; |
b97bf3fd | 150 | u32 identity; |
a18c4bc3 | 151 | struct tipc_link_req *link_req; |
b97bf3fd | 152 | char net_plane; |
0d051bf9 | 153 | unsigned long up; |
b97bf3fd PL |
154 | }; |
155 | ||
f19765f4 | 156 | struct tipc_bearer_names { |
b97bf3fd PL |
157 | char media_name[TIPC_MAX_MEDIA_NAME]; |
158 | char if_name[TIPC_MAX_IF_NAME]; | |
159 | }; | |
160 | ||
d265fef6 AS |
161 | /* |
162 | * TIPC routines available to supported media types | |
163 | */ | |
d265fef6 | 164 | |
1a90632d | 165 | void tipc_rcv(struct net *net, struct sk_buff *skb, struct tipc_bearer *b); |
d265fef6 AS |
166 | |
167 | /* | |
168 | * Routines made available to TIPC by supported media types | |
169 | */ | |
5702dbab | 170 | extern struct tipc_media eth_media_info; |
d265fef6 | 171 | |
a29a194a | 172 | #ifdef CONFIG_TIPC_MEDIA_IB |
5702dbab | 173 | extern struct tipc_media ib_media_info; |
a29a194a | 174 | #endif |
d0f91938 EH |
175 | #ifdef CONFIG_TIPC_MEDIA_UDP |
176 | extern struct tipc_media udp_media_info; | |
177 | #endif | |
a29a194a | 178 | |
0655f6a8 RA |
179 | int tipc_nl_bearer_disable(struct sk_buff *skb, struct genl_info *info); |
180 | int tipc_nl_bearer_enable(struct sk_buff *skb, struct genl_info *info); | |
35b9dd76 RA |
181 | int tipc_nl_bearer_dump(struct sk_buff *skb, struct netlink_callback *cb); |
182 | int tipc_nl_bearer_get(struct sk_buff *skb, struct genl_info *info); | |
315c00bc | 183 | int tipc_nl_bearer_set(struct sk_buff *skb, struct genl_info *info); |
ef20cd4d | 184 | int tipc_nl_bearer_add(struct sk_buff *skb, struct genl_info *info); |
0655f6a8 | 185 | |
46f15c67 RA |
186 | int tipc_nl_media_dump(struct sk_buff *skb, struct netlink_callback *cb); |
187 | int tipc_nl_media_get(struct sk_buff *skb, struct genl_info *info); | |
1e55417d | 188 | int tipc_nl_media_set(struct sk_buff *skb, struct genl_info *info); |
46f15c67 | 189 | |
5c216e1d AS |
190 | int tipc_media_set_priority(const char *name, u32 new_value); |
191 | int tipc_media_set_window(const char *name, u32 new_value); | |
dc1aed37 | 192 | void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a); |
d0f91938 EH |
193 | int tipc_enable_l2_media(struct net *net, struct tipc_bearer *b, |
194 | struct nlattr *attrs[]); | |
e4d050cb | 195 | void tipc_disable_l2_media(struct tipc_bearer *b); |
1da46568 YX |
196 | int tipc_l2_send_msg(struct net *net, struct sk_buff *buf, |
197 | struct tipc_bearer *b, struct tipc_media_addr *dest); | |
b97bf3fd | 198 | |
7f9f95d9 YX |
199 | void tipc_bearer_add_dest(struct net *net, u32 bearer_id, u32 dest); |
200 | void tipc_bearer_remove_dest(struct net *net, u32 bearer_id, u32 dest); | |
201 | struct tipc_bearer *tipc_bearer_find(struct net *net, const char *name); | |
ff0d3e78 | 202 | int tipc_bearer_get_name(struct net *net, char *name, u32 bearer_id); |
358a0d1c | 203 | struct tipc_media *tipc_media_find(const char *name); |
1fc07f3e | 204 | void tipc_bearer_reset_all(struct net *net); |
6e967adf YX |
205 | int tipc_bearer_setup(void); |
206 | void tipc_bearer_cleanup(void); | |
f2f9800d | 207 | void tipc_bearer_stop(struct net *net); |
959e1781 | 208 | int tipc_bearer_mtu(struct net *net, u32 bearer_id); |
60852d67 JPM |
209 | void tipc_bearer_xmit_skb(struct net *net, u32 bearer_id, |
210 | struct sk_buff *skb, | |
211 | struct tipc_media_addr *dest); | |
af9b028e JPM |
212 | void tipc_bearer_xmit(struct net *net, u32 bearer_id, |
213 | struct sk_buff_head *xmitq, | |
214 | struct tipc_media_addr *dst); | |
b06b281e JPM |
215 | void tipc_bearer_bc_xmit(struct net *net, u32 bearer_id, |
216 | struct sk_buff_head *xmitq); | |
b97bf3fd | 217 | |
b274f4ab | 218 | #endif /* _TIPC_BEARER_H */ |