monitor/main.c

// SPDX-License-Identifier: LGPL-2.1-or-later
/*
 *
 *  BlueZ - Bluetooth protocol stack for Linux
 *
 *  Copyright (C) 2011-2014  Intel Corporation
 *  Copyright (C) 2002-2010  Marcel Holtmann <marcel@holtmann.org>
 *
 *
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#define _GNU_SOURCE
#include <stdio.h>
#include <ctype.h>
#include <stdlib.h>
#include <string.h>
#include <getopt.h>
#include <sys/un.h>

#include "src/shared/mainloop.h"
#include "src/shared/tty.h"

#include "packet.h"
#include "lmp.h"
#include "keys.h"
#include "analyze.h"
#include "ellisys.h"
#include "control.h"
#include "display.h"
#include "stats.h"

#define OPT_COMPRESS 1000
#define OPT_BQR_BUFFER 1001
#define OPT_BQR_FILE 1002

static void signal_callback(int signum, void *user_data)
{
	switch (signum) {
	case SIGINT:
	case SIGTERM:
		mainloop_quit();
		break;
	}
}

static void usage(void)
{
	printf("btmon - Bluetooth monitor\n"
		"Usage:\n");
	printf("\tbtmon [options]\n");
	printf("options:\n"
		"\t-0, --zero             Zero out privacy data\n"
		"\t-r, --read <file>      Read traces in btsnoop format\n"
		"\t-w, --write <file>     Save traces in btsnoop format\n"
		"\t-l  --limit-size <size> Limit save [-w] to <size> bytes\n"
		"\t-f  --file-rotate      Have two rotating logs when size\n"
		"\t                         limit [-l] is reached\n"
		"\t    --compress         Compress the saved btsnoop\n"
		"\t-a, --analyze <file>   Analyze traces in btsnoop format\n"
		"\t    --quality-buffer <num> number of subevents to keep in buffer\n"
		"\t                         default is 720\n"
		"\t    --quality-file <file>  Save quality events in the file\n"
		"\t-s, --server <socket>  Start monitor server socket\n"
		"\t-p, --priority <level> Show only priority or lower\n"
		"\t-i, --index <num>      Show only specified controller\n"
		"\t-d, --tty <tty>        Read data from TTY\n"
		"\t-B, --tty-speed <rate> Set TTY speed (default 115200)\n"
		"\t-V, --vendor <compid>  Set default company identifier\n"
		"\t-M, --mgmt             Open channel for mgmt events\n"
		"\t-t, --time             Show time instead of time offset\n"
		"\t-T, --date             Show time and date information\n"
		"\t-S, --sco              Dump SCO traffic\n"
		"\t-A, --a2dp             Dump A2DP stream traffic\n"
		"\t-E, --ellisys [ip]     Send Ellisys HCI Injection\n"
		"\t-P, --no-pager         Disable pager usage\n"
		"\t-J  --jlink <device>,[<serialno>],[<interface>],[<speed>]\n"
		"\t                       Read data from RTT\n"
		"\t-R  --rtt [<address>],[<area>],[<name>]\n"
		"\t                       RTT control block parameters\n"
		"\t-C, --columns [width]  Output width if not a terminal\n"
		"\t-c, --color [mode]     Output color: auto/always/never\n"
		"\t-h, --help             Show help options\n");
}

static const struct option main_options[] = {
	{ "zero",      no_argument,       NULL, '0' },
	{ "read",      required_argument, NULL, 'r' },
	{ "write",     required_argument, NULL, 'w' },
	{ "limit-size",required_argument, NULL, 'l' },
	{ "file-rotate",  required_argument, NULL, 'f' },
	{ "compress",  no_argument,       NULL, OPT_COMPRESS },
	{ "analyze",   required_argument, NULL, 'a' },
	{ "quality-buffer", required_argument, NULL, OPT_BQR_BUFFER },
	{ "quality-file",  required_argument, NULL, OPT_BQR_FILE },
	{ "server",    required_argument, NULL, 's' },
	{ "priority",  required_argument, NULL, 'p' },
	{ "index",     required_argument, NULL, 'i' },
	{ "tty",       required_argument, NULL, 'd' },
	{ "tty-speed", required_argument, NULL, 'B' },
	{ "vendor",    required_argument, NULL, 'V' },
	{ "mgmt",      no_argument,       NULL, 'M' },
	{ "no-time",   no_argument,       NULL, 'N' },
	{ "time",      no_argument,       NULL, 't' },
	{ "date",      no_argument,       NULL, 'T' },
	{ "sco",       no_argument,       NULL, 'S' },
	{ "a2dp",      no_argument,       NULL, 'A' },
	{ "ellisys",   required_argument, NULL, 'E' },
	{ "no-pager",  no_argument,       NULL, 'P' },
	{ "jlink",     required_argument, NULL, 'J' },
	{ "rtt",       required_argument, NULL, 'R' },
	{ "columns",   required_argument, NULL, 'C' },
	{ "color",     required_argument, NULL, 'c' },
	{ "todo",      no_argument,       NULL, '#' },
	{ "version",   no_argument,       NULL, 'v' },
	{ "help",      no_argument,       NULL, 'h' },
	{ }
};

int main(int argc, char *argv[])
{
	unsigned long filter_mask = 0;
	bool use_pager = true;
	bool compress = false;
	bool rotate = false;
	int size_limit = 0;
	const char *reader_path = NULL;
	const char *writer_path = NULL;
	const char *analyze_path = NULL;
	const char *bqr_path = NULL;
	unsigned int bqr_buffer_length = 0;
	const char *ellisys_server = NULL;
	const char *tty = NULL;
	unsigned int tty_speed = B115200;
	unsigned short ellisys_port = 0;
	const char *str;
	char *jlink = NULL;
	char *rtt = NULL;
	int exit_status;

	mainloop_init();

	filter_mask |= PACKET_FILTER_SHOW_TIME_OFFSET;

	for (;;) {
		int opt;
		struct sockaddr_un addr;

		opt = getopt_long(argc, argv,
					"r:w:a:s:p:i:d:B:V:MNtTSAE:PJ:R:C:c:vh0l:f",
					main_options, NULL);
		if (opt < 0)
			break;

		switch (opt) {
		case '0':
			filter_mask |= PACKET_FILTER_ZERO_DATA;
			break;
		case 'r':
			reader_path = optarg;
			break;
		case 'w':
			writer_path = optarg;
			break;
		case 'l':
			size_limit = atoi(optarg);
			if (size_limit < 0) {
				fprintf(stderr, "bad limit: %d\n", size_limit);
				return EXIT_FAILURE;
			}
			break;
		case 'f':
			rotate = true;
			break;
		case OPT_COMPRESS:
			compress = true;
			break;
		case 'a':
			analyze_path = optarg;
			break;
		case OPT_BQR_BUFFER:
			bqr_buffer_length = atoi(optarg);
			if (bqr_buffer_length <= 0) {
				fprintf(stderr,
					"invalid quality-buffer value\n");
				return EXIT_FAILURE;
			}
			set_bqr_buffer_length(bqr_buffer_length);
			break;
		case OPT_BQR_FILE:
			bqr_path = optarg;
			break;
		case 's':
			if (strlen(optarg) > sizeof(addr.sun_path) - 1) {
				fprintf(stderr, "Socket name too long\n");
				return EXIT_FAILURE;
			}
			control_server(optarg);
			break;
		case 'p':
			packet_set_priority(optarg);
			break;
		case 'i':
			if (strlen(optarg) > 3 && !strncmp(optarg, "hci", 3))
				str = optarg + 3;
			else
				str = optarg;
			if (!isdigit(*str)) {
				usage();
				return EXIT_FAILURE;
			}
			packet_select_index(atoi(str));
			break;
		case 'd':
			tty = optarg;
			break;
		case 'B':
			tty_speed = tty_get_speed(atoi(optarg));
			if (!tty_speed) {
				fprintf(stderr, "Unknown speed: %s\n", optarg);
				return EXIT_FAILURE;
			}
			break;
		case 'V':
			str = optarg;
			packet_set_fallback_manufacturer(atoi(str));
			break;
		case 'M':
			filter_mask |= PACKET_FILTER_SHOW_MGMT_SOCKET;
			break;
		case 'N':
			filter_mask &= ~PACKET_FILTER_SHOW_TIME_OFFSET;
			break;
		case 't':
			filter_mask &= ~PACKET_FILTER_SHOW_TIME_OFFSET;
			filter_mask |= PACKET_FILTER_SHOW_TIME;
			break;
		case 'T':
			filter_mask &= ~PACKET_FILTER_SHOW_TIME_OFFSET;
			filter_mask |= PACKET_FILTER_SHOW_TIME;
			filter_mask |= PACKET_FILTER_SHOW_DATE;
			break;
		case 'S':
			filter_mask |= PACKET_FILTER_SHOW_SCO_DATA;
			break;
		case 'A':
			filter_mask |= PACKET_FILTER_SHOW_A2DP_STREAM;
			break;
		case 'E':
			ellisys_server = optarg;
			ellisys_port = 24352;
			break;
		case 'P':
			use_pager = false;
			break;
		case 'J':
			jlink = optarg;
			break;
		case 'R':
			rtt = optarg;
			break;
		case 'C':
			set_default_pager_num_columns(atoi(optarg));
			break;
		case 'c':
			if (strcmp("always", optarg) == 0)
				set_monitor_color(COLOR_ALWAYS);
			else if (strcmp("never", optarg) == 0)
				set_monitor_color(COLOR_NEVER);
			else if (strcmp("auto", optarg) == 0)
				set_monitor_color(COLOR_AUTO);
			else {
				fprintf(stderr, "Color option must be one of "
						"auto/always/never\n");
				return EXIT_FAILURE;
			}
			break;
		case '#':
			packet_todo();
			lmp_todo();
			return EXIT_SUCCESS;
		case 'v':
			printf("%s\n", VERSION);
			return EXIT_SUCCESS;
		case 'h':
			usage();
			return EXIT_SUCCESS;
		default:
			return EXIT_FAILURE;
		}
	}

	if (argc - optind > 0) {
		fprintf(stderr, "Invalid command line parameters\n");
		return EXIT_FAILURE;
	}

	if (reader_path && analyze_path) {
		fprintf(stderr, "Display and analyze can't be combined\n");
		return EXIT_FAILURE;
	}

	printf("Bluetooth monitor ver %s\n", VERSION);

	keys_setup();

	packet_set_filter(filter_mask);

	if (analyze_path) {
		FILE *fp_bqr = NULL;

		if (bqr_path) {
			fp_bqr = bqr_file_create(bqr_path);
			if (!fp_bqr)
				fprintf(stderr, "Failed to create file %s.\n",
					bqr_path);
		}

		analyze_trace(analyze_path);

		if (fp_bqr)
			bqr_file_close();

		return EXIT_SUCCESS;
	}

	if (reader_path) {
		if (ellisys_server)
			ellisys_enable(ellisys_server, ellisys_port);

		control_reader(reader_path, use_pager);
		return EXIT_SUCCESS;
	}

	if (rotate && (!writer_path || !size_limit)) {
		printf("Rotating logs also requires -w and -l\n");
		return EXIT_FAILURE;
	}

	if (writer_path && !control_writer(writer_path, compress, size_limit,
								rotate)) {
		printf("Failed to open '%s'\n", writer_path);
		return EXIT_FAILURE;
	}

	if (ellisys_server)
		ellisys_enable(ellisys_server, ellisys_port);

	if (!tty && !jlink && control_tracing() < 0)
		return EXIT_FAILURE;

	if (tty && control_tty(tty, tty_speed) < 0)
		return EXIT_FAILURE;

	if (jlink && control_rtt(jlink, rtt) < 0)
		return EXIT_FAILURE;

	exit_status = mainloop_run_with_signal(signal_callback, NULL);

	keys_cleanup();

	return exit_status;
}