Loading...
1/*
2 * net/tipc/bearer.h: Include file for TIPC bearer code
3 *
4 * Copyright (c) 1996-2006, 2013, 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 "bcast.h"
41
42#define MAX_BEARERS 2
43#define MAX_MEDIA 2
44
45/*
46 * Identifiers associated with TIPC message header media address info
47 *
48 * - address info field is 20 bytes long
49 * - media type identifier located at offset 3
50 * - remaining bytes vary according to media type
51 */
52#define TIPC_MEDIA_ADDR_SIZE 20
53#define TIPC_MEDIA_TYPE_OFFSET 3
54
55/*
56 * Identifiers of supported TIPC media types
57 */
58#define TIPC_MEDIA_TYPE_ETH 1
59#define TIPC_MEDIA_TYPE_IB 2
60
61/**
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
66 */
67struct tipc_media_addr {
68 u8 value[TIPC_MEDIA_ADDR_SIZE];
69 u8 media_id;
70 u8 broadcast;
71};
72
73struct tipc_bearer;
74
75/**
76 * struct tipc_media - Media specific info exposed to generic bearer layer
77 * @send_msg: routine which handles buffer transmission
78 * @enable_media: routine which enables a media
79 * @disable_media: routine which disables a media
80 * @addr2str: routine which converts media address to string
81 * @addr2msg: routine which converts media address to protocol message area
82 * @msg2addr: routine which converts media address from protocol message area
83 * @priority: default link (and bearer) priority
84 * @tolerance: default time (in ms) before declaring link failure
85 * @window: default window (in packets) before declaring link congestion
86 * @type_id: TIPC media identifier
87 * @hwaddr_len: TIPC media address len
88 * @name: media name
89 */
90struct tipc_media {
91 int (*send_msg)(struct sk_buff *buf,
92 struct tipc_bearer *b_ptr,
93 struct tipc_media_addr *dest);
94 int (*enable_media)(struct tipc_bearer *b_ptr);
95 void (*disable_media)(struct tipc_bearer *b_ptr);
96 int (*addr2str)(struct tipc_media_addr *a, char *str_buf, int str_size);
97 int (*addr2msg)(struct tipc_media_addr *a, char *msg_area);
98 int (*msg2addr)(const struct tipc_bearer *b_ptr,
99 struct tipc_media_addr *a, char *msg_area);
100 u32 priority;
101 u32 tolerance;
102 u32 window;
103 u32 type_id;
104 u32 hwaddr_len;
105 char name[TIPC_MAX_MEDIA_NAME];
106};
107
108/**
109 * struct tipc_bearer - Generic TIPC bearer structure
110 * @media_ptr: pointer to additional media-specific information about bearer
111 * @mtu: max packet size bearer can support
112 * @addr: media-specific address associated with bearer
113 * @name: bearer name (format = media:interface)
114 * @media: ptr to media structure associated with bearer
115 * @bcast_addr: media address used in broadcasting
116 * @priority: default link priority for bearer
117 * @window: default window size for bearer
118 * @tolerance: default link tolerance for bearer
119 * @domain: network domain to which links can be established
120 * @identity: array index of this bearer within TIPC bearer array
121 * @link_req: ptr to (optional) structure making periodic link setup requests
122 * @net_plane: network plane ('A' through 'H') currently associated with bearer
123 * @nodes: indicates which nodes in cluster can be reached through bearer
124 *
125 * Note: media-specific code is responsible for initialization of the fields
126 * indicated below when a bearer is enabled; TIPC's generic bearer code takes
127 * care of initializing all other fields.
128 */
129struct tipc_bearer {
130 void *media_ptr; /* initalized by media */
131 u32 mtu; /* initalized by media */
132 struct tipc_media_addr addr; /* initalized by media */
133 char name[TIPC_MAX_BEARER_NAME];
134 struct tipc_media *media;
135 struct tipc_media_addr bcast_addr;
136 u32 priority;
137 u32 window;
138 u32 tolerance;
139 u32 domain;
140 u32 identity;
141 struct tipc_link_req *link_req;
142 char net_plane;
143 struct tipc_node_map nodes;
144};
145
146struct tipc_bearer_names {
147 char media_name[TIPC_MAX_MEDIA_NAME];
148 char if_name[TIPC_MAX_IF_NAME];
149};
150
151struct tipc_link;
152
153extern struct tipc_bearer *bearer_list[];
154
155/*
156 * TIPC routines available to supported media types
157 */
158
159void tipc_rcv(struct sk_buff *buf, struct tipc_bearer *tb_ptr);
160int tipc_enable_bearer(const char *bearer_name, u32 disc_domain, u32 priority);
161int tipc_disable_bearer(const char *name);
162
163/*
164 * Routines made available to TIPC by supported media types
165 */
166extern struct tipc_media eth_media_info;
167
168#ifdef CONFIG_TIPC_MEDIA_IB
169extern struct tipc_media ib_media_info;
170#endif
171
172int tipc_media_set_priority(const char *name, u32 new_value);
173int tipc_media_set_window(const char *name, u32 new_value);
174void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a);
175struct sk_buff *tipc_media_get_names(void);
176void tipc_l2_media_addr_set(const struct tipc_bearer *b,
177 struct tipc_media_addr *a, char *mac);
178int tipc_enable_l2_media(struct tipc_bearer *b);
179void tipc_disable_l2_media(struct tipc_bearer *b);
180int tipc_l2_send_msg(struct sk_buff *buf, struct tipc_bearer *b,
181 struct tipc_media_addr *dest);
182
183struct sk_buff *tipc_bearer_get_names(void);
184void tipc_bearer_add_dest(struct tipc_bearer *b_ptr, u32 dest);
185void tipc_bearer_remove_dest(struct tipc_bearer *b_ptr, u32 dest);
186struct tipc_bearer *tipc_bearer_find(const char *name);
187struct tipc_media *tipc_media_find(const char *name);
188int tipc_bearer_setup(void);
189void tipc_bearer_cleanup(void);
190void tipc_bearer_stop(void);
191void tipc_bearer_send(struct tipc_bearer *b, struct sk_buff *buf,
192 struct tipc_media_addr *dest);
193
194#endif /* _TIPC_BEARER_H */
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 */