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
= kmalloc(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
);
78 memset(n_ptr
, 0, sizeof(*n_ptr
));
80 spin_lock_init(&n_ptr
->lock
);
81 INIT_LIST_HEAD(&n_ptr
->nsub
);
83 tipc_cltr_attach_node(c_ptr
, n_ptr
);
84 n_ptr
->last_router
= -1;
86 /* Insert node into ordered list */
87 for (curr_node
= &tipc_nodes
; *curr_node
;
88 curr_node
= &(*curr_node
)->next
) {
89 if (addr
< (*curr_node
)->addr
) {
90 n_ptr
->next
= *curr_node
;
98 void tipc_node_delete(struct node
*n_ptr
)
104 /* Not needed because links are already deleted via tipc_bearer_stop() */
108 for (l_num
= 0; l_num
< MAX_BEARERS
; l_num
++) {
109 link_delete(n_ptr
->links
[l_num
]);
113 dbg("node %x deleted\n", n_ptr
->addr
);
119 * tipc_node_link_up - handle addition of link
121 * Link becomes active (alone or shared) or standby, depending on its priority.
124 void tipc_node_link_up(struct node
*n_ptr
, struct link
*l_ptr
)
126 struct link
**active
= &n_ptr
->active_links
[0];
128 n_ptr
->working_links
++;
130 info("Established link <%s> on network plane %c\n",
131 l_ptr
->name
, l_ptr
->b_ptr
->net_plane
);
134 dbg(" link %x into %x/%x\n", l_ptr
, &active
[0], &active
[1]);
135 active
[0] = active
[1] = l_ptr
;
136 node_established_contact(n_ptr
);
139 if (l_ptr
->priority
< active
[0]->priority
) {
140 info("New link <%s> becomes standby\n", l_ptr
->name
);
143 tipc_link_send_duplicate(active
[0], l_ptr
);
144 if (l_ptr
->priority
== active
[0]->priority
) {
148 info("Old link <%s> becomes standby\n", active
[0]->name
);
149 if (active
[1] != active
[0])
150 info("Old link <%s> becomes standby\n", active
[1]->name
);
151 active
[0] = active
[1] = l_ptr
;
155 * node_select_active_links - select active link
158 static void node_select_active_links(struct node
*n_ptr
)
160 struct link
**active
= &n_ptr
->active_links
[0];
162 u32 highest_prio
= 0;
164 active
[0] = active
[1] = NULL
;
166 for (i
= 0; i
< MAX_BEARERS
; i
++) {
167 struct link
*l_ptr
= n_ptr
->links
[i
];
169 if (!l_ptr
|| !tipc_link_is_up(l_ptr
) ||
170 (l_ptr
->priority
< highest_prio
))
173 if (l_ptr
->priority
> highest_prio
) {
174 highest_prio
= l_ptr
->priority
;
175 active
[0] = active
[1] = l_ptr
;
183 * tipc_node_link_down - handle loss of link
186 void tipc_node_link_down(struct node
*n_ptr
, struct link
*l_ptr
)
188 struct link
**active
;
190 n_ptr
->working_links
--;
192 if (!tipc_link_is_active(l_ptr
)) {
193 info("Lost standby link <%s> on network plane %c\n",
194 l_ptr
->name
, l_ptr
->b_ptr
->net_plane
);
197 info("Lost link <%s> on network plane %c\n",
198 l_ptr
->name
, l_ptr
->b_ptr
->net_plane
);
200 active
= &n_ptr
->active_links
[0];
201 if (active
[0] == l_ptr
)
202 active
[0] = active
[1];
203 if (active
[1] == l_ptr
)
204 active
[1] = active
[0];
205 if (active
[0] == l_ptr
)
206 node_select_active_links(n_ptr
);
207 if (tipc_node_is_up(n_ptr
))
208 tipc_link_changeover(l_ptr
);
210 node_lost_contact(n_ptr
);
213 int tipc_node_has_active_links(struct node
*n_ptr
)
216 ((n_ptr
->active_links
[0]) || (n_ptr
->active_links
[1])));
219 int tipc_node_has_redundant_links(struct node
*n_ptr
)
221 return (n_ptr
->working_links
> 1);
224 static int tipc_node_has_active_routes(struct node
*n_ptr
)
226 return (n_ptr
&& (n_ptr
->last_router
>= 0));
229 int tipc_node_is_up(struct node
*n_ptr
)
231 return (tipc_node_has_active_links(n_ptr
) || tipc_node_has_active_routes(n_ptr
));
234 struct node
*tipc_node_attach_link(struct link
*l_ptr
)
236 struct node
*n_ptr
= tipc_node_find(l_ptr
->addr
);
239 n_ptr
= tipc_node_create(l_ptr
->addr
);
241 u32 bearer_id
= l_ptr
->b_ptr
->identity
;
242 char addr_string
[16];
244 if (n_ptr
->link_cnt
>= 2) {
245 char addr_string
[16];
247 err("Attempt to create third link to %s\n",
248 addr_string_fill(addr_string
, n_ptr
->addr
));
252 if (!n_ptr
->links
[bearer_id
]) {
253 n_ptr
->links
[bearer_id
] = l_ptr
;
254 tipc_net
.zones
[tipc_zone(l_ptr
->addr
)]->links
++;
258 err("Attempt to establish second link on <%s> to %s \n",
259 l_ptr
->b_ptr
->publ
.name
,
260 addr_string_fill(addr_string
, l_ptr
->addr
));
265 void tipc_node_detach_link(struct node
*n_ptr
, struct link
*l_ptr
)
267 n_ptr
->links
[l_ptr
->b_ptr
->identity
] = NULL
;
268 tipc_net
.zones
[tipc_zone(l_ptr
->addr
)]->links
--;
273 * Routing table management - five cases to handle:
275 * 1: A link towards a zone/cluster external node comes up.
276 * => Send a multicast message updating routing tables of all
277 * system nodes within own cluster that the new destination
278 * can be reached via this node.
279 * (node.establishedContact()=>cluster.multicastNewRoute())
281 * 2: A link towards a slave node comes up.
282 * => Send a multicast message updating routing tables of all
283 * system nodes within own cluster that the new destination
284 * can be reached via this node.
285 * (node.establishedContact()=>cluster.multicastNewRoute())
286 * => Send a message to the slave node about existence
287 * of all system nodes within cluster:
288 * (node.establishedContact()=>cluster.sendLocalRoutes())
290 * 3: A new cluster local system node becomes available.
291 * => Send message(s) to this particular node containing
292 * information about all cluster external and slave
293 * nodes which can be reached via this node.
294 * (node.establishedContact()==>network.sendExternalRoutes())
295 * (node.establishedContact()==>network.sendSlaveRoutes())
296 * => Send messages to all directly connected slave nodes
297 * containing information about the existence of the new node
298 * (node.establishedContact()=>cluster.multicastNewRoute())
300 * 4: The link towards a zone/cluster external node or slave
302 * => Send a multcast message updating routing tables of all
303 * nodes within cluster that the new destination can not any
304 * longer be reached via this node.
305 * (node.lostAllLinks()=>cluster.bcastLostRoute())
307 * 5: A cluster local system node becomes unavailable.
308 * => Remove all references to this node from the local
309 * routing tables. Note: This is a completely node
311 * (node.lostAllLinks()=>network.removeAsRouter())
312 * => Send messages to all directly connected slave nodes
313 * containing information about loss of the node
314 * (node.establishedContact()=>cluster.multicastLostRoute())
318 static void node_established_contact(struct node
*n_ptr
)
320 struct cluster
*c_ptr
;
322 dbg("node_established_contact:-> %x\n", n_ptr
->addr
);
323 if (!tipc_node_has_active_routes(n_ptr
) && in_own_cluster(n_ptr
->addr
)) {
324 tipc_k_signal((Handler
)tipc_named_node_up
, n_ptr
->addr
);
327 /* Syncronize broadcast acks */
328 n_ptr
->bclink
.acked
= tipc_bclink_get_last_sent();
330 if (is_slave(tipc_own_addr
))
332 if (!in_own_cluster(n_ptr
->addr
)) {
333 /* Usage case 1 (see above) */
334 c_ptr
= tipc_cltr_find(tipc_own_addr
);
336 c_ptr
= tipc_cltr_create(tipc_own_addr
);
338 tipc_cltr_bcast_new_route(c_ptr
, n_ptr
->addr
, 1,
343 c_ptr
= n_ptr
->owner
;
344 if (is_slave(n_ptr
->addr
)) {
345 /* Usage case 2 (see above) */
346 tipc_cltr_bcast_new_route(c_ptr
, n_ptr
->addr
, 1, tipc_max_nodes
);
347 tipc_cltr_send_local_routes(c_ptr
, n_ptr
->addr
);
351 if (n_ptr
->bclink
.supported
) {
352 tipc_nmap_add(&tipc_cltr_bcast_nodes
, n_ptr
->addr
);
353 if (n_ptr
->addr
< tipc_own_addr
)
357 /* Case 3 (see above) */
358 tipc_net_send_external_routes(n_ptr
->addr
);
359 tipc_cltr_send_slave_routes(c_ptr
, n_ptr
->addr
);
360 tipc_cltr_bcast_new_route(c_ptr
, n_ptr
->addr
, LOWEST_SLAVE
,
361 tipc_highest_allowed_slave
);
364 static void node_lost_contact(struct node
*n_ptr
)
366 struct cluster
*c_ptr
;
367 struct node_subscr
*ns
, *tns
;
368 char addr_string
[16];
371 /* Clean up broadcast reception remains */
372 n_ptr
->bclink
.gap_after
= n_ptr
->bclink
.gap_to
= 0;
373 while (n_ptr
->bclink
.deferred_head
) {
374 struct sk_buff
* buf
= n_ptr
->bclink
.deferred_head
;
375 n_ptr
->bclink
.deferred_head
= buf
->next
;
378 if (n_ptr
->bclink
.defragm
) {
379 buf_discard(n_ptr
->bclink
.defragm
);
380 n_ptr
->bclink
.defragm
= NULL
;
382 if (in_own_cluster(n_ptr
->addr
) && n_ptr
->bclink
.supported
) {
383 tipc_bclink_acknowledge(n_ptr
, mod(n_ptr
->bclink
.acked
+ 10000));
386 /* Update routing tables */
387 if (is_slave(tipc_own_addr
)) {
388 tipc_net_remove_as_router(n_ptr
->addr
);
390 if (!in_own_cluster(n_ptr
->addr
)) {
391 /* Case 4 (see above) */
392 c_ptr
= tipc_cltr_find(tipc_own_addr
);
393 tipc_cltr_bcast_lost_route(c_ptr
, n_ptr
->addr
, 1,
396 /* Case 5 (see above) */
397 c_ptr
= tipc_cltr_find(n_ptr
->addr
);
398 if (is_slave(n_ptr
->addr
)) {
399 tipc_cltr_bcast_lost_route(c_ptr
, n_ptr
->addr
, 1,
402 if (n_ptr
->bclink
.supported
) {
403 tipc_nmap_remove(&tipc_cltr_bcast_nodes
,
405 if (n_ptr
->addr
< tipc_own_addr
)
408 tipc_net_remove_as_router(n_ptr
->addr
);
409 tipc_cltr_bcast_lost_route(c_ptr
, n_ptr
->addr
,
411 tipc_highest_allowed_slave
);
415 if (tipc_node_has_active_routes(n_ptr
))
418 info("Lost contact with %s\n",
419 addr_string_fill(addr_string
, n_ptr
->addr
));
421 /* Abort link changeover */
422 for (i
= 0; i
< MAX_BEARERS
; i
++) {
423 struct link
*l_ptr
= n_ptr
->links
[i
];
426 l_ptr
->reset_checkpoint
= l_ptr
->next_in_no
;
427 l_ptr
->exp_msg_count
= 0;
428 tipc_link_reset_fragments(l_ptr
);
431 /* Notify subscribers */
432 list_for_each_entry_safe(ns
, tns
, &n_ptr
->nsub
, nodesub_list
) {
434 list_del_init(&ns
->nodesub_list
);
435 tipc_k_signal((Handler
)ns
->handle_node_down
,
436 (unsigned long)ns
->usr_handle
);
441 * tipc_node_select_next_hop - find the next-hop node for a message
443 * Called by when cluster local lookup has failed.
446 struct node
*tipc_node_select_next_hop(u32 addr
, u32 selector
)
451 if (!tipc_addr_domain_valid(addr
))
454 /* Look for direct link to destination processsor */
455 n_ptr
= tipc_node_find(addr
);
456 if (n_ptr
&& tipc_node_has_active_links(n_ptr
))
459 /* Cluster local system nodes *must* have direct links */
460 if (!is_slave(addr
) && in_own_cluster(addr
))
463 /* Look for cluster local router with direct link to node */
464 router_addr
= tipc_node_select_router(n_ptr
, selector
);
466 return tipc_node_select(router_addr
, selector
);
468 /* Slave nodes can only be accessed within own cluster via a
469 known router with direct link -- if no router was found,give up */
473 /* Inter zone/cluster -- find any direct link to remote cluster */
474 addr
= tipc_addr(tipc_zone(addr
), tipc_cluster(addr
), 0);
475 n_ptr
= tipc_net_select_remote_node(addr
, selector
);
476 if (n_ptr
&& tipc_node_has_active_links(n_ptr
))
479 /* Last resort -- look for any router to anywhere in remote zone */
480 router_addr
= tipc_net_select_router(addr
, selector
);
482 return tipc_node_select(router_addr
, selector
);
488 * tipc_node_select_router - select router to reach specified node
490 * Uses a deterministic and fair algorithm for selecting router node.
493 u32
tipc_node_select_router(struct node
*n_ptr
, u32 ref
)
503 if (n_ptr
->last_router
< 0)
505 ulim
= ((n_ptr
->last_router
+ 1) * 32) - 1;
507 /* Start entry must be random */
508 mask
= tipc_max_nodes
;
514 /* Lookup upwards with wrap-around */
516 if (((n_ptr
->routers
[r
/ 32]) >> (r
% 32)) & 1)
518 } while (++r
<= ulim
);
522 if (((n_ptr
->routers
[r
/ 32]) >> (r
% 32)) & 1)
524 } while (++r
< start
);
527 assert(r
&& (r
<= ulim
));
528 return tipc_addr(own_zone(), own_cluster(), r
);
531 void tipc_node_add_router(struct node
*n_ptr
, u32 router
)
533 u32 r_num
= tipc_node(router
);
535 n_ptr
->routers
[r_num
/ 32] =
536 ((1 << (r_num
% 32)) | n_ptr
->routers
[r_num
/ 32]);
537 n_ptr
->last_router
= tipc_max_nodes
/ 32;
538 while ((--n_ptr
->last_router
>= 0) &&
539 !n_ptr
->routers
[n_ptr
->last_router
]);
542 void tipc_node_remove_router(struct node
*n_ptr
, u32 router
)
544 u32 r_num
= tipc_node(router
);
546 if (n_ptr
->last_router
< 0)
547 return; /* No routes */
549 n_ptr
->routers
[r_num
/ 32] =
550 ((~(1 << (r_num
% 32))) & (n_ptr
->routers
[r_num
/ 32]));
551 n_ptr
->last_router
= tipc_max_nodes
/ 32;
552 while ((--n_ptr
->last_router
>= 0) &&
553 !n_ptr
->routers
[n_ptr
->last_router
]);
555 if (!tipc_node_is_up(n_ptr
))
556 node_lost_contact(n_ptr
);
560 void node_print(struct print_buf
*buf
, struct node
*n_ptr
, char *str
)
564 tipc_printf(buf
, "\n\n%s", str
);
565 for (i
= 0; i
< MAX_BEARERS
; i
++) {
566 if (!n_ptr
->links
[i
])
568 tipc_printf(buf
, "Links[%u]: %x, ", i
, n_ptr
->links
[i
]);
570 tipc_printf(buf
, "Active links: [%x,%x]\n",
571 n_ptr
->active_links
[0], n_ptr
->active_links
[1]);
575 u32
tipc_available_nodes(const u32 domain
)
580 for (n_ptr
= tipc_nodes
; n_ptr
; n_ptr
= n_ptr
->next
) {
581 if (!in_scope(domain
, n_ptr
->addr
))
583 if (tipc_node_is_up(n_ptr
))
589 struct sk_buff
*tipc_node_get_nodes(const void *req_tlv_area
, int req_tlv_space
)
594 struct tipc_node_info node_info
;
597 if (!TLV_CHECK(req_tlv_area
, req_tlv_space
, TIPC_TLV_NET_ADDR
))
598 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR
);
600 domain
= *(u32
*)TLV_DATA(req_tlv_area
);
601 domain
= ntohl(domain
);
602 if (!tipc_addr_domain_valid(domain
))
603 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
604 " (network address)");
607 return tipc_cfg_reply_none();
609 /* For now, get space for all other nodes
610 (will need to modify this when slave nodes are supported */
612 payload_size
= TLV_SPACE(sizeof(node_info
)) * (tipc_max_nodes
- 1);
613 if (payload_size
> 32768u)
614 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
615 " (too many nodes)");
616 buf
= tipc_cfg_reply_alloc(payload_size
);
620 /* Add TLVs for all nodes in scope */
622 for (n_ptr
= tipc_nodes
; n_ptr
; n_ptr
= n_ptr
->next
) {
623 if (!in_scope(domain
, n_ptr
->addr
))
625 node_info
.addr
= htonl(n_ptr
->addr
);
626 node_info
.up
= htonl(tipc_node_is_up(n_ptr
));
627 tipc_cfg_append_tlv(buf
, TIPC_TLV_NODE_INFO
,
628 &node_info
, sizeof(node_info
));
634 struct sk_buff
*tipc_node_get_links(const void *req_tlv_area
, int req_tlv_space
)
639 struct tipc_link_info link_info
;
642 if (!TLV_CHECK(req_tlv_area
, req_tlv_space
, TIPC_TLV_NET_ADDR
))
643 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR
);
645 domain
= *(u32
*)TLV_DATA(req_tlv_area
);
646 domain
= ntohl(domain
);
647 if (!tipc_addr_domain_valid(domain
))
648 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
649 " (network address)");
652 return tipc_cfg_reply_none();
654 /* Get space for all unicast links + multicast link */
656 payload_size
= TLV_SPACE(sizeof(link_info
)) *
657 (tipc_net
.zones
[tipc_zone(tipc_own_addr
)]->links
+ 1);
658 if (payload_size
> 32768u)
659 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
660 " (too many links)");
661 buf
= tipc_cfg_reply_alloc(payload_size
);
665 /* Add TLV for broadcast link */
667 link_info
.dest
= tipc_own_addr
& 0xfffff00;
668 link_info
.dest
= htonl(link_info
.dest
);
669 link_info
.up
= htonl(1);
670 sprintf(link_info
.str
, tipc_bclink_name
);
671 tipc_cfg_append_tlv(buf
, TIPC_TLV_LINK_INFO
, &link_info
, sizeof(link_info
));
673 /* Add TLVs for any other links in scope */
675 for (n_ptr
= tipc_nodes
; n_ptr
; n_ptr
= n_ptr
->next
) {
678 if (!in_scope(domain
, n_ptr
->addr
))
680 for (i
= 0; i
< MAX_BEARERS
; i
++) {
681 if (!n_ptr
->links
[i
])
683 link_info
.dest
= htonl(n_ptr
->addr
);
684 link_info
.up
= htonl(tipc_link_is_up(n_ptr
->links
[i
]));
685 strcpy(link_info
.str
, n_ptr
->links
[i
]->name
);
686 tipc_cfg_append_tlv(buf
, TIPC_TLV_LINK_INFO
,
687 &link_info
, sizeof(link_info
));