2 * net/tipc/bearer.c: TIPC bearer code
4 * Copyright (c) 1996-2006, 2013, 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 * const media_list[] = {
46 #ifdef CONFIG_TIPC_MEDIA_IB
52 struct tipc_bearer tipc_bearers[MAX_BEARERS];
54 static void bearer_disable(struct tipc_bearer *b_ptr);
57 * tipc_media_find - locates specified media object by name
59 struct tipc_media *tipc_media_find(const char *name)
63 for (i = 0; media_list[i] != NULL; i++) {
64 if (!strcmp(media_list[i]->name, name))
71 * media_find_id - locates specified media object by type identifier
73 static struct tipc_media *media_find_id(u8 type)
77 for (i = 0; media_list[i] != NULL; i++) {
78 if (media_list[i]->type_id == type)
85 * tipc_media_addr_printf - record media address in print buffer
87 void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a)
89 char addr_str[MAX_ADDR_STR];
90 struct tipc_media *m_ptr;
93 m_ptr = media_find_id(a->media_id);
95 if (m_ptr && !m_ptr->addr2str(a, addr_str, sizeof(addr_str)))
96 ret = tipc_snprintf(buf, len, "%s(%s)", m_ptr->name, addr_str);
100 ret = tipc_snprintf(buf, len, "UNKNOWN(%u)", a->media_id);
101 for (i = 0; i < sizeof(a->value); i++)
102 ret += tipc_snprintf(buf - ret, len + ret,
103 "-%02x", a->value[i]);
108 * tipc_media_get_names - record names of registered media in buffer
110 struct sk_buff *tipc_media_get_names(void)
115 buf = tipc_cfg_reply_alloc(MAX_MEDIA * TLV_SPACE(TIPC_MAX_MEDIA_NAME));
119 for (i = 0; media_list[i] != NULL; i++) {
120 tipc_cfg_append_tlv(buf, TIPC_TLV_MEDIA_NAME,
122 strlen(media_list[i]->name) + 1);
128 * bearer_name_validate - validate & (optionally) deconstruct bearer name
129 * @name: ptr to bearer name string
130 * @name_parts: ptr to area for bearer name components (or NULL if not needed)
132 * Returns 1 if bearer name is valid, otherwise 0.
134 static int bearer_name_validate(const char *name,
135 struct tipc_bearer_names *name_parts)
137 char name_copy[TIPC_MAX_BEARER_NAME];
143 /* copy bearer name & ensure length is OK */
144 name_copy[TIPC_MAX_BEARER_NAME - 1] = 0;
145 /* need above in case non-Posix strncpy() doesn't pad with nulls */
146 strncpy(name_copy, name, TIPC_MAX_BEARER_NAME);
147 if (name_copy[TIPC_MAX_BEARER_NAME - 1] != 0)
150 /* ensure all component parts of bearer name are present */
151 media_name = name_copy;
152 if_name = strchr(media_name, ':');
156 media_len = if_name - media_name;
157 if_len = strlen(if_name) + 1;
159 /* validate component parts of bearer name */
160 if ((media_len <= 1) || (media_len > TIPC_MAX_MEDIA_NAME) ||
161 (if_len <= 1) || (if_len > TIPC_MAX_IF_NAME))
164 /* return bearer name components, if necessary */
166 strcpy(name_parts->media_name, media_name);
167 strcpy(name_parts->if_name, if_name);
173 * tipc_bearer_find - locates bearer object with matching bearer name
175 struct tipc_bearer *tipc_bearer_find(const char *name)
177 struct tipc_bearer *b_ptr;
180 for (i = 0, b_ptr = tipc_bearers; i < MAX_BEARERS; i++, b_ptr++) {
181 if (b_ptr->active && (!strcmp(b_ptr->name, name)))
188 * tipc_bearer_find_interface - locates bearer object with matching interface name
190 struct tipc_bearer *tipc_bearer_find_interface(const char *if_name)
192 struct tipc_bearer *b_ptr;
196 for (i = 0, b_ptr = tipc_bearers; i < MAX_BEARERS; i++, b_ptr++) {
199 b_if_name = strchr(b_ptr->name, ':') + 1;
200 if (!strcmp(b_if_name, if_name))
207 * tipc_bearer_get_names - record names of bearers in buffer
209 struct sk_buff *tipc_bearer_get_names(void)
212 struct tipc_bearer *b_ptr;
215 buf = tipc_cfg_reply_alloc(MAX_BEARERS * TLV_SPACE(TIPC_MAX_BEARER_NAME));
219 read_lock_bh(&tipc_net_lock);
220 for (i = 0; media_list[i] != NULL; i++) {
221 for (j = 0; j < MAX_BEARERS; j++) {
222 b_ptr = &tipc_bearers[j];
223 if (b_ptr->active && (b_ptr->media == media_list[i])) {
224 tipc_cfg_append_tlv(buf, TIPC_TLV_BEARER_NAME,
226 strlen(b_ptr->name) + 1);
230 read_unlock_bh(&tipc_net_lock);
234 void tipc_bearer_add_dest(struct tipc_bearer *b_ptr, u32 dest)
236 tipc_nmap_add(&b_ptr->nodes, dest);
237 tipc_bcbearer_sort();
238 tipc_disc_add_dest(b_ptr->link_req);
241 void tipc_bearer_remove_dest(struct tipc_bearer *b_ptr, u32 dest)
243 tipc_nmap_remove(&b_ptr->nodes, dest);
244 tipc_bcbearer_sort();
245 tipc_disc_remove_dest(b_ptr->link_req);
249 * tipc_enable_bearer - enable bearer with the given name
251 int tipc_enable_bearer(const char *name, u32 disc_domain, u32 priority)
253 struct tipc_bearer *b_ptr;
254 struct tipc_media *m_ptr;
255 struct tipc_bearer_names b_names;
256 char addr_string[16];
262 if (!tipc_own_addr) {
263 pr_warn("Bearer <%s> rejected, not supported in standalone mode\n",
267 if (!bearer_name_validate(name, &b_names)) {
268 pr_warn("Bearer <%s> rejected, illegal name\n", name);
271 if (tipc_addr_domain_valid(disc_domain) &&
272 (disc_domain != tipc_own_addr)) {
273 if (tipc_in_scope(disc_domain, tipc_own_addr)) {
274 disc_domain = tipc_own_addr & TIPC_CLUSTER_MASK;
275 res = 0; /* accept any node in own cluster */
276 } else if (in_own_cluster_exact(disc_domain))
277 res = 0; /* accept specified node in own cluster */
280 pr_warn("Bearer <%s> rejected, illegal discovery domain\n",
284 if ((priority > TIPC_MAX_LINK_PRI) &&
285 (priority != TIPC_MEDIA_LINK_PRI)) {
286 pr_warn("Bearer <%s> rejected, illegal priority\n", name);
290 write_lock_bh(&tipc_net_lock);
292 m_ptr = tipc_media_find(b_names.media_name);
294 pr_warn("Bearer <%s> rejected, media <%s> not registered\n",
295 name, b_names.media_name);
299 if (priority == TIPC_MEDIA_LINK_PRI)
300 priority = m_ptr->priority;
303 bearer_id = MAX_BEARERS;
305 for (i = MAX_BEARERS; i-- != 0; ) {
306 if (!tipc_bearers[i].active) {
310 if (!strcmp(name, tipc_bearers[i].name)) {
311 pr_warn("Bearer <%s> rejected, already enabled\n",
315 if ((tipc_bearers[i].priority == priority) &&
316 (++with_this_prio > 2)) {
317 if (priority-- == 0) {
318 pr_warn("Bearer <%s> rejected, duplicate priority\n",
322 pr_warn("Bearer <%s> priority adjustment required %u->%u\n",
323 name, priority + 1, priority);
327 if (bearer_id >= MAX_BEARERS) {
328 pr_warn("Bearer <%s> rejected, bearer limit reached (%u)\n",
333 b_ptr = &tipc_bearers[bearer_id];
334 strcpy(b_ptr->name, name);
335 res = m_ptr->enable_media(b_ptr);
337 pr_warn("Bearer <%s> rejected, enable failure (%d)\n",
342 b_ptr->identity = bearer_id;
343 b_ptr->media = m_ptr;
344 b_ptr->tolerance = m_ptr->tolerance;
345 b_ptr->window = m_ptr->window;
346 b_ptr->net_plane = bearer_id + 'A';
348 b_ptr->priority = priority;
349 INIT_LIST_HEAD(&b_ptr->links);
350 spin_lock_init(&b_ptr->lock);
352 res = tipc_disc_create(b_ptr, &b_ptr->bcast_addr, disc_domain);
354 bearer_disable(b_ptr);
355 pr_warn("Bearer <%s> rejected, discovery object creation failed\n",
359 pr_info("Enabled bearer <%s>, discovery domain %s, priority %u\n",
361 tipc_addr_string_fill(addr_string, disc_domain), priority);
363 write_unlock_bh(&tipc_net_lock);
368 * tipc_reset_bearer - Reset all links established over this bearer
370 int tipc_reset_bearer(struct tipc_bearer *b_ptr)
372 struct tipc_link *l_ptr;
373 struct tipc_link *temp_l_ptr;
375 read_lock_bh(&tipc_net_lock);
376 pr_info("Resetting bearer <%s>\n", b_ptr->name);
377 spin_lock_bh(&b_ptr->lock);
378 list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
379 struct tipc_node *n_ptr = l_ptr->owner;
381 spin_lock_bh(&n_ptr->lock);
382 tipc_link_reset(l_ptr);
383 spin_unlock_bh(&n_ptr->lock);
385 spin_unlock_bh(&b_ptr->lock);
386 read_unlock_bh(&tipc_net_lock);
393 * Note: This routine assumes caller holds tipc_net_lock.
395 static void bearer_disable(struct tipc_bearer *b_ptr)
397 struct tipc_link *l_ptr;
398 struct tipc_link *temp_l_ptr;
399 struct tipc_link_req *temp_req;
401 pr_info("Disabling bearer <%s>\n", b_ptr->name);
402 spin_lock_bh(&b_ptr->lock);
403 b_ptr->media->disable_media(b_ptr);
404 list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
405 tipc_link_delete(l_ptr);
407 temp_req = b_ptr->link_req;
408 b_ptr->link_req = NULL;
409 spin_unlock_bh(&b_ptr->lock);
412 tipc_disc_delete(temp_req);
414 memset(b_ptr, 0, sizeof(struct tipc_bearer));
417 int tipc_disable_bearer(const char *name)
419 struct tipc_bearer *b_ptr;
422 write_lock_bh(&tipc_net_lock);
423 b_ptr = tipc_bearer_find(name);
425 pr_warn("Attempt to disable unknown bearer <%s>\n", name);
428 bearer_disable(b_ptr);
431 write_unlock_bh(&tipc_net_lock);
437 void tipc_bearer_stop(void)
441 for (i = 0; i < MAX_BEARERS; i++) {
442 if (tipc_bearers[i].active)
443 bearer_disable(&tipc_bearers[i]);