1 /* Copyright (C) 2016-2017 B.A.T.M.A.N. contributors:
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of version 2 of the GNU General Public
7 * License as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 #include <linux/atomic.h>
22 #include <linux/byteorder/generic.h>
23 #include <linux/cache.h>
24 #include <linux/errno.h>
25 #include <linux/export.h>
27 #include <linux/genetlink.h>
28 #include <linux/if_ether.h>
29 #include <linux/init.h>
30 #include <linux/kernel.h>
31 #include <linux/netdevice.h>
32 #include <linux/netlink.h>
33 #include <linux/printk.h>
34 #include <linux/rculist.h>
35 #include <linux/rcupdate.h>
36 #include <linux/skbuff.h>
37 #include <linux/stddef.h>
38 #include <linux/types.h>
39 #include <net/genetlink.h>
40 #include <net/netlink.h>
42 #include <uapi/linux/batman_adv.h>
45 #include "bridge_loop_avoidance.h"
46 #include "gateway_client.h"
47 #include "hard-interface.h"
48 #include "originator.h"
50 #include "soft-interface.h"
52 #include "translation-table.h"
54 struct genl_family batadv_netlink_family
;
56 /* multicast groups */
57 enum batadv_netlink_multicast_groups
{
58 BATADV_NL_MCGRP_TPMETER
,
61 static const struct genl_multicast_group batadv_netlink_mcgrps
[] = {
62 [BATADV_NL_MCGRP_TPMETER
] = { .name
= BATADV_NL_MCAST_GROUP_TPMETER
},
65 static const struct nla_policy batadv_netlink_policy
[NUM_BATADV_ATTR
] = {
66 [BATADV_ATTR_VERSION
] = { .type
= NLA_STRING
},
67 [BATADV_ATTR_ALGO_NAME
] = { .type
= NLA_STRING
},
68 [BATADV_ATTR_MESH_IFINDEX
] = { .type
= NLA_U32
},
69 [BATADV_ATTR_MESH_IFNAME
] = { .type
= NLA_STRING
},
70 [BATADV_ATTR_MESH_ADDRESS
] = { .len
= ETH_ALEN
},
71 [BATADV_ATTR_HARD_IFINDEX
] = { .type
= NLA_U32
},
72 [BATADV_ATTR_HARD_IFNAME
] = { .type
= NLA_STRING
},
73 [BATADV_ATTR_HARD_ADDRESS
] = { .len
= ETH_ALEN
},
74 [BATADV_ATTR_ORIG_ADDRESS
] = { .len
= ETH_ALEN
},
75 [BATADV_ATTR_TPMETER_RESULT
] = { .type
= NLA_U8
},
76 [BATADV_ATTR_TPMETER_TEST_TIME
] = { .type
= NLA_U32
},
77 [BATADV_ATTR_TPMETER_BYTES
] = { .type
= NLA_U64
},
78 [BATADV_ATTR_TPMETER_COOKIE
] = { .type
= NLA_U32
},
79 [BATADV_ATTR_ACTIVE
] = { .type
= NLA_FLAG
},
80 [BATADV_ATTR_TT_ADDRESS
] = { .len
= ETH_ALEN
},
81 [BATADV_ATTR_TT_TTVN
] = { .type
= NLA_U8
},
82 [BATADV_ATTR_TT_LAST_TTVN
] = { .type
= NLA_U8
},
83 [BATADV_ATTR_TT_CRC32
] = { .type
= NLA_U32
},
84 [BATADV_ATTR_TT_VID
] = { .type
= NLA_U16
},
85 [BATADV_ATTR_TT_FLAGS
] = { .type
= NLA_U32
},
86 [BATADV_ATTR_FLAG_BEST
] = { .type
= NLA_FLAG
},
87 [BATADV_ATTR_LAST_SEEN_MSECS
] = { .type
= NLA_U32
},
88 [BATADV_ATTR_NEIGH_ADDRESS
] = { .len
= ETH_ALEN
},
89 [BATADV_ATTR_TQ
] = { .type
= NLA_U8
},
90 [BATADV_ATTR_THROUGHPUT
] = { .type
= NLA_U32
},
91 [BATADV_ATTR_BANDWIDTH_UP
] = { .type
= NLA_U32
},
92 [BATADV_ATTR_BANDWIDTH_DOWN
] = { .type
= NLA_U32
},
93 [BATADV_ATTR_ROUTER
] = { .len
= ETH_ALEN
},
94 [BATADV_ATTR_BLA_OWN
] = { .type
= NLA_FLAG
},
95 [BATADV_ATTR_BLA_ADDRESS
] = { .len
= ETH_ALEN
},
96 [BATADV_ATTR_BLA_VID
] = { .type
= NLA_U16
},
97 [BATADV_ATTR_BLA_BACKBONE
] = { .len
= ETH_ALEN
},
98 [BATADV_ATTR_BLA_CRC
] = { .type
= NLA_U16
},
102 * batadv_netlink_get_ifindex - Extract an interface index from a message
103 * @nlh: Message header
104 * @attrtype: Attribute which holds an interface index
106 * Return: interface index, or 0.
109 batadv_netlink_get_ifindex(const struct nlmsghdr
*nlh
, int attrtype
)
111 struct nlattr
*attr
= nlmsg_find_attr(nlh
, GENL_HDRLEN
, attrtype
);
113 return attr
? nla_get_u32(attr
) : 0;
117 * batadv_netlink_mesh_info_put - fill in generic information about mesh
119 * @msg: netlink message to be sent back
120 * @soft_iface: interface for which the data should be taken
122 * Return: 0 on success, < 0 on error
125 batadv_netlink_mesh_info_put(struct sk_buff
*msg
, struct net_device
*soft_iface
)
127 struct batadv_priv
*bat_priv
= netdev_priv(soft_iface
);
128 struct batadv_hard_iface
*primary_if
= NULL
;
129 struct net_device
*hard_iface
;
132 if (nla_put_string(msg
, BATADV_ATTR_VERSION
, BATADV_SOURCE_VERSION
) ||
133 nla_put_string(msg
, BATADV_ATTR_ALGO_NAME
,
134 bat_priv
->algo_ops
->name
) ||
135 nla_put_u32(msg
, BATADV_ATTR_MESH_IFINDEX
, soft_iface
->ifindex
) ||
136 nla_put_string(msg
, BATADV_ATTR_MESH_IFNAME
, soft_iface
->name
) ||
137 nla_put(msg
, BATADV_ATTR_MESH_ADDRESS
, ETH_ALEN
,
138 soft_iface
->dev_addr
) ||
139 nla_put_u8(msg
, BATADV_ATTR_TT_TTVN
,
140 (u8
)atomic_read(&bat_priv
->tt
.vn
)))
143 #ifdef CONFIG_BATMAN_ADV_BLA
144 if (nla_put_u16(msg
, BATADV_ATTR_BLA_CRC
,
145 ntohs(bat_priv
->bla
.claim_dest
.group
)))
149 primary_if
= batadv_primary_if_get_selected(bat_priv
);
150 if (primary_if
&& primary_if
->if_status
== BATADV_IF_ACTIVE
) {
151 hard_iface
= primary_if
->net_dev
;
153 if (nla_put_u32(msg
, BATADV_ATTR_HARD_IFINDEX
,
154 hard_iface
->ifindex
) ||
155 nla_put_string(msg
, BATADV_ATTR_HARD_IFNAME
,
157 nla_put(msg
, BATADV_ATTR_HARD_ADDRESS
, ETH_ALEN
,
158 hard_iface
->dev_addr
))
166 batadv_hardif_put(primary_if
);
172 * batadv_netlink_get_mesh_info - handle incoming BATADV_CMD_GET_MESH_INFO
174 * @skb: received netlink message
175 * @info: receiver information
177 * Return: 0 on success, < 0 on error
180 batadv_netlink_get_mesh_info(struct sk_buff
*skb
, struct genl_info
*info
)
182 struct net
*net
= genl_info_net(info
);
183 struct net_device
*soft_iface
;
184 struct sk_buff
*msg
= NULL
;
189 if (!info
->attrs
[BATADV_ATTR_MESH_IFINDEX
])
192 ifindex
= nla_get_u32(info
->attrs
[BATADV_ATTR_MESH_IFINDEX
]);
196 soft_iface
= dev_get_by_index(net
, ifindex
);
197 if (!soft_iface
|| !batadv_softif_is_valid(soft_iface
)) {
202 msg
= nlmsg_new(NLMSG_DEFAULT_SIZE
, GFP_KERNEL
);
208 msg_head
= genlmsg_put(msg
, info
->snd_portid
, info
->snd_seq
,
209 &batadv_netlink_family
, 0,
210 BATADV_CMD_GET_MESH_INFO
);
216 ret
= batadv_netlink_mesh_info_put(msg
, soft_iface
);
228 genlmsg_end(msg
, msg_head
);
229 return genlmsg_reply(msg
, info
);
233 * batadv_netlink_tp_meter_put - Fill information of started tp_meter session
234 * @msg: netlink message to be sent back
235 * @cookie: tp meter session cookie
237 * Return: 0 on success, < 0 on error
240 batadv_netlink_tp_meter_put(struct sk_buff
*msg
, u32 cookie
)
242 if (nla_put_u32(msg
, BATADV_ATTR_TPMETER_COOKIE
, cookie
))
249 * batadv_netlink_tpmeter_notify - send tp_meter result via netlink to client
250 * @bat_priv: the bat priv with all the soft interface information
251 * @dst: destination of tp_meter session
252 * @result: reason for tp meter session stop
253 * @test_time: total time ot the tp_meter session
254 * @total_bytes: bytes acked to the receiver
255 * @cookie: cookie of tp_meter session
257 * Return: 0 on success, < 0 on error
259 int batadv_netlink_tpmeter_notify(struct batadv_priv
*bat_priv
, const u8
*dst
,
260 u8 result
, u32 test_time
, u64 total_bytes
,
267 msg
= nlmsg_new(NLMSG_DEFAULT_SIZE
, GFP_KERNEL
);
271 hdr
= genlmsg_put(msg
, 0, 0, &batadv_netlink_family
, 0,
272 BATADV_CMD_TP_METER
);
278 if (nla_put_u32(msg
, BATADV_ATTR_TPMETER_COOKIE
, cookie
))
279 goto nla_put_failure
;
281 if (nla_put_u32(msg
, BATADV_ATTR_TPMETER_TEST_TIME
, test_time
))
282 goto nla_put_failure
;
284 if (nla_put_u64_64bit(msg
, BATADV_ATTR_TPMETER_BYTES
, total_bytes
,
286 goto nla_put_failure
;
288 if (nla_put_u8(msg
, BATADV_ATTR_TPMETER_RESULT
, result
))
289 goto nla_put_failure
;
291 if (nla_put(msg
, BATADV_ATTR_ORIG_ADDRESS
, ETH_ALEN
, dst
))
292 goto nla_put_failure
;
294 genlmsg_end(msg
, hdr
);
296 genlmsg_multicast_netns(&batadv_netlink_family
,
297 dev_net(bat_priv
->soft_iface
), msg
, 0,
298 BATADV_NL_MCGRP_TPMETER
, GFP_KERNEL
);
303 genlmsg_cancel(msg
, hdr
);
312 * batadv_netlink_tp_meter_start - Start a new tp_meter session
313 * @skb: received netlink message
314 * @info: receiver information
316 * Return: 0 on success, < 0 on error
319 batadv_netlink_tp_meter_start(struct sk_buff
*skb
, struct genl_info
*info
)
321 struct net
*net
= genl_info_net(info
);
322 struct net_device
*soft_iface
;
323 struct batadv_priv
*bat_priv
;
324 struct sk_buff
*msg
= NULL
;
332 if (!info
->attrs
[BATADV_ATTR_MESH_IFINDEX
])
335 if (!info
->attrs
[BATADV_ATTR_ORIG_ADDRESS
])
338 if (!info
->attrs
[BATADV_ATTR_TPMETER_TEST_TIME
])
341 ifindex
= nla_get_u32(info
->attrs
[BATADV_ATTR_MESH_IFINDEX
]);
345 dst
= nla_data(info
->attrs
[BATADV_ATTR_ORIG_ADDRESS
]);
347 test_length
= nla_get_u32(info
->attrs
[BATADV_ATTR_TPMETER_TEST_TIME
]);
349 soft_iface
= dev_get_by_index(net
, ifindex
);
350 if (!soft_iface
|| !batadv_softif_is_valid(soft_iface
)) {
355 msg
= nlmsg_new(NLMSG_DEFAULT_SIZE
, GFP_KERNEL
);
361 msg_head
= genlmsg_put(msg
, info
->snd_portid
, info
->snd_seq
,
362 &batadv_netlink_family
, 0,
363 BATADV_CMD_TP_METER
);
369 bat_priv
= netdev_priv(soft_iface
);
370 batadv_tp_start(bat_priv
, dst
, test_length
, &cookie
);
372 ret
= batadv_netlink_tp_meter_put(msg
, cookie
);
384 genlmsg_end(msg
, msg_head
);
385 return genlmsg_reply(msg
, info
);
389 * batadv_netlink_tp_meter_start - Cancel a running tp_meter session
390 * @skb: received netlink message
391 * @info: receiver information
393 * Return: 0 on success, < 0 on error
396 batadv_netlink_tp_meter_cancel(struct sk_buff
*skb
, struct genl_info
*info
)
398 struct net
*net
= genl_info_net(info
);
399 struct net_device
*soft_iface
;
400 struct batadv_priv
*bat_priv
;
405 if (!info
->attrs
[BATADV_ATTR_MESH_IFINDEX
])
408 if (!info
->attrs
[BATADV_ATTR_ORIG_ADDRESS
])
411 ifindex
= nla_get_u32(info
->attrs
[BATADV_ATTR_MESH_IFINDEX
]);
415 dst
= nla_data(info
->attrs
[BATADV_ATTR_ORIG_ADDRESS
]);
417 soft_iface
= dev_get_by_index(net
, ifindex
);
418 if (!soft_iface
|| !batadv_softif_is_valid(soft_iface
)) {
423 bat_priv
= netdev_priv(soft_iface
);
424 batadv_tp_stop(bat_priv
, dst
, BATADV_TP_REASON_CANCEL
);
434 * batadv_netlink_dump_hardif_entry - Dump one hard interface into a message
435 * @msg: Netlink message to dump into
436 * @portid: Port making netlink request
437 * @seq: Sequence number of netlink message
438 * @hard_iface: Hard interface to dump
440 * Return: error code, or 0 on success
443 batadv_netlink_dump_hardif_entry(struct sk_buff
*msg
, u32 portid
, u32 seq
,
444 struct batadv_hard_iface
*hard_iface
)
446 struct net_device
*net_dev
= hard_iface
->net_dev
;
449 hdr
= genlmsg_put(msg
, portid
, seq
, &batadv_netlink_family
, NLM_F_MULTI
,
450 BATADV_CMD_GET_HARDIFS
);
454 if (nla_put_u32(msg
, BATADV_ATTR_HARD_IFINDEX
,
456 nla_put_string(msg
, BATADV_ATTR_HARD_IFNAME
,
458 nla_put(msg
, BATADV_ATTR_HARD_ADDRESS
, ETH_ALEN
,
460 goto nla_put_failure
;
462 if (hard_iface
->if_status
== BATADV_IF_ACTIVE
) {
463 if (nla_put_flag(msg
, BATADV_ATTR_ACTIVE
))
464 goto nla_put_failure
;
467 genlmsg_end(msg
, hdr
);
471 genlmsg_cancel(msg
, hdr
);
476 * batadv_netlink_dump_hardifs - Dump all hard interface into a messages
477 * @msg: Netlink message to dump into
478 * @cb: Parameters from query
480 * Return: error code, or length of reply message on success
483 batadv_netlink_dump_hardifs(struct sk_buff
*msg
, struct netlink_callback
*cb
)
485 struct net
*net
= sock_net(cb
->skb
->sk
);
486 struct net_device
*soft_iface
;
487 struct batadv_hard_iface
*hard_iface
;
489 int portid
= NETLINK_CB(cb
->skb
).portid
;
490 int seq
= cb
->nlh
->nlmsg_seq
;
491 int skip
= cb
->args
[0];
494 ifindex
= batadv_netlink_get_ifindex(cb
->nlh
,
495 BATADV_ATTR_MESH_IFINDEX
);
499 soft_iface
= dev_get_by_index(net
, ifindex
);
503 if (!batadv_softif_is_valid(soft_iface
)) {
510 list_for_each_entry_rcu(hard_iface
, &batadv_hardif_list
, list
) {
511 if (hard_iface
->soft_iface
!= soft_iface
)
517 if (batadv_netlink_dump_hardif_entry(msg
, portid
, seq
,
533 static const struct genl_ops batadv_netlink_ops
[] = {
535 .cmd
= BATADV_CMD_GET_MESH_INFO
,
536 .flags
= GENL_ADMIN_PERM
,
537 .policy
= batadv_netlink_policy
,
538 .doit
= batadv_netlink_get_mesh_info
,
541 .cmd
= BATADV_CMD_TP_METER
,
542 .flags
= GENL_ADMIN_PERM
,
543 .policy
= batadv_netlink_policy
,
544 .doit
= batadv_netlink_tp_meter_start
,
547 .cmd
= BATADV_CMD_TP_METER_CANCEL
,
548 .flags
= GENL_ADMIN_PERM
,
549 .policy
= batadv_netlink_policy
,
550 .doit
= batadv_netlink_tp_meter_cancel
,
553 .cmd
= BATADV_CMD_GET_ROUTING_ALGOS
,
554 .flags
= GENL_ADMIN_PERM
,
555 .policy
= batadv_netlink_policy
,
556 .dumpit
= batadv_algo_dump
,
559 .cmd
= BATADV_CMD_GET_HARDIFS
,
560 .flags
= GENL_ADMIN_PERM
,
561 .policy
= batadv_netlink_policy
,
562 .dumpit
= batadv_netlink_dump_hardifs
,
565 .cmd
= BATADV_CMD_GET_TRANSTABLE_LOCAL
,
566 .flags
= GENL_ADMIN_PERM
,
567 .policy
= batadv_netlink_policy
,
568 .dumpit
= batadv_tt_local_dump
,
571 .cmd
= BATADV_CMD_GET_TRANSTABLE_GLOBAL
,
572 .flags
= GENL_ADMIN_PERM
,
573 .policy
= batadv_netlink_policy
,
574 .dumpit
= batadv_tt_global_dump
,
577 .cmd
= BATADV_CMD_GET_ORIGINATORS
,
578 .flags
= GENL_ADMIN_PERM
,
579 .policy
= batadv_netlink_policy
,
580 .dumpit
= batadv_orig_dump
,
583 .cmd
= BATADV_CMD_GET_NEIGHBORS
,
584 .flags
= GENL_ADMIN_PERM
,
585 .policy
= batadv_netlink_policy
,
586 .dumpit
= batadv_hardif_neigh_dump
,
589 .cmd
= BATADV_CMD_GET_GATEWAYS
,
590 .flags
= GENL_ADMIN_PERM
,
591 .policy
= batadv_netlink_policy
,
592 .dumpit
= batadv_gw_dump
,
595 .cmd
= BATADV_CMD_GET_BLA_CLAIM
,
596 .flags
= GENL_ADMIN_PERM
,
597 .policy
= batadv_netlink_policy
,
598 .dumpit
= batadv_bla_claim_dump
,
601 .cmd
= BATADV_CMD_GET_BLA_BACKBONE
,
602 .flags
= GENL_ADMIN_PERM
,
603 .policy
= batadv_netlink_policy
,
604 .dumpit
= batadv_bla_backbone_dump
,
609 struct genl_family batadv_netlink_family __ro_after_init
= {
611 .name
= BATADV_NL_NAME
,
613 .maxattr
= BATADV_ATTR_MAX
,
615 .module
= THIS_MODULE
,
616 .ops
= batadv_netlink_ops
,
617 .n_ops
= ARRAY_SIZE(batadv_netlink_ops
),
618 .mcgrps
= batadv_netlink_mcgrps
,
619 .n_mcgrps
= ARRAY_SIZE(batadv_netlink_mcgrps
),
623 * batadv_netlink_register - register batadv genl netlink family
625 void __init
batadv_netlink_register(void)
629 ret
= genl_register_family(&batadv_netlink_family
);
631 pr_warn("unable to register netlink family");
635 * batadv_netlink_unregister - unregister batadv genl netlink family
637 void batadv_netlink_unregister(void)
639 genl_unregister_family(&batadv_netlink_family
);