Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <56581822-eb30-2e1b-169e-2bdee6f961f3@amperemail.onmicrosoft.com>
Date:   Thu, 15 Dec 2022 16:08:06 +0700
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:102.0)
 Gecko/20100101 Thunderbird/102.5.1
Subject: Re: [EXT] Re: [PATCH] USB: gadget: Add ID numbers to configfs-gadget
 driver names
Content-Language: en-US
To:     Frank Li <frank.li@nxp.com>,
        Christophe JAILLET <christophe.jaillet@wanadoo.fr>,
        Chanh Nguyen <chanh@os.amperecomputing.com>
Cc:     OpenBMC Maillist <openbmc@lists.ozlabs.org>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Dan Vacura <w36195@motorola.com>,
        Jakob Koschel <jakobkoschel@gmail.com>,
        Alan Stern <stern@rowland.harvard.edu>,
        Vijayavardhan Vennapusa <vvreddy@codeaurora.org>,
        "linux-usb@vger.kernel.org" <linux-usb@vger.kernel.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        Open Source Submission <patches@amperecomputing.com>,
        Rondreis <linhaoguo86@gmail.com>
References: <20221213041203.21080-1-chanh@os.amperecomputing.com>
 <720b814d-5102-04d3-4938-33a25e87a46d@wanadoo.fr>
 <6044a542-fbcd-0fe7-abd3-83f38b731ecc@amperemail.onmicrosoft.com>
 <HE1PR0401MB23315376796AF65DEB8B636B88E09@HE1PR0401MB2331.eurprd04.prod.outlook.com>
From:   Chanh Nguyen <chanh@amperemail.onmicrosoft.com>
In-Reply-To: <HE1PR0401MB23315376796AF65DEB8B636B88E09@HE1PR0401MB2331.eurprd04.prod.outlook.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?c0VRSVNMdzhDRW9jSmwvTEdLa2Jmem9BNkJwR05VQzRPTFdWN0JudEZBWmFj?=
 =?utf-8?B?VWJyTEQ3WHF5RjZJQVBuci9GVlFnc1BDYnBLM3paclcrTzdhZUNheUdCREJm?=
 =?utf-8?B?RytnczVqMlprckp2R0t6Wm0wQmZkMU5rdDB4TldzYlNvVW9Ea0JBU2Q4YStM?=
 =?utf-8?B?TWNtYkFiN2J3YU1wSGZXMnpjSkhhRnlvczNTOStHWWNPQm5PWExKTHlDTE1F?=
 =?utf-8?B?VFZCQjVHRk9VdEFZbVc1d0JqaUlzd0NhaWtzOTBBRWVKVGJJUzhlbWprUlJB?=
 =?utf-8?B?L21IT3FPY3F1a2VEb2d0bzRWd0c4d1JSOEd3MUZwNVRibmZ3aW9jQmVGUkJs?=
 =?utf-8?B?S1dzMjRkeEUyRHBOMmFqYzlRMFlLbmxMUFlBTVkyNVg5T2NSdjExbDhtZ05E?=
 =?utf-8?B?WUMydUE5UXF2aWxyWGdKTENqd0RhWlJzZzJSZSthVi9mUTNySGFXRlN1OUpr?=
 =?utf-8?B?Wm5BMkx4Z2VxbVo5NDNWOHo0RGFoZmxuZCtZU3RwZ2M5ZzFjZFVMUmNWZUI1?=
 =?utf-8?B?UHZsSldRQ1pvNSsrZ2NUazJDMmdUT0cxOFBHUzRxb05NcUwyd2tqdXE2RVBn?=
 =?utf-8?B?a2VmREV2OWxlaTdtUkxlVlE4TjJZMkJtajNCRHZlam5tRDFOcElLQkw0N3dv?=
 =?utf-8?B?bm5vdXFVLzd5Vk9sZk05K203cjkrN05xaEo3UTVTZHE1YVZUT2kyK2o4SldE?=
 =?utf-8?B?U0QxOE9ybDNwb2lyQktrU2c5bFlrbk5nY3k3ZHFCUzdkSUNTN2JLZ1dHRU90?=
 =?utf-8?B?eWFDbmlkWE9kb1JKYmhCWWVJUzJqZ3JKN3FUK1pIc0RQdzZNQ2diOGZxVytJ?=
 =?utf-8?B?dzVFbHRzeDJYUkF1K29BQVJ0RnBVZU1mcWR3bTNnU3BZSzAvaWJxUGwrQ0Nj?=
 =?utf-8?B?ek83b2kwcUVJV2JzdDJIWkpFa1orNGU4Nk85a0d4T3N1UlJQd2hkUjVYM1k4?=
 =?utf-8?B?TnpDeDFuQmMvUEZzdDdQM3g5enpOeSs2aVA4R0FISEZLbnMwV3MyWXFMaEhN?=
 =?utf-8?B?VlN5OHdEVURCWEcrd3gvTS9GSXBHT2JObThRT0tYSURTb1poSUtnWmpkRFpm?=
 =?utf-8?B?NTYyUFB1MWZBelh4dlZXTWZSMXJMNHphNHdIWW9mcDhDNVdJSzRiRW5uYlZO?=
 =?utf-8?B?YUZpd2llQjFEL1dnUytic0RzV1dMbjFGVkllemlRa0wrRGlqZ1JOUFpOODVS?=
 =?utf-8?B?Q1A3dWZ4ckRlZnVpV3hmQXRLRmZQSUNLYW5LekhpZGgxenFjSnhicDVha0ND?=
 =?utf-8?B?YzEwV2xiWDhBN3cvWkRPazN0QXRpY2RDZzgyWk55bDZVYU1hdHlkUklxbVJZ?=
 =?utf-8?B?dno2WVd0dDRlNStNSHZ0YStuT3N2ZlR6NHVzby9QUDVSejZDQmdBY280aGhz?=
 =?utf-8?B?SjJ2MUJrNnhla3pFZUVKUytCNFlTUHRGbmh2cWJwazFIbG9sbzJlUDRzYTda?=
 =?utf-8?B?Z3BNUXUyVHRlQUtud3BEcnpyU2lNcWw5czR3R2hDaUxkUU81a09Bd1RyMERo?=
 =?utf-8?B?U3c3NUlLL1RSb214R0ovZ0NrdXlnamhjZ1BsUHRsUCtNaEhndEszb09kRFBJ?=
 =?utf-8?B?VkJaSUFGR21LTlg4WERBbk9zVkYzNU5SUUpSM2U1UXBvN3ZKVWhJdkV1V1pr?=
 =?utf-8?B?dG9WNnlFNHlBNWM3SkdGQmluZktaZ3hZUE5PUmY0cFlNVTZ0MFJHSjU0RnFK?=
 =?utf-8?B?VjZFeGl0L21HeWo4UWpXTEFuOEM2WkxvalJmVnFncTdQNkw4YXF0WU94bjVu?=
 =?utf-8?B?WkVBOHNtaDR0VEUyYVJydUk2Sm1ONnEvVjBpUWNOTG5ldjlTZ2RoMzV0NnUx?=
 =?utf-8?B?VlRlR21FSW9wbFdtdkRiRXUrbGh0K28yTjR1Zkc3QmhiRTcrcVp5ZlVEaVNj?=
 =?utf-8?B?MlQrZk5rNFpINmp5OGtjMWpTUUpINERvVFhpRGZrZHV0R3BMV0EzeWozS1NB?=
 =?utf-8?B?b1ZWTXlyUmNyY0pFQkUrakorcFluSFcwcCtheXlveUdNRko3aDFuRUEwVHpV?=
 =?utf-8?B?U3JhZ2wxUVlXeTVNcVRtZ1V1OHNUNThXbDhHVGFVL0NqampzY1hYWjdDREti?=
 =?utf-8?B?MDEweklUeGFWZHFiNXBWZm0vNmdhcnZuQUJqQis3R1NWY3p4bEsyR0NGVFhs?=
 =?utf-8?B?dWwvS0VWSmVDTVdYUmFRR0hYeVlTdkRSRlFQbERIeGFoY3dWeGZKRWsxN2Zj?=
 =?utf-8?Q?o4F+D92bZ/ji5rSsCIksemQ=3D?=
X-OriginatorOrg: amperemail.onmicrosoft.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 90ba0db1-acdd-4520-8a6b-08dade7be680
X-MS-Exchange-CrossTenant-AuthSource: SN6PR01MB4973.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Dec 2022 09:08:15.9623
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3bc2b170-fd94-476d-b0ce-4229bdc904a7
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: ryVpt9roDez3g9hqFEnjy6aweXXZWpiVPEK3FAw+vstu1aTovccMnGo3HY/faI4BUV7R1eBUvqQl3gzFX8SU8LluNi+LmrQpxpiJhHRWmWDbvv/RPCYuOUUyS6bZepVD
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR01MB5375
X-Spam-Status: No, score=-1.5 required=5.0 tests=BAYES_00,DKIM_INVALID,
        DKIM_SIGNED,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM,
        HEADER_FROM_DIFFERENT_DOMAINS,NICE_REPLY_A,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS autolearn=no
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org


On 14/12/2022 11:20, Frank Li wrote:
>>
>> Caution: EXT Email
>>
>> On 13/12/2022 14:22, Christophe JAILLET wrote:
>>> Le 13/12/2022 à 05:12, Chanh Nguyen a écrit :
>>>> It is unable to use configfs to attach more than one gadget. When
>>>> attaching the second gadget, it always fails and the kernel message
>>>> prints out:
>>>>
>>>> Error: Driver 'configfs-gadget' is already registered, aborting...
>>>> UDC core: g1: driver registration failed: -16
>>>>
>>>> This commit fixes the problem by a ".N" suffix added to each
>>>> configfs_gadget's driver name (where N is a unique ID number),
>>>> thus making the names distinct.
>>>>
>>>> Fixes: fc274c1e9973 ("USB: gadget: Add a new bus for gadgets")
>>>> Signed-off-by: Chanh Nguyen
>>>> <chanh-shex6MNQR2J/SfDzf78azzKzEDxYleXD@public.gmane.org>
>>>> ---
>>>>    drivers/usb/gadget/configfs.c | 42
>> +++++++++++++++++++++++++++++++++++
>>>>    1 file changed, 42 insertions(+)
>>>>
>>>> diff --git a/drivers/usb/gadget/configfs.c
>>>> b/drivers/usb/gadget/configfs.c
>>>> index 96121d1c8df4..d8c5156ad777 100644
>>>> --- a/drivers/usb/gadget/configfs.c
>>>> +++ b/drivers/usb/gadget/configfs.c
>>>> @@ -3,6 +3,7 @@
>>>>    #include <linux/module.h>
>>>>    #include <linux/slab.h>
>>>>    #include <linux/device.h>
>>>> +#include <linux/idr.h>
>>>>    #include <linux/kstrtox.h>
>>>>    #include <linux/nls.h>
>>>>    #include <linux/usb/composite.h>
>>>> @@ -11,6 +12,16 @@
>>>>    #include "u_f.h"
>>>>    #include "u_os_desc.h"
>>>> +static DEFINE_IDA(driver_id_numbers);
>>>> +
>>>> +/*
>>>> + * Driver name has the form of "configfs-gadget.%d", where %d
>>>> + * is id allocated by ida_alloc(). The max value returns by
>>>> + * ida_alloc() is INT_MAX, in 64-bit system, it is about nine
>>>> + * quintillion: 19 digits in decimal. Set the max length to 35.
>>>> + */
>>>> +#define DRIVER_NAME_LENGTH_MAX 35
>>>
>>> Hi,
>>>
>>> if paranoiac, the final \0 seems to be missing in the max length
>>> computation, but see below.
>>
>> Thanks CJ! Indeed, I have missed that.
>>
>>>
>>>> +
>>>>    int check_user_usb_string(const char *name,
>>>>            struct usb_gadget_strings *stringtab_dev)
>>>>    {
>>>> @@ -52,6 +63,9 @@ struct gadget_info {
>>>>        char qw_sign[OS_STRING_QW_SIGN_LEN];
>>>>        spinlock_t spinlock;
>>>>        bool unbind;
>>>> +
>>>> +    /* Make driver names unique */
>>>> +    int driver_id_number;
>>>>    };
>>>>    static inline struct gadget_info *to_gadget_info(struct config_item
>>>> *item)
>>>> @@ -1582,6 +1596,8 @@ static struct config_group *gadgets_make(
>>>>            const char *name)
>>>>    {
>>>>        struct gadget_info *gi;
>>>> +    char *driver_name;
>>>> +    int ret;
>>>>        gi = kzalloc(sizeof(*gi), GFP_KERNEL);
>>>>        if (!gi)
>>>> @@ -1623,6 +1639,21 @@ static struct config_group *gadgets_make(
>>>>        gi->composite.gadget_driver = configfs_driver_template;
>>>> +    ret = ida_alloc(&driver_id_numbers, GFP_KERNEL);
>>>> +    if (ret < 0)
>>>> +        goto err;
>>>> +    gi->driver_id_number = ret;
>>>> +
>>>> +    driver_name = kmalloc(DRIVER_NAME_LENGTH_MAX, GFP_KERNEL);
>>>> +    if (!driver_name)
>>>> +        goto out_free_driver_id_number;
>>>> +
>>>> +    ret = scnprintf(driver_name, DRIVER_NAME_LENGTH_MAX,
>>>> +            "configfs-gadget.%d", gi->driver_id_number);
>>>
>>>
>>> using kasprintf() looks simpler here.
>>> No need to kmalloc()+scnprintf(), and no need for
>> DRIVER_NAME_LENGTH_MAX.
>>>
>>> Just my 2c,
>>>
>>> CJ
>>
>> Thanks CJ for the review!
>>
>> I've made some changes as below (in gadgets_make() to remove
>> unnecessary
>> variables) and now trying to test it as much as possible. Will re-post
>> it as v2 if looks good soon.
>>
>> static inline struct gadget_info *to_gadget_info(struct config_item *item)
>> @@ -1623,13 +1629,25 @@ static struct config_group *gadgets_make(
>>
>>        gi->composite.gadget_driver = configfs_driver_template;
>>
>> +    gi->driver_id_number = ida_alloc(&driver_id_numbers, GFP_KERNEL);
>> +    if (gi->driver_id_number < 0)
>> +        goto err;
>> +
>> +    gi->composite.gadget_driver.driver.name =
>> +                          kasprintf(GFP_KERNEL, "configfs-gadget.%d",
>> +                                    gi->driver_id_number);
>> +    if (!gi->composite.gadget_driver.driver.name)
>> +        goto out_free_driver_id_number;
>> +
>>        gi->composite.gadget_driver.function = kstrdup(name, GFP_KERNEL);
>>        gi->composite.name = gi->composite.gadget_driver.function;
>>
>>        if (!gi->composite.gadget_driver.function)
>> -        goto err;
>> +        goto out_free_driver_id_number;
>>
>>        return &gi->group;
>> +
>> +out_free_driver_id_number:
>> +    ida_free(&driver_id_numbers, gi->driver_id_number);
>>    err:
>>        kfree(gi);
>>        return ERR_PTR(-ENOMEM);
>>
>>
>>>
>>>> +    if (ret < 0)
>>>> +        goto out_free_driver_name;
>>>> +
>>>> +    gi->composite.gadget_driver.driver.name = driver_name;
>>>>        gi->composite.gadget_driver.function = kstrdup(name, GFP_KERNEL);
>>>>        gi->composite.name = gi->composite.gadget_driver.function;
>>>> @@ -1630,6 +1661,11 @@ static struct config_group *gadgets_make(
>>>>            goto err;
>>>>        return &gi->group;
>>>> +
>>>> +out_free_driver_name:
>>>> +    kfree(driver_name);
>>>> +out_free_driver_id_number:
>>>> +    ida_free(&driver_id_numbers, gi->driver_id_number);
>>>>    err:
>>>>        kfree(gi);
>>>>        return ERR_PTR(-ENOMEM);
>>>> @@ -1637,6 +1673,12 @@ static struct config_group *gadgets_make(
>>>>    static void gadgets_drop(struct config_group *group, struct
>>>> config_item *item)
>>>>    {
>>>> +    struct gadget_info *gi = to_gadget_info(item);
>>>> +
>>>> +    mutex_lock(&gi->lock);
>>>> +    kfree(gi->composite.gadget_driver.driver.name);
>>>> +    ida_free(&driver_id_numbers, gi->driver_id_number);
>>>> +    mutex_unlock(&gi->lock);
> 
> Move all free into gadget_info_attr_release(), just before kfree(gi)
> Driver.name and gi create at the same place,
> Free should be the same place also.
> 

Thanks a lot for the quick review comment.

As per my observation through the test, on the first mount, the 
virtual-media the gadgets_make() is called, then later, when unmount, 
the gadgets_drop() is called and followed by gadget_info_attr_release().

The gadget_info_attr_release() is registered as .release() of 
gadget_root_type for the gi->group via the call 
"config_group_init_type_name(&gi->group, name, &gadget_root_type);"

In general, the .release() will be called only for the group. There is 
nothing to guarantee that the group will always be registered, ie: 
incase without the call to "config_group_init_type_name(&gi->group, 
name, &gadget_root_type);"

In this patch, what is added is an ida number to be used to make up the 
composite driver name. This is done in gadgets_make() so we'd like to 
add the cleanup code to gadgets_drop() as they are registered together 
in the same place and would be a little easier to read than adding them 
to _release() as the code below:

     static struct configfs_group_operations gadgets_ops = {
         .make_group = &gadgets_make,
         .drop_item = &gadgets_drop,
     };

Anyway, we still doubt that there might be something that we have missed 
so please let me know the reason why putting cleanup codes to _release() 
would be a better solution.

Thank you and best regards,
- Chanh

> 
>>>>        config_item_put(item);
>>>>    }
>>>