B.A.T.M.A.N

b.a.t.m.a.n@lists.open-mesh.org

15 participants
4308 discussions

[PATCH v2 2/2] batctl: Add JSON debug commands
by Alexander Sarmanow 10 May '21

10 May '21

According to part 1 of this patch following commands will be added to the JSON debug: meshinfo_json, originators_json, neighbors_json, translocal_json, transglobal_json. Signed-off-by: Alexander Sarmanow <asarmanow(a)gmail.com> --- Makefile | 5 ++ gateways.c | 2 +- main.c | 14 +++-- main.h | 1 + mcast_flags.c | 2 +- meshinfo_json.c | 139 +++++++++++++++++++++++++++++++++++++++++++++ neighbors_json.c | 89 +++++++++++++++++++++++++++++ netlink.c | 39 ++++++++----- netlink.h | 2 +- originators.c | 2 +- originators_json.c | 107 ++++++++++++++++++++++++++++++++++ transglobal_json.c | 109 +++++++++++++++++++++++++++++++++++ translocal_json.c | 102 +++++++++++++++++++++++++++++++++ 13 files changed, 592 insertions(+), 21 deletions(-) create mode 100644 meshinfo_json.c create mode 100644 neighbors_json.c create mode 100644 originators_json.c create mode 100644 transglobal_json.c create mode 100644 translocal_json.c diff --git a/Makefile b/Makefile index 98bf695..0f85561 100755 --- a/Makefile +++ b/Makefile @@ -54,13 +54,16 @@ $(eval $(call add_command,interface,y)) $(eval $(call add_command,isolation_mark,y)) $(eval $(call add_command,loglevel,y)) $(eval $(call add_command,mcast_flags,y)) +$(eval $(call add_command,meshinfo_json,y)) $(eval $(call add_command,multicast_fanout,y)) $(eval $(call add_command,multicast_forceflood,y)) $(eval $(call add_command,multicast_mode,y)) $(eval $(call add_command,neighbors,y)) +$(eval $(call add_command,neighbors_json,y)) $(eval $(call add_command,network_coding,y)) $(eval $(call add_command,orig_interval,y)) $(eval $(call add_command,originators,y)) +$(eval $(call add_command,originators_json,y)) $(eval $(call add_command,ping,y)) $(eval $(call add_command,routing_algo,y)) $(eval $(call add_command,statistics,y)) @@ -69,8 +72,10 @@ $(eval $(call add_command,throughput_override,y)) $(eval $(call add_command,throughputmeter,y)) $(eval $(call add_command,traceroute,y)) $(eval $(call add_command,transglobal,y)) +$(eval $(call add_command,transglobal_json,y)) $(eval $(call add_command,translate,y)) $(eval $(call add_command,translocal,y)) +$(eval $(call add_command,translocal_json,y)) MANPAGE = man/batctl.8 diff --git a/gateways.c b/gateways.c index 867c882..3704c99 100644 --- a/gateways.c +++ b/gateways.c @@ -123,7 +123,7 @@ static int netlink_print_gateways(struct state *state, char *orig_iface, /* only parse routing algorithm name */ last_err = -EINVAL; info_header = netlink_get_info(state->mesh_ifindex, - BATADV_CMD_GET_ORIGINATORS, NULL); + BATADV_CMD_GET_ORIGINATORS, NULL, 0); free(info_header); if (strlen(algo_name_buf) == 0) diff --git a/main.c b/main.c index d9b63f3..1371bc0 100644 --- a/main.c +++ b/main.c @@ -43,6 +43,10 @@ static void print_usage(void) .label = "debug tables: \tdisplay the corresponding debug table\n", .types = BIT(DEBUGTABLE), }, + { + .label = "debug JSONs: \tdisplay the corresponding debug JSON\n", + .types = BIT(DEBUGJSON), + }, }; const char *default_prefixes[] = { "", @@ -67,9 +71,9 @@ static void print_usage(void) char buf[64]; size_t i; - fprintf(stderr, "Usage: batctl [options] command|debug table [parameters]\n"); + fprintf(stderr, "Usage: batctl [options] command|debug table|debug json [parameters]\n"); fprintf(stderr, "options:\n"); - fprintf(stderr, " \t-h print this help (or 'batctl <command|debug table> -h' for the parameter help)\n"); + fprintf(stderr, " \t-h print this help (or 'batctl <command|debug table|debug json> -h' for the parameter help)\n"); fprintf(stderr, " \t-v print version\n"); for (i = 0; i < sizeof(type) / sizeof(*type); i++) { @@ -87,6 +91,7 @@ static void print_usage(void) continue; switch (cmd->type) { + case DEBUGJSON: case DEBUGTABLE: case SUBCOMMAND_MIF: prefixes = meshif_prefixes; @@ -167,7 +172,8 @@ static const struct command *find_command(struct state *state, const char *name) /* fall through */ case SP_MESHIF: types |= BIT(SUBCOMMAND_MIF) | - BIT(DEBUGTABLE); + BIT(DEBUGTABLE) | + BIT(DEBUGJSON); break; case SP_VLAN: types = BIT(SUBCOMMAND_VID); @@ -380,7 +386,7 @@ int main(int argc, char **argv) cmd = find_command(&state, argv[0]); if (!cmd) { fprintf(stderr, - "Error - no valid command or debug table specified: %s\n", + "Error - no valid command or debug table/JSON specified: %s\n", argv[0]); goto err; } diff --git a/main.h b/main.h index b1ff050..2efd136 100644 --- a/main.h +++ b/main.h @@ -71,6 +71,7 @@ enum command_type { SUBCOMMAND_VID, SUBCOMMAND_HIF, DEBUGTABLE, + DEBUGJSON, }; struct state { diff --git a/mcast_flags.c b/mcast_flags.c index cb6e89d..87fb077 100644 --- a/mcast_flags.c +++ b/mcast_flags.c @@ -105,7 +105,7 @@ static int netlink_print_mcast_flags(struct state *state, char *orig_iface, /* only parse own multicast flags */ info_header = netlink_get_info(state->mesh_ifindex, - BATADV_CMD_GET_MCAST_FLAGS, NULL); + BATADV_CMD_GET_MCAST_FLAGS, NULL, 0); free(info_header); if (mcast_flags == -EOPNOTSUPP || mcast_flags_priv == -EOPNOTSUPP) diff --git a/meshinfo_json.c b/meshinfo_json.c new file mode 100644 index 0000000..8c6f675 --- /dev/null +++ b/meshinfo_json.c @@ -0,0 +1,139 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (C) B.A.T.M.A.N. contributors: + * + * Alexander Sarmanow <asarmanow(a)gmail.com> + * + * License-Filename: LICENSES/preferred/GPL-2.0 + */ + +#include <errno.h> +#include <netlink/netlink.h> +#include <netlink/genl/genl.h> +#include <netlink/genl/ctrl.h> +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> + +#include "batman_adv.h" +#include "debug.h" +#include "main.h" +#include "netlink.h" + +static const int info_mandatory[] = { + BATADV_ATTR_MESH_IFINDEX, + BATADV_ATTR_MESH_IFNAME, +}; + +static int meshinfo_callback(struct nl_msg *msg, void *arg) +{ + struct print_opts *opts = arg; + struct nlattr *attrs[BATADV_ATTR_MAX+1]; + struct nlmsghdr *nlh = nlmsg_hdr(msg); + struct genlmsghdr *ghdr; + int selected_attrs[10] = { BATADV_ATTR_MESH_IFNAME, + BATADV_ATTR_MESH_ADDRESS, + BATADV_ATTR_HARD_IFNAME, + BATADV_ATTR_VERSION, + BATADV_ATTR_ALGO_NAME, + BATADV_ATTR_HARD_ADDRESS, + BATADV_ATTR_TT_TTVN }; + + if (!genlmsg_valid_hdr(nlh, 0)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + ghdr = nlmsg_data(nlh); + + if (ghdr->cmd != BATADV_CMD_GET_MESH_INFO) + return NL_OK; + if (nla_parse(attrs, BATADV_ATTR_MAX, genlmsg_attrdata(ghdr, 0), + genlmsg_len(ghdr), batadv_netlink_policy)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + if (missing_mandatory_attrs(attrs, info_mandatory, + ARRAY_SIZE(info_mandatory))) { + fputs("Missing attributes from kernel\n", stderr); + exit(1); + } + + netlink_print_json_entries(attrs, selected_attrs, + ARRAY_SIZE(selected_attrs), opts); + opts->is_first = 0; + + return NL_OK; +} + +static int netlink_print_meshinfo_json(struct state *state, char *orig_iface, + int read_opts, float orig_timeout, + float watch_interval) +{ + (void) orig_iface; + (void) orig_timeout; + (void) watch_interval; + (void) read_opts; + struct nl_sock *sock; + struct nl_msg *msg; + struct nl_cb *cb; + struct print_opts opts = { + .is_json = 1, + .is_first = 1, + }; + int family; + + if (!state->sock) { + last_err = -EOPNOTSUPP; + return last_err; + } + + sock = nl_socket_alloc(); + if (!sock) + return -1; + + genl_connect(sock); + + family = genl_ctrl_resolve(sock, BATADV_NL_NAME); + if (family < 0) { + nl_socket_free(sock); + return -1; + } + + msg = nlmsg_alloc(); + if (!msg) { + nl_socket_free(sock); + return -1; + } + + genlmsg_put(msg, NL_AUTO_PID, NL_AUTO_SEQ, family, 0, 0, + BATADV_CMD_GET_MESH_INFO, 1); + + nla_put_u32(msg, BATADV_ATTR_MESH_IFINDEX, state->mesh_ifindex); + + nl_send_auto_complete(sock, msg); + + nlmsg_free(msg); + + cb = nl_cb_alloc(NL_CB_DEFAULT); + if (!cb) + goto err_free_sock; + + nl_cb_set(cb, NL_CB_VALID, NL_CB_CUSTOM, meshinfo_callback, &opts); + nl_cb_err(cb, NL_CB_CUSTOM, netlink_print_error, NULL); + + nl_recvmsgs(sock, cb); + +err_free_sock: + nl_socket_free(sock); + + return 0; +} + +static struct debug_table_data batctl_debug_json_meshinfo = { + .netlink_fn = netlink_print_meshinfo_json, +}; + +COMMAND_NAMED(DEBUGJSON, meshinfo_json, "mij", handle_debug_table, + COMMAND_FLAG_MESH_IFACE | COMMAND_FLAG_NETLINK, + &batctl_debug_json_meshinfo, ""); diff --git a/neighbors_json.c b/neighbors_json.c new file mode 100644 index 0000000..5182e47 --- /dev/null +++ b/neighbors_json.c @@ -0,0 +1,89 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (C) B.A.T.M.A.N. contributors: + * + * Andrew Lunn <andrew(a)lunn.ch> + * Alexander Sarmanow <asarmanow(a)gmail.com> + * + * License-Filename: LICENSES/preferred/GPL-2.0 + */ + +#include <net/if.h> +#include <netinet/if_ether.h> +#include <netlink/netlink.h> +#include <netlink/genl/genl.h> +#include <netlink/genl/ctrl.h> +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> + +#include "batadv_packet.h" +#include "batman_adv.h" +#include "bat-hosts.h" +#include "debug.h" +#include "functions.h" +#include "main.h" +#include "netlink.h" + +static const int neighbors_mandatory[] = { + BATADV_ATTR_NEIGH_ADDRESS, + BATADV_ATTR_HARD_IFINDEX, + BATADV_ATTR_LAST_SEEN_MSECS, +}; + +static int neighbors_json_callback(struct nl_msg *msg, void *arg) +{ + struct nlattr *attrs[BATADV_ATTR_MAX+1]; + struct nlmsghdr *nlh = nlmsg_hdr(msg); + struct print_opts *opts = arg; + struct genlmsghdr *ghdr; + int selected_attrs[4] = { BATADV_ATTR_NEIGH_ADDRESS, + BATADV_ATTR_HARD_IFINDEX, + BATADV_ATTR_LAST_SEEN_MSECS, + BATADV_ATTR_THROUGHPUT }; + + if (!genlmsg_valid_hdr(nlh, 0)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + ghdr = nlmsg_data(nlh); + + if (ghdr->cmd != BATADV_CMD_GET_NEIGHBORS) + return NL_OK; + + if (nla_parse(attrs, BATADV_ATTR_MAX, genlmsg_attrdata(ghdr, 0), + genlmsg_len(ghdr), batadv_netlink_policy)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + if (missing_mandatory_attrs(attrs, neighbors_mandatory, + ARRAY_SIZE(neighbors_mandatory))) { + fputs("Missing attributes from kernel\n", stderr); + exit(1); + } + + netlink_print_json_entries(attrs, selected_attrs, + ARRAY_SIZE(selected_attrs), opts); + opts->is_first = 0; + + return NL_OK; +} + +static int netlink_print_neighbors_json(struct state *state, char *orig_iface, + int read_opts, float orig_timeout, + float watch_interval) +{ + return netlink_print_common(state, orig_iface, read_opts, + orig_timeout, watch_interval, NULL, + BATADV_CMD_GET_NEIGHBORS, + neighbors_json_callback, true); +} + +static struct debug_table_data batctl_debug_json_neighbors = { + .netlink_fn = netlink_print_neighbors_json, +}; + +COMMAND_NAMED(DEBUGJSON, neighbors_json, "nj", handle_debug_table, + COMMAND_FLAG_MESH_IFACE | COMMAND_FLAG_NETLINK, + &batctl_debug_json_neighbors, ""); diff --git a/netlink.c b/netlink.c index 26ae5ef..db44d82 100644 --- a/netlink.c +++ b/netlink.c @@ -363,17 +363,21 @@ static int info_callback(struct nl_msg *msg, void *arg) else extra_header = ""; - ret = asprintf(&opts->remaining_header, - "[B.A.T.M.A.N. adv %s, MainIF/MAC: %s/%02x:%02x:%02x:%02x:%02x:%02x (%s/%02x:%02x:%02x:%02x:%02x:%02x %s)%s]\n%s", - version, primary_if, - primary_mac[0], primary_mac[1], primary_mac[2], - primary_mac[3], primary_mac[4], primary_mac[5], - mesh_name, - mesh_mac[0], mesh_mac[1], mesh_mac[2], - mesh_mac[3], mesh_mac[4], mesh_mac[5], - algo_name, extra_info, extra_header); - if (ret < 0) - opts->remaining_header = NULL; + if (!opts->is_json) { + ret = asprintf(&opts->remaining_header, + "[B.A.T.M.A.N. adv %s, MainIF/MAC: %s/%02x:%02x:%02x:%02x:%02x:%02x (%s/%02x:%02x:%02x:%02x:%02x:%02x %s)%s]\n%s", + version, primary_if, + primary_mac[0], primary_mac[1], + primary_mac[2], primary_mac[3], + primary_mac[4], primary_mac[5], + mesh_name, + mesh_mac[0], mesh_mac[1], mesh_mac[2], + mesh_mac[3], mesh_mac[4], mesh_mac[5], + algo_name, extra_info, extra_header); + + if (ret < 0) + opts->remaining_header = NULL; + } if (extra_info) free(extra_info); @@ -387,7 +391,8 @@ static int info_callback(struct nl_msg *msg, void *arg) return NL_STOP; } -char *netlink_get_info(int ifindex, uint8_t nl_cmd, const char *header) +char *netlink_get_info(int ifindex, uint8_t nl_cmd, const char *header, + uint8_t is_json) { struct nl_sock *sock; struct nl_msg *msg; @@ -398,6 +403,7 @@ char *netlink_get_info(int ifindex, uint8_t nl_cmd, const char *header) .nl_cmd = nl_cmd, .remaining_header = NULL, .static_header = header, + .is_json = is_json, }; sock = nl_socket_alloc(); @@ -494,6 +500,9 @@ int netlink_print_common(struct state *state, char *orig_iface, int read_opt, } } + if (is_json) + printf("["); + bat_hosts_init(read_opt); nl_cb_set(state->cb, NL_CB_VALID, NL_CB_CUSTOM, netlink_print_common_cb, &opts); @@ -508,7 +517,8 @@ int netlink_print_common(struct state *state, char *orig_iface, int read_opt, if (!(read_opt & SKIP_HEADER)) opts.remaining_header = netlink_get_info(state->mesh_ifindex, nl_cmd, - header); + header, + is_json); msg = nlmsg_alloc(); if (!msg) @@ -529,6 +539,9 @@ int netlink_print_common(struct state *state, char *orig_iface, int read_opt, last_err = 0; nl_recvmsgs(state->sock, state->cb); + if (is_json) + printf("]"); + /* the header should still be printed when no entry was received */ if (!last_err) netlink_print_remaining_header(&opts); diff --git a/netlink.h b/netlink.h index c766741..47390fc 100644 --- a/netlink.h +++ b/netlink.h @@ -44,7 +44,7 @@ struct ether_addr; int netlink_create(struct state *state); void netlink_destroy(struct state *state); -char *netlink_get_info(int ifindex, uint8_t nl_cmd, const char *header); +char *netlink_get_info(int ifindex, uint8_t nl_cmd, const char *header, uint8_t is_json); int translate_mac_netlink(const char *mesh_iface, const struct ether_addr *mac, struct ether_addr *mac_out); int get_nexthop_netlink(const char *mesh_iface, const struct ether_addr *mac, diff --git a/originators.c b/originators.c index 674656c..c3af740 100644 --- a/originators.c +++ b/originators.c @@ -175,7 +175,7 @@ static int netlink_print_originators(struct state *state, char *orig_iface, /* only parse routing algorithm name */ last_err = -EINVAL; info_header = netlink_get_info(state->mesh_ifindex, - BATADV_CMD_GET_ORIGINATORS, NULL); + BATADV_CMD_GET_ORIGINATORS, NULL, 0); free(info_header); if (strlen(algo_name_buf) == 0) diff --git a/originators_json.c b/originators_json.c new file mode 100644 index 0000000..91dcb44 --- /dev/null +++ b/originators_json.c @@ -0,0 +1,107 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (C) B.A.T.M.A.N. contributors: + * + * Andrew Lunn <andrew(a)lunn.ch> + * Sven Eckelmann <sven(a)narfation.org> + * Alexander Sarmanow <asarmanow(a)gmail.com> + * + * License-Filename: LICENSES/preferred/GPL-2.0 + */ + +#include <errno.h> +#include <net/if.h> +#include <netinet/if_ether.h> +#include <netlink/netlink.h> +#include <netlink/genl/genl.h> +#include <netlink/genl/ctrl.h> +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> +#include <string.h> + +#include "batadv_packet.h" +#include "batman_adv.h" +#include "bat-hosts.h" +#include "debug.h" +#include "functions.h" +#include "main.h" +#include "netlink.h" + +static const int originators_mandatory[] = { + BATADV_ATTR_ORIG_ADDRESS, + BATADV_ATTR_NEIGH_ADDRESS, + BATADV_ATTR_HARD_IFINDEX, + BATADV_ATTR_LAST_SEEN_MSECS, +}; + +static int originators_json_callback(struct nl_msg *msg, void *arg) +{ + struct nlattr *attrs[BATADV_ATTR_MAX+1]; + struct nlmsghdr *nlh = nlmsg_hdr(msg); + int last_seen_msecs; + struct print_opts *opts = arg; + struct genlmsghdr *ghdr; + float last_seen; + int selected_attrs[6] = { BATADV_ATTR_ORIG_ADDRESS, + BATADV_ATTR_NEIGH_ADDRESS, + BATADV_ATTR_HARD_IFINDEX, + BATADV_ATTR_LAST_SEEN_MSECS, + BATADV_ATTR_THROUGHPUT, + BATADV_ATTR_TQ }; + + if (!genlmsg_valid_hdr(nlh, 0)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + ghdr = nlmsg_data(nlh); + + if (ghdr->cmd != BATADV_CMD_GET_ORIGINATORS) + return NL_OK; + + if (nla_parse(attrs, BATADV_ATTR_MAX, genlmsg_attrdata(ghdr, 0), + genlmsg_len(ghdr), batadv_netlink_policy)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + if (missing_mandatory_attrs(attrs, originators_mandatory, + ARRAY_SIZE(originators_mandatory))) { + fputs("Missing attributes from kernel\n", stderr); + exit(1); + } + + last_seen_msecs = nla_get_u32(attrs[BATADV_ATTR_LAST_SEEN_MSECS]); + last_seen = (float)last_seen_msecs / 1000.0; + + /* skip timed out originators */ + if (opts->read_opt & NO_OLD_ORIGS) + if (last_seen > opts->orig_timeout) + return NL_OK; + + netlink_print_json_entries(attrs, selected_attrs, + ARRAY_SIZE(selected_attrs), opts); + opts->is_first = 0; + + return NL_OK; +} + +static int netlink_print_originators_json(struct state *state, char *orig_iface, + int read_opts, float orig_timeout, + float watch_interval) +{ + return netlink_print_common(state, orig_iface, read_opts, + orig_timeout, watch_interval, NULL, + BATADV_CMD_GET_ORIGINATORS, + originators_json_callback, 1); +} + +static struct debug_table_data batctl_debug_json_originators = { + .netlink_fn = netlink_print_originators_json, + .option_timeout_interval = 1, + .option_orig_iface = 1, +}; + +COMMAND_NAMED(DEBUGJSON, originators_json, "oj", handle_debug_table, + COMMAND_FLAG_MESH_IFACE | COMMAND_FLAG_NETLINK, + &batctl_debug_json_originators, ""); diff --git a/transglobal_json.c b/transglobal_json.c new file mode 100644 index 0000000..faff8ec --- /dev/null +++ b/transglobal_json.c @@ -0,0 +1,109 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (C) B.A.T.M.A.N. contributors: + * + * Andrew Lunn <andrew(a)lunn.ch> + * Sven Eckelmann <sven(a)narfation.org> + * Alexander Sarmanow <asarmanow(a)gmail.com> + * + * License-Filename: LICENSES/preferred/GPL-2.0 + */ + +#include <netinet/if_ether.h> +#include <netlink/netlink.h> +#include <netlink/genl/genl.h> +#include <netlink/genl/ctrl.h> +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> + +#include "batadv_packet.h" +#include "batman_adv.h" +#include "bat-hosts.h" +#include "debug.h" +#include "functions.h" +#include "main.h" +#include "netlink.h" + +static const int transglobal_mandatory[] = { + BATADV_ATTR_TT_ADDRESS, + BATADV_ATTR_ORIG_ADDRESS, + BATADV_ATTR_TT_VID, + BATADV_ATTR_TT_TTVN, + BATADV_ATTR_TT_LAST_TTVN, + BATADV_ATTR_TT_CRC32, + BATADV_ATTR_TT_FLAGS, +}; + +static int transglobal_json_callback(struct nl_msg *msg, void *arg) +{ + struct nlattr *attrs[BATADV_ATTR_MAX+1]; + struct nlmsghdr *nlh = nlmsg_hdr(msg); + struct print_opts *opts = arg; + struct genlmsghdr *ghdr; + uint8_t *addr; + int selected_attrs[8] = { BATADV_ATTR_TT_ADDRESS, + BATADV_ATTR_ORIG_ADDRESS, + BATADV_ATTR_TT_VID, + BATADV_ATTR_TT_TTVN, + BATADV_ATTR_TT_LAST_TTVN, + BATADV_ATTR_TT_CRC32, + BATADV_ATTR_TT_FLAGS, + BATADV_ATTR_FLAG_BEST }; + + if (!genlmsg_valid_hdr(nlh, 0)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + ghdr = nlmsg_data(nlh); + + if (ghdr->cmd != BATADV_CMD_GET_TRANSTABLE_GLOBAL) + return NL_OK; + + if (nla_parse(attrs, BATADV_ATTR_MAX, genlmsg_attrdata(ghdr, 0), + genlmsg_len(ghdr), batadv_netlink_policy)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + if (missing_mandatory_attrs(attrs, transglobal_mandatory, + ARRAY_SIZE(transglobal_mandatory))) { + fputs("Missing attributes from kernel\n", stderr); + exit(1); + } + + addr = nla_data(attrs[BATADV_ATTR_TT_ADDRESS]); + + if (opts->read_opt & MULTICAST_ONLY && !(addr[0] & 0x01)) + return NL_OK; + + if (opts->read_opt & UNICAST_ONLY && (addr[0] & 0x01)) + return NL_OK; + + netlink_print_json_entries(attrs, selected_attrs, + ARRAY_SIZE(selected_attrs), opts); + opts->is_first = 0; + + + return NL_OK; +} + +static int netlink_print_transglobal_json(struct state *state, char *orig_iface, + int read_opts, float orig_timeout, + float watch_interval) +{ + return netlink_print_common(state, orig_iface, read_opts, + orig_timeout, watch_interval, NULL, + BATADV_CMD_GET_TRANSTABLE_GLOBAL, + transglobal_json_callback, true); +} + +static struct debug_table_data batctl_debug_json_transglobal = { + .netlink_fn = netlink_print_transglobal_json, + .option_unicast_only = 1, + .option_multicast_only = 1, +}; + +COMMAND_NAMED(DEBUGJSON, transglobal_json, "tgj", handle_debug_table, + COMMAND_FLAG_MESH_IFACE | COMMAND_FLAG_NETLINK, + &batctl_debug_json_transglobal, ""); diff --git a/translocal_json.c b/translocal_json.c new file mode 100644 index 0000000..e78150e --- /dev/null +++ b/translocal_json.c @@ -0,0 +1,102 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (C) B.A.T.M.A.N. contributors: + * + * Andrew Lunn <andrew(a)lunn.ch> + * Sven Eckelmann <sven(a)narfation.org> + * Alexander Sarmanow <asarmanow(a)gmail.com> + * + * License-Filename: LICENSES/preferred/GPL-2.0 + */ + +#include <netinet/if_ether.h> +#include <netlink/netlink.h> +#include <netlink/genl/genl.h> +#include <netlink/genl/ctrl.h> +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> + +#include "batadv_packet.h" +#include "batman_adv.h" +#include "bat-hosts.h" +#include "debug.h" +#include "functions.h" +#include "main.h" +#include "netlink.h" + +static const int translocal_mandatory[] = { + BATADV_ATTR_TT_ADDRESS, + BATADV_ATTR_TT_VID, + BATADV_ATTR_TT_CRC32, + BATADV_ATTR_TT_FLAGS, +}; + +static int translocal_json_callback(struct nl_msg *msg, void *arg) +{ + struct nlattr *attrs[BATADV_ATTR_MAX+1]; + struct nlmsghdr *nlh = nlmsg_hdr(msg); + struct print_opts *opts = arg; + struct genlmsghdr *ghdr; + uint8_t *addr; + int selected_attrs[5] = { BATADV_ATTR_TT_ADDRESS, + BATADV_ATTR_TT_VID, + BATADV_ATTR_TT_CRC32, + BATADV_ATTR_TT_FLAGS, + BATADV_ATTR_LAST_SEEN_MSECS }; + + if (!genlmsg_valid_hdr(nlh, 0)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + ghdr = nlmsg_data(nlh); + + if (ghdr->cmd != BATADV_CMD_GET_TRANSTABLE_LOCAL) + return NL_OK; + + if (nla_parse(attrs, BATADV_ATTR_MAX, genlmsg_attrdata(ghdr, 0), + genlmsg_len(ghdr), batadv_netlink_policy)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + if (missing_mandatory_attrs(attrs, translocal_mandatory, + ARRAY_SIZE(translocal_mandatory))) { + fputs("Missing attributes from kernel\n", stderr); + exit(1); + } + + addr = nla_data(attrs[BATADV_ATTR_TT_ADDRESS]); + + if (opts->read_opt & MULTICAST_ONLY && !(addr[0] & 0x01)) + return NL_OK; + + if (opts->read_opt & UNICAST_ONLY && (addr[0] & 0x01)) + return NL_OK; + + netlink_print_json_entries(attrs, selected_attrs, + ARRAY_SIZE(selected_attrs), opts); + opts->is_first = 0; + + return NL_OK; +} + +static int netlink_print_translocal_json(struct state *state, char *orig_iface, + int read_opts, float orig_timeout, + float watch_interval) +{ + return netlink_print_common(state, orig_iface, read_opts, + orig_timeout, watch_interval, NULL, + BATADV_CMD_GET_TRANSTABLE_LOCAL, + translocal_json_callback, 1); +} + +static struct debug_table_data batctl_debug_json_translocal = { + .netlink_fn = netlink_print_translocal_json, + .option_unicast_only = 1, + .option_multicast_only = 1, +}; + +COMMAND_NAMED(DEBUGJSON, translocal_json, "tlj", handle_debug_table, + COMMAND_FLAG_MESH_IFACE | COMMAND_FLAG_NETLINK, + &batctl_debug_json_translocal, ""); -- 2.25.1

3 5

[PATCH] batctl: Avoid boolean in structures
by Sven Eckelmann 10 May '21

10 May '21

Booleans inside structures to really only store a single bit of information is often a waste of space because a boolean is stored using multiple bytes. While this is not too relevant for batctl, just use the same way of storing such values as in the rest of batman-adv to avoid different paradigms in related code. Signed-off-by: Sven Eckelmann <sven(a)narfation.org> --- netlink.c | 8 ++++---- throughputmeter.c | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/netlink.c b/netlink.c index 31c9b01..31f4419 100644 --- a/netlink.c +++ b/netlink.c @@ -592,7 +592,7 @@ static const int translate_mac_netlink_mandatory[] = { struct translate_mac_netlink_opts { struct ether_addr mac; - bool found; + uint8_t found:1; struct nlquery_opts query_opts; }; @@ -680,7 +680,7 @@ struct get_nexthop_netlink_opts { struct ether_addr mac; uint8_t *nexthop; char *ifname; - bool found; + uint8_t found:1; struct nlquery_opts query_opts; }; @@ -772,7 +772,7 @@ static const int get_primarymac_netlink_mandatory[] = { struct get_primarymac_netlink_opts { uint8_t *primarymac; - bool found; + uint8_t found:1; struct nlquery_opts query_opts; }; @@ -844,7 +844,7 @@ int get_primarymac_netlink(const char *mesh_iface, uint8_t *primarymac) struct get_algoname_netlink_opts { char *algoname; size_t algoname_len; - bool found; + uint8_t found:1; struct nlquery_opts query_opts; }; diff --git a/throughputmeter.c b/throughputmeter.c index f50f521..4c7ccca 100644 --- a/throughputmeter.c +++ b/throughputmeter.c @@ -38,16 +38,16 @@ static char *tp_mesh_iface; struct tp_result { int error; - bool found; uint32_t cookie; uint8_t return_value; + uint8_t found:1; uint32_t test_time; uint64_t total_bytes; }; struct tp_cookie { int error; - bool found; + uint8_t found:1; uint32_t cookie; }; -- 2.30.2

1 0

batctl: translocal: Simplify evaluation of last_seen
by Sven Eckelmann 10 May '21

10 May '21

The BATADV_ATTR_LAST_SEEN_MSECS is send from the kernel whenever it is relevant for the current local translation table entry. It is therefore not necessary to only read this value when a specific flag is or is not present in BATADV_ATTR_TT_FLAGS. Signed-off-by: Sven Eckelmann <sven(a)narfation.org> diff --git a/translocal.c b/translocal.c index a3ad3da57252b336399bdea8bf2ea21442c9cafe..bac6be9e9bd59c20550068495197d0d3c74564d5 100644 --- a/translocal.c +++ b/translocal.c @@ -89,15 +89,10 @@ static int translocal_callback(struct nl_msg *msg, void *arg) w = 'W'; if (flags & BATADV_TT_CLIENT_ISOLA) i = 'I'; - - if (flags & BATADV_TT_CLIENT_NOPURGE) { + if (flags & BATADV_TT_CLIENT_NOPURGE) p = 'P'; - } else { - if (!attrs[BATADV_ATTR_LAST_SEEN_MSECS]) { - fputs("Received invalid data from kernel.\n", stderr); - exit(1); - } + if (attrs[BATADV_ATTR_LAST_SEEN_MSECS]) { last_seen_msecs = nla_get_u32( attrs[BATADV_ATTR_LAST_SEEN_MSECS]); last_seen_secs = last_seen_msecs / 1000;

1 0

[PATCH] batctl: Realign netlink_policy array
by Sven Eckelmann 10 May '21

10 May '21

The netlink_policy contains an array of structures with several members in it. But the initialization of the entries of this array was not aligned like any other initialization in the batctl code - instead it was tried to have everything on the same same line. This resulted in rather long lines and could result in larger commits which just try to realign the whole table when a new entry with a long identifier was added. Just realign the array to better match the rest of the code. Signed-off-by: Sven Eckelmann <sven(a)narfation.org> --- netlink.c | 280 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 200 insertions(+), 80 deletions(-) diff --git a/netlink.c b/netlink.c index 31c9b01..e0e1e28 100644 --- a/netlink.c +++ b/netlink.c @@ -34,86 +34,206 @@ struct nlquery_opts { }; struct nla_policy batadv_netlink_policy[NUM_BATADV_ATTR] = { - [BATADV_ATTR_VERSION] = { .type = NLA_STRING }, - [BATADV_ATTR_ALGO_NAME] = { .type = NLA_STRING }, - [BATADV_ATTR_MESH_IFINDEX] = { .type = NLA_U32 }, - [BATADV_ATTR_MESH_IFNAME] = { .type = NLA_STRING, - .maxlen = IFNAMSIZ }, - [BATADV_ATTR_MESH_ADDRESS] = { .type = NLA_UNSPEC, - .minlen = ETH_ALEN, - .maxlen = ETH_ALEN }, - [BATADV_ATTR_HARD_IFINDEX] = { .type = NLA_U32 }, - [BATADV_ATTR_HARD_IFNAME] = { .type = NLA_STRING, - .maxlen = IFNAMSIZ }, - [BATADV_ATTR_HARD_ADDRESS] = { .type = NLA_UNSPEC, - .minlen = ETH_ALEN, - .maxlen = ETH_ALEN }, - [BATADV_ATTR_ORIG_ADDRESS] = { .type = NLA_UNSPEC, - .minlen = ETH_ALEN, - .maxlen = ETH_ALEN }, - [BATADV_ATTR_TPMETER_RESULT] = { .type = NLA_U8 }, - [BATADV_ATTR_TPMETER_TEST_TIME] = { .type = NLA_U32 }, - [BATADV_ATTR_TPMETER_BYTES] = { .type = NLA_U64 }, - [BATADV_ATTR_TPMETER_COOKIE] = { .type = NLA_U32 }, - [BATADV_ATTR_PAD] = { .type = NLA_UNSPEC }, - [BATADV_ATTR_ACTIVE] = { .type = NLA_FLAG }, - [BATADV_ATTR_TT_ADDRESS] = { .type = NLA_UNSPEC, - .minlen = ETH_ALEN, - .maxlen = ETH_ALEN }, - [BATADV_ATTR_TT_TTVN] = { .type = NLA_U8 }, - [BATADV_ATTR_TT_LAST_TTVN] = { .type = NLA_U8 }, - [BATADV_ATTR_TT_CRC32] = { .type = NLA_U32 }, - [BATADV_ATTR_TT_VID] = { .type = NLA_U16 }, - [BATADV_ATTR_TT_FLAGS] = { .type = NLA_U32 }, - [BATADV_ATTR_FLAG_BEST] = { .type = NLA_FLAG }, - [BATADV_ATTR_LAST_SEEN_MSECS] = { .type = NLA_U32 }, - [BATADV_ATTR_NEIGH_ADDRESS] = { .type = NLA_UNSPEC, - .minlen = ETH_ALEN, - .maxlen = ETH_ALEN }, - [BATADV_ATTR_TQ] = { .type = NLA_U8 }, - [BATADV_ATTR_THROUGHPUT] = { .type = NLA_U32 }, - [BATADV_ATTR_BANDWIDTH_UP] = { .type = NLA_U32 }, - [BATADV_ATTR_BANDWIDTH_DOWN] = { .type = NLA_U32 }, - [BATADV_ATTR_ROUTER] = { .type = NLA_UNSPEC, - .minlen = ETH_ALEN, - .maxlen = ETH_ALEN }, - [BATADV_ATTR_BLA_OWN] = { .type = NLA_FLAG }, - [BATADV_ATTR_BLA_ADDRESS] = { .type = NLA_UNSPEC, - .minlen = ETH_ALEN, - .maxlen = ETH_ALEN }, - [BATADV_ATTR_BLA_VID] = { .type = NLA_U16 }, - [BATADV_ATTR_BLA_BACKBONE] = { .type = NLA_UNSPEC, - .minlen = ETH_ALEN, - .maxlen = ETH_ALEN }, - [BATADV_ATTR_BLA_CRC] = { .type = NLA_U16 }, - [BATADV_ATTR_DAT_CACHE_IP4ADDRESS] = { .type = NLA_U32 }, - [BATADV_ATTR_DAT_CACHE_HWADDRESS] = { .type = NLA_UNSPEC, - .minlen = ETH_ALEN, - .maxlen = ETH_ALEN }, - [BATADV_ATTR_DAT_CACHE_VID] = { .type = NLA_U16 }, - [BATADV_ATTR_MCAST_FLAGS] = { .type = NLA_U32 }, - [BATADV_ATTR_MCAST_FLAGS_PRIV] = { .type = NLA_U32 }, - [BATADV_ATTR_VLANID] = { .type = NLA_U16 }, - [BATADV_ATTR_AGGREGATED_OGMS_ENABLED] = { .type = NLA_U8 }, - [BATADV_ATTR_AP_ISOLATION_ENABLED] = { .type = NLA_U8 }, - [BATADV_ATTR_ISOLATION_MARK] = { .type = NLA_U32 }, - [BATADV_ATTR_ISOLATION_MASK] = { .type = NLA_U32 }, - [BATADV_ATTR_BONDING_ENABLED] = { .type = NLA_U8 }, - [BATADV_ATTR_BRIDGE_LOOP_AVOIDANCE_ENABLED] = { .type = NLA_U8 }, - [BATADV_ATTR_DISTRIBUTED_ARP_TABLE_ENABLED] = { .type = NLA_U8 }, - [BATADV_ATTR_FRAGMENTATION_ENABLED] = { .type = NLA_U8 }, - [BATADV_ATTR_GW_BANDWIDTH_DOWN] = { .type = NLA_U32 }, - [BATADV_ATTR_GW_BANDWIDTH_UP] = { .type = NLA_U32 }, - [BATADV_ATTR_GW_MODE] = { .type = NLA_U8 }, - [BATADV_ATTR_GW_SEL_CLASS] = { .type = NLA_U32 }, - [BATADV_ATTR_HOP_PENALTY] = { .type = NLA_U8 }, - [BATADV_ATTR_LOG_LEVEL] = { .type = NLA_U32 }, - [BATADV_ATTR_MULTICAST_FORCEFLOOD_ENABLED] = { .type = NLA_U8 }, - [BATADV_ATTR_MULTICAST_FANOUT] = { .type = NLA_U32 }, - [BATADV_ATTR_NETWORK_CODING_ENABLED] = { .type = NLA_U8 }, - [BATADV_ATTR_ORIG_INTERVAL] = { .type = NLA_U32 }, - [BATADV_ATTR_ELP_INTERVAL] = { .type = NLA_U32 }, - [BATADV_ATTR_THROUGHPUT_OVERRIDE] = { .type = NLA_U32 }, + [BATADV_ATTR_VERSION] = { + .type = NLA_STRING, + }, + [BATADV_ATTR_ALGO_NAME] = { + .type = NLA_STRING, + }, + [BATADV_ATTR_MESH_IFINDEX] = { + .type = NLA_U32, + }, + [BATADV_ATTR_MESH_IFNAME] = { + .type = NLA_STRING, + .maxlen = IFNAMSIZ, + }, + [BATADV_ATTR_MESH_ADDRESS] = { + .type = NLA_UNSPEC, + .minlen = ETH_ALEN, + .maxlen = ETH_ALEN, + }, + [BATADV_ATTR_HARD_IFINDEX] = { + .type = NLA_U32, + }, + [BATADV_ATTR_HARD_IFNAME] = { + .type = NLA_STRING, + .maxlen = IFNAMSIZ, + }, + [BATADV_ATTR_HARD_ADDRESS] = { + .type = NLA_UNSPEC, + .minlen = ETH_ALEN, + .maxlen = ETH_ALEN, + }, + [BATADV_ATTR_ORIG_ADDRESS] = { + .type = NLA_UNSPEC, + .minlen = ETH_ALEN, + .maxlen = ETH_ALEN, + }, + [BATADV_ATTR_TPMETER_RESULT] = { + .type = NLA_U8, + }, + [BATADV_ATTR_TPMETER_TEST_TIME] = { + .type = NLA_U32, + }, + [BATADV_ATTR_TPMETER_BYTES] = { + .type = NLA_U64, + }, + [BATADV_ATTR_TPMETER_COOKIE] = { + .type = NLA_U32, + }, + [BATADV_ATTR_PAD] = { + .type = NLA_UNSPEC, + }, + [BATADV_ATTR_ACTIVE] = { + .type = NLA_FLAG, + }, + [BATADV_ATTR_TT_ADDRESS] = { + .type = NLA_UNSPEC, + .minlen = ETH_ALEN, + .maxlen = ETH_ALEN, + }, + [BATADV_ATTR_TT_TTVN] = { + .type = NLA_U8, + }, + [BATADV_ATTR_TT_LAST_TTVN] = { + .type = NLA_U8, + }, + [BATADV_ATTR_TT_CRC32] = { + .type = NLA_U32, + }, + [BATADV_ATTR_TT_VID] = { + .type = NLA_U16, + }, + [BATADV_ATTR_TT_FLAGS] = { + .type = NLA_U32, + }, + [BATADV_ATTR_FLAG_BEST] = { + .type = NLA_FLAG, + }, + [BATADV_ATTR_LAST_SEEN_MSECS] = { + .type = NLA_U32, + }, + [BATADV_ATTR_NEIGH_ADDRESS] = { + .type = NLA_UNSPEC, + .minlen = ETH_ALEN, + .maxlen = ETH_ALEN, + }, + [BATADV_ATTR_TQ] = { + .type = NLA_U8, + }, + [BATADV_ATTR_THROUGHPUT] = { + .type = NLA_U32, + }, + [BATADV_ATTR_BANDWIDTH_UP] = { + .type = NLA_U32, + }, + [BATADV_ATTR_BANDWIDTH_DOWN] = { + .type = NLA_U32, + }, + [BATADV_ATTR_ROUTER] = { + .type = NLA_UNSPEC, + .minlen = ETH_ALEN, + .maxlen = ETH_ALEN, + }, + [BATADV_ATTR_BLA_OWN] = { + .type = NLA_FLAG, + }, + [BATADV_ATTR_BLA_ADDRESS] = { + .type = NLA_UNSPEC, + .minlen = ETH_ALEN, + .maxlen = ETH_ALEN, + }, + [BATADV_ATTR_BLA_VID] = { + .type = NLA_U16, + }, + [BATADV_ATTR_BLA_BACKBONE] = { + .type = NLA_UNSPEC, + .minlen = ETH_ALEN, + .maxlen = ETH_ALEN, + }, + [BATADV_ATTR_BLA_CRC] = { + .type = NLA_U16, + }, + [BATADV_ATTR_DAT_CACHE_IP4ADDRESS] = { + .type = NLA_U32, + }, + [BATADV_ATTR_DAT_CACHE_HWADDRESS] = { + .type = NLA_UNSPEC, + .minlen = ETH_ALEN, + .maxlen = ETH_ALEN, + }, + [BATADV_ATTR_DAT_CACHE_VID] = { + .type = NLA_U16, + }, + [BATADV_ATTR_MCAST_FLAGS] = { + .type = NLA_U32, + }, + [BATADV_ATTR_MCAST_FLAGS_PRIV] = { + .type = NLA_U32, + }, + [BATADV_ATTR_VLANID] = { + .type = NLA_U16, + }, + [BATADV_ATTR_AGGREGATED_OGMS_ENABLED] = { + .type = NLA_U8, + }, + [BATADV_ATTR_AP_ISOLATION_ENABLED] = { + .type = NLA_U8, + }, + [BATADV_ATTR_ISOLATION_MARK] = { + .type = NLA_U32, + }, + [BATADV_ATTR_ISOLATION_MASK] = { + .type = NLA_U32, + }, + [BATADV_ATTR_BONDING_ENABLED] = { + .type = NLA_U8, + }, + [BATADV_ATTR_BRIDGE_LOOP_AVOIDANCE_ENABLED] = { + .type = NLA_U8, + }, + [BATADV_ATTR_DISTRIBUTED_ARP_TABLE_ENABLED] = { + .type = NLA_U8, + }, + [BATADV_ATTR_FRAGMENTATION_ENABLED] = { + .type = NLA_U8, + }, + [BATADV_ATTR_GW_BANDWIDTH_DOWN] = { + .type = NLA_U32, + }, + [BATADV_ATTR_GW_BANDWIDTH_UP] = { + .type = NLA_U32, + }, + [BATADV_ATTR_GW_MODE] = { + .type = NLA_U8, + }, + [BATADV_ATTR_GW_SEL_CLASS] = { + .type = NLA_U32, + }, + [BATADV_ATTR_HOP_PENALTY] = { + .type = NLA_U8, + }, + [BATADV_ATTR_LOG_LEVEL] = { + .type = NLA_U32, + }, + [BATADV_ATTR_MULTICAST_FORCEFLOOD_ENABLED] = { + .type = NLA_U8, + }, + [BATADV_ATTR_NETWORK_CODING_ENABLED] = { + .type = NLA_U8, + }, + [BATADV_ATTR_ORIG_INTERVAL] = { + .type = NLA_U32, + }, + [BATADV_ATTR_ELP_INTERVAL] = { + .type = NLA_U32, + }, + [BATADV_ATTR_THROUGHPUT_OVERRIDE] = { + .type = NLA_U32, + }, + [BATADV_ATTR_MULTICAST_FANOUT] = { + .type = NLA_U32, + }, }; int netlink_create(struct state *state) -- 2.30.2

1 0

[PATCH 1/4] batctl: originators: Get outgoing ifname from netlink
by Sven Eckelmann 10 May '21

10 May '21

There is no need to gather the interface name for an outgoing interface via a different syscall(s) when the kernel directly provides this information in the netlink message for this originator table entry. batman-adv provides this functionality with Linux 5.14/batman-adv 2021.2. Signed-off-by: Sven Eckelmann <sven(a)narfation.org> --- originators.c | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/originators.c b/originators.c index 8a29dd7..11ca4b9 100644 --- a/originators.c +++ b/originators.c @@ -40,12 +40,14 @@ static int originators_callback(struct nl_msg *msg, void *arg) struct nlmsghdr *nlh = nlmsg_hdr(msg); int last_seen_msecs, last_seen_secs; struct print_opts *opts = arg; + char ifname_buf[IF_NAMESIZE]; struct bat_host *bat_host; struct genlmsghdr *ghdr; - char ifname[IF_NAMESIZE]; + uint32_t ifindex; float last_seen; uint8_t *neigh; uint8_t *orig; + char *ifname; char c = ' '; uint8_t tq; @@ -74,9 +76,16 @@ static int originators_callback(struct nl_msg *msg, void *arg) orig = nla_data(attrs[BATADV_ATTR_ORIG_ADDRESS]); neigh = nla_data(attrs[BATADV_ATTR_NEIGH_ADDRESS]); - if (!if_indextoname(nla_get_u32(attrs[BATADV_ATTR_HARD_IFINDEX]), - ifname)) - ifname[0] = '\0'; + if (attrs[BATADV_ATTR_HARD_IFNAME]) { + ifname = nla_get_string(attrs[BATADV_ATTR_HARD_IFNAME]); + } else { + /* compatibility for Linux < 5.14/batman-adv < 2021.2 */ + ifindex = nla_get_u32(attrs[BATADV_ATTR_HARD_IFINDEX]); + if (!if_indextoname(ifindex, ifname_buf)) + ifname_buf[0] = '\0'; + + ifname = ifname_buf; + } if (attrs[BATADV_ATTR_FLAG_BEST]) c = '*'; -- 2.30.2

1 3

[PATCH] batman-adv: Always send iface index+name in genlmsg
by Sven Eckelmann 10 May '21

10 May '21

The batman-adv netlink messages often contain the interface index and interface name in the same message. This makes it easy for the receiver to operate on the incoming data when it either needs to print something or needs to operate on the interface index. But one of the attributes was missing for: * neighbor table dumps * originator table dumps * gateway list dumps * query of hardif information * query of vid information The userspace therefore had to implement special workarounds using SIOCGIFNAME or SIOCGIFINDEX depending on what was actually provided. Providing both information simplifies the userspace code massively without adding a lot of extra overhead in the kernel portion. Signed-off-by: Sven Eckelmann <sven(a)narfation.org> --- net/batman-adv/bat_iv_ogm.c | 6 ++++++ net/batman-adv/bat_v.c | 10 ++++++++++ net/batman-adv/netlink.c | 8 ++++++++ 3 files changed, 24 insertions(+) diff --git a/net/batman-adv/bat_iv_ogm.c b/net/batman-adv/bat_iv_ogm.c index 789f257b..680def80 100644 --- a/net/batman-adv/bat_iv_ogm.c +++ b/net/batman-adv/bat_iv_ogm.c @@ -1849,6 +1849,8 @@ batadv_iv_ogm_orig_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq, orig_node->orig) || nla_put(msg, BATADV_ATTR_NEIGH_ADDRESS, ETH_ALEN, neigh_node->addr) || + nla_put_string(msg, BATADV_ATTR_HARD_IFNAME, + neigh_node->if_incoming->net_dev->name) || nla_put_u32(msg, BATADV_ATTR_HARD_IFINDEX, neigh_node->if_incoming->net_dev->ifindex) || nla_put_u8(msg, BATADV_ATTR_TQ, tq_avg) || @@ -2078,6 +2080,8 @@ batadv_iv_ogm_neigh_dump_neigh(struct sk_buff *msg, u32 portid, u32 seq, if (nla_put(msg, BATADV_ATTR_NEIGH_ADDRESS, ETH_ALEN, hardif_neigh->addr) || + nla_put_string(msg, BATADV_ATTR_HARD_IFNAME, + hardif_neigh->if_incoming->net_dev->name) || nla_put_u32(msg, BATADV_ATTR_HARD_IFINDEX, hardif_neigh->if_incoming->net_dev->ifindex) || nla_put_u32(msg, BATADV_ATTR_LAST_SEEN_MSECS, @@ -2459,6 +2463,8 @@ static int batadv_iv_gw_dump_entry(struct sk_buff *msg, u32 portid, router->addr) || nla_put_string(msg, BATADV_ATTR_HARD_IFNAME, router->if_incoming->net_dev->name) || + nla_put_u32(msg, BATADV_ATTR_HARD_IFINDEX, + router->if_incoming->net_dev->ifindex) || nla_put_u32(msg, BATADV_ATTR_BANDWIDTH_DOWN, gw_node->bandwidth_down) || nla_put_u32(msg, BATADV_ATTR_BANDWIDTH_UP, diff --git a/net/batman-adv/bat_v.c b/net/batman-adv/bat_v.c index e1ca2b8c..b98aea95 100644 --- a/net/batman-adv/bat_v.c +++ b/net/batman-adv/bat_v.c @@ -146,6 +146,8 @@ batadv_v_neigh_dump_neigh(struct sk_buff *msg, u32 portid, u32 seq, if (nla_put(msg, BATADV_ATTR_NEIGH_ADDRESS, ETH_ALEN, hardif_neigh->addr) || + nla_put_string(msg, BATADV_ATTR_HARD_IFNAME, + hardif_neigh->if_incoming->net_dev->name) || nla_put_u32(msg, BATADV_ATTR_HARD_IFINDEX, hardif_neigh->if_incoming->net_dev->ifindex) || nla_put_u32(msg, BATADV_ATTR_LAST_SEEN_MSECS, @@ -298,6 +300,8 @@ batadv_v_orig_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq, if (nla_put(msg, BATADV_ATTR_ORIG_ADDRESS, ETH_ALEN, orig_node->orig) || nla_put(msg, BATADV_ATTR_NEIGH_ADDRESS, ETH_ALEN, neigh_node->addr) || + nla_put_string(msg, BATADV_ATTR_HARD_IFNAME, + neigh_node->if_incoming->net_dev->name) || nla_put_u32(msg, BATADV_ATTR_HARD_IFINDEX, neigh_node->if_incoming->net_dev->ifindex) || nla_put_u32(msg, BATADV_ATTR_THROUGHPUT, throughput) || @@ -739,6 +743,12 @@ static int batadv_v_gw_dump_entry(struct sk_buff *msg, u32 portid, goto out; } + if (nla_put_u32(msg, BATADV_ATTR_HARD_IFINDEX, + router->if_incoming->net_dev->ifindex)) { + genlmsg_cancel(msg, hdr); + goto out; + } + if (nla_put_u32(msg, BATADV_ATTR_BANDWIDTH_DOWN, gw_node->bandwidth_down)) { genlmsg_cancel(msg, hdr); diff --git a/net/batman-adv/netlink.c b/net/batman-adv/netlink.c index f317d206..b6cc746e 100644 --- a/net/batman-adv/netlink.c +++ b/net/batman-adv/netlink.c @@ -814,6 +814,10 @@ static int batadv_netlink_hardif_fill(struct sk_buff *msg, bat_priv->soft_iface->ifindex)) goto nla_put_failure; + if (nla_put_string(msg, BATADV_ATTR_MESH_IFNAME, + bat_priv->soft_iface->name)) + goto nla_put_failure; + if (nla_put_u32(msg, BATADV_ATTR_HARD_IFINDEX, net_dev->ifindex) || nla_put_string(msg, BATADV_ATTR_HARD_IFNAME, @@ -1045,6 +1049,10 @@ static int batadv_netlink_vlan_fill(struct sk_buff *msg, bat_priv->soft_iface->ifindex)) goto nla_put_failure; + if (nla_put_string(msg, BATADV_ATTR_MESH_IFNAME, + bat_priv->soft_iface->name)) + goto nla_put_failure; + if (nla_put_u32(msg, BATADV_ATTR_VLANID, vlan->vid & VLAN_VID_MASK)) goto nla_put_failure; -- 2.30.2

1 0

[PATCH v2 1/2] batctl: Add generic JSON interface
by Alexander Sarmanow 07 May '21

07 May '21

To print JSON strings in a generic way a second nla_policy is used, with a name (dict key) and a callback function for each entry corresponding to its formats. There are multiple callback functions created, most of them are straight forward. The nljson_print_ttflags() needed more logic behind it, because of its dependency with the last_seen_msecs entry and whether local or global table is requested. Signed-off-by: Alexander Sarmanow <asarmanow(a)gmail.com> --- backbonetable.c | 2 +- claimtable.c | 2 +- dat_cache.c | 2 +- gateways.c | 2 +- main.h | 2 + mcast_flags.c | 2 +- neighbors.c | 2 +- netlink.c | 282 +++++++++++++++++++++++++++++++++++++++++++++++- netlink.h | 37 ++++++- originators.c | 2 +- transglobal.c | 2 +- translocal.c | 2 +- 12 files changed, 328 insertions(+), 11 deletions(-) diff --git a/backbonetable.c b/backbonetable.c index 17fbd1d..11cec32 100644 --- a/backbonetable.c +++ b/backbonetable.c @@ -98,7 +98,7 @@ static int netlink_print_bla_backbone(struct state *state, char *orig_iface, orig_timeout, watch_interval, "Originator VID last seen (CRC )\n", BATADV_CMD_GET_BLA_BACKBONE, - bla_backbone_callback); + bla_backbone_callback, 0); } static struct debug_table_data batctl_debug_table_backbonetable = { diff --git a/claimtable.c b/claimtable.c index b6bf9f5..0bf017d 100644 --- a/claimtable.c +++ b/claimtable.c @@ -103,7 +103,7 @@ static int netlink_print_bla_claim(struct state *state, char *orig_iface, orig_timeout, watch_interval, "Client VID Originator [o] (CRC )\n", BATADV_CMD_GET_BLA_CLAIM, - bla_claim_callback); + bla_claim_callback, 0); } static struct debug_table_data batctl_debug_table_claimtable = { diff --git a/dat_cache.c b/dat_cache.c index 8d47171..109e553 100644 --- a/dat_cache.c +++ b/dat_cache.c @@ -116,7 +116,7 @@ static int netlink_print_dat_cache(struct state *state, char *orig_iface, ret = netlink_print_common(state, orig_iface, read_opts, orig_timeout, watch_interval, header, BATADV_CMD_GET_DAT_CACHE, - dat_cache_callback); + dat_cache_callback, 0); free(header); return ret; diff --git a/gateways.c b/gateways.c index 7625bd8..867c882 100644 --- a/gateways.c +++ b/gateways.c @@ -141,7 +141,7 @@ static int netlink_print_gateways(struct state *state, char *orig_iface, orig_timeout, watch_interval, header, BATADV_CMD_GET_GATEWAYS, - gateways_callback); + gateways_callback, 0); } static struct debug_table_data batctl_debug_table_gateways = { diff --git a/main.h b/main.h index 81b7a27..b1ff050 100644 --- a/main.h +++ b/main.h @@ -44,6 +44,8 @@ extern char module_ver_path[]; #define ARRAY_SIZE(x) (sizeof(x) / sizeof(*(x))) +#define BOOL_STRING(x) (x ? "true" : "false") + #ifndef container_of #define container_of(ptr, type, member) __extension__ ({ \ const __typeof__(((type *)0)->member) *__pmember = (ptr); \ diff --git a/mcast_flags.c b/mcast_flags.c index 721f549..cb6e89d 100644 --- a/mcast_flags.c +++ b/mcast_flags.c @@ -147,7 +147,7 @@ static int netlink_print_mcast_flags(struct state *state, char *orig_iface, ret = netlink_print_common(state, orig_iface, read_opts, orig_timeout, watch_interval, header, BATADV_CMD_GET_MCAST_FLAGS, - mcast_flags_callback); + mcast_flags_callback, 0); free(header); return ret; diff --git a/neighbors.c b/neighbors.c index af76d0f..2a50e78 100644 --- a/neighbors.c +++ b/neighbors.c @@ -114,7 +114,7 @@ static int netlink_print_neighbors(struct state *state, char *orig_iface, orig_timeout, watch_interval, "IF Neighbor last-seen\n", BATADV_CMD_GET_NEIGHBORS, - neighbors_callback); + neighbors_callback, 0); } static struct debug_table_data batctl_debug_table_neighbors = { diff --git a/netlink.c b/netlink.c index 31c9b01..26ae5ef 100644 --- a/netlink.c +++ b/netlink.c @@ -13,6 +13,7 @@ #include <stdio.h> #include <string.h> #include <unistd.h> +#include <ctype.h> #include <errno.h> #include <net/ethernet.h> #include <net/if.h> @@ -116,6 +117,50 @@ struct nla_policy batadv_netlink_policy[NUM_BATADV_ATTR] = { [BATADV_ATTR_THROUGHPUT_OVERRIDE] = { .type = NLA_U32 }, }; +struct nla_policy_json batadv_netlink_policy_json[NUM_BATADV_ATTR] = { + [BATADV_ATTR_VERSION] = { .name = "version", + .cb = nljson_print_str }, + [BATADV_ATTR_ALGO_NAME] = { .name = "algo", + .cb = nljson_print_str }, + [BATADV_ATTR_MESH_IFINDEX] = { .name = "mesh_if_idx", + .cb = nljson_print_ifname_by_ifindex }, + [BATADV_ATTR_MESH_IFNAME] = { .name = "mesh_if", + .cb = nljson_print_str }, + [BATADV_ATTR_MESH_ADDRESS] = { .name = "mesh_address", + .cb = nljson_print_mac}, + [BATADV_ATTR_ORIG_ADDRESS] = { .name = "originator", + .cb = nljson_print_mac }, + [BATADV_ATTR_HARD_IFINDEX] = { .name = "hard_if_idx", + .cb = nljson_print_ifname_by_ifindex }, + [BATADV_ATTR_HARD_IFNAME] = { .name = "hard_if", + .cb = nljson_print_str }, + [BATADV_ATTR_HARD_ADDRESS] = { .name = "hard_addr", + .cb = nljson_print_mac }, + [BATADV_ATTR_TT_ADDRESS] = { .name = "client", + .cb = nljson_print_mac }, + [BATADV_ATTR_TT_TTVN] = { .name = "ttvn", + .cb = nljson_print_uint8_t }, + [BATADV_ATTR_TT_LAST_TTVN] = { .name = "last_ttvn", + .cb = nljson_print_uint8_t }, + [BATADV_ATTR_TT_CRC32] = { .name = "crc32", + .cb = nljson_print_crc32 }, + [BATADV_ATTR_TT_VID] = { .name = "vid", + .cb = nljson_print_vid }, + [BATADV_ATTR_TT_FLAGS] = { .name = "flags", + .cb = nljson_print_ttflags }, + [BATADV_ATTR_FLAG_BEST] = { .name = "best", + .cb = nljson_print_bool}, + [BATADV_ATTR_LAST_SEEN_MSECS] = { .name = "last_seen", + .cb = nljson_print_int}, + [BATADV_ATTR_NEIGH_ADDRESS] = { .name = "neighbor", + .cb = nljson_print_mac }, + [BATADV_ATTR_TQ] = { .name = "tq", + .cb = nljson_print_uint8_t }, + [BATADV_ATTR_THROUGHPUT] = { .name = "throughput", + .cb = nljson_print_unsigned }, + [BATADV_ATTR_BLA_CRC] = { .name = "bla_crc",}, +}; + int netlink_create(struct state *state) { int ret; @@ -419,7 +464,7 @@ int netlink_print_common_cb(struct nl_msg *msg, void *arg) int netlink_print_common(struct state *state, char *orig_iface, int read_opt, float orig_timeout, float watch_interval, const char *header, uint8_t nl_cmd, - nl_recvmsg_msg_cb_t callback) + nl_recvmsg_msg_cb_t callback, uint8_t is_json) { struct print_opts opts = { .read_opt = read_opt, @@ -427,6 +472,9 @@ int netlink_print_common(struct state *state, char *orig_iface, int read_opt, .watch_interval = watch_interval, .remaining_header = NULL, .callback = callback, + .nl_cmd = nl_cmd, + .is_json = is_json, + .is_first = 1, }; int hardifindex = 0; struct nl_msg *msg; @@ -495,6 +543,238 @@ int netlink_print_common(struct state *state, char *orig_iface, int read_opt, return last_err; } +void netlink_print_json_entries(struct nlattr *attrs[], int selected_attrs[], + int arr_len, struct print_opts *opts) +{ + const char *name; + uint8_t first_valid_attr = 1; + int idx, i; + struct json_opts json_opts = { + .use_alt_int_val = 0, + .alt_int_val = 0, + }; + + + if (!opts->is_first) + printf(","); + + for (i = 0; i < arr_len; i++) { + idx = selected_attrs[i]; + + if (attrs[idx] && batadv_netlink_policy_json[idx].cb) { + if (!first_valid_attr) + printf(","); + else + printf("{"); + + create_json_print_string(batadv_netlink_policy_json[idx].name, + &name); + sanitize_string(name, strlen(name)); + printf(":"); + batadv_netlink_policy_json[idx].cb(&json_opts, opts, + attrs, idx); + + first_valid_attr = 0; + } + } + if (!first_valid_attr) + printf("}"); +} + +void nljson_print_str(struct json_opts *json_opts, struct print_opts *opts, + struct nlattr *attrs[], int idx) +{ + (void) json_opts; + (void) opts; + const char *value; + const char *value_print; + + value = nla_get_string(attrs[idx]); + + create_json_print_string(value, &value_print); + sanitize_string(value_print, strlen(value_print)); +} + +void nljson_print_ifname_by_ifindex(struct json_opts *json_opts, + struct print_opts *opts, struct nlattr *attrs[], + int idx) +{ + (void) opts; + (void) json_opts; + char value[IF_NAMESIZE]; + const char *value_buf; + + if (!if_indextoname(nla_get_u32(attrs[idx]), value)) + value[0] = '\0'; + + create_json_print_string(value, &value_buf); + sanitize_string(value_buf, strlen(value_buf)); +} + +void nljson_print_int(struct json_opts *json_opts, struct print_opts *opts, + struct nlattr *attrs[], int idx) +{ + (void) opts; + int value; + + if (json_opts->use_alt_int_val) { + json_opts->use_alt_int_val = 0; + value = json_opts->alt_int_val; + } else { + value = nla_get_u32(attrs[idx]); + } + + printf("%d", value); +} + +void nljson_print_unsigned(struct json_opts *json_opts, struct print_opts *opts, + struct nlattr *attrs[], int idx) +{ + (void) json_opts; + (void) opts; + unsigned value = nla_get_u32(attrs[idx]); + printf("%u", value); +} + +void nljson_print_uint8_t(struct json_opts *json_opts, struct print_opts *opts, + struct nlattr *attrs[], int idx) +{ + (void) json_opts; + (void) opts; + uint8_t value = nla_get_u8(attrs[idx]); + printf("%u", value); +} + +void nljson_print_mac(struct json_opts *json_opts, struct print_opts *opts, + struct nlattr *attrs[], int idx) +{ + (void) json_opts; + (void) opts; + uint8_t *value = nla_data(attrs[idx]); + printf("\"%02x:%02x:%02x:%02x:%02x:%02x\"", + value[0], value[1], value[2], value[3], value[4], value[5]); +} + +void nljson_print_bool(struct json_opts *json_opts, struct print_opts *opts, + struct nlattr *attrs[], int idx) +{ + (void) json_opts; + (void) opts; + bool value = nla_get_flag(attrs[idx]); + printf("%s", BOOL_STRING(value)); +} + +void nljson_print_vid(struct json_opts *json_opts, struct print_opts *opts, + struct nlattr *attrs[], int idx) +{ + (void) json_opts; + (void) opts; + int16_t value = nla_get_u16(attrs[idx]); + printf("%i", BATADV_PRINT_VID(value)); +} + +void nljson_print_crc32(struct json_opts *json_opts, struct print_opts *opts, + struct nlattr *attrs[], int idx) +{ + (void) json_opts; + (void) opts; + int32_t value = nla_get_u32(attrs[idx]); + printf("\"0x%.8x\"", value); +} + +void nljson_print_ttflags(struct json_opts *json_opts, struct print_opts *opts, + struct nlattr *attrs[], int idx) +{ + const char *key_ls; + uint32_t flags; + char r, n, x, w, i, p, t; + + flags = nla_get_u32(attrs[idx]); + + r = '.', p = '.', n = '.', x = '.', w = '.', i = '.', t = '.'; + + if (opts->nl_cmd == BATADV_CMD_GET_TRANSTABLE_LOCAL) { + // last_seen = 0 when flags are set + json_opts->use_alt_int_val = 0; + json_opts->alt_int_val = 0; + + if (flags & BATADV_TT_CLIENT_ROAM) + r = 'R'; + if (flags & BATADV_TT_CLIENT_NEW) + n = 'N'; + if (flags & BATADV_TT_CLIENT_PENDING) + x = 'X'; + if (flags & BATADV_TT_CLIENT_WIFI) + w = 'W'; + if (flags & BATADV_TT_CLIENT_ISOLA) + i = 'I'; + if (flags & BATADV_TT_CLIENT_NOPURGE) { + p = 'P'; + } else { + if (!attrs[BATADV_ATTR_LAST_SEEN_MSECS]) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + goto print_local_table; + } + + json_opts->use_alt_int_val = 1; + goto print_local_table; + } else { + if (flags & BATADV_TT_CLIENT_ROAM) + r = 'R'; + if (flags & BATADV_TT_CLIENT_WIFI) + w = 'W'; + if (flags & BATADV_TT_CLIENT_ISOLA) + i = 'I'; + if (flags & BATADV_TT_CLIENT_TEMP) + t = 'T'; + + goto print_global_table; + } + +print_local_table: + printf("\"%c%c%c%c%c%c\"", r, n, x, w, i, p); + + printf(","); + create_json_print_string(batadv_netlink_policy_json[BATADV_ATTR_LAST_SEEN_MSECS].name, + &key_ls); + sanitize_string(key_ls, strlen(key_ls)); + printf(":"); + nljson_print_int(json_opts, opts, attrs, BATADV_ATTR_LAST_SEEN_MSECS); + + return; + +print_global_table: + printf("\"%c%c%c%c\"", r, w, i, t); +} + +void create_json_print_string(const char *str, const char **str_ret) +{ + size_t needed = snprintf(NULL, 0, "\"%s\"", str); + char *str_buf = malloc(needed+1); + + sprintf(str_buf, "\"%s\"", str); + + *str_ret = str_buf; +} + +void sanitize_string(const char *str, int str_len) +{ + int i; + + for (i = 0; i < str_len; i++) { + if (str[i] == '"') + printf("\""); + else if (str[i] == '\\') + printf("\\\\"); + else if (!isprint(str[i])) + printf("\\x%02x", str[i]); + else + printf("%c", str[i]); + } +} + static int nlquery_error_cb(struct sockaddr_nl *nla __maybe_unused, struct nlmsgerr *nlerr, void *arg) { diff --git a/netlink.h b/netlink.h index 4ee2f39..c766741 100644 --- a/netlink.h +++ b/netlink.h @@ -21,8 +21,22 @@ struct print_opts { float watch_interval; nl_recvmsg_msg_cb_t callback; char *remaining_header; + char *remaining_entry; const char *static_header; uint8_t nl_cmd; + uint8_t is_json; + uint8_t is_first; +}; + +struct json_opts { + uint8_t use_alt_int_val; + int alt_int_val; +}; + +struct nla_policy_json { + const char *name; + void (*cb)(struct json_opts *json_opts, struct print_opts *opts, + struct nlattr *attrs[], int idx); }; struct ether_addr; @@ -40,13 +54,14 @@ int get_algoname_netlink(const char *mesh_iface, char *algoname, size_t algoname_len); extern struct nla_policy batadv_netlink_policy[]; +extern struct nla_policy_json batadv_netlink_policy_json[]; int missing_mandatory_attrs(struct nlattr *attrs[], const int mandatory[], int num); int netlink_print_common(struct state *state, char *orig_iface, int read_opt, float orig_timeout, float watch_interval, const char *header, uint8_t nl_cmd, - nl_recvmsg_msg_cb_t callback); + nl_recvmsg_msg_cb_t callback, uint8_t is_json); int netlink_print_common_cb(struct nl_msg *msg, void *arg); int netlink_stop_callback(struct nl_msg *msg, void *arg); @@ -54,6 +69,26 @@ int netlink_print_error(struct sockaddr_nl *nla, struct nlmsgerr *nlerr, void *arg); void netlink_print_remaining_header(struct print_opts *opts); +void netlink_print_json_entries(struct nlattr *attrs[], int selected_attrs[], + int arr_len, struct print_opts *opts); +void netlink_print_json_entry(struct nlattr *attrs[], int idx); +void nljson_print_str(struct json_opts *json_opts, struct print_opts *opts, struct nlattr *attrs[], int idx); +void nljson_print_ifname_by_ifindex(struct json_opts *json_opts, struct print_opts *opts, + struct nlattr *attrs[], int idx); +void nljson_print_int(struct json_opts *json_opts, struct print_opts *opts, struct nlattr *attrs[], int idx); +void nljson_print_unsigned(struct json_opts *json_opts, struct print_opts *opts, struct nlattr *attrs[], + int idx); +void nljson_print_uint8_t(struct json_opts *json_opts, struct print_opts *opts, struct nlattr *attrs[], + int idx); +void nljson_print_vid(struct json_opts *json_opts, struct print_opts *opts, struct nlattr *attrs[], int idx); +void nljson_print_crc32(struct json_opts *json_opts, struct print_opts *opts, struct nlattr *attrs[], int idx); +void nljson_print_mac(struct json_opts *json_opts, struct print_opts *opts, struct nlattr *attrs[], int idx); +void nljson_print_bool(struct json_opts *json_opts, struct print_opts *opts, struct nlattr *attrs[], int idx); +void nljson_print_ttflags(struct json_opts *json_opts, struct print_opts *opts, struct nlattr *attrs[], + int idx); +void create_json_print_string(const char *str, const char **str_ret); +void sanitize_string(const char *str, int str_len); + extern char algo_name_buf[256]; extern int last_err; extern int64_t mcast_flags; diff --git a/originators.c b/originators.c index 8a29dd7..674656c 100644 --- a/originators.c +++ b/originators.c @@ -192,7 +192,7 @@ static int netlink_print_originators(struct state *state, char *orig_iface, return netlink_print_common(state, orig_iface, read_opts, orig_timeout, watch_interval, header, BATADV_CMD_GET_ORIGINATORS, - originators_callback); + originators_callback, 0); } static struct debug_table_data batctl_debug_table_originators = { diff --git a/transglobal.c b/transglobal.c index 4eae95d..c9312c0 100644 --- a/transglobal.c +++ b/transglobal.c @@ -132,7 +132,7 @@ static int netlink_print_transglobal(struct state *state, char *orig_iface, orig_timeout, watch_interval, " Client VID Flags Last ttvn Via ttvn (CRC )\n", BATADV_CMD_GET_TRANSTABLE_GLOBAL, - transglobal_callback); + transglobal_callback, 0); } static struct debug_table_data batctl_debug_table_transglobal = { diff --git a/translocal.c b/translocal.c index a3ad3da..7753010 100644 --- a/translocal.c +++ b/translocal.c @@ -128,7 +128,7 @@ static int netlink_print_translocal(struct state *state, char *orig_iface, orig_timeout, watch_interval, "Client VID Flags Last seen (CRC )\n", BATADV_CMD_GET_TRANSTABLE_LOCAL, - translocal_callback); + translocal_callback, 0); } static struct debug_table_data batctl_debug_table_translocal = { -- 2.25.1

2 1

How to mesh over ethernet VLAN?
by Andi Depressivum 04 May '21

04 May '21

Hello everybody, What's the correct setup to mesh also over an existing ethernet VLAN link? My core network with all routers & servers is running on VLAN 3 (eth0.3 in the routers). How do I have to setup batman-adv to a) mesh also over this existing link and b) propagate this VLAN also over wireless links. Bridging eth0.3 with bat0.3 and adding eth0.3 also as a hardif doesn't work, as it will remove eth0.3 from the bridge. If I add eth0 instead as hardif the routers are only seeing each other over wireless link. Or do I have to use a separate VLAN for ethernet meshing which isn't bridged to a bat0.X interface? Thanks a lot!

2 6

[PATCH] batctl: Add JSON debug support
by Alexander Sarmanow 28 Apr '21

28 Apr '21

A JSON output of the debug tables is still missing. Corresponding JSON output is added for originators, neighbors, translocal, transglobal and interfaces tables. Same parameters of the debug tables can be used for the JSON, except the "-w [interval]" (not useful). The table header is implemented as a JSON equivalent and can be also optionally omitted. Signed-off-by: Alexander Sarmanow <asarmanow(a)gmail.com> --- Makefile | 5 ++ backbonetable.c | 2 +- claimtable.c | 2 +- dat_cache.c | 2 +- debug.c | 15 +++- gateways.c | 4 +- interfaces_json.c | 167 +++++++++++++++++++++++++++++++++++++++++++++ main.c | 14 ++-- main.h | 3 + mcast_flags.c | 4 +- neighbors.c | 2 +- neighbors_json.c | 109 +++++++++++++++++++++++++++++ netlink.c | 70 +++++++++++++++---- netlink.h | 9 ++- originators.c | 4 +- originators_json.c | 154 +++++++++++++++++++++++++++++++++++++++++ transglobal.c | 2 +- transglobal_json.c | 146 +++++++++++++++++++++++++++++++++++++++ translocal.c | 2 +- translocal_json.c | 139 +++++++++++++++++++++++++++++++++++++ 20 files changed, 823 insertions(+), 32 deletions(-) create mode 100644 interfaces_json.c create mode 100644 neighbors_json.c create mode 100644 originators_json.c create mode 100644 transglobal_json.c create mode 100644 translocal_json.c diff --git a/Makefile b/Makefile index 98bf695..84c5de6 100755 --- a/Makefile +++ b/Makefile @@ -71,6 +71,11 @@ $(eval $(call add_command,traceroute,y)) $(eval $(call add_command,transglobal,y)) $(eval $(call add_command,translate,y)) $(eval $(call add_command,translocal,y)) +$(eval $(call add_command,originators_json,y)) +$(eval $(call add_command,neighbors_json,y)) +$(eval $(call add_command,translocal_json,y)) +$(eval $(call add_command,transglobal_json,y)) +$(eval $(call add_command,interfaces_json,y)) MANPAGE = man/batctl.8 diff --git a/backbonetable.c b/backbonetable.c index 17fbd1d..714ae55 100644 --- a/backbonetable.c +++ b/backbonetable.c @@ -98,7 +98,7 @@ static int netlink_print_bla_backbone(struct state *state, char *orig_iface, orig_timeout, watch_interval, "Originator VID last seen (CRC )\n", BATADV_CMD_GET_BLA_BACKBONE, - bla_backbone_callback); + bla_backbone_callback, false); } static struct debug_table_data batctl_debug_table_backbonetable = { diff --git a/claimtable.c b/claimtable.c index b6bf9f5..a1c3868 100644 --- a/claimtable.c +++ b/claimtable.c @@ -103,7 +103,7 @@ static int netlink_print_bla_claim(struct state *state, char *orig_iface, orig_timeout, watch_interval, "Client VID Originator [o] (CRC )\n", BATADV_CMD_GET_BLA_CLAIM, - bla_claim_callback); + bla_claim_callback, false); } static struct debug_table_data batctl_debug_table_claimtable = { diff --git a/dat_cache.c b/dat_cache.c index 8d47171..15a212b 100644 --- a/dat_cache.c +++ b/dat_cache.c @@ -116,7 +116,7 @@ static int netlink_print_dat_cache(struct state *state, char *orig_iface, ret = netlink_print_common(state, orig_iface, read_opts, orig_timeout, watch_interval, header, BATADV_CMD_GET_DAT_CACHE, - dat_cache_callback); + dat_cache_callback, false); free(header); return ret; diff --git a/debug.c b/debug.c index 458c137..5d5024e 100644 --- a/debug.c +++ b/debug.c @@ -27,7 +27,9 @@ static void debug_table_usage(struct state *state) fprintf(stderr, " \t -h print this help\n"); fprintf(stderr, " \t -n don't replace mac addresses with bat-host names\n"); fprintf(stderr, " \t -H don't show the header\n"); - fprintf(stderr, " \t -w [interval] watch mode - refresh the table continuously\n"); + + if (state->cmd->type != DEBUGJSON) + fprintf(stderr, " \t -w [interval] watch mode - refresh the table continuously\n"); if (debug_table->option_timeout_interval) fprintf(stderr, " \t -t timeout interval - don't print originators not seen for x.y seconds \n"); @@ -60,6 +62,12 @@ int handle_debug_table(struct state *state, int argc, char **argv) read_opt &= ~USE_BAT_HOSTS; break; case 'w': + if (state->cmd->type == DEBUGJSON) { + fprintf(stderr, "Error - unrecognised option '-%c'\n", optchar); + debug_table_usage(state); + return EXIT_FAILURE; + } + read_opt |= CLR_CONT_READ; if (optarg[0] == '-') { optind--; @@ -123,6 +131,11 @@ int handle_debug_table(struct state *state, int argc, char **argv) } else if (optopt == 'i') { fprintf(stderr, "Error - option '-i' needs an interface as argument\n"); } else if (optopt == 'w') { + if (state->cmd->type == DEBUGJSON) { + fprintf(stderr, "Error - unrecognised option '-w'\n"); + debug_table_usage(state); + return EXIT_FAILURE; + } read_opt |= CLR_CONT_READ; break; } diff --git a/gateways.c b/gateways.c index 7625bd8..4bfa1ed 100644 --- a/gateways.c +++ b/gateways.c @@ -123,7 +123,7 @@ static int netlink_print_gateways(struct state *state, char *orig_iface, /* only parse routing algorithm name */ last_err = -EINVAL; info_header = netlink_get_info(state->mesh_ifindex, - BATADV_CMD_GET_ORIGINATORS, NULL); + BATADV_CMD_GET_ORIGINATORS, NULL, false); free(info_header); if (strlen(algo_name_buf) == 0) @@ -141,7 +141,7 @@ static int netlink_print_gateways(struct state *state, char *orig_iface, orig_timeout, watch_interval, header, BATADV_CMD_GET_GATEWAYS, - gateways_callback); + gateways_callback, false); } static struct debug_table_data batctl_debug_table_gateways = { diff --git a/interfaces_json.c b/interfaces_json.c new file mode 100644 index 0000000..65cde95 --- /dev/null +++ b/interfaces_json.c @@ -0,0 +1,167 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (C) B.A.T.M.A.N. contributors: + * + * Marek Lindner <mareklindner(a)neomailbox.ch> + * Alexander Sarmanow <asarmanow(a)gmail.com> + * + * License-Filename: LICENSES/preferred/GPL-2.0 + */ + +#include <unistd.h> +#include <stdio.h> +#include <stdbool.h> +#include <stdlib.h> +#include <string.h> +#include <errno.h> +#include <dirent.h> +#include <net/if.h> +#include <linux/if_link.h> +#include <linux/rtnetlink.h> +#include <netlink/netlink.h> +#include <netlink/msg.h> +#include <netlink/attr.h> + +#include "main.h" +#include "sys.h" +#include "functions.h" +#include "debug.h" + +#define IFACE_STATUS_LEN 256 + +static int get_iface_status_netlink_parse(struct nl_msg *msg, void *arg) +{ + struct nlattr *attrs[NUM_BATADV_ATTR]; + struct nlmsghdr *nlh = nlmsg_hdr(msg); + char *iface_status = arg; + struct genlmsghdr *ghdr; + + if (!genlmsg_valid_hdr(nlh, 0)) + return NL_OK; + + ghdr = nlmsg_data(nlh); + if (ghdr->cmd != BATADV_CMD_GET_HARDIF) + return NL_OK; + + if (nla_parse(attrs, BATADV_ATTR_MAX, genlmsg_attrdata(ghdr, 0), + genlmsg_len(ghdr), batadv_netlink_policy)) + return NL_OK; + + if (attrs[BATADV_ATTR_ACTIVE]) + strncpy(iface_status, "active", IFACE_STATUS_LEN); + else + strncpy(iface_status, "inactive", IFACE_STATUS_LEN); + + iface_status[IFACE_STATUS_LEN - 1] = '\0'; + + return NL_STOP; +} + +static char *get_iface_status_netlink(unsigned int meshif, unsigned int hardif, + char *iface_status) +{ + char *ret_status = NULL; + struct nl_sock *sock; + struct nl_msg *msg; + int batadv_family; + struct nl_cb *cb; + int ret; + + iface_status[0] = '\0'; + + sock = nl_socket_alloc(); + if (!sock) + return NULL; + + ret = genl_connect(sock); + if (ret < 0) + goto err_free_sock; + + batadv_family = genl_ctrl_resolve(sock, BATADV_NL_NAME); + if (batadv_family < 0) + goto err_free_sock; + + cb = nl_cb_alloc(NL_CB_DEFAULT); + if (!cb) + goto err_free_sock; + + nl_cb_set(cb, NL_CB_VALID, NL_CB_CUSTOM, get_iface_status_netlink_parse, + iface_status); + + msg = nlmsg_alloc(); + if (!msg) + goto err_free_cb; + + genlmsg_put(msg, NL_AUTO_PID, NL_AUTO_SEQ, batadv_family, + 0, 0, BATADV_CMD_GET_HARDIF, 1); + + nla_put_u32(msg, BATADV_ATTR_MESH_IFINDEX, meshif); + nla_put_u32(msg, BATADV_ATTR_HARD_IFINDEX, hardif); + + ret = nl_send_auto_complete(sock, msg); + if (ret < 0) + goto err_free_msg; + + nl_recvmsgs(sock, cb); + + if (strlen(iface_status) > 0) + ret_status = iface_status; + +err_free_msg: + nlmsg_free(msg); +err_free_cb: + nl_cb_put(cb); +err_free_sock: + nl_socket_free(sock); + + return ret_status; +} + +static int interfaces_callback(struct nl_msg *msg, void *arg) +{ + struct nlattr *attrs[BATADV_ATTR_MAX+1]; + struct nlmsghdr *nlh = nlmsg_hdr(msg); + struct print_opts *opts = arg; + struct genlmsghdr *ghdr; + char iface_status[IFACE_STATUS_LEN]; + const char *status; + char *ifname; + int ifindex; + int master; + + ghdr = nlmsg_data(nlh); + + if (nla_parse(attrs, BATADV_ATTR_MAX, genlmsg_attrdata(ghdr, 0), + genlmsg_len(ghdr), batadv_netlink_policy)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + ifname = nla_data(attrs[BATADV_ATTR_HARD_IFNAME]); + master = nla_get_u32(attrs[BATADV_ATTR_MESH_IFINDEX]); + ifindex = nla_get_u32(attrs[BATADV_ATTR_HARD_IFINDEX]); + + status = get_iface_status_netlink(master, ifindex, iface_status); + if (!status) + status = "<error reading status>\n"; + + printf("{\"%s\":\"%s\"}", ifname, status); + + return NL_OK; +} + +static int netlink_print_interfaces_json(struct state *state, char *orig_iface, + int read_opts, float orig_timeout, + float watch_interval) +{ + return netlink_print_common(state, orig_iface, read_opts, orig_timeout, + watch_interval, NULL, BATADV_CMD_GET_HARDIF, + interfaces_callback, true); +} + +static struct debug_table_data batctl_debug_table_interfaces = { + .netlink_fn = netlink_print_interfaces_json, +}; + +COMMAND_NAMED(DEBUGJSON, interfaces_json, "ifj", handle_debug_table, + COMMAND_FLAG_MESH_IFACE | COMMAND_FLAG_NETLINK, + &batctl_debug_table_interfaces, ""); diff --git a/main.c b/main.c index d9b63f3..1371bc0 100644 --- a/main.c +++ b/main.c @@ -43,6 +43,10 @@ static void print_usage(void) .label = "debug tables: \tdisplay the corresponding debug table\n", .types = BIT(DEBUGTABLE), }, + { + .label = "debug JSONs: \tdisplay the corresponding debug JSON\n", + .types = BIT(DEBUGJSON), + }, }; const char *default_prefixes[] = { "", @@ -67,9 +71,9 @@ static void print_usage(void) char buf[64]; size_t i; - fprintf(stderr, "Usage: batctl [options] command|debug table [parameters]\n"); + fprintf(stderr, "Usage: batctl [options] command|debug table|debug json [parameters]\n"); fprintf(stderr, "options:\n"); - fprintf(stderr, " \t-h print this help (or 'batctl <command|debug table> -h' for the parameter help)\n"); + fprintf(stderr, " \t-h print this help (or 'batctl <command|debug table|debug json> -h' for the parameter help)\n"); fprintf(stderr, " \t-v print version\n"); for (i = 0; i < sizeof(type) / sizeof(*type); i++) { @@ -87,6 +91,7 @@ static void print_usage(void) continue; switch (cmd->type) { + case DEBUGJSON: case DEBUGTABLE: case SUBCOMMAND_MIF: prefixes = meshif_prefixes; @@ -167,7 +172,8 @@ static const struct command *find_command(struct state *state, const char *name) /* fall through */ case SP_MESHIF: types |= BIT(SUBCOMMAND_MIF) | - BIT(DEBUGTABLE); + BIT(DEBUGTABLE) | + BIT(DEBUGJSON); break; case SP_VLAN: types = BIT(SUBCOMMAND_VID); @@ -380,7 +386,7 @@ int main(int argc, char **argv) cmd = find_command(&state, argv[0]); if (!cmd) { fprintf(stderr, - "Error - no valid command or debug table specified: %s\n", + "Error - no valid command or debug table/JSON specified: %s\n", argv[0]); goto err; } diff --git a/main.h b/main.h index 81b7a27..2efd136 100644 --- a/main.h +++ b/main.h @@ -44,6 +44,8 @@ extern char module_ver_path[]; #define ARRAY_SIZE(x) (sizeof(x) / sizeof(*(x))) +#define BOOL_STRING(x) (x ? "true" : "false") + #ifndef container_of #define container_of(ptr, type, member) __extension__ ({ \ const __typeof__(((type *)0)->member) *__pmember = (ptr); \ @@ -69,6 +71,7 @@ enum command_type { SUBCOMMAND_VID, SUBCOMMAND_HIF, DEBUGTABLE, + DEBUGJSON, }; struct state { diff --git a/mcast_flags.c b/mcast_flags.c index 721f549..6fc2780 100644 --- a/mcast_flags.c +++ b/mcast_flags.c @@ -105,7 +105,7 @@ static int netlink_print_mcast_flags(struct state *state, char *orig_iface, /* only parse own multicast flags */ info_header = netlink_get_info(state->mesh_ifindex, - BATADV_CMD_GET_MCAST_FLAGS, NULL); + BATADV_CMD_GET_MCAST_FLAGS, NULL, false); free(info_header); if (mcast_flags == -EOPNOTSUPP || mcast_flags_priv == -EOPNOTSUPP) @@ -147,7 +147,7 @@ static int netlink_print_mcast_flags(struct state *state, char *orig_iface, ret = netlink_print_common(state, orig_iface, read_opts, orig_timeout, watch_interval, header, BATADV_CMD_GET_MCAST_FLAGS, - mcast_flags_callback); + mcast_flags_callback, false); free(header); return ret; diff --git a/neighbors.c b/neighbors.c index af76d0f..a54045b 100644 --- a/neighbors.c +++ b/neighbors.c @@ -114,7 +114,7 @@ static int netlink_print_neighbors(struct state *state, char *orig_iface, orig_timeout, watch_interval, "IF Neighbor last-seen\n", BATADV_CMD_GET_NEIGHBORS, - neighbors_callback); + neighbors_callback, false); } static struct debug_table_data batctl_debug_table_neighbors = { diff --git a/neighbors_json.c b/neighbors_json.c new file mode 100644 index 0000000..d89dc7a --- /dev/null +++ b/neighbors_json.c @@ -0,0 +1,109 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (C) B.A.T.M.A.N. contributors: + * + * Andrew Lunn <andrew(a)lunn.ch> + * Alexander Sarmanow <asarmanow(a)gmail.com> + * + * License-Filename: LICENSES/preferred/GPL-2.0 + */ + +#include <net/if.h> +#include <netinet/if_ether.h> +#include <netlink/netlink.h> +#include <netlink/genl/genl.h> +#include <netlink/genl/ctrl.h> +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> + +#include "batadv_packet.h" +#include "batman_adv.h" +#include "bat-hosts.h" +#include "debug.h" +#include "functions.h" +#include "main.h" +#include "netlink.h" + +static const int neighbors_mandatory[] = { + BATADV_ATTR_NEIGH_ADDRESS, + BATADV_ATTR_HARD_IFINDEX, + BATADV_ATTR_LAST_SEEN_MSECS, +}; + +static int neighbors_callback(struct nl_msg *msg, void *arg) +{ + unsigned throughput_kbits; + struct nlattr *attrs[BATADV_ATTR_MAX+1]; + struct nlmsghdr *nlh = nlmsg_hdr(msg); + int last_seen_msecs; + struct print_opts *opts = arg; + struct bat_host *bat_host; + char ifname[IF_NAMESIZE]; + struct genlmsghdr *ghdr; + uint8_t *neigh; + + if (!genlmsg_valid_hdr(nlh, 0)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + ghdr = nlmsg_data(nlh); + + if (ghdr->cmd != BATADV_CMD_GET_NEIGHBORS) + return NL_OK; + + if (nla_parse(attrs, BATADV_ATTR_MAX, genlmsg_attrdata(ghdr, 0), + genlmsg_len(ghdr), batadv_netlink_policy)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + if (missing_mandatory_attrs(attrs, neighbors_mandatory, + ARRAY_SIZE(neighbors_mandatory))) { + fputs("Missing attributes from kernel\n", stderr); + exit(1); + } + + neigh = nla_data(attrs[BATADV_ATTR_NEIGH_ADDRESS]); + bat_host = bat_hosts_find_by_mac((char *)neigh); + + if (!if_indextoname(nla_get_u32(attrs[BATADV_ATTR_HARD_IFINDEX]), + ifname)) + ifname[0] = '\0'; + + last_seen_msecs = nla_get_u32(attrs[BATADV_ATTR_LAST_SEEN_MSECS]); + + if (!(opts->read_opt & USE_BAT_HOSTS) || !bat_host) + printf("{\"neighbor\":\"%02x:%02x:%02x:%02x:%02x:%02x\",", + neigh[0], neigh[1], neigh[2], + neigh[3], neigh[4], neigh[5]); + else + printf("{\"neighbor\":\"%s\",", bat_host->name); + + if (attrs[BATADV_ATTR_THROUGHPUT]) { + throughput_kbits = nla_get_u32(attrs[BATADV_ATTR_THROUGHPUT]); + printf("\"throughput_kbits\":%u,", throughput_kbits); + } + + printf("\"last_seen\":%d,\"ifname\":\"%s\"}", last_seen_msecs, ifname); + + return NL_OK; +} + +static int netlink_print_neighbors_json(struct state *state, char *orig_iface, + int read_opts, float orig_timeout, + float watch_interval) +{ + return netlink_print_common(state, orig_iface, read_opts, + orig_timeout, watch_interval, NULL, + BATADV_CMD_GET_NEIGHBORS, + neighbors_callback, true); +} + +static struct debug_table_data batctl_debug_table_neighbors = { + .netlink_fn = netlink_print_neighbors_json, +}; + +COMMAND_NAMED(DEBUGJSON, neighbors_json, "nj", handle_debug_table, + COMMAND_FLAG_MESH_IFACE | COMMAND_FLAG_NETLINK, + &batctl_debug_table_neighbors, ""); diff --git a/netlink.c b/netlink.c index 31c9b01..f42643e 100644 --- a/netlink.c +++ b/netlink.c @@ -318,15 +318,29 @@ static int info_callback(struct nl_msg *msg, void *arg) else extra_header = ""; - ret = asprintf(&opts->remaining_header, - "[B.A.T.M.A.N. adv %s, MainIF/MAC: %s/%02x:%02x:%02x:%02x:%02x:%02x (%s/%02x:%02x:%02x:%02x:%02x:%02x %s)%s]\n%s", - version, primary_if, - primary_mac[0], primary_mac[1], primary_mac[2], - primary_mac[3], primary_mac[4], primary_mac[5], - mesh_name, - mesh_mac[0], mesh_mac[1], mesh_mac[2], - mesh_mac[3], mesh_mac[4], mesh_mac[5], - algo_name, extra_info, extra_header); + if (opts->is_json) { + ret = asprintf(&opts->remaining_header, + "{\"version\":\"%s\",\"main_if\":\"%s\",\"main_mac\":\"%02x:%02x:%02x:%02x:%02x:%02x\",\"mesh_if\":\"%s\",\"mesh_mac\":\"%02x:%02x:%02x:%02x:%02x:%02x\",\"algo_name\":\"%s\",\"extra_info\":\"%s\",\"data\":[", + version, primary_if, + primary_mac[0], primary_mac[1], + primary_mac[2], primary_mac[3], + primary_mac[4], primary_mac[5], + mesh_name, + mesh_mac[0], mesh_mac[1], mesh_mac[2], + mesh_mac[3], mesh_mac[4], mesh_mac[5], + algo_name, extra_info); + } else { + ret = asprintf(&opts->remaining_header, + "[B.A.T.M.A.N. adv %s, MainIF/MAC: %s/%02x:%02x:%02x:%02x:%02x:%02x (%s/%02x:%02x:%02x:%02x:%02x:%02x %s)%s]\n%s", + version, primary_if, + primary_mac[0], primary_mac[1], + primary_mac[2], primary_mac[3], + primary_mac[4], primary_mac[5], + mesh_name, + mesh_mac[0], mesh_mac[1], mesh_mac[2], + mesh_mac[3], mesh_mac[4], mesh_mac[5], + algo_name, extra_info, extra_header); + } if (ret < 0) opts->remaining_header = NULL; @@ -342,7 +356,8 @@ static int info_callback(struct nl_msg *msg, void *arg) return NL_STOP; } -char *netlink_get_info(int ifindex, uint8_t nl_cmd, const char *header) +char *netlink_get_info(int ifindex, uint8_t nl_cmd, const char *header, + bool is_json) { struct nl_sock *sock; struct nl_msg *msg; @@ -353,6 +368,7 @@ char *netlink_get_info(int ifindex, uint8_t nl_cmd, const char *header) .nl_cmd = nl_cmd, .remaining_header = NULL, .static_header = header, + .is_json = is_json, }; sock = nl_socket_alloc(); @@ -399,12 +415,34 @@ char *netlink_get_info(int ifindex, uint8_t nl_cmd, const char *header) void netlink_print_remaining_header(struct print_opts *opts) { - if (!opts->remaining_header) + if (!opts->remaining_header) { + if (!opts->is_json) + return; + + if (opts->is_first) + fputs("[", stdout); + if (opts->is_last) { + if (!(opts->read_opt & SKIP_HEADER)) + fputs("]}\n", stdout); + else + fputs("]\n", stdout); + } + if (!opts->is_first && !opts->is_last) + fputs(",", stdout); + + opts->is_first = false; + return; + } fputs(opts->remaining_header, stdout); free(opts->remaining_header); opts->remaining_header = NULL; + + opts->is_first = false; + + if (opts->is_last && opts->is_json) + fputs("]}\n", stdout); } int netlink_print_common_cb(struct nl_msg *msg, void *arg) @@ -419,7 +457,7 @@ int netlink_print_common_cb(struct nl_msg *msg, void *arg) int netlink_print_common(struct state *state, char *orig_iface, int read_opt, float orig_timeout, float watch_interval, const char *header, uint8_t nl_cmd, - nl_recvmsg_msg_cb_t callback) + nl_recvmsg_msg_cb_t callback, bool is_json) { struct print_opts opts = { .read_opt = read_opt, @@ -427,6 +465,9 @@ int netlink_print_common(struct state *state, char *orig_iface, int read_opt, .watch_interval = watch_interval, .remaining_header = NULL, .callback = callback, + .is_json = is_json, + .is_first = true, + .is_last = false, }; int hardifindex = 0; struct nl_msg *msg; @@ -460,7 +501,8 @@ int netlink_print_common(struct state *state, char *orig_iface, int read_opt, if (!(read_opt & SKIP_HEADER)) opts.remaining_header = netlink_get_info(state->mesh_ifindex, nl_cmd, - header); + header, + is_json); msg = nlmsg_alloc(); if (!msg) @@ -481,6 +523,8 @@ int netlink_print_common(struct state *state, char *orig_iface, int read_opt, last_err = 0; nl_recvmsgs(state->sock, state->cb); + opts.is_last = true; + /* the header should still be printed when no entry was received */ if (!last_err) netlink_print_remaining_header(&opts); diff --git a/netlink.h b/netlink.h index 4ee2f39..b7adade 100644 --- a/netlink.h +++ b/netlink.h @@ -12,6 +12,7 @@ #include <netlink/genl/genl.h> #include <netlink/genl/ctrl.h> #include <stdint.h> +#include <stdbool.h> struct state; @@ -21,8 +22,12 @@ struct print_opts { float watch_interval; nl_recvmsg_msg_cb_t callback; char *remaining_header; + char *remaining_entry; const char *static_header; uint8_t nl_cmd; + bool is_json; + bool is_first; + bool is_last; }; struct ether_addr; @@ -30,7 +35,7 @@ struct ether_addr; int netlink_create(struct state *state); void netlink_destroy(struct state *state); -char *netlink_get_info(int ifindex, uint8_t nl_cmd, const char *header); +char *netlink_get_info(int ifindex, uint8_t nl_cmd, const char *header, bool is_json); int translate_mac_netlink(const char *mesh_iface, const struct ether_addr *mac, struct ether_addr *mac_out); int get_nexthop_netlink(const char *mesh_iface, const struct ether_addr *mac, @@ -46,7 +51,7 @@ int missing_mandatory_attrs(struct nlattr *attrs[], const int mandatory[], int netlink_print_common(struct state *state, char *orig_iface, int read_opt, float orig_timeout, float watch_interval, const char *header, uint8_t nl_cmd, - nl_recvmsg_msg_cb_t callback); + nl_recvmsg_msg_cb_t callback, bool is_json); int netlink_print_common_cb(struct nl_msg *msg, void *arg); int netlink_stop_callback(struct nl_msg *msg, void *arg); diff --git a/originators.c b/originators.c index 8a29dd7..4acf2d0 100644 --- a/originators.c +++ b/originators.c @@ -175,7 +175,7 @@ static int netlink_print_originators(struct state *state, char *orig_iface, /* only parse routing algorithm name */ last_err = -EINVAL; info_header = netlink_get_info(state->mesh_ifindex, - BATADV_CMD_GET_ORIGINATORS, NULL); + BATADV_CMD_GET_ORIGINATORS, NULL, false); free(info_header); if (strlen(algo_name_buf) == 0) @@ -192,7 +192,7 @@ static int netlink_print_originators(struct state *state, char *orig_iface, return netlink_print_common(state, orig_iface, read_opts, orig_timeout, watch_interval, header, BATADV_CMD_GET_ORIGINATORS, - originators_callback); + originators_callback, false); } static struct debug_table_data batctl_debug_table_originators = { diff --git a/originators_json.c b/originators_json.c new file mode 100644 index 0000000..d0caec3 --- /dev/null +++ b/originators_json.c @@ -0,0 +1,154 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (C) B.A.T.M.A.N. contributors: + * + * Andrew Lunn <andrew(a)lunn.ch> + * Sven Eckelmann <sven(a)narfation.org> + * Alexander Sarmanow <asarmanow(a)gmail.com> + * + * License-Filename: LICENSES/preferred/GPL-2.0 + */ + +#include <errno.h> +#include <net/if.h> +#include <netinet/if_ether.h> +#include <netlink/netlink.h> +#include <netlink/genl/genl.h> +#include <netlink/genl/ctrl.h> +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> +#include <string.h> + +#include "batadv_packet.h" +#include "batman_adv.h" +#include "bat-hosts.h" +#include "debug.h" +#include "functions.h" +#include "main.h" +#include "netlink.h" + +static const int originators_mandatory[] = { + BATADV_ATTR_ORIG_ADDRESS, + BATADV_ATTR_NEIGH_ADDRESS, + BATADV_ATTR_HARD_IFINDEX, + BATADV_ATTR_LAST_SEEN_MSECS, +}; + +static int originators_callback(struct nl_msg *msg, void *arg) +{ + unsigned throughput_kbits; + struct nlattr *attrs[BATADV_ATTR_MAX+1]; + struct nlmsghdr *nlh = nlmsg_hdr(msg); + int last_seen_msecs; + struct print_opts *opts = arg; + struct bat_host *bat_host; + struct genlmsghdr *ghdr; + char ifname[IF_NAMESIZE]; + float last_seen; + uint8_t *neigh; + uint8_t *orig; + bool c = false; + uint8_t tq; + + if (!genlmsg_valid_hdr(nlh, 0)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + ghdr = nlmsg_data(nlh); + + if (ghdr->cmd != BATADV_CMD_GET_ORIGINATORS) + return NL_OK; + + if (nla_parse(attrs, BATADV_ATTR_MAX, genlmsg_attrdata(ghdr, 0), + genlmsg_len(ghdr), batadv_netlink_policy)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + if (missing_mandatory_attrs(attrs, originators_mandatory, + ARRAY_SIZE(originators_mandatory))) { + fputs("Missing attributes from kernel\n", stderr); + exit(1); + } + + orig = nla_data(attrs[BATADV_ATTR_ORIG_ADDRESS]); + neigh = nla_data(attrs[BATADV_ATTR_NEIGH_ADDRESS]); + + if (!if_indextoname(nla_get_u32(attrs[BATADV_ATTR_HARD_IFINDEX]), + ifname)) + ifname[0] = '\0'; + + if (attrs[BATADV_ATTR_FLAG_BEST]) + c = true; + + last_seen_msecs = nla_get_u32(attrs[BATADV_ATTR_LAST_SEEN_MSECS]); + last_seen = (float)last_seen_msecs / 1000.0; + + /* skip timed out originators */ + if (opts->read_opt & NO_OLD_ORIGS) + if (last_seen > opts->orig_timeout) + return NL_OK; + + printf("{\"best\":%s,", BOOL_STRING(c)); + + if (!(opts->read_opt & USE_BAT_HOSTS)) { + printf("\"originator\":\"%02x:%02x:%02x:%02x:%02x:%02x\",", + orig[0], orig[1], orig[2], + orig[3], orig[4], orig[5]); + printf("\"next_hop\":\"%02x:%02x:%02x:%02x:%02x:%02x\",", + neigh[0], neigh[1], neigh[2], + neigh[3], neigh[4], neigh[5]); + } else { + bat_host = bat_hosts_find_by_mac((char *)orig); + if (bat_host) { + printf("\"originator\":\"%s\",", + bat_host->name); + } else { + printf("\"originator\":\"%02x:%02x:%02x:%02x:%02x:%02x\",", + orig[0], orig[1], orig[2], + orig[3], orig[4], orig[5]); + } + bat_host = bat_hosts_find_by_mac((char *)neigh); + if (bat_host) + printf("\"next_hop\":\"%s\",", + bat_host->name); + else + printf("\"next_hop\":\"%02x:%02x:%02x:%02x:%02x:%02x\",", + neigh[0], neigh[1], neigh[2], + neigh[3], neigh[4], neigh[5]); + } + if (attrs[BATADV_ATTR_THROUGHPUT]) { + throughput_kbits = nla_get_u32(attrs[BATADV_ATTR_THROUGHPUT]); + printf("\"throughput_kbits\":%u,", throughput_kbits); + } + if (attrs[BATADV_ATTR_TQ]) { + tq = nla_get_u8(attrs[BATADV_ATTR_TQ]); + printf("\"tq\":%i,", tq); + } + + printf("\"last_seen\":%d,\"outgoing_iface\":\"%s\"}", + last_seen_msecs, ifname); + + return NL_OK; +} + +static int netlink_print_originators_json(struct state *state, char *orig_iface, + int read_opts, float orig_timeout, + float watch_interval) +{ + return netlink_print_common(state, orig_iface, read_opts, + orig_timeout, watch_interval, NULL, + BATADV_CMD_GET_ORIGINATORS, + originators_callback, true); +} + +static struct debug_table_data batctl_debug_table_originators = { + .netlink_fn = netlink_print_originators_json, + .option_timeout_interval = 1, + .option_orig_iface = 1, +}; + +COMMAND_NAMED(DEBUGJSON, originators_json, "oj", handle_debug_table, + COMMAND_FLAG_MESH_IFACE | COMMAND_FLAG_NETLINK, + &batctl_debug_table_originators, ""); diff --git a/transglobal.c b/transglobal.c index 4eae95d..abe0339 100644 --- a/transglobal.c +++ b/transglobal.c @@ -132,7 +132,7 @@ static int netlink_print_transglobal(struct state *state, char *orig_iface, orig_timeout, watch_interval, " Client VID Flags Last ttvn Via ttvn (CRC )\n", BATADV_CMD_GET_TRANSTABLE_GLOBAL, - transglobal_callback); + transglobal_callback, false); } static struct debug_table_data batctl_debug_table_transglobal = { diff --git a/transglobal_json.c b/transglobal_json.c new file mode 100644 index 0000000..a687f57 --- /dev/null +++ b/transglobal_json.c @@ -0,0 +1,146 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (C) B.A.T.M.A.N. contributors: + * + * Andrew Lunn <andrew(a)lunn.ch> + * Sven Eckelmann <sven(a)narfation.org> + * Alexander Sarmanow <asarmanow(a)gmail.com> + * + * License-Filename: LICENSES/preferred/GPL-2.0 + */ + +#include <netinet/if_ether.h> +#include <netlink/netlink.h> +#include <netlink/genl/genl.h> +#include <netlink/genl/ctrl.h> +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> + +#include "batadv_packet.h" +#include "batman_adv.h" +#include "bat-hosts.h" +#include "debug.h" +#include "functions.h" +#include "main.h" +#include "netlink.h" + +static const int transglobal_mandatory[] = { + BATADV_ATTR_TT_ADDRESS, + BATADV_ATTR_ORIG_ADDRESS, + BATADV_ATTR_TT_VID, + BATADV_ATTR_TT_TTVN, + BATADV_ATTR_TT_LAST_TTVN, + BATADV_ATTR_TT_CRC32, + BATADV_ATTR_TT_FLAGS, +}; + +static int transglobal_callback(struct nl_msg *msg, void *arg) +{ + struct nlattr *attrs[BATADV_ATTR_MAX+1]; + struct nlmsghdr *nlh = nlmsg_hdr(msg); + struct print_opts *opts = arg; + struct bat_host *bat_host; + struct genlmsghdr *ghdr; + char c, r, w, i, t; + uint8_t last_ttvn; + uint32_t crc32; + uint32_t flags; + uint8_t *addr; + uint8_t *orig; + uint8_t ttvn; + int16_t vid; + + if (!genlmsg_valid_hdr(nlh, 0)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + ghdr = nlmsg_data(nlh); + + if (ghdr->cmd != BATADV_CMD_GET_TRANSTABLE_GLOBAL) + return NL_OK; + + if (nla_parse(attrs, BATADV_ATTR_MAX, genlmsg_attrdata(ghdr, 0), + genlmsg_len(ghdr), batadv_netlink_policy)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + if (missing_mandatory_attrs(attrs, transglobal_mandatory, + ARRAY_SIZE(transglobal_mandatory))) { + fputs("Missing attributes from kernel\n", stderr); + exit(1); + } + + addr = nla_data(attrs[BATADV_ATTR_TT_ADDRESS]); + orig = nla_data(attrs[BATADV_ATTR_ORIG_ADDRESS]); + vid = nla_get_u16(attrs[BATADV_ATTR_TT_VID]); + ttvn = nla_get_u8(attrs[BATADV_ATTR_TT_TTVN]); + last_ttvn = nla_get_u8(attrs[BATADV_ATTR_TT_LAST_TTVN]); + crc32 = nla_get_u32(attrs[BATADV_ATTR_TT_CRC32]); + flags = nla_get_u32(attrs[BATADV_ATTR_TT_FLAGS]); + + if (opts->read_opt & MULTICAST_ONLY && !(addr[0] & 0x01)) + return NL_OK; + + if (opts->read_opt & UNICAST_ONLY && (addr[0] & 0x01)) + return NL_OK; + + c = false, r = false, w = false, i = false, t = false; + if (attrs[BATADV_ATTR_FLAG_BEST]) + c = true; + if (flags & BATADV_TT_CLIENT_ROAM) + r = true; + if (flags & BATADV_TT_CLIENT_WIFI) + w = true; + if (flags & BATADV_TT_CLIENT_ISOLA) + i = true; + if (flags & BATADV_TT_CLIENT_TEMP) + t = true; + + printf("{\"best\":%s,", BOOL_STRING(c)); + + bat_host = bat_hosts_find_by_mac((char *)addr); + if (!(opts->read_opt & USE_BAT_HOSTS) || !bat_host) + printf("\"client\":\"%02x:%02x:%02x:%02x:%02x:%02x\",", + addr[0], addr[1], addr[2], + addr[3], addr[4], addr[5]); + else + printf("\"client\":\"%s\",", bat_host->name); + + printf("\"vid\":%i,\"flag_r\":%s,\"flag_w\":%s,\"flag_i\":%s,\"flag_t\":%s,\"ttvn\":%u,", + BATADV_PRINT_VID(vid), BOOL_STRING(r), BOOL_STRING(w), + BOOL_STRING(i), BOOL_STRING(t), ttvn); + + bat_host = bat_hosts_find_by_mac((char *)orig); + if (!(opts->read_opt & USE_BAT_HOSTS) || !bat_host) + printf("\"orig\":\"%02x:%02x:%02x:%02x:%02x:%02x\",", + orig[0], orig[1], orig[2], + orig[3], orig[4], orig[5]); + else + printf("\"orig\":\"%s\",", bat_host->name); + + printf("\"last_ttvn\":%u,\"crc\":\"0x%.8x\"}", last_ttvn, crc32); + + return NL_OK; +} + +static int netlink_print_transglobal_json(struct state *state, char *orig_iface, + int read_opts, float orig_timeout, + float watch_interval) +{ + return netlink_print_common(state, orig_iface, read_opts, + orig_timeout, watch_interval, NULL, + BATADV_CMD_GET_TRANSTABLE_GLOBAL, + transglobal_callback, true); +} + +static struct debug_table_data batctl_debug_table_transglobal = { + .netlink_fn = netlink_print_transglobal_json, + .option_unicast_only = 1, + .option_multicast_only = 1, +}; + +COMMAND_NAMED(DEBUGJSON, transglobal_json, "tgj", handle_debug_table, + COMMAND_FLAG_MESH_IFACE | COMMAND_FLAG_NETLINK, + &batctl_debug_table_transglobal, ""); diff --git a/translocal.c b/translocal.c index a3ad3da..d72125c 100644 --- a/translocal.c +++ b/translocal.c @@ -128,7 +128,7 @@ static int netlink_print_translocal(struct state *state, char *orig_iface, orig_timeout, watch_interval, "Client VID Flags Last seen (CRC )\n", BATADV_CMD_GET_TRANSTABLE_LOCAL, - translocal_callback); + translocal_callback, false); } static struct debug_table_data batctl_debug_table_translocal = { diff --git a/translocal_json.c b/translocal_json.c new file mode 100644 index 0000000..ad2ff46 --- /dev/null +++ b/translocal_json.c @@ -0,0 +1,139 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (C) B.A.T.M.A.N. contributors: + * + * Andrew Lunn <andrew(a)lunn.ch> + * Sven Eckelmann <sven(a)narfation.org> + * Alexander Sarmanow <asarmanow(a)gmail.com> + * + * License-Filename: LICENSES/preferred/GPL-2.0 + */ + +#include <netinet/if_ether.h> +#include <netlink/netlink.h> +#include <netlink/genl/genl.h> +#include <netlink/genl/ctrl.h> +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> + +#include "batadv_packet.h" +#include "batman_adv.h" +#include "bat-hosts.h" +#include "debug.h" +#include "functions.h" +#include "main.h" +#include "netlink.h" + +static const int translocal_mandatory[] = { + BATADV_ATTR_TT_ADDRESS, + BATADV_ATTR_TT_VID, + BATADV_ATTR_TT_CRC32, + BATADV_ATTR_TT_FLAGS, +}; + +static int translocal_callback(struct nl_msg *msg, void *arg) +{ + int last_seen_msecs = 0; + struct nlattr *attrs[BATADV_ATTR_MAX+1]; + struct nlmsghdr *nlh = nlmsg_hdr(msg); + struct print_opts *opts = arg; + struct bat_host *bat_host; + struct genlmsghdr *ghdr; + char r, p, n, x, w, i; + uint8_t *addr; + int16_t vid; + uint32_t crc32; + uint32_t flags; + + if (!genlmsg_valid_hdr(nlh, 0)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + ghdr = nlmsg_data(nlh); + + if (ghdr->cmd != BATADV_CMD_GET_TRANSTABLE_LOCAL) + return NL_OK; + + if (nla_parse(attrs, BATADV_ATTR_MAX, genlmsg_attrdata(ghdr, 0), + genlmsg_len(ghdr), batadv_netlink_policy)) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + if (missing_mandatory_attrs(attrs, translocal_mandatory, + ARRAY_SIZE(translocal_mandatory))) { + fputs("Missing attributes from kernel\n", stderr); + exit(1); + } + + addr = nla_data(attrs[BATADV_ATTR_TT_ADDRESS]); + vid = nla_get_u16(attrs[BATADV_ATTR_TT_VID]); + crc32 = nla_get_u32(attrs[BATADV_ATTR_TT_CRC32]); + flags = nla_get_u32(attrs[BATADV_ATTR_TT_FLAGS]); + last_seen_msecs = 0; + + if (opts->read_opt & MULTICAST_ONLY && !(addr[0] & 0x01)) + return NL_OK; + + if (opts->read_opt & UNICAST_ONLY && (addr[0] & 0x01)) + return NL_OK; + + r = false, p = false, n = false, x = false, w = false, i = false; + if (flags & BATADV_TT_CLIENT_ROAM) + r = true; + if (flags & BATADV_TT_CLIENT_NEW) + n = true; + if (flags & BATADV_TT_CLIENT_PENDING) + x = true; + if (flags & BATADV_TT_CLIENT_WIFI) + w = true; + if (flags & BATADV_TT_CLIENT_ISOLA) + i = true; + + if (flags & BATADV_TT_CLIENT_NOPURGE) { + p = true; + } else { + if (!attrs[BATADV_ATTR_LAST_SEEN_MSECS]) { + fputs("Received invalid data from kernel.\n", stderr); + exit(1); + } + + last_seen_msecs = nla_get_u32( + attrs[BATADV_ATTR_LAST_SEEN_MSECS]); + } + + bat_host = bat_hosts_find_by_mac((char *)addr); + if (!(opts->read_opt & USE_BAT_HOSTS) || !bat_host) + printf("{\"client\":\"%02x:%02x:%02x:%02x:%02x:%02x\",", + addr[0], addr[1], addr[2], addr[3], addr[4], addr[5]); + else + printf("{\"client\":\"%s\",", bat_host->name); + + printf("\"vid\":%i,\"flag_r\":%s,\"flag_n\":%s,\"flag_x\":%s,\"flag_w\":%s,\"flag_i\":%s,\"flag_p\":%s,\"last_seen\":%d,\"crc\":\"0x%.8x\"}", + BATADV_PRINT_VID(vid), BOOL_STRING(r), BOOL_STRING(n), + BOOL_STRING(x), BOOL_STRING(w), BOOL_STRING(i), BOOL_STRING(p), + last_seen_msecs, crc32); + + return NL_OK; +} + +static int netlink_print_translocal_json(struct state *state, char *orig_iface, + int read_opts, float orig_timeout, + float watch_interval) +{ + return netlink_print_common(state, orig_iface, read_opts, + orig_timeout, watch_interval, NULL, + BATADV_CMD_GET_TRANSTABLE_LOCAL, + translocal_callback, true); +} + +static struct debug_table_data batctl_debug_table_translocal = { + .netlink_fn = netlink_print_translocal_json, + .option_unicast_only = 1, + .option_multicast_only = 1, +}; + +COMMAND_NAMED(DEBUGJSON, translocal_json, "tlj", handle_debug_table, + COMMAND_FLAG_MESH_IFACE | COMMAND_FLAG_NETLINK, + &batctl_debug_table_translocal, ""); -- 2.25.1

3 2

Callback Function
by BrainGeek 28 Apr '21

28 Apr '21

With ALFRED I've noticed a parameter you can pass into it labeled "-c" which is described to be a callback. I've tried things like "-c poweroff" just to make it obvious that the callback worked, but to no avail. How can I properly use this feature and how does it work? I'm currently running ALFRED and batman-adv on my Raspberry Pi 4. All the software is up-to-date.

2 1

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

B.A.T.M.A.N