2 * net/tipc/bearer.c: TIPC bearer code
4 * Copyright (c) 1996-2006, 2013, Ericsson AB
5 * Copyright (c) 2004-2006, 2010-2013, Wind River Systems
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
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.
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.
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.
42 #define MAX_ADDR_STR 60
44 static struct tipc_media
* const media_info_array
[] = {
46 #ifdef CONFIG_TIPC_MEDIA_IB
52 struct tipc_bearer __rcu
*bearer_list
[MAX_BEARERS
+ 1];
54 static void bearer_disable(struct tipc_bearer
*b_ptr
, bool shutting_down
);
57 * tipc_media_find - locates specified media object by name
59 struct tipc_media
*tipc_media_find(const char *name
)
63 for (i
= 0; media_info_array
[i
] != NULL
; i
++) {
64 if (!strcmp(media_info_array
[i
]->name
, name
))
67 return media_info_array
[i
];
71 * media_find_id - locates specified media object by type identifier
73 static struct tipc_media
*media_find_id(u8 type
)
77 for (i
= 0; media_info_array
[i
] != NULL
; i
++) {
78 if (media_info_array
[i
]->type_id
== type
)
81 return media_info_array
[i
];
85 * tipc_media_addr_printf - record media address in print buffer
87 void tipc_media_addr_printf(char *buf
, int len
, struct tipc_media_addr
*a
)
89 char addr_str
[MAX_ADDR_STR
];
90 struct tipc_media
*m_ptr
;
93 m_ptr
= media_find_id(a
->media_id
);
95 if (m_ptr
&& !m_ptr
->addr2str(a
, addr_str
, sizeof(addr_str
)))
96 ret
= tipc_snprintf(buf
, len
, "%s(%s)", m_ptr
->name
, addr_str
);
100 ret
= tipc_snprintf(buf
, len
, "UNKNOWN(%u)", a
->media_id
);
101 for (i
= 0; i
< sizeof(a
->value
); i
++)
102 ret
+= tipc_snprintf(buf
- ret
, len
+ ret
,
103 "-%02x", a
->value
[i
]);
108 * tipc_media_get_names - record names of registered media in buffer
110 struct sk_buff
*tipc_media_get_names(void)
115 buf
= tipc_cfg_reply_alloc(MAX_MEDIA
* TLV_SPACE(TIPC_MAX_MEDIA_NAME
));
119 for (i
= 0; media_info_array
[i
] != NULL
; i
++) {
120 tipc_cfg_append_tlv(buf
, TIPC_TLV_MEDIA_NAME
,
121 media_info_array
[i
]->name
,
122 strlen(media_info_array
[i
]->name
) + 1);
128 * bearer_name_validate - validate & (optionally) deconstruct bearer name
129 * @name: ptr to bearer name string
130 * @name_parts: ptr to area for bearer name components (or NULL if not needed)
132 * Returns 1 if bearer name is valid, otherwise 0.
134 static int bearer_name_validate(const char *name
,
135 struct tipc_bearer_names
*name_parts
)
137 char name_copy
[TIPC_MAX_BEARER_NAME
];
143 /* copy bearer name & ensure length is OK */
144 name_copy
[TIPC_MAX_BEARER_NAME
- 1] = 0;
145 /* need above in case non-Posix strncpy() doesn't pad with nulls */
146 strncpy(name_copy
, name
, TIPC_MAX_BEARER_NAME
);
147 if (name_copy
[TIPC_MAX_BEARER_NAME
- 1] != 0)
150 /* ensure all component parts of bearer name are present */
151 media_name
= name_copy
;
152 if_name
= strchr(media_name
, ':');
156 media_len
= if_name
- media_name
;
157 if_len
= strlen(if_name
) + 1;
159 /* validate component parts of bearer name */
160 if ((media_len
<= 1) || (media_len
> TIPC_MAX_MEDIA_NAME
) ||
161 (if_len
<= 1) || (if_len
> TIPC_MAX_IF_NAME
))
164 /* return bearer name components, if necessary */
166 strcpy(name_parts
->media_name
, media_name
);
167 strcpy(name_parts
->if_name
, if_name
);
173 * tipc_bearer_find - locates bearer object with matching bearer name
175 struct tipc_bearer
*tipc_bearer_find(const char *name
)
177 struct tipc_bearer
*b_ptr
;
180 for (i
= 0; i
< MAX_BEARERS
; i
++) {
181 b_ptr
= rtnl_dereference(bearer_list
[i
]);
182 if (b_ptr
&& (!strcmp(b_ptr
->name
, name
)))
189 * tipc_bearer_get_names - record names of bearers in buffer
191 struct sk_buff
*tipc_bearer_get_names(void)
194 struct tipc_bearer
*b
;
197 buf
= tipc_cfg_reply_alloc(MAX_BEARERS
* TLV_SPACE(TIPC_MAX_BEARER_NAME
));
201 for (i
= 0; media_info_array
[i
] != NULL
; i
++) {
202 for (j
= 0; j
< MAX_BEARERS
; j
++) {
203 b
= rtnl_dereference(bearer_list
[j
]);
206 if (b
->media
== media_info_array
[i
]) {
207 tipc_cfg_append_tlv(buf
, TIPC_TLV_BEARER_NAME
,
209 strlen(b
->name
) + 1);
216 void tipc_bearer_add_dest(u32 bearer_id
, u32 dest
)
218 struct tipc_bearer
*b_ptr
;
221 b_ptr
= rcu_dereference_rtnl(bearer_list
[bearer_id
]);
223 tipc_bcbearer_sort(&b_ptr
->nodes
, dest
, true);
224 tipc_disc_add_dest(b_ptr
->link_req
);
229 void tipc_bearer_remove_dest(u32 bearer_id
, u32 dest
)
231 struct tipc_bearer
*b_ptr
;
234 b_ptr
= rcu_dereference_rtnl(bearer_list
[bearer_id
]);
236 tipc_bcbearer_sort(&b_ptr
->nodes
, dest
, false);
237 tipc_disc_remove_dest(b_ptr
->link_req
);
243 * tipc_enable_bearer - enable bearer with the given name
245 int tipc_enable_bearer(const char *name
, u32 disc_domain
, u32 priority
)
247 struct tipc_bearer
*b_ptr
;
248 struct tipc_media
*m_ptr
;
249 struct tipc_bearer_names b_names
;
250 char addr_string
[16];
256 if (!tipc_own_addr
) {
257 pr_warn("Bearer <%s> rejected, not supported in standalone mode\n",
261 if (!bearer_name_validate(name
, &b_names
)) {
262 pr_warn("Bearer <%s> rejected, illegal name\n", name
);
265 if (tipc_addr_domain_valid(disc_domain
) &&
266 (disc_domain
!= tipc_own_addr
)) {
267 if (tipc_in_scope(disc_domain
, tipc_own_addr
)) {
268 disc_domain
= tipc_own_addr
& TIPC_CLUSTER_MASK
;
269 res
= 0; /* accept any node in own cluster */
270 } else if (in_own_cluster_exact(disc_domain
))
271 res
= 0; /* accept specified node in own cluster */
274 pr_warn("Bearer <%s> rejected, illegal discovery domain\n",
278 if ((priority
> TIPC_MAX_LINK_PRI
) &&
279 (priority
!= TIPC_MEDIA_LINK_PRI
)) {
280 pr_warn("Bearer <%s> rejected, illegal priority\n", name
);
284 m_ptr
= tipc_media_find(b_names
.media_name
);
286 pr_warn("Bearer <%s> rejected, media <%s> not registered\n",
287 name
, b_names
.media_name
);
291 if (priority
== TIPC_MEDIA_LINK_PRI
)
292 priority
= m_ptr
->priority
;
295 bearer_id
= MAX_BEARERS
;
297 for (i
= MAX_BEARERS
; i
-- != 0; ) {
298 b_ptr
= rtnl_dereference(bearer_list
[i
]);
303 if (!strcmp(name
, b_ptr
->name
)) {
304 pr_warn("Bearer <%s> rejected, already enabled\n",
308 if ((b_ptr
->priority
== priority
) &&
309 (++with_this_prio
> 2)) {
310 if (priority
-- == 0) {
311 pr_warn("Bearer <%s> rejected, duplicate priority\n",
315 pr_warn("Bearer <%s> priority adjustment required %u->%u\n",
316 name
, priority
+ 1, priority
);
320 if (bearer_id
>= MAX_BEARERS
) {
321 pr_warn("Bearer <%s> rejected, bearer limit reached (%u)\n",
326 b_ptr
= kzalloc(sizeof(*b_ptr
), GFP_ATOMIC
);
330 strcpy(b_ptr
->name
, name
);
331 b_ptr
->media
= m_ptr
;
332 res
= m_ptr
->enable_media(b_ptr
);
334 pr_warn("Bearer <%s> rejected, enable failure (%d)\n",
339 b_ptr
->identity
= bearer_id
;
340 b_ptr
->tolerance
= m_ptr
->tolerance
;
341 b_ptr
->window
= m_ptr
->window
;
342 b_ptr
->domain
= disc_domain
;
343 b_ptr
->net_plane
= bearer_id
+ 'A';
344 b_ptr
->priority
= priority
;
346 res
= tipc_disc_create(b_ptr
, &b_ptr
->bcast_addr
);
348 bearer_disable(b_ptr
, false);
349 pr_warn("Bearer <%s> rejected, discovery object creation failed\n",
354 rcu_assign_pointer(bearer_list
[bearer_id
], b_ptr
);
356 pr_info("Enabled bearer <%s>, discovery domain %s, priority %u\n",
358 tipc_addr_string_fill(addr_string
, disc_domain
), priority
);
363 * tipc_reset_bearer - Reset all links established over this bearer
365 static int tipc_reset_bearer(struct tipc_bearer
*b_ptr
)
367 pr_info("Resetting bearer <%s>\n", b_ptr
->name
);
368 tipc_link_reset_list(b_ptr
->identity
);
369 tipc_disc_reset(b_ptr
);
376 * Note: This routine assumes caller holds RTNL lock.
378 static void bearer_disable(struct tipc_bearer
*b_ptr
, bool shutting_down
)
382 pr_info("Disabling bearer <%s>\n", b_ptr
->name
);
383 b_ptr
->media
->disable_media(b_ptr
);
385 tipc_link_delete_list(b_ptr
->identity
, shutting_down
);
387 tipc_disc_delete(b_ptr
->link_req
);
389 for (i
= 0; i
< MAX_BEARERS
; i
++) {
390 if (b_ptr
== rtnl_dereference(bearer_list
[i
])) {
391 RCU_INIT_POINTER(bearer_list
[i
], NULL
);
395 kfree_rcu(b_ptr
, rcu
);
398 int tipc_disable_bearer(const char *name
)
400 struct tipc_bearer
*b_ptr
;
403 b_ptr
= tipc_bearer_find(name
);
405 pr_warn("Attempt to disable unknown bearer <%s>\n", name
);
408 bearer_disable(b_ptr
, false);
414 int tipc_enable_l2_media(struct tipc_bearer
*b
)
416 struct net_device
*dev
;
417 char *driver_name
= strchr((const char *)b
->name
, ':') + 1;
419 /* Find device with specified name */
420 dev
= dev_get_by_name(&init_net
, driver_name
);
423 if (tipc_mtu_bad(dev
, 0)) {
428 /* Associate TIPC bearer with L2 bearer */
429 rcu_assign_pointer(b
->media_ptr
, dev
);
430 memset(&b
->bcast_addr
, 0, sizeof(b
->bcast_addr
));
431 memcpy(b
->bcast_addr
.value
, dev
->broadcast
, b
->media
->hwaddr_len
);
432 b
->bcast_addr
.media_id
= b
->media
->type_id
;
433 b
->bcast_addr
.broadcast
= 1;
435 b
->media
->raw2addr(b
, &b
->addr
, (char *)dev
->dev_addr
);
436 rcu_assign_pointer(dev
->tipc_ptr
, b
);
440 /* tipc_disable_l2_media - detach TIPC bearer from an L2 interface
442 * Mark L2 bearer as inactive so that incoming buffers are thrown away,
443 * then get worker thread to complete bearer cleanup. (Can't do cleanup
444 * here because cleanup code needs to sleep and caller holds spinlocks.)
446 void tipc_disable_l2_media(struct tipc_bearer
*b
)
448 struct net_device
*dev
;
450 dev
= (struct net_device
*)rtnl_dereference(b
->media_ptr
);
451 RCU_INIT_POINTER(b
->media_ptr
, NULL
);
452 RCU_INIT_POINTER(dev
->tipc_ptr
, NULL
);
458 * tipc_l2_send_msg - send a TIPC packet out over an L2 interface
459 * @buf: the packet to be sent
460 * @b_ptr: the bearer through which the packet is to be sent
461 * @dest: peer destination address
463 int tipc_l2_send_msg(struct sk_buff
*buf
, struct tipc_bearer
*b
,
464 struct tipc_media_addr
*dest
)
466 struct sk_buff
*clone
;
467 struct net_device
*dev
;
470 dev
= (struct net_device
*)rcu_dereference_rtnl(b
->media_ptr
);
474 clone
= skb_clone(buf
, GFP_ATOMIC
);
478 delta
= dev
->hard_header_len
- skb_headroom(buf
);
480 pskb_expand_head(clone
, SKB_DATA_ALIGN(delta
), 0, GFP_ATOMIC
)) {
485 skb_reset_network_header(clone
);
487 clone
->protocol
= htons(ETH_P_TIPC
);
488 dev_hard_header(clone
, dev
, ETH_P_TIPC
, dest
->value
,
489 dev
->dev_addr
, clone
->len
);
490 dev_queue_xmit(clone
);
494 /* tipc_bearer_send- sends buffer to destination over bearer
497 * The media send routine must not alter the buffer being passed in
498 * as it may be needed for later retransmission!
500 void tipc_bearer_send(u32 bearer_id
, struct sk_buff
*buf
,
501 struct tipc_media_addr
*dest
)
503 struct tipc_bearer
*b_ptr
;
506 b_ptr
= rcu_dereference_rtnl(bearer_list
[bearer_id
]);
508 b_ptr
->media
->send_msg(buf
, b_ptr
, dest
);
513 * tipc_l2_rcv_msg - handle incoming TIPC message from an interface
514 * @buf: the received packet
515 * @dev: the net device that the packet was received on
516 * @pt: the packet_type structure which was used to register this handler
517 * @orig_dev: the original receive net device in case the device is a bond
519 * Accept only packets explicitly sent to this node, or broadcast packets;
520 * ignores packets sent using interface multicast, and traffic sent to other
521 * nodes (which can happen if interface is running in promiscuous mode).
523 static int tipc_l2_rcv_msg(struct sk_buff
*buf
, struct net_device
*dev
,
524 struct packet_type
*pt
, struct net_device
*orig_dev
)
526 struct tipc_bearer
*b_ptr
;
528 if (!net_eq(dev_net(dev
), &init_net
)) {
534 b_ptr
= rcu_dereference_rtnl(dev
->tipc_ptr
);
536 if (likely(buf
->pkt_type
<= PACKET_BROADCAST
)) {
538 tipc_rcv(buf
, b_ptr
);
540 return NET_RX_SUCCESS
;
550 * tipc_l2_device_event - handle device events from network device
551 * @nb: the context of the notification
552 * @evt: the type of event
553 * @ptr: the net device that the event was on
555 * This function is called by the Ethernet driver in case of link
558 static int tipc_l2_device_event(struct notifier_block
*nb
, unsigned long evt
,
561 struct tipc_bearer
*b_ptr
;
562 struct net_device
*dev
= netdev_notifier_info_to_dev(ptr
);
564 if (!net_eq(dev_net(dev
), &init_net
))
567 b_ptr
= rtnl_dereference(dev
->tipc_ptr
);
573 if (netif_carrier_ok(dev
))
576 tipc_reset_bearer(b_ptr
);
578 case NETDEV_CHANGEMTU
:
579 if (tipc_mtu_bad(dev
, 0)) {
580 bearer_disable(b_ptr
, false);
583 b_ptr
->mtu
= dev
->mtu
;
584 tipc_reset_bearer(b_ptr
);
586 case NETDEV_CHANGEADDR
:
587 b_ptr
->media
->raw2addr(b_ptr
, &b_ptr
->addr
,
588 (char *)dev
->dev_addr
);
589 tipc_reset_bearer(b_ptr
);
591 case NETDEV_UNREGISTER
:
592 case NETDEV_CHANGENAME
:
593 bearer_disable(b_ptr
, false);
599 static struct packet_type tipc_packet_type __read_mostly
= {
600 .type
= htons(ETH_P_TIPC
),
601 .func
= tipc_l2_rcv_msg
,
604 static struct notifier_block notifier
= {
605 .notifier_call
= tipc_l2_device_event
,
609 int tipc_bearer_setup(void)
613 err
= register_netdevice_notifier(¬ifier
);
616 dev_add_pack(&tipc_packet_type
);
620 void tipc_bearer_cleanup(void)
622 unregister_netdevice_notifier(¬ifier
);
623 dev_remove_pack(&tipc_packet_type
);
626 void tipc_bearer_stop(void)
628 struct tipc_bearer
*b_ptr
;
631 for (i
= 0; i
< MAX_BEARERS
; i
++) {
632 b_ptr
= rtnl_dereference(bearer_list
[i
]);
634 bearer_disable(b_ptr
, true);
635 bearer_list
[i
] = NULL
;