Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/bearer.h: Include file for TIPC bearer code | |
c4307285 | 3 | * |
0655f6a8 | 4 | * Copyright (c) 1996-2006, 2013-2014, 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 | ||
b97bf3fd | 40 | #include "bcast.h" |
0655f6a8 RA |
41 | #include "netlink.h" |
42 | #include <net/genetlink.h> | |
b97bf3fd | 43 | |
909234cd AS |
44 | #define MAX_BEARERS 2 |
45 | #define MAX_MEDIA 2 | |
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 | */ |
38504c28 | 52 | #define TIPC_MEDIA_ADDR_SIZE 32 |
4d163a32 AS |
53 | #define TIPC_MEDIA_TYPE_OFFSET 3 |
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 |
d265fef6 | 60 | |
2c53040f | 61 | /** |
3d749a6a AS |
62 | * struct tipc_media_addr - destination address used by TIPC bearers |
63 | * @value: address info (format defined by media) | |
64 | * @media_id: TIPC media type identifier | |
65 | * @broadcast: non-zero if address is a broadcast address | |
d265fef6 AS |
66 | */ |
67 | struct tipc_media_addr { | |
3d749a6a AS |
68 | u8 value[TIPC_MEDIA_ADDR_SIZE]; |
69 | u8 media_id; | |
70 | u8 broadcast; | |
d265fef6 AS |
71 | }; |
72 | ||
2d627b92 | 73 | struct tipc_bearer; |
b97bf3fd PL |
74 | |
75 | /** | |
ef72a7e0 | 76 | * struct tipc_media - Media specific info exposed to generic bearer layer |
b97bf3fd | 77 | * @send_msg: routine which handles buffer transmission |
4babbaa8 YX |
78 | * @enable_media: routine which enables a media |
79 | * @disable_media: routine which disables a media | |
38504c28 JPM |
80 | * @addr2str: convert media address format to string |
81 | * @addr2msg: convert from media addr format to discovery msg addr format | |
82 | * @msg2addr: convert from discovery msg addr format to media addr format | |
83 | * @raw2addr: convert from raw addr format to media addr format | |
b97bf3fd PL |
84 | * @priority: default link (and bearer) priority |
85 | * @tolerance: default time (in ms) before declaring link failure | |
86 | * @window: default window (in packets) before declaring link congestion | |
d265fef6 | 87 | * @type_id: TIPC media identifier |
e4d050cb | 88 | * @hwaddr_len: TIPC media address len |
b97bf3fd PL |
89 | * @name: media name |
90 | */ | |
358a0d1c | 91 | struct tipc_media { |
c4307285 | 92 | int (*send_msg)(struct sk_buff *buf, |
b97bf3fd PL |
93 | struct tipc_bearer *b_ptr, |
94 | struct tipc_media_addr *dest); | |
7f9f95d9 | 95 | int (*enable_media)(struct net *net, struct tipc_bearer *b_ptr); |
4babbaa8 | 96 | void (*disable_media)(struct tipc_bearer *b_ptr); |
38504c28 JPM |
97 | int (*addr2str)(struct tipc_media_addr *addr, |
98 | char *strbuf, | |
99 | int bufsz); | |
100 | int (*addr2msg)(char *msg, struct tipc_media_addr *addr); | |
101 | int (*msg2addr)(struct tipc_bearer *b, | |
102 | struct tipc_media_addr *addr, | |
103 | char *msg); | |
104 | int (*raw2addr)(struct tipc_bearer *b, | |
105 | struct tipc_media_addr *addr, | |
106 | char *raw); | |
b97bf3fd PL |
107 | u32 priority; |
108 | u32 tolerance; | |
109 | u32 window; | |
110 | u32 type_id; | |
e4d050cb | 111 | u32 hwaddr_len; |
b97bf3fd PL |
112 | char name[TIPC_MAX_MEDIA_NAME]; |
113 | }; | |
114 | ||
115 | /** | |
ef72a7e0 | 116 | * struct tipc_bearer - Generic TIPC bearer structure |
a8304529 | 117 | * @media_ptr: pointer to additional media-specific information about bearer |
2d627b92 | 118 | * @mtu: max packet size bearer can support |
2d627b92 AS |
119 | * @addr: media-specific address associated with bearer |
120 | * @name: bearer name (format = media:interface) | |
b97bf3fd | 121 | * @media: ptr to media structure associated with bearer |
ef72a7e0 | 122 | * @bcast_addr: media address used in broadcasting |
f8322dfc | 123 | * @rcu: rcu struct for tipc_bearer |
b97bf3fd | 124 | * @priority: default link priority for bearer |
5c216e1d AS |
125 | * @window: default window size for bearer |
126 | * @tolerance: default link tolerance for bearer | |
a21a584d | 127 | * @domain: network domain to which links can be established |
b97bf3fd PL |
128 | * @identity: array index of this bearer within TIPC bearer array |
129 | * @link_req: ptr to (optional) structure making periodic link setup requests | |
b97bf3fd PL |
130 | * @net_plane: network plane ('A' through 'H') currently associated with bearer |
131 | * @nodes: indicates which nodes in cluster can be reached through bearer | |
2d627b92 AS |
132 | * |
133 | * Note: media-specific code is responsible for initialization of the fields | |
134 | * indicated below when a bearer is enabled; TIPC's generic bearer code takes | |
135 | * care of initializing all other fields. | |
b97bf3fd | 136 | */ |
2d627b92 | 137 | struct tipc_bearer { |
2231c5af | 138 | void __rcu *media_ptr; /* initalized by media */ |
2d627b92 | 139 | u32 mtu; /* initalized by media */ |
2d627b92 AS |
140 | struct tipc_media_addr addr; /* initalized by media */ |
141 | char name[TIPC_MAX_BEARER_NAME]; | |
358a0d1c | 142 | struct tipc_media *media; |
8aeb89f2 | 143 | struct tipc_media_addr bcast_addr; |
f8322dfc | 144 | struct rcu_head rcu; |
b97bf3fd | 145 | u32 priority; |
5c216e1d AS |
146 | u32 window; |
147 | u32 tolerance; | |
a21a584d | 148 | u32 domain; |
b97bf3fd | 149 | u32 identity; |
a18c4bc3 | 150 | struct tipc_link_req *link_req; |
b97bf3fd | 151 | char net_plane; |
6c00055a | 152 | struct tipc_node_map nodes; |
b97bf3fd PL |
153 | }; |
154 | ||
f19765f4 | 155 | struct tipc_bearer_names { |
b97bf3fd PL |
156 | char media_name[TIPC_MAX_MEDIA_NAME]; |
157 | char if_name[TIPC_MAX_IF_NAME]; | |
158 | }; | |
159 | ||
a18c4bc3 | 160 | struct tipc_link; |
b97bf3fd | 161 | |
d265fef6 AS |
162 | /* |
163 | * TIPC routines available to supported media types | |
164 | */ | |
d265fef6 | 165 | |
c93d3baa YX |
166 | void tipc_rcv(struct net *net, struct sk_buff *skb, struct tipc_bearer *b_ptr); |
167 | int tipc_enable_bearer(struct net *net, const char *bearer_name, | |
168 | u32 disc_domain, u32 priority); | |
f2f9800d | 169 | int tipc_disable_bearer(struct net *net, const char *name); |
d265fef6 AS |
170 | |
171 | /* | |
172 | * Routines made available to TIPC by supported media types | |
173 | */ | |
5702dbab | 174 | extern struct tipc_media eth_media_info; |
d265fef6 | 175 | |
a29a194a | 176 | #ifdef CONFIG_TIPC_MEDIA_IB |
5702dbab | 177 | extern struct tipc_media ib_media_info; |
a29a194a PM |
178 | #endif |
179 | ||
0655f6a8 RA |
180 | int tipc_nl_bearer_disable(struct sk_buff *skb, struct genl_info *info); |
181 | int tipc_nl_bearer_enable(struct sk_buff *skb, struct genl_info *info); | |
35b9dd76 RA |
182 | int tipc_nl_bearer_dump(struct sk_buff *skb, struct netlink_callback *cb); |
183 | int tipc_nl_bearer_get(struct sk_buff *skb, struct genl_info *info); | |
315c00bc | 184 | int tipc_nl_bearer_set(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); |
4323add6 | 193 | struct sk_buff *tipc_media_get_names(void); |
7f9f95d9 | 194 | int tipc_enable_l2_media(struct net *net, struct tipc_bearer *b); |
e4d050cb YX |
195 | void tipc_disable_l2_media(struct tipc_bearer *b); |
196 | int tipc_l2_send_msg(struct sk_buff *buf, struct tipc_bearer *b, | |
197 | struct tipc_media_addr *dest); | |
b97bf3fd | 198 | |
7f9f95d9 YX |
199 | struct sk_buff *tipc_bearer_get_names(struct net *net); |
200 | void tipc_bearer_add_dest(struct net *net, u32 bearer_id, u32 dest); | |
201 | void tipc_bearer_remove_dest(struct net *net, u32 bearer_id, u32 dest); | |
202 | struct tipc_bearer *tipc_bearer_find(struct net *net, const char *name); | |
358a0d1c | 203 | struct tipc_media *tipc_media_find(const char *name); |
6e967adf YX |
204 | int tipc_bearer_setup(void); |
205 | void tipc_bearer_cleanup(void); | |
f2f9800d | 206 | void tipc_bearer_stop(struct net *net); |
7f9f95d9 | 207 | void tipc_bearer_send(struct net *net, u32 bearer_id, struct sk_buff *buf, |
e4d050cb | 208 | struct tipc_media_addr *dest); |
b97bf3fd | 209 | |
b274f4ab | 210 | #endif /* _TIPC_BEARER_H */ |