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
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 60
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
);
52 * tipc_media_find - locates specified media object by name
54 struct tipc_media
*tipc_media_find(const char *name
)
58 for (i
= 0; i
< media_count
; i
++) {
59 if (!strcmp(media_list
[i
]->name
, name
))
66 * media_find_id - locates specified media object by type identifier
68 static struct tipc_media
*media_find_id(u8 type
)
72 for (i
= 0; i
< media_count
; i
++) {
73 if (media_list
[i
]->type_id
== type
)
80 * tipc_register_media - register a media type
82 * Bearers for this media type must be activated separately at a later stage.
84 int tipc_register_media(struct tipc_media
*m_ptr
)
88 write_lock_bh(&tipc_net_lock
);
90 if ((strlen(m_ptr
->name
) + 1) > TIPC_MAX_MEDIA_NAME
)
92 if (m_ptr
->priority
> TIPC_MAX_LINK_PRI
)
94 if ((m_ptr
->tolerance
< TIPC_MIN_LINK_TOL
) ||
95 (m_ptr
->tolerance
> TIPC_MAX_LINK_TOL
))
97 if (media_count
>= MAX_MEDIA
)
99 if (tipc_media_find(m_ptr
->name
) || media_find_id(m_ptr
->type_id
))
102 media_list
[media_count
] = m_ptr
;
106 write_unlock_bh(&tipc_net_lock
);
108 pr_warn("Media <%s> registration error\n", m_ptr
->name
);
113 * tipc_media_addr_printf - record media address in print buffer
115 void tipc_media_addr_printf(char *buf
, int len
, struct tipc_media_addr
*a
)
117 char addr_str
[MAX_ADDR_STR
];
118 struct tipc_media
*m_ptr
;
121 m_ptr
= media_find_id(a
->media_id
);
123 if (m_ptr
&& !m_ptr
->addr2str(a
, addr_str
, sizeof(addr_str
)))
124 ret
= tipc_snprintf(buf
, len
, "%s(%s)", m_ptr
->name
, addr_str
);
128 ret
= tipc_snprintf(buf
, len
, "UNKNOWN(%u)", a
->media_id
);
129 for (i
= 0; i
< sizeof(a
->value
); i
++)
130 ret
+= tipc_snprintf(buf
- ret
, len
+ ret
,
131 "-%02x", a
->value
[i
]);
136 * tipc_media_get_names - record names of registered media in buffer
138 struct sk_buff
*tipc_media_get_names(void)
143 buf
= tipc_cfg_reply_alloc(MAX_MEDIA
* TLV_SPACE(TIPC_MAX_MEDIA_NAME
));
147 read_lock_bh(&tipc_net_lock
);
148 for (i
= 0; i
< media_count
; i
++) {
149 tipc_cfg_append_tlv(buf
, TIPC_TLV_MEDIA_NAME
,
151 strlen(media_list
[i
]->name
) + 1);
153 read_unlock_bh(&tipc_net_lock
);
158 * bearer_name_validate - validate & (optionally) deconstruct bearer name
159 * @name: ptr to bearer name string
160 * @name_parts: ptr to area for bearer name components (or NULL if not needed)
162 * Returns 1 if bearer name is valid, otherwise 0.
164 static int bearer_name_validate(const char *name
,
165 struct tipc_bearer_names
*name_parts
)
167 char name_copy
[TIPC_MAX_BEARER_NAME
];
173 /* copy bearer name & ensure length is OK */
174 name_copy
[TIPC_MAX_BEARER_NAME
- 1] = 0;
175 /* need above in case non-Posix strncpy() doesn't pad with nulls */
176 strncpy(name_copy
, name
, TIPC_MAX_BEARER_NAME
);
177 if (name_copy
[TIPC_MAX_BEARER_NAME
- 1] != 0)
180 /* ensure all component parts of bearer name are present */
181 media_name
= name_copy
;
182 if_name
= strchr(media_name
, ':');
186 media_len
= if_name
- media_name
;
187 if_len
= strlen(if_name
) + 1;
189 /* validate component parts of bearer name */
190 if ((media_len
<= 1) || (media_len
> TIPC_MAX_MEDIA_NAME
) ||
191 (if_len
<= 1) || (if_len
> TIPC_MAX_IF_NAME
))
194 /* return bearer name components, if necessary */
196 strcpy(name_parts
->media_name
, media_name
);
197 strcpy(name_parts
->if_name
, if_name
);
203 * tipc_bearer_find - locates bearer object with matching bearer name
205 struct tipc_bearer
*tipc_bearer_find(const char *name
)
207 struct tipc_bearer
*b_ptr
;
210 for (i
= 0, b_ptr
= tipc_bearers
; i
< MAX_BEARERS
; i
++, b_ptr
++) {
211 if (b_ptr
->active
&& (!strcmp(b_ptr
->name
, name
)))
218 * tipc_bearer_find_interface - locates bearer object with matching interface name
220 struct tipc_bearer
*tipc_bearer_find_interface(const char *if_name
)
222 struct tipc_bearer
*b_ptr
;
226 for (i
= 0, b_ptr
= tipc_bearers
; i
< MAX_BEARERS
; i
++, b_ptr
++) {
229 b_if_name
= strchr(b_ptr
->name
, ':') + 1;
230 if (!strcmp(b_if_name
, if_name
))
237 * tipc_bearer_get_names - record names of bearers in buffer
239 struct sk_buff
*tipc_bearer_get_names(void)
242 struct tipc_bearer
*b_ptr
;
245 buf
= tipc_cfg_reply_alloc(MAX_BEARERS
* TLV_SPACE(TIPC_MAX_BEARER_NAME
));
249 read_lock_bh(&tipc_net_lock
);
250 for (i
= 0; i
< media_count
; i
++) {
251 for (j
= 0; j
< MAX_BEARERS
; j
++) {
252 b_ptr
= &tipc_bearers
[j
];
253 if (b_ptr
->active
&& (b_ptr
->media
== media_list
[i
])) {
254 tipc_cfg_append_tlv(buf
, TIPC_TLV_BEARER_NAME
,
256 strlen(b_ptr
->name
) + 1);
260 read_unlock_bh(&tipc_net_lock
);
264 void tipc_bearer_add_dest(struct tipc_bearer
*b_ptr
, u32 dest
)
266 tipc_nmap_add(&b_ptr
->nodes
, dest
);
267 tipc_bcbearer_sort();
268 tipc_disc_add_dest(b_ptr
->link_req
);
271 void tipc_bearer_remove_dest(struct tipc_bearer
*b_ptr
, u32 dest
)
273 tipc_nmap_remove(&b_ptr
->nodes
, dest
);
274 tipc_bcbearer_sort();
275 tipc_disc_remove_dest(b_ptr
->link_req
);
279 * Interrupt enabling new requests after bearer blocking:
282 void tipc_continue(struct tipc_bearer
*b
)
284 spin_lock_bh(&b
->lock
);
286 spin_unlock_bh(&b
->lock
);
290 * tipc_bearer_blocked - determines if bearer is currently blocked
292 int tipc_bearer_blocked(struct tipc_bearer
*b
)
296 spin_lock_bh(&b
->lock
);
298 spin_unlock_bh(&b
->lock
);
304 * tipc_enable_bearer - enable bearer with the given name
306 int tipc_enable_bearer(const char *name
, u32 disc_domain
, u32 priority
)
308 struct tipc_bearer
*b_ptr
;
309 struct tipc_media
*m_ptr
;
310 struct tipc_bearer_names b_names
;
311 char addr_string
[16];
317 if (!tipc_own_addr
) {
318 pr_warn("Bearer <%s> rejected, not supported in standalone mode\n",
322 if (!bearer_name_validate(name
, &b_names
)) {
323 pr_warn("Bearer <%s> rejected, illegal name\n", name
);
326 if (tipc_addr_domain_valid(disc_domain
) &&
327 (disc_domain
!= tipc_own_addr
)) {
328 if (tipc_in_scope(disc_domain
, tipc_own_addr
)) {
329 disc_domain
= tipc_own_addr
& TIPC_CLUSTER_MASK
;
330 res
= 0; /* accept any node in own cluster */
331 } else if (in_own_cluster_exact(disc_domain
))
332 res
= 0; /* accept specified node in own cluster */
335 pr_warn("Bearer <%s> rejected, illegal discovery domain\n",
339 if ((priority
> TIPC_MAX_LINK_PRI
) &&
340 (priority
!= TIPC_MEDIA_LINK_PRI
)) {
341 pr_warn("Bearer <%s> rejected, illegal priority\n", name
);
345 write_lock_bh(&tipc_net_lock
);
347 m_ptr
= tipc_media_find(b_names
.media_name
);
349 pr_warn("Bearer <%s> rejected, media <%s> not registered\n",
350 name
, b_names
.media_name
);
354 if (priority
== TIPC_MEDIA_LINK_PRI
)
355 priority
= m_ptr
->priority
;
358 bearer_id
= MAX_BEARERS
;
360 for (i
= MAX_BEARERS
; i
-- != 0; ) {
361 if (!tipc_bearers
[i
].active
) {
365 if (!strcmp(name
, tipc_bearers
[i
].name
)) {
366 pr_warn("Bearer <%s> rejected, already enabled\n",
370 if ((tipc_bearers
[i
].priority
== priority
) &&
371 (++with_this_prio
> 2)) {
372 if (priority
-- == 0) {
373 pr_warn("Bearer <%s> rejected, duplicate priority\n",
377 pr_warn("Bearer <%s> priority adjustment required %u->%u\n",
378 name
, priority
+ 1, priority
);
382 if (bearer_id
>= MAX_BEARERS
) {
383 pr_warn("Bearer <%s> rejected, bearer limit reached (%u)\n",
388 b_ptr
= &tipc_bearers
[bearer_id
];
389 strcpy(b_ptr
->name
, name
);
390 res
= m_ptr
->enable_media(b_ptr
);
392 pr_warn("Bearer <%s> rejected, enable failure (%d)\n",
397 b_ptr
->identity
= bearer_id
;
398 b_ptr
->media
= m_ptr
;
399 b_ptr
->tolerance
= m_ptr
->tolerance
;
400 b_ptr
->window
= m_ptr
->window
;
401 b_ptr
->net_plane
= bearer_id
+ 'A';
403 b_ptr
->priority
= priority
;
404 INIT_LIST_HEAD(&b_ptr
->links
);
405 spin_lock_init(&b_ptr
->lock
);
407 res
= tipc_disc_create(b_ptr
, &b_ptr
->bcast_addr
, disc_domain
);
409 bearer_disable(b_ptr
);
410 pr_warn("Bearer <%s> rejected, discovery object creation failed\n",
414 pr_info("Enabled bearer <%s>, discovery domain %s, priority %u\n",
416 tipc_addr_string_fill(addr_string
, disc_domain
), priority
);
418 write_unlock_bh(&tipc_net_lock
);
423 * tipc_block_bearer - Block the bearer, and reset all its links
425 int tipc_block_bearer(struct tipc_bearer
*b_ptr
)
427 struct tipc_link
*l_ptr
;
428 struct tipc_link
*temp_l_ptr
;
430 read_lock_bh(&tipc_net_lock
);
431 pr_info("Blocking bearer <%s>\n", b_ptr
->name
);
432 spin_lock_bh(&b_ptr
->lock
);
434 list_for_each_entry_safe(l_ptr
, temp_l_ptr
, &b_ptr
->links
, link_list
) {
435 struct tipc_node
*n_ptr
= l_ptr
->owner
;
437 spin_lock_bh(&n_ptr
->lock
);
438 tipc_link_reset(l_ptr
);
439 spin_unlock_bh(&n_ptr
->lock
);
441 spin_unlock_bh(&b_ptr
->lock
);
442 read_unlock_bh(&tipc_net_lock
);
449 * Note: This routine assumes caller holds tipc_net_lock.
451 static void bearer_disable(struct tipc_bearer
*b_ptr
)
453 struct tipc_link
*l_ptr
;
454 struct tipc_link
*temp_l_ptr
;
455 struct tipc_link_req
*temp_req
;
457 pr_info("Disabling bearer <%s>\n", b_ptr
->name
);
458 spin_lock_bh(&b_ptr
->lock
);
460 b_ptr
->media
->disable_media(b_ptr
);
461 list_for_each_entry_safe(l_ptr
, temp_l_ptr
, &b_ptr
->links
, link_list
) {
462 tipc_link_delete(l_ptr
);
464 temp_req
= b_ptr
->link_req
;
465 b_ptr
->link_req
= NULL
;
466 spin_unlock_bh(&b_ptr
->lock
);
469 tipc_disc_delete(temp_req
);
471 memset(b_ptr
, 0, sizeof(struct tipc_bearer
));
474 int tipc_disable_bearer(const char *name
)
476 struct tipc_bearer
*b_ptr
;
479 write_lock_bh(&tipc_net_lock
);
480 b_ptr
= tipc_bearer_find(name
);
482 pr_warn("Attempt to disable unknown bearer <%s>\n", name
);
485 bearer_disable(b_ptr
);
488 write_unlock_bh(&tipc_net_lock
);
494 void tipc_bearer_stop(void)
498 for (i
= 0; i
< MAX_BEARERS
; i
++) {
499 if (tipc_bearers
[i
].active
)
500 bearer_disable(&tipc_bearers
[i
]);