event.c 11.5 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
2
/* Copyright (C) 2009-2019  B.A.T.M.A.N. contributors:
3 4 5 6 7 8 9 10
 *
 * Sven Eckelmann <sven@narfation.org>
 *
 * License-Filename: LICENSES/preferred/GPL-2.0
 */

#include <errno.h>
#include <getopt.h>
11
#include <net/if.h>
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
#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 <sys/time.h>

#include "batadv_packet.h"
#include "batman_adv.h"
#include "bat-hosts.h"
#include "debug.h"
#include "functions.h"
#include "genl.h"
#include "main.h"
#include "netlink.h"

enum event_time_mode {
	EVENT_TIME_NO,
	EVENT_TIME_LOCAL,
	EVENT_TIME_RELATIVE,
};

struct event_args {
	enum event_time_mode mode;
	struct timeval tv;
};

41 42 43 44 45 46 47 48
static const char *u8_to_boolstr(struct nlattr *attrs)
{
	if (nla_get_u8(attrs))
		return "true";
	else
		return "false";
}

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
static void event_usage(void)
{
	fprintf(stderr, "Usage: batctl [options] event [parameters]\n");
	fprintf(stderr, "parameters:\n");
	fprintf(stderr, " \t -h print this help\n");
	fprintf(stderr, " \t -t print local timestamp\n");
	fprintf(stderr, " \t -r print relative timestamp\n");
}

static int event_prepare(struct state *state)
{
	int ret;
	int mcid;

	if (!state->sock)
		return -EOPNOTSUPP;

	mcid = nl_get_multicast_id(state->sock, BATADV_NL_NAME,
				   BATADV_NL_MCAST_GROUP_TPMETER);
	if (mcid < 0) {
		fprintf(stderr, "Failed to resolve batadv tp_meter multicast group: %d\n",
			mcid);
		/* ignore error for now */
		goto skip_tp_meter;
	}

	ret = nl_socket_add_membership(state->sock, mcid);
	if (ret) {
		fprintf(stderr, "Failed to join batadv tp_meter multicast group: %d\n",
			ret);
		/* ignore error for now */
		goto skip_tp_meter;
	}

skip_tp_meter:

85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
	mcid = nl_get_multicast_id(state->sock, BATADV_NL_NAME,
				   BATADV_NL_MCAST_GROUP_CONFIG);
	if (mcid < 0) {
		fprintf(stderr, "Failed to resolve batadv config multicast group: %d\n",
			mcid);
		/* ignore error for now */
		goto skip_config;
	}

	ret = nl_socket_add_membership(state->sock, mcid);
	if (ret) {
		fprintf(stderr, "Failed to join batadv config multicast group: %d\n",
			ret);
		/* ignore error for now */
		goto skip_config;
	}

skip_config:

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
	return 0;
}

static int no_seq_check(struct nl_msg *msg __maybe_unused,
			void *arg __maybe_unused)
{
	return NL_OK;
}

static const int tp_meter_mandatory[] = {
	BATADV_ATTR_TPMETER_COOKIE,
	BATADV_ATTR_TPMETER_RESULT,
};

static void event_parse_tp_meter(struct nlattr **attrs)
{
	const char *result_str;
	uint32_t cookie;
	uint8_t result;

	/* ignore entry when attributes are missing */
	if (missing_mandatory_attrs(attrs, tp_meter_mandatory,
				    ARRAY_SIZE(tp_meter_mandatory)))
		return;

	cookie = nla_get_u32(attrs[BATADV_ATTR_TPMETER_COOKIE]);
	result = nla_get_u8(attrs[BATADV_ATTR_TPMETER_RESULT]);

	switch (result) {
	case BATADV_TP_REASON_DST_UNREACHABLE:
		result_str = "Destination unreachable";
		break;
	case BATADV_TP_REASON_RESEND_LIMIT:
		result_str = "The number of retry for the same window exceeds the limit, test aborted";
		break;
	case BATADV_TP_REASON_ALREADY_ONGOING:
		result_str = "Cannot run two test towards the same node";
		break;
	case BATADV_TP_REASON_MEMORY_ERROR:
		result_str = "Kernel cannot allocate memory, aborted";
		break;
	case BATADV_TP_REASON_TOO_MANY:
		result_str = "Too many ongoing sessions";
		break;
	case BATADV_TP_REASON_CANCEL:
		result_str = "CANCEL received: test aborted";
		break;
	case BATADV_TP_REASON_COMPLETE:
		result_str = "complete";
		break;
	default:
		result_str = "unknown";
		break;
	}

	printf("tp_meter 0x%08x: %s\n", cookie, result_str);
}

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
static void event_parse_set_mesh(struct nlattr **attrs)
{
	static const int mesh_mandatory[] = {
		BATADV_ATTR_MESH_IFINDEX,
		BATADV_ATTR_ALGO_NAME,
	};
	char meshif_buf[IF_NAMESIZE];
	char *meshif_name;
	uint32_t mesh_ifindex;

	/* ignore entry when attributes are missing */
	if (missing_mandatory_attrs(attrs, mesh_mandatory,
				    ARRAY_SIZE(mesh_mandatory)))
		return;

	mesh_ifindex = nla_get_u32(attrs[BATADV_ATTR_MESH_IFINDEX]);
	meshif_name = if_indextoname(mesh_ifindex, meshif_buf);
	if (!meshif_name)
		return;

	printf("%s: set mesh:\n", meshif_name);

	if (attrs[BATADV_ATTR_AGGREGATED_OGMS_ENABLED])
		printf("* aggregated_ogms %s\n",
		       u8_to_boolstr(attrs[BATADV_ATTR_AGGREGATED_OGMS_ENABLED]));

	if (attrs[BATADV_ATTR_AP_ISOLATION_ENABLED])
		printf("* ap_isolation %s\n",
		       u8_to_boolstr(attrs[BATADV_ATTR_AP_ISOLATION_ENABLED]));

	if (attrs[BATADV_ATTR_ISOLATION_MARK])
		printf("* isolation_mark 0x%08x\n",
		       nla_get_u32(attrs[BATADV_ATTR_ISOLATION_MARK]));

	if (attrs[BATADV_ATTR_ISOLATION_MASK])
		printf("* isolation_mask 0x%08x\n",
		       nla_get_u32(attrs[BATADV_ATTR_ISOLATION_MASK]));

	if (attrs[BATADV_ATTR_BONDING_ENABLED])
		printf("* bonding %s\n",
		       u8_to_boolstr(attrs[BATADV_ATTR_BONDING_ENABLED]));

	if (attrs[BATADV_ATTR_BRIDGE_LOOP_AVOIDANCE_ENABLED])
		printf("* bridge_loop_avoidance %s\n",
		       u8_to_boolstr(attrs[BATADV_ATTR_BRIDGE_LOOP_AVOIDANCE_ENABLED]));

	if (attrs[BATADV_ATTR_DISTRIBUTED_ARP_TABLE_ENABLED])
		printf("* distributed_arp_table %s\n",
		       u8_to_boolstr(attrs[BATADV_ATTR_DISTRIBUTED_ARP_TABLE_ENABLED]));

	if (attrs[BATADV_ATTR_FRAGMENTATION_ENABLED])
		printf("* fragmentation %s\n",
		       u8_to_boolstr(attrs[BATADV_ATTR_FRAGMENTATION_ENABLED]));

	if (attrs[BATADV_ATTR_GW_BANDWIDTH_DOWN]) {
		uint32_t val;

		val = nla_get_u32(attrs[BATADV_ATTR_GW_BANDWIDTH_DOWN]);
		printf("* gw_bandwidth_down %u.%01u MBit/s\n", val / 10,
		       val % 10);
	}

	if (attrs[BATADV_ATTR_GW_BANDWIDTH_UP]) {
		uint32_t val;

		val = nla_get_u32(attrs[BATADV_ATTR_GW_BANDWIDTH_UP]);
		printf("* gw_bandwidth_up %u.%01u MBit/s\n", val / 10,
		       val % 10);
	}

	if (attrs[BATADV_ATTR_GW_MODE]) {
		uint8_t val = nla_get_u8(attrs[BATADV_ATTR_GW_MODE]);
		const char *valstr;

		switch (val) {
		case BATADV_GW_MODE_OFF:
			valstr = "off";
			break;
		case BATADV_GW_MODE_CLIENT:
			valstr = "client";
			break;
		case BATADV_GW_MODE_SERVER:
			valstr = "server";
			break;
		default:
			valstr = "unknown";
			break;
		}

		printf("* gw_mode %s\n", valstr);
	}

	if (attrs[BATADV_ATTR_GW_SEL_CLASS]) {
		uint32_t val = nla_get_u32(attrs[BATADV_ATTR_GW_SEL_CLASS]);
		const char *algo = nla_data(attrs[BATADV_ATTR_ALGO_NAME]);

		if (strcmp(algo, "BATMAN_V") == 0)
			printf("* gw_sel_class %u.%01u MBit/s\n", val / 10,
			       val % 10);
		else
			printf("* gw_sel_class %u\n", val);
	}

	if (attrs[BATADV_ATTR_HOP_PENALTY])
		printf("* hop_penalty %u\n",
		       nla_get_u8(attrs[BATADV_ATTR_HOP_PENALTY]));

	if (attrs[BATADV_ATTR_LOG_LEVEL])
		printf("* log_level 0x%08x\n",
		       nla_get_u32(attrs[BATADV_ATTR_LOG_LEVEL]));

273 274 275 276
	if (attrs[BATADV_ATTR_MULTICAST_FANOUT])
		printf("* multicast_fanout %u\n",
		       nla_get_u32(attrs[BATADV_ATTR_MULTICAST_FANOUT]));

277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
	if (attrs[BATADV_ATTR_MULTICAST_FORCEFLOOD_ENABLED])
		printf("* multicast_forceflood %s\n",
		       u8_to_boolstr(attrs[BATADV_ATTR_MULTICAST_FORCEFLOOD_ENABLED]));

	if (attrs[BATADV_ATTR_NETWORK_CODING_ENABLED])
		printf("* network_coding %s\n",
		       u8_to_boolstr(attrs[BATADV_ATTR_NETWORK_CODING_ENABLED]));

	if (attrs[BATADV_ATTR_ORIG_INTERVAL])
		printf("* orig_interval %u ms\n",
		       nla_get_u32(attrs[BATADV_ATTR_ORIG_INTERVAL]));
}

static void event_parse_set_hardif(struct nlattr **attrs)
{
	static const int hardif_mandatory[] = {
		BATADV_ATTR_MESH_IFINDEX,
		BATADV_ATTR_HARD_IFINDEX,
	};
	char meshif_buf[IF_NAMESIZE];
	char hardif_buf[IF_NAMESIZE];
	char *meshif_name;
	char *hardif_name;
	uint32_t hardif_ifindex;
	uint32_t mesh_ifindex;

	/* ignore entry when attributes are missing */
	if (missing_mandatory_attrs(attrs, hardif_mandatory,
				    ARRAY_SIZE(hardif_mandatory)))
		return;

	mesh_ifindex = nla_get_u32(attrs[BATADV_ATTR_MESH_IFINDEX]);
	meshif_name = if_indextoname(mesh_ifindex, meshif_buf);
	if (!meshif_name)
		return;

	hardif_ifindex = nla_get_u32(attrs[BATADV_ATTR_HARD_IFINDEX]);
	hardif_name = if_indextoname(hardif_ifindex, hardif_buf);
	if (!hardif_name)
		return;

	printf("%s (%s): set hardif:\n", meshif_name, hardif_name);

	if (attrs[BATADV_ATTR_ELP_INTERVAL])
		printf("* elp_interval %u ms\n",
		       nla_get_u32(attrs[BATADV_ATTR_ELP_INTERVAL]));

	if (attrs[BATADV_ATTR_THROUGHPUT_OVERRIDE]) {
		uint32_t val;

		val = nla_get_u32(attrs[BATADV_ATTR_THROUGHPUT_OVERRIDE]);
		printf("* throughput_override %u.%01u MBit/s\n", val / 10,
		       val % 10);
	}
}

static void event_parse_set_vlan(struct nlattr **attrs)
{
	static const int vlan_mandatory[] = {
		BATADV_ATTR_MESH_IFINDEX,
		BATADV_ATTR_VLANID,
	};
	char meshif_buf[IF_NAMESIZE];
	char *meshif_name;
	uint32_t mesh_ifindex;
	uint16_t vid;

	/* ignore entry when attributes are missing */
	if (missing_mandatory_attrs(attrs, vlan_mandatory,
				    ARRAY_SIZE(vlan_mandatory)))
		return;

	mesh_ifindex = nla_get_u32(attrs[BATADV_ATTR_MESH_IFINDEX]);
	meshif_name = if_indextoname(mesh_ifindex, meshif_buf);
	if (!meshif_name)
		return;

	vid = nla_get_u16(attrs[BATADV_ATTR_VLANID]);

	printf("%s (vid %u): set vlan:\n", meshif_name, vid);

	if (attrs[BATADV_ATTR_AP_ISOLATION_ENABLED])
		printf("* ap_isolation %s\n",
		       u8_to_boolstr(attrs[BATADV_ATTR_AP_ISOLATION_ENABLED]));
}

363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
static unsigned long long get_timestamp(struct event_args *event_args)
{
	unsigned long long prevtime = 0;
	unsigned long long now;
	struct timeval tv;

	gettimeofday(&tv, NULL);
	now = 1000000ULL * tv.tv_sec + tv.tv_usec;

	if (event_args->mode == EVENT_TIME_RELATIVE) {
		prevtime = 1000000ULL * event_args->tv.tv_sec + event_args->tv.tv_usec;
		event_args->tv = tv;
	}

	return now - prevtime;
}

static int event_parse(struct nl_msg *msg, void *arg)
{
	struct nlmsghdr *nlh = nlmsg_hdr(msg);
	struct nlattr *attrs[NUM_BATADV_ATTR];
	struct event_args *event_args = arg;
	unsigned long long timestamp;
	struct genlmsghdr *ghdr;

	if (!genlmsg_valid_hdr(nlh, 0))
		return NL_OK;

	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);
		return NL_OK;
	}

	if (event_args->mode != EVENT_TIME_NO) {
		timestamp = get_timestamp(event_args);
		printf("%llu.%06llu: ", timestamp / 1000000, timestamp % 1000000);
	}

	switch (ghdr->cmd) {
	case BATADV_CMD_TP_METER:
		event_parse_tp_meter(attrs);
		break;
408 409 410 411 412 413 414 415 416
	case BATADV_CMD_SET_MESH:
		event_parse_set_mesh(attrs);
		break;
	case BATADV_CMD_SET_HARDIF:
		event_parse_set_hardif(attrs);
		break;
	case BATADV_CMD_SET_VLAN:
		event_parse_set_vlan(attrs);
		break;
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
	default:
		printf("Received unknown event %u\n", ghdr->cmd);
		break;
	}

	return NL_OK;
}

static int event(struct state *state, int argc, char **argv)
{
	struct event_args event_args = {
		.mode = EVENT_TIME_NO,
	};
	int opt;
	int ret;

	while ((opt = getopt(argc, argv, "htr")) != -1) {
		switch (opt) {
		case 'h':
			event_usage();
			return EXIT_SUCCESS;
		case 't':
			event_args.mode = EVENT_TIME_LOCAL;
			break;
		case 'r':
			event_args.mode = EVENT_TIME_RELATIVE;
			break;
		default:
			event_usage();
			return  EXIT_FAILURE;
		}
	}

	ret = event_prepare(state);
	if (ret < 0) {
		fprintf(stderr, "Failed to prepare event netlink: %s (%d)\n",
			strerror(-ret), -ret);
		return 1;
	}

	if (event_args.mode == EVENT_TIME_RELATIVE)
		get_timestamp(&event_args);

	nl_cb_set(state->cb, NL_CB_SEQ_CHECK, NL_CB_CUSTOM, no_seq_check, NULL);
	nl_cb_set(state->cb, NL_CB_VALID, NL_CB_CUSTOM, event_parse, &event_args);

	while (1)
		nl_recvmsgs(state->sock, state->cb);

	return 0;
}

COMMAND(SUBCOMMAND, event, "e", COMMAND_FLAG_NETLINK, NULL,
	"                  \tdisplay events from batman-adv");