2 * net/tipc/node.c: TIPC node management routines
4 * Copyright (c) 2000-2006, Ericsson AB
5 * Copyright (c) 2005-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.
43 #include "node_subscr.h"
47 #include "name_distr.h"
49 void node_print(struct print_buf *buf, struct node *n_ptr, char *str);
50 static void node_lost_contact(struct node *n_ptr);
51 static void node_established_contact(struct node *n_ptr);
53 struct node *tipc_nodes = NULL; /* sorted list of nodes within cluster */
57 struct node *tipc_node_create(u32 addr)
59 struct cluster *c_ptr;
61 struct node **curr_node;
63 n_ptr = kzalloc(sizeof(*n_ptr),GFP_ATOMIC);
65 warn("Node creation failed, no memory\n");
69 c_ptr = tipc_cltr_find(addr);
71 c_ptr = tipc_cltr_create(addr);
79 spin_lock_init(&n_ptr->lock);
80 INIT_LIST_HEAD(&n_ptr->nsub);
82 tipc_cltr_attach_node(c_ptr, n_ptr);
83 n_ptr->last_router = -1;
85 /* Insert node into ordered list */
86 for (curr_node = &tipc_nodes; *curr_node;
87 curr_node = &(*curr_node)->next) {
88 if (addr < (*curr_node)->addr) {
89 n_ptr->next = *curr_node;
97 void tipc_node_delete(struct node *n_ptr)
103 /* Not needed because links are already deleted via tipc_bearer_stop() */
107 for (l_num = 0; l_num < MAX_BEARERS; l_num++) {
108 link_delete(n_ptr->links[l_num]);
112 dbg("node %x deleted\n", n_ptr->addr);
118 * tipc_node_link_up - handle addition of link
120 * Link becomes active (alone or shared) or standby, depending on its priority.
123 void tipc_node_link_up(struct node *n_ptr, struct link *l_ptr)
125 struct link **active = &n_ptr->active_links[0];
127 n_ptr->working_links++;
129 info("Established link <%s> on network plane %c\n",
130 l_ptr->name, l_ptr->b_ptr->net_plane);
133 dbg(" link %x into %x/%x\n", l_ptr, &active[0], &active[1]);
134 active[0] = active[1] = l_ptr;
135 node_established_contact(n_ptr);
138 if (l_ptr->priority < active[0]->priority) {
139 info("New link <%s> becomes standby\n", l_ptr->name);
142 tipc_link_send_duplicate(active[0], l_ptr);
143 if (l_ptr->priority == active[0]->priority) {
147 info("Old link <%s> becomes standby\n", active[0]->name);
148 if (active[1] != active[0])
149 info("Old link <%s> becomes standby\n", active[1]->name);
150 active[0] = active[1] = l_ptr;
154 * node_select_active_links - select active link
157 static void node_select_active_links(struct node *n_ptr)
159 struct link **active = &n_ptr->active_links[0];
161 u32 highest_prio = 0;
163 active[0] = active[1] = NULL;
165 for (i = 0; i < MAX_BEARERS; i++) {
166 struct link *l_ptr = n_ptr->links[i];
168 if (!l_ptr || !tipc_link_is_up(l_ptr) ||
169 (l_ptr->priority < highest_prio))
172 if (l_ptr->priority > highest_prio) {
173 highest_prio = l_ptr->priority;
174 active[0] = active[1] = l_ptr;
182 * tipc_node_link_down - handle loss of link
185 void tipc_node_link_down(struct node *n_ptr, struct link *l_ptr)
187 struct link **active;
189 n_ptr->working_links--;
191 if (!tipc_link_is_active(l_ptr)) {
192 info("Lost standby link <%s> on network plane %c\n",
193 l_ptr->name, l_ptr->b_ptr->net_plane);
196 info("Lost link <%s> on network plane %c\n",
197 l_ptr->name, l_ptr->b_ptr->net_plane);
199 active = &n_ptr->active_links[0];
200 if (active[0] == l_ptr)
201 active[0] = active[1];
202 if (active[1] == l_ptr)
203 active[1] = active[0];
204 if (active[0] == l_ptr)
205 node_select_active_links(n_ptr);
206 if (tipc_node_is_up(n_ptr))
207 tipc_link_changeover(l_ptr);
209 node_lost_contact(n_ptr);
212 int tipc_node_has_active_links(struct node *n_ptr)
215 ((n_ptr->active_links[0]) || (n_ptr->active_links[1])));
218 int tipc_node_has_redundant_links(struct node *n_ptr)
220 return (n_ptr->working_links > 1);
223 static int tipc_node_has_active_routes(struct node *n_ptr)
225 return (n_ptr && (n_ptr->last_router >= 0));
228 int tipc_node_is_up(struct node *n_ptr)
230 return (tipc_node_has_active_links(n_ptr) || tipc_node_has_active_routes(n_ptr));
233 struct node *tipc_node_attach_link(struct link *l_ptr)
235 struct node *n_ptr = tipc_node_find(l_ptr->addr);
238 n_ptr = tipc_node_create(l_ptr->addr);
240 u32 bearer_id = l_ptr->b_ptr->identity;
241 char addr_string[16];
243 if (n_ptr->link_cnt >= 2) {
244 char addr_string[16];
246 err("Attempt to create third link to %s\n",
247 addr_string_fill(addr_string, n_ptr->addr));
251 if (!n_ptr->links[bearer_id]) {
252 n_ptr->links[bearer_id] = l_ptr;
253 tipc_net.zones[tipc_zone(l_ptr->addr)]->links++;
257 err("Attempt to establish second link on <%s> to %s \n",
258 l_ptr->b_ptr->publ.name,
259 addr_string_fill(addr_string, l_ptr->addr));
264 void tipc_node_detach_link(struct node *n_ptr, struct link *l_ptr)
266 n_ptr->links[l_ptr->b_ptr->identity] = NULL;
267 tipc_net.zones[tipc_zone(l_ptr->addr)]->links--;
272 * Routing table management - five cases to handle:
274 * 1: A link towards a zone/cluster external node comes up.
275 * => Send a multicast message updating routing tables of all
276 * system nodes within own cluster that the new destination
277 * can be reached via this node.
278 * (node.establishedContact()=>cluster.multicastNewRoute())
280 * 2: A link towards a slave node comes up.
281 * => Send a multicast message updating routing tables of all
282 * system nodes within own cluster that the new destination
283 * can be reached via this node.
284 * (node.establishedContact()=>cluster.multicastNewRoute())
285 * => Send a message to the slave node about existence
286 * of all system nodes within cluster:
287 * (node.establishedContact()=>cluster.sendLocalRoutes())
289 * 3: A new cluster local system node becomes available.
290 * => Send message(s) to this particular node containing
291 * information about all cluster external and slave
292 * nodes which can be reached via this node.
293 * (node.establishedContact()==>network.sendExternalRoutes())
294 * (node.establishedContact()==>network.sendSlaveRoutes())
295 * => Send messages to all directly connected slave nodes
296 * containing information about the existence of the new node
297 * (node.establishedContact()=>cluster.multicastNewRoute())
299 * 4: The link towards a zone/cluster external node or slave
301 * => Send a multcast message updating routing tables of all
302 * nodes within cluster that the new destination can not any
303 * longer be reached via this node.
304 * (node.lostAllLinks()=>cluster.bcastLostRoute())
306 * 5: A cluster local system node becomes unavailable.
307 * => Remove all references to this node from the local
308 * routing tables. Note: This is a completely node
310 * (node.lostAllLinks()=>network.removeAsRouter())
311 * => Send messages to all directly connected slave nodes
312 * containing information about loss of the node
313 * (node.establishedContact()=>cluster.multicastLostRoute())
317 static void node_established_contact(struct node *n_ptr)
319 struct cluster *c_ptr;
321 dbg("node_established_contact:-> %x\n", n_ptr->addr);
322 if (!tipc_node_has_active_routes(n_ptr) && in_own_cluster(n_ptr->addr)) {
323 tipc_k_signal((Handler)tipc_named_node_up, n_ptr->addr);
326 /* Syncronize broadcast acks */
327 n_ptr->bclink.acked = tipc_bclink_get_last_sent();
329 if (is_slave(tipc_own_addr))
331 if (!in_own_cluster(n_ptr->addr)) {
332 /* Usage case 1 (see above) */
333 c_ptr = tipc_cltr_find(tipc_own_addr);
335 c_ptr = tipc_cltr_create(tipc_own_addr);
337 tipc_cltr_bcast_new_route(c_ptr, n_ptr->addr, 1,
342 c_ptr = n_ptr->owner;
343 if (is_slave(n_ptr->addr)) {
344 /* Usage case 2 (see above) */
345 tipc_cltr_bcast_new_route(c_ptr, n_ptr->addr, 1, tipc_max_nodes);
346 tipc_cltr_send_local_routes(c_ptr, n_ptr->addr);
350 if (n_ptr->bclink.supported) {
351 tipc_nmap_add(&tipc_cltr_bcast_nodes, n_ptr->addr);
352 if (n_ptr->addr < tipc_own_addr)
356 /* Case 3 (see above) */
357 tipc_net_send_external_routes(n_ptr->addr);
358 tipc_cltr_send_slave_routes(c_ptr, n_ptr->addr);
359 tipc_cltr_bcast_new_route(c_ptr, n_ptr->addr, LOWEST_SLAVE,
360 tipc_highest_allowed_slave);
363 static void node_lost_contact(struct node *n_ptr)
365 struct cluster *c_ptr;
366 struct node_subscr *ns, *tns;
367 char addr_string[16];
370 /* Clean up broadcast reception remains */
371 n_ptr->bclink.gap_after = n_ptr->bclink.gap_to = 0;
372 while (n_ptr->bclink.deferred_head) {
373 struct sk_buff* buf = n_ptr->bclink.deferred_head;
374 n_ptr->bclink.deferred_head = buf->next;
377 if (n_ptr->bclink.defragm) {
378 buf_discard(n_ptr->bclink.defragm);
379 n_ptr->bclink.defragm = NULL;
381 if (in_own_cluster(n_ptr->addr) && n_ptr->bclink.supported) {
382 tipc_bclink_acknowledge(n_ptr, mod(n_ptr->bclink.acked + 10000));
385 /* Update routing tables */
386 if (is_slave(tipc_own_addr)) {
387 tipc_net_remove_as_router(n_ptr->addr);
389 if (!in_own_cluster(n_ptr->addr)) {
390 /* Case 4 (see above) */
391 c_ptr = tipc_cltr_find(tipc_own_addr);
392 tipc_cltr_bcast_lost_route(c_ptr, n_ptr->addr, 1,
395 /* Case 5 (see above) */
396 c_ptr = tipc_cltr_find(n_ptr->addr);
397 if (is_slave(n_ptr->addr)) {
398 tipc_cltr_bcast_lost_route(c_ptr, n_ptr->addr, 1,
401 if (n_ptr->bclink.supported) {
402 tipc_nmap_remove(&tipc_cltr_bcast_nodes,
404 if (n_ptr->addr < tipc_own_addr)
407 tipc_net_remove_as_router(n_ptr->addr);
408 tipc_cltr_bcast_lost_route(c_ptr, n_ptr->addr,
410 tipc_highest_allowed_slave);
414 if (tipc_node_has_active_routes(n_ptr))
417 info("Lost contact with %s\n",
418 addr_string_fill(addr_string, n_ptr->addr));
420 /* Abort link changeover */
421 for (i = 0; i < MAX_BEARERS; i++) {
422 struct link *l_ptr = n_ptr->links[i];
425 l_ptr->reset_checkpoint = l_ptr->next_in_no;
426 l_ptr->exp_msg_count = 0;
427 tipc_link_reset_fragments(l_ptr);
430 /* Notify subscribers */
431 list_for_each_entry_safe(ns, tns, &n_ptr->nsub, nodesub_list) {
433 list_del_init(&ns->nodesub_list);
434 tipc_k_signal((Handler)ns->handle_node_down,
435 (unsigned long)ns->usr_handle);
440 * tipc_node_select_next_hop - find the next-hop node for a message
442 * Called by when cluster local lookup has failed.
445 struct node *tipc_node_select_next_hop(u32 addr, u32 selector)
450 if (!tipc_addr_domain_valid(addr))
453 /* Look for direct link to destination processsor */
454 n_ptr = tipc_node_find(addr);
455 if (n_ptr && tipc_node_has_active_links(n_ptr))
458 /* Cluster local system nodes *must* have direct links */
459 if (!is_slave(addr) && in_own_cluster(addr))
462 /* Look for cluster local router with direct link to node */
463 router_addr = tipc_node_select_router(n_ptr, selector);
465 return tipc_node_select(router_addr, selector);
467 /* Slave nodes can only be accessed within own cluster via a
468 known router with direct link -- if no router was found,give up */
472 /* Inter zone/cluster -- find any direct link to remote cluster */
473 addr = tipc_addr(tipc_zone(addr), tipc_cluster(addr), 0);
474 n_ptr = tipc_net_select_remote_node(addr, selector);
475 if (n_ptr && tipc_node_has_active_links(n_ptr))
478 /* Last resort -- look for any router to anywhere in remote zone */
479 router_addr = tipc_net_select_router(addr, selector);
481 return tipc_node_select(router_addr, selector);
487 * tipc_node_select_router - select router to reach specified node
489 * Uses a deterministic and fair algorithm for selecting router node.
492 u32 tipc_node_select_router(struct node *n_ptr, u32 ref)
502 if (n_ptr->last_router < 0)
504 ulim = ((n_ptr->last_router + 1) * 32) - 1;
506 /* Start entry must be random */
507 mask = tipc_max_nodes;
513 /* Lookup upwards with wrap-around */
515 if (((n_ptr->routers[r / 32]) >> (r % 32)) & 1)
517 } while (++r <= ulim);
521 if (((n_ptr->routers[r / 32]) >> (r % 32)) & 1)
523 } while (++r < start);
526 assert(r && (r <= ulim));
527 return tipc_addr(own_zone(), own_cluster(), r);
530 void tipc_node_add_router(struct node *n_ptr, u32 router)
532 u32 r_num = tipc_node(router);
534 n_ptr->routers[r_num / 32] =
535 ((1 << (r_num % 32)) | n_ptr->routers[r_num / 32]);
536 n_ptr->last_router = tipc_max_nodes / 32;
537 while ((--n_ptr->last_router >= 0) &&
538 !n_ptr->routers[n_ptr->last_router]);
541 void tipc_node_remove_router(struct node *n_ptr, u32 router)
543 u32 r_num = tipc_node(router);
545 if (n_ptr->last_router < 0)
546 return; /* No routes */
548 n_ptr->routers[r_num / 32] =
549 ((~(1 << (r_num % 32))) & (n_ptr->routers[r_num / 32]));
550 n_ptr->last_router = tipc_max_nodes / 32;
551 while ((--n_ptr->last_router >= 0) &&
552 !n_ptr->routers[n_ptr->last_router]);
554 if (!tipc_node_is_up(n_ptr))
555 node_lost_contact(n_ptr);
559 void node_print(struct print_buf *buf, struct node *n_ptr, char *str)
563 tipc_printf(buf, "\n\n%s", str);
564 for (i = 0; i < MAX_BEARERS; i++) {
565 if (!n_ptr->links[i])
567 tipc_printf(buf, "Links[%u]: %x, ", i, n_ptr->links[i]);
569 tipc_printf(buf, "Active links: [%x,%x]\n",
570 n_ptr->active_links[0], n_ptr->active_links[1]);
574 u32 tipc_available_nodes(const u32 domain)
579 for (n_ptr = tipc_nodes; n_ptr; n_ptr = n_ptr->next) {
580 if (!in_scope(domain, n_ptr->addr))
582 if (tipc_node_is_up(n_ptr))
588 struct sk_buff *tipc_node_get_nodes(const void *req_tlv_area, int req_tlv_space)
593 struct tipc_node_info node_info;
596 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_NET_ADDR))
597 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
599 domain = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
600 if (!tipc_addr_domain_valid(domain))
601 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
602 " (network address)");
605 return tipc_cfg_reply_none();
607 /* For now, get space for all other nodes
608 (will need to modify this when slave nodes are supported */
610 payload_size = TLV_SPACE(sizeof(node_info)) * (tipc_max_nodes - 1);
611 if (payload_size > 32768u)
612 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
613 " (too many nodes)");
614 buf = tipc_cfg_reply_alloc(payload_size);
618 /* Add TLVs for all nodes in scope */
620 for (n_ptr = tipc_nodes; n_ptr; n_ptr = n_ptr->next) {
621 if (!in_scope(domain, n_ptr->addr))
623 node_info.addr = htonl(n_ptr->addr);
624 node_info.up = htonl(tipc_node_is_up(n_ptr));
625 tipc_cfg_append_tlv(buf, TIPC_TLV_NODE_INFO,
626 &node_info, sizeof(node_info));
632 struct sk_buff *tipc_node_get_links(const void *req_tlv_area, int req_tlv_space)
637 struct tipc_link_info link_info;
640 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_NET_ADDR))
641 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
643 domain = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
644 if (!tipc_addr_domain_valid(domain))
645 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
646 " (network address)");
648 if (tipc_mode != TIPC_NET_MODE)
649 return tipc_cfg_reply_none();
651 /* Get space for all unicast links + multicast link */
653 payload_size = TLV_SPACE(sizeof(link_info)) *
654 (tipc_net.zones[tipc_zone(tipc_own_addr)]->links + 1);
655 if (payload_size > 32768u)
656 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
657 " (too many links)");
658 buf = tipc_cfg_reply_alloc(payload_size);
662 /* Add TLV for broadcast link */
664 link_info.dest = htonl(tipc_own_addr & 0xfffff00);
665 link_info.up = htonl(1);
666 sprintf(link_info.str, tipc_bclink_name);
667 tipc_cfg_append_tlv(buf, TIPC_TLV_LINK_INFO, &link_info, sizeof(link_info));
669 /* Add TLVs for any other links in scope */
671 for (n_ptr = tipc_nodes; n_ptr; n_ptr = n_ptr->next) {
674 if (!in_scope(domain, n_ptr->addr))
676 for (i = 0; i < MAX_BEARERS; i++) {
677 if (!n_ptr->links[i])
679 link_info.dest = htonl(n_ptr->addr);
680 link_info.up = htonl(tipc_link_is_up(n_ptr->links[i]));
681 strcpy(link_info.str, n_ptr->links[i]->name);
682 tipc_cfg_append_tlv(buf, TIPC_TLV_LINK_INFO,
683 &link_info, sizeof(link_info));