diff mbox series

[bluez,v3,3/3] btmgmt: Add command "add" into "monitor" btmgmt submenu

Message ID 20200617005531.bluez.v3.3.I55df963e4055bf1778db6f9e46f166b88472e051@changeid (mailing list archive)
State New, archived
Headers show
Series Add new commands in btmgmt to support adv monitor | expand

Commit Message

Michael Sun June 17, 2020, 7:55 a.m. UTC 
This patch introduces a new command ‘add’ within "monitor" submenu to
allow users to add advertisement monitor filters and get back monitor
handlers. An event handler is also added to handle kernel issued
MGMT_EV_ADV_MONITOR_ADDED events. The command will work with the new
MGMT opcode MGMT_OP_ADD_ADV_MONITOR. This patch only adds support for
adding pattern based filters.

Reviewed-by: Alain Michaud <alainm@chromium.org>
Reviewed-by: Miao-chen Chou <mcchou@chromium.org>
Signed-off-by: Michael Sun <michaelfsun@google.com>
---

Changes in v3:
- Fix build errors

Changes in v2:
- Move add command into submenu and fix build warnings

 tools/btmgmt.c | 161 ++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 160 insertions(+), 1 deletion(-)

Comments

bluez.test.bot@gmail.com June 17, 2020, 8:08 a.m. UTC | #1 
This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list.
While we are preparing for reviewing the patches, we found the following
issue/warning.

Test Result:
checkpatch Failed

Outputs:
WARNING:PREFER_FALLTHROUGH: Prefer 'fallthrough;' over fallthrough comment
#168: FILE: tools/btmgmt.c:4784:
+			/* fall through */

- total: 0 errors, 1 warnings, 191 lines checked

NOTE: For some of the reported defects, checkpatch may be able to
      mechanically convert to the typical style using --fix or --fix-inplace.

Your patch has style problems, please review.

NOTE: Ignored message types: COMMIT_MESSAGE COMPLEX_MACRO CONST_STRUCT FILE_PATH_CHANGES MISSING_SIGN_OFF PREFER_PACKED SPLIT_STRING

NOTE: If any of the errors are false positives, please report
      them to the maintainer, see CHECKPATCH in MAINTAINERS.



---
Regards,
Linux Bluetooth
Von Dentz, Luiz June 17, 2020, 3:01 p.m. UTC | #2 
Hi Michael,

On Wed, Jun 17, 2020 at 12:55 AM Michael Sun <michaelfsun@google.com> wrote:
>
> This patch introduces a new command ‘add’ within "monitor" submenu to
> allow users to add advertisement monitor filters and get back monitor
> handlers. An event handler is also added to handle kernel issued
> MGMT_EV_ADV_MONITOR_ADDED events. The command will work with the new
> MGMT opcode MGMT_OP_ADD_ADV_MONITOR. This patch only adds support for
> adding pattern based filters.
>
> Reviewed-by: Alain Michaud <alainm@chromium.org>
> Reviewed-by: Miao-chen Chou <mcchou@chromium.org>
> Signed-off-by: Michael Sun <michaelfsun@google.com>
> ---
>
> Changes in v3:
> - Fix build errors
>
> Changes in v2:
> - Move add command into submenu and fix build warnings
>
>  tools/btmgmt.c | 161 ++++++++++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 160 insertions(+), 1 deletion(-)
>
> diff --git a/tools/btmgmt.c b/tools/btmgmt.c
> index 5a70e9e1c3e9..ce2a198b1b29 100644
> --- a/tools/btmgmt.c
> +++ b/tools/btmgmt.c
> @@ -1013,6 +1013,19 @@ static void advertising_removed(uint16_t index, uint16_t len,
>         print("hci%u advertising_removed: instance %u", index, ev->instance);
>  }
>
> +static void advmon_added(uint16_t index, uint16_t len, const void *param,
> +                                                       void *user_data)
> +{
> +       const struct mgmt_ev_adv_monitor_added *ev = param;
> +
> +       if (len < sizeof(*ev)) {
> +               error("Too small (%u bytes) %s event", len, __func__);
> +               return;
> +       }
> +
> +       print("hci%u %s: handle %u", index, __func__, ev->monitor_handle);
> +}
> +
>  static void advmon_removed(uint16_t index, uint16_t len, const void *param,
>                                                         void *user_data)
>  {
> @@ -4587,7 +4600,7 @@ static const char * const advmon_features_str[] = {
>  static const char *advmon_features2str(uint32_t features)
>  {
>         static char str[512];
> -       int off, i;
> +       unsigned int off, i;
>
>         off = 0;
>         snprintf(str, sizeof(str), "\n\tNone");
> @@ -4657,6 +4670,148 @@ static void cmd_advmon_features(int argc, char **argv)
>         }
>  }
>
> +static void advmon_add_rsp(uint8_t status, uint16_t len, const void *param,
> +                                                       void *user_data)
> +{
> +       const struct mgmt_rp_add_adv_patterns_monitor *rp = param;
> +
> +       if (status != MGMT_STATUS_SUCCESS) {
> +               error("Could not add advertisement monitor with status "
> +                               "0x%02x (%s)", status, mgmt_errstr(status));
> +               return bt_shell_noninteractive_quit(EXIT_FAILURE);
> +       }
> +
> +       print("Advertisement monitor with handle:0x%04x added",
> +                                                       rp->monitor_handle);
> +       return bt_shell_noninteractive_quit(EXIT_SUCCESS);
> +}
> +
> +static bool str2pattern(struct mgmt_adv_pattern *pattern, const char *str)
> +{
> +       int type_len, offset_len, offset_end_pos, str_len;
> +       int i, j;
> +       char pattern_str[62] = { 0 };
> +       char tmp;
> +
> +       if (sscanf(str, "%2hhx%n:%2hhx%n:%s", &pattern->ad_type, &type_len,
> +                       &pattern->offset, &offset_end_pos, pattern_str) != 3)
> +               return false;
> +
> +       offset_len = offset_end_pos - type_len - 1;
> +       str_len = strlen(pattern_str);
> +       pattern->length = str_len / 2 + str_len % 2;
> +
> +       if (type_len > 2 || offset_len > 2 ||
> +                                       pattern->offset + pattern->length > 31)
> +               return false;
> +
> +       for (i = 0, j = 0; i < str_len; i++, j++) {
> +               if (sscanf(&pattern_str[i++], "%2hhx", &pattern->value[j])
> +                                                                       != 1)
> +                       return false;
> +               if (i < str_len && sscanf(&pattern_str[i], "%1hhx", &tmp) != 1)
> +                       return false;
> +       }
> +
> +       return true;
> +}
> +
> +static void advmon_add_usage(void)
> +{
> +       bt_shell_usage();
> +       print("Options:\n"
> +               "\t-P, --pattern <ad_type:offset:pattern>  "
> +               "Advertising data bytes\n"
> +               "Monitor Types:\n"
> +               "\t-p, --pattern-monitor                        "
> +               "Pattern Monitor\n"
> +               "e.g.:\n"
> +               "\tadd -P 0:1:c504 -P 1:a:9a55beef -p");
> +}
> +
> +static struct option advmon_add_options[] = {
> +                                       { "help", 0, 0, 'h' },
> +                                       { "pattern-monitor", 0, 0, 'p' },
> +                                       { "pattern", 1, 0, 'P' },
> +                                       { 0, 0, 0, 0 } };
> +
> +static void cmd_advmon_add(int argc, char **argv)
> +{
> +
> +       uint16_t index;
> +       void *cp = NULL;
> +       struct mgmt_adv_pattern *patterns = NULL;
> +       int opt, patterns_len;
> +       int pattern_count = 0, cp_len = 0;
> +       bool success = false, type_selected = false;
> +
> +       index = mgmt_index;
> +       if (index == MGMT_INDEX_NONE)
> +               index = 0;
> +
> +       while ((opt = getopt_long(argc, argv, "P:ph", advmon_add_options,
> +                                                               NULL)) != -1) {
> +               switch (opt) {
> +               case 'P':
> +                       patterns_len = (pattern_count + 1) *
> +                                       sizeof(struct mgmt_adv_pattern);
> +                       patterns = realloc(patterns, patterns_len);
> +
> +                       if (!str2pattern(&patterns[pattern_count++], optarg)) {
> +                               error("Failed to parse monitor patterns.");
> +                               goto done;
> +                       }
> +                       break;
> +               case 'p':
> +                       if (!pattern_count) {
> +                               advmon_add_usage();
> +                               goto done;
> +                       }
> +                       cp_len =
> +                               sizeof(struct mgmt_cp_add_adv_monitor) +
> +                               patterns_len;
> +                       cp = realloc(cp, cp_len);
> +
> +                       ((struct mgmt_cp_add_adv_monitor *)cp)
> +                                       ->pattern_count = pattern_count;
> +
> +                       memcpy(((struct mgmt_cp_add_adv_monitor *)cp)
> +                                       ->patterns, patterns, patterns_len);
> +                       type_selected = true;
> +                       break;
> +               case 'h':
> +                       success = true;
> +                       /* fall through */
> +               default:
> +                       advmon_add_usage();
> +                       goto done;
> +               }
> +       }
> +
> +       argc -= optind;
> +       argv += optind;
> +
> +       if (argc || !type_selected) {
> +               advmon_add_usage();
> +               goto done;
> +       }
> +
> +       if (!mgmt_send(mgmt, MGMT_OP_ADD_ADV_PATTERNS_MONITOR, index, cp_len,
> +                                       cp, advmon_add_rsp, NULL, NULL)) {
> +               error("Unable to send \"Add Advertising Monitor\" command");
> +               goto done;
> +       }
> +
> +       success = true;
> +
> +done:
> +       optind = 0;
> +       free(patterns);
> +       free(cp);
> +       if (!success)
> +               bt_shell_noninteractive_quit(EXIT_FAILURE);
> +}
> +
>  static void advmon_remove_rsp(uint8_t status, uint16_t len, const void *param,
>                                                         void *user_data)
>  {
> @@ -4747,6 +4902,8 @@ static void register_mgmt_callbacks(struct mgmt *mgmt, uint16_t index)
>                                                 advertising_added, NULL, NULL);
>         mgmt_register(mgmt, MGMT_EV_ADVERTISING_REMOVED, index,
>                                         advertising_removed, NULL, NULL);
> +       mgmt_register(mgmt, MGMT_EV_ADV_MONITOR_ADDED, index, advmon_added,
> +                                                               NULL, NULL);
>         mgmt_register(mgmt, MGMT_EV_ADV_MONITOR_REMOVED, index, advmon_removed,
>                                                                 NULL, NULL);
>  }
> @@ -4774,6 +4931,8 @@ static const struct bt_shell_menu monitor_menu = {
>                                         "features"                      },
>         { "remove",             "<handle>",
>                 cmd_advmon_remove,      "Remove advertisement monitor " },
> +       { "add",                "[options] <-p|-h>",
> +               cmd_advmon_add,         "Add advertisement monitor"     },

Is there any particular reason why you are adding getopt options
instead of just having regular arguments? Also the optional parameters
(those delimited by []), shall come after the mandatory ones
(delimited by <>).

>         { } },
>  };
>
> --
> 2.27.0.290.gba653c62da-goog
>
diff mbox series

Patch

diff --git a/tools/btmgmt.c b/tools/btmgmt.c
index 5a70e9e1c3e9..ce2a198b1b29 100644
--- a/tools/btmgmt.c
+++ b/tools/btmgmt.c
@@ -1013,6 +1013,19 @@  static void advertising_removed(uint16_t index, uint16_t len,
 	print("hci%u advertising_removed: instance %u", index, ev->instance);
 }
 
+static void advmon_added(uint16_t index, uint16_t len, const void *param,
+							void *user_data)
+{
+	const struct mgmt_ev_adv_monitor_added *ev = param;
+
+	if (len < sizeof(*ev)) {
+		error("Too small (%u bytes) %s event", len, __func__);
+		return;
+	}
+
+	print("hci%u %s: handle %u", index, __func__, ev->monitor_handle);
+}
+
 static void advmon_removed(uint16_t index, uint16_t len, const void *param,
 							void *user_data)
 {
@@ -4587,7 +4600,7 @@  static const char * const advmon_features_str[] = {
 static const char *advmon_features2str(uint32_t features)
 {
 	static char str[512];
-	int off, i;
+	unsigned int off, i;
 
 	off = 0;
 	snprintf(str, sizeof(str), "\n\tNone");
@@ -4657,6 +4670,148 @@  static void cmd_advmon_features(int argc, char **argv)
 	}
 }
 
+static void advmon_add_rsp(uint8_t status, uint16_t len, const void *param,
+							void *user_data)
+{
+	const struct mgmt_rp_add_adv_patterns_monitor *rp = param;
+
+	if (status != MGMT_STATUS_SUCCESS) {
+		error("Could not add advertisement monitor with status "
+				"0x%02x (%s)", status, mgmt_errstr(status));
+		return bt_shell_noninteractive_quit(EXIT_FAILURE);
+	}
+
+	print("Advertisement monitor with handle:0x%04x added",
+							rp->monitor_handle);
+	return bt_shell_noninteractive_quit(EXIT_SUCCESS);
+}
+
+static bool str2pattern(struct mgmt_adv_pattern *pattern, const char *str)
+{
+	int type_len, offset_len, offset_end_pos, str_len;
+	int i, j;
+	char pattern_str[62] = { 0 };
+	char tmp;
+
+	if (sscanf(str, "%2hhx%n:%2hhx%n:%s", &pattern->ad_type, &type_len,
+			&pattern->offset, &offset_end_pos, pattern_str) != 3)
+		return false;
+
+	offset_len = offset_end_pos - type_len - 1;
+	str_len = strlen(pattern_str);
+	pattern->length = str_len / 2 + str_len % 2;
+
+	if (type_len > 2 || offset_len > 2 ||
+					pattern->offset + pattern->length > 31)
+		return false;
+
+	for (i = 0, j = 0; i < str_len; i++, j++) {
+		if (sscanf(&pattern_str[i++], "%2hhx", &pattern->value[j])
+									!= 1)
+			return false;
+		if (i < str_len && sscanf(&pattern_str[i], "%1hhx", &tmp) != 1)
+			return false;
+	}
+
+	return true;
+}
+
+static void advmon_add_usage(void)
+{
+	bt_shell_usage();
+	print("Options:\n"
+		"\t-P, --pattern <ad_type:offset:pattern>  "
+		"Advertising data bytes\n"
+		"Monitor Types:\n"
+		"\t-p, --pattern-monitor			"
+		"Pattern Monitor\n"
+		"e.g.:\n"
+		"\tadd -P 0:1:c504 -P 1:a:9a55beef -p");
+}
+
+static struct option advmon_add_options[] = {
+					{ "help", 0, 0, 'h' },
+					{ "pattern-monitor", 0, 0, 'p' },
+					{ "pattern", 1, 0, 'P' },
+					{ 0, 0, 0, 0 } };
+
+static void cmd_advmon_add(int argc, char **argv)
+{
+
+	uint16_t index;
+	void *cp = NULL;
+	struct mgmt_adv_pattern *patterns = NULL;
+	int opt, patterns_len;
+	int pattern_count = 0, cp_len = 0;
+	bool success = false, type_selected = false;
+
+	index = mgmt_index;
+	if (index == MGMT_INDEX_NONE)
+		index = 0;
+
+	while ((opt = getopt_long(argc, argv, "P:ph", advmon_add_options,
+								NULL)) != -1) {
+		switch (opt) {
+		case 'P':
+			patterns_len = (pattern_count + 1) *
+					sizeof(struct mgmt_adv_pattern);
+			patterns = realloc(patterns, patterns_len);
+
+			if (!str2pattern(&patterns[pattern_count++], optarg)) {
+				error("Failed to parse monitor patterns.");
+				goto done;
+			}
+			break;
+		case 'p':
+			if (!pattern_count) {
+				advmon_add_usage();
+				goto done;
+			}
+			cp_len =
+				sizeof(struct mgmt_cp_add_adv_monitor) +
+				patterns_len;
+			cp = realloc(cp, cp_len);
+
+			((struct mgmt_cp_add_adv_monitor *)cp)
+					->pattern_count = pattern_count;
+
+			memcpy(((struct mgmt_cp_add_adv_monitor *)cp)
+					->patterns, patterns, patterns_len);
+			type_selected = true;
+			break;
+		case 'h':
+			success = true;
+			/* fall through */
+		default:
+			advmon_add_usage();
+			goto done;
+		}
+	}
+
+	argc -= optind;
+	argv += optind;
+
+	if (argc || !type_selected) {
+		advmon_add_usage();
+		goto done;
+	}
+
+	if (!mgmt_send(mgmt, MGMT_OP_ADD_ADV_PATTERNS_MONITOR, index, cp_len,
+					cp, advmon_add_rsp, NULL, NULL)) {
+		error("Unable to send \"Add Advertising Monitor\" command");
+		goto done;
+	}
+
+	success = true;
+
+done:
+	optind = 0;
+	free(patterns);
+	free(cp);
+	if (!success)
+		bt_shell_noninteractive_quit(EXIT_FAILURE);
+}
+
 static void advmon_remove_rsp(uint8_t status, uint16_t len, const void *param,
 							void *user_data)
 {
@@ -4747,6 +4902,8 @@  static void register_mgmt_callbacks(struct mgmt *mgmt, uint16_t index)
 						advertising_added, NULL, NULL);
 	mgmt_register(mgmt, MGMT_EV_ADVERTISING_REMOVED, index,
 					advertising_removed, NULL, NULL);
+	mgmt_register(mgmt, MGMT_EV_ADV_MONITOR_ADDED, index, advmon_added,
+								NULL, NULL);
 	mgmt_register(mgmt, MGMT_EV_ADV_MONITOR_REMOVED, index, advmon_removed,
 								NULL, NULL);
 }
@@ -4774,6 +4931,8 @@  static const struct bt_shell_menu monitor_menu = {
 					"features"			},
 	{ "remove",		"<handle>",
 		cmd_advmon_remove,	"Remove advertisement monitor "	},
+	{ "add",		"[options] <-p|-h>",
+		cmd_advmon_add,		"Add advertisement monitor"	},
 	{ } },
 };