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.
42 #define MAX_ADDR_STR 32
44 static struct media media_list[MAX_MEDIA];
45 static u32 media_count;
47 struct bearer tipc_bearers[MAX_BEARERS];
50 * media_name_valid - validate media name
52 * Returns 1 if media name is valid, otherwise 0.
55 static int media_name_valid(const char *name)
60 if ((len + 1) > TIPC_MAX_MEDIA_NAME)
62 return strspn(name, tipc_alphabet) == len;
66 * media_find - locates specified media object by name
69 static struct media *media_find(const char *name)
74 for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
75 if (!strcmp(m_ptr->name, name))
82 * tipc_register_media - register a media type
84 * Bearers for this media type must be activated separately at a later stage.
87 int tipc_register_media(u32 media_type,
89 int (*enable)(struct tipc_bearer *),
90 void (*disable)(struct tipc_bearer *),
91 int (*send_msg)(struct sk_buff *,
93 struct tipc_media_addr *),
94 char *(*addr2str)(struct tipc_media_addr *a,
95 char *str_buf, int str_size),
96 struct tipc_media_addr *bcast_addr,
97 const u32 bearer_priority,
98 const u32 link_tolerance, /* [ms] */
99 const u32 send_window_limit)
106 write_lock_bh(&tipc_net_lock);
108 if (tipc_mode != TIPC_NET_MODE) {
109 warn("Media <%s> rejected, not in networked mode yet\n", name);
112 if (!media_name_valid(name)) {
113 warn("Media <%s> rejected, illegal name\n", name);
117 warn("Media <%s> rejected, no broadcast address\n", name);
120 if ((bearer_priority < TIPC_MIN_LINK_PRI) ||
121 (bearer_priority > TIPC_MAX_LINK_PRI)) {
122 warn("Media <%s> rejected, illegal priority (%u)\n", name,
126 if ((link_tolerance < TIPC_MIN_LINK_TOL) ||
127 (link_tolerance > TIPC_MAX_LINK_TOL)) {
128 warn("Media <%s> rejected, illegal tolerance (%u)\n", name,
133 media_id = media_count++;
134 if (media_id >= MAX_MEDIA) {
135 warn("Media <%s> rejected, media limit reached (%u)\n", name,
140 for (i = 0; i < media_id; i++) {
141 if (media_list[i].type_id == media_type) {
142 warn("Media <%s> rejected, duplicate type (%u)\n", name,
147 if (!strcmp(name, media_list[i].name)) {
148 warn("Media <%s> rejected, duplicate name\n", name);
154 m_ptr = &media_list[media_id];
155 m_ptr->type_id = media_type;
156 m_ptr->send_msg = send_msg;
157 m_ptr->enable_bearer = enable;
158 m_ptr->disable_bearer = disable;
159 m_ptr->addr2str = addr2str;
160 memcpy(&m_ptr->bcast_addr, bcast_addr, sizeof(*bcast_addr));
162 strcpy(m_ptr->name, name);
163 m_ptr->priority = bearer_priority;
164 m_ptr->tolerance = link_tolerance;
165 m_ptr->window = send_window_limit;
168 write_unlock_bh(&tipc_net_lock);
173 * tipc_media_addr_printf - record media address in print buffer
176 void tipc_media_addr_printf(struct print_buf *pb, struct tipc_media_addr *a)
182 media_type = ntohl(a->type);
183 for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
184 if (m_ptr->type_id == media_type)
188 if ((i < media_count) && (m_ptr->addr2str != NULL)) {
189 char addr_str[MAX_ADDR_STR];
191 tipc_printf(pb, "%s(%s)", m_ptr->name,
192 m_ptr->addr2str(a, addr_str, sizeof(addr_str)));
194 unchar *addr = (unchar *)&a->dev_addr;
196 tipc_printf(pb, "UNKNOWN(%u)", media_type);
197 for (i = 0; i < (sizeof(*a) - sizeof(a->type)); i++)
198 tipc_printf(pb, "-%02x", addr[i]);
203 * tipc_media_get_names - record names of registered media in buffer
206 struct sk_buff *tipc_media_get_names(void)
212 buf = tipc_cfg_reply_alloc(MAX_MEDIA * TLV_SPACE(TIPC_MAX_MEDIA_NAME));
216 read_lock_bh(&tipc_net_lock);
217 for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
218 tipc_cfg_append_tlv(buf, TIPC_TLV_MEDIA_NAME, m_ptr->name,
219 strlen(m_ptr->name) + 1);
221 read_unlock_bh(&tipc_net_lock);
226 * bearer_name_validate - validate & (optionally) deconstruct bearer name
227 * @name - ptr to bearer name string
228 * @name_parts - ptr to area for bearer name components (or NULL if not needed)
230 * Returns 1 if bearer name is valid, otherwise 0.
233 static int bearer_name_validate(const char *name,
234 struct bearer_name *name_parts)
236 char name_copy[TIPC_MAX_BEARER_NAME];
242 /* copy bearer name & ensure length is OK */
244 name_copy[TIPC_MAX_BEARER_NAME - 1] = 0;
245 /* need above in case non-Posix strncpy() doesn't pad with nulls */
246 strncpy(name_copy, name, TIPC_MAX_BEARER_NAME);
247 if (name_copy[TIPC_MAX_BEARER_NAME - 1] != 0)
250 /* ensure all component parts of bearer name are present */
252 media_name = name_copy;
253 if_name = strchr(media_name, ':');
257 media_len = if_name - media_name;
258 if_len = strlen(if_name) + 1;
260 /* validate component parts of bearer name */
262 if ((media_len <= 1) || (media_len > TIPC_MAX_MEDIA_NAME) ||
263 (if_len <= 1) || (if_len > TIPC_MAX_IF_NAME) ||
264 (strspn(media_name, tipc_alphabet) != (media_len - 1)) ||
265 (strspn(if_name, tipc_alphabet) != (if_len - 1)))
268 /* return bearer name components, if necessary */
271 strcpy(name_parts->media_name, media_name);
272 strcpy(name_parts->if_name, if_name);
278 * bearer_find - locates bearer object with matching bearer name
281 static struct bearer *bearer_find(const char *name)
283 struct bearer *b_ptr;
286 for (i = 0, b_ptr = tipc_bearers; i < MAX_BEARERS; i++, b_ptr++) {
287 if (b_ptr->active && (!strcmp(b_ptr->publ.name, name)))
294 * tipc_bearer_find_interface - locates bearer object with matching interface name
297 struct bearer *tipc_bearer_find_interface(const char *if_name)
299 struct bearer *b_ptr;
303 for (i = 0, b_ptr = tipc_bearers; i < MAX_BEARERS; i++, b_ptr++) {
306 b_if_name = strchr(b_ptr->publ.name, ':') + 1;
307 if (!strcmp(b_if_name, if_name))
314 * tipc_bearer_get_names - record names of bearers in buffer
317 struct sk_buff *tipc_bearer_get_names(void)
321 struct bearer *b_ptr;
324 buf = tipc_cfg_reply_alloc(MAX_BEARERS * TLV_SPACE(TIPC_MAX_BEARER_NAME));
328 read_lock_bh(&tipc_net_lock);
329 for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
330 for (j = 0; j < MAX_BEARERS; j++) {
331 b_ptr = &tipc_bearers[j];
332 if (b_ptr->active && (b_ptr->media == m_ptr)) {
333 tipc_cfg_append_tlv(buf, TIPC_TLV_BEARER_NAME,
335 strlen(b_ptr->publ.name) + 1);
339 read_unlock_bh(&tipc_net_lock);
343 void tipc_bearer_add_dest(struct bearer *b_ptr, u32 dest)
345 tipc_nmap_add(&b_ptr->nodes, dest);
346 tipc_disc_update_link_req(b_ptr->link_req);
347 tipc_bcbearer_sort();
350 void tipc_bearer_remove_dest(struct bearer *b_ptr, u32 dest)
352 tipc_nmap_remove(&b_ptr->nodes, dest);
353 tipc_disc_update_link_req(b_ptr->link_req);
354 tipc_bcbearer_sort();
358 * bearer_push(): Resolve bearer congestion. Force the waiting
359 * links to push out their unsent packets, one packet per link
360 * per iteration, until all packets are gone or congestion reoccurs.
361 * 'tipc_net_lock' is read_locked when this function is called
362 * bearer.lock must be taken before calling
363 * Returns binary true(1) ore false(0)
365 static int bearer_push(struct bearer *b_ptr)
368 struct link *ln, *tln;
370 if (b_ptr->publ.blocked)
373 while (!list_empty(&b_ptr->cong_links) && (res != PUSH_FAILED)) {
374 list_for_each_entry_safe(ln, tln, &b_ptr->cong_links, link_list) {
375 res = tipc_link_push_packet(ln);
376 if (res == PUSH_FAILED)
378 if (res == PUSH_FINISHED)
379 list_move_tail(&ln->link_list, &b_ptr->links);
382 return list_empty(&b_ptr->cong_links);
385 void tipc_bearer_lock_push(struct bearer *b_ptr)
389 spin_lock_bh(&b_ptr->publ.lock);
390 res = bearer_push(b_ptr);
391 spin_unlock_bh(&b_ptr->publ.lock);
393 tipc_bcbearer_push();
398 * Interrupt enabling new requests after bearer congestion or blocking:
401 void tipc_continue(struct tipc_bearer *tb_ptr)
403 struct bearer *b_ptr = (struct bearer *)tb_ptr;
405 spin_lock_bh(&b_ptr->publ.lock);
406 b_ptr->continue_count++;
407 if (!list_empty(&b_ptr->cong_links))
408 tipc_k_signal((Handler)tipc_bearer_lock_push, (unsigned long)b_ptr);
409 b_ptr->publ.blocked = 0;
410 spin_unlock_bh(&b_ptr->publ.lock);
414 * Schedule link for sending of messages after the bearer
415 * has been deblocked by 'continue()'. This method is called
416 * when somebody tries to send a message via this link while
417 * the bearer is congested. 'tipc_net_lock' is in read_lock here
418 * bearer.lock is busy
421 static void tipc_bearer_schedule_unlocked(struct bearer *b_ptr, struct link *l_ptr)
423 list_move_tail(&l_ptr->link_list, &b_ptr->cong_links);
427 * Schedule link for sending of messages after the bearer
428 * has been deblocked by 'continue()'. This method is called
429 * when somebody tries to send a message via this link while
430 * the bearer is congested. 'tipc_net_lock' is in read_lock here,
431 * bearer.lock is free
434 void tipc_bearer_schedule(struct bearer *b_ptr, struct link *l_ptr)
436 spin_lock_bh(&b_ptr->publ.lock);
437 tipc_bearer_schedule_unlocked(b_ptr, l_ptr);
438 spin_unlock_bh(&b_ptr->publ.lock);
443 * tipc_bearer_resolve_congestion(): Check if there is bearer congestion,
444 * and if there is, try to resolve it before returning.
445 * 'tipc_net_lock' is read_locked when this function is called
447 int tipc_bearer_resolve_congestion(struct bearer *b_ptr, struct link *l_ptr)
451 if (list_empty(&b_ptr->cong_links))
453 spin_lock_bh(&b_ptr->publ.lock);
454 if (!bearer_push(b_ptr)) {
455 tipc_bearer_schedule_unlocked(b_ptr, l_ptr);
458 spin_unlock_bh(&b_ptr->publ.lock);
463 * tipc_bearer_congested - determines if bearer is currently congested
466 int tipc_bearer_congested(struct bearer *b_ptr, struct link *l_ptr)
468 if (unlikely(b_ptr->publ.blocked))
470 if (likely(list_empty(&b_ptr->cong_links)))
472 return !tipc_bearer_resolve_congestion(b_ptr, l_ptr);
476 * tipc_enable_bearer - enable bearer with the given name
479 int tipc_enable_bearer(const char *name, u32 bcast_scope, u32 priority)
481 struct bearer *b_ptr;
483 struct bearer_name b_name;
484 char addr_string[16];
490 if (tipc_mode != TIPC_NET_MODE) {
491 warn("Bearer <%s> rejected, not supported in standalone mode\n",
495 if (!bearer_name_validate(name, &b_name)) {
496 warn("Bearer <%s> rejected, illegal name\n", name);
499 if (!tipc_addr_domain_valid(bcast_scope) ||
500 !tipc_in_scope(bcast_scope, tipc_own_addr)) {
501 warn("Bearer <%s> rejected, illegal broadcast scope\n", name);
504 if ((priority < TIPC_MIN_LINK_PRI ||
505 priority > TIPC_MAX_LINK_PRI) &&
506 (priority != TIPC_MEDIA_LINK_PRI)) {
507 warn("Bearer <%s> rejected, illegal priority\n", name);
511 write_lock_bh(&tipc_net_lock);
513 m_ptr = media_find(b_name.media_name);
515 warn("Bearer <%s> rejected, media <%s> not registered\n", name,
520 if (priority == TIPC_MEDIA_LINK_PRI)
521 priority = m_ptr->priority;
524 bearer_id = MAX_BEARERS;
526 for (i = MAX_BEARERS; i-- != 0; ) {
527 if (!tipc_bearers[i].active) {
531 if (!strcmp(name, tipc_bearers[i].publ.name)) {
532 warn("Bearer <%s> rejected, already enabled\n", name);
535 if ((tipc_bearers[i].priority == priority) &&
536 (++with_this_prio > 2)) {
537 if (priority-- == 0) {
538 warn("Bearer <%s> rejected, duplicate priority\n",
542 warn("Bearer <%s> priority adjustment required %u->%u\n",
543 name, priority + 1, priority);
547 if (bearer_id >= MAX_BEARERS) {
548 warn("Bearer <%s> rejected, bearer limit reached (%u)\n",
553 b_ptr = &tipc_bearers[bearer_id];
554 strcpy(b_ptr->publ.name, name);
555 res = m_ptr->enable_bearer(&b_ptr->publ);
557 warn("Bearer <%s> rejected, enable failure (%d)\n", name, -res);
561 b_ptr->identity = bearer_id;
562 b_ptr->media = m_ptr;
563 b_ptr->net_plane = bearer_id + 'A';
565 b_ptr->detect_scope = bcast_scope;
566 b_ptr->priority = priority;
567 INIT_LIST_HEAD(&b_ptr->cong_links);
568 INIT_LIST_HEAD(&b_ptr->links);
570 b_ptr->link_req = tipc_disc_init_link_req(b_ptr, &m_ptr->bcast_addr,
573 spin_lock_init(&b_ptr->publ.lock);
574 write_unlock_bh(&tipc_net_lock);
575 info("Enabled bearer <%s>, discovery domain %s, priority %u\n",
576 name, tipc_addr_string_fill(addr_string, bcast_scope), priority);
579 write_unlock_bh(&tipc_net_lock);
584 * tipc_block_bearer(): Block the bearer with the given name,
585 * and reset all its links
588 int tipc_block_bearer(const char *name)
590 struct bearer *b_ptr = NULL;
592 struct link *temp_l_ptr;
594 read_lock_bh(&tipc_net_lock);
595 b_ptr = bearer_find(name);
597 warn("Attempt to block unknown bearer <%s>\n", name);
598 read_unlock_bh(&tipc_net_lock);
602 info("Blocking bearer <%s>\n", name);
603 spin_lock_bh(&b_ptr->publ.lock);
604 b_ptr->publ.blocked = 1;
605 list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
606 struct tipc_node *n_ptr = l_ptr->owner;
608 spin_lock_bh(&n_ptr->lock);
609 tipc_link_reset(l_ptr);
610 spin_unlock_bh(&n_ptr->lock);
612 spin_unlock_bh(&b_ptr->publ.lock);
613 read_unlock_bh(&tipc_net_lock);
620 * Note: This routine assumes caller holds tipc_net_lock.
623 static void bearer_disable(struct bearer *b_ptr)
626 struct link *temp_l_ptr;
628 info("Disabling bearer <%s>\n", b_ptr->publ.name);
629 tipc_disc_stop_link_req(b_ptr->link_req);
630 spin_lock_bh(&b_ptr->publ.lock);
631 b_ptr->link_req = NULL;
632 b_ptr->publ.blocked = 1;
633 b_ptr->media->disable_bearer(&b_ptr->publ);
634 list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
635 tipc_link_delete(l_ptr);
637 spin_unlock_bh(&b_ptr->publ.lock);
638 memset(b_ptr, 0, sizeof(struct bearer));
641 int tipc_disable_bearer(const char *name)
643 struct bearer *b_ptr;
646 write_lock_bh(&tipc_net_lock);
647 b_ptr = bearer_find(name);
649 warn("Attempt to disable unknown bearer <%s>\n", name);
652 bearer_disable(b_ptr);
655 write_unlock_bh(&tipc_net_lock);
661 void tipc_bearer_stop(void)
665 for (i = 0; i < MAX_BEARERS; i++) {
666 if (tipc_bearers[i].active)
667 bearer_disable(&tipc_bearers[i]);