Loading...
1/*
2 * net/tipc/bearer.h: Include file for TIPC bearer code
3 *
4 * Copyright (c) 1996-2006, 2013-2014, Ericsson AB
5 * Copyright (c) 2005, 2010-2011, Wind River Systems
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 *
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.
19 *
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
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_BEARER_H
38#define _TIPC_BEARER_H
39
40#include "netlink.h"
41#include "core.h"
42#include <net/genetlink.h>
43
44#define MAX_MEDIA 3
45#define MAX_NODES 4096
46#define WSIZE 32
47
48/* Identifiers associated with TIPC message header media address info
49 * - address info field is 32 bytes long
50 * - the field's actual content and length is defined per media
51 * - remaining unused bytes in the field are set to zero
52 */
53#define TIPC_MEDIA_INFO_SIZE 32
54#define TIPC_MEDIA_TYPE_OFFSET 3
55#define TIPC_MEDIA_ADDR_OFFSET 4
56
57/*
58 * Identifiers of supported TIPC media types
59 */
60#define TIPC_MEDIA_TYPE_ETH 1
61#define TIPC_MEDIA_TYPE_IB 2
62#define TIPC_MEDIA_TYPE_UDP 3
63
64/**
65 * struct tipc_node_map - set of node identifiers
66 * @count: # of nodes in set
67 * @map: bitmap of node identifiers that are in the set
68 */
69struct tipc_node_map {
70 u32 count;
71 u32 map[MAX_NODES / WSIZE];
72};
73
74/**
75 * struct tipc_media_addr - destination address used by TIPC bearers
76 * @value: address info (format defined by media)
77 * @media_id: TIPC media type identifier
78 * @broadcast: non-zero if address is a broadcast address
79 */
80struct tipc_media_addr {
81 u8 value[TIPC_MEDIA_INFO_SIZE];
82 u8 media_id;
83 u8 broadcast;
84};
85
86struct tipc_bearer;
87
88/**
89 * struct tipc_media - Media specific info exposed to generic bearer layer
90 * @send_msg: routine which handles buffer transmission
91 * @enable_media: routine which enables a media
92 * @disable_media: routine which disables a media
93 * @addr2str: convert media address format to string
94 * @addr2msg: convert from media addr format to discovery msg addr format
95 * @msg2addr: convert from discovery msg addr format to media addr format
96 * @raw2addr: convert from raw addr format to media addr format
97 * @priority: default link (and bearer) priority
98 * @tolerance: default time (in ms) before declaring link failure
99 * @window: default window (in packets) before declaring link congestion
100 * @type_id: TIPC media identifier
101 * @hwaddr_len: TIPC media address len
102 * @name: media name
103 */
104struct tipc_media {
105 int (*send_msg)(struct net *net, struct sk_buff *buf,
106 struct tipc_bearer *b,
107 struct tipc_media_addr *dest);
108 int (*enable_media)(struct net *net, struct tipc_bearer *b,
109 struct nlattr *attr[]);
110 void (*disable_media)(struct tipc_bearer *b);
111 int (*addr2str)(struct tipc_media_addr *addr,
112 char *strbuf,
113 int bufsz);
114 int (*addr2msg)(char *msg, struct tipc_media_addr *addr);
115 int (*msg2addr)(struct tipc_bearer *b,
116 struct tipc_media_addr *addr,
117 char *msg);
118 int (*raw2addr)(struct tipc_bearer *b,
119 struct tipc_media_addr *addr,
120 char *raw);
121 u32 priority;
122 u32 tolerance;
123 u32 window;
124 u32 type_id;
125 u32 hwaddr_len;
126 char name[TIPC_MAX_MEDIA_NAME];
127};
128
129/**
130 * struct tipc_bearer - Generic TIPC bearer structure
131 * @media_ptr: pointer to additional media-specific information about bearer
132 * @mtu: max packet size bearer can support
133 * @addr: media-specific address associated with bearer
134 * @name: bearer name (format = media:interface)
135 * @media: ptr to media structure associated with bearer
136 * @bcast_addr: media address used in broadcasting
137 * @rcu: rcu struct for tipc_bearer
138 * @priority: default link priority for bearer
139 * @window: default window size for bearer
140 * @tolerance: default link tolerance for bearer
141 * @domain: network domain to which links can be established
142 * @identity: array index of this bearer within TIPC bearer array
143 * @link_req: ptr to (optional) structure making periodic link setup requests
144 * @net_plane: network plane ('A' through 'H') currently associated with bearer
145 * @nodes: indicates which nodes in cluster can be reached through bearer
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.
150 */
151struct tipc_bearer {
152 void __rcu *media_ptr; /* initalized by media */
153 u32 mtu; /* initalized by media */
154 struct tipc_media_addr addr; /* initalized by media */
155 char name[TIPC_MAX_BEARER_NAME];
156 struct tipc_media *media;
157 struct tipc_media_addr bcast_addr;
158 struct rcu_head rcu;
159 u32 priority;
160 u32 window;
161 u32 tolerance;
162 u32 domain;
163 u32 identity;
164 struct tipc_link_req *link_req;
165 char net_plane;
166 int node_cnt;
167 struct tipc_node_map nodes;
168};
169
170struct tipc_bearer_names {
171 char media_name[TIPC_MAX_MEDIA_NAME];
172 char if_name[TIPC_MAX_IF_NAME];
173};
174
175/*
176 * TIPC routines available to supported media types
177 */
178
179void tipc_rcv(struct net *net, struct sk_buff *skb, struct tipc_bearer *b);
180
181/*
182 * Routines made available to TIPC by supported media types
183 */
184extern struct tipc_media eth_media_info;
185
186#ifdef CONFIG_TIPC_MEDIA_IB
187extern struct tipc_media ib_media_info;
188#endif
189#ifdef CONFIG_TIPC_MEDIA_UDP
190extern struct tipc_media udp_media_info;
191#endif
192
193int tipc_nl_bearer_disable(struct sk_buff *skb, struct genl_info *info);
194int tipc_nl_bearer_enable(struct sk_buff *skb, struct genl_info *info);
195int tipc_nl_bearer_dump(struct sk_buff *skb, struct netlink_callback *cb);
196int tipc_nl_bearer_get(struct sk_buff *skb, struct genl_info *info);
197int tipc_nl_bearer_set(struct sk_buff *skb, struct genl_info *info);
198
199int tipc_nl_media_dump(struct sk_buff *skb, struct netlink_callback *cb);
200int tipc_nl_media_get(struct sk_buff *skb, struct genl_info *info);
201int tipc_nl_media_set(struct sk_buff *skb, struct genl_info *info);
202
203int tipc_media_set_priority(const char *name, u32 new_value);
204int tipc_media_set_window(const char *name, u32 new_value);
205void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a);
206int tipc_enable_l2_media(struct net *net, struct tipc_bearer *b,
207 struct nlattr *attrs[]);
208void tipc_disable_l2_media(struct tipc_bearer *b);
209int tipc_l2_send_msg(struct net *net, struct sk_buff *buf,
210 struct tipc_bearer *b, struct tipc_media_addr *dest);
211
212void tipc_bearer_add_dest(struct net *net, u32 bearer_id, u32 dest);
213void tipc_bearer_remove_dest(struct net *net, u32 bearer_id, u32 dest);
214struct tipc_bearer *tipc_bearer_find(struct net *net, const char *name);
215struct tipc_media *tipc_media_find(const char *name);
216int tipc_bearer_setup(void);
217void tipc_bearer_cleanup(void);
218void tipc_bearer_stop(struct net *net);
219int tipc_bearer_mtu(struct net *net, u32 bearer_id);
220void tipc_bearer_xmit_skb(struct net *net, u32 bearer_id,
221 struct sk_buff *skb,
222 struct tipc_media_addr *dest);
223void tipc_bearer_xmit(struct net *net, u32 bearer_id,
224 struct sk_buff_head *xmitq,
225 struct tipc_media_addr *dst);
226void tipc_bearer_bc_xmit(struct net *net, u32 bearer_id,
227 struct sk_buff_head *xmitq);
228
229#endif /* _TIPC_BEARER_H */
1/*
2 * net/tipc/bearer.h: Include file for TIPC bearer code
3 *
4 * Copyright (c) 1996-2006, 2013-2016, Ericsson AB
5 * Copyright (c) 2005, 2010-2011, Wind River Systems
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 *
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.
19 *
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
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_BEARER_H
38#define _TIPC_BEARER_H
39
40#include "netlink.h"
41#include "core.h"
42#include "msg.h"
43#include <net/genetlink.h>
44
45#define MAX_MEDIA 3
46
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
51 */
52#define TIPC_MEDIA_INFO_SIZE 32
53#define TIPC_MEDIA_TYPE_OFFSET 3
54#define TIPC_MEDIA_ADDR_OFFSET 4
55
56/*
57 * Identifiers of supported TIPC media types
58 */
59#define TIPC_MEDIA_TYPE_ETH 1
60#define TIPC_MEDIA_TYPE_IB 2
61#define TIPC_MEDIA_TYPE_UDP 3
62
63/* Minimum bearer MTU */
64#define TIPC_MIN_BEARER_MTU (MAX_H_SIZE + INT_H_SIZE)
65
66/* Identifiers for distinguishing between broadcast/multicast and replicast
67 */
68#define TIPC_BROADCAST_SUPPORT 1
69#define TIPC_REPLICAST_SUPPORT 2
70
71/**
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
76 */
77struct tipc_media_addr {
78 u8 value[TIPC_MEDIA_INFO_SIZE];
79 u8 media_id;
80 u8 broadcast;
81};
82
83struct tipc_bearer;
84
85/**
86 * struct tipc_media - Media specific info exposed to generic bearer layer
87 * @send_msg: routine which handles buffer transmission
88 * @enable_media: routine which enables a media
89 * @disable_media: routine which disables a media
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
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
97 * @type_id: TIPC media identifier
98 * @hwaddr_len: TIPC media address len
99 * @name: media name
100 */
101struct tipc_media {
102 int (*send_msg)(struct net *net, struct sk_buff *buf,
103 struct tipc_bearer *b,
104 struct tipc_media_addr *dest);
105 int (*enable_media)(struct net *net, struct tipc_bearer *b,
106 struct nlattr *attr[]);
107 void (*disable_media)(struct tipc_bearer *b);
108 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);
118 u32 priority;
119 u32 tolerance;
120 u32 window;
121 u32 type_id;
122 u32 hwaddr_len;
123 char name[TIPC_MAX_MEDIA_NAME];
124};
125
126/**
127 * struct tipc_bearer - Generic TIPC bearer structure
128 * @media_ptr: pointer to additional media-specific information about bearer
129 * @mtu: max packet size bearer can support
130 * @addr: media-specific address associated with bearer
131 * @name: bearer name (format = media:interface)
132 * @media: ptr to media structure associated with bearer
133 * @bcast_addr: media address used in broadcasting
134 * @pt: packet type for bearer
135 * @rcu: rcu struct for tipc_bearer
136 * @priority: default link priority for bearer
137 * @window: default window size for bearer
138 * @tolerance: default link tolerance for bearer
139 * @domain: network domain to which links can be established
140 * @identity: array index of this bearer within TIPC bearer array
141 * @link_req: ptr to (optional) structure making periodic link setup requests
142 * @net_plane: network plane ('A' through 'H') currently associated with bearer
143 *
144 * Note: media-specific code is responsible for initialization of the fields
145 * indicated below when a bearer is enabled; TIPC's generic bearer code takes
146 * care of initializing all other fields.
147 */
148struct tipc_bearer {
149 void __rcu *media_ptr; /* initalized by media */
150 u32 mtu; /* initalized by media */
151 struct tipc_media_addr addr; /* initalized by media */
152 char name[TIPC_MAX_BEARER_NAME];
153 struct tipc_media *media;
154 struct tipc_media_addr bcast_addr;
155 struct packet_type pt;
156 struct rcu_head rcu;
157 u32 priority;
158 u32 window;
159 u32 tolerance;
160 u32 domain;
161 u32 identity;
162 struct tipc_discoverer *disc;
163 char net_plane;
164 unsigned long up;
165};
166
167struct tipc_bearer_names {
168 char media_name[TIPC_MAX_MEDIA_NAME];
169 char if_name[TIPC_MAX_IF_NAME];
170};
171
172/*
173 * TIPC routines available to supported media types
174 */
175
176void tipc_rcv(struct net *net, struct sk_buff *skb, struct tipc_bearer *b);
177
178/*
179 * Routines made available to TIPC by supported media types
180 */
181extern struct tipc_media eth_media_info;
182
183#ifdef CONFIG_TIPC_MEDIA_IB
184extern struct tipc_media ib_media_info;
185#endif
186#ifdef CONFIG_TIPC_MEDIA_UDP
187extern struct tipc_media udp_media_info;
188#endif
189
190int tipc_nl_bearer_disable(struct sk_buff *skb, struct genl_info *info);
191int __tipc_nl_bearer_disable(struct sk_buff *skb, struct genl_info *info);
192int tipc_nl_bearer_enable(struct sk_buff *skb, struct genl_info *info);
193int __tipc_nl_bearer_enable(struct sk_buff *skb, struct genl_info *info);
194int tipc_nl_bearer_dump(struct sk_buff *skb, struct netlink_callback *cb);
195int tipc_nl_bearer_get(struct sk_buff *skb, struct genl_info *info);
196int tipc_nl_bearer_set(struct sk_buff *skb, struct genl_info *info);
197int __tipc_nl_bearer_set(struct sk_buff *skb, struct genl_info *info);
198int tipc_nl_bearer_add(struct sk_buff *skb, struct genl_info *info);
199
200int tipc_nl_media_dump(struct sk_buff *skb, struct netlink_callback *cb);
201int tipc_nl_media_get(struct sk_buff *skb, struct genl_info *info);
202int tipc_nl_media_set(struct sk_buff *skb, struct genl_info *info);
203int __tipc_nl_media_set(struct sk_buff *skb, struct genl_info *info);
204
205int tipc_media_set_priority(const char *name, u32 new_value);
206int tipc_media_set_window(const char *name, u32 new_value);
207void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a);
208int tipc_enable_l2_media(struct net *net, struct tipc_bearer *b,
209 struct nlattr *attrs[]);
210void tipc_disable_l2_media(struct tipc_bearer *b);
211int tipc_l2_send_msg(struct net *net, struct sk_buff *buf,
212 struct tipc_bearer *b, struct tipc_media_addr *dest);
213
214void tipc_bearer_add_dest(struct net *net, u32 bearer_id, u32 dest);
215void tipc_bearer_remove_dest(struct net *net, u32 bearer_id, u32 dest);
216struct tipc_bearer *tipc_bearer_find(struct net *net, const char *name);
217int tipc_bearer_get_name(struct net *net, char *name, u32 bearer_id);
218struct tipc_media *tipc_media_find(const char *name);
219int tipc_bearer_setup(void);
220void tipc_bearer_cleanup(void);
221void tipc_bearer_stop(struct net *net);
222int tipc_bearer_mtu(struct net *net, u32 bearer_id);
223bool tipc_bearer_bcast_support(struct net *net, u32 bearer_id);
224void tipc_bearer_xmit_skb(struct net *net, u32 bearer_id,
225 struct sk_buff *skb,
226 struct tipc_media_addr *dest);
227void tipc_bearer_xmit(struct net *net, u32 bearer_id,
228 struct sk_buff_head *xmitq,
229 struct tipc_media_addr *dst);
230void tipc_bearer_bc_xmit(struct net *net, u32 bearer_id,
231 struct sk_buff_head *xmitq);
232
233/* check if device MTU is too low for tipc headers */
234static inline bool tipc_mtu_bad(struct net_device *dev, unsigned int reserve)
235{
236 if (dev->mtu >= TIPC_MIN_BEARER_MTU + reserve)
237 return false;
238 netdev_warn(dev, "MTU too low for tipc bearer\n");
239 return true;
240}
241
242#endif /* _TIPC_BEARER_H */