1 /* Copyright 2011-2014 Autronica Fire and Security AS
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)
9 * 2011-2014 Arvid Brodin, arvid.brodin@alten.se
11 * Routines for handling Netlink messages for HSR.
14 #include "hsr_netlink.h"
15 #include <linux/kernel.h>
16 #include <net/rtnetlink.h>
17 #include <net/genetlink.h>
19 #include "hsr_device.h"
20 #include "hsr_framereg.h"
22 static const struct nla_policy hsr_policy[IFLA_HSR_MAX + 1] = {
23 [IFLA_HSR_SLAVE1] = { .type = NLA_U32 },
24 [IFLA_HSR_SLAVE2] = { .type = NLA_U32 },
25 [IFLA_HSR_MULTICAST_SPEC] = { .type = NLA_U8 },
26 [IFLA_HSR_VERSION] = { .type = NLA_U8 },
27 [IFLA_HSR_SUPERVISION_ADDR] = { .len = ETH_ALEN },
28 [IFLA_HSR_SEQ_NR] = { .type = NLA_U16 },
32 /* Here, it seems a netdevice has already been allocated for us, and the
33 * hsr_dev_setup routine has been executed. Nice!
35 static int hsr_newlink(struct net *src_net, struct net_device *dev,
36 struct nlattr *tb[], struct nlattr *data[],
37 struct netlink_ext_ack *extack)
39 struct net_device *link[2];
40 unsigned char multicast_spec, hsr_version;
43 netdev_info(dev, "HSR: No slave devices specified\n");
46 if (!data[IFLA_HSR_SLAVE1]) {
47 netdev_info(dev, "HSR: Slave1 device not specified\n");
50 link[0] = __dev_get_by_index(src_net, nla_get_u32(data[IFLA_HSR_SLAVE1]));
51 if (!data[IFLA_HSR_SLAVE2]) {
52 netdev_info(dev, "HSR: Slave2 device not specified\n");
55 link[1] = __dev_get_by_index(src_net, nla_get_u32(data[IFLA_HSR_SLAVE2]));
57 if (!link[0] || !link[1])
59 if (link[0] == link[1])
62 if (!data[IFLA_HSR_MULTICAST_SPEC])
65 multicast_spec = nla_get_u8(data[IFLA_HSR_MULTICAST_SPEC]);
67 if (!data[IFLA_HSR_VERSION]) {
70 hsr_version = nla_get_u8(data[IFLA_HSR_VERSION]);
71 if (hsr_version > 1) {
72 NL_SET_ERR_MSG_MOD(extack,
73 "Only versions 0..1 are supported");
78 return hsr_dev_finalize(dev, link, multicast_spec, hsr_version);
81 static int hsr_fill_info(struct sk_buff *skb, const struct net_device *dev)
84 struct hsr_port *port;
87 hsr = netdev_priv(dev);
92 port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_A);
94 res = nla_put_u32(skb, IFLA_HSR_SLAVE1, port->dev->ifindex);
100 port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_B);
102 res = nla_put_u32(skb, IFLA_HSR_SLAVE2, port->dev->ifindex);
105 goto nla_put_failure;
107 if (nla_put(skb, IFLA_HSR_SUPERVISION_ADDR, ETH_ALEN,
108 hsr->sup_multicast_addr) ||
109 nla_put_u16(skb, IFLA_HSR_SEQ_NR, hsr->sequence_nr))
110 goto nla_put_failure;
118 static struct rtnl_link_ops hsr_link_ops __read_mostly = {
120 .maxtype = IFLA_HSR_MAX,
121 .policy = hsr_policy,
122 .priv_size = sizeof(struct hsr_priv),
123 .setup = hsr_dev_setup,
124 .newlink = hsr_newlink,
125 .fill_info = hsr_fill_info,
130 /* attribute policy */
131 static const struct nla_policy hsr_genl_policy[HSR_A_MAX + 1] = {
132 [HSR_A_NODE_ADDR] = { .len = ETH_ALEN },
133 [HSR_A_NODE_ADDR_B] = { .len = ETH_ALEN },
134 [HSR_A_IFINDEX] = { .type = NLA_U32 },
135 [HSR_A_IF1_AGE] = { .type = NLA_U32 },
136 [HSR_A_IF2_AGE] = { .type = NLA_U32 },
137 [HSR_A_IF1_SEQ] = { .type = NLA_U16 },
138 [HSR_A_IF2_SEQ] = { .type = NLA_U16 },
141 static struct genl_family hsr_genl_family;
143 static const struct genl_multicast_group hsr_mcgrps[] = {
144 { .name = "hsr-network", },
149 /* This is called if for some node with MAC address addr, we only get frames
150 * over one of the slave interfaces. This would indicate an open network ring
151 * (i.e. a link has failed somewhere).
153 void hsr_nl_ringerror(struct hsr_priv *hsr, unsigned char addr[ETH_ALEN],
154 struct hsr_port *port)
158 struct hsr_port *master;
161 skb = genlmsg_new(NLMSG_GOODSIZE, GFP_ATOMIC);
165 msg_head = genlmsg_put(skb, 0, 0, &hsr_genl_family, 0, HSR_C_RING_ERROR);
167 goto nla_put_failure;
169 res = nla_put(skb, HSR_A_NODE_ADDR, ETH_ALEN, addr);
171 goto nla_put_failure;
173 res = nla_put_u32(skb, HSR_A_IFINDEX, port->dev->ifindex);
175 goto nla_put_failure;
177 genlmsg_end(skb, msg_head);
178 genlmsg_multicast(&hsr_genl_family, skb, 0, 0, GFP_ATOMIC);
187 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
188 netdev_warn(master->dev, "Could not send HSR ring error message\n");
192 /* This is called when we haven't heard from the node with MAC address addr for
193 * some time (just before the node is removed from the node table/list).
195 void hsr_nl_nodedown(struct hsr_priv *hsr, unsigned char addr[ETH_ALEN])
199 struct hsr_port *master;
202 skb = genlmsg_new(NLMSG_GOODSIZE, GFP_ATOMIC);
206 msg_head = genlmsg_put(skb, 0, 0, &hsr_genl_family, 0, HSR_C_NODE_DOWN);
208 goto nla_put_failure;
211 res = nla_put(skb, HSR_A_NODE_ADDR, ETH_ALEN, addr);
213 goto nla_put_failure;
215 genlmsg_end(skb, msg_head);
216 genlmsg_multicast(&hsr_genl_family, skb, 0, 0, GFP_ATOMIC);
225 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
226 netdev_warn(master->dev, "Could not send HSR node down\n");
231 /* HSR_C_GET_NODE_STATUS lets userspace query the internal HSR node table
232 * about the status of a specific node in the network, defined by its MAC
235 * Input: hsr ifindex, node mac address
236 * Output: hsr ifindex, node mac address (copied from request),
237 * age of latest frame from node over slave 1, slave 2 [ms]
239 static int hsr_get_node_status(struct sk_buff *skb_in, struct genl_info *info)
243 struct net_device *hsr_dev;
246 struct sk_buff *skb_out;
248 struct hsr_priv *hsr;
249 struct hsr_port *port;
250 unsigned char hsr_node_addr_b[ETH_ALEN];
251 int hsr_node_if1_age;
252 u16 hsr_node_if1_seq;
253 int hsr_node_if2_age;
254 u16 hsr_node_if2_seq;
261 na = info->attrs[HSR_A_IFINDEX];
264 na = info->attrs[HSR_A_NODE_ADDR];
269 hsr_dev = dev_get_by_index_rcu(genl_info_net(info),
270 nla_get_u32(info->attrs[HSR_A_IFINDEX]));
273 if (!is_hsr_master(hsr_dev))
277 skb_out = genlmsg_new(NLMSG_GOODSIZE, GFP_ATOMIC);
283 msg_head = genlmsg_put(skb_out, NETLINK_CB(skb_in).portid,
284 info->snd_seq, &hsr_genl_family, 0,
285 HSR_C_SET_NODE_STATUS);
288 goto nla_put_failure;
291 res = nla_put_u32(skb_out, HSR_A_IFINDEX, hsr_dev->ifindex);
293 goto nla_put_failure;
295 hsr = netdev_priv(hsr_dev);
296 res = hsr_get_node_data(hsr,
297 (unsigned char *) nla_data(info->attrs[HSR_A_NODE_ADDR]),
305 goto nla_put_failure;
307 res = nla_put(skb_out, HSR_A_NODE_ADDR, ETH_ALEN,
308 nla_data(info->attrs[HSR_A_NODE_ADDR]));
310 goto nla_put_failure;
312 if (addr_b_ifindex > -1) {
313 res = nla_put(skb_out, HSR_A_NODE_ADDR_B, ETH_ALEN,
316 goto nla_put_failure;
318 res = nla_put_u32(skb_out, HSR_A_ADDR_B_IFINDEX, addr_b_ifindex);
320 goto nla_put_failure;
323 res = nla_put_u32(skb_out, HSR_A_IF1_AGE, hsr_node_if1_age);
325 goto nla_put_failure;
326 res = nla_put_u16(skb_out, HSR_A_IF1_SEQ, hsr_node_if1_seq);
328 goto nla_put_failure;
329 port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_A);
331 res = nla_put_u32(skb_out, HSR_A_IF1_IFINDEX,
334 goto nla_put_failure;
336 res = nla_put_u32(skb_out, HSR_A_IF2_AGE, hsr_node_if2_age);
338 goto nla_put_failure;
339 res = nla_put_u16(skb_out, HSR_A_IF2_SEQ, hsr_node_if2_seq);
341 goto nla_put_failure;
342 port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_B);
344 res = nla_put_u32(skb_out, HSR_A_IF2_IFINDEX,
347 goto nla_put_failure;
351 genlmsg_end(skb_out, msg_head);
352 genlmsg_unicast(genl_info_net(info), skb_out, info->snd_portid);
359 netlink_ack(skb_in, nlmsg_hdr(skb_in), -EINVAL, NULL);
371 /* Get a list of MacAddressA of all nodes known to this node (including self).
373 static int hsr_get_node_list(struct sk_buff *skb_in, struct genl_info *info)
375 unsigned char addr[ETH_ALEN];
376 struct net_device *hsr_dev;
377 struct sk_buff *skb_out;
378 struct hsr_priv *hsr;
379 bool restart = false;
388 na = info->attrs[HSR_A_IFINDEX];
393 hsr_dev = dev_get_by_index_rcu(genl_info_net(info),
394 nla_get_u32(info->attrs[HSR_A_IFINDEX]));
397 if (!is_hsr_master(hsr_dev))
402 skb_out = genlmsg_new(GENLMSG_DEFAULT_SIZE, GFP_ATOMIC);
408 msg_head = genlmsg_put(skb_out, NETLINK_CB(skb_in).portid,
409 info->snd_seq, &hsr_genl_family, 0,
410 HSR_C_SET_NODE_LIST);
413 goto nla_put_failure;
417 res = nla_put_u32(skb_out, HSR_A_IFINDEX, hsr_dev->ifindex);
419 goto nla_put_failure;
422 hsr = netdev_priv(hsr_dev);
425 pos = hsr_get_next_node(hsr, NULL, addr);
427 res = nla_put(skb_out, HSR_A_NODE_ADDR, ETH_ALEN, addr);
429 if (res == -EMSGSIZE) {
430 genlmsg_end(skb_out, msg_head);
431 genlmsg_unicast(genl_info_net(info), skb_out,
436 goto nla_put_failure;
438 pos = hsr_get_next_node(hsr, pos, addr);
442 genlmsg_end(skb_out, msg_head);
443 genlmsg_unicast(genl_info_net(info), skb_out, info->snd_portid);
450 netlink_ack(skb_in, nlmsg_hdr(skb_in), -EINVAL, NULL);
463 static const struct genl_ops hsr_ops[] = {
465 .cmd = HSR_C_GET_NODE_STATUS,
467 .policy = hsr_genl_policy,
468 .doit = hsr_get_node_status,
472 .cmd = HSR_C_GET_NODE_LIST,
474 .policy = hsr_genl_policy,
475 .doit = hsr_get_node_list,
480 static struct genl_family hsr_genl_family __ro_after_init = {
484 .maxattr = HSR_A_MAX,
486 .module = THIS_MODULE,
488 .n_ops = ARRAY_SIZE(hsr_ops),
489 .mcgrps = hsr_mcgrps,
490 .n_mcgrps = ARRAY_SIZE(hsr_mcgrps),
493 int __init hsr_netlink_init(void)
497 rc = rtnl_link_register(&hsr_link_ops);
499 goto fail_rtnl_link_register;
501 rc = genl_register_family(&hsr_genl_family);
503 goto fail_genl_register_family;
507 fail_genl_register_family:
508 rtnl_link_unregister(&hsr_link_ops);
509 fail_rtnl_link_register:
514 void __exit hsr_netlink_exit(void)
516 genl_unregister_family(&hsr_genl_family);
517 rtnl_link_unregister(&hsr_link_ops);
520 MODULE_ALIAS_RTNL_LINK("hsr");