1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) 2016-2017 B.A.T.M.A.N. contributors:
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of version 2 of the GNU General Public
8 * License as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, see <http://www.gnu.org/licenses/>.
22 #include <linux/atomic.h>
23 #include <linux/byteorder/generic.h>
24 #include <linux/cache.h>
25 #include <linux/errno.h>
26 #include <linux/export.h>
27 #include <linux/genetlink.h>
28 #include <linux/gfp.h>
29 #include <linux/if_ether.h>
30 #include <linux/init.h>
31 #include <linux/kernel.h>
32 #include <linux/netdevice.h>
33 #include <linux/netlink.h>
34 #include <linux/printk.h>
35 #include <linux/rculist.h>
36 #include <linux/rcupdate.h>
37 #include <linux/skbuff.h>
38 #include <linux/stddef.h>
39 #include <linux/types.h>
40 #include <net/genetlink.h>
41 #include <net/netlink.h>
43 #include <uapi/linux/batadv_packet.h>
44 #include <uapi/linux/batman_adv.h>
47 #include "bridge_loop_avoidance.h"
48 #include "gateway_client.h"
49 #include "hard-interface.h"
50 #include "originator.h"
51 #include "soft-interface.h"
53 #include "translation-table.h"
55 struct genl_family batadv_netlink_family
;
57 /* multicast groups */
58 enum batadv_netlink_multicast_groups
{
59 BATADV_NL_MCGRP_TPMETER
,
62 static const struct genl_multicast_group batadv_netlink_mcgrps
[] = {
63 [BATADV_NL_MCGRP_TPMETER
] = { .name
= BATADV_NL_MCAST_GROUP_TPMETER
},
66 static const struct nla_policy batadv_netlink_policy
[NUM_BATADV_ATTR
] = {
67 [BATADV_ATTR_VERSION
] = { .type
= NLA_STRING
},
68 [BATADV_ATTR_ALGO_NAME
] = { .type
= NLA_STRING
},
69 [BATADV_ATTR_MESH_IFINDEX
] = { .type
= NLA_U32
},
70 [BATADV_ATTR_MESH_IFNAME
] = { .type
= NLA_STRING
},
71 [BATADV_ATTR_MESH_ADDRESS
] = { .len
= ETH_ALEN
},
72 [BATADV_ATTR_HARD_IFINDEX
] = { .type
= NLA_U32
},
73 [BATADV_ATTR_HARD_IFNAME
] = { .type
= NLA_STRING
},
74 [BATADV_ATTR_HARD_ADDRESS
] = { .len
= ETH_ALEN
},
75 [BATADV_ATTR_ORIG_ADDRESS
] = { .len
= ETH_ALEN
},
76 [BATADV_ATTR_TPMETER_RESULT
] = { .type
= NLA_U8
},
77 [BATADV_ATTR_TPMETER_TEST_TIME
] = { .type
= NLA_U32
},
78 [BATADV_ATTR_TPMETER_BYTES
] = { .type
= NLA_U64
},
79 [BATADV_ATTR_TPMETER_COOKIE
] = { .type
= NLA_U32
},
80 [BATADV_ATTR_ACTIVE
] = { .type
= NLA_FLAG
},
81 [BATADV_ATTR_TT_ADDRESS
] = { .len
= ETH_ALEN
},
82 [BATADV_ATTR_TT_TTVN
] = { .type
= NLA_U8
},
83 [BATADV_ATTR_TT_LAST_TTVN
] = { .type
= NLA_U8
},
84 [BATADV_ATTR_TT_CRC32
] = { .type
= NLA_U32
},
85 [BATADV_ATTR_TT_VID
] = { .type
= NLA_U16
},
86 [BATADV_ATTR_TT_FLAGS
] = { .type
= NLA_U32
},
87 [BATADV_ATTR_FLAG_BEST
] = { .type
= NLA_FLAG
},
88 [BATADV_ATTR_LAST_SEEN_MSECS
] = { .type
= NLA_U32
},
89 [BATADV_ATTR_NEIGH_ADDRESS
] = { .len
= ETH_ALEN
},
90 [BATADV_ATTR_TQ
] = { .type
= NLA_U8
},
91 [BATADV_ATTR_THROUGHPUT
] = { .type
= NLA_U32
},
92 [BATADV_ATTR_BANDWIDTH_UP
] = { .type
= NLA_U32
},
93 [BATADV_ATTR_BANDWIDTH_DOWN
] = { .type
= NLA_U32
},
94 [BATADV_ATTR_ROUTER
] = { .len
= ETH_ALEN
},
95 [BATADV_ATTR_BLA_OWN
] = { .type
= NLA_FLAG
},
96 [BATADV_ATTR_BLA_ADDRESS
] = { .len
= ETH_ALEN
},
97 [BATADV_ATTR_BLA_VID
] = { .type
= NLA_U16
},
98 [BATADV_ATTR_BLA_BACKBONE
] = { .len
= ETH_ALEN
},
99 [BATADV_ATTR_BLA_CRC
] = { .type
= NLA_U16
},
103 * batadv_netlink_get_ifindex() - Extract an interface index from a message
104 * @nlh: Message header
105 * @attrtype: Attribute which holds an interface index
107 * Return: interface index, or 0.
110 batadv_netlink_get_ifindex(const struct nlmsghdr
*nlh
, int attrtype
)
112 struct nlattr
*attr
= nlmsg_find_attr(nlh
, GENL_HDRLEN
, attrtype
);
114 return attr
? nla_get_u32(attr
) : 0;
118 * batadv_netlink_mesh_info_put() - fill in generic information about mesh
120 * @msg: netlink message to be sent back
121 * @soft_iface: interface for which the data should be taken
123 * Return: 0 on success, < 0 on error
126 batadv_netlink_mesh_info_put(struct sk_buff
*msg
, struct net_device
*soft_iface
)
128 struct batadv_priv
*bat_priv
= netdev_priv(soft_iface
);
129 struct batadv_hard_iface
*primary_if
= NULL
;
130 struct net_device
*hard_iface
;
133 if (nla_put_string(msg
, BATADV_ATTR_VERSION
, BATADV_SOURCE_VERSION
) ||
134 nla_put_string(msg
, BATADV_ATTR_ALGO_NAME
,
135 bat_priv
->algo_ops
->name
) ||
136 nla_put_u32(msg
, BATADV_ATTR_MESH_IFINDEX
, soft_iface
->ifindex
) ||
137 nla_put_string(msg
, BATADV_ATTR_MESH_IFNAME
, soft_iface
->name
) ||
138 nla_put(msg
, BATADV_ATTR_MESH_ADDRESS
, ETH_ALEN
,
139 soft_iface
->dev_addr
) ||
140 nla_put_u8(msg
, BATADV_ATTR_TT_TTVN
,
141 (u8
)atomic_read(&bat_priv
->tt
.vn
)))
144 #ifdef CONFIG_BATMAN_ADV_BLA
145 if (nla_put_u16(msg
, BATADV_ATTR_BLA_CRC
,
146 ntohs(bat_priv
->bla
.claim_dest
.group
)))
150 primary_if
= batadv_primary_if_get_selected(bat_priv
);
151 if (primary_if
&& primary_if
->if_status
== BATADV_IF_ACTIVE
) {
152 hard_iface
= primary_if
->net_dev
;
154 if (nla_put_u32(msg
, BATADV_ATTR_HARD_IFINDEX
,
155 hard_iface
->ifindex
) ||
156 nla_put_string(msg
, BATADV_ATTR_HARD_IFNAME
,
158 nla_put(msg
, BATADV_ATTR_HARD_ADDRESS
, ETH_ALEN
,
159 hard_iface
->dev_addr
))
167 batadv_hardif_put(primary_if
);
173 * batadv_netlink_get_mesh_info() - handle incoming BATADV_CMD_GET_MESH_INFO
175 * @skb: received netlink message
176 * @info: receiver information
178 * Return: 0 on success, < 0 on error
181 batadv_netlink_get_mesh_info(struct sk_buff
*skb
, struct genl_info
*info
)
183 struct net
*net
= genl_info_net(info
);
184 struct net_device
*soft_iface
;
185 struct sk_buff
*msg
= NULL
;
190 if (!info
->attrs
[BATADV_ATTR_MESH_IFINDEX
])
193 ifindex
= nla_get_u32(info
->attrs
[BATADV_ATTR_MESH_IFINDEX
]);
197 soft_iface
= dev_get_by_index(net
, ifindex
);
198 if (!soft_iface
|| !batadv_softif_is_valid(soft_iface
)) {
203 msg
= nlmsg_new(NLMSG_DEFAULT_SIZE
, GFP_KERNEL
);
209 msg_head
= genlmsg_put(msg
, info
->snd_portid
, info
->snd_seq
,
210 &batadv_netlink_family
, 0,
211 BATADV_CMD_GET_MESH_INFO
);
217 ret
= batadv_netlink_mesh_info_put(msg
, soft_iface
);
229 genlmsg_end(msg
, msg_head
);
230 return genlmsg_reply(msg
, info
);
234 * batadv_netlink_tp_meter_put() - Fill information of started tp_meter session
235 * @msg: netlink message to be sent back
236 * @cookie: tp meter session cookie
238 * Return: 0 on success, < 0 on error
241 batadv_netlink_tp_meter_put(struct sk_buff
*msg
, u32 cookie
)
243 if (nla_put_u32(msg
, BATADV_ATTR_TPMETER_COOKIE
, cookie
))
250 * batadv_netlink_tpmeter_notify() - send tp_meter result via netlink to client
251 * @bat_priv: the bat priv with all the soft interface information
252 * @dst: destination of tp_meter session
253 * @result: reason for tp meter session stop
254 * @test_time: total time ot the tp_meter session
255 * @total_bytes: bytes acked to the receiver
256 * @cookie: cookie of tp_meter session
258 * Return: 0 on success, < 0 on error
260 int batadv_netlink_tpmeter_notify(struct batadv_priv
*bat_priv
, const u8
*dst
,
261 u8 result
, u32 test_time
, u64 total_bytes
,
268 msg
= nlmsg_new(NLMSG_DEFAULT_SIZE
, GFP_KERNEL
);
272 hdr
= genlmsg_put(msg
, 0, 0, &batadv_netlink_family
, 0,
273 BATADV_CMD_TP_METER
);
279 if (nla_put_u32(msg
, BATADV_ATTR_TPMETER_COOKIE
, cookie
))
280 goto nla_put_failure
;
282 if (nla_put_u32(msg
, BATADV_ATTR_TPMETER_TEST_TIME
, test_time
))
283 goto nla_put_failure
;
285 if (nla_put_u64_64bit(msg
, BATADV_ATTR_TPMETER_BYTES
, total_bytes
,
287 goto nla_put_failure
;
289 if (nla_put_u8(msg
, BATADV_ATTR_TPMETER_RESULT
, result
))
290 goto nla_put_failure
;
292 if (nla_put(msg
, BATADV_ATTR_ORIG_ADDRESS
, ETH_ALEN
, dst
))
293 goto nla_put_failure
;
295 genlmsg_end(msg
, hdr
);
297 genlmsg_multicast_netns(&batadv_netlink_family
,
298 dev_net(bat_priv
->soft_iface
), msg
, 0,
299 BATADV_NL_MCGRP_TPMETER
, GFP_KERNEL
);
304 genlmsg_cancel(msg
, hdr
);
313 * batadv_netlink_tp_meter_start() - Start a new tp_meter session
314 * @skb: received netlink message
315 * @info: receiver information
317 * Return: 0 on success, < 0 on error
320 batadv_netlink_tp_meter_start(struct sk_buff
*skb
, struct genl_info
*info
)
322 struct net
*net
= genl_info_net(info
);
323 struct net_device
*soft_iface
;
324 struct batadv_priv
*bat_priv
;
325 struct sk_buff
*msg
= NULL
;
333 if (!info
->attrs
[BATADV_ATTR_MESH_IFINDEX
])
336 if (!info
->attrs
[BATADV_ATTR_ORIG_ADDRESS
])
339 if (!info
->attrs
[BATADV_ATTR_TPMETER_TEST_TIME
])
342 ifindex
= nla_get_u32(info
->attrs
[BATADV_ATTR_MESH_IFINDEX
]);
346 dst
= nla_data(info
->attrs
[BATADV_ATTR_ORIG_ADDRESS
]);
348 test_length
= nla_get_u32(info
->attrs
[BATADV_ATTR_TPMETER_TEST_TIME
]);
350 soft_iface
= dev_get_by_index(net
, ifindex
);
351 if (!soft_iface
|| !batadv_softif_is_valid(soft_iface
)) {
356 msg
= nlmsg_new(NLMSG_DEFAULT_SIZE
, GFP_KERNEL
);
362 msg_head
= genlmsg_put(msg
, info
->snd_portid
, info
->snd_seq
,
363 &batadv_netlink_family
, 0,
364 BATADV_CMD_TP_METER
);
370 bat_priv
= netdev_priv(soft_iface
);
371 batadv_tp_start(bat_priv
, dst
, test_length
, &cookie
);
373 ret
= batadv_netlink_tp_meter_put(msg
, cookie
);
385 genlmsg_end(msg
, msg_head
);
386 return genlmsg_reply(msg
, info
);
390 * batadv_netlink_tp_meter_start() - Cancel a running tp_meter session
391 * @skb: received netlink message
392 * @info: receiver information
394 * Return: 0 on success, < 0 on error
397 batadv_netlink_tp_meter_cancel(struct sk_buff
*skb
, struct genl_info
*info
)
399 struct net
*net
= genl_info_net(info
);
400 struct net_device
*soft_iface
;
401 struct batadv_priv
*bat_priv
;
406 if (!info
->attrs
[BATADV_ATTR_MESH_IFINDEX
])
409 if (!info
->attrs
[BATADV_ATTR_ORIG_ADDRESS
])
412 ifindex
= nla_get_u32(info
->attrs
[BATADV_ATTR_MESH_IFINDEX
]);
416 dst
= nla_data(info
->attrs
[BATADV_ATTR_ORIG_ADDRESS
]);
418 soft_iface
= dev_get_by_index(net
, ifindex
);
419 if (!soft_iface
|| !batadv_softif_is_valid(soft_iface
)) {
424 bat_priv
= netdev_priv(soft_iface
);
425 batadv_tp_stop(bat_priv
, dst
, BATADV_TP_REASON_CANCEL
);
435 * batadv_netlink_dump_hardif_entry() - Dump one hard interface into a message
436 * @msg: Netlink message to dump into
437 * @portid: Port making netlink request
438 * @seq: Sequence number of netlink message
439 * @hard_iface: Hard interface to dump
441 * Return: error code, or 0 on success
444 batadv_netlink_dump_hardif_entry(struct sk_buff
*msg
, u32 portid
, u32 seq
,
445 struct batadv_hard_iface
*hard_iface
)
447 struct net_device
*net_dev
= hard_iface
->net_dev
;
450 hdr
= genlmsg_put(msg
, portid
, seq
, &batadv_netlink_family
, NLM_F_MULTI
,
451 BATADV_CMD_GET_HARDIFS
);
455 if (nla_put_u32(msg
, BATADV_ATTR_HARD_IFINDEX
,
457 nla_put_string(msg
, BATADV_ATTR_HARD_IFNAME
,
459 nla_put(msg
, BATADV_ATTR_HARD_ADDRESS
, ETH_ALEN
,
461 goto nla_put_failure
;
463 if (hard_iface
->if_status
== BATADV_IF_ACTIVE
) {
464 if (nla_put_flag(msg
, BATADV_ATTR_ACTIVE
))
465 goto nla_put_failure
;
468 genlmsg_end(msg
, hdr
);
472 genlmsg_cancel(msg
, hdr
);
477 * batadv_netlink_dump_hardifs() - Dump all hard interface into a messages
478 * @msg: Netlink message to dump into
479 * @cb: Parameters from query
481 * Return: error code, or length of reply message on success
484 batadv_netlink_dump_hardifs(struct sk_buff
*msg
, struct netlink_callback
*cb
)
486 struct net
*net
= sock_net(cb
->skb
->sk
);
487 struct net_device
*soft_iface
;
488 struct batadv_hard_iface
*hard_iface
;
490 int portid
= NETLINK_CB(cb
->skb
).portid
;
491 int seq
= cb
->nlh
->nlmsg_seq
;
492 int skip
= cb
->args
[0];
495 ifindex
= batadv_netlink_get_ifindex(cb
->nlh
,
496 BATADV_ATTR_MESH_IFINDEX
);
500 soft_iface
= dev_get_by_index(net
, ifindex
);
504 if (!batadv_softif_is_valid(soft_iface
)) {
511 list_for_each_entry_rcu(hard_iface
, &batadv_hardif_list
, list
) {
512 if (hard_iface
->soft_iface
!= soft_iface
)
518 if (batadv_netlink_dump_hardif_entry(msg
, portid
, seq
,
534 static const struct genl_ops batadv_netlink_ops
[] = {
536 .cmd
= BATADV_CMD_GET_MESH_INFO
,
537 .flags
= GENL_ADMIN_PERM
,
538 .policy
= batadv_netlink_policy
,
539 .doit
= batadv_netlink_get_mesh_info
,
542 .cmd
= BATADV_CMD_TP_METER
,
543 .flags
= GENL_ADMIN_PERM
,
544 .policy
= batadv_netlink_policy
,
545 .doit
= batadv_netlink_tp_meter_start
,
548 .cmd
= BATADV_CMD_TP_METER_CANCEL
,
549 .flags
= GENL_ADMIN_PERM
,
550 .policy
= batadv_netlink_policy
,
551 .doit
= batadv_netlink_tp_meter_cancel
,
554 .cmd
= BATADV_CMD_GET_ROUTING_ALGOS
,
555 .flags
= GENL_ADMIN_PERM
,
556 .policy
= batadv_netlink_policy
,
557 .dumpit
= batadv_algo_dump
,
560 .cmd
= BATADV_CMD_GET_HARDIFS
,
561 .flags
= GENL_ADMIN_PERM
,
562 .policy
= batadv_netlink_policy
,
563 .dumpit
= batadv_netlink_dump_hardifs
,
566 .cmd
= BATADV_CMD_GET_TRANSTABLE_LOCAL
,
567 .flags
= GENL_ADMIN_PERM
,
568 .policy
= batadv_netlink_policy
,
569 .dumpit
= batadv_tt_local_dump
,
572 .cmd
= BATADV_CMD_GET_TRANSTABLE_GLOBAL
,
573 .flags
= GENL_ADMIN_PERM
,
574 .policy
= batadv_netlink_policy
,
575 .dumpit
= batadv_tt_global_dump
,
578 .cmd
= BATADV_CMD_GET_ORIGINATORS
,
579 .flags
= GENL_ADMIN_PERM
,
580 .policy
= batadv_netlink_policy
,
581 .dumpit
= batadv_orig_dump
,
584 .cmd
= BATADV_CMD_GET_NEIGHBORS
,
585 .flags
= GENL_ADMIN_PERM
,
586 .policy
= batadv_netlink_policy
,
587 .dumpit
= batadv_hardif_neigh_dump
,
590 .cmd
= BATADV_CMD_GET_GATEWAYS
,
591 .flags
= GENL_ADMIN_PERM
,
592 .policy
= batadv_netlink_policy
,
593 .dumpit
= batadv_gw_dump
,
596 .cmd
= BATADV_CMD_GET_BLA_CLAIM
,
597 .flags
= GENL_ADMIN_PERM
,
598 .policy
= batadv_netlink_policy
,
599 .dumpit
= batadv_bla_claim_dump
,
602 .cmd
= BATADV_CMD_GET_BLA_BACKBONE
,
603 .flags
= GENL_ADMIN_PERM
,
604 .policy
= batadv_netlink_policy
,
605 .dumpit
= batadv_bla_backbone_dump
,
610 struct genl_family batadv_netlink_family __ro_after_init
= {
612 .name
= BATADV_NL_NAME
,
614 .maxattr
= BATADV_ATTR_MAX
,
616 .module
= THIS_MODULE
,
617 .ops
= batadv_netlink_ops
,
618 .n_ops
= ARRAY_SIZE(batadv_netlink_ops
),
619 .mcgrps
= batadv_netlink_mcgrps
,
620 .n_mcgrps
= ARRAY_SIZE(batadv_netlink_mcgrps
),
624 * batadv_netlink_register() - register batadv genl netlink family
626 void __init
batadv_netlink_register(void)
630 ret
= genl_register_family(&batadv_netlink_family
);
632 pr_warn("unable to register netlink family");
636 * batadv_netlink_unregister() - unregister batadv genl netlink family
638 void batadv_netlink_unregister(void)
640 genl_unregister_family(&batadv_netlink_family
);