[PATCH v12 0/4] usb: gadget: configfs: add some trace event

[PATCH v12 0/4] usb: gadget: configfs: add some trace event

[Linyu Yuan]

this series make some minor change to gadget configfs and
add some important trace event from configfs layer.

follow suggestion from Felipe Balbi in link below,
https://lore.kernel.org/linux-usb/1629777281-30188-1-git-send-email-quic_linyyuan@quicinc.com/

v2: fix two issue Reported-by: kernel test robot <lkp@intel.com>
v3: do not move private structure to configfs.h
v4: add missing new file configfs_trace.h
v5: lost some change of v2, add it again
v6: fix comments from Greg Kroah-Hartman
v7: three minor changes according to coding rules
v8: change two trace location
v9: fix when config is empty
v10: fix wrong api in v9
v11: split to three changes, minor change to trace event print format
v12: use mutex lock gi->lock to make sure data safe for trace

trace event will looks like as below,
config_usb_cfg_link: g1: 0 0 0 0 0 0 0 0 0000 0510 6 0 {1 80 2 Function FS Gadget,}; - (null)
gadget_dev_desc_UDC_store: g1: 0 0 0 0 0 0 0 0 0000 0510 6 0 {1 80 2 Function FS Gadget,}; - dummy_udc
unregister_gadget: g1: 0 0 0 0 0 0 0 0 0000 0510 6 0 {1 80 2 Function FS Gadget,}; - dummy_udc
config_usb_cfg_unlink: g1: 0 0 0 0 0 0 0 0 0000 0510 6 0 {1 80 2 }, - (null)

Linyu Yuan (4):
  usb: gadget: configfs: add cfg_to_gadget_info() helper
  usb: gadget: configfs: change config attributes file operation
  usb: gadget: configfs: use gi->lock to protect write operation
  usb: gadget: add configfs trace events

 drivers/usb/gadget/configfs.c       |  61 ++++++++++---
 drivers/usb/gadget/configfs_trace.h | 168 ++++++++++++++++++++++++++++++++++++
 2 files changed, 218 insertions(+), 11 deletions(-)
 create mode 100644 drivers/usb/gadget/configfs_trace.h

-- 
2.7.4

[PATCH v12 1/4] usb: gadget: configfs: add cfg_to_gadget_info() helper

[Linyu Yuan]

add this helper function can simplify code of
config_usb_cfg_link() and config_usb_cfg_unlink().

Signed-off-by: Linyu Yuan <quic_linyyuan@quicinc.com>
---
 drivers/usb/gadget/configfs.c | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/drivers/usb/gadget/configfs.c b/drivers/usb/gadget/configfs.c
index 477e72a..58615dc 100644
--- a/drivers/usb/gadget/configfs.c
+++ b/drivers/usb/gadget/configfs.c
@@ -73,6 +73,11 @@ static inline struct config_usb_cfg *to_config_usb_cfg(struct config_item *item)
 			group);
 }
 
+static inline struct gadget_info *cfg_to_gadget_info(struct config_usb_cfg *cfg)
+{
+	return container_of(cfg->c.cdev, struct gadget_info, cdev);
+}
+
 struct gadget_strings {
 	struct usb_gadget_strings stringtab_dev;
 	struct usb_string strings[USB_GADGET_FIRST_AVAIL_IDX];
@@ -413,8 +418,7 @@ static int config_usb_cfg_link(
 	struct config_item *usb_func_ci)
 {
 	struct config_usb_cfg *cfg = to_config_usb_cfg(usb_cfg_ci);
-	struct usb_composite_dev *cdev = cfg->c.cdev;
-	struct gadget_info *gi = container_of(cdev, struct gadget_info, cdev);
+	struct gadget_info *gi = cfg_to_gadget_info(cfg);
 
 	struct config_group *group = to_config_group(usb_func_ci);
 	struct usb_function_instance *fi = container_of(group,
@@ -464,8 +468,7 @@ static void config_usb_cfg_unlink(
 	struct config_item *usb_func_ci)
 {
 	struct config_usb_cfg *cfg = to_config_usb_cfg(usb_cfg_ci);
-	struct usb_composite_dev *cdev = cfg->c.cdev;
-	struct gadget_info *gi = container_of(cdev, struct gadget_info, cdev);
+	struct gadget_info *gi = cfg_to_gadget_info(cfg);
 
 	struct config_group *group = to_config_group(usb_func_ci);
 	struct usb_function_instance *fi = container_of(group,
-- 
2.7.4

[PATCH v12 2/4] usb: gadget: configfs: change config attributes file operation

[Linyu Yuan]

in order to add trace event in configfs function with same
struct gadget_info *gi parameter,
add struct config_usb_cfg *cfg variable in below functions,
gadget_config_desc_MaxPower_show(),
gadget_config_desc_MaxPower_store(),
gadget_config_desc_bmAttributes_show(),
gadget_config_desc_bmAttributes_store(),
this allow following patch easy change cfg to gi with helper function
cfg_to_gadget_info().

Signed-off-by: Linyu Yuan <quic_linyyuan@quicinc.com>
---
 drivers/usb/gadget/configfs.c | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/drivers/usb/gadget/configfs.c b/drivers/usb/gadget/configfs.c
index 58615dc..36c611d 100644
--- a/drivers/usb/gadget/configfs.c
+++ b/drivers/usb/gadget/configfs.c
@@ -508,12 +508,15 @@ static struct configfs_item_operations gadget_config_item_ops = {
 static ssize_t gadget_config_desc_MaxPower_show(struct config_item *item,
 		char *page)
 {
-	return sprintf(page, "%u\n", to_config_usb_cfg(item)->c.MaxPower);
+	struct config_usb_cfg *cfg = to_config_usb_cfg(item);
+
+	return sprintf(page, "%u\n", cfg->c.MaxPower);
 }
 
 static ssize_t gadget_config_desc_MaxPower_store(struct config_item *item,
 		const char *page, size_t len)
 {
+	struct config_usb_cfg *cfg = to_config_usb_cfg(item);
 	u16 val;
 	int ret;
 	ret = kstrtou16(page, 0, &val);
@@ -521,20 +524,22 @@ static ssize_t gadget_config_desc_MaxPower_store(struct config_item *item,
 		return ret;
 	if (DIV_ROUND_UP(val, 8) > 0xff)
 		return -ERANGE;
-	to_config_usb_cfg(item)->c.MaxPower = val;
+	cfg->c.MaxPower = val;
 	return len;
 }
 
 static ssize_t gadget_config_desc_bmAttributes_show(struct config_item *item,
 		char *page)
 {
-	return sprintf(page, "0x%02x\n",
-		to_config_usb_cfg(item)->c.bmAttributes);
+	struct config_usb_cfg *cfg = to_config_usb_cfg(item);
+
+	return sprintf(page, "0x%02x\n", cfg->c.bmAttributes);
 }
 
 static ssize_t gadget_config_desc_bmAttributes_store(struct config_item *item,
 		const char *page, size_t len)
 {
+	struct config_usb_cfg *cfg = to_config_usb_cfg(item);
 	u8 val;
 	int ret;
 	ret = kstrtou8(page, 0, &val);
@@ -545,7 +550,7 @@ static ssize_t gadget_config_desc_bmAttributes_store(struct config_item *item,
 	if (val & ~(USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER |
 				USB_CONFIG_ATT_WAKEUP))
 		return -EINVAL;
-	to_config_usb_cfg(item)->c.bmAttributes = val;
+	cfg->c.bmAttributes = val;
 	return len;
 }
 
-- 
2.7.4

[PATCH v12 3/4] usb: gadget: configfs: use gi->lock to protect write operation

[Linyu Yuan]

write operation from user space should be protected by
one mutex lock gi->lock.

Signed-off-by: Linyu Yuan <quic_linyyuan@quicinc.com>
---
 drivers/usb/gadget/configfs.c | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/drivers/usb/gadget/configfs.c b/drivers/usb/gadget/configfs.c
index 36c611d..27aa569 100644
--- a/drivers/usb/gadget/configfs.c
+++ b/drivers/usb/gadget/configfs.c
@@ -199,6 +199,7 @@ static ssize_t is_valid_bcd(u16 bcd_val)
 static ssize_t gadget_dev_desc_bcdDevice_store(struct config_item *item,
 		const char *page, size_t len)
 {
+	struct gadget_info *gi = to_gadget_info(item);
 	u16 bcdDevice;
 	int ret;
 
@@ -209,13 +210,16 @@ static ssize_t gadget_dev_desc_bcdDevice_store(struct config_item *item,
 	if (ret)
 		return ret;
 
-	to_gadget_info(item)->cdev.desc.bcdDevice = cpu_to_le16(bcdDevice);
+	mutex_lock(&gi->lock);
+	gi->cdev.desc.bcdDevice = cpu_to_le16(bcdDevice);
+	mutex_unlock(&gi->lock);
 	return len;
 }
 
 static ssize_t gadget_dev_desc_bcdUSB_store(struct config_item *item,
 		const char *page, size_t len)
 {
+	struct gadget_info *gi = to_gadget_info(item);
 	u16 bcdUSB;
 	int ret;
 
@@ -226,7 +230,9 @@ static ssize_t gadget_dev_desc_bcdUSB_store(struct config_item *item,
 	if (ret)
 		return ret;
 
-	to_gadget_info(item)->cdev.desc.bcdUSB = cpu_to_le16(bcdUSB);
+	mutex_lock(&gi->lock);
+	gi->cdev.desc.bcdUSB = cpu_to_le16(bcdUSB);
+	mutex_unlock(&gi->lock);
 	return len;
 }
 
@@ -517,6 +523,7 @@ static ssize_t gadget_config_desc_MaxPower_store(struct config_item *item,
 		const char *page, size_t len)
 {
 	struct config_usb_cfg *cfg = to_config_usb_cfg(item);
+	struct gadget_info *gi = cfg_to_gadget_info(cfg);
 	u16 val;
 	int ret;
 	ret = kstrtou16(page, 0, &val);
@@ -524,7 +531,9 @@ static ssize_t gadget_config_desc_MaxPower_store(struct config_item *item,
 		return ret;
 	if (DIV_ROUND_UP(val, 8) > 0xff)
 		return -ERANGE;
+	mutex_lock(&gi->lock);
 	cfg->c.MaxPower = val;
+	mutex_unlock(&gi->lock);
 	return len;
 }
 
@@ -540,6 +549,7 @@ static ssize_t gadget_config_desc_bmAttributes_store(struct config_item *item,
 		const char *page, size_t len)
 {
 	struct config_usb_cfg *cfg = to_config_usb_cfg(item);
+	struct gadget_info *gi = cfg_to_gadget_info(cfg);
 	u8 val;
 	int ret;
 	ret = kstrtou8(page, 0, &val);
@@ -550,7 +560,9 @@ static ssize_t gadget_config_desc_bmAttributes_store(struct config_item *item,
 	if (val & ~(USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER |
 				USB_CONFIG_ATT_WAKEUP))
 		return -EINVAL;
+	mutex_lock(&gi->lock);
 	cfg->c.bmAttributes = val;
+	mutex_unlock(&gi->lock);
 	return len;
 }
 
@@ -729,7 +741,9 @@ static struct config_group *config_desc_make(
 			&gadget_config_name_strings_type);
 	configfs_add_default_group(&cfg->strings_group, &cfg->group);
 
+	mutex_lock(&gi->lock);
 	ret = usb_add_config_only(&gi->cdev, &cfg->c);
+	mutex_unlock(&gi->lock);
 	if (ret)
 		goto err;
 
-- 
2.7.4

Re: [PATCH v12 3/4] usb: gadget: configfs: use gi->lock to protect write operation

[Greg Kroah-Hartman]

On Tue, Oct 19, 2021 at 09:26:36PM +0800, Linyu Yuan wrote:
> write operation from user space should be protected by
> one mutex lock gi->lock.
> 
> Signed-off-by: Linyu Yuan <quic_linyyuan@quicinc.com>
> ---
>  drivers/usb/gadget/configfs.c | 18 ++++++++++++++++--
>  1 file changed, 16 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/usb/gadget/configfs.c b/drivers/usb/gadget/configfs.c
> index 36c611d..27aa569 100644
> --- a/drivers/usb/gadget/configfs.c
> +++ b/drivers/usb/gadget/configfs.c
> @@ -199,6 +199,7 @@ static ssize_t is_valid_bcd(u16 bcd_val)
>  static ssize_t gadget_dev_desc_bcdDevice_store(struct config_item *item,
>  		const char *page, size_t len)
>  {
> +	struct gadget_info *gi = to_gadget_info(item);
>  	u16 bcdDevice;
>  	int ret;
>  
> @@ -209,13 +210,16 @@ static ssize_t gadget_dev_desc_bcdDevice_store(struct config_item *item,
>  	if (ret)
>  		return ret;
>  
> -	to_gadget_info(item)->cdev.desc.bcdDevice = cpu_to_le16(bcdDevice);
> +	mutex_lock(&gi->lock);
> +	gi->cdev.desc.bcdDevice = cpu_to_le16(bcdDevice);
> +	mutex_unlock(&gi->lock);

What exactly is this lock now protecting?

How can this write cause a problem if it is read from before or after it
changes?  What problem is this lock now solving?

>  	return len;
>  }
>  
>  static ssize_t gadget_dev_desc_bcdUSB_store(struct config_item *item,
>  		const char *page, size_t len)
>  {
> +	struct gadget_info *gi = to_gadget_info(item);
>  	u16 bcdUSB;
>  	int ret;
>  
> @@ -226,7 +230,9 @@ static ssize_t gadget_dev_desc_bcdUSB_store(struct config_item *item,
>  	if (ret)
>  		return ret;
>  
> -	to_gadget_info(item)->cdev.desc.bcdUSB = cpu_to_le16(bcdUSB);
> +	mutex_lock(&gi->lock);
> +	gi->cdev.desc.bcdUSB = cpu_to_le16(bcdUSB);
> +	mutex_unlock(&gi->lock);

Same here.

>  	return len;
>  }
>  
> @@ -517,6 +523,7 @@ static ssize_t gadget_config_desc_MaxPower_store(struct config_item *item,
>  		const char *page, size_t len)
>  {
>  	struct config_usb_cfg *cfg = to_config_usb_cfg(item);
> +	struct gadget_info *gi = cfg_to_gadget_info(cfg);
>  	u16 val;
>  	int ret;
>  	ret = kstrtou16(page, 0, &val);
> @@ -524,7 +531,9 @@ static ssize_t gadget_config_desc_MaxPower_store(struct config_item *item,
>  		return ret;
>  	if (DIV_ROUND_UP(val, 8) > 0xff)
>  		return -ERANGE;
> +	mutex_lock(&gi->lock);
>  	cfg->c.MaxPower = val;
> +	mutex_unlock(&gi->lock);

Same here.

>  	return len;
>  }
>  
> @@ -540,6 +549,7 @@ static ssize_t gadget_config_desc_bmAttributes_store(struct config_item *item,
>  		const char *page, size_t len)
>  {
>  	struct config_usb_cfg *cfg = to_config_usb_cfg(item);
> +	struct gadget_info *gi = cfg_to_gadget_info(cfg);
>  	u8 val;
>  	int ret;
>  	ret = kstrtou8(page, 0, &val);
> @@ -550,7 +560,9 @@ static ssize_t gadget_config_desc_bmAttributes_store(struct config_item *item,
>  	if (val & ~(USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER |
>  				USB_CONFIG_ATT_WAKEUP))
>  		return -EINVAL;
> +	mutex_lock(&gi->lock);
>  	cfg->c.bmAttributes = val;
> +	mutex_unlock(&gi->lock);

And here.

>  	return len;
>  }
>  
> @@ -729,7 +741,9 @@ static struct config_group *config_desc_make(
>  			&gadget_config_name_strings_type);
>  	configfs_add_default_group(&cfg->strings_group, &cfg->group);
>  
> +	mutex_lock(&gi->lock);
>  	ret = usb_add_config_only(&gi->cdev, &cfg->c);
> +	mutex_unlock(&gi->lock);

This is different, are you sure you should do this with the lock held?
This looks like an actual fix, possibly, but what is it protecting from
going wrong?

thanks,

greg k-h

[PATCH v12 4/4] usb: gadget: add configfs trace events

[Linyu Yuan]

in case of USB Gadget functions configure through configfs from
a complicated user space program, when switch function from one to another,
if it failed, it is better to find out what action was done to configfs
from user space program.

this change add some trace events which enable/disable a function,
it including add/remove configuration, bind/unbind UDC,
and some attribute files write operation.

Suggested-by: Felipe Balbi <balbi@kernel.org>
Signed-off-by: Linyu Yuan <quic_linyyuan@quicinc.com>
---
v2: fix two issue Reported-by: kernel test robot <lkp@intel.com>
v3: do not move private structure to configfs.h
v4: add missing new file configfs_trace.h
v5: lost some change of v2, add it again
v6: fix comments from Greg Kroah-Hartman
v7: three minor changes according to coding rules
v8: change two trace location
v9: fix when config is empty
v10: fix wrong api in v9
v11: split to 3 changes, remove read trace, change trace event print format
v12: allocate trace string array per gadget driver

 drivers/usb/gadget/configfs.c       |  17 ++++
 drivers/usb/gadget/configfs_trace.h | 168 ++++++++++++++++++++++++++++++++++++
 2 files changed, 185 insertions(+)
 create mode 100644 drivers/usb/gadget/configfs_trace.h

diff --git a/drivers/usb/gadget/configfs.c b/drivers/usb/gadget/configfs.c
index 27aa569..6e7d1b1 100644
--- a/drivers/usb/gadget/configfs.c
+++ b/drivers/usb/gadget/configfs.c
@@ -29,6 +29,7 @@ int check_user_usb_string(const char *name,
 
 #define MAX_NAME_LEN	40
 #define MAX_USB_STRING_LANGS 2
+#define MAX_TRACE_STR_LEN	512
 
 static const struct usb_descriptor_header *otg_desc[2];
 
@@ -51,6 +52,9 @@ struct gadget_info {
 	char qw_sign[OS_STRING_QW_SIGN_LEN];
 	spinlock_t spinlock;
 	bool unbind;
+#ifdef CONFIG_TRACING
+	char trace_string[MAX_TRACE_STR_LEN];
+#endif
 };
 
 static inline struct gadget_info *to_gadget_info(struct config_item *item)
@@ -102,6 +106,10 @@ struct gadget_config_name {
 	struct list_head list;
 };
 
+#define CONFIGFS_TRACE_STRING
+#define CREATE_TRACE_POINTS
+#include "configfs_trace.h"
+
 #define USB_MAX_STRING_WITH_NULL_LEN	(USB_MAX_STRING_LEN+1)
 
 static int usb_string_copy(const char *s, char **s_copy)
@@ -212,6 +220,7 @@ static ssize_t gadget_dev_desc_bcdDevice_store(struct config_item *item,
 
 	mutex_lock(&gi->lock);
 	gi->cdev.desc.bcdDevice = cpu_to_le16(bcdDevice);
+	trace_gadget_dev_desc_bcdDevice_store(gi);
 	mutex_unlock(&gi->lock);
 	return len;
 }
@@ -232,6 +241,7 @@ static ssize_t gadget_dev_desc_bcdUSB_store(struct config_item *item,
 
 	mutex_lock(&gi->lock);
 	gi->cdev.desc.bcdUSB = cpu_to_le16(bcdUSB);
+	trace_gadget_dev_desc_bcdUSB_store(gi);
 	mutex_unlock(&gi->lock);
 	return len;
 }
@@ -254,6 +264,7 @@ static int unregister_gadget(struct gadget_info *gi)
 {
 	int ret;
 
+	trace_unregister_gadget(gi);
 	if (!gi->composite.gadget_driver.udc_name)
 		return -ENODEV;
 
@@ -300,6 +311,7 @@ static ssize_t gadget_dev_desc_UDC_store(struct config_item *item,
 			goto err;
 		}
 	}
+	trace_gadget_dev_desc_UDC_store(gi);
 	mutex_unlock(&gi->lock);
 	return len;
 err:
@@ -342,6 +354,7 @@ static ssize_t gadget_dev_desc_max_speed_store(struct config_item *item,
 
 	gi->composite.gadget_driver.max_speed = gi->composite.max_speed;
 
+	trace_gadget_dev_desc_max_speed_store(gi);
 	mutex_unlock(&gi->lock);
 	return len;
 err:
@@ -465,6 +478,7 @@ static int config_usb_cfg_link(
 	list_add_tail(&f->list, &cfg->func_list);
 	ret = 0;
 out:
+	trace_config_usb_cfg_link(gi);
 	mutex_unlock(&gi->lock);
 	return ret;
 }
@@ -496,6 +510,7 @@ static void config_usb_cfg_unlink(
 		if (f->fi == fi) {
 			list_del(&f->list);
 			usb_put_function(f);
+			trace_config_usb_cfg_unlink(gi);
 			mutex_unlock(&gi->lock);
 			return;
 		}
@@ -533,6 +548,7 @@ static ssize_t gadget_config_desc_MaxPower_store(struct config_item *item,
 		return -ERANGE;
 	mutex_lock(&gi->lock);
 	cfg->c.MaxPower = val;
+	trace_gadget_config_desc_MaxPower_store(gi);
 	mutex_unlock(&gi->lock);
 	return len;
 }
@@ -562,6 +578,7 @@ static ssize_t gadget_config_desc_bmAttributes_store(struct config_item *item,
 		return -EINVAL;
 	mutex_lock(&gi->lock);
 	cfg->c.bmAttributes = val;
+	trace_gadget_config_desc_bmAttributes_store(gi);
 	mutex_unlock(&gi->lock);
 	return len;
 }
diff --git a/drivers/usb/gadget/configfs_trace.h b/drivers/usb/gadget/configfs_trace.h
new file mode 100644
index 0000000..d36c61f
--- /dev/null
+++ b/drivers/usb/gadget/configfs_trace.h
@@ -0,0 +1,168 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * Copyright (c) 2021 Qualcomm Innovation Center, Inc. All rights reserved.
+ */
+
+#ifdef CONFIGFS_TRACE_STRING
+#undef CONFIGFS_TRACE_STRING
+
+#ifdef CONFIG_TRACING
+static __maybe_unused char *configfs_trace_string(struct gadget_info *gi)
+{
+	struct usb_configuration *uc;
+	struct config_usb_cfg *cfg;
+	struct usb_function *f;
+	size_t len = sizeof(gi->trace_string) - 1;
+	int n = 0;
+
+	if (list_empty(&gi->cdev.configs)) {
+		strcat(gi->trace_string, "empty");
+		return gi->trace_string;
+	}
+
+	list_for_each_entry(uc, &gi->cdev.configs, list) {
+		cfg = container_of(uc, struct config_usb_cfg, c);
+
+		n += scnprintf(gi->trace_string + n, len - n,
+			"{%d %02x %d ",
+			uc->bConfigurationValue,
+			uc->bmAttributes,
+			uc->MaxPower);
+
+		list_for_each_entry(f, &cfg->func_list, list)
+			n += scnprintf(gi->trace_string + n,
+				len - n, "%s,", f->name);
+
+		list_for_each_entry(f, &cfg->c.functions, list)
+			n += scnprintf(gi->trace_string + n,
+				len - n, "%s,", f->name);
+
+		n += scnprintf(gi->trace_string + n, len - n, "};");
+	}
+
+	return gi->trace_string;
+}
+#endif /* CONFIG_TRACING */
+
+#endif /* CONFIGFS_TRACE_STRING */
+
+#undef TRACE_SYSTEM
+#define TRACE_SYSTEM configfs_gadget
+
+#if !defined(__CONFIGFS_GADGET_TRACE_H) || defined(TRACE_HEADER_MULTI_READ)
+#define __CONFIGFS_GADGET_TRACE_H
+
+#include <linux/tracepoint.h>
+
+DECLARE_EVENT_CLASS(log_gadget_info,
+	TP_PROTO(struct gadget_info *gi),
+	TP_ARGS(gi),
+	TP_STRUCT__entry(
+		__string(gi_group, config_item_name(&gi->group.cg_item))
+		__field(bool, unbind)
+		__field(bool, use_os_desc)
+		__field(char, b_vendor_code)
+		__field(bool, suspended)
+		__field(bool, setup_pending)
+		__field(bool, os_desc_pending)
+		__field(unsigned int, deactivations)
+		__field(int, delayed_status)
+		__field(u16, bcdUSB)
+		__field(u16, bcdDevice)
+		__string(config, configfs_trace_string(gi))
+		__field(unsigned int, max_speed)
+		__field(bool, needs_serial)
+		__string(udc_name, gi->composite.gadget_driver.udc_name)
+	),
+	TP_fast_assign(
+		__assign_str(gi_group, config_item_name(&gi->group.cg_item));
+		__entry->unbind = gi->unbind;
+		__entry->use_os_desc = gi->use_os_desc;
+		__entry->b_vendor_code = gi->b_vendor_code;
+		__entry->suspended = gi->cdev.suspended;
+		__entry->setup_pending = gi->cdev.setup_pending;
+		__entry->os_desc_pending = gi->cdev.os_desc_pending;
+		__entry->deactivations = gi->cdev.deactivations;
+		__entry->delayed_status = gi->cdev.delayed_status;
+		__entry->bcdUSB = le16_to_cpu(gi->cdev.desc.bcdUSB);
+		__entry->bcdDevice = le16_to_cpu(gi->cdev.desc.bcdDevice);
+		__assign_str(config, configfs_trace_string(gi));
+		__entry->max_speed = gi->composite.max_speed;
+		__entry->needs_serial = gi->composite.needs_serial;
+		__assign_str(udc_name, gi->composite.gadget_driver.udc_name);
+	),
+	TP_printk("%s: %d %d %d %d %d %d %d %d %04x %04x %d %d %s - %s",
+		__get_str(gi_group),
+		__entry->unbind,
+		__entry->use_os_desc,
+		__entry->b_vendor_code,
+		__entry->suspended,
+		__entry->setup_pending,
+		__entry->os_desc_pending,
+		__entry->deactivations,
+		__entry->delayed_status,
+		__entry->bcdUSB,
+		__entry->bcdDevice,
+		__entry->max_speed,
+		__entry->needs_serial,
+		__get_str(config),
+		__get_str(udc_name)
+	)
+);
+
+DEFINE_EVENT(log_gadget_info, gadget_dev_desc_bcdDevice_store,
+	TP_PROTO(struct gadget_info *gi),
+	TP_ARGS(gi)
+);
+
+DEFINE_EVENT(log_gadget_info, gadget_dev_desc_bcdUSB_store,
+	TP_PROTO(struct gadget_info *gi),
+	TP_ARGS(gi)
+);
+
+DEFINE_EVENT(log_gadget_info, unregister_gadget,
+	TP_PROTO(struct gadget_info *gi),
+	TP_ARGS(gi)
+);
+
+DEFINE_EVENT(log_gadget_info, gadget_dev_desc_UDC_store,
+	TP_PROTO(struct gadget_info *gi),
+	TP_ARGS(gi)
+);
+
+DEFINE_EVENT(log_gadget_info, gadget_dev_desc_max_speed_store,
+	TP_PROTO(struct gadget_info *gi),
+	TP_ARGS(gi)
+);
+
+DEFINE_EVENT(log_gadget_info, config_usb_cfg_link,
+	TP_PROTO(struct gadget_info *gi),
+	TP_ARGS(gi)
+);
+
+DEFINE_EVENT(log_gadget_info, config_usb_cfg_unlink,
+	TP_PROTO(struct gadget_info *gi),
+	TP_ARGS(gi)
+);
+
+DEFINE_EVENT(log_gadget_info, gadget_config_desc_MaxPower_store,
+	TP_PROTO(struct gadget_info *gi),
+	TP_ARGS(gi)
+);
+
+DEFINE_EVENT(log_gadget_info, gadget_config_desc_bmAttributes_store,
+	TP_PROTO(struct gadget_info *gi),
+	TP_ARGS(gi)
+);
+
+#endif /* __CONFIGFS_GADGET_TRACE_H */
+
+/* this part has to be here */
+
+#undef TRACE_INCLUDE_PATH
+#define TRACE_INCLUDE_PATH ../../drivers/usb/gadget
+
+#undef TRACE_INCLUDE_FILE
+#define TRACE_INCLUDE_FILE configfs_trace
+
+#include <trace/define_trace.h>
-- 
2.7.4

Re: [PATCH v12 4/4] usb: gadget: add configfs trace events

[Greg Kroah-Hartman]

On Tue, Oct 19, 2021 at 09:26:37PM +0800, Linyu Yuan wrote:
> in case of USB Gadget functions configure through configfs from
> a complicated user space program, when switch function from one to another,
> if it failed, it is better to find out what action was done to configfs
> from user space program.
> 
> this change add some trace events which enable/disable a function,
> it including add/remove configuration, bind/unbind UDC,
> and some attribute files write operation.
> 
> Suggested-by: Felipe Balbi <balbi@kernel.org>
> Signed-off-by: Linyu Yuan <quic_linyyuan@quicinc.com>
> ---
> v2: fix two issue Reported-by: kernel test robot <lkp@intel.com>
> v3: do not move private structure to configfs.h
> v4: add missing new file configfs_trace.h
> v5: lost some change of v2, add it again
> v6: fix comments from Greg Kroah-Hartman
> v7: three minor changes according to coding rules
> v8: change two trace location
> v9: fix when config is empty
> v10: fix wrong api in v9
> v11: split to 3 changes, remove read trace, change trace event print format
> v12: allocate trace string array per gadget driver
> 
>  drivers/usb/gadget/configfs.c       |  17 ++++
>  drivers/usb/gadget/configfs_trace.h | 168 ++++++++++++++++++++++++++++++++++++
>  2 files changed, 185 insertions(+)
>  create mode 100644 drivers/usb/gadget/configfs_trace.h
> 
> diff --git a/drivers/usb/gadget/configfs.c b/drivers/usb/gadget/configfs.c
> index 27aa569..6e7d1b1 100644
> --- a/drivers/usb/gadget/configfs.c
> +++ b/drivers/usb/gadget/configfs.c
> @@ -29,6 +29,7 @@ int check_user_usb_string(const char *name,
>  
>  #define MAX_NAME_LEN	40
>  #define MAX_USB_STRING_LANGS 2
> +#define MAX_TRACE_STR_LEN	512
>  
>  static const struct usb_descriptor_header *otg_desc[2];
>  
> @@ -51,6 +52,9 @@ struct gadget_info {
>  	char qw_sign[OS_STRING_QW_SIGN_LEN];
>  	spinlock_t spinlock;
>  	bool unbind;
> +#ifdef CONFIG_TRACING
> +	char trace_string[MAX_TRACE_STR_LEN];
> +#endif
>  };
>  
>  static inline struct gadget_info *to_gadget_info(struct config_item *item)
> @@ -102,6 +106,10 @@ struct gadget_config_name {
>  	struct list_head list;
>  };
>  
> +#define CONFIGFS_TRACE_STRING
> +#define CREATE_TRACE_POINTS
> +#include "configfs_trace.h"
> +
>  #define USB_MAX_STRING_WITH_NULL_LEN	(USB_MAX_STRING_LEN+1)
>  
>  static int usb_string_copy(const char *s, char **s_copy)
> @@ -212,6 +220,7 @@ static ssize_t gadget_dev_desc_bcdDevice_store(struct config_item *item,
>  
>  	mutex_lock(&gi->lock);
>  	gi->cdev.desc.bcdDevice = cpu_to_le16(bcdDevice);
> +	trace_gadget_dev_desc_bcdDevice_store(gi);
>  	mutex_unlock(&gi->lock);
>  	return len;
>  }
> @@ -232,6 +241,7 @@ static ssize_t gadget_dev_desc_bcdUSB_store(struct config_item *item,
>  
>  	mutex_lock(&gi->lock);
>  	gi->cdev.desc.bcdUSB = cpu_to_le16(bcdUSB);
> +	trace_gadget_dev_desc_bcdUSB_store(gi);
>  	mutex_unlock(&gi->lock);
>  	return len;
>  }
> @@ -254,6 +264,7 @@ static int unregister_gadget(struct gadget_info *gi)
>  {
>  	int ret;
>  
> +	trace_unregister_gadget(gi);
>  	if (!gi->composite.gadget_driver.udc_name)
>  		return -ENODEV;
>  
> @@ -300,6 +311,7 @@ static ssize_t gadget_dev_desc_UDC_store(struct config_item *item,
>  			goto err;
>  		}
>  	}
> +	trace_gadget_dev_desc_UDC_store(gi);
>  	mutex_unlock(&gi->lock);
>  	return len;
>  err:
> @@ -342,6 +354,7 @@ static ssize_t gadget_dev_desc_max_speed_store(struct config_item *item,
>  
>  	gi->composite.gadget_driver.max_speed = gi->composite.max_speed;
>  
> +	trace_gadget_dev_desc_max_speed_store(gi);
>  	mutex_unlock(&gi->lock);
>  	return len;
>  err:
> @@ -465,6 +478,7 @@ static int config_usb_cfg_link(
>  	list_add_tail(&f->list, &cfg->func_list);
>  	ret = 0;
>  out:
> +	trace_config_usb_cfg_link(gi);
>  	mutex_unlock(&gi->lock);
>  	return ret;
>  }
> @@ -496,6 +510,7 @@ static void config_usb_cfg_unlink(
>  		if (f->fi == fi) {
>  			list_del(&f->list);
>  			usb_put_function(f);
> +			trace_config_usb_cfg_unlink(gi);
>  			mutex_unlock(&gi->lock);
>  			return;
>  		}
> @@ -533,6 +548,7 @@ static ssize_t gadget_config_desc_MaxPower_store(struct config_item *item,
>  		return -ERANGE;
>  	mutex_lock(&gi->lock);
>  	cfg->c.MaxPower = val;
> +	trace_gadget_config_desc_MaxPower_store(gi);
>  	mutex_unlock(&gi->lock);
>  	return len;
>  }
> @@ -562,6 +578,7 @@ static ssize_t gadget_config_desc_bmAttributes_store(struct config_item *item,
>  		return -EINVAL;
>  	mutex_lock(&gi->lock);
>  	cfg->c.bmAttributes = val;
> +	trace_gadget_config_desc_bmAttributes_store(gi);
>  	mutex_unlock(&gi->lock);
>  	return len;
>  }
> diff --git a/drivers/usb/gadget/configfs_trace.h b/drivers/usb/gadget/configfs_trace.h
> new file mode 100644
> index 0000000..d36c61f
> --- /dev/null
> +++ b/drivers/usb/gadget/configfs_trace.h
> @@ -0,0 +1,168 @@
> +/* SPDX-License-Identifier: GPL-2.0 */
> +/*
> + * Copyright (c) 2021 Qualcomm Innovation Center, Inc. All rights reserved.
> + */
> +
> +#ifdef CONFIGFS_TRACE_STRING
> +#undef CONFIGFS_TRACE_STRING
> +
> +#ifdef CONFIG_TRACING
> +static __maybe_unused char *configfs_trace_string(struct gadget_info *gi)
> +{
> +	struct usb_configuration *uc;
> +	struct config_usb_cfg *cfg;
> +	struct usb_function *f;
> +	size_t len = sizeof(gi->trace_string) - 1;
> +	int n = 0;
> +
> +	if (list_empty(&gi->cdev.configs)) {
> +		strcat(gi->trace_string, "empty");
> +		return gi->trace_string;
> +	}
> +
> +	list_for_each_entry(uc, &gi->cdev.configs, list) {
> +		cfg = container_of(uc, struct config_usb_cfg, c);
> +
> +		n += scnprintf(gi->trace_string + n, len - n,
> +			"{%d %02x %d ",
> +			uc->bConfigurationValue,
> +			uc->bmAttributes,
> +			uc->MaxPower);
> +
> +		list_for_each_entry(f, &cfg->func_list, list)
> +			n += scnprintf(gi->trace_string + n,
> +				len - n, "%s,", f->name);
> +
> +		list_for_each_entry(f, &cfg->c.functions, list)
> +			n += scnprintf(gi->trace_string + n,
> +				len - n, "%s,", f->name);
> +
> +		n += scnprintf(gi->trace_string + n, len - n, "};");
> +	}
> +
> +	return gi->trace_string;

I still do not see where you are locking anything to protect the walking
of these lists.

Where is that now happening?

thanks,

greg k-h

RE: [PATCH v12 4/4] usb: gadget: add configfs trace events

[Linyu Yuan (QUIC)]

> From: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Sent: Friday, October 22, 2021 5:21 PM
> To: Linyu Yuan (QUIC) <quic_linyyuan@quicinc.com>
> Cc: Felipe Balbi <balbi@kernel.org>; linux-usb@vger.kernel.org; Jack Pham
> <jackp@quicinc.com>
> Subject: Re: [PATCH v12 4/4] usb: gadget: add configfs trace events
> 
> On Tue, Oct 19, 2021 at 09:26:37PM +0800, Linyu Yuan wrote:
> > in case of USB Gadget functions configure through configfs from
> > a complicated user space program, when switch function from one to
> another,
> > if it failed, it is better to find out what action was done to configfs
> > from user space program.
> >
> > this change add some trace events which enable/disable a function,
> > it including add/remove configuration, bind/unbind UDC,
> > and some attribute files write operation.
> >
> > Suggested-by: Felipe Balbi <balbi@kernel.org>
> > Signed-off-by: Linyu Yuan <quic_linyyuan@quicinc.com>
> > ---
> > v2: fix two issue Reported-by: kernel test robot <lkp@intel.com>
> > v3: do not move private structure to configfs.h
> > v4: add missing new file configfs_trace.h
> > v5: lost some change of v2, add it again
> > v6: fix comments from Greg Kroah-Hartman
> > v7: three minor changes according to coding rules
> > v8: change two trace location
> > v9: fix when config is empty
> > v10: fix wrong api in v9
> > v11: split to 3 changes, remove read trace, change trace event print format
> > v12: allocate trace string array per gadget driver
> >
> >  drivers/usb/gadget/configfs.c       |  17 ++++
> >  drivers/usb/gadget/configfs_trace.h | 168
> ++++++++++++++++++++++++++++++++++++
> >  2 files changed, 185 insertions(+)
> >  create mode 100644 drivers/usb/gadget/configfs_trace.h
> >
> > diff --git a/drivers/usb/gadget/configfs.c b/drivers/usb/gadget/configfs.c
> > index 27aa569..6e7d1b1 100644
> > --- a/drivers/usb/gadget/configfs.c
> > +++ b/drivers/usb/gadget/configfs.c
> > @@ -29,6 +29,7 @@ int check_user_usb_string(const char *name,
> >
> >  #define MAX_NAME_LEN	40
> >  #define MAX_USB_STRING_LANGS 2
> > +#define MAX_TRACE_STR_LEN	512
> >
> >  static const struct usb_descriptor_header *otg_desc[2];
> >
> > @@ -51,6 +52,9 @@ struct gadget_info {
> >  	char qw_sign[OS_STRING_QW_SIGN_LEN];
> >  	spinlock_t spinlock;
> >  	bool unbind;
> > +#ifdef CONFIG_TRACING
> > +	char trace_string[MAX_TRACE_STR_LEN];
> > +#endif
> >  };
> >
> >  static inline struct gadget_info *to_gadget_info(struct config_item *item)
> > @@ -102,6 +106,10 @@ struct gadget_config_name {
> >  	struct list_head list;
> >  };
> >
> > +#define CONFIGFS_TRACE_STRING
> > +#define CREATE_TRACE_POINTS
> > +#include "configfs_trace.h"
> > +
> >  #define USB_MAX_STRING_WITH_NULL_LEN
> 	(USB_MAX_STRING_LEN+1)
> >
> >  static int usb_string_copy(const char *s, char **s_copy)
> > @@ -212,6 +220,7 @@ static ssize_t
> gadget_dev_desc_bcdDevice_store(struct config_item *item,
> >
> >  	mutex_lock(&gi->lock);
> >  	gi->cdev.desc.bcdDevice = cpu_to_le16(bcdDevice);
> > +	trace_gadget_dev_desc_bcdDevice_store(gi);
> >  	mutex_unlock(&gi->lock);
> >  	return len;
> >  }
> > @@ -232,6 +241,7 @@ static ssize_t
> gadget_dev_desc_bcdUSB_store(struct config_item *item,
> >
> >  	mutex_lock(&gi->lock);
> >  	gi->cdev.desc.bcdUSB = cpu_to_le16(bcdUSB);
> > +	trace_gadget_dev_desc_bcdUSB_store(gi);
> >  	mutex_unlock(&gi->lock);
> >  	return len;
> >  }
> > @@ -254,6 +264,7 @@ static int unregister_gadget(struct gadget_info *gi)
> >  {
> >  	int ret;
> >
> > +	trace_unregister_gadget(gi);
> >  	if (!gi->composite.gadget_driver.udc_name)
> >  		return -ENODEV;
> >
> > @@ -300,6 +311,7 @@ static ssize_t gadget_dev_desc_UDC_store(struct
> config_item *item,
> >  			goto err;
> >  		}
> >  	}
> > +	trace_gadget_dev_desc_UDC_store(gi);
> >  	mutex_unlock(&gi->lock);
> >  	return len;
> >  err:
> > @@ -342,6 +354,7 @@ static ssize_t
> gadget_dev_desc_max_speed_store(struct config_item *item,
> >
> >  	gi->composite.gadget_driver.max_speed = gi-
> >composite.max_speed;
> >
> > +	trace_gadget_dev_desc_max_speed_store(gi);
> >  	mutex_unlock(&gi->lock);
> >  	return len;
> >  err:
> > @@ -465,6 +478,7 @@ static int config_usb_cfg_link(
> >  	list_add_tail(&f->list, &cfg->func_list);
> >  	ret = 0;
> >  out:
> > +	trace_config_usb_cfg_link(gi);
> >  	mutex_unlock(&gi->lock);
> >  	return ret;
> >  }
> > @@ -496,6 +510,7 @@ static void config_usb_cfg_unlink(
> >  		if (f->fi == fi) {
> >  			list_del(&f->list);
> >  			usb_put_function(f);
> > +			trace_config_usb_cfg_unlink(gi);
> >  			mutex_unlock(&gi->lock);
> >  			return;
> >  		}
> > @@ -533,6 +548,7 @@ static ssize_t
> gadget_config_desc_MaxPower_store(struct config_item *item,
> >  		return -ERANGE;
> >  	mutex_lock(&gi->lock);
> >  	cfg->c.MaxPower = val;
> > +	trace_gadget_config_desc_MaxPower_store(gi);
> >  	mutex_unlock(&gi->lock);
> >  	return len;
> >  }
> > @@ -562,6 +578,7 @@ static ssize_t
> gadget_config_desc_bmAttributes_store(struct config_item *item,
> >  		return -EINVAL;
> >  	mutex_lock(&gi->lock);
> >  	cfg->c.bmAttributes = val;
> > +	trace_gadget_config_desc_bmAttributes_store(gi);
> >  	mutex_unlock(&gi->lock);
> >  	return len;
> >  }
> > diff --git a/drivers/usb/gadget/configfs_trace.h
> b/drivers/usb/gadget/configfs_trace.h
> > new file mode 100644
> > index 0000000..d36c61f
> > --- /dev/null
> > +++ b/drivers/usb/gadget/configfs_trace.h
> > @@ -0,0 +1,168 @@
> > +/* SPDX-License-Identifier: GPL-2.0 */
> > +/*
> > + * Copyright (c) 2021 Qualcomm Innovation Center, Inc. All rights reserved.
> > + */
> > +
> > +#ifdef CONFIGFS_TRACE_STRING
> > +#undef CONFIGFS_TRACE_STRING
> > +
> > +#ifdef CONFIG_TRACING
> > +static __maybe_unused char *configfs_trace_string(struct gadget_info
> *gi)
> > +{
> > +	struct usb_configuration *uc;
> > +	struct config_usb_cfg *cfg;
> > +	struct usb_function *f;
> > +	size_t len = sizeof(gi->trace_string) - 1;
> > +	int n = 0;
> > +
> > +	if (list_empty(&gi->cdev.configs)) {
> > +		strcat(gi->trace_string, "empty");
> > +		return gi->trace_string;
> > +	}
> > +
> > +	list_for_each_entry(uc, &gi->cdev.configs, list) {
> > +		cfg = container_of(uc, struct config_usb_cfg, c);
> > +
> > +		n += scnprintf(gi->trace_string + n, len - n,
> > +			"{%d %02x %d ",
> > +			uc->bConfigurationValue,
> > +			uc->bmAttributes,
> > +			uc->MaxPower);
> > +
> > +		list_for_each_entry(f, &cfg->func_list, list)
> > +			n += scnprintf(gi->trace_string + n,
> > +				len - n, "%s,", f->name);
> > +
> > +		list_for_each_entry(f, &cfg->c.functions, list)
> > +			n += scnprintf(gi->trace_string + n,
> > +				len - n, "%s,", f->name);
> > +
> > +		n += scnprintf(gi->trace_string + n, len - n, "};");
> > +	}
> > +
> > +	return gi->trace_string;
> 
> I still do not see where you are locking anything to protect the walking
> of these lists.
> 
> Where is that now happening?
With patch#3, my design is all data was protect by gi->lock mutex lock.
Now trace_string is allocated per instance, it also protected by gi->lock.
> 
> thanks,
> 
> greg k-h

Re: [PATCH v12 4/4] usb: gadget: add configfs trace events

[Greg Kroah-Hartman]

On Fri, Oct 22, 2021 at 09:43:06AM +0000, Linyu Yuan (QUIC) wrote:
> > From: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> > Sent: Friday, October 22, 2021 5:21 PM
> > To: Linyu Yuan (QUIC) <quic_linyyuan@quicinc.com>
> > Cc: Felipe Balbi <balbi@kernel.org>; linux-usb@vger.kernel.org; Jack Pham
> > <jackp@quicinc.com>
> > Subject: Re: [PATCH v12 4/4] usb: gadget: add configfs trace events
> > 
> > On Tue, Oct 19, 2021 at 09:26:37PM +0800, Linyu Yuan wrote:
> > > in case of USB Gadget functions configure through configfs from
> > > a complicated user space program, when switch function from one to
> > another,
> > > if it failed, it is better to find out what action was done to configfs
> > > from user space program.
> > >
> > > this change add some trace events which enable/disable a function,
> > > it including add/remove configuration, bind/unbind UDC,
> > > and some attribute files write operation.
> > >
> > > Suggested-by: Felipe Balbi <balbi@kernel.org>
> > > Signed-off-by: Linyu Yuan <quic_linyyuan@quicinc.com>
> > > ---
> > > v2: fix two issue Reported-by: kernel test robot <lkp@intel.com>
> > > v3: do not move private structure to configfs.h
> > > v4: add missing new file configfs_trace.h
> > > v5: lost some change of v2, add it again
> > > v6: fix comments from Greg Kroah-Hartman
> > > v7: three minor changes according to coding rules
> > > v8: change two trace location
> > > v9: fix when config is empty
> > > v10: fix wrong api in v9
> > > v11: split to 3 changes, remove read trace, change trace event print format
> > > v12: allocate trace string array per gadget driver
> > >
> > >  drivers/usb/gadget/configfs.c       |  17 ++++
> > >  drivers/usb/gadget/configfs_trace.h | 168
> > ++++++++++++++++++++++++++++++++++++
> > >  2 files changed, 185 insertions(+)
> > >  create mode 100644 drivers/usb/gadget/configfs_trace.h
> > >
> > > diff --git a/drivers/usb/gadget/configfs.c b/drivers/usb/gadget/configfs.c
> > > index 27aa569..6e7d1b1 100644
> > > --- a/drivers/usb/gadget/configfs.c
> > > +++ b/drivers/usb/gadget/configfs.c
> > > @@ -29,6 +29,7 @@ int check_user_usb_string(const char *name,
> > >
> > >  #define MAX_NAME_LEN	40
> > >  #define MAX_USB_STRING_LANGS 2
> > > +#define MAX_TRACE_STR_LEN	512
> > >
> > >  static const struct usb_descriptor_header *otg_desc[2];
> > >
> > > @@ -51,6 +52,9 @@ struct gadget_info {
> > >  	char qw_sign[OS_STRING_QW_SIGN_LEN];
> > >  	spinlock_t spinlock;
> > >  	bool unbind;
> > > +#ifdef CONFIG_TRACING
> > > +	char trace_string[MAX_TRACE_STR_LEN];
> > > +#endif
> > >  };
> > >
> > >  static inline struct gadget_info *to_gadget_info(struct config_item *item)
> > > @@ -102,6 +106,10 @@ struct gadget_config_name {
> > >  	struct list_head list;
> > >  };
> > >
> > > +#define CONFIGFS_TRACE_STRING
> > > +#define CREATE_TRACE_POINTS
> > > +#include "configfs_trace.h"
> > > +
> > >  #define USB_MAX_STRING_WITH_NULL_LEN
> > 	(USB_MAX_STRING_LEN+1)
> > >
> > >  static int usb_string_copy(const char *s, char **s_copy)
> > > @@ -212,6 +220,7 @@ static ssize_t
> > gadget_dev_desc_bcdDevice_store(struct config_item *item,
> > >
> > >  	mutex_lock(&gi->lock);
> > >  	gi->cdev.desc.bcdDevice = cpu_to_le16(bcdDevice);
> > > +	trace_gadget_dev_desc_bcdDevice_store(gi);
> > >  	mutex_unlock(&gi->lock);
> > >  	return len;
> > >  }
> > > @@ -232,6 +241,7 @@ static ssize_t
> > gadget_dev_desc_bcdUSB_store(struct config_item *item,
> > >
> > >  	mutex_lock(&gi->lock);
> > >  	gi->cdev.desc.bcdUSB = cpu_to_le16(bcdUSB);
> > > +	trace_gadget_dev_desc_bcdUSB_store(gi);
> > >  	mutex_unlock(&gi->lock);
> > >  	return len;
> > >  }
> > > @@ -254,6 +264,7 @@ static int unregister_gadget(struct gadget_info *gi)
> > >  {
> > >  	int ret;
> > >
> > > +	trace_unregister_gadget(gi);
> > >  	if (!gi->composite.gadget_driver.udc_name)
> > >  		return -ENODEV;
> > >
> > > @@ -300,6 +311,7 @@ static ssize_t gadget_dev_desc_UDC_store(struct
> > config_item *item,
> > >  			goto err;
> > >  		}
> > >  	}
> > > +	trace_gadget_dev_desc_UDC_store(gi);
> > >  	mutex_unlock(&gi->lock);
> > >  	return len;
> > >  err:
> > > @@ -342,6 +354,7 @@ static ssize_t
> > gadget_dev_desc_max_speed_store(struct config_item *item,
> > >
> > >  	gi->composite.gadget_driver.max_speed = gi-
> > >composite.max_speed;
> > >
> > > +	trace_gadget_dev_desc_max_speed_store(gi);
> > >  	mutex_unlock(&gi->lock);
> > >  	return len;
> > >  err:
> > > @@ -465,6 +478,7 @@ static int config_usb_cfg_link(
> > >  	list_add_tail(&f->list, &cfg->func_list);
> > >  	ret = 0;
> > >  out:
> > > +	trace_config_usb_cfg_link(gi);
> > >  	mutex_unlock(&gi->lock);
> > >  	return ret;
> > >  }
> > > @@ -496,6 +510,7 @@ static void config_usb_cfg_unlink(
> > >  		if (f->fi == fi) {
> > >  			list_del(&f->list);
> > >  			usb_put_function(f);
> > > +			trace_config_usb_cfg_unlink(gi);
> > >  			mutex_unlock(&gi->lock);
> > >  			return;
> > >  		}
> > > @@ -533,6 +548,7 @@ static ssize_t
> > gadget_config_desc_MaxPower_store(struct config_item *item,
> > >  		return -ERANGE;
> > >  	mutex_lock(&gi->lock);
> > >  	cfg->c.MaxPower = val;
> > > +	trace_gadget_config_desc_MaxPower_store(gi);
> > >  	mutex_unlock(&gi->lock);
> > >  	return len;
> > >  }
> > > @@ -562,6 +578,7 @@ static ssize_t
> > gadget_config_desc_bmAttributes_store(struct config_item *item,
> > >  		return -EINVAL;
> > >  	mutex_lock(&gi->lock);
> > >  	cfg->c.bmAttributes = val;
> > > +	trace_gadget_config_desc_bmAttributes_store(gi);
> > >  	mutex_unlock(&gi->lock);
> > >  	return len;
> > >  }
> > > diff --git a/drivers/usb/gadget/configfs_trace.h
> > b/drivers/usb/gadget/configfs_trace.h
> > > new file mode 100644
> > > index 0000000..d36c61f
> > > --- /dev/null
> > > +++ b/drivers/usb/gadget/configfs_trace.h
> > > @@ -0,0 +1,168 @@
> > > +/* SPDX-License-Identifier: GPL-2.0 */
> > > +/*
> > > + * Copyright (c) 2021 Qualcomm Innovation Center, Inc. All rights reserved.
> > > + */
> > > +
> > > +#ifdef CONFIGFS_TRACE_STRING
> > > +#undef CONFIGFS_TRACE_STRING
> > > +
> > > +#ifdef CONFIG_TRACING
> > > +static __maybe_unused char *configfs_trace_string(struct gadget_info
> > *gi)
> > > +{
> > > +	struct usb_configuration *uc;
> > > +	struct config_usb_cfg *cfg;
> > > +	struct usb_function *f;
> > > +	size_t len = sizeof(gi->trace_string) - 1;
> > > +	int n = 0;
> > > +
> > > +	if (list_empty(&gi->cdev.configs)) {
> > > +		strcat(gi->trace_string, "empty");
> > > +		return gi->trace_string;
> > > +	}
> > > +
> > > +	list_for_each_entry(uc, &gi->cdev.configs, list) {
> > > +		cfg = container_of(uc, struct config_usb_cfg, c);
> > > +
> > > +		n += scnprintf(gi->trace_string + n, len - n,
> > > +			"{%d %02x %d ",
> > > +			uc->bConfigurationValue,
> > > +			uc->bmAttributes,
> > > +			uc->MaxPower);
> > > +
> > > +		list_for_each_entry(f, &cfg->func_list, list)
> > > +			n += scnprintf(gi->trace_string + n,
> > > +				len - n, "%s,", f->name);
> > > +
> > > +		list_for_each_entry(f, &cfg->c.functions, list)
> > > +			n += scnprintf(gi->trace_string + n,
> > > +				len - n, "%s,", f->name);
> > > +
> > > +		n += scnprintf(gi->trace_string + n, len - n, "};");
> > > +	}
> > > +
> > > +	return gi->trace_string;
> > 
> > I still do not see where you are locking anything to protect the walking
> > of these lists.
> > 
> > Where is that now happening?
> With patch#3, my design is all data was protect by gi->lock mutex lock.
> Now trace_string is allocated per instance, it also protected by gi->lock.

That is not obvious at all.  Especially as it looked like you did not
protect any list with the patch 3, only attribute values.

Please document this much better at the very least.

Also note that the trace string being per-instance does not change the
locking issues involved here at all.

thanks,

greg k-h

Re: [PATCH v12 0/4] usb: gadget: configfs: add some trace event

[Greg Kroah-Hartman]

On Tue, Oct 19, 2021 at 09:26:33PM +0800, Linyu Yuan wrote:
> this series make some minor change to gadget configfs and
> add some important trace event from configfs layer.
> 
> follow suggestion from Felipe Balbi in link below,
> https://lore.kernel.org/linux-usb/1629777281-30188-1-git-send-email-quic_linyyuan@quicinc.com/

I've applied the first 2 patches here, as they are nice "cleanup"
changes.  But I had a problem with patch 3, and I need others to help
review patch 4 so I can not take them at this point in time yet.  Feel
free to rebase the remaining patches on my tree so you no longer have to
send the first 2 anymore.

thanks,

greg k-h