HID: leave dev_rdesc unmodified and use it for comparisons
PATCH v2 1/1 HID: leave dev_rdesc unmodified and use it for comparisons
The dev_rdesc member of the hid_device structure is meant to store the original report descriptor received from the device, but it is currently passed to any report_fixup method before it is copied to the rdesc member. This patch moves the kmemdup to before, not after, the report_fixup call, keeping dev_rdesc unchanged.
usbhid's hid_post_reset checks the report descriptor currently returned by the device against a descriptor that may have been modified by a driver's report_fixup method. That leaves some devices nonfunctional after a resume, with a "reset_resume error 1" reported. This patch checks the new descriptor against the unmodified dev_rdesc instead.
---
drivers/hid/hid-core.c +5 -3
@@ -775,12 +775,14 @@ int hid_open_report(struct hid_device *dreturn -ENODEV ; size = device->dev_rsize; + start =kmemdup (start, size,GFP_KERNEL ); +if (start ==NULL ) +return -ENOMEM ; +if (device->driver->report_fixup) start = device->driver->report_fixup (device, start, &size); - device->rdesc =kmemdup (start, size,GFP_KERNEL ); -if (device->rdesc ==NULL ) -return -ENOMEM ; + device->rdesc = start; device->rsize = size; parser =vzalloc (sizeof (struct hid_parser ));
drivers/hid/usbhid/hid-core.c +1 -1
@@ -1436,7 +1436,7 @@ static int hid_post_reset(struct usb_intkfree (rdesc);return 1 ; } - status =memcmp (rdesc, hid->rdesc, hid->rsize); + status =memcmp (rdesc, hid->dev_rdesc, hid->rsize);kfree (rdesc);if (status !=0 ) {dbg_hid ("report descriptor changed\n" );
Quoted 8 lines · Kevin Daughtridge
drivers/hid/hid-core.c +2
-0@@ -775,12 +775,14 @@ int hid_open_report(struct hid_device *dreturn -ENODEV ; size = device->dev_rsize; + start =kmemdup (start, size,GFP_KERNEL ); +if (start ==NULL )
drivers/hid/hid-core.c int hid_open_report(struct hid_device *d · line 786
Quoted 10 lines
drivers/hid/hid-core.c +3
-3+return -ENOMEM ; +if (device->driver->report_fixup) start = device->driver->report_fixup (device, start, &size); - device->rdesc =kmemdup (start, size,GFP_KERNEL ); -if (device->rdesc ==NULL ) -return -ENOMEM ; + device->rdesc = start; device->rsize = size;
AFAICS this is incorrect. Some drivers return pointers to their own static structure from their .report_fixup. Hence there are two problems:
* leak, because kmemdup'ped start is never freed
* invalid free -- kfree(device->rdesc) will try to free a static structure
regards,
Signature · 2 lines
js suse labs
Quoted 3 lines · Jiri Slaby
AFAICS this is incorrect. Some drivers return pointers to their own static structure from their .report_fixup. Hence there are two problems:
* leak, because kmemdup'ped start is never freed
* invalid free --kfree(device->rdesc)will try to free a static structure regards,
Quoted 1 line · Jiri Kosina
How do you avoid memory leak on 'start' here?
Hmm. I hadn't noticed that the other drivers are returning a static structure. In that case, it seems that report_fixup itself is broken from a memory perspective, in that it returns pointers to inconsistent storage types depending on the driver. (As evidenced by how my first patch version would have also caused invalid frees that weren't evident from the declaration in hid.h.) I see two options:
1. Ugly workaround: make a temporary copy of the dev_rdesc, give it to report_fixup, make a copy of the return, store that copy in rdesc, free the temporary copy. Though ugly, this would at least involve the smallest diff.
2. Standardize the behavior of the drivers' report_fixup implementations. Given that some of them need to change the size of the descriptor, modifying the passed structure is not an option. Probably all of them should return a newly allocated structure, either a modified copy of the input or a copy of their static, that can then be stored directly in rdesc. Especially since report_fixup is only ever called right before a copy is going to be taken anyway. (Adding constness to a parameter isn't considered a severe ABI break, is it?)
Thoughts?
-Kevin
Hi Kevin,
Thanks for looking to this.
Quoted 4 lines
Hmm. I hadn't noticed that the other drivers are returning a static structure. In that case, it seems that
report_fixupitself is broken from a memory perspective, in that it returns pointers to inconsistent storage types depending on the driver.
The driver can either modify the existing buffer, of return a pointer to a buffer managed by the driver. The former requires a kmemdup before, the latter a kmemdup after.
Quoted 4 lines
1. Ugly workaround: make a temporary copy of the
dev_rdesc, give it toreport_fixup, make a copy of the return, store that copy in rdesc, free the temporary copy. Though ugly, this would at least involve the smallest diff.
Yes, it is correct and ugly, in no particular order.
Quoted 7 lines
2. Standardize the behavior of the drivers'
report_fixupimplementations. Given that some of them need to change the size of the descriptor, modifying the passed structure is not an option. Probably all of them should return a newly allocated structure, either a modified copy of the input or a copy of their static, that can then be stored directly in rdesc. Especially sincereport_fixupis only ever called right before a copy is going to be taken anyway.
Relying on the returned pointer to be properly alloc'd is not a good idea, in particular since it changes semantics rather drastically.
Since the current function performs two different things, perhaps there should be two different functions instead.
Quoted 2 lines
(Adding constness to a parameter isn't considered a severe ABI break, is it?)
Inside the kernel there is no ABI. Go wild.
Thanks,
Henrik
Hello.
Quoted 6 lines · Kevin Daughtridge
The
dev_rdescmember of thehid_devicestructure is meant to store the original report descriptor received from the device, but it is currently passed to anyreport_fixupmethod before it is copied to the rdesc member. This patch moves the kmemdup to before, not after, thereport_fixupcall, keepingdev_rdescunchanged.
Quoted 8 lines
usbhid's
hid_post_resetchecks the report descriptor currently returned by the device against a descriptor that may have been modified by a driver'sreport_fixupmethod. That leaves some devices nonfunctional after a resume, with a "reset_resumeerror 1" reported. This patch checks the new descriptor against the unmodifieddev_rdescinstead.Signed-off-by Kevin Daughtridge<[email protected]>
Need space before the email. I've checked your original mail, it's not my
Thunderbird this time (which does this kind of damage while quoting).
Quoted 11 lines
---
drivers/hid/hid-core.c +4
-0@@ -775,12 +775,14 @@ int hid_open_report(struct hid_device *dreturn -ENODEV ; size = device->dev_rsize; + start =kmemdup (start, size,GFP_KERNEL ); +if (start ==NULL ) +return -ENOMEM ; +
drivers/hid/hid-core.c int hid_open_report(struct hid_device *d · line 788
Quoted 10 lines
drivers/hid/hid-core.c +1
-3if (device->driver->report_fixup) start = device->driver->report_fixup (device, start, &size); - device->rdesc =kmemdup (start, size,GFP_KERNEL ); -if (device->rdesc ==NULL ) -return -ENOMEM ; + device->rdesc = start; device->rsize = size; parser =vzalloc (sizeof (struct hid_parser ));
It still seems like the patch is whitespace damaged, but in another way:
to every line satrting with space, another spece was added.
WBR, Sergei
Quoted 15 lines · Kevin Daughtridge
The
dev_rdescmember of thehid_devicestructure is meant to store the original
report descriptor received from the device, but it is currently passed to anyreport_fixupmethod before it is copied to the rdesc member. This patch moves the kmemdup to before, not after, thereport_fixupcall, keepingdev_rdescunchanged.usbhid's
hid_post_resetchecks the report descriptor currently returned by the device against a descriptor that may have been modified by a driver'sreport_fixupmethod. That leaves some devices nonfunctional after a resume, with
a "reset_resumeerror 1" reported. This patch checks the new descriptor against
the unmodifieddev_rdescinstead.
Quoted 2 lines
Signed-off-by Kevin Daughtridge<[email protected]>
Your patch is whitespace damaged again, please fix your workload Kevin.
drivers/hid/hid-core.c int hid_open_report(struct hid_device *d · line 780
Quoted 10 lines
---
drivers/hid/hid-core.c +3
-0@@ -775,12 +775,14 @@ int hid_open_report(struct hid_device *dreturn -ENODEV ; size = device->dev_rsize; + start =kmemdup (start, size,GFP_KERNEL ); +if (start ==NULL ) +return -ENOMEM ; +
How do you avoid memory leak on 'start' here?
Signature · 2 lines
Jiri Kosina SUSE Labs