06f642abdf38fbc979349f2e018be1f2bbcda0bd
[cascardo/linux.git] / net / tipc / node.c
1 /*
2  * net/tipc/node.c: TIPC node management routines
3  *
4  * Copyright (c) 2000-2006, 2012-2015, Ericsson AB
5  * Copyright (c) 2005-2006, 2010-2014, Wind River Systems
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
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.
19  *
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.
23  *
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.
35  */
36
37 #include "core.h"
38 #include "link.h"
39 #include "node.h"
40 #include "name_distr.h"
41 #include "socket.h"
42 #include "bcast.h"
43
44 static void node_lost_contact(struct tipc_node *n_ptr);
45 static void node_established_contact(struct tipc_node *n_ptr);
46 static void tipc_node_delete(struct tipc_node *node);
47
48 struct tipc_sock_conn {
49         u32 port;
50         u32 peer_port;
51         u32 peer_node;
52         struct list_head list;
53 };
54
55 static const struct nla_policy tipc_nl_node_policy[TIPC_NLA_NODE_MAX + 1] = {
56         [TIPC_NLA_NODE_UNSPEC]          = { .type = NLA_UNSPEC },
57         [TIPC_NLA_NODE_ADDR]            = { .type = NLA_U32 },
58         [TIPC_NLA_NODE_UP]              = { .type = NLA_FLAG }
59 };
60
61 /*
62  * A trivial power-of-two bitmask technique is used for speed, since this
63  * operation is done for every incoming TIPC packet. The number of hash table
64  * entries has been chosen so that no hash chain exceeds 8 nodes and will
65  * usually be much smaller (typically only a single node).
66  */
67 static unsigned int tipc_hashfn(u32 addr)
68 {
69         return addr & (NODE_HTABLE_SIZE - 1);
70 }
71
72 static void tipc_node_kref_release(struct kref *kref)
73 {
74         struct tipc_node *node = container_of(kref, struct tipc_node, kref);
75
76         tipc_node_delete(node);
77 }
78
79 void tipc_node_put(struct tipc_node *node)
80 {
81         kref_put(&node->kref, tipc_node_kref_release);
82 }
83
84 static void tipc_node_get(struct tipc_node *node)
85 {
86         kref_get(&node->kref);
87 }
88
89 /*
90  * tipc_node_find - locate specified node object, if it exists
91  */
92 struct tipc_node *tipc_node_find(struct net *net, u32 addr)
93 {
94         struct tipc_net *tn = net_generic(net, tipc_net_id);
95         struct tipc_node *node;
96
97         if (unlikely(!in_own_cluster_exact(net, addr)))
98                 return NULL;
99
100         rcu_read_lock();
101         hlist_for_each_entry_rcu(node, &tn->node_htable[tipc_hashfn(addr)],
102                                  hash) {
103                 if (node->addr == addr) {
104                         tipc_node_get(node);
105                         rcu_read_unlock();
106                         return node;
107                 }
108         }
109         rcu_read_unlock();
110         return NULL;
111 }
112
113 struct tipc_node *tipc_node_create(struct net *net, u32 addr)
114 {
115         struct tipc_net *tn = net_generic(net, tipc_net_id);
116         struct tipc_node *n_ptr, *temp_node;
117
118         spin_lock_bh(&tn->node_list_lock);
119         n_ptr = tipc_node_find(net, addr);
120         if (n_ptr)
121                 goto exit;
122         n_ptr = kzalloc(sizeof(*n_ptr), GFP_ATOMIC);
123         if (!n_ptr) {
124                 pr_warn("Node creation failed, no memory\n");
125                 goto exit;
126         }
127         n_ptr->addr = addr;
128         n_ptr->net = net;
129         kref_init(&n_ptr->kref);
130         spin_lock_init(&n_ptr->lock);
131         INIT_HLIST_NODE(&n_ptr->hash);
132         INIT_LIST_HEAD(&n_ptr->list);
133         INIT_LIST_HEAD(&n_ptr->publ_list);
134         INIT_LIST_HEAD(&n_ptr->conn_sks);
135         __skb_queue_head_init(&n_ptr->bclink.deferdq);
136         hlist_add_head_rcu(&n_ptr->hash, &tn->node_htable[tipc_hashfn(addr)]);
137         list_for_each_entry_rcu(temp_node, &tn->node_list, list) {
138                 if (n_ptr->addr < temp_node->addr)
139                         break;
140         }
141         list_add_tail_rcu(&n_ptr->list, &temp_node->list);
142         n_ptr->action_flags = TIPC_WAIT_PEER_LINKS_DOWN;
143         n_ptr->signature = INVALID_NODE_SIG;
144         tipc_node_get(n_ptr);
145 exit:
146         spin_unlock_bh(&tn->node_list_lock);
147         return n_ptr;
148 }
149
150 static void tipc_node_delete(struct tipc_node *node)
151 {
152         list_del_rcu(&node->list);
153         hlist_del_rcu(&node->hash);
154         kfree_rcu(node, rcu);
155 }
156
157 void tipc_node_stop(struct net *net)
158 {
159         struct tipc_net *tn = net_generic(net, tipc_net_id);
160         struct tipc_node *node, *t_node;
161
162         spin_lock_bh(&tn->node_list_lock);
163         list_for_each_entry_safe(node, t_node, &tn->node_list, list)
164                 tipc_node_put(node);
165         spin_unlock_bh(&tn->node_list_lock);
166 }
167
168 int tipc_node_add_conn(struct net *net, u32 dnode, u32 port, u32 peer_port)
169 {
170         struct tipc_node *node;
171         struct tipc_sock_conn *conn;
172         int err = 0;
173
174         if (in_own_node(net, dnode))
175                 return 0;
176
177         node = tipc_node_find(net, dnode);
178         if (!node) {
179                 pr_warn("Connecting sock to node 0x%x failed\n", dnode);
180                 return -EHOSTUNREACH;
181         }
182         conn = kmalloc(sizeof(*conn), GFP_ATOMIC);
183         if (!conn) {
184                 err = -EHOSTUNREACH;
185                 goto exit;
186         }
187         conn->peer_node = dnode;
188         conn->port = port;
189         conn->peer_port = peer_port;
190
191         tipc_node_lock(node);
192         list_add_tail(&conn->list, &node->conn_sks);
193         tipc_node_unlock(node);
194 exit:
195         tipc_node_put(node);
196         return err;
197 }
198
199 void tipc_node_remove_conn(struct net *net, u32 dnode, u32 port)
200 {
201         struct tipc_node *node;
202         struct tipc_sock_conn *conn, *safe;
203
204         if (in_own_node(net, dnode))
205                 return;
206
207         node = tipc_node_find(net, dnode);
208         if (!node)
209                 return;
210
211         tipc_node_lock(node);
212         list_for_each_entry_safe(conn, safe, &node->conn_sks, list) {
213                 if (port != conn->port)
214                         continue;
215                 list_del(&conn->list);
216                 kfree(conn);
217         }
218         tipc_node_unlock(node);
219         tipc_node_put(node);
220 }
221
222 /**
223  * tipc_node_link_up - handle addition of link
224  *
225  * Link becomes active (alone or shared) or standby, depending on its priority.
226  */
227 void tipc_node_link_up(struct tipc_node *n, int bearer_id)
228 {
229         struct tipc_link_entry **actv = &n->active_links[0];
230         struct tipc_link_entry *le = &n->links[bearer_id];
231         struct tipc_link *l = le->link;
232
233         /* Leave room for tunnel header when returning 'mtu' to users: */
234         n->links[bearer_id].mtu = l->mtu - INT_H_SIZE;
235
236         n->working_links++;
237         n->action_flags |= TIPC_NOTIFY_LINK_UP;
238         n->link_id = l->peer_bearer_id << 16 | l->bearer_id;
239
240         pr_debug("Established link <%s> on network plane %c\n",
241                  l->name, l->net_plane);
242
243         /* No active links ? => take both active slots */
244         if (!actv[0]) {
245                 actv[0] = le;
246                 actv[1] = le;
247                 node_established_contact(n);
248                 return;
249         }
250         if (l->priority < actv[0]->link->priority) {
251                 pr_debug("New link <%s> becomes standby\n", l->name);
252                 return;
253         }
254         tipc_link_dup_queue_xmit(actv[0]->link, l);
255
256         /* Take one active slot if applicable */
257         if (l->priority == actv[0]->link->priority) {
258                 actv[0] = le;
259                 return;
260         }
261         /* Higher prio than current active? => take both active slots */
262         pr_debug("Old l <%s> becomes standby\n", actv[0]->link->name);
263         if (actv[1] != actv[0])
264                 pr_debug("Old link <%s> now standby\n", actv[1]->link->name);
265         actv[0] = le;
266         actv[1] = le;
267 }
268
269 /**
270  * node_select_active_links - select which working links should be active
271  */
272 static void node_select_active_links(struct tipc_node *n)
273 {
274         struct tipc_link_entry **actv = &n->active_links[0];
275         struct tipc_link *l;
276         u32 b, highest = 0;
277
278         actv[0] = NULL;
279         actv[1] = NULL;
280
281         for (b = 0; b < MAX_BEARERS; b++) {
282                 l = n->links[b].link;
283                 if (!l || !tipc_link_is_up(l) || (l->priority < highest))
284                         continue;
285                 if (l->priority > highest) {
286                         highest = l->priority;
287                         actv[0] = &n->links[b];
288                         actv[1] = &n->links[b];
289                         continue;
290                 }
291                 actv[1] = &n->links[b];
292         }
293 }
294
295 /**
296  * tipc_node_link_down - handle loss of link
297  */
298 void tipc_node_link_down(struct tipc_node *n, int bearer_id)
299 {
300         struct tipc_link_entry **actv = &n->active_links[0];
301         struct tipc_link_entry *le = &n->links[bearer_id];
302         struct tipc_link *l = le->link;
303
304         n->working_links--;
305         n->action_flags |= TIPC_NOTIFY_LINK_DOWN;
306         n->link_id = l->peer_bearer_id << 16 | l->bearer_id;
307
308         if (!tipc_link_is_active(l)) {
309                 pr_debug("Lost standby link <%s> on network plane %c\n",
310                          l->name, l->net_plane);
311                 return;
312         }
313         pr_debug("Lost link <%s> on network plane %c\n",
314                  l->name, l->net_plane);
315
316         /* Resdistribute active slots if applicable */
317         if (actv[0] == le)
318                 actv[0] = actv[1];
319         if (actv[1] == le)
320                 actv[1] = actv[0];
321
322         /* Last link of this priority? => select other ones if available */
323         if (actv[0] == le)
324                 node_select_active_links(n);
325
326         if (tipc_node_is_up(n))
327                 tipc_link_failover_send_queue(l);
328         else
329                 node_lost_contact(n);
330 }
331
332 bool tipc_node_is_up(struct tipc_node *n)
333 {
334         return n->active_links[0];
335 }
336
337 void tipc_node_check_dest(struct tipc_node *n, struct tipc_bearer *b,
338                           bool *link_up, bool *addr_match,
339                           struct tipc_media_addr *maddr)
340 {
341         struct tipc_link *l = n->links[b->identity].link;
342         struct tipc_media_addr *curr = &n->links[b->identity].maddr;
343
344         *link_up = l && tipc_link_is_up(l);
345         *addr_match = l && !memcmp(curr, maddr, sizeof(*maddr));
346 }
347
348 bool tipc_node_update_dest(struct tipc_node *n,  struct tipc_bearer *b,
349                            struct tipc_media_addr *maddr)
350 {
351         struct tipc_link *l = n->links[b->identity].link;
352         struct tipc_media_addr *curr = &n->links[b->identity].maddr;
353
354         if (!l)
355                 l = tipc_link_create(n, b, maddr);
356         if (!l)
357                 return false;
358         memcpy(&l->media_addr, maddr, sizeof(*maddr));
359         memcpy(curr, maddr, sizeof(*maddr));
360         tipc_link_reset(l);
361         return true;
362 }
363
364 void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr)
365 {
366         n_ptr->links[l_ptr->bearer_id].link = l_ptr;
367         n_ptr->link_cnt++;
368 }
369
370 void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr)
371 {
372         int i;
373
374         for (i = 0; i < MAX_BEARERS; i++) {
375                 if (l_ptr != n_ptr->links[i].link)
376                         continue;
377                 n_ptr->links[i].link = NULL;
378                 n_ptr->link_cnt--;
379         }
380 }
381
382 static void node_established_contact(struct tipc_node *n_ptr)
383 {
384         n_ptr->action_flags |= TIPC_NOTIFY_NODE_UP;
385         n_ptr->bclink.oos_state = 0;
386         n_ptr->bclink.acked = tipc_bclink_get_last_sent(n_ptr->net);
387         tipc_bclink_add_node(n_ptr->net, n_ptr->addr);
388 }
389
390 static void node_lost_contact(struct tipc_node *n_ptr)
391 {
392         char addr_string[16];
393         struct tipc_sock_conn *conn, *safe;
394         struct list_head *conns = &n_ptr->conn_sks;
395         struct sk_buff *skb;
396         struct tipc_net *tn = net_generic(n_ptr->net, tipc_net_id);
397         uint i;
398
399         pr_debug("Lost contact with %s\n",
400                  tipc_addr_string_fill(addr_string, n_ptr->addr));
401
402         /* Flush broadcast link info associated with lost node */
403         if (n_ptr->bclink.recv_permitted) {
404                 __skb_queue_purge(&n_ptr->bclink.deferdq);
405
406                 if (n_ptr->bclink.reasm_buf) {
407                         kfree_skb(n_ptr->bclink.reasm_buf);
408                         n_ptr->bclink.reasm_buf = NULL;
409                 }
410
411                 tipc_bclink_remove_node(n_ptr->net, n_ptr->addr);
412                 tipc_bclink_acknowledge(n_ptr, INVALID_LINK_SEQ);
413
414                 n_ptr->bclink.recv_permitted = false;
415         }
416
417         /* Abort any ongoing link failover */
418         for (i = 0; i < MAX_BEARERS; i++) {
419                 struct tipc_link *l_ptr = n_ptr->links[i].link;
420                 if (!l_ptr)
421                         continue;
422                 l_ptr->flags &= ~LINK_FAILINGOVER;
423                 l_ptr->failover_checkpt = 0;
424                 l_ptr->failover_pkts = 0;
425                 kfree_skb(l_ptr->failover_skb);
426                 l_ptr->failover_skb = NULL;
427                 tipc_link_reset_fragments(l_ptr);
428         }
429
430         n_ptr->action_flags &= ~TIPC_WAIT_OWN_LINKS_DOWN;
431
432         /* Prevent re-contact with node until cleanup is done */
433         n_ptr->action_flags |= TIPC_WAIT_PEER_LINKS_DOWN;
434
435         /* Notify publications from this node */
436         n_ptr->action_flags |= TIPC_NOTIFY_NODE_DOWN;
437
438         /* Notify sockets connected to node */
439         list_for_each_entry_safe(conn, safe, conns, list) {
440                 skb = tipc_msg_create(TIPC_CRITICAL_IMPORTANCE, TIPC_CONN_MSG,
441                                       SHORT_H_SIZE, 0, tn->own_addr,
442                                       conn->peer_node, conn->port,
443                                       conn->peer_port, TIPC_ERR_NO_NODE);
444                 if (likely(skb)) {
445                         skb_queue_tail(n_ptr->inputq, skb);
446                         n_ptr->action_flags |= TIPC_MSG_EVT;
447                 }
448                 list_del(&conn->list);
449                 kfree(conn);
450         }
451 }
452
453 /**
454  * tipc_node_get_linkname - get the name of a link
455  *
456  * @bearer_id: id of the bearer
457  * @node: peer node address
458  * @linkname: link name output buffer
459  *
460  * Returns 0 on success
461  */
462 int tipc_node_get_linkname(struct net *net, u32 bearer_id, u32 addr,
463                            char *linkname, size_t len)
464 {
465         struct tipc_link *link;
466         int err = -EINVAL;
467         struct tipc_node *node = tipc_node_find(net, addr);
468
469         if (!node)
470                 return err;
471
472         if (bearer_id >= MAX_BEARERS)
473                 goto exit;
474
475         tipc_node_lock(node);
476         link = node->links[bearer_id].link;
477         if (link) {
478                 strncpy(linkname, link->name, len);
479                 err = 0;
480         }
481 exit:
482         tipc_node_unlock(node);
483         tipc_node_put(node);
484         return err;
485 }
486
487 void tipc_node_unlock(struct tipc_node *node)
488 {
489         struct net *net = node->net;
490         u32 addr = 0;
491         u32 flags = node->action_flags;
492         u32 link_id = 0;
493         struct list_head *publ_list;
494         struct sk_buff_head *inputq = node->inputq;
495         struct sk_buff_head *namedq;
496
497         if (likely(!flags || (flags == TIPC_MSG_EVT))) {
498                 node->action_flags = 0;
499                 spin_unlock_bh(&node->lock);
500                 if (flags == TIPC_MSG_EVT)
501                         tipc_sk_rcv(net, inputq);
502                 return;
503         }
504
505         addr = node->addr;
506         link_id = node->link_id;
507         namedq = node->namedq;
508         publ_list = &node->publ_list;
509
510         node->action_flags &= ~(TIPC_MSG_EVT |
511                                 TIPC_NOTIFY_NODE_DOWN | TIPC_NOTIFY_NODE_UP |
512                                 TIPC_NOTIFY_LINK_DOWN | TIPC_NOTIFY_LINK_UP |
513                                 TIPC_WAKEUP_BCAST_USERS | TIPC_BCAST_MSG_EVT |
514                                 TIPC_NAMED_MSG_EVT | TIPC_BCAST_RESET);
515
516         spin_unlock_bh(&node->lock);
517
518         if (flags & TIPC_NOTIFY_NODE_DOWN)
519                 tipc_publ_notify(net, publ_list, addr);
520
521         if (flags & TIPC_WAKEUP_BCAST_USERS)
522                 tipc_bclink_wakeup_users(net);
523
524         if (flags & TIPC_NOTIFY_NODE_UP)
525                 tipc_named_node_up(net, addr);
526
527         if (flags & TIPC_NOTIFY_LINK_UP)
528                 tipc_nametbl_publish(net, TIPC_LINK_STATE, addr, addr,
529                                      TIPC_NODE_SCOPE, link_id, addr);
530
531         if (flags & TIPC_NOTIFY_LINK_DOWN)
532                 tipc_nametbl_withdraw(net, TIPC_LINK_STATE, addr,
533                                       link_id, addr);
534
535         if (flags & TIPC_MSG_EVT)
536                 tipc_sk_rcv(net, inputq);
537
538         if (flags & TIPC_NAMED_MSG_EVT)
539                 tipc_named_rcv(net, namedq);
540
541         if (flags & TIPC_BCAST_MSG_EVT)
542                 tipc_bclink_input(net);
543
544         if (flags & TIPC_BCAST_RESET)
545                 tipc_link_reset_all(node);
546 }
547
548 /* Caller should hold node lock for the passed node */
549 static int __tipc_nl_add_node(struct tipc_nl_msg *msg, struct tipc_node *node)
550 {
551         void *hdr;
552         struct nlattr *attrs;
553
554         hdr = genlmsg_put(msg->skb, msg->portid, msg->seq, &tipc_genl_family,
555                           NLM_F_MULTI, TIPC_NL_NODE_GET);
556         if (!hdr)
557                 return -EMSGSIZE;
558
559         attrs = nla_nest_start(msg->skb, TIPC_NLA_NODE);
560         if (!attrs)
561                 goto msg_full;
562
563         if (nla_put_u32(msg->skb, TIPC_NLA_NODE_ADDR, node->addr))
564                 goto attr_msg_full;
565         if (tipc_node_is_up(node))
566                 if (nla_put_flag(msg->skb, TIPC_NLA_NODE_UP))
567                         goto attr_msg_full;
568
569         nla_nest_end(msg->skb, attrs);
570         genlmsg_end(msg->skb, hdr);
571
572         return 0;
573
574 attr_msg_full:
575         nla_nest_cancel(msg->skb, attrs);
576 msg_full:
577         genlmsg_cancel(msg->skb, hdr);
578
579         return -EMSGSIZE;
580 }
581
582 int tipc_nl_node_dump(struct sk_buff *skb, struct netlink_callback *cb)
583 {
584         int err;
585         struct net *net = sock_net(skb->sk);
586         struct tipc_net *tn = net_generic(net, tipc_net_id);
587         int done = cb->args[0];
588         int last_addr = cb->args[1];
589         struct tipc_node *node;
590         struct tipc_nl_msg msg;
591
592         if (done)
593                 return 0;
594
595         msg.skb = skb;
596         msg.portid = NETLINK_CB(cb->skb).portid;
597         msg.seq = cb->nlh->nlmsg_seq;
598
599         rcu_read_lock();
600         if (last_addr) {
601                 node = tipc_node_find(net, last_addr);
602                 if (!node) {
603                         rcu_read_unlock();
604                         /* We never set seq or call nl_dump_check_consistent()
605                          * this means that setting prev_seq here will cause the
606                          * consistence check to fail in the netlink callback
607                          * handler. Resulting in the NLMSG_DONE message having
608                          * the NLM_F_DUMP_INTR flag set if the node state
609                          * changed while we released the lock.
610                          */
611                         cb->prev_seq = 1;
612                         return -EPIPE;
613                 }
614                 tipc_node_put(node);
615         }
616
617         list_for_each_entry_rcu(node, &tn->node_list, list) {
618                 if (last_addr) {
619                         if (node->addr == last_addr)
620                                 last_addr = 0;
621                         else
622                                 continue;
623                 }
624
625                 tipc_node_lock(node);
626                 err = __tipc_nl_add_node(&msg, node);
627                 if (err) {
628                         last_addr = node->addr;
629                         tipc_node_unlock(node);
630                         goto out;
631                 }
632
633                 tipc_node_unlock(node);
634         }
635         done = 1;
636 out:
637         cb->args[0] = done;
638         cb->args[1] = last_addr;
639         rcu_read_unlock();
640
641         return skb->len;
642 }