xref: /linux/net/tipc/eth_media.c (revision 14b42963f64b98ab61fa9723c03d71aa5ef4f862)
1 /*
2  * net/tipc/eth_media.c: Ethernet bearer support for TIPC
3  *
4  * Copyright (c) 2001-2006, Ericsson AB
5  * Copyright (c) 2005-2006, 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 #include <net/tipc/tipc.h>
38 #include <net/tipc/tipc_bearer.h>
39 #include <net/tipc/tipc_msg.h>
40 #include <linux/netdevice.h>
41 
42 #define MAX_ETH_BEARERS		2
43 #define ETH_LINK_PRIORITY	TIPC_DEF_LINK_PRI
44 #define ETH_LINK_TOLERANCE	TIPC_DEF_LINK_TOL
45 #define ETH_LINK_WINDOW		TIPC_DEF_LINK_WIN
46 
47 /**
48  * struct eth_bearer - Ethernet bearer data structure
49  * @bearer: ptr to associated "generic" bearer structure
50  * @dev: ptr to associated Ethernet network device
51  * @tipc_packet_type: used in binding TIPC to Ethernet driver
52  */
53 
54 struct eth_bearer {
55 	struct tipc_bearer *bearer;
56 	struct net_device *dev;
57 	struct packet_type tipc_packet_type;
58 };
59 
60 static struct eth_bearer eth_bearers[MAX_ETH_BEARERS];
61 static int eth_started = 0;
62 static struct notifier_block notifier;
63 
64 /**
65  * send_msg - send a TIPC message out over an Ethernet interface
66  */
67 
68 static int send_msg(struct sk_buff *buf, struct tipc_bearer *tb_ptr,
69 		    struct tipc_media_addr *dest)
70 {
71 	struct sk_buff *clone;
72 	struct net_device *dev;
73 
74 	clone = skb_clone(buf, GFP_ATOMIC);
75 	if (clone) {
76 		clone->nh.raw = clone->data;
77 		dev = ((struct eth_bearer *)(tb_ptr->usr_handle))->dev;
78 		clone->dev = dev;
79 		dev->hard_header(clone, dev, ETH_P_TIPC,
80 				 &dest->dev_addr.eth_addr,
81 				 dev->dev_addr, clone->len);
82 		dev_queue_xmit(clone);
83 	}
84 	return TIPC_OK;
85 }
86 
87 /**
88  * recv_msg - handle incoming TIPC message from an Ethernet interface
89  *
90  * Routine truncates any Ethernet padding/CRC appended to the message,
91  * and ensures message size matches actual length
92  */
93 
94 static int recv_msg(struct sk_buff *buf, struct net_device *dev,
95 		    struct packet_type *pt, struct net_device *orig_dev)
96 {
97 	struct eth_bearer *eb_ptr = (struct eth_bearer *)pt->af_packet_priv;
98 	u32 size;
99 
100 	if (likely(eb_ptr->bearer)) {
101 	       if (likely(!dev->promiscuity) ||
102 	           !memcmp(buf->mac.raw,dev->dev_addr,ETH_ALEN) ||
103 	           !memcmp(buf->mac.raw,dev->broadcast,ETH_ALEN)) {
104 		        size = msg_size((struct tipc_msg *)buf->data);
105 	                skb_trim(buf, size);
106 	        	if (likely(buf->len == size)) {
107 		        	buf->next = NULL;
108 			        tipc_recv_msg(buf, eb_ptr->bearer);
109 			        return TIPC_OK;
110 			}
111 		}
112 	}
113 	kfree_skb(buf);
114 	return TIPC_OK;
115 }
116 
117 /**
118  * enable_bearer - attach TIPC bearer to an Ethernet interface
119  */
120 
121 static int enable_bearer(struct tipc_bearer *tb_ptr)
122 {
123 	struct net_device *dev = dev_base;
124 	struct eth_bearer *eb_ptr = &eth_bearers[0];
125 	struct eth_bearer *stop = &eth_bearers[MAX_ETH_BEARERS];
126 	char *driver_name = strchr((const char *)tb_ptr->name, ':') + 1;
127 
128 	/* Find device with specified name */
129 
130 	while (dev && dev->name && strncmp(dev->name, driver_name, IFNAMSIZ)) {
131 		dev = dev->next;
132 	}
133 	if (!dev)
134 		return -ENODEV;
135 
136 	/* Find Ethernet bearer for device (or create one) */
137 
138 	for (;(eb_ptr != stop) && eb_ptr->dev && (eb_ptr->dev != dev); eb_ptr++);
139 	if (eb_ptr == stop)
140 		return -EDQUOT;
141 	if (!eb_ptr->dev) {
142 		eb_ptr->dev = dev;
143 		eb_ptr->tipc_packet_type.type = __constant_htons(ETH_P_TIPC);
144 		eb_ptr->tipc_packet_type.dev = dev;
145 		eb_ptr->tipc_packet_type.func = recv_msg;
146 		eb_ptr->tipc_packet_type.af_packet_priv = eb_ptr;
147 		INIT_LIST_HEAD(&(eb_ptr->tipc_packet_type.list));
148 		dev_hold(dev);
149 		dev_add_pack(&eb_ptr->tipc_packet_type);
150 	}
151 
152 	/* Associate TIPC bearer with Ethernet bearer */
153 
154 	eb_ptr->bearer = tb_ptr;
155 	tb_ptr->usr_handle = (void *)eb_ptr;
156 	tb_ptr->mtu = dev->mtu;
157 	tb_ptr->blocked = 0;
158 	tb_ptr->addr.type = htonl(TIPC_MEDIA_TYPE_ETH);
159 	memcpy(&tb_ptr->addr.dev_addr, &dev->dev_addr, ETH_ALEN);
160 	return 0;
161 }
162 
163 /**
164  * disable_bearer - detach TIPC bearer from an Ethernet interface
165  *
166  * We really should do dev_remove_pack() here, but this function can not be
167  * called at tasklet level. => Use eth_bearer->bearer as a flag to throw away
168  * incoming buffers, & postpone dev_remove_pack() to eth_media_stop() on exit.
169  */
170 
171 static void disable_bearer(struct tipc_bearer *tb_ptr)
172 {
173 	((struct eth_bearer *)tb_ptr->usr_handle)->bearer = NULL;
174 }
175 
176 /**
177  * recv_notification - handle device updates from OS
178  *
179  * Change the state of the Ethernet bearer (if any) associated with the
180  * specified device.
181  */
182 
183 static int recv_notification(struct notifier_block *nb, unsigned long evt,
184 			     void *dv)
185 {
186 	struct net_device *dev = (struct net_device *)dv;
187 	struct eth_bearer *eb_ptr = &eth_bearers[0];
188 	struct eth_bearer *stop = &eth_bearers[MAX_ETH_BEARERS];
189 
190 	while ((eb_ptr->dev != dev)) {
191 		if (++eb_ptr == stop)
192 			return NOTIFY_DONE;	/* couldn't find device */
193 	}
194 	if (!eb_ptr->bearer)
195 		return NOTIFY_DONE;		/* bearer had been disabled */
196 
197         eb_ptr->bearer->mtu = dev->mtu;
198 
199 	switch (evt) {
200 	case NETDEV_CHANGE:
201 		if (netif_carrier_ok(dev))
202 			tipc_continue(eb_ptr->bearer);
203 		else
204 			tipc_block_bearer(eb_ptr->bearer->name);
205 		break;
206 	case NETDEV_UP:
207 		tipc_continue(eb_ptr->bearer);
208 		break;
209 	case NETDEV_DOWN:
210 		tipc_block_bearer(eb_ptr->bearer->name);
211 		break;
212 	case NETDEV_CHANGEMTU:
213         case NETDEV_CHANGEADDR:
214 		tipc_block_bearer(eb_ptr->bearer->name);
215                 tipc_continue(eb_ptr->bearer);
216 		break;
217 	case NETDEV_UNREGISTER:
218         case NETDEV_CHANGENAME:
219 		tipc_disable_bearer(eb_ptr->bearer->name);
220 		break;
221 	}
222 	return NOTIFY_OK;
223 }
224 
225 /**
226  * eth_addr2str - convert Ethernet address to string
227  */
228 
229 static char *eth_addr2str(struct tipc_media_addr *a, char *str_buf, int str_size)
230 {
231 	unchar *addr = (unchar *)&a->dev_addr;
232 
233 	if (str_size < 18)
234 		*str_buf = '\0';
235 	else
236 		sprintf(str_buf, "%02x:%02x:%02x:%02x:%02x:%02x",
237 			addr[0], addr[1], addr[2], addr[3], addr[4], addr[5]);
238 	return str_buf;
239 }
240 
241 /**
242  * tipc_eth_media_start - activate Ethernet bearer support
243  *
244  * Register Ethernet media type with TIPC bearer code.  Also register
245  * with OS for notifications about device state changes.
246  */
247 
248 int tipc_eth_media_start(void)
249 {
250 	struct tipc_media_addr bcast_addr;
251 	int res;
252 
253 	if (eth_started)
254 		return -EINVAL;
255 
256 	bcast_addr.type = htonl(TIPC_MEDIA_TYPE_ETH);
257 	memset(&bcast_addr.dev_addr, 0xff, ETH_ALEN);
258 
259 	memset(eth_bearers, 0, sizeof(eth_bearers));
260 
261 	res = tipc_register_media(TIPC_MEDIA_TYPE_ETH, "eth",
262 				  enable_bearer, disable_bearer, send_msg,
263 				  eth_addr2str, &bcast_addr, ETH_LINK_PRIORITY,
264 				  ETH_LINK_TOLERANCE, ETH_LINK_WINDOW);
265 	if (res)
266 		return res;
267 
268 	notifier.notifier_call = &recv_notification;
269 	notifier.priority = 0;
270 	res = register_netdevice_notifier(&notifier);
271 	if (!res)
272 		eth_started = 1;
273 	return res;
274 }
275 
276 /**
277  * tipc_eth_media_stop - deactivate Ethernet bearer support
278  */
279 
280 void tipc_eth_media_stop(void)
281 {
282 	int i;
283 
284 	if (!eth_started)
285 		return;
286 
287 	unregister_netdevice_notifier(&notifier);
288 	for (i = 0; i < MAX_ETH_BEARERS ; i++) {
289 		if (eth_bearers[i].bearer) {
290 			eth_bearers[i].bearer->blocked = 1;
291 			eth_bearers[i].bearer = NULL;
292 		}
293 		if (eth_bearers[i].dev) {
294 			dev_remove_pack(&eth_bearers[i].tipc_packet_type);
295 			dev_put(eth_bearers[i].dev);
296 		}
297 	}
298 	memset(&eth_bearers, 0, sizeof(eth_bearers));
299 	eth_started = 0;
300 }
301