drivers/staging/brcm80211/brcmfmac/wl_iw.c: introduce missing kfree
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / net / tipc / bearer.c
blob411719feb80391284d6d6f2438a9ec70dab91ee5
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 media media_list[MAX_MEDIA];
45 static u32 media_count;
47 struct tipc_bearer tipc_bearers[MAX_BEARERS];
49 /**
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)
57 u32 len;
59 len = strlen(name);
60 if ((len + 1) > TIPC_MAX_MEDIA_NAME)
61 return 0;
62 return strspn(name, tipc_alphabet) == len;
65 /**
66 * media_find - locates specified media object by name
69 static struct media *media_find(const char *name)
71 struct media *m_ptr;
72 u32 i;
74 for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
75 if (!strcmp(m_ptr->name, name))
76 return m_ptr;
78 return NULL;
81 /**
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,
88 char *name,
89 int (*enable)(struct tipc_bearer *),
90 void (*disable)(struct tipc_bearer *),
91 int (*send_msg)(struct sk_buff *,
92 struct tipc_bearer *,
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)
101 struct media *m_ptr;
102 u32 media_id;
103 u32 i;
104 int res = -EINVAL;
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);
110 goto exit;
112 if (!media_name_valid(name)) {
113 warn("Media <%s> rejected, illegal name\n", name);
114 goto exit;
116 if (!bcast_addr) {
117 warn("Media <%s> rejected, no broadcast address\n", name);
118 goto exit;
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,
123 bearer_priority);
124 goto exit;
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,
129 link_tolerance);
130 goto exit;
133 media_id = media_count++;
134 if (media_id >= MAX_MEDIA) {
135 warn("Media <%s> rejected, media limit reached (%u)\n", name,
136 MAX_MEDIA);
137 media_count--;
138 goto exit;
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,
143 media_type);
144 media_count--;
145 goto exit;
147 if (!strcmp(name, media_list[i].name)) {
148 warn("Media <%s> rejected, duplicate name\n", name);
149 media_count--;
150 goto exit;
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));
161 strcpy(m_ptr->name, name);
162 m_ptr->priority = bearer_priority;
163 m_ptr->tolerance = link_tolerance;
164 m_ptr->window = send_window_limit;
165 res = 0;
166 exit:
167 write_unlock_bh(&tipc_net_lock);
168 return res;
172 * tipc_media_addr_printf - record media address in print buffer
175 void tipc_media_addr_printf(struct print_buf *pb, struct tipc_media_addr *a)
177 struct media *m_ptr;
178 u32 media_type;
179 u32 i;
181 media_type = ntohl(a->type);
182 for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
183 if (m_ptr->type_id == media_type)
184 break;
187 if ((i < media_count) && (m_ptr->addr2str != NULL)) {
188 char addr_str[MAX_ADDR_STR];
190 tipc_printf(pb, "%s(%s)", m_ptr->name,
191 m_ptr->addr2str(a, addr_str, sizeof(addr_str)));
192 } else {
193 unchar *addr = (unchar *)&a->dev_addr;
195 tipc_printf(pb, "UNKNOWN(%u)", media_type);
196 for (i = 0; i < (sizeof(*a) - sizeof(a->type)); i++)
197 tipc_printf(pb, "-%02x", addr[i]);
202 * tipc_media_get_names - record names of registered media in buffer
205 struct sk_buff *tipc_media_get_names(void)
207 struct sk_buff *buf;
208 struct media *m_ptr;
209 int i;
211 buf = tipc_cfg_reply_alloc(MAX_MEDIA * TLV_SPACE(TIPC_MAX_MEDIA_NAME));
212 if (!buf)
213 return NULL;
215 read_lock_bh(&tipc_net_lock);
216 for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
217 tipc_cfg_append_tlv(buf, TIPC_TLV_MEDIA_NAME, m_ptr->name,
218 strlen(m_ptr->name) + 1);
220 read_unlock_bh(&tipc_net_lock);
221 return buf;
225 * bearer_name_validate - validate & (optionally) deconstruct bearer name
226 * @name - ptr to bearer name string
227 * @name_parts - ptr to area for bearer name components (or NULL if not needed)
229 * Returns 1 if bearer name is valid, otherwise 0.
232 static int bearer_name_validate(const char *name,
233 struct bearer_name *name_parts)
235 char name_copy[TIPC_MAX_BEARER_NAME];
236 char *media_name;
237 char *if_name;
238 u32 media_len;
239 u32 if_len;
241 /* copy bearer name & ensure length is OK */
243 name_copy[TIPC_MAX_BEARER_NAME - 1] = 0;
244 /* need above in case non-Posix strncpy() doesn't pad with nulls */
245 strncpy(name_copy, name, TIPC_MAX_BEARER_NAME);
246 if (name_copy[TIPC_MAX_BEARER_NAME - 1] != 0)
247 return 0;
249 /* ensure all component parts of bearer name are present */
251 media_name = name_copy;
252 if_name = strchr(media_name, ':');
253 if (if_name == NULL)
254 return 0;
255 *(if_name++) = 0;
256 media_len = if_name - media_name;
257 if_len = strlen(if_name) + 1;
259 /* validate component parts of bearer name */
261 if ((media_len <= 1) || (media_len > TIPC_MAX_MEDIA_NAME) ||
262 (if_len <= 1) || (if_len > TIPC_MAX_IF_NAME) ||
263 (strspn(media_name, tipc_alphabet) != (media_len - 1)) ||
264 (strspn(if_name, tipc_alphabet) != (if_len - 1)))
265 return 0;
267 /* return bearer name components, if necessary */
269 if (name_parts) {
270 strcpy(name_parts->media_name, media_name);
271 strcpy(name_parts->if_name, if_name);
273 return 1;
277 * bearer_find - locates bearer object with matching bearer name
280 static struct tipc_bearer *bearer_find(const char *name)
282 struct tipc_bearer *b_ptr;
283 u32 i;
285 for (i = 0, b_ptr = tipc_bearers; i < MAX_BEARERS; i++, b_ptr++) {
286 if (b_ptr->active && (!strcmp(b_ptr->name, name)))
287 return b_ptr;
289 return NULL;
293 * tipc_bearer_find_interface - locates bearer object with matching interface name
296 struct tipc_bearer *tipc_bearer_find_interface(const char *if_name)
298 struct tipc_bearer *b_ptr;
299 char *b_if_name;
300 u32 i;
302 for (i = 0, b_ptr = tipc_bearers; i < MAX_BEARERS; i++, b_ptr++) {
303 if (!b_ptr->active)
304 continue;
305 b_if_name = strchr(b_ptr->name, ':') + 1;
306 if (!strcmp(b_if_name, if_name))
307 return b_ptr;
309 return NULL;
313 * tipc_bearer_get_names - record names of bearers in buffer
316 struct sk_buff *tipc_bearer_get_names(void)
318 struct sk_buff *buf;
319 struct media *m_ptr;
320 struct tipc_bearer *b_ptr;
321 int i, j;
323 buf = tipc_cfg_reply_alloc(MAX_BEARERS * TLV_SPACE(TIPC_MAX_BEARER_NAME));
324 if (!buf)
325 return NULL;
327 read_lock_bh(&tipc_net_lock);
328 for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
329 for (j = 0; j < MAX_BEARERS; j++) {
330 b_ptr = &tipc_bearers[j];
331 if (b_ptr->active && (b_ptr->media == m_ptr)) {
332 tipc_cfg_append_tlv(buf, TIPC_TLV_BEARER_NAME,
333 b_ptr->name,
334 strlen(b_ptr->name) + 1);
338 read_unlock_bh(&tipc_net_lock);
339 return buf;
342 void tipc_bearer_add_dest(struct tipc_bearer *b_ptr, u32 dest)
344 tipc_nmap_add(&b_ptr->nodes, dest);
345 tipc_disc_update_link_req(b_ptr->link_req);
346 tipc_bcbearer_sort();
349 void tipc_bearer_remove_dest(struct tipc_bearer *b_ptr, u32 dest)
351 tipc_nmap_remove(&b_ptr->nodes, dest);
352 tipc_disc_update_link_req(b_ptr->link_req);
353 tipc_bcbearer_sort();
357 * bearer_push(): Resolve bearer congestion. Force the waiting
358 * links to push out their unsent packets, one packet per link
359 * per iteration, until all packets are gone or congestion reoccurs.
360 * 'tipc_net_lock' is read_locked when this function is called
361 * bearer.lock must be taken before calling
362 * Returns binary true(1) ore false(0)
364 static int bearer_push(struct tipc_bearer *b_ptr)
366 u32 res = 0;
367 struct link *ln, *tln;
369 if (b_ptr->blocked)
370 return 0;
372 while (!list_empty(&b_ptr->cong_links) && (res != PUSH_FAILED)) {
373 list_for_each_entry_safe(ln, tln, &b_ptr->cong_links, link_list) {
374 res = tipc_link_push_packet(ln);
375 if (res == PUSH_FAILED)
376 break;
377 if (res == PUSH_FINISHED)
378 list_move_tail(&ln->link_list, &b_ptr->links);
381 return list_empty(&b_ptr->cong_links);
384 void tipc_bearer_lock_push(struct tipc_bearer *b_ptr)
386 int res;
388 spin_lock_bh(&b_ptr->lock);
389 res = bearer_push(b_ptr);
390 spin_unlock_bh(&b_ptr->lock);
391 if (res)
392 tipc_bcbearer_push();
397 * Interrupt enabling new requests after bearer congestion or blocking:
398 * See bearer_send().
400 void tipc_continue(struct tipc_bearer *b_ptr)
402 spin_lock_bh(&b_ptr->lock);
403 b_ptr->continue_count++;
404 if (!list_empty(&b_ptr->cong_links))
405 tipc_k_signal((Handler)tipc_bearer_lock_push, (unsigned long)b_ptr);
406 b_ptr->blocked = 0;
407 spin_unlock_bh(&b_ptr->lock);
411 * Schedule link for sending of messages after the bearer
412 * has been deblocked by 'continue()'. This method is called
413 * when somebody tries to send a message via this link while
414 * the bearer is congested. 'tipc_net_lock' is in read_lock here
415 * bearer.lock is busy
418 static void tipc_bearer_schedule_unlocked(struct tipc_bearer *b_ptr, struct link *l_ptr)
420 list_move_tail(&l_ptr->link_list, &b_ptr->cong_links);
424 * Schedule link for sending of messages after the bearer
425 * has been deblocked by 'continue()'. This method is called
426 * when somebody tries to send a message via this link while
427 * the bearer is congested. 'tipc_net_lock' is in read_lock here,
428 * bearer.lock is free
431 void tipc_bearer_schedule(struct tipc_bearer *b_ptr, struct link *l_ptr)
433 spin_lock_bh(&b_ptr->lock);
434 tipc_bearer_schedule_unlocked(b_ptr, l_ptr);
435 spin_unlock_bh(&b_ptr->lock);
440 * tipc_bearer_resolve_congestion(): Check if there is bearer congestion,
441 * and if there is, try to resolve it before returning.
442 * 'tipc_net_lock' is read_locked when this function is called
444 int tipc_bearer_resolve_congestion(struct tipc_bearer *b_ptr, struct link *l_ptr)
446 int res = 1;
448 if (list_empty(&b_ptr->cong_links))
449 return 1;
450 spin_lock_bh(&b_ptr->lock);
451 if (!bearer_push(b_ptr)) {
452 tipc_bearer_schedule_unlocked(b_ptr, l_ptr);
453 res = 0;
455 spin_unlock_bh(&b_ptr->lock);
456 return res;
460 * tipc_bearer_congested - determines if bearer is currently congested
463 int tipc_bearer_congested(struct tipc_bearer *b_ptr, struct link *l_ptr)
465 if (unlikely(b_ptr->blocked))
466 return 1;
467 if (likely(list_empty(&b_ptr->cong_links)))
468 return 0;
469 return !tipc_bearer_resolve_congestion(b_ptr, l_ptr);
473 * tipc_enable_bearer - enable bearer with the given name
476 int tipc_enable_bearer(const char *name, u32 disc_domain, u32 priority)
478 struct tipc_bearer *b_ptr;
479 struct media *m_ptr;
480 struct bearer_name b_name;
481 char addr_string[16];
482 u32 bearer_id;
483 u32 with_this_prio;
484 u32 i;
485 int res = -EINVAL;
487 if (tipc_mode != TIPC_NET_MODE) {
488 warn("Bearer <%s> rejected, not supported in standalone mode\n",
489 name);
490 return -ENOPROTOOPT;
492 if (!bearer_name_validate(name, &b_name)) {
493 warn("Bearer <%s> rejected, illegal name\n", name);
494 return -EINVAL;
496 if (!tipc_addr_domain_valid(disc_domain) ||
497 !tipc_in_scope(disc_domain, tipc_own_addr)) {
498 warn("Bearer <%s> rejected, illegal discovery domain\n", name);
499 return -EINVAL;
501 if ((priority < TIPC_MIN_LINK_PRI ||
502 priority > TIPC_MAX_LINK_PRI) &&
503 (priority != TIPC_MEDIA_LINK_PRI)) {
504 warn("Bearer <%s> rejected, illegal priority\n", name);
505 return -EINVAL;
508 write_lock_bh(&tipc_net_lock);
510 m_ptr = media_find(b_name.media_name);
511 if (!m_ptr) {
512 warn("Bearer <%s> rejected, media <%s> not registered\n", name,
513 b_name.media_name);
514 goto failed;
517 if (priority == TIPC_MEDIA_LINK_PRI)
518 priority = m_ptr->priority;
520 restart:
521 bearer_id = MAX_BEARERS;
522 with_this_prio = 1;
523 for (i = MAX_BEARERS; i-- != 0; ) {
524 if (!tipc_bearers[i].active) {
525 bearer_id = i;
526 continue;
528 if (!strcmp(name, tipc_bearers[i].name)) {
529 warn("Bearer <%s> rejected, already enabled\n", name);
530 goto failed;
532 if ((tipc_bearers[i].priority == priority) &&
533 (++with_this_prio > 2)) {
534 if (priority-- == 0) {
535 warn("Bearer <%s> rejected, duplicate priority\n",
536 name);
537 goto failed;
539 warn("Bearer <%s> priority adjustment required %u->%u\n",
540 name, priority + 1, priority);
541 goto restart;
544 if (bearer_id >= MAX_BEARERS) {
545 warn("Bearer <%s> rejected, bearer limit reached (%u)\n",
546 name, MAX_BEARERS);
547 goto failed;
550 b_ptr = &tipc_bearers[bearer_id];
551 strcpy(b_ptr->name, name);
552 res = m_ptr->enable_bearer(b_ptr);
553 if (res) {
554 warn("Bearer <%s> rejected, enable failure (%d)\n", name, -res);
555 goto failed;
558 b_ptr->identity = bearer_id;
559 b_ptr->media = m_ptr;
560 b_ptr->net_plane = bearer_id + 'A';
561 b_ptr->active = 1;
562 b_ptr->priority = priority;
563 INIT_LIST_HEAD(&b_ptr->cong_links);
564 INIT_LIST_HEAD(&b_ptr->links);
565 b_ptr->link_req = tipc_disc_init_link_req(b_ptr, &m_ptr->bcast_addr,
566 disc_domain);
567 spin_lock_init(&b_ptr->lock);
568 write_unlock_bh(&tipc_net_lock);
569 info("Enabled bearer <%s>, discovery domain %s, priority %u\n",
570 name, tipc_addr_string_fill(addr_string, disc_domain), priority);
571 return 0;
572 failed:
573 write_unlock_bh(&tipc_net_lock);
574 return res;
578 * tipc_block_bearer(): Block the bearer with the given name,
579 * and reset all its links
582 int tipc_block_bearer(const char *name)
584 struct tipc_bearer *b_ptr = NULL;
585 struct link *l_ptr;
586 struct link *temp_l_ptr;
588 read_lock_bh(&tipc_net_lock);
589 b_ptr = bearer_find(name);
590 if (!b_ptr) {
591 warn("Attempt to block unknown bearer <%s>\n", name);
592 read_unlock_bh(&tipc_net_lock);
593 return -EINVAL;
596 info("Blocking bearer <%s>\n", name);
597 spin_lock_bh(&b_ptr->lock);
598 b_ptr->blocked = 1;
599 list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
600 struct tipc_node *n_ptr = l_ptr->owner;
602 spin_lock_bh(&n_ptr->lock);
603 tipc_link_reset(l_ptr);
604 spin_unlock_bh(&n_ptr->lock);
606 spin_unlock_bh(&b_ptr->lock);
607 read_unlock_bh(&tipc_net_lock);
608 return 0;
612 * bearer_disable -
614 * Note: This routine assumes caller holds tipc_net_lock.
617 static void bearer_disable(struct tipc_bearer *b_ptr)
619 struct link *l_ptr;
620 struct link *temp_l_ptr;
622 info("Disabling bearer <%s>\n", b_ptr->name);
623 tipc_disc_stop_link_req(b_ptr->link_req);
624 spin_lock_bh(&b_ptr->lock);
625 b_ptr->link_req = NULL;
626 b_ptr->blocked = 1;
627 b_ptr->media->disable_bearer(b_ptr);
628 list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
629 tipc_link_delete(l_ptr);
631 spin_unlock_bh(&b_ptr->lock);
632 memset(b_ptr, 0, sizeof(struct tipc_bearer));
635 int tipc_disable_bearer(const char *name)
637 struct tipc_bearer *b_ptr;
638 int res;
640 write_lock_bh(&tipc_net_lock);
641 b_ptr = bearer_find(name);
642 if (b_ptr == NULL) {
643 warn("Attempt to disable unknown bearer <%s>\n", name);
644 res = -EINVAL;
645 } else {
646 bearer_disable(b_ptr);
647 res = 0;
649 write_unlock_bh(&tipc_net_lock);
650 return res;
655 void tipc_bearer_stop(void)
657 u32 i;
659 for (i = 0; i < MAX_BEARERS; i++) {
660 if (tipc_bearers[i].active)
661 bearer_disable(&tipc_bearers[i]);
663 media_count = 0;