2 * net/tipc/bearer.c: TIPC bearer code
4 * Copyright (c) 1996-2006, Ericsson AB
5 * Copyright (c) 2004-2006, 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.
46 #define MAX_ADDR_STR 32
48 static struct media media_list[MAX_MEDIA];
49 static u32 media_count = 0;
51 struct bearer tipc_bearers[MAX_BEARERS];
54 * media_name_valid - validate media name
56 * Returns 1 if media name is valid, otherwise 0.
59 static int media_name_valid(const char *name)
64 if ((len + 1) > TIPC_MAX_MEDIA_NAME)
66 return (strspn(name, tipc_alphabet) == len);
70 * media_find - locates specified media object by name
73 static struct media *media_find(const char *name)
78 for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
79 if (!strcmp(m_ptr->name, name))
86 * tipc_register_media - register a media type
88 * Bearers for this media type must be activated separately at a later stage.
91 int tipc_register_media(u32 media_type,
93 int (*enable)(struct tipc_bearer *),
94 void (*disable)(struct tipc_bearer *),
95 int (*send_msg)(struct sk_buff *,
97 struct tipc_media_addr *),
98 char *(*addr2str)(struct tipc_media_addr *a,
99 char *str_buf, int str_size),
100 struct tipc_media_addr *bcast_addr,
101 const u32 bearer_priority,
102 const u32 link_tolerance, /* [ms] */
103 const u32 send_window_limit)
110 write_lock_bh(&tipc_net_lock);
112 if (tipc_mode != TIPC_NET_MODE) {
113 warn("Media <%s> rejected, not in networked mode yet\n", name);
116 if (!media_name_valid(name)) {
117 warn("Media <%s> rejected, illegal name\n", name);
121 warn("Media <%s> rejected, no broadcast address\n", name);
124 if ((bearer_priority < TIPC_MIN_LINK_PRI) ||
125 (bearer_priority > TIPC_MAX_LINK_PRI)) {
126 warn("Media <%s> rejected, illegal priority (%u)\n", name,
130 if ((link_tolerance < TIPC_MIN_LINK_TOL) ||
131 (link_tolerance > TIPC_MAX_LINK_TOL)) {
132 warn("Media <%s> rejected, illegal tolerance (%u)\n", name,
137 media_id = media_count++;
138 if (media_id >= MAX_MEDIA) {
139 warn("Media <%s> rejected, media limit reached (%u)\n", name,
144 for (i = 0; i < media_id; i++) {
145 if (media_list[i].type_id == media_type) {
146 warn("Media <%s> rejected, duplicate type (%u)\n", name,
151 if (!strcmp(name, media_list[i].name)) {
152 warn("Media <%s> rejected, duplicate name\n", name);
158 m_ptr = &media_list[media_id];
159 m_ptr->type_id = media_type;
160 m_ptr->send_msg = send_msg;
161 m_ptr->enable_bearer = enable;
162 m_ptr->disable_bearer = disable;
163 m_ptr->addr2str = addr2str;
164 memcpy(&m_ptr->bcast_addr, bcast_addr, sizeof(*bcast_addr));
166 strcpy(m_ptr->name, name);
167 m_ptr->priority = bearer_priority;
168 m_ptr->tolerance = link_tolerance;
169 m_ptr->window = send_window_limit;
170 dbg("Media <%s> registered\n", name);
173 write_unlock_bh(&tipc_net_lock);
178 * tipc_media_addr_printf - record media address in print buffer
181 void tipc_media_addr_printf(struct print_buf *pb, struct tipc_media_addr *a)
187 media_type = ntohl(a->type);
188 for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
189 if (m_ptr->type_id == media_type)
193 if ((i < media_count) && (m_ptr->addr2str != NULL)) {
194 char addr_str[MAX_ADDR_STR];
196 tipc_printf(pb, "%s(%s)", m_ptr->name,
197 m_ptr->addr2str(a, addr_str, sizeof(addr_str)));
199 unchar *addr = (unchar *)&a->dev_addr;
201 tipc_printf(pb, "UNKNOWN(%u)", media_type);
202 for (i = 0; i < (sizeof(*a) - sizeof(a->type)); i++) {
203 tipc_printf(pb, "-%02x", addr[i]);
209 * tipc_media_get_names - record names of registered media in buffer
212 struct sk_buff *tipc_media_get_names(void)
218 buf = tipc_cfg_reply_alloc(MAX_MEDIA * TLV_SPACE(TIPC_MAX_MEDIA_NAME));
222 read_lock_bh(&tipc_net_lock);
223 for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
224 tipc_cfg_append_tlv(buf, TIPC_TLV_MEDIA_NAME, m_ptr->name,
225 strlen(m_ptr->name) + 1);
227 read_unlock_bh(&tipc_net_lock);
232 * bearer_name_validate - validate & (optionally) deconstruct bearer name
233 * @name - ptr to bearer name string
234 * @name_parts - ptr to area for bearer name components (or NULL if not needed)
236 * Returns 1 if bearer name is valid, otherwise 0.
239 static int bearer_name_validate(const char *name,
240 struct bearer_name *name_parts)
242 char name_copy[TIPC_MAX_BEARER_NAME];
248 /* copy bearer name & ensure length is OK */
250 name_copy[TIPC_MAX_BEARER_NAME - 1] = 0;
251 /* need above in case non-Posix strncpy() doesn't pad with nulls */
252 strncpy(name_copy, name, TIPC_MAX_BEARER_NAME);
253 if (name_copy[TIPC_MAX_BEARER_NAME - 1] != 0)
256 /* ensure all component parts of bearer name are present */
258 media_name = name_copy;
259 if ((if_name = strchr(media_name, ':')) == NULL)
262 media_len = if_name - media_name;
263 if_len = strlen(if_name) + 1;
265 /* validate component parts of bearer name */
267 if ((media_len <= 1) || (media_len > TIPC_MAX_MEDIA_NAME) ||
268 (if_len <= 1) || (if_len > TIPC_MAX_IF_NAME) ||
269 (strspn(media_name, tipc_alphabet) != (media_len - 1)) ||
270 (strspn(if_name, tipc_alphabet) != (if_len - 1)))
273 /* return bearer name components, if necessary */
276 strcpy(name_parts->media_name, media_name);
277 strcpy(name_parts->if_name, if_name);
283 * bearer_find - locates bearer object with matching bearer name
286 static struct bearer *bearer_find(const char *name)
288 struct bearer *b_ptr;
291 if (tipc_mode != TIPC_NET_MODE)
294 for (i = 0, b_ptr = tipc_bearers; i < MAX_BEARERS; i++, b_ptr++) {
295 if (b_ptr->active && (!strcmp(b_ptr->publ.name, name)))
302 * tipc_bearer_find_interface - locates bearer object with matching interface name
305 struct bearer *tipc_bearer_find_interface(const char *if_name)
307 struct bearer *b_ptr;
311 for (i = 0, b_ptr = tipc_bearers; i < MAX_BEARERS; i++, b_ptr++) {
314 b_if_name = strchr(b_ptr->publ.name, ':') + 1;
315 if (!strcmp(b_if_name, if_name))
322 * tipc_bearer_get_names - record names of bearers in buffer
325 struct sk_buff *tipc_bearer_get_names(void)
329 struct bearer *b_ptr;
332 buf = tipc_cfg_reply_alloc(MAX_BEARERS * TLV_SPACE(TIPC_MAX_BEARER_NAME));
336 read_lock_bh(&tipc_net_lock);
337 for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
338 for (j = 0; j < MAX_BEARERS; j++) {
339 b_ptr = &tipc_bearers[j];
340 if (b_ptr->active && (b_ptr->media == m_ptr)) {
341 tipc_cfg_append_tlv(buf, TIPC_TLV_BEARER_NAME,
343 strlen(b_ptr->publ.name) + 1);
347 read_unlock_bh(&tipc_net_lock);
351 void tipc_bearer_add_dest(struct bearer *b_ptr, u32 dest)
353 tipc_nmap_add(&b_ptr->nodes, dest);
354 tipc_disc_update_link_req(b_ptr->link_req);
355 tipc_bcbearer_sort();
358 void tipc_bearer_remove_dest(struct bearer *b_ptr, u32 dest)
360 tipc_nmap_remove(&b_ptr->nodes, dest);
361 tipc_disc_update_link_req(b_ptr->link_req);
362 tipc_bcbearer_sort();
366 * bearer_push(): Resolve bearer congestion. Force the waiting
367 * links to push out their unsent packets, one packet per link
368 * per iteration, until all packets are gone or congestion reoccurs.
369 * 'tipc_net_lock' is read_locked when this function is called
370 * bearer.lock must be taken before calling
371 * Returns binary true(1) ore false(0)
373 static int bearer_push(struct bearer *b_ptr)
376 struct link *ln, *tln;
378 if (b_ptr->publ.blocked)
381 while (!list_empty(&b_ptr->cong_links) && (res != PUSH_FAILED)) {
382 list_for_each_entry_safe(ln, tln, &b_ptr->cong_links, link_list) {
383 res = tipc_link_push_packet(ln);
384 if (res == PUSH_FAILED)
386 if (res == PUSH_FINISHED)
387 list_move_tail(&ln->link_list, &b_ptr->links);
390 return list_empty(&b_ptr->cong_links);
393 void tipc_bearer_lock_push(struct bearer *b_ptr)
397 spin_lock_bh(&b_ptr->publ.lock);
398 res = bearer_push(b_ptr);
399 spin_unlock_bh(&b_ptr->publ.lock);
401 tipc_bcbearer_push();
406 * Interrupt enabling new requests after bearer congestion or blocking:
409 void tipc_continue(struct tipc_bearer *tb_ptr)
411 struct bearer *b_ptr = (struct bearer *)tb_ptr;
413 spin_lock_bh(&b_ptr->publ.lock);
414 b_ptr->continue_count++;
415 if (!list_empty(&b_ptr->cong_links))
416 tipc_k_signal((Handler)tipc_bearer_lock_push, (unsigned long)b_ptr);
417 b_ptr->publ.blocked = 0;
418 spin_unlock_bh(&b_ptr->publ.lock);
422 * Schedule link for sending of messages after the bearer
423 * has been deblocked by 'continue()'. This method is called
424 * when somebody tries to send a message via this link while
425 * the bearer is congested. 'tipc_net_lock' is in read_lock here
426 * bearer.lock is busy
429 static void tipc_bearer_schedule_unlocked(struct bearer *b_ptr, struct link *l_ptr)
431 list_move_tail(&l_ptr->link_list, &b_ptr->cong_links);
435 * Schedule link for sending of messages after the bearer
436 * has been deblocked by 'continue()'. This method is called
437 * when somebody tries to send a message via this link while
438 * the bearer is congested. 'tipc_net_lock' is in read_lock here,
439 * bearer.lock is free
442 void tipc_bearer_schedule(struct bearer *b_ptr, struct link *l_ptr)
444 spin_lock_bh(&b_ptr->publ.lock);
445 tipc_bearer_schedule_unlocked(b_ptr, l_ptr);
446 spin_unlock_bh(&b_ptr->publ.lock);
451 * tipc_bearer_resolve_congestion(): Check if there is bearer congestion,
452 * and if there is, try to resolve it before returning.
453 * 'tipc_net_lock' is read_locked when this function is called
455 int tipc_bearer_resolve_congestion(struct bearer *b_ptr, struct link *l_ptr)
459 if (list_empty(&b_ptr->cong_links))
461 spin_lock_bh(&b_ptr->publ.lock);
462 if (!bearer_push(b_ptr)) {
463 tipc_bearer_schedule_unlocked(b_ptr, l_ptr);
466 spin_unlock_bh(&b_ptr->publ.lock);
472 * tipc_enable_bearer - enable bearer with the given name
475 int tipc_enable_bearer(const char *name, u32 bcast_scope, u32 priority)
477 struct bearer *b_ptr;
479 struct bearer_name b_name;
480 char addr_string[16];
486 if (tipc_mode != TIPC_NET_MODE) {
487 warn("Bearer <%s> rejected, not supported in standalone mode\n",
491 if (!bearer_name_validate(name, &b_name)) {
492 warn("Bearer <%s> rejected, illegal name\n", name);
495 if (!tipc_addr_domain_valid(bcast_scope) ||
496 !in_scope(bcast_scope, tipc_own_addr)) {
497 warn("Bearer <%s> rejected, illegal broadcast scope\n", name);
500 if ((priority < TIPC_MIN_LINK_PRI ||
501 priority > TIPC_MAX_LINK_PRI) &&
502 (priority != TIPC_MEDIA_LINK_PRI)) {
503 warn("Bearer <%s> rejected, illegal priority\n", name);
507 write_lock_bh(&tipc_net_lock);
509 m_ptr = media_find(b_name.media_name);
511 warn("Bearer <%s> rejected, media <%s> not registered\n", name,
516 if (priority == TIPC_MEDIA_LINK_PRI)
517 priority = m_ptr->priority;
520 bearer_id = MAX_BEARERS;
522 for (i = MAX_BEARERS; i-- != 0; ) {
523 if (!tipc_bearers[i].active) {
527 if (!strcmp(name, tipc_bearers[i].publ.name)) {
528 warn("Bearer <%s> rejected, already enabled\n", name);
531 if ((tipc_bearers[i].priority == priority) &&
532 (++with_this_prio > 2)) {
533 if (priority-- == 0) {
534 warn("Bearer <%s> rejected, duplicate priority\n",
538 warn("Bearer <%s> priority adjustment required %u->%u\n",
539 name, priority + 1, priority);
543 if (bearer_id >= MAX_BEARERS) {
544 warn("Bearer <%s> rejected, bearer limit reached (%u)\n",
549 b_ptr = &tipc_bearers[bearer_id];
550 memset(b_ptr, 0, sizeof(struct bearer));
552 strcpy(b_ptr->publ.name, name);
553 res = m_ptr->enable_bearer(&b_ptr->publ);
555 warn("Bearer <%s> rejected, enable failure (%d)\n", name, -res);
559 b_ptr->identity = bearer_id;
560 b_ptr->media = m_ptr;
561 b_ptr->net_plane = bearer_id + 'A';
563 b_ptr->detect_scope = bcast_scope;
564 b_ptr->priority = priority;
565 INIT_LIST_HEAD(&b_ptr->cong_links);
566 INIT_LIST_HEAD(&b_ptr->links);
568 b_ptr->link_req = tipc_disc_init_link_req(b_ptr, &m_ptr->bcast_addr,
571 spin_lock_init(&b_ptr->publ.lock);
572 write_unlock_bh(&tipc_net_lock);
573 info("Enabled bearer <%s>, discovery domain %s, priority %u\n",
574 name, addr_string_fill(addr_string, bcast_scope), priority);
577 write_unlock_bh(&tipc_net_lock);
582 * tipc_block_bearer(): Block the bearer with the given name,
583 * and reset all its links
586 int tipc_block_bearer(const char *name)
588 struct bearer *b_ptr = NULL;
590 struct link *temp_l_ptr;
592 read_lock_bh(&tipc_net_lock);
593 b_ptr = bearer_find(name);
595 warn("Attempt to block unknown bearer <%s>\n", name);
596 read_unlock_bh(&tipc_net_lock);
600 info("Blocking bearer <%s>\n", name);
601 spin_lock_bh(&b_ptr->publ.lock);
602 b_ptr->publ.blocked = 1;
603 list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
604 struct tipc_node *n_ptr = l_ptr->owner;
606 spin_lock_bh(&n_ptr->lock);
607 tipc_link_reset(l_ptr);
608 spin_unlock_bh(&n_ptr->lock);
610 spin_unlock_bh(&b_ptr->publ.lock);
611 read_unlock_bh(&tipc_net_lock);
618 * Note: This routine assumes caller holds tipc_net_lock.
621 static int bearer_disable(const char *name)
623 struct bearer *b_ptr;
625 struct link *temp_l_ptr;
627 b_ptr = bearer_find(name);
629 warn("Attempt to disable unknown bearer <%s>\n", name);
633 info("Disabling bearer <%s>\n", name);
634 tipc_disc_stop_link_req(b_ptr->link_req);
635 spin_lock_bh(&b_ptr->publ.lock);
636 b_ptr->link_req = NULL;
637 b_ptr->publ.blocked = 1;
638 if (b_ptr->media->disable_bearer) {
639 spin_unlock_bh(&b_ptr->publ.lock);
640 write_unlock_bh(&tipc_net_lock);
641 b_ptr->media->disable_bearer(&b_ptr->publ);
642 write_lock_bh(&tipc_net_lock);
643 spin_lock_bh(&b_ptr->publ.lock);
645 list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
646 tipc_link_delete(l_ptr);
648 spin_unlock_bh(&b_ptr->publ.lock);
649 memset(b_ptr, 0, sizeof(struct bearer));
653 int tipc_disable_bearer(const char *name)
657 write_lock_bh(&tipc_net_lock);
658 res = bearer_disable(name);
659 write_unlock_bh(&tipc_net_lock);
665 void tipc_bearer_stop(void)
669 for (i = 0; i < MAX_BEARERS; i++) {
670 if (tipc_bearers[i].active)
671 tipc_bearers[i].publ.blocked = 1;
673 for (i = 0; i < MAX_BEARERS; i++) {
674 if (tipc_bearers[i].active)
675 bearer_disable(tipc_bearers[i].publ.name);