2 * net/tipc/node.c: TIPC node management routines
4 * Copyright (c) 2000-2006, 2012-2014, Ericsson AB
5 * Copyright (c) 2005-2006, 2010-2014, 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.
40 #include "name_distr.h"
43 static void node_lost_contact(struct tipc_node *n_ptr);
44 static void node_established_contact(struct tipc_node *n_ptr);
46 struct tipc_sock_conn {
50 struct list_head list;
53 static const struct nla_policy tipc_nl_node_policy[TIPC_NLA_NODE_MAX + 1] = {
54 [TIPC_NLA_NODE_UNSPEC] = { .type = NLA_UNSPEC },
55 [TIPC_NLA_NODE_ADDR] = { .type = NLA_U32 },
56 [TIPC_NLA_NODE_UP] = { .type = NLA_FLAG }
60 * A trivial power-of-two bitmask technique is used for speed, since this
61 * operation is done for every incoming TIPC packet. The number of hash table
62 * entries has been chosen so that no hash chain exceeds 8 nodes and will
63 * usually be much smaller (typically only a single node).
65 static unsigned int tipc_hashfn(u32 addr)
67 return addr & (NODE_HTABLE_SIZE - 1);
71 * tipc_node_find - locate specified node object, if it exists
73 struct tipc_node *tipc_node_find(struct net *net, u32 addr)
75 struct tipc_net *tn = net_generic(net, tipc_net_id);
76 struct tipc_node *node;
78 if (unlikely(!in_own_cluster_exact(addr)))
82 hlist_for_each_entry_rcu(node, &tn->node_htable[tipc_hashfn(addr)],
84 if (node->addr == addr) {
93 struct tipc_node *tipc_node_create(struct net *net, u32 addr)
95 struct tipc_net *tn = net_generic(net, tipc_net_id);
96 struct tipc_node *n_ptr, *temp_node;
98 spin_lock_bh(&tn->node_list_lock);
100 n_ptr = kzalloc(sizeof(*n_ptr), GFP_ATOMIC);
102 spin_unlock_bh(&tn->node_list_lock);
103 pr_warn("Node creation failed, no memory\n");
109 spin_lock_init(&n_ptr->lock);
110 INIT_HLIST_NODE(&n_ptr->hash);
111 INIT_LIST_HEAD(&n_ptr->list);
112 INIT_LIST_HEAD(&n_ptr->publ_list);
113 INIT_LIST_HEAD(&n_ptr->conn_sks);
114 skb_queue_head_init(&n_ptr->waiting_sks);
115 __skb_queue_head_init(&n_ptr->bclink.deferred_queue);
117 hlist_add_head_rcu(&n_ptr->hash, &tn->node_htable[tipc_hashfn(addr)]);
119 list_for_each_entry_rcu(temp_node, &tn->node_list, list) {
120 if (n_ptr->addr < temp_node->addr)
123 list_add_tail_rcu(&n_ptr->list, &temp_node->list);
124 n_ptr->action_flags = TIPC_WAIT_PEER_LINKS_DOWN;
125 n_ptr->signature = INVALID_NODE_SIG;
129 spin_unlock_bh(&tn->node_list_lock);
133 static void tipc_node_delete(struct tipc_net *tn, struct tipc_node *n_ptr)
135 list_del_rcu(&n_ptr->list);
136 hlist_del_rcu(&n_ptr->hash);
137 kfree_rcu(n_ptr, rcu);
142 void tipc_node_stop(struct net *net)
144 struct tipc_net *tn = net_generic(net, tipc_net_id);
145 struct tipc_node *node, *t_node;
147 spin_lock_bh(&tn->node_list_lock);
148 list_for_each_entry_safe(node, t_node, &tn->node_list, list)
149 tipc_node_delete(tn, node);
150 spin_unlock_bh(&tn->node_list_lock);
153 int tipc_node_add_conn(struct net *net, u32 dnode, u32 port, u32 peer_port)
155 struct tipc_node *node;
156 struct tipc_sock_conn *conn;
158 if (in_own_node(dnode))
161 node = tipc_node_find(net, dnode);
163 pr_warn("Connecting sock to node 0x%x failed\n", dnode);
164 return -EHOSTUNREACH;
166 conn = kmalloc(sizeof(*conn), GFP_ATOMIC);
168 return -EHOSTUNREACH;
169 conn->peer_node = dnode;
171 conn->peer_port = peer_port;
173 tipc_node_lock(node);
174 list_add_tail(&conn->list, &node->conn_sks);
175 tipc_node_unlock(node);
179 void tipc_node_remove_conn(struct net *net, u32 dnode, u32 port)
181 struct tipc_node *node;
182 struct tipc_sock_conn *conn, *safe;
184 if (in_own_node(dnode))
187 node = tipc_node_find(net, dnode);
191 tipc_node_lock(node);
192 list_for_each_entry_safe(conn, safe, &node->conn_sks, list) {
193 if (port != conn->port)
195 list_del(&conn->list);
198 tipc_node_unlock(node);
201 void tipc_node_abort_sock_conns(struct net *net, struct list_head *conns)
203 struct tipc_sock_conn *conn, *safe;
206 list_for_each_entry_safe(conn, safe, conns, list) {
207 buf = tipc_msg_create(TIPC_CRITICAL_IMPORTANCE, TIPC_CONN_MSG,
208 SHORT_H_SIZE, 0, tipc_own_addr,
209 conn->peer_node, conn->port,
210 conn->peer_port, TIPC_ERR_NO_NODE);
212 tipc_sk_rcv(net, buf);
213 list_del(&conn->list);
219 * tipc_node_link_up - handle addition of link
221 * Link becomes active (alone or shared) or standby, depending on its priority.
223 void tipc_node_link_up(struct tipc_node *n_ptr, struct tipc_link *l_ptr)
225 struct tipc_link **active = &n_ptr->active_links[0];
227 n_ptr->working_links++;
228 n_ptr->action_flags |= TIPC_NOTIFY_LINK_UP;
229 n_ptr->link_id = l_ptr->peer_bearer_id << 16 | l_ptr->bearer_id;
231 pr_info("Established link <%s> on network plane %c\n",
232 l_ptr->name, l_ptr->net_plane);
235 active[0] = active[1] = l_ptr;
236 node_established_contact(n_ptr);
239 if (l_ptr->priority < active[0]->priority) {
240 pr_info("New link <%s> becomes standby\n", l_ptr->name);
243 tipc_link_dup_queue_xmit(active[0], l_ptr);
244 if (l_ptr->priority == active[0]->priority) {
248 pr_info("Old link <%s> becomes standby\n", active[0]->name);
249 if (active[1] != active[0])
250 pr_info("Old link <%s> becomes standby\n", active[1]->name);
251 active[0] = active[1] = l_ptr;
253 /* Leave room for changeover header when returning 'mtu' to users: */
254 n_ptr->act_mtus[0] = active[0]->max_pkt - INT_H_SIZE;
255 n_ptr->act_mtus[1] = active[1]->max_pkt - INT_H_SIZE;
259 * node_select_active_links - select active link
261 static void node_select_active_links(struct tipc_node *n_ptr)
263 struct tipc_link **active = &n_ptr->active_links[0];
265 u32 highest_prio = 0;
267 active[0] = active[1] = NULL;
269 for (i = 0; i < MAX_BEARERS; i++) {
270 struct tipc_link *l_ptr = n_ptr->links[i];
272 if (!l_ptr || !tipc_link_is_up(l_ptr) ||
273 (l_ptr->priority < highest_prio))
276 if (l_ptr->priority > highest_prio) {
277 highest_prio = l_ptr->priority;
278 active[0] = active[1] = l_ptr;
286 * tipc_node_link_down - handle loss of link
288 void tipc_node_link_down(struct tipc_node *n_ptr, struct tipc_link *l_ptr)
290 struct tipc_link **active;
292 n_ptr->working_links--;
293 n_ptr->action_flags |= TIPC_NOTIFY_LINK_DOWN;
294 n_ptr->link_id = l_ptr->peer_bearer_id << 16 | l_ptr->bearer_id;
296 if (!tipc_link_is_active(l_ptr)) {
297 pr_info("Lost standby link <%s> on network plane %c\n",
298 l_ptr->name, l_ptr->net_plane);
301 pr_info("Lost link <%s> on network plane %c\n",
302 l_ptr->name, l_ptr->net_plane);
304 active = &n_ptr->active_links[0];
305 if (active[0] == l_ptr)
306 active[0] = active[1];
307 if (active[1] == l_ptr)
308 active[1] = active[0];
309 if (active[0] == l_ptr)
310 node_select_active_links(n_ptr);
311 if (tipc_node_is_up(n_ptr))
312 tipc_link_failover_send_queue(l_ptr);
314 node_lost_contact(n_ptr);
316 /* Leave room for changeover header when returning 'mtu' to users: */
318 n_ptr->act_mtus[0] = active[0]->max_pkt - INT_H_SIZE;
319 n_ptr->act_mtus[1] = active[1]->max_pkt - INT_H_SIZE;
323 /* Loopback link went down? No fragmentation needed from now on. */
324 if (n_ptr->addr == tipc_own_addr) {
325 n_ptr->act_mtus[0] = MAX_MSG_SIZE;
326 n_ptr->act_mtus[1] = MAX_MSG_SIZE;
330 int tipc_node_active_links(struct tipc_node *n_ptr)
332 return n_ptr->active_links[0] != NULL;
335 int tipc_node_is_up(struct tipc_node *n_ptr)
337 return tipc_node_active_links(n_ptr);
340 void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr)
342 struct tipc_net *tn = net_generic(n_ptr->net, tipc_net_id);
344 n_ptr->links[l_ptr->bearer_id] = l_ptr;
345 spin_lock_bh(&tn->node_list_lock);
347 spin_unlock_bh(&tn->node_list_lock);
351 void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr)
353 struct tipc_net *tn = net_generic(n_ptr->net, tipc_net_id);
356 for (i = 0; i < MAX_BEARERS; i++) {
357 if (l_ptr != n_ptr->links[i])
359 n_ptr->links[i] = NULL;
360 spin_lock_bh(&tn->node_list_lock);
362 spin_unlock_bh(&tn->node_list_lock);
367 static void node_established_contact(struct tipc_node *n_ptr)
369 n_ptr->action_flags |= TIPC_NOTIFY_NODE_UP;
370 n_ptr->bclink.oos_state = 0;
371 n_ptr->bclink.acked = tipc_bclink_get_last_sent();
372 tipc_bclink_add_node(n_ptr->addr);
375 static void node_lost_contact(struct tipc_node *n_ptr)
377 char addr_string[16];
380 pr_info("Lost contact with %s\n",
381 tipc_addr_string_fill(addr_string, n_ptr->addr));
383 /* Flush broadcast link info associated with lost node */
384 if (n_ptr->bclink.recv_permitted) {
385 __skb_queue_purge(&n_ptr->bclink.deferred_queue);
387 if (n_ptr->bclink.reasm_buf) {
388 kfree_skb(n_ptr->bclink.reasm_buf);
389 n_ptr->bclink.reasm_buf = NULL;
392 tipc_bclink_remove_node(n_ptr->addr);
393 tipc_bclink_acknowledge(n_ptr, INVALID_LINK_SEQ);
395 n_ptr->bclink.recv_permitted = false;
398 /* Abort link changeover */
399 for (i = 0; i < MAX_BEARERS; i++) {
400 struct tipc_link *l_ptr = n_ptr->links[i];
403 l_ptr->reset_checkpoint = l_ptr->next_in_no;
404 l_ptr->exp_msg_count = 0;
405 tipc_link_reset_fragments(l_ptr);
408 n_ptr->action_flags &= ~TIPC_WAIT_OWN_LINKS_DOWN;
410 /* Notify subscribers and prevent re-contact with node until
413 n_ptr->action_flags |= TIPC_WAIT_PEER_LINKS_DOWN |
414 TIPC_NOTIFY_NODE_DOWN;
417 struct sk_buff *tipc_node_get_nodes(struct net *net, const void *req_tlv_area,
420 struct tipc_net *tn = net_generic(net, tipc_net_id);
423 struct tipc_node *n_ptr;
424 struct tipc_node_info node_info;
427 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_NET_ADDR))
428 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
430 domain = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
431 if (!tipc_addr_domain_valid(domain))
432 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
433 " (network address)");
435 spin_lock_bh(&tn->node_list_lock);
436 if (!tn->num_nodes) {
437 spin_unlock_bh(&tn->node_list_lock);
438 return tipc_cfg_reply_none();
441 /* For now, get space for all other nodes */
442 payload_size = TLV_SPACE(sizeof(node_info)) * tn->num_nodes;
443 if (payload_size > 32768u) {
444 spin_unlock_bh(&tn->node_list_lock);
445 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
446 " (too many nodes)");
448 spin_unlock_bh(&tn->node_list_lock);
450 buf = tipc_cfg_reply_alloc(payload_size);
454 /* Add TLVs for all nodes in scope */
456 list_for_each_entry_rcu(n_ptr, &tn->node_list, list) {
457 if (!tipc_in_scope(domain, n_ptr->addr))
459 node_info.addr = htonl(n_ptr->addr);
460 node_info.up = htonl(tipc_node_is_up(n_ptr));
461 tipc_cfg_append_tlv(buf, TIPC_TLV_NODE_INFO,
462 &node_info, sizeof(node_info));
468 struct sk_buff *tipc_node_get_links(struct net *net, const void *req_tlv_area,
471 struct tipc_net *tn = net_generic(net, tipc_net_id);
474 struct tipc_node *n_ptr;
475 struct tipc_link_info link_info;
478 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_NET_ADDR))
479 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
481 domain = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
482 if (!tipc_addr_domain_valid(domain))
483 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
484 " (network address)");
487 return tipc_cfg_reply_none();
489 spin_lock_bh(&tn->node_list_lock);
490 /* Get space for all unicast links + broadcast link */
491 payload_size = TLV_SPACE((sizeof(link_info)) * (tn->num_links + 1));
492 if (payload_size > 32768u) {
493 spin_unlock_bh(&tn->node_list_lock);
494 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
495 " (too many links)");
497 spin_unlock_bh(&tn->node_list_lock);
499 buf = tipc_cfg_reply_alloc(payload_size);
503 /* Add TLV for broadcast link */
504 link_info.dest = htonl(tipc_cluster_mask(tipc_own_addr));
505 link_info.up = htonl(1);
506 strlcpy(link_info.str, tipc_bclink_name, TIPC_MAX_LINK_NAME);
507 tipc_cfg_append_tlv(buf, TIPC_TLV_LINK_INFO, &link_info, sizeof(link_info));
509 /* Add TLVs for any other links in scope */
511 list_for_each_entry_rcu(n_ptr, &tn->node_list, list) {
514 if (!tipc_in_scope(domain, n_ptr->addr))
516 tipc_node_lock(n_ptr);
517 for (i = 0; i < MAX_BEARERS; i++) {
518 if (!n_ptr->links[i])
520 link_info.dest = htonl(n_ptr->addr);
521 link_info.up = htonl(tipc_link_is_up(n_ptr->links[i]));
522 strcpy(link_info.str, n_ptr->links[i]->name);
523 tipc_cfg_append_tlv(buf, TIPC_TLV_LINK_INFO,
524 &link_info, sizeof(link_info));
526 tipc_node_unlock(n_ptr);
533 * tipc_node_get_linkname - get the name of a link
535 * @bearer_id: id of the bearer
536 * @node: peer node address
537 * @linkname: link name output buffer
539 * Returns 0 on success
541 int tipc_node_get_linkname(struct net *net, u32 bearer_id, u32 addr,
542 char *linkname, size_t len)
544 struct tipc_link *link;
545 struct tipc_node *node = tipc_node_find(net, addr);
547 if ((bearer_id >= MAX_BEARERS) || !node)
549 tipc_node_lock(node);
550 link = node->links[bearer_id];
552 strncpy(linkname, link->name, len);
553 tipc_node_unlock(node);
556 tipc_node_unlock(node);
560 void tipc_node_unlock(struct tipc_node *node)
562 struct net *net = node->net;
563 LIST_HEAD(nsub_list);
565 struct sk_buff_head waiting_sks;
567 int flags = node->action_flags;
570 if (likely(!flags)) {
571 spin_unlock_bh(&node->lock);
576 link_id = node->link_id;
577 __skb_queue_head_init(&waiting_sks);
579 if (flags & TIPC_WAKEUP_USERS)
580 skb_queue_splice_init(&node->waiting_sks, &waiting_sks);
582 if (flags & TIPC_NOTIFY_NODE_DOWN) {
583 list_replace_init(&node->publ_list, &nsub_list);
584 list_replace_init(&node->conn_sks, &conn_sks);
586 node->action_flags &= ~(TIPC_WAKEUP_USERS | TIPC_NOTIFY_NODE_DOWN |
587 TIPC_NOTIFY_NODE_UP | TIPC_NOTIFY_LINK_UP |
588 TIPC_NOTIFY_LINK_DOWN |
589 TIPC_WAKEUP_BCAST_USERS);
591 spin_unlock_bh(&node->lock);
593 while (!skb_queue_empty(&waiting_sks))
594 tipc_sk_rcv(net, __skb_dequeue(&waiting_sks));
596 if (!list_empty(&conn_sks))
597 tipc_node_abort_sock_conns(net, &conn_sks);
599 if (!list_empty(&nsub_list))
600 tipc_publ_notify(net, &nsub_list, addr);
602 if (flags & TIPC_WAKEUP_BCAST_USERS)
603 tipc_bclink_wakeup_users(net);
605 if (flags & TIPC_NOTIFY_NODE_UP)
606 tipc_named_node_up(net, addr);
608 if (flags & TIPC_NOTIFY_LINK_UP)
609 tipc_nametbl_publish(net, TIPC_LINK_STATE, addr, addr,
610 TIPC_NODE_SCOPE, link_id, addr);
612 if (flags & TIPC_NOTIFY_LINK_DOWN)
613 tipc_nametbl_withdraw(net, TIPC_LINK_STATE, addr,
617 /* Caller should hold node lock for the passed node */
618 static int __tipc_nl_add_node(struct tipc_nl_msg *msg, struct tipc_node *node)
621 struct nlattr *attrs;
623 hdr = genlmsg_put(msg->skb, msg->portid, msg->seq, &tipc_genl_v2_family,
624 NLM_F_MULTI, TIPC_NL_NODE_GET);
628 attrs = nla_nest_start(msg->skb, TIPC_NLA_NODE);
632 if (nla_put_u32(msg->skb, TIPC_NLA_NODE_ADDR, node->addr))
634 if (tipc_node_is_up(node))
635 if (nla_put_flag(msg->skb, TIPC_NLA_NODE_UP))
638 nla_nest_end(msg->skb, attrs);
639 genlmsg_end(msg->skb, hdr);
644 nla_nest_cancel(msg->skb, attrs);
646 genlmsg_cancel(msg->skb, hdr);
651 int tipc_nl_node_dump(struct sk_buff *skb, struct netlink_callback *cb)
654 struct net *net = sock_net(skb->sk);
655 struct tipc_net *tn = net_generic(net, tipc_net_id);
656 int done = cb->args[0];
657 int last_addr = cb->args[1];
658 struct tipc_node *node;
659 struct tipc_nl_msg msg;
665 msg.portid = NETLINK_CB(cb->skb).portid;
666 msg.seq = cb->nlh->nlmsg_seq;
670 if (last_addr && !tipc_node_find(net, last_addr)) {
672 /* We never set seq or call nl_dump_check_consistent() this
673 * means that setting prev_seq here will cause the consistence
674 * check to fail in the netlink callback handler. Resulting in
675 * the NLMSG_DONE message having the NLM_F_DUMP_INTR flag set if
676 * the node state changed while we released the lock.
682 list_for_each_entry_rcu(node, &tn->node_list, list) {
684 if (node->addr == last_addr)
690 tipc_node_lock(node);
691 err = __tipc_nl_add_node(&msg, node);
693 last_addr = node->addr;
694 tipc_node_unlock(node);
698 tipc_node_unlock(node);
703 cb->args[1] = last_addr;