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
= 0;
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
]);
204 * tipc_media_get_names - record names of registered media in buffer
207 struct sk_buff
*tipc_media_get_names(void)
213 buf
= tipc_cfg_reply_alloc(MAX_MEDIA
* TLV_SPACE(TIPC_MAX_MEDIA_NAME
));
217 read_lock_bh(&tipc_net_lock
);
218 for (i
= 0, m_ptr
= media_list
; i
< media_count
; i
++, m_ptr
++) {
219 tipc_cfg_append_tlv(buf
, TIPC_TLV_MEDIA_NAME
, m_ptr
->name
,
220 strlen(m_ptr
->name
) + 1);
222 read_unlock_bh(&tipc_net_lock
);
227 * bearer_name_validate - validate & (optionally) deconstruct bearer name
228 * @name - ptr to bearer name string
229 * @name_parts - ptr to area for bearer name components (or NULL if not needed)
231 * Returns 1 if bearer name is valid, otherwise 0.
234 static int bearer_name_validate(const char *name
,
235 struct bearer_name
*name_parts
)
237 char name_copy
[TIPC_MAX_BEARER_NAME
];
243 /* copy bearer name & ensure length is OK */
245 name_copy
[TIPC_MAX_BEARER_NAME
- 1] = 0;
246 /* need above in case non-Posix strncpy() doesn't pad with nulls */
247 strncpy(name_copy
, name
, TIPC_MAX_BEARER_NAME
);
248 if (name_copy
[TIPC_MAX_BEARER_NAME
- 1] != 0)
251 /* ensure all component parts of bearer name are present */
253 media_name
= name_copy
;
254 if_name
= strchr(media_name
, ':');
258 media_len
= if_name
- media_name
;
259 if_len
= strlen(if_name
) + 1;
261 /* validate component parts of bearer name */
263 if ((media_len
<= 1) || (media_len
> TIPC_MAX_MEDIA_NAME
) ||
264 (if_len
<= 1) || (if_len
> TIPC_MAX_IF_NAME
) ||
265 (strspn(media_name
, tipc_alphabet
) != (media_len
- 1)) ||
266 (strspn(if_name
, tipc_alphabet
) != (if_len
- 1)))
269 /* return bearer name components, if necessary */
272 strcpy(name_parts
->media_name
, media_name
);
273 strcpy(name_parts
->if_name
, if_name
);
279 * bearer_find - locates bearer object with matching bearer name
282 static struct bearer
*bearer_find(const char *name
)
284 struct bearer
*b_ptr
;
287 for (i
= 0, b_ptr
= tipc_bearers
; i
< MAX_BEARERS
; i
++, b_ptr
++) {
288 if (b_ptr
->active
&& (!strcmp(b_ptr
->publ
.name
, name
)))
295 * tipc_bearer_find_interface - locates bearer object with matching interface name
298 struct bearer
*tipc_bearer_find_interface(const char *if_name
)
300 struct bearer
*b_ptr
;
304 for (i
= 0, b_ptr
= tipc_bearers
; i
< MAX_BEARERS
; i
++, b_ptr
++) {
307 b_if_name
= strchr(b_ptr
->publ
.name
, ':') + 1;
308 if (!strcmp(b_if_name
, if_name
))
315 * tipc_bearer_get_names - record names of bearers in buffer
318 struct sk_buff
*tipc_bearer_get_names(void)
322 struct bearer
*b_ptr
;
325 buf
= tipc_cfg_reply_alloc(MAX_BEARERS
* TLV_SPACE(TIPC_MAX_BEARER_NAME
));
329 read_lock_bh(&tipc_net_lock
);
330 for (i
= 0, m_ptr
= media_list
; i
< media_count
; i
++, m_ptr
++) {
331 for (j
= 0; j
< MAX_BEARERS
; j
++) {
332 b_ptr
= &tipc_bearers
[j
];
333 if (b_ptr
->active
&& (b_ptr
->media
== m_ptr
)) {
334 tipc_cfg_append_tlv(buf
, TIPC_TLV_BEARER_NAME
,
336 strlen(b_ptr
->publ
.name
) + 1);
340 read_unlock_bh(&tipc_net_lock
);
344 void tipc_bearer_add_dest(struct bearer
*b_ptr
, u32 dest
)
346 tipc_nmap_add(&b_ptr
->nodes
, dest
);
347 tipc_disc_update_link_req(b_ptr
->link_req
);
348 tipc_bcbearer_sort();
351 void tipc_bearer_remove_dest(struct bearer
*b_ptr
, u32 dest
)
353 tipc_nmap_remove(&b_ptr
->nodes
, dest
);
354 tipc_disc_update_link_req(b_ptr
->link_req
);
355 tipc_bcbearer_sort();
359 * bearer_push(): Resolve bearer congestion. Force the waiting
360 * links to push out their unsent packets, one packet per link
361 * per iteration, until all packets are gone or congestion reoccurs.
362 * 'tipc_net_lock' is read_locked when this function is called
363 * bearer.lock must be taken before calling
364 * Returns binary true(1) ore false(0)
366 static int bearer_push(struct bearer
*b_ptr
)
369 struct link
*ln
, *tln
;
371 if (b_ptr
->publ
.blocked
)
374 while (!list_empty(&b_ptr
->cong_links
) && (res
!= PUSH_FAILED
)) {
375 list_for_each_entry_safe(ln
, tln
, &b_ptr
->cong_links
, link_list
) {
376 res
= tipc_link_push_packet(ln
);
377 if (res
== PUSH_FAILED
)
379 if (res
== PUSH_FINISHED
)
380 list_move_tail(&ln
->link_list
, &b_ptr
->links
);
383 return list_empty(&b_ptr
->cong_links
);
386 void tipc_bearer_lock_push(struct bearer
*b_ptr
)
390 spin_lock_bh(&b_ptr
->publ
.lock
);
391 res
= bearer_push(b_ptr
);
392 spin_unlock_bh(&b_ptr
->publ
.lock
);
394 tipc_bcbearer_push();
399 * Interrupt enabling new requests after bearer congestion or blocking:
402 void tipc_continue(struct tipc_bearer
*tb_ptr
)
404 struct bearer
*b_ptr
= (struct bearer
*)tb_ptr
;
406 spin_lock_bh(&b_ptr
->publ
.lock
);
407 b_ptr
->continue_count
++;
408 if (!list_empty(&b_ptr
->cong_links
))
409 tipc_k_signal((Handler
)tipc_bearer_lock_push
, (unsigned long)b_ptr
);
410 b_ptr
->publ
.blocked
= 0;
411 spin_unlock_bh(&b_ptr
->publ
.lock
);
415 * Schedule link for sending of messages after the bearer
416 * has been deblocked by 'continue()'. This method is called
417 * when somebody tries to send a message via this link while
418 * the bearer is congested. 'tipc_net_lock' is in read_lock here
419 * bearer.lock is busy
422 static void tipc_bearer_schedule_unlocked(struct bearer
*b_ptr
, struct link
*l_ptr
)
424 list_move_tail(&l_ptr
->link_list
, &b_ptr
->cong_links
);
428 * Schedule link for sending of messages after the bearer
429 * has been deblocked by 'continue()'. This method is called
430 * when somebody tries to send a message via this link while
431 * the bearer is congested. 'tipc_net_lock' is in read_lock here,
432 * bearer.lock is free
435 void tipc_bearer_schedule(struct bearer
*b_ptr
, struct link
*l_ptr
)
437 spin_lock_bh(&b_ptr
->publ
.lock
);
438 tipc_bearer_schedule_unlocked(b_ptr
, l_ptr
);
439 spin_unlock_bh(&b_ptr
->publ
.lock
);
444 * tipc_bearer_resolve_congestion(): Check if there is bearer congestion,
445 * and if there is, try to resolve it before returning.
446 * 'tipc_net_lock' is read_locked when this function is called
448 int tipc_bearer_resolve_congestion(struct bearer
*b_ptr
, struct link
*l_ptr
)
452 if (list_empty(&b_ptr
->cong_links
))
454 spin_lock_bh(&b_ptr
->publ
.lock
);
455 if (!bearer_push(b_ptr
)) {
456 tipc_bearer_schedule_unlocked(b_ptr
, l_ptr
);
459 spin_unlock_bh(&b_ptr
->publ
.lock
);
464 * tipc_bearer_congested - determines if bearer is currently congested
467 int tipc_bearer_congested(struct bearer
*b_ptr
, struct link
*l_ptr
)
469 if (unlikely(b_ptr
->publ
.blocked
))
471 if (likely(list_empty(&b_ptr
->cong_links
)))
473 return !tipc_bearer_resolve_congestion(b_ptr
, l_ptr
);
477 * tipc_enable_bearer - enable bearer with the given name
480 int tipc_enable_bearer(const char *name
, u32 bcast_scope
, u32 priority
)
482 struct bearer
*b_ptr
;
484 struct bearer_name b_name
;
485 char addr_string
[16];
491 if (tipc_mode
!= TIPC_NET_MODE
) {
492 warn("Bearer <%s> rejected, not supported in standalone mode\n",
496 if (!bearer_name_validate(name
, &b_name
)) {
497 warn("Bearer <%s> rejected, illegal name\n", name
);
500 if (!tipc_addr_domain_valid(bcast_scope
) ||
501 !tipc_in_scope(bcast_scope
, tipc_own_addr
)) {
502 warn("Bearer <%s> rejected, illegal broadcast scope\n", name
);
505 if ((priority
< TIPC_MIN_LINK_PRI
||
506 priority
> TIPC_MAX_LINK_PRI
) &&
507 (priority
!= TIPC_MEDIA_LINK_PRI
)) {
508 warn("Bearer <%s> rejected, illegal priority\n", name
);
512 write_lock_bh(&tipc_net_lock
);
514 m_ptr
= media_find(b_name
.media_name
);
516 warn("Bearer <%s> rejected, media <%s> not registered\n", name
,
521 if (priority
== TIPC_MEDIA_LINK_PRI
)
522 priority
= m_ptr
->priority
;
525 bearer_id
= MAX_BEARERS
;
527 for (i
= MAX_BEARERS
; i
-- != 0; ) {
528 if (!tipc_bearers
[i
].active
) {
532 if (!strcmp(name
, tipc_bearers
[i
].publ
.name
)) {
533 warn("Bearer <%s> rejected, already enabled\n", name
);
536 if ((tipc_bearers
[i
].priority
== priority
) &&
537 (++with_this_prio
> 2)) {
538 if (priority
-- == 0) {
539 warn("Bearer <%s> rejected, duplicate priority\n",
543 warn("Bearer <%s> priority adjustment required %u->%u\n",
544 name
, priority
+ 1, priority
);
548 if (bearer_id
>= MAX_BEARERS
) {
549 warn("Bearer <%s> rejected, bearer limit reached (%u)\n",
554 b_ptr
= &tipc_bearers
[bearer_id
];
555 strcpy(b_ptr
->publ
.name
, name
);
556 res
= m_ptr
->enable_bearer(&b_ptr
->publ
);
558 warn("Bearer <%s> rejected, enable failure (%d)\n", name
, -res
);
562 b_ptr
->identity
= bearer_id
;
563 b_ptr
->media
= m_ptr
;
564 b_ptr
->net_plane
= bearer_id
+ 'A';
566 b_ptr
->detect_scope
= bcast_scope
;
567 b_ptr
->priority
= priority
;
568 INIT_LIST_HEAD(&b_ptr
->cong_links
);
569 INIT_LIST_HEAD(&b_ptr
->links
);
571 b_ptr
->link_req
= tipc_disc_init_link_req(b_ptr
, &m_ptr
->bcast_addr
,
574 spin_lock_init(&b_ptr
->publ
.lock
);
575 write_unlock_bh(&tipc_net_lock
);
576 info("Enabled bearer <%s>, discovery domain %s, priority %u\n",
577 name
, tipc_addr_string_fill(addr_string
, bcast_scope
), priority
);
580 write_unlock_bh(&tipc_net_lock
);
585 * tipc_block_bearer(): Block the bearer with the given name,
586 * and reset all its links
589 int tipc_block_bearer(const char *name
)
591 struct bearer
*b_ptr
= NULL
;
593 struct link
*temp_l_ptr
;
595 read_lock_bh(&tipc_net_lock
);
596 b_ptr
= bearer_find(name
);
598 warn("Attempt to block unknown bearer <%s>\n", name
);
599 read_unlock_bh(&tipc_net_lock
);
603 info("Blocking bearer <%s>\n", name
);
604 spin_lock_bh(&b_ptr
->publ
.lock
);
605 b_ptr
->publ
.blocked
= 1;
606 list_for_each_entry_safe(l_ptr
, temp_l_ptr
, &b_ptr
->links
, link_list
) {
607 struct tipc_node
*n_ptr
= l_ptr
->owner
;
609 spin_lock_bh(&n_ptr
->lock
);
610 tipc_link_reset(l_ptr
);
611 spin_unlock_bh(&n_ptr
->lock
);
613 spin_unlock_bh(&b_ptr
->publ
.lock
);
614 read_unlock_bh(&tipc_net_lock
);
621 * Note: This routine assumes caller holds tipc_net_lock.
624 static void bearer_disable(struct bearer
*b_ptr
)
627 struct link
*temp_l_ptr
;
629 info("Disabling bearer <%s>\n", b_ptr
->publ
.name
);
630 tipc_disc_stop_link_req(b_ptr
->link_req
);
631 spin_lock_bh(&b_ptr
->publ
.lock
);
632 b_ptr
->link_req
= NULL
;
633 b_ptr
->publ
.blocked
= 1;
634 b_ptr
->media
->disable_bearer(&b_ptr
->publ
);
635 list_for_each_entry_safe(l_ptr
, temp_l_ptr
, &b_ptr
->links
, link_list
) {
636 tipc_link_delete(l_ptr
);
638 spin_unlock_bh(&b_ptr
->publ
.lock
);
639 memset(b_ptr
, 0, sizeof(struct bearer
));
642 int tipc_disable_bearer(const char *name
)
644 struct bearer
*b_ptr
;
647 write_lock_bh(&tipc_net_lock
);
648 b_ptr
= bearer_find(name
);
650 warn("Attempt to disable unknown bearer <%s>\n", name
);
653 bearer_disable(b_ptr
);
656 write_unlock_bh(&tipc_net_lock
);
662 void tipc_bearer_stop(void)
666 for (i
= 0; i
< MAX_BEARERS
; i
++) {
667 if (tipc_bearers
[i
].active
)
668 bearer_disable(&tipc_bearers
[i
]);
This page took 0.053757 seconds and 5 git commands to generate.