spi-topcliff-pch: Fix issue for transmitting over 4KByte
[zen-stable.git] / net / tipc / bearer.c
blob329fb659fae4c2b89d4c0830466dab297906dc8c
1 /*
2 * net/tipc/bearer.c: TIPC bearer code
4 * Copyright (c) 1996-2006, Ericsson AB
5 * Copyright (c) 2004-2006, 2010-2011, Wind River Systems
6 * All rights reserved.
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.
37 #include "core.h"
38 #include "config.h"
39 #include "bearer.h"
40 #include "discover.h"
42 #define MAX_ADDR_STR 32
44 static struct tipc_media *media_list[MAX_MEDIA];
45 static u32 media_count;
47 struct tipc_bearer tipc_bearers[MAX_BEARERS];
49 static void bearer_disable(struct tipc_bearer *b_ptr);
51 /**
52 * media_name_valid - validate media name
54 * Returns 1 if media name is valid, otherwise 0.
57 static int media_name_valid(const char *name)
59 u32 len;
61 len = strlen(name);
62 if ((len + 1) > TIPC_MAX_MEDIA_NAME)
63 return 0;
64 return strspn(name, tipc_alphabet) == len;
67 /**
68 * tipc_media_find - locates specified media object by name
71 struct tipc_media *tipc_media_find(const char *name)
73 u32 i;
75 for (i = 0; i < media_count; i++) {
76 if (!strcmp(media_list[i]->name, name))
77 return media_list[i];
79 return NULL;
82 /**
83 * media_find_id - locates specified media object by type identifier
86 static struct tipc_media *media_find_id(u8 type)
88 u32 i;
90 for (i = 0; i < media_count; i++) {
91 if (media_list[i]->type_id == type)
92 return media_list[i];
94 return NULL;
97 /**
98 * tipc_register_media - register a media type
100 * Bearers for this media type must be activated separately at a later stage.
103 int tipc_register_media(struct tipc_media *m_ptr)
105 int res = -EINVAL;
107 write_lock_bh(&tipc_net_lock);
109 if (!media_name_valid(m_ptr->name))
110 goto exit;
111 if ((m_ptr->bcast_addr.media_id != m_ptr->type_id) ||
112 !m_ptr->bcast_addr.broadcast)
113 goto exit;
114 if (m_ptr->priority > TIPC_MAX_LINK_PRI)
115 goto exit;
116 if ((m_ptr->tolerance < TIPC_MIN_LINK_TOL) ||
117 (m_ptr->tolerance > TIPC_MAX_LINK_TOL))
118 goto exit;
119 if (media_count >= MAX_MEDIA)
120 goto exit;
121 if (tipc_media_find(m_ptr->name) || media_find_id(m_ptr->type_id))
122 goto exit;
124 media_list[media_count] = m_ptr;
125 media_count++;
126 res = 0;
127 exit:
128 write_unlock_bh(&tipc_net_lock);
129 if (res)
130 warn("Media <%s> registration error\n", m_ptr->name);
131 return res;
135 * tipc_media_addr_printf - record media address in print buffer
138 void tipc_media_addr_printf(struct print_buf *pb, struct tipc_media_addr *a)
140 char addr_str[MAX_ADDR_STR];
141 struct tipc_media *m_ptr;
143 m_ptr = media_find_id(a->media_id);
145 if (m_ptr && !m_ptr->addr2str(a, addr_str, sizeof(addr_str)))
146 tipc_printf(pb, "%s(%s)", m_ptr->name, addr_str);
147 else {
148 u32 i;
150 tipc_printf(pb, "UNKNOWN(%u)", a->media_id);
151 for (i = 0; i < sizeof(a->value); i++)
152 tipc_printf(pb, "-%02x", a->value[i]);
157 * tipc_media_get_names - record names of registered media in buffer
160 struct sk_buff *tipc_media_get_names(void)
162 struct sk_buff *buf;
163 int i;
165 buf = tipc_cfg_reply_alloc(MAX_MEDIA * TLV_SPACE(TIPC_MAX_MEDIA_NAME));
166 if (!buf)
167 return NULL;
169 read_lock_bh(&tipc_net_lock);
170 for (i = 0; i < media_count; i++) {
171 tipc_cfg_append_tlv(buf, TIPC_TLV_MEDIA_NAME,
172 media_list[i]->name,
173 strlen(media_list[i]->name) + 1);
175 read_unlock_bh(&tipc_net_lock);
176 return buf;
180 * bearer_name_validate - validate & (optionally) deconstruct bearer name
181 * @name - ptr to bearer name string
182 * @name_parts - ptr to area for bearer name components (or NULL if not needed)
184 * Returns 1 if bearer name is valid, otherwise 0.
187 static int bearer_name_validate(const char *name,
188 struct tipc_bearer_names *name_parts)
190 char name_copy[TIPC_MAX_BEARER_NAME];
191 char *media_name;
192 char *if_name;
193 u32 media_len;
194 u32 if_len;
196 /* copy bearer name & ensure length is OK */
198 name_copy[TIPC_MAX_BEARER_NAME - 1] = 0;
199 /* need above in case non-Posix strncpy() doesn't pad with nulls */
200 strncpy(name_copy, name, TIPC_MAX_BEARER_NAME);
201 if (name_copy[TIPC_MAX_BEARER_NAME - 1] != 0)
202 return 0;
204 /* ensure all component parts of bearer name are present */
206 media_name = name_copy;
207 if_name = strchr(media_name, ':');
208 if (if_name == NULL)
209 return 0;
210 *(if_name++) = 0;
211 media_len = if_name - media_name;
212 if_len = strlen(if_name) + 1;
214 /* validate component parts of bearer name */
216 if ((media_len <= 1) || (media_len > TIPC_MAX_MEDIA_NAME) ||
217 (if_len <= 1) || (if_len > TIPC_MAX_IF_NAME) ||
218 (strspn(media_name, tipc_alphabet) != (media_len - 1)) ||
219 (strspn(if_name, tipc_alphabet) != (if_len - 1)))
220 return 0;
222 /* return bearer name components, if necessary */
224 if (name_parts) {
225 strcpy(name_parts->media_name, media_name);
226 strcpy(name_parts->if_name, if_name);
228 return 1;
232 * tipc_bearer_find - locates bearer object with matching bearer name
235 struct tipc_bearer *tipc_bearer_find(const char *name)
237 struct tipc_bearer *b_ptr;
238 u32 i;
240 for (i = 0, b_ptr = tipc_bearers; i < MAX_BEARERS; i++, b_ptr++) {
241 if (b_ptr->active && (!strcmp(b_ptr->name, name)))
242 return b_ptr;
244 return NULL;
248 * tipc_bearer_find_interface - locates bearer object with matching interface name
251 struct tipc_bearer *tipc_bearer_find_interface(const char *if_name)
253 struct tipc_bearer *b_ptr;
254 char *b_if_name;
255 u32 i;
257 for (i = 0, b_ptr = tipc_bearers; i < MAX_BEARERS; i++, b_ptr++) {
258 if (!b_ptr->active)
259 continue;
260 b_if_name = strchr(b_ptr->name, ':') + 1;
261 if (!strcmp(b_if_name, if_name))
262 return b_ptr;
264 return NULL;
268 * tipc_bearer_get_names - record names of bearers in buffer
271 struct sk_buff *tipc_bearer_get_names(void)
273 struct sk_buff *buf;
274 struct tipc_bearer *b_ptr;
275 int i, j;
277 buf = tipc_cfg_reply_alloc(MAX_BEARERS * TLV_SPACE(TIPC_MAX_BEARER_NAME));
278 if (!buf)
279 return NULL;
281 read_lock_bh(&tipc_net_lock);
282 for (i = 0; i < media_count; i++) {
283 for (j = 0; j < MAX_BEARERS; j++) {
284 b_ptr = &tipc_bearers[j];
285 if (b_ptr->active && (b_ptr->media == media_list[i])) {
286 tipc_cfg_append_tlv(buf, TIPC_TLV_BEARER_NAME,
287 b_ptr->name,
288 strlen(b_ptr->name) + 1);
292 read_unlock_bh(&tipc_net_lock);
293 return buf;
296 void tipc_bearer_add_dest(struct tipc_bearer *b_ptr, u32 dest)
298 tipc_nmap_add(&b_ptr->nodes, dest);
299 tipc_bcbearer_sort();
300 tipc_disc_add_dest(b_ptr->link_req);
303 void tipc_bearer_remove_dest(struct tipc_bearer *b_ptr, u32 dest)
305 tipc_nmap_remove(&b_ptr->nodes, dest);
306 tipc_bcbearer_sort();
307 tipc_disc_remove_dest(b_ptr->link_req);
311 * bearer_push(): Resolve bearer congestion. Force the waiting
312 * links to push out their unsent packets, one packet per link
313 * per iteration, until all packets are gone or congestion reoccurs.
314 * 'tipc_net_lock' is read_locked when this function is called
315 * bearer.lock must be taken before calling
316 * Returns binary true(1) ore false(0)
318 static int bearer_push(struct tipc_bearer *b_ptr)
320 u32 res = 0;
321 struct tipc_link *ln, *tln;
323 if (b_ptr->blocked)
324 return 0;
326 while (!list_empty(&b_ptr->cong_links) && (res != PUSH_FAILED)) {
327 list_for_each_entry_safe(ln, tln, &b_ptr->cong_links, link_list) {
328 res = tipc_link_push_packet(ln);
329 if (res == PUSH_FAILED)
330 break;
331 if (res == PUSH_FINISHED)
332 list_move_tail(&ln->link_list, &b_ptr->links);
335 return list_empty(&b_ptr->cong_links);
338 void tipc_bearer_lock_push(struct tipc_bearer *b_ptr)
340 spin_lock_bh(&b_ptr->lock);
341 bearer_push(b_ptr);
342 spin_unlock_bh(&b_ptr->lock);
347 * Interrupt enabling new requests after bearer congestion or blocking:
348 * See bearer_send().
350 void tipc_continue(struct tipc_bearer *b_ptr)
352 spin_lock_bh(&b_ptr->lock);
353 if (!list_empty(&b_ptr->cong_links))
354 tipc_k_signal((Handler)tipc_bearer_lock_push, (unsigned long)b_ptr);
355 b_ptr->blocked = 0;
356 spin_unlock_bh(&b_ptr->lock);
360 * Schedule link for sending of messages after the bearer
361 * has been deblocked by 'continue()'. This method is called
362 * when somebody tries to send a message via this link while
363 * the bearer is congested. 'tipc_net_lock' is in read_lock here
364 * bearer.lock is busy
367 static void tipc_bearer_schedule_unlocked(struct tipc_bearer *b_ptr,
368 struct tipc_link *l_ptr)
370 list_move_tail(&l_ptr->link_list, &b_ptr->cong_links);
374 * Schedule link for sending of messages after the bearer
375 * has been deblocked by 'continue()'. This method is called
376 * when somebody tries to send a message via this link while
377 * the bearer is congested. 'tipc_net_lock' is in read_lock here,
378 * bearer.lock is free
381 void tipc_bearer_schedule(struct tipc_bearer *b_ptr, struct tipc_link *l_ptr)
383 spin_lock_bh(&b_ptr->lock);
384 tipc_bearer_schedule_unlocked(b_ptr, l_ptr);
385 spin_unlock_bh(&b_ptr->lock);
390 * tipc_bearer_resolve_congestion(): Check if there is bearer congestion,
391 * and if there is, try to resolve it before returning.
392 * 'tipc_net_lock' is read_locked when this function is called
394 int tipc_bearer_resolve_congestion(struct tipc_bearer *b_ptr,
395 struct tipc_link *l_ptr)
397 int res = 1;
399 if (list_empty(&b_ptr->cong_links))
400 return 1;
401 spin_lock_bh(&b_ptr->lock);
402 if (!bearer_push(b_ptr)) {
403 tipc_bearer_schedule_unlocked(b_ptr, l_ptr);
404 res = 0;
406 spin_unlock_bh(&b_ptr->lock);
407 return res;
411 * tipc_bearer_congested - determines if bearer is currently congested
414 int tipc_bearer_congested(struct tipc_bearer *b_ptr, struct tipc_link *l_ptr)
416 if (unlikely(b_ptr->blocked))
417 return 1;
418 if (likely(list_empty(&b_ptr->cong_links)))
419 return 0;
420 return !tipc_bearer_resolve_congestion(b_ptr, l_ptr);
424 * tipc_enable_bearer - enable bearer with the given name
427 int tipc_enable_bearer(const char *name, u32 disc_domain, u32 priority)
429 struct tipc_bearer *b_ptr;
430 struct tipc_media *m_ptr;
431 struct tipc_bearer_names b_names;
432 char addr_string[16];
433 u32 bearer_id;
434 u32 with_this_prio;
435 u32 i;
436 int res = -EINVAL;
438 if (tipc_mode != TIPC_NET_MODE) {
439 warn("Bearer <%s> rejected, not supported in standalone mode\n",
440 name);
441 return -ENOPROTOOPT;
443 if (!bearer_name_validate(name, &b_names)) {
444 warn("Bearer <%s> rejected, illegal name\n", name);
445 return -EINVAL;
447 if (tipc_addr_domain_valid(disc_domain) &&
448 (disc_domain != tipc_own_addr)) {
449 if (tipc_in_scope(disc_domain, tipc_own_addr)) {
450 disc_domain = tipc_own_addr & TIPC_CLUSTER_MASK;
451 res = 0; /* accept any node in own cluster */
452 } else if (in_own_cluster(disc_domain))
453 res = 0; /* accept specified node in own cluster */
455 if (res) {
456 warn("Bearer <%s> rejected, illegal discovery domain\n", name);
457 return -EINVAL;
459 if ((priority < TIPC_MIN_LINK_PRI ||
460 priority > TIPC_MAX_LINK_PRI) &&
461 (priority != TIPC_MEDIA_LINK_PRI)) {
462 warn("Bearer <%s> rejected, illegal priority\n", name);
463 return -EINVAL;
466 write_lock_bh(&tipc_net_lock);
468 m_ptr = tipc_media_find(b_names.media_name);
469 if (!m_ptr) {
470 warn("Bearer <%s> rejected, media <%s> not registered\n", name,
471 b_names.media_name);
472 goto exit;
475 if (priority == TIPC_MEDIA_LINK_PRI)
476 priority = m_ptr->priority;
478 restart:
479 bearer_id = MAX_BEARERS;
480 with_this_prio = 1;
481 for (i = MAX_BEARERS; i-- != 0; ) {
482 if (!tipc_bearers[i].active) {
483 bearer_id = i;
484 continue;
486 if (!strcmp(name, tipc_bearers[i].name)) {
487 warn("Bearer <%s> rejected, already enabled\n", name);
488 goto exit;
490 if ((tipc_bearers[i].priority == priority) &&
491 (++with_this_prio > 2)) {
492 if (priority-- == 0) {
493 warn("Bearer <%s> rejected, duplicate priority\n",
494 name);
495 goto exit;
497 warn("Bearer <%s> priority adjustment required %u->%u\n",
498 name, priority + 1, priority);
499 goto restart;
502 if (bearer_id >= MAX_BEARERS) {
503 warn("Bearer <%s> rejected, bearer limit reached (%u)\n",
504 name, MAX_BEARERS);
505 goto exit;
508 b_ptr = &tipc_bearers[bearer_id];
509 strcpy(b_ptr->name, name);
510 res = m_ptr->enable_bearer(b_ptr);
511 if (res) {
512 warn("Bearer <%s> rejected, enable failure (%d)\n", name, -res);
513 goto exit;
516 b_ptr->identity = bearer_id;
517 b_ptr->media = m_ptr;
518 b_ptr->tolerance = m_ptr->tolerance;
519 b_ptr->window = m_ptr->window;
520 b_ptr->net_plane = bearer_id + 'A';
521 b_ptr->active = 1;
522 b_ptr->priority = priority;
523 INIT_LIST_HEAD(&b_ptr->cong_links);
524 INIT_LIST_HEAD(&b_ptr->links);
525 spin_lock_init(&b_ptr->lock);
527 res = tipc_disc_create(b_ptr, &m_ptr->bcast_addr, disc_domain);
528 if (res) {
529 bearer_disable(b_ptr);
530 warn("Bearer <%s> rejected, discovery object creation failed\n",
531 name);
532 goto exit;
534 info("Enabled bearer <%s>, discovery domain %s, priority %u\n",
535 name, tipc_addr_string_fill(addr_string, disc_domain), priority);
536 exit:
537 write_unlock_bh(&tipc_net_lock);
538 return res;
542 * tipc_block_bearer(): Block the bearer with the given name,
543 * and reset all its links
546 int tipc_block_bearer(const char *name)
548 struct tipc_bearer *b_ptr = NULL;
549 struct tipc_link *l_ptr;
550 struct tipc_link *temp_l_ptr;
552 read_lock_bh(&tipc_net_lock);
553 b_ptr = tipc_bearer_find(name);
554 if (!b_ptr) {
555 warn("Attempt to block unknown bearer <%s>\n", name);
556 read_unlock_bh(&tipc_net_lock);
557 return -EINVAL;
560 info("Blocking bearer <%s>\n", name);
561 spin_lock_bh(&b_ptr->lock);
562 b_ptr->blocked = 1;
563 list_splice_init(&b_ptr->cong_links, &b_ptr->links);
564 list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
565 struct tipc_node *n_ptr = l_ptr->owner;
567 spin_lock_bh(&n_ptr->lock);
568 tipc_link_reset(l_ptr);
569 spin_unlock_bh(&n_ptr->lock);
571 spin_unlock_bh(&b_ptr->lock);
572 read_unlock_bh(&tipc_net_lock);
573 return 0;
577 * bearer_disable -
579 * Note: This routine assumes caller holds tipc_net_lock.
582 static void bearer_disable(struct tipc_bearer *b_ptr)
584 struct tipc_link *l_ptr;
585 struct tipc_link *temp_l_ptr;
587 info("Disabling bearer <%s>\n", b_ptr->name);
588 spin_lock_bh(&b_ptr->lock);
589 b_ptr->blocked = 1;
590 b_ptr->media->disable_bearer(b_ptr);
591 list_splice_init(&b_ptr->cong_links, &b_ptr->links);
592 list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
593 tipc_link_delete(l_ptr);
595 if (b_ptr->link_req)
596 tipc_disc_delete(b_ptr->link_req);
597 spin_unlock_bh(&b_ptr->lock);
598 memset(b_ptr, 0, sizeof(struct tipc_bearer));
601 int tipc_disable_bearer(const char *name)
603 struct tipc_bearer *b_ptr;
604 int res;
606 write_lock_bh(&tipc_net_lock);
607 b_ptr = tipc_bearer_find(name);
608 if (b_ptr == NULL) {
609 warn("Attempt to disable unknown bearer <%s>\n", name);
610 res = -EINVAL;
611 } else {
612 bearer_disable(b_ptr);
613 res = 0;
615 write_unlock_bh(&tipc_net_lock);
616 return res;
621 void tipc_bearer_stop(void)
623 u32 i;
625 for (i = 0; i < MAX_BEARERS; i++) {
626 if (tipc_bearers[i].active)
627 bearer_disable(&tipc_bearers[i]);
629 media_count = 0;