Merge branch 'for-4.14-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/tj/wq
[GitHub/moto-9609/android_kernel_motorola_exynos9610.git] / net / hsr / hsr_framereg.c
CommitLineData
70ebe4a4 1/* Copyright 2011-2014 Autronica Fire and Security AS
f421436a
AB
2 *
3 * This program is free software; you can redistribute it and/or modify it
4 * under the terms of the GNU General Public License as published by the Free
5 * Software Foundation; either version 2 of the License, or (at your option)
6 * any later version.
7 *
8 * Author(s):
70ebe4a4 9 * 2011-2014 Arvid Brodin, arvid.brodin@alten.se
f421436a
AB
10 *
11 * The HSR spec says never to forward the same frame twice on the same
12 * interface. A frame is identified by its source MAC address and its HSR
13 * sequence number. This code keeps track of senders and their sequence numbers
14 * to allow filtering of duplicate frames, and to detect HSR ring errors.
15 */
16
17#include <linux/if_ether.h>
18#include <linux/etherdevice.h>
19#include <linux/slab.h>
20#include <linux/rculist.h>
21#include "hsr_main.h"
22#include "hsr_framereg.h"
23#include "hsr_netlink.h"
24
25
70ebe4a4
AB
26struct hsr_node {
27 struct list_head mac_list;
28 unsigned char MacAddressA[ETH_ALEN];
29 unsigned char MacAddressB[ETH_ALEN];
c5a75911
AB
30 /* Local slave through which AddrB frames are received from this node */
31 enum hsr_port_type AddrB_port;
32 unsigned long time_in[HSR_PT_PORTS];
33 bool time_in_stale[HSR_PT_PORTS];
34 u16 seq_out[HSR_PT_PORTS];
70ebe4a4 35 struct rcu_head rcu_head;
f421436a
AB
36};
37
f421436a 38
f266a683 39/* TODO: use hash lists for mac addresses (linux/jhash.h)? */
f421436a
AB
40
41
f266a683
AB
42/* seq_nr_after(a, b) - return true if a is after (higher in sequence than) b,
43 * false otherwise.
f421436a 44 */
f266a683 45static bool seq_nr_after(u16 a, u16 b)
f421436a 46{
f266a683
AB
47 /* Remove inconsistency where
48 * seq_nr_after(a, b) == seq_nr_before(a, b)
49 */
50 if ((int) b - a == 32768)
51 return false;
f421436a 52
f266a683 53 return (((s16) (b - a)) < 0);
f421436a 54}
f266a683
AB
55#define seq_nr_before(a, b) seq_nr_after((b), (a))
56#define seq_nr_after_or_eq(a, b) (!seq_nr_before((a), (b)))
57#define seq_nr_before_or_eq(a, b) (!seq_nr_after((a), (b)))
f421436a
AB
58
59
f266a683 60bool hsr_addr_is_self(struct hsr_priv *hsr, unsigned char *addr)
f421436a 61{
70ebe4a4 62 struct hsr_node *node;
f421436a 63
f266a683
AB
64 node = list_first_or_null_rcu(&hsr->self_node_db, struct hsr_node,
65 mac_list);
66 if (!node) {
67 WARN_ONCE(1, "HSR: No self node\n");
68 return false;
f421436a
AB
69 }
70
f266a683
AB
71 if (ether_addr_equal(addr, node->MacAddressA))
72 return true;
73 if (ether_addr_equal(addr, node->MacAddressB))
74 return true;
f421436a 75
f266a683
AB
76 return false;
77}
f421436a
AB
78
79/* Search for mac entry. Caller must hold rcu read lock.
80 */
f266a683
AB
81static struct hsr_node *find_node_by_AddrA(struct list_head *node_db,
82 const unsigned char addr[ETH_ALEN])
f421436a 83{
70ebe4a4 84 struct hsr_node *node;
f421436a
AB
85
86 list_for_each_entry_rcu(node, node_db, mac_list) {
f266a683 87 if (ether_addr_equal(node->MacAddressA, addr))
f421436a
AB
88 return node;
89 }
90
91 return NULL;
92}
93
94
95/* Helper for device init; the self_node_db is used in hsr_rcv() to recognize
96 * frames from self that's been looped over the HSR ring.
97 */
98int hsr_create_self_node(struct list_head *self_node_db,
99 unsigned char addr_a[ETH_ALEN],
100 unsigned char addr_b[ETH_ALEN])
101{
70ebe4a4 102 struct hsr_node *node, *oldnode;
f421436a
AB
103
104 node = kmalloc(sizeof(*node), GFP_KERNEL);
105 if (!node)
106 return -ENOMEM;
107
e83abe37
JP
108 ether_addr_copy(node->MacAddressA, addr_a);
109 ether_addr_copy(node->MacAddressB, addr_b);
f421436a
AB
110
111 rcu_read_lock();
112 oldnode = list_first_or_null_rcu(self_node_db,
70ebe4a4 113 struct hsr_node, mac_list);
f421436a
AB
114 if (oldnode) {
115 list_replace_rcu(&oldnode->mac_list, &node->mac_list);
116 rcu_read_unlock();
117 synchronize_rcu();
118 kfree(oldnode);
119 } else {
120 rcu_read_unlock();
121 list_add_tail_rcu(&node->mac_list, self_node_db);
122 }
123
124 return 0;
125}
126
f421436a 127
f266a683
AB
128/* Allocate an hsr_node and add it to node_db. 'addr' is the node's AddressA;
129 * seq_out is used to initialize filtering of outgoing duplicate frames
130 * originating from the newly added node.
f421436a 131 */
f266a683
AB
132struct hsr_node *hsr_add_node(struct list_head *node_db, unsigned char addr[],
133 u16 seq_out)
f421436a 134{
f266a683 135 struct hsr_node *node;
f421436a 136 unsigned long now;
f266a683 137 int i;
f421436a
AB
138
139 node = kzalloc(sizeof(*node), GFP_ATOMIC);
140 if (!node)
141 return NULL;
142
f266a683 143 ether_addr_copy(node->MacAddressA, addr);
f421436a
AB
144
145 /* We are only interested in time diffs here, so use current jiffies
146 * as initialization. (0 could trigger an spurious ring error warning).
147 */
148 now = jiffies;
c5a75911 149 for (i = 0; i < HSR_PT_PORTS; i++)
f421436a 150 node->time_in[i] = now;
c5a75911 151 for (i = 0; i < HSR_PT_PORTS; i++)
f266a683 152 node->seq_out[i] = seq_out;
f421436a 153
f266a683 154 list_add_tail_rcu(&node->mac_list, node_db);
f421436a
AB
155
156 return node;
157}
158
f266a683
AB
159/* Get the hsr_node from which 'skb' was sent.
160 */
675c8da0 161struct hsr_node *hsr_get_node(struct hsr_port *port, struct sk_buff *skb,
f266a683
AB
162 bool is_sup)
163{
675c8da0 164 struct list_head *node_db = &port->hsr->node_db;
f266a683
AB
165 struct hsr_node *node;
166 struct ethhdr *ethhdr;
167 u16 seq_out;
168
169 if (!skb_mac_header_was_set(skb))
170 return NULL;
171
172 ethhdr = (struct ethhdr *) skb_mac_header(skb);
173
174 list_for_each_entry_rcu(node, node_db, mac_list) {
175 if (ether_addr_equal(node->MacAddressA, ethhdr->h_source))
176 return node;
177 if (ether_addr_equal(node->MacAddressB, ethhdr->h_source))
178 return node;
179 }
180
ee1c2797 181 /* Everyone may create a node entry, connected node to a HSR device. */
f266a683 182
ee1c2797
PH
183 if (ethhdr->h_proto == htons(ETH_P_PRP)
184 || ethhdr->h_proto == htons(ETH_P_HSR)) {
f266a683
AB
185 /* Use the existing sequence_nr from the tag as starting point
186 * for filtering duplicate frames.
187 */
188 seq_out = hsr_get_skb_sequence_nr(skb) - 1;
189 } else {
675c8da0
KM
190 /* this is called also for frames from master port and
191 * so warn only for non master ports
192 */
193 if (port->type != HSR_PT_MASTER)
194 WARN_ONCE(1, "%s: Non-HSR frame\n", __func__);
ee1c2797 195 seq_out = HSR_SEQNR_START;
f266a683
AB
196 }
197
198 return hsr_add_node(node_db, ethhdr->h_source, seq_out);
199}
200
201/* Use the Supervision frame's info about an eventual MacAddressB for merging
202 * nodes that has previously had their MacAddressB registered as a separate
203 * node.
204 */
205void hsr_handle_sup_frame(struct sk_buff *skb, struct hsr_node *node_curr,
206 struct hsr_port *port_rcv)
207{
ee1c2797 208 struct ethhdr *ethhdr;
f266a683
AB
209 struct hsr_node *node_real;
210 struct hsr_sup_payload *hsr_sp;
211 struct list_head *node_db;
212 int i;
213
ee1c2797 214 ethhdr = (struct ethhdr *) skb_mac_header(skb);
f266a683 215
ee1c2797
PH
216 /* Leave the ethernet header. */
217 skb_pull(skb, sizeof(struct ethhdr));
218
219 /* And leave the HSR tag. */
220 if (ethhdr->h_proto == htons(ETH_P_HSR))
221 skb_pull(skb, sizeof(struct hsr_tag));
222
223 /* And leave the HSR sup tag. */
224 skb_pull(skb, sizeof(struct hsr_sup_tag));
225
226 hsr_sp = (struct hsr_sup_payload *) skb->data;
f266a683
AB
227
228 /* Merge node_curr (registered on MacAddressB) into node_real */
229 node_db = &port_rcv->hsr->node_db;
230 node_real = find_node_by_AddrA(node_db, hsr_sp->MacAddressA);
231 if (!node_real)
232 /* No frame received from AddrA of this node yet */
233 node_real = hsr_add_node(node_db, hsr_sp->MacAddressA,
234 HSR_SEQNR_START - 1);
235 if (!node_real)
236 goto done; /* No mem */
237 if (node_real == node_curr)
238 /* Node has already been merged */
239 goto done;
240
ee1c2797 241 ether_addr_copy(node_real->MacAddressB, ethhdr->h_source);
f266a683
AB
242 for (i = 0; i < HSR_PT_PORTS; i++) {
243 if (!node_curr->time_in_stale[i] &&
244 time_after(node_curr->time_in[i], node_real->time_in[i])) {
245 node_real->time_in[i] = node_curr->time_in[i];
246 node_real->time_in_stale[i] = node_curr->time_in_stale[i];
247 }
248 if (seq_nr_after(node_curr->seq_out[i], node_real->seq_out[i]))
249 node_real->seq_out[i] = node_curr->seq_out[i];
250 }
251 node_real->AddrB_port = port_rcv->type;
252
253 list_del_rcu(&node_curr->mac_list);
254 kfree_rcu(node_curr, rcu_head);
255
256done:
ee1c2797 257 skb_push(skb, sizeof(struct hsrv1_ethhdr_sp));
f266a683
AB
258}
259
f421436a
AB
260
261/* 'skb' is a frame meant for this host, that is to be passed to upper layers.
262 *
f266a683 263 * If the frame was sent by a node's B interface, replace the source
f421436a
AB
264 * address with that node's "official" address (MacAddressA) so that upper
265 * layers recognize where it came from.
266 */
f266a683 267void hsr_addr_subst_source(struct hsr_node *node, struct sk_buff *skb)
f421436a 268{
f421436a
AB
269 if (!skb_mac_header_was_set(skb)) {
270 WARN_ONCE(1, "%s: Mac header not set\n", __func__);
271 return;
272 }
f421436a 273
f266a683 274 memcpy(&eth_hdr(skb)->h_source, node->MacAddressA, ETH_ALEN);
f421436a
AB
275}
276
f421436a 277/* 'skb' is a frame meant for another host.
f266a683 278 * 'port' is the outgoing interface
f421436a
AB
279 *
280 * Substitute the target (dest) MAC address if necessary, so the it matches the
281 * recipient interface MAC address, regardless of whether that is the
282 * recipient's A or B interface.
283 * This is needed to keep the packets flowing through switches that learn on
284 * which "side" the different interfaces are.
285 */
f266a683 286void hsr_addr_subst_dest(struct hsr_node *node_src, struct sk_buff *skb,
c5a75911 287 struct hsr_port *port)
f421436a 288{
f266a683 289 struct hsr_node *node_dst;
f421436a 290
f266a683
AB
291 if (!skb_mac_header_was_set(skb)) {
292 WARN_ONCE(1, "%s: Mac header not set\n", __func__);
293 return;
294 }
f421436a 295
f266a683
AB
296 if (!is_unicast_ether_addr(eth_hdr(skb)->h_dest))
297 return;
f421436a 298
f266a683
AB
299 node_dst = find_node_by_AddrA(&port->hsr->node_db, eth_hdr(skb)->h_dest);
300 if (!node_dst) {
301 WARN_ONCE(1, "%s: Unknown node\n", __func__);
302 return;
303 }
304 if (port->type != node_dst->AddrB_port)
305 return;
f421436a 306
f266a683 307 ether_addr_copy(eth_hdr(skb)->h_dest, node_dst->MacAddressB);
f421436a 308}
f421436a
AB
309
310
f266a683
AB
311void hsr_register_frame_in(struct hsr_node *node, struct hsr_port *port,
312 u16 sequence_nr)
f421436a 313{
f266a683
AB
314 /* Don't register incoming frames without a valid sequence number. This
315 * ensures entries of restarted nodes gets pruned so that they can
316 * re-register and resume communications.
317 */
318 if (seq_nr_before(sequence_nr, node->seq_out[port->type]))
319 return;
320
c5a75911
AB
321 node->time_in[port->type] = jiffies;
322 node->time_in_stale[port->type] = false;
f421436a
AB
323}
324
f421436a
AB
325/* 'skb' is a HSR Ethernet frame (with a HSR tag inserted), with a valid
326 * ethhdr->h_source address and skb->mac_header set.
327 *
328 * Return:
329 * 1 if frame can be shown to have been sent recently on this interface,
330 * 0 otherwise, or
331 * negative error code on error
332 */
f266a683
AB
333int hsr_register_frame_out(struct hsr_port *port, struct hsr_node *node,
334 u16 sequence_nr)
f421436a 335{
c5a75911 336 if (seq_nr_before_or_eq(sequence_nr, node->seq_out[port->type]))
f421436a
AB
337 return 1;
338
c5a75911 339 node->seq_out[port->type] = sequence_nr;
f421436a
AB
340 return 0;
341}
342
343
c5a75911
AB
344static struct hsr_port *get_late_port(struct hsr_priv *hsr,
345 struct hsr_node *node)
f421436a 346{
c5a75911
AB
347 if (node->time_in_stale[HSR_PT_SLAVE_A])
348 return hsr_port_get_hsr(hsr, HSR_PT_SLAVE_A);
349 if (node->time_in_stale[HSR_PT_SLAVE_B])
350 return hsr_port_get_hsr(hsr, HSR_PT_SLAVE_B);
351
352 if (time_after(node->time_in[HSR_PT_SLAVE_B],
353 node->time_in[HSR_PT_SLAVE_A] +
354 msecs_to_jiffies(MAX_SLAVE_DIFF)))
355 return hsr_port_get_hsr(hsr, HSR_PT_SLAVE_A);
356 if (time_after(node->time_in[HSR_PT_SLAVE_A],
357 node->time_in[HSR_PT_SLAVE_B] +
358 msecs_to_jiffies(MAX_SLAVE_DIFF)))
359 return hsr_port_get_hsr(hsr, HSR_PT_SLAVE_B);
f421436a 360
c5a75911 361 return NULL;
f421436a
AB
362}
363
364
365/* Remove stale sequence_nr records. Called by timer every
366 * HSR_LIFE_CHECK_INTERVAL (two seconds or so).
367 */
abff7162 368void hsr_prune_nodes(unsigned long data)
f421436a 369{
abff7162 370 struct hsr_priv *hsr;
70ebe4a4 371 struct hsr_node *node;
c5a75911 372 struct hsr_port *port;
f421436a
AB
373 unsigned long timestamp;
374 unsigned long time_a, time_b;
375
abff7162
AB
376 hsr = (struct hsr_priv *) data;
377
f421436a 378 rcu_read_lock();
70ebe4a4 379 list_for_each_entry_rcu(node, &hsr->node_db, mac_list) {
f421436a 380 /* Shorthand */
c5a75911
AB
381 time_a = node->time_in[HSR_PT_SLAVE_A];
382 time_b = node->time_in[HSR_PT_SLAVE_B];
f421436a
AB
383
384 /* Check for timestamps old enough to risk wrap-around */
385 if (time_after(jiffies, time_a + MAX_JIFFY_OFFSET/2))
c5a75911 386 node->time_in_stale[HSR_PT_SLAVE_A] = true;
f421436a 387 if (time_after(jiffies, time_b + MAX_JIFFY_OFFSET/2))
c5a75911 388 node->time_in_stale[HSR_PT_SLAVE_B] = true;
f421436a
AB
389
390 /* Get age of newest frame from node.
391 * At least one time_in is OK here; nodes get pruned long
392 * before both time_ins can get stale
393 */
394 timestamp = time_a;
c5a75911
AB
395 if (node->time_in_stale[HSR_PT_SLAVE_A] ||
396 (!node->time_in_stale[HSR_PT_SLAVE_B] &&
f421436a
AB
397 time_after(time_b, time_a)))
398 timestamp = time_b;
399
400 /* Warn of ring error only as long as we get frames at all */
401 if (time_is_after_jiffies(timestamp +
402 msecs_to_jiffies(1.5*MAX_SLAVE_DIFF))) {
c5a75911
AB
403 rcu_read_lock();
404 port = get_late_port(hsr, node);
405 if (port != NULL)
406 hsr_nl_ringerror(hsr, node->MacAddressA, port);
407 rcu_read_unlock();
f421436a
AB
408 }
409
410 /* Prune old entries */
411 if (time_is_before_jiffies(timestamp +
412 msecs_to_jiffies(HSR_NODE_FORGET_TIME))) {
70ebe4a4 413 hsr_nl_nodedown(hsr, node->MacAddressA);
f421436a
AB
414 list_del_rcu(&node->mac_list);
415 /* Note that we need to free this entry later: */
1aee6cc2 416 kfree_rcu(node, rcu_head);
f421436a
AB
417 }
418 }
419 rcu_read_unlock();
420}
421
422
70ebe4a4 423void *hsr_get_next_node(struct hsr_priv *hsr, void *_pos,
f421436a
AB
424 unsigned char addr[ETH_ALEN])
425{
70ebe4a4 426 struct hsr_node *node;
f421436a
AB
427
428 if (!_pos) {
70ebe4a4
AB
429 node = list_first_or_null_rcu(&hsr->node_db,
430 struct hsr_node, mac_list);
f421436a 431 if (node)
e83abe37 432 ether_addr_copy(addr, node->MacAddressA);
f421436a
AB
433 return node;
434 }
435
436 node = _pos;
70ebe4a4 437 list_for_each_entry_continue_rcu(node, &hsr->node_db, mac_list) {
e83abe37 438 ether_addr_copy(addr, node->MacAddressA);
f421436a
AB
439 return node;
440 }
441
442 return NULL;
443}
444
445
70ebe4a4 446int hsr_get_node_data(struct hsr_priv *hsr,
f421436a
AB
447 const unsigned char *addr,
448 unsigned char addr_b[ETH_ALEN],
449 unsigned int *addr_b_ifindex,
450 int *if1_age,
451 u16 *if1_seq,
452 int *if2_age,
453 u16 *if2_seq)
454{
70ebe4a4 455 struct hsr_node *node;
c5a75911 456 struct hsr_port *port;
f421436a
AB
457 unsigned long tdiff;
458
459
460 rcu_read_lock();
70ebe4a4 461 node = find_node_by_AddrA(&hsr->node_db, addr);
f421436a
AB
462 if (!node) {
463 rcu_read_unlock();
464 return -ENOENT; /* No such entry */
465 }
466
e83abe37 467 ether_addr_copy(addr_b, node->MacAddressB);
f421436a 468
c5a75911
AB
469 tdiff = jiffies - node->time_in[HSR_PT_SLAVE_A];
470 if (node->time_in_stale[HSR_PT_SLAVE_A])
f421436a
AB
471 *if1_age = INT_MAX;
472#if HZ <= MSEC_PER_SEC
473 else if (tdiff > msecs_to_jiffies(INT_MAX))
474 *if1_age = INT_MAX;
475#endif
476 else
477 *if1_age = jiffies_to_msecs(tdiff);
478
c5a75911
AB
479 tdiff = jiffies - node->time_in[HSR_PT_SLAVE_B];
480 if (node->time_in_stale[HSR_PT_SLAVE_B])
f421436a
AB
481 *if2_age = INT_MAX;
482#if HZ <= MSEC_PER_SEC
483 else if (tdiff > msecs_to_jiffies(INT_MAX))
484 *if2_age = INT_MAX;
485#endif
486 else
487 *if2_age = jiffies_to_msecs(tdiff);
488
489 /* Present sequence numbers as if they were incoming on interface */
c5a75911
AB
490 *if1_seq = node->seq_out[HSR_PT_SLAVE_B];
491 *if2_seq = node->seq_out[HSR_PT_SLAVE_A];
f421436a 492
c5a75911
AB
493 if (node->AddrB_port != HSR_PT_NONE) {
494 port = hsr_port_get_hsr(hsr, node->AddrB_port);
495 *addr_b_ifindex = port->dev->ifindex;
496 } else {
f421436a 497 *addr_b_ifindex = -1;
c5a75911 498 }
f421436a
AB
499
500 rcu_read_unlock();
501
502 return 0;
503}