kcov: collect coverage from usbhid interrupts
Subsystems (8)
cover kcov: collect coverage from usbhid interrupts
This patchset extends kcov to allow collecting coverage from interrupts and then uses the new functionality to collect coverage from usbhid code.
What I'm not sure yet about this change is if we actually want to selectively annotate some parts of the USB stack that are executed in interrupt context, or maybe we can do this with some common approach.
For example patch #2 in this patchset annotates all functions that are passed as completion callbacks to usb_fill_*() in drivers/hid/usbhid. Maybe instead we could redefine usb_fill_*() in a way that would handle all such cases without manual annotations.
Any suggestions are welcome.
This has allowed to find at least one new HID bug [1], which was recently fixed by Alan [2].
[1] https://syzkaller.appspot.com/bug?extid=09ef48aa58261464b621
[2] https://patchwork.kernel.org/patch/11283319/
This patchset has been pushed to the public Linux kernel Gerrit instance:
https://linux-review.googlesource.com/c/linux/kernel/git/torvalds/linux/+/2225
Andrey Konovalov (2):
kcov: collect coverage from interrupts
HID: usbhid: kcov: add annotations for coverage collection
Documentation/dev-tools/kcov.rst | 16 +-- drivers/hid/usbhid/hid-core.c | 25 +++- drivers/hid/usbhid/usbkbd.c | 15 ++- drivers/hid/usbhid/usbmouse.c | 7 +- drivers/usb/gadget/udc/dummy_hcd.c | 1 + include/linux/sched.h | 3 + kernel/kcov.c | 196 +++++++++++++++++++---------- lib/Kconfig.debug | 9 ++ 8 files changed, 192 insertions(+), 80 deletions(-)
Signature · 1 line
2.24.1.735.g03f4e72817-goog
RFC PATCH 1/2 kcov: collect coverage from interrupts
This change extends kcov remote coverage support to allow collecting coverage from interrupts in addition to kernel background threads.
To collect coverage from code that is executed in interrupt context, a part of that code has to be annotated with kcov_remote_start/stop() in a similar way as how it is done for global kernel background threads. Then the handle used for the annotations has to be passed to the KCOV_REMOTE_ENABLE ioctl.
Internally this patch adjusts the __sanitizer_cov_trace_pc() compiler inserted callback to not bail out when called from interrupt context. kcov_remote_start/stop() are updated to save/restore the current per task kcov state in a per-cpu area (in case the interrupt came when the kernel was already collecting coverage in task context). Coverage from interrupts is collected into pre-allocated per-cpu areas, whose size is controlled by the new CONFIG_KCOV_IRQ_AREA_SIZE.
This patch also cleans up some of kcov debug messages.
--- Documentation/dev-tools/kcov.rst | 16 +-- drivers/usb/gadget/udc/dummy_hcd.c | 1 + include/linux/sched.h | 3 + kernel/kcov.c | 196 +++++++++++++++++++---------- lib/Kconfig.debug | 9 ++ 5 files changed, 154 insertions(+), 71 deletions(-)
Documentation/dev-tools/kcov.rst +8 -8
@@ -217,14 +217,14 @@ This allows to collect coverage from two types of kernel background threads: the global ones, that are spawned during kernel boot in a limited number of instances (e.g. one USB hub_event() worker thread is spawned per USB HCD); and the local ones, that are spawned when a user interacts with -some kernel interface (e.g. vhost workers). +some kernel interface (e.g. vhost workers); as well as from interrupts. -To enable collecting coverage from a global background thread, a unique -global handle must be assigned and passed to the corresponding -kcov_remote_start() call. Then a userspace process can pass a list of such -handles to the KCOV_REMOTE_ENABLE ioctl in the handles array field of the -kcov_remote_arg struct. This will attach the used kcov device to the code -sections, that are referenced by those handles. +To enable collecting coverage from a global background thread or from an +interrupt, a unique global handle must be assigned and passed to the +corresponding kcov_remote_start() call. Then a userspace process can pass +a list of such handles to the KCOV_REMOTE_ENABLE ioctl in the handles +array field of the kcov_remote_arg struct. This will attach the used kcov +device to the code sections, that are referenced by those handles. Since there might be many local background threads spawned from different userspace processes, we can't use a single global handle per annotation.
@@ -242,7 +242,7 @@ handles as they don't belong to a particular subsystem. The bytes 4-7 are currently reserved and must be zero. In the future the number of bytes used for the subsystem or handle ids might be increased. -When a particular userspace proccess collects coverage by via a common +When a particular userspace proccess collects coverage via a common handle, kcov will collect coverage for each code section that is annotated to use the common handle obtained as kcov_handle from the current task_struct. However non common handles allow to collect coverage
drivers/usb/gadget/udc/dummy_hcd.c +1 -0
@@ -38,6 +38,7 @@#include <linux/usb/gadget.h> #include <linux/usb/hcd.h> #include <linux/scatterlist.h> +#include <linux/kcov.h> #include <asm/byteorder.h> #include <linux/io.h>
include/linux/sched.h +3 -0
@@ -1229,6 +1229,9 @@ struct task_struct {/* KCOV sequence number: */ int kcov_sequence; + +/* Collect coverage from interrupt context: */ +bool kcov_interrupt;#endif #ifdef CONFIG_MEMCG
kernel/kcov.c +133 -63
463 lines not on this page · raw message
lib/Kconfig.debug +9 -0
@@ -1695,6 +1695,15 @@ config KCOV_INSTRUMENT_ALL filesystem fuzzing with AFL) then you will want to enable coverage for more specific subsets of files, and should say n here. +config KCOV_IRQ_AREA_SIZE + hex "Size of interrupt coverage collection area in words" + depends on KCOV + default 0x40000 + help + KCOV uses preallocated per-cpu areas to collect coverage from + interrupts. This specifies the size of those areas in the number + of unsigned long words. + menuconfig RUNTIME_TESTING_MENU bool "Runtime Testing" def_bool y
Signature · 1 line
2.24.1.735.g03f4e72817-goog
RFC PATCH 2/2 HID: usbhid: kcov: add annotations for coverage collection
In reply to Andrey KonovalovThis patch adds kcov_remote_start/stop() callbacks into usbhid code that is executed in interrupt context. As the result, kcov can be used to collect coverage from those parts of the code, which is used to facilitate coverage-guided fuzzing with syzkaller.
--- drivers/hid/usbhid/hid-core.c | 25 ++++++++++++++++++++----- drivers/hid/usbhid/usbkbd.c | 15 ++++++++++++--- drivers/hid/usbhid/usbmouse.c | 7 ++++++- 3 files changed, 38 insertions(+), 9 deletions(-)
drivers/hid/usbhid/hid-core.c +20 -5
@@ -274,6 +274,8 @@ static void hid_irq_in(struct urb *urb)struct usbhid_device *usbhid = hid->driver_data;int status; +kcov_remote_start_usb ((u64 )urb->dev->bus->busnum); +switch (urb->status) {case 0 :/* success */ usbhid->retry_delay =0 ;
@@ -300,12 +302,12 @@ static void hid_irq_in(struct urb *urb)clear_bit (HID_IN_RUNNING , &usbhid->iofl);set_bit (HID_CLEAR_HALT , &usbhid->iofl);schedule_work (&usbhid->reset_work); -return ; + goto out;case -ECONNRESET :/* unlink */ case -ENOENT :case -ESHUTDOWN :/* unplug */ clear_bit (HID_IN_RUNNING , &usbhid->iofl); -return ; + goto out;case -EILSEQ :/* protocol error or unplug */ case -EPROTO :/* protocol error or unplug */ case -ETIME :/* protocol error or unplug */
@@ -313,7 +315,7 @@ static void hid_irq_in(struct urb *urb)usbhid_mark_busy (usbhid);clear_bit (HID_IN_RUNNING , &usbhid->iofl);hid_io_error (hid); -return ; + goto out;default :/* error */ hid_warn (urb->dev,"input irq status %d received\n" , urb->status);
@@ -330,6 +332,9 @@ static void hid_irq_in(struct urb *urb)hid_io_error (hid); } } + +out: +kcov_remote_stop (); }static int hid_submit_out (struct hid_device *hid)
@@ -433,6 +438,8 @@ static void hid_irq_out(struct urb *urb)unsigned long flags;int unplug =0 ; +kcov_remote_start_usb ((u64 )urb->dev->bus->busnum); +switch (urb->status) {case 0 :/* success */ break ;
@@ -459,7 +466,7 @@ static void hid_irq_out(struct urb *urb) hid_submit_out(hid) == 0) {/* Successfully submitted next urb in queue */ spin_unlock_irqrestore (&usbhid->lock, flags); -return ; + goto out; } }
@@ -467,6 +474,9 @@ static void hid_irq_out(struct urb *urb)spin_unlock_irqrestore (&usbhid->lock, flags);usb_autopm_put_interface_async (usbhid->intf);wake_up (&usbhid->wait); + +out: +kcov_remote_stop (); }/*
@@ -480,6 +490,8 @@ static void hid_ctrl(struct urb *urb)unsigned long flags;int unplug =0 , status = urb->status; +kcov_remote_start_usb ((u64 )urb->dev->bus->busnum); +switch (status) {case 0 :/* success */ if (usbhid->ctrl[usbhid->ctrltail].dir ==USB_DIR_IN )
@@ -510,7 +522,7 @@ static void hid_ctrl(struct urb *urb) hid_submit_ctrl(hid) == 0) {/* Successfully submitted next urb in queue */ spin_unlock_irqrestore (&usbhid->lock, flags); -return ; + goto out; } }
@@ -518,6 +530,9 @@ static void hid_ctrl(struct urb *urb)spin_unlock_irqrestore (&usbhid->lock, flags);usb_autopm_put_interface_async (usbhid->intf);wake_up (&usbhid->wait); + +out: +kcov_remote_stop (); } static void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report,
drivers/hid/usbhid/usbkbd.c +12 -3
@@ -102,13 +102,15 @@ static void usb_kbd_irq(struct urb *urb)struct usb_kbd *kbd = urb->context;int i; +kcov_remote_start_usb ((u64 )urb->dev->bus->busnum); +switch (urb->status) {case 0 :/* success */ break ;case -ECONNRESET :/* unlink */ case -ENOENT :case -ESHUTDOWN : -return ; + goto out;/* -EPIPE: should clear the halt */ default :/* error */ goto resubmit;
@@ -148,6 +150,9 @@ static void usb_kbd_irq(struct urb *urb)hid_err (urb->dev,"can't resubmit intr, %s-%s/input0, status %d" , kbd->usbdev->bus->bus_name, kbd->usbdev->devpath, i); + +out: +kcov_remote_stop (); } static int usb_kbd_event(struct input_dev *dev, unsigned int type,
@@ -192,6 +197,8 @@ static void usb_kbd_led(struct urb *urb)unsigned long flags;struct usb_kbd *kbd = urb->context; +kcov_remote_start_usb ((u64 )urb->dev->bus->busnum); +if (urb->status)hid_warn (urb->dev,"led urb status %d received\n" , urb->status);
@@ -201,7 +208,7 @@ static void usb_kbd_led(struct urb *urb)if (*(kbd->leds) == kbd->newleds){ kbd->led_urb_submitted = false;spin_unlock_irqrestore (&kbd->leds_lock, flags); -return ; + goto out; } *(kbd->leds) = kbd->newleds;
@@ -212,7 +219,9 @@ static void usb_kbd_led(struct urb *urb) kbd->led_urb_submitted = false; }spin_unlock_irqrestore (&kbd->leds_lock, flags); - + +out: +kcov_remote_stop (); }static int usb_kbd_open (struct input_dev *dev)
drivers/hid/usbhid/usbmouse.c +6 -1
@@ -53,13 +53,15 @@ static void usb_mouse_irq(struct urb *urb)struct input_dev *dev = mouse->dev;int status; +kcov_remote_start_usb ((u64 )urb->dev->bus->busnum); +switch (urb->status) {case 0 :/* success */ break ;case -ECONNRESET :/* unlink */ case -ENOENT :case -ESHUTDOWN : -return ; + goto out;/* -EPIPE: should clear the halt */ default :/* error */ goto resubmit;
@@ -83,6 +85,9 @@ static void usb_mouse_irq(struct urb *urb)"can't resubmit intr, %s-%s/input0, status %d\n" , mouse->usbdev->bus->bus_name, mouse->usbdev->devpath, status); + +out: +kcov_remote_stop (); }static int usb_mouse_open (struct input_dev *dev)
Signature · 1 line
2.24.1.735.g03f4e72817-goog
Re: [PATCH RFC 1/2] kcov: collect coverage from interrupts
In reply to Andrey KonovalovQuoted 27 lines · Andrey Konovalov
This change extends kcov remote coverage support to allow collecting coverage from interrupts in addition to kernel background threads.
To collect coverage from code that is executed in interrupt context, a part of that code has to be annotated with kcov_remote_start/stop() in a similar way as how it is done for global kernel background threads. Then the handle used for the annotations has to be passed to the
KCOV_REMOTE_ENABLEioctl.Internally this patch adjusts the
__sanitizer_cov_trace_pc()compiler inserted callback to not bail out when called from interrupt context. kcov_remote_start/stop() are updated to save/restore the current per task kcov state in a per-cpu area (in case the interrupt came when the kernel was already collecting coverage in task context). Coverage from interrupts is collected into pre-allocated per-cpu areas, whose size is controlled by the newCONFIG_KCOV_IRQ_AREA_SIZE.This patch also cleans up some of kcov debug messages.
Signed-off-by Andrey Konovalov <[email protected]>---
drivers/usb/gadget/udc/dummy_hcd.c +0
-0
drivers/usb/gadget/udc/dummy_hcd.c line 44
Quoted 7 lines
drivers/usb/gadget/udc/dummy_hcd.c +1
-0@@ -38,6 +38,7 @@#include <linux/usb/gadget.h> #include <linux/usb/hcd.h> #include <linux/scatterlist.h> +#include <linux/kcov.h> #include <asm/byteorder.h> #include <linux/io.h>
That's the only change to this driver. As such, it doesn't appear to be needed, judging by the patch description.
Alan Stern
Re: [PATCH RFC 2/2] HID: usbhid: kcov: add annotations for coverage collection
In reply to Andrey KonovalovQuoted 6 lines · Andrey Konovalov
This patch adds kcov_remote_start/stop() callbacks into usbhid code that is executed in interrupt context. As the result, kcov can be used to collect coverage from those parts of the code, which is used to facilitate coverage-guided fuzzing with syzkaller.
Signed-off-by Andrey Konovalov <[email protected]>
Signature · 2 lines
Jiri Kosina SUSE Labs
Re: [PATCH RFC 1/2] kcov: collect coverage from interrupts
In reply to Alan SternQuoted 35 lines · Alan Stern
Quoted 32 lines · Andrey Konovalov
This change extends kcov remote coverage support to allow collecting coverage from interrupts in addition to kernel background threads.
To collect coverage from code that is executed in interrupt context, a part of that code has to be annotated with kcov_remote_start/stop() in a similar way as how it is done for global kernel background threads. Then the handle used for the annotations has to be passed to the
KCOV_REMOTE_ENABLEioctl.Internally this patch adjusts the
__sanitizer_cov_trace_pc()compiler inserted callback to not bail out when called from interrupt context. kcov_remote_start/stop() are updated to save/restore the current per task kcov state in a per-cpu area (in case the interrupt came when the kernel was already collecting coverage in task context). Coverage from interrupts is collected into pre-allocated per-cpu areas, whose size is controlled by the newCONFIG_KCOV_IRQ_AREA_SIZE.This patch also cleans up some of kcov debug messages.
Signed-off-by Andrey Konovalov <[email protected]>---
drivers/usb/gadget/udc/dummy_hcd.c +1
-0@@ -38,6 +38,7 @@#include <linux/usb/gadget.h> #include <linux/usb/hcd.h> #include <linux/scatterlist.h> +#include <linux/kcov.h>
Quoted 5 lines
drivers/usb/gadget/udc/dummy_hcd.c line 44
Quoted 2 lines
drivers/usb/gadget/udc/dummy_hcd.c +0
-0#include <asm/byteorder.h> #include <linux/io.h> That's the only change to this driver. As such, it doesn't appear to be needed, judging by the patch description.
Right, will fix in the next version, thanks!
Quoted 4 lines · Andrey Konovalov
This patchset extends kcov to allow collecting coverage from interrupts and then uses the new functionality to collect coverage from usbhid code.
Quoted 8 lines
What I'm not sure yet about this change is if we actually want to selectively annotate some parts of the USB stack that are executed in interrupt context, or maybe we can do this with some common approach.
For example patch #2 in this patchset annotates all functions that are passed as completion callbacks to usb_fill_*() in
drivers/hid/usbhid. Maybe instead we could redefine usb_fill_*() in a way that would handle all such cases without manual annotations.
Although looking at this again today, it seems much more logical to add kcov annotations around the complete() callback in __usb_hcd_giveback_urb(). Don't know why I didn't think of that. Will do in the next version.
Quoted 32 lines
Any suggestions are welcome.
This has allowed to find at least one new HID bug [1], which was recently fixed by Alan [2].
[1] https://syzkaller.appspot.com/bug?extid=09ef48aa58261464b621
[2] https://patchwork.kernel.org/patch/11283319/This patchset has been pushed to the public Linux kernel Gerrit instance:
https://linux-review.googlesource.com/c/linux/kernel/git/torvalds/linux/+/2225
Signed-off-by Andrey Konovalov <[email protected]>Andrey Konovalov (2):
kcov: collect coverage from interrupts
HID: usbhid: kcov: add annotations for coverage collectionDocumentation/dev-tools/kcov.rst | 16 +-- drivers/hid/usbhid/hid-core.c | 25 +++- drivers/hid/usbhid/usbkbd.c | 15 ++- drivers/hid/usbhid/usbmouse.c | 7 +- drivers/usb/gadget/udc/dummy_hcd.c | 1 + include/linux/sched.h | 3 + kernel/kcov.c | 196 +++++++++++++++++++---------- lib/Kconfig.debug | 9 ++ 8 files changed, 192 insertions(+), 80 deletions(-)--
2.24.1.735.g03f4e72817-goog
Dmitry Vyukov
reviewerRe: [PATCH RFC 1/2] kcov: collect coverage from interrupts
In reply to Andrey KonovalovQuoted 37 lines · Andrey Konovalov
Quoted 35 lines · Alan Stern
Quoted 32 lines · Andrey Konovalov
This change extends kcov remote coverage support to allow collecting coverage from interrupts in addition to kernel background threads.
To collect coverage from code that is executed in interrupt context, a part of that code has to be annotated with kcov_remote_start/stop() in a similar way as how it is done for global kernel background threads. Then the handle used for the annotations has to be passed to the
KCOV_REMOTE_ENABLEioctl.Internally this patch adjusts the
__sanitizer_cov_trace_pc()compiler inserted callback to not bail out when called from interrupt context. kcov_remote_start/stop() are updated to save/restore the current per task kcov state in a per-cpu area (in case the interrupt came when the kernel was already collecting coverage in task context). Coverage from interrupts is collected into pre-allocated per-cpu areas, whose size is controlled by the newCONFIG_KCOV_IRQ_AREA_SIZE.This patch also cleans up some of kcov debug messages.
Signed-off-by Andrey Konovalov <[email protected]>---
drivers/usb/gadget/udc/dummy_hcd.c +1
-0@@ -38,6 +38,7 @@#include <linux/usb/gadget.h> #include <linux/usb/hcd.h> #include <linux/scatterlist.h> +#include <linux/kcov.h>
Quoted 7 lines
Quoted 5 lines
drivers/usb/gadget/udc/dummy_hcd.c line 44
Quoted 2 lines
drivers/usb/gadget/udc/dummy_hcd.c +0
-0#include <asm/byteorder.h> #include <linux/io.h> That's the only change to this driver. As such, it doesn't appear to be needed, judging by the patch description.
Right, will fix in the next version, thanks!
Please also post a github or gerrit link. These small scraps of changes without context and better visualisation are extremely hard to review meaningfully.
Re: [PATCH RFC 1/2] kcov: collect coverage from interrupts
Quoted 45 lines · Dmitry Vyukov
Quoted 43 lines · Andrey Konovalov
Quoted 40 lines · Alan Stern
Quoted 27 lines · Andrey Konovalov
This change extends kcov remote coverage support to allow collecting coverage from interrupts in addition to kernel background threads.
To collect coverage from code that is executed in interrupt context, a part of that code has to be annotated with kcov_remote_start/stop() in a similar way as how it is done for global kernel background threads. Then the handle used for the annotations has to be passed to the
KCOV_REMOTE_ENABLEioctl.Internally this patch adjusts the
__sanitizer_cov_trace_pc()compiler inserted callback to not bail out when called from interrupt context. kcov_remote_start/stop() are updated to save/restore the current per task kcov state in a per-cpu area (in case the interrupt came when the kernel was already collecting coverage in task context). Coverage from interrupts is collected into pre-allocated per-cpu areas, whose size is controlled by the newCONFIG_KCOV_IRQ_AREA_SIZE.This patch also cleans up some of kcov debug messages.
Signed-off-by Andrey Konovalov <[email protected]>---
drivers/usb/gadget/udc/dummy_hcd.c +0
-0drivers/usb/gadget/udc/dummy_hcd.c line 44
Quoted 7 lines
drivers/usb/gadget/udc/dummy_hcd.c +1
-0@@ -38,6 +38,7 @@#include <linux/usb/gadget.h> #include <linux/usb/hcd.h> #include <linux/scatterlist.h> +#include <linux/kcov.h> #include <asm/byteorder.h> #include <linux/io.h> That's the only change to this driver. As such, it doesn't appear to be needed, judging by the patch description.
Quoted 5 lines
Quoted 1 line
Right, will fix in the next version, thanks!
Please also post a github or gerrit link. These small scraps of changes without context and better visualisation are extremely hard to review meaningfully.
The link is in the cover letter:
https://linux-review.googlesource.com/c/linux/kernel/git/torvalds/linux/+/2224/1
Dmitry Vyukov
reviewerRe: [PATCH RFC 1/2] kcov: collect coverage from interrupts
Quoted 44 lines · Andrey Konovalov
Quoted 44 lines
Quoted 43 lines · Alan Stern
Quoted 35 lines · Andrey Konovalov
Quoted 33 lines
This change extends kcov remote coverage support to allow collecting coverage from interrupts in addition to kernel background threads.
To collect coverage from code that is executed in interrupt context, a part of that code has to be annotated with kcov_remote_start/stop() in a similar way as how it is done for global kernel background threads. Then the handle used for the annotations has to be passed to the
KCOV_REMOTE_ENABLEioctl.Internally this patch adjusts the
__sanitizer_cov_trace_pc()compiler inserted callback to not bail out when called from interrupt context. kcov_remote_start/stop() are updated to save/restore the current per task kcov state in a per-cpu area (in case the interrupt came when the kernel was already collecting coverage in task context). Coverage from interrupts is collected into pre-allocated per-cpu areas, whose size is controlled by the newCONFIG_KCOV_IRQ_AREA_SIZE.This patch also cleans up some of kcov debug messages.
Signed-off-by Andrey Konovalov <[email protected]>---
drivers/usb/gadget/udc/dummy_hcd.c +1
-0@@ -38,6 +38,7 @@#include <linux/usb/gadget.h> #include <linux/usb/hcd.h> #include <linux/scatterlist.h> +#include <linux/kcov.h> Quoted 5 lines
drivers/usb/gadget/udc/dummy_hcd.c line 44
Quoted 2 lines
drivers/usb/gadget/udc/dummy_hcd.c +0
-0#include <asm/byteorder.h> #include <linux/io.h> That's the only change to this driver. As such, it doesn't appear to be needed, judging by the patch description.
Right, will fix in the next version, thanks!
Quoted 7 lines
Quoted 3 lines
Please also post a github or gerrit link. These small scraps of changes without context and better visualisation are extremely hard to review meaningfully.
The link is in the cover letter:
https://linux-review.googlesource.com/c/linux/kernel/git/torvalds/linux/+/2224/1
Sorry, missed. Now I can read it!
Dmitry Vyukov
reviewerRe: [PATCH RFC 1/2] kcov: collect coverage from interrupts
In reply to Andrey KonovalovQuoted 106 lines · Andrey Konovalov
This change extends kcov remote coverage support to allow collecting coverage from interrupts in addition to kernel background threads.
To collect coverage from code that is executed in interrupt context, a part of that code has to be annotated with kcov_remote_start/stop() in a similar way as how it is done for global kernel background threads. Then the handle used for the annotations has to be passed to the
KCOV_REMOTE_ENABLEioctl.Internally this patch adjusts the
__sanitizer_cov_trace_pc()compiler inserted callback to not bail out when called from interrupt context. kcov_remote_start/stop() are updated to save/restore the current per task kcov state in a per-cpu area (in case the interrupt came when the kernel was already collecting coverage in task context). Coverage from interrupts is collected into pre-allocated per-cpu areas, whose size is controlled by the newCONFIG_KCOV_IRQ_AREA_SIZE.This patch also cleans up some of kcov debug messages.
Signed-off-by Andrey Konovalov <[email protected]>--- Documentation/dev-tools/kcov.rst | 16 +-- drivers/usb/gadget/udc/dummy_hcd.c | 1 + include/linux/sched.h | 3 + kernel/kcov.c | 196 +++++++++++++++++++---------- lib/Kconfig.debug | 9 ++ 5 files changed, 154 insertions(+), 71 deletions(-)Documentation/dev-tools/kcov.rst +8
-8@@ -217,14 +217,14 @@ This allows to collect coverage from two types of kernel background threads: the global ones, that are spawned during kernel boot in a limited number of instances (e.g. one USB hub_event() worker thread is spawned per USB HCD); and the local ones, that are spawned when a user interacts with -some kernel interface (e.g. vhost workers). +some kernel interface (e.g. vhost workers); as well as from interrupts. -To enable collecting coverage from a global background thread, a unique -global handle must be assigned and passed to the corresponding -kcov_remote_start() call. Then a userspace process can pass a list of such -handles to the KCOV_REMOTE_ENABLE ioctl in the handles array field of the -kcov_remote_arg struct. This will attach the used kcov device to the code -sections, that are referenced by those handles. +To enable collecting coverage from a global background thread or from an +interrupt, a unique global handle must be assigned and passed to the +corresponding kcov_remote_start() call. Then a userspace process can pass +a list of such handles to the KCOV_REMOTE_ENABLE ioctl in the handles +array field of the kcov_remote_arg struct. This will attach the used kcov +device to the code sections, that are referenced by those handles. Since there might be many local background threads spawned from different userspace processes, we can't use a single global handle per annotation.@@ -242,7 +242,7 @@ handles as they don't belong to a particular subsystem. The bytes 4-7 are currently reserved and must be zero. In the future the number of bytes used for the subsystem or handle ids might be increased. -When a particular userspace proccess collects coverage by via a common +When a particular userspace proccess collects coverage via a common handle, kcov will collect coverage for each code section that is annotated to use the common handle obtained as kcov_handle from the current task_struct. However non common handles allow to collect coveragedrivers/usb/gadget/udc/dummy_hcd.c +1
-0@@ -38,6 +38,7 @@#include <linux/usb/gadget.h> #include <linux/usb/hcd.h> #include <linux/scatterlist.h> +#include <linux/kcov.h> #include <asm/byteorder.h> #include <linux/io.h> include/linux/sched.h +3
-0@@ -1229,6 +1229,9 @@ struct task_struct {/* KCOV sequence number: */ int kcov_sequence; + +/* Collect coverage from interrupt context: */ +bool kcov_interrupt;#endif #ifdef CONFIG_MEMCG kernel/kcov.c +1
-0@@ -26,6 +26,7 @@#include <asm/setup.h> #define kcov_debug (fmt, ...) pr_debug("%s: " fmt, __func__, ##__VA_ARGS__) +#define kcov_err (fmt, ...) pr_err("%s: " fmt, __func__, ##__VA_ARGS__)/* Number of 64-bit words written per one comparison: */ #define KCOV_WORDS_PER_CMP 4@@ -86,6 +87,17 @@ static DEFINE_SPINLOCK(kcov_remote_lock); static DEFINE_HASHTABLE(kcov_remote_map, 4);static struct list_head kcov_remote_areas =LIST_HEAD_INIT (kcov_remote_areas);
kernel/kcov.c static DEFINE_SPINLOCK(kcov_remote_lock); · line 99
Quoted 10 lines
kernel/kcov.c +10
-0+struct kcov_remote_irq_data { +unsigned int mode; +unsigned int size; +void *area; +struct kcov *kcov; +unsigned long flags; +}; + +DEFINE_PER_CPU(struct kcov_remote_irq_data, kcov_remote_irq); +DEFINE_PER_CPU(void *, kcov_irq_area);
I would combine these 2 vars together.
Each kcov_remote_irq_data field and kcov_irq_area are all various bits of kcov irq-related state. Little point in separating them into 2 per-cpu variables. What may help is better names, e.g. what's the difference between kcov_remote_irq.area and kcov_irq_area? I would understand if kcov_remote_irq would only be used in kcov_remote_swap_irq as current task save area, but flags already don't belong to this category.
Quoted 294 lines
kernel/kcov.c +38
-37+/* Must be called with kcov_remote_lock locked. */ static struct kcov_remote *kcov_remote_find (u64 handle) {@@ -98,6 +110,7 @@ static struct kcov_remote *kcov_remote_find(u64 handle)return NULL ; } +/* Must be called with kcov_remote_lock locked. */ static struct kcov_remote *kcov_remote_add (struct kcov *kcov,u64 handle) {struct kcov_remote *remote;@@ -119,16 +132,13 @@ static struct kcov_remote_area *kcov_remote_area_get(unsigned int size)struct kcov_remote_area *area;struct list_head *pos; -kcov_debug ("size = %u\n" , size);list_for_each (pos, &kcov_remote_areas) { area = list_entry(pos, struct kcov_remote_area, list);if (area->size == size) {list_del (&area->list); -kcov_debug ("rv = %px\n" , area);return area; } } -kcov_debug ("rv = NULL\n" );return NULL ; }@@ -136,7 +146,6 @@ static struct kcov_remote_area *kcov_remote_area_get(unsigned int size)static void kcov_remote_area_put (struct kcov_remote_area *area,unsigned int size) { -kcov_debug ("area = %px, size = %u\n" , area, size);INIT_LIST_HEAD (&area->list); area->size = size;list_add (&area->list, &kcov_remote_areas);@@ -148,9 +157,11 @@ static notrace bool check_kcov_mode(enum kcov_mode needed_mode, struct task_stru/* * We are interested in code coverage as a function of a syscall inputs, -* so we ignore code executed in interrupts. +* so we ignore code executed in interrupts, unless we are in a remote +* coverage collection section happening in an interrupt, which is +* indicated by the t->kcov_interrupt flag. */ -if (!in_task ()) +if (!in_task () && !t->kcov_interrupt)return false; mode =READ_ONCE (t->kcov_mode);/* @@ -331,12 +342,12 @@ static void kcov_stop(struct task_struct *t)barrier (); t->kcov_size =0 ; t->kcov_area =NULL ; + t->kcov =NULL ; }static void kcov_task_reset (struct task_struct *t) {kcov_stop (t); - t->kcov =NULL ; t->kcov_sequence =0 ; t->kcov_handle =0 ; }@@ -361,18 +372,18 @@ static void kcov_remote_reset(struct kcov *kcov)int bkt;struct kcov_remote *remote;struct hlist_node *tmp; +unsigned long flags; -spin_lock (&kcov_remote_lock); +spin_lock_irqsave (&kcov_remote_lock, flags);hash_for_each_safe (kcov_remote_map, bkt, tmp, remote, hnode) {if (remote->kcov != kcov)continue ; -kcov_debug ("removing handle %llx\n" , remote->handle);hash_del (&remote->hnode);kfree (remote); }/* Do reset before unlock to prevent races with kcov_remote_start(). */ kcov_reset (kcov); -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, flags); }static void kcov_disable (struct task_struct *t,struct kcov *kcov)@@ -401,12 +412,13 @@ static void kcov_put(struct kcov *kcov)void kcov_task_exit (struct task_struct *t) {struct kcov *kcov; +unsigned long flags; kcov = t->kcov;if (kcov ==NULL )return ; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags);kcov_debug ("t = %px, kcov->t = %px\n" , t, kcov->t);/* * For KCOV_ENABLE devices we want to make sure that t->kcov->t == t, @@ -430,12 +442,12 @@ void kcov_task_exit(struct task_struct *t)* By combining all three checks into one we get: */ if (WARN_ON (kcov->t != t)) { -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);return ; }/* Just to not leave dangling references behind. */ kcov_disable (t, kcov); -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);kcov_put (kcov); }@@ -446,12 +458,13 @@ static int kcov_mmap(struct file *filep, struct vm_area_struct *vma)struct kcov *kcov = vma->vm_file->private_data;unsigned long size, off;struct page *page; +unsigned long flags; area =vmalloc_user (vma->vm_end - vma->vm_start);if (!area)return -ENOMEM ; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags); size = kcov->size *sizeof (unsigned long );if (kcov->mode !=KCOV_MODE_INIT || vma->vm_pgoff !=0 || vma->vm_end - vma->vm_start != size) {@@ -461,7 +474,7 @@ static int kcov_mmap(struct file *filep, struct vm_area_struct *vma)if (!kcov->area) { kcov->area = area; vma->vm_flags |=VM_DONTEXPAND ; -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);for (off =0 ; off < size; off +=PAGE_SIZE ) { page =vmalloc_to_page (kcov->area + off);if (vm_insert_page (vma, vma->vm_start + off, page))@@ -470,7 +483,7 @@ static int kcov_mmap(struct file *filep, struct vm_area_struct *vma)return 0 ; } exit: -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);vfree (area);return res; }@@ -550,10 +563,10 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd,int mode, i;struct kcov_remote_arg *remote_arg;struct kcov_remote *remote; +unsigned long flags;switch (cmd) {case KCOV_INIT_TRACE : -kcov_debug ("KCOV_INIT_TRACE\n" );/* * Enable kcov in trace mode and setup buffer size. * Must happen before anything else. @@ -572,7 +585,6 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd, kcov->mode =KCOV_MODE_INIT ;return 0 ;case KCOV_ENABLE : -kcov_debug ("KCOV_ENABLE\n" );/* * Enable coverage for the current task. * At this point user must have been enabled trace mode, @@ -598,7 +610,6 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd,kcov_get (kcov);return 0 ;case KCOV_DISABLE : -kcov_debug ("KCOV_DISABLE\n" );/* Disable coverage for the current task. */ unused = arg;if (unused !=0 || current->kcov != kcov)@@ -610,7 +621,6 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd,kcov_put (kcov);return 0 ;case KCOV_REMOTE_ENABLE : -kcov_debug ("KCOV_REMOTE_ENABLE\n" );if (kcov->mode !=KCOV_MODE_INIT || !kcov->area)return -EINVAL ; t = current;@@ -627,41 +637,42 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd, kcov->t = t; kcov->remote = true; kcov->remote_size = remote_arg->area_size; -spin_lock (&kcov_remote_lock); +spin_lock_irqsave (&kcov_remote_lock, flags);for (i =0 ; i < remote_arg->num_handles; i++) { -kcov_debug ("handle %llx\n" , remote_arg->handles[i]);if (!kcov_check_handle (remote_arg->handles[i], false, true, false)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return -EINVAL ; } remote =kcov_remote_add (kcov, remote_arg->handles[i]);if (IS_ERR (remote)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return PTR_ERR (remote); } }if (remote_arg->common_handle) { -kcov_debug ("common handle %llx\n" , - remote_arg->common_handle);if (!kcov_check_handle (remote_arg->common_handle, true, false, false)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return -EINVAL ; } remote =kcov_remote_add (kcov, remote_arg->common_handle);if (IS_ERR (remote)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return PTR_ERR (remote); } t->kcov_handle = remote_arg->common_handle; } -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, flags);/* Put either in kcov_task_exit() or in KCOV_DISABLE. */ kcov_get (kcov);return 0 ;@@ -677,6 +688,7 @@ static long kcov_ioctl(struct file *filep, unsigned int cmd, unsigned long arg)struct kcov_remote_arg *remote_arg =NULL ;unsigned int remote_num_handles;unsigned long remote_arg_size; +unsigned long flags;if (cmd ==KCOV_REMOTE_ENABLE ) { if (get_user(remote_num_handles, (unsigned __user *)(arg +@@ -697,9 +709,9 @@ static long kcov_ioctl(struct file *filep, unsigned int cmd, unsigned long arg) } kcov = filep->private_data; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags); res =kcov_ioctl_locked (kcov, cmd, arg); -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);kfree (remote_arg);@@ -716,8 +728,8 @@ static const struct file_operations kcov_fops = {/* * kcov_remote_start() and kcov_remote_stop() can be used to annotate a section -* of code in a kernel background thread to allow kcov to be used to collect -* coverage from that part of code. +* of code in a kernel background thread or in an interrupt to allow kcov to be +* used to collect coverage from that part of code. * * The handle argument of kcov_remote_start() identifies a code section that is * used for coverage collection. A userspace process passes this handle to @@ -728,9 +740,9 @@ static const struct file_operations kcov_fops = {* the type of the kernel thread whose code is being annotated. * * For global kernel threads that are spawned in a limited number of instances -* (e.g. one USB hub_event() worker thread is spawned per USB HCD), each -* instance must be assigned a unique 4-byte instance id. The instance id is -* then combined with a 1-byte subsystem id to get a handle via +* (e.g. one USB hub_event() worker thread is spawned per USB HCD) and for +* interrupts, each instance must be assigned a unique 4-byte instance id. The +* instance id is then combined with a 1-byte subsystem id to get a handle via * kcov_remote_handle(subsystem_id, instance_id). * * For local kernel threads that are spawned from system calls handler when a @@ -749,13 +761,48 @@ static const struct file_operations kcov_fops = {* * See Documentation/dev-tools/kcov.rst for more details. * -* Internally, this function looks up the kcov device associated with the +* Internally, kcov_remote_start() looks up the kcov device associated with the * provided handle, allocates an area for coverage collection, and saves the * pointers to kcov and area into the current task_struct to allow coverage to * be collected via __sanitizer_cov_trace_pc() * In turns kcov_remote_stop() clears those pointers from task_struct to stop * collecting coverage and copies all collected coverage into the kcov area. */
kernel/kcov.c static const struct file_operations kcov_fops = { · line 780
Quoted 10 lines
kernel/kcov.c +8
-0+ +void kcov_remote_swap_irq (struct task_struct *t, +struct kcov_remote_irq_data *irq) +{ + t->kcov =xchg (&irq->kcov, t->kcov); + t->kcov_size =xchg (&irq->size, t->kcov_size); + t->kcov_area =xchg (&irq->area, t->kcov_area); + t->kcov_mode =xchg (&irq->mode, t->kcov_mode);
Do we need these xchg here? Why?
They look fishy. If somebody actually uses these fields concurrently, then they can get inconsistent kcov_area/size/mode, which will explode badly (overwrite beyond area). So these field atomic updates only seem to give a false sense of safety.
If nobody uses this, then no need in atomic updates.
If somebody uses this, atomic updates won't help.
kernel/kcov.c static const struct file_operations kcov_fops = { · line 783
Quoted 5 lines
kernel/kcov.c +5
-0+} + +bool kcov_remote_start_irq (struct task_struct *t) +{ +struct kcov_remote_irq_data *irq = &get_cpu_var (kcov_remote_irq);
We are already (1) in interrupt and (2) inside of spin_lock_irqsave, and we seem to rely on that below when we do non-atomic xchg on t->kcov_interrupt. Do we need get/put_cpu_var here? It seems using this_cpu_ptr will make it simpler.
kernel/kcov.c static const struct file_operations kcov_fops = { · line 790
Quoted 7 lines
kernel/kcov.c +7
-0+ +if (t->kcov_interrupt) { +/* Nested interrupt. */ +put_cpu_var (kcov_remote_irq); +return false; + } + t->kcov_interrupt = true;
I can't fully understand what happens with nested interrupts. We very much rely on the fact that we disabled interrupts for the whole traced region.
But what happens with NMIs? Let's say nmi arrives when we set t->kcov_interrupt = true but did not execute kcov_remote_swap_irq yet (or worse, in the middle of kcov_remote_swap_irq)?
kernel/kcov.c static const struct file_operations kcov_fops = { · line 800
Quoted 10 lines
kernel/kcov.c +10
-0+kcov_remote_swap_irq (t, irq); +put_cpu_var (kcov_remote_irq); +return true; +} + +void kcov_remote_stop_irq (struct task_struct *t) +{ +struct kcov_remote_irq_data *irq = &get_cpu_var (kcov_remote_irq); + +kcov_remote_swap_irq (t, irq);
What is an NMI arrives while we are swapping?
kernel/kcov.c static const struct file_operations kcov_fops = { · line 802
Quoted 2 lines
kernel/kcov.c +2
-0+ t->kcov_interrupt = false; +local_irq_restore (irq->flags);
Interesting. Is it OK to prolong irq disabling region that much?...
Quoted 49 lines
kernel/kcov.c +3
-0+put_cpu_var (kcov_remote_irq); +} +void kcov_remote_start (u64 handle){ struct kcov_remote *remote;kernel/kcov.c +13
-9@@ -764,28 +811,32 @@ void kcov_remote_start(u64 handle)unsigned int size;enum kcov_mode mode;int sequence; +unsigned long flags;if (WARN_ON (!kcov_check_handle (handle, true, true, true)))return ; -if (WARN_ON (!in_task ())) +if (WARN_ON (in_nmi ()))return ; t = current;/* -* Check that kcov_remote_start is not called twice -* nor called by user tasks (with enabled kcov). +* Check that kcov_remote_start is not called twice in background +* threads nor called by user tasks (with enabled kcov). */ -if (WARN_ON (t->kcov)) +if (WARN_ON (in_task () && t->kcov))return ; -kcov_debug ("handle = %llx\n" , handle); - -spin_lock (&kcov_remote_lock); +spin_lock_irqsave (&kcov_remote_lock, flags); remote =kcov_remote_find (handle);if (!remote) { -kcov_debug ("no remote found" ); -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, flags);return ; } +if (!in_task () && !kcov_remote_start_irq (t)) { +spin_unlock_irqrestore (&kcov_remote_lock, flags); +return ; + } +kcov_debug ("handle = %llx, context: %s\n" , handle, +in_task () ?"task" :"irq" );/* Put in kcov_remote_stop(). */ kcov_get (remote->kcov); t->kcov = remote->kcov;
kernel/kcov.c void kcov_remote_start(u64 handle) · line 848
Quoted 6 lines
kernel/kcov.c +2
-1@@ -793,11 +844,19 @@ void kcov_remote_start(u64 handle)* Read kcov fields before unlock to prevent races with * KCOV_DISABLE / kcov_remote_reset(). */ - size = remote->kcov->remote_size; + size = min_t(unsigned int, remote->kcov->remote_size, +CONFIG_KCOV_IRQ_AREA_SIZE );
This seems to only be relevant for the irq case.
Quoted 6 lines
kernel/kcov.c +2
-2mode = remote->kcov->mode; sequence = remote->kcov->sequence; - area =kcov_remote_area_get (size); -spin_unlock (&kcov_remote_lock); +if (in_task ()) { + area =kcov_remote_area_get (size);
kernel/kcov.c void kcov_remote_start(u64 handle) · line 862
Quoted 10 lines
kernel/kcov.c +7
-0+spin_unlock_irqrestore (&kcov_remote_lock, flags); + }else { + area = *this_cpu_ptr (&kcov_irq_area); +/* Flags are restored by kcov_remote_stop_irq(). */ +this_cpu_ptr (&kcov_remote_irq)->flags = flags; +spin_unlock (&kcov_remote_lock); + }if (!area) { area =vmalloc (size *sizeof (unsigned long ));
And this only for the !irq case, so may be better to move inside of the if above to not confuse the reader.
kernel/kcov.c void kcov_remote_start(u64 handle) · line 872
Quoted 7 lines
kernel/kcov.c +0
-2@@ -810,8 +869,6 @@ void kcov_remote_start(u64 handle)/* Reset coverage size. */ *(u64 *)area =0 ; -kcov_debug ("area = %px, size = %u" , area, size); -kcov_start (t, size, area, mode, sequence);
Don't we overwrite and lose the original t->kcov_sequence here?
Quoted 88 lines
kernel/kcov.c +25
-12}@@ -880,30 +937,30 @@ void kcov_remote_stop(void)void *area = t->kcov_area;unsigned int size = t->kcov_size;int sequence = t->kcov_sequence; +unsigned long flags; -if (!kcov) { -kcov_debug ("no kcov found\n" ); +if (!kcov)return ; - }kcov_stop (t); - t->kcov =NULL ; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags);/* * KCOV_DISABLE could have been called between kcov_remote_start() -* and kcov_remote_stop(), hence the check. +* and kcov_remote_stop(), hence the sequence check. */ -kcov_debug ("move if: %d == %d && %d\n" , - sequence, kcov->sequence, (int )kcov->remote);if (sequence == kcov->sequence && kcov->remote)kcov_move_area (kcov->mode, kcov->area, kcov->size, area); -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags); -spin_lock (&kcov_remote_lock); -kcov_remote_area_put (area, size); -spin_unlock (&kcov_remote_lock); +if (in_task ()) { +spin_lock_irqsave (&kcov_remote_lock, flags); +kcov_remote_area_put (area, size); +spin_unlock_irqrestore (&kcov_remote_lock, flags); + }else +kcov_remote_stop_irq (t); +/* Get in kcov_remote_start(). */ kcov_put (kcov); }EXPORT_SYMBOL (kcov_remote_stop);@@ -917,6 +974,19 @@ EXPORT_SYMBOL(kcov_common_handle);static int __init kcov_init (void ) { +int cpu; + +for_each_possible_cpu (cpu) { +void **area =per_cpu_ptr (&kcov_irq_area, cpu); + + *area =vmalloc (CONFIG_KCOV_IRQ_AREA_SIZE * +sizeof (unsigned long )); +if (!*area) { +kcov_err ("failed to allocate per-cpu area\n" ); +return -ENOMEM ; + } + } +/* * The kcov debugfs file won't ever get removed and thus, * there is no need to protect it against removal races. The lib/Kconfig.debug +9
-1@@ -1695,6 +1695,15 @@ config KCOV_INSTRUMENT_ALL filesystem fuzzing with AFL) then you will want to enable coverage for more specific subsets of files, and should say n here. +config KCOV_IRQ_AREA_SIZE + hex "Size of interrupt coverage collection area in words" + depends on KCOV + default 0x40000 + help + KCOV uses preallocated per-cpu areas to collect coverage from + interrupts. This specifies the size of those areas in the number + of unsigned long words. + menuconfig RUNTIME_TESTING_MENU bool "Runtime Testing" def_bool y --2.24.1.735.g03f4e72817-goog
Dmitry Vyukov
reviewerRe: [PATCH RFC 1/2] kcov: collect coverage from interrupts
Quoted 574 lines · Dmitry Vyukov
Quoted 106 lines · Andrey Konovalov
This change extends kcov remote coverage support to allow collecting coverage from interrupts in addition to kernel background threads.
To collect coverage from code that is executed in interrupt context, a part of that code has to be annotated with kcov_remote_start/stop() in a similar way as how it is done for global kernel background threads. Then the handle used for the annotations has to be passed to the
KCOV_REMOTE_ENABLEioctl.Internally this patch adjusts the
__sanitizer_cov_trace_pc()compiler inserted callback to not bail out when called from interrupt context. kcov_remote_start/stop() are updated to save/restore the current per task kcov state in a per-cpu area (in case the interrupt came when the kernel was already collecting coverage in task context). Coverage from interrupts is collected into pre-allocated per-cpu areas, whose size is controlled by the newCONFIG_KCOV_IRQ_AREA_SIZE.This patch also cleans up some of kcov debug messages.
Signed-off-by Andrey Konovalov <[email protected]>--- Documentation/dev-tools/kcov.rst | 16 +-- drivers/usb/gadget/udc/dummy_hcd.c | 1 + include/linux/sched.h | 3 + kernel/kcov.c | 196 +++++++++++++++++++---------- lib/Kconfig.debug | 9 ++ 5 files changed, 154 insertions(+), 71 deletions(-)Documentation/dev-tools/kcov.rst +8
-8@@ -217,14 +217,14 @@ This allows to collect coverage from two types of kernel background threads: the global ones, that are spawned during kernel boot in a limited number of instances (e.g. one USB hub_event() worker thread is spawned per USB HCD); and the local ones, that are spawned when a user interacts with -some kernel interface (e.g. vhost workers). +some kernel interface (e.g. vhost workers); as well as from interrupts. -To enable collecting coverage from a global background thread, a unique -global handle must be assigned and passed to the corresponding -kcov_remote_start() call. Then a userspace process can pass a list of such -handles to the KCOV_REMOTE_ENABLE ioctl in the handles array field of the -kcov_remote_arg struct. This will attach the used kcov device to the code -sections, that are referenced by those handles. +To enable collecting coverage from a global background thread or from an +interrupt, a unique global handle must be assigned and passed to the +corresponding kcov_remote_start() call. Then a userspace process can pass +a list of such handles to the KCOV_REMOTE_ENABLE ioctl in the handles +array field of the kcov_remote_arg struct. This will attach the used kcov +device to the code sections, that are referenced by those handles. Since there might be many local background threads spawned from different userspace processes, we can't use a single global handle per annotation.@@ -242,7 +242,7 @@ handles as they don't belong to a particular subsystem. The bytes 4-7 are currently reserved and must be zero. In the future the number of bytes used for the subsystem or handle ids might be increased. -When a particular userspace proccess collects coverage by via a common +When a particular userspace proccess collects coverage via a common handle, kcov will collect coverage for each code section that is annotated to use the common handle obtained as kcov_handle from the current task_struct. However non common handles allow to collect coveragedrivers/usb/gadget/udc/dummy_hcd.c +1
-0@@ -38,6 +38,7 @@#include <linux/usb/gadget.h> #include <linux/usb/hcd.h> #include <linux/scatterlist.h> +#include <linux/kcov.h> #include <asm/byteorder.h> #include <linux/io.h> include/linux/sched.h +3
-0@@ -1229,6 +1229,9 @@ struct task_struct {/* KCOV sequence number: */ int kcov_sequence; + +/* Collect coverage from interrupt context: */ +bool kcov_interrupt;#endif #ifdef CONFIG_MEMCG kernel/kcov.c +1
-0@@ -26,6 +26,7 @@#include <asm/setup.h> #define kcov_debug (fmt, ...) pr_debug("%s: " fmt, __func__, ##__VA_ARGS__) +#define kcov_err (fmt, ...) pr_err("%s: " fmt, __func__, ##__VA_ARGS__)/* Number of 64-bit words written per one comparison: */ #define KCOV_WORDS_PER_CMP 4@@ -86,6 +87,17 @@ static DEFINE_SPINLOCK(kcov_remote_lock); static DEFINE_HASHTABLE(kcov_remote_map, 4);static struct list_head kcov_remote_areas =LIST_HEAD_INIT (kcov_remote_areas);kernel/kcov.c static DEFINE_SPINLOCK(kcov_remote_lock); · line 99
Quoted 10 lines
kernel/kcov.c +10
-0+struct kcov_remote_irq_data { +unsigned int mode; +unsigned int size; +void *area; +struct kcov *kcov; +unsigned long flags; +}; + +DEFINE_PER_CPU(struct kcov_remote_irq_data, kcov_remote_irq); +DEFINE_PER_CPU(void *, kcov_irq_area);I would combine these 2 vars together.
Eachkcov_remote_irq_datafield andkcov_irq_areaare all various bits of kcov irq-related state. Little point in separating them into 2 per-cpu variables. What may help is better names, e.g. what's the difference between kcov_remote_irq.area andkcov_irq_area? I would understand ifkcov_remote_irqwould only be used inkcov_remote_swap_irqas current task save area, but flags already don't belong to this category.Quoted 294 lines
kernel/kcov.c +38
-37+/* Must be called with kcov_remote_lock locked. */ static struct kcov_remote *kcov_remote_find (u64 handle) {@@ -98,6 +110,7 @@ static struct kcov_remote *kcov_remote_find(u64 handle)return NULL ; } +/* Must be called with kcov_remote_lock locked. */ static struct kcov_remote *kcov_remote_add (struct kcov *kcov,u64 handle) {struct kcov_remote *remote;@@ -119,16 +132,13 @@ static struct kcov_remote_area *kcov_remote_area_get(unsigned int size)struct kcov_remote_area *area;struct list_head *pos; -kcov_debug ("size = %u\n" , size);list_for_each (pos, &kcov_remote_areas) { area = list_entry(pos, struct kcov_remote_area, list);if (area->size == size) {list_del (&area->list); -kcov_debug ("rv = %px\n" , area);return area; } } -kcov_debug ("rv = NULL\n" );return NULL ; }@@ -136,7 +146,6 @@ static struct kcov_remote_area *kcov_remote_area_get(unsigned int size)static void kcov_remote_area_put (struct kcov_remote_area *area,unsigned int size) { -kcov_debug ("area = %px, size = %u\n" , area, size);INIT_LIST_HEAD (&area->list); area->size = size;list_add (&area->list, &kcov_remote_areas);@@ -148,9 +157,11 @@ static notrace bool check_kcov_mode(enum kcov_mode needed_mode, struct task_stru/* * We are interested in code coverage as a function of a syscall inputs, -* so we ignore code executed in interrupts. +* so we ignore code executed in interrupts, unless we are in a remote +* coverage collection section happening in an interrupt, which is +* indicated by the t->kcov_interrupt flag. */ -if (!in_task ()) +if (!in_task () && !t->kcov_interrupt)return false; mode =READ_ONCE (t->kcov_mode);/* @@ -331,12 +342,12 @@ static void kcov_stop(struct task_struct *t)barrier (); t->kcov_size =0 ; t->kcov_area =NULL ; + t->kcov =NULL ; }static void kcov_task_reset (struct task_struct *t) {kcov_stop (t); - t->kcov =NULL ; t->kcov_sequence =0 ; t->kcov_handle =0 ; }@@ -361,18 +372,18 @@ static void kcov_remote_reset(struct kcov *kcov)int bkt;struct kcov_remote *remote;struct hlist_node *tmp; +unsigned long flags; -spin_lock (&kcov_remote_lock); +spin_lock_irqsave (&kcov_remote_lock, flags);hash_for_each_safe (kcov_remote_map, bkt, tmp, remote, hnode) {if (remote->kcov != kcov)continue ; -kcov_debug ("removing handle %llx\n" , remote->handle);hash_del (&remote->hnode);kfree (remote); }/* Do reset before unlock to prevent races with kcov_remote_start(). */ kcov_reset (kcov); -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, flags); }static void kcov_disable (struct task_struct *t,struct kcov *kcov)@@ -401,12 +412,13 @@ static void kcov_put(struct kcov *kcov)void kcov_task_exit (struct task_struct *t) {struct kcov *kcov; +unsigned long flags; kcov = t->kcov;if (kcov ==NULL )return ; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags);kcov_debug ("t = %px, kcov->t = %px\n" , t, kcov->t);/* * For KCOV_ENABLE devices we want to make sure that t->kcov->t == t, @@ -430,12 +442,12 @@ void kcov_task_exit(struct task_struct *t)* By combining all three checks into one we get: */ if (WARN_ON (kcov->t != t)) { -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);return ; }/* Just to not leave dangling references behind. */ kcov_disable (t, kcov); -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);kcov_put (kcov); }@@ -446,12 +458,13 @@ static int kcov_mmap(struct file *filep, struct vm_area_struct *vma)struct kcov *kcov = vma->vm_file->private_data;unsigned long size, off;struct page *page; +unsigned long flags; area =vmalloc_user (vma->vm_end - vma->vm_start);if (!area)return -ENOMEM ; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags); size = kcov->size *sizeof (unsigned long );if (kcov->mode !=KCOV_MODE_INIT || vma->vm_pgoff !=0 || vma->vm_end - vma->vm_start != size) {@@ -461,7 +474,7 @@ static int kcov_mmap(struct file *filep, struct vm_area_struct *vma)if (!kcov->area) { kcov->area = area; vma->vm_flags |=VM_DONTEXPAND ; -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);for (off =0 ; off < size; off +=PAGE_SIZE ) { page =vmalloc_to_page (kcov->area + off);if (vm_insert_page (vma, vma->vm_start + off, page))@@ -470,7 +483,7 @@ static int kcov_mmap(struct file *filep, struct vm_area_struct *vma)return 0 ; } exit: -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);vfree (area);return res; }@@ -550,10 +563,10 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd,int mode, i;struct kcov_remote_arg *remote_arg;struct kcov_remote *remote; +unsigned long flags;switch (cmd) {case KCOV_INIT_TRACE : -kcov_debug ("KCOV_INIT_TRACE\n" );/* * Enable kcov in trace mode and setup buffer size. * Must happen before anything else. @@ -572,7 +585,6 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd, kcov->mode =KCOV_MODE_INIT ;return 0 ;case KCOV_ENABLE : -kcov_debug ("KCOV_ENABLE\n" );/* * Enable coverage for the current task. * At this point user must have been enabled trace mode, @@ -598,7 +610,6 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd,kcov_get (kcov);return 0 ;case KCOV_DISABLE : -kcov_debug ("KCOV_DISABLE\n" );/* Disable coverage for the current task. */ unused = arg;if (unused !=0 || current->kcov != kcov)@@ -610,7 +621,6 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd,kcov_put (kcov);return 0 ;case KCOV_REMOTE_ENABLE : -kcov_debug ("KCOV_REMOTE_ENABLE\n" );if (kcov->mode !=KCOV_MODE_INIT || !kcov->area)return -EINVAL ; t = current;@@ -627,41 +637,42 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd, kcov->t = t; kcov->remote = true; kcov->remote_size = remote_arg->area_size; -spin_lock (&kcov_remote_lock); +spin_lock_irqsave (&kcov_remote_lock, flags);for (i =0 ; i < remote_arg->num_handles; i++) { -kcov_debug ("handle %llx\n" , remote_arg->handles[i]);if (!kcov_check_handle (remote_arg->handles[i], false, true, false)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return -EINVAL ; } remote =kcov_remote_add (kcov, remote_arg->handles[i]);if (IS_ERR (remote)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return PTR_ERR (remote); } }if (remote_arg->common_handle) { -kcov_debug ("common handle %llx\n" , - remote_arg->common_handle);if (!kcov_check_handle (remote_arg->common_handle, true, false, false)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return -EINVAL ; } remote =kcov_remote_add (kcov, remote_arg->common_handle);if (IS_ERR (remote)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return PTR_ERR (remote); } t->kcov_handle = remote_arg->common_handle; } -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, flags);/* Put either in kcov_task_exit() or in KCOV_DISABLE. */ kcov_get (kcov);return 0 ;@@ -677,6 +688,7 @@ static long kcov_ioctl(struct file *filep, unsigned int cmd, unsigned long arg)struct kcov_remote_arg *remote_arg =NULL ;unsigned int remote_num_handles;unsigned long remote_arg_size; +unsigned long flags;if (cmd ==KCOV_REMOTE_ENABLE ) { if (get_user(remote_num_handles, (unsigned __user *)(arg +@@ -697,9 +709,9 @@ static long kcov_ioctl(struct file *filep, unsigned int cmd, unsigned long arg) } kcov = filep->private_data; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags); res =kcov_ioctl_locked (kcov, cmd, arg); -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);kfree (remote_arg);@@ -716,8 +728,8 @@ static const struct file_operations kcov_fops = {/* * kcov_remote_start() and kcov_remote_stop() can be used to annotate a section -* of code in a kernel background thread to allow kcov to be used to collect -* coverage from that part of code. +* of code in a kernel background thread or in an interrupt to allow kcov to be +* used to collect coverage from that part of code. * * The handle argument of kcov_remote_start() identifies a code section that is * used for coverage collection. A userspace process passes this handle to @@ -728,9 +740,9 @@ static const struct file_operations kcov_fops = {* the type of the kernel thread whose code is being annotated. * * For global kernel threads that are spawned in a limited number of instances -* (e.g. one USB hub_event() worker thread is spawned per USB HCD), each -* instance must be assigned a unique 4-byte instance id. The instance id is -* then combined with a 1-byte subsystem id to get a handle via +* (e.g. one USB hub_event() worker thread is spawned per USB HCD) and for +* interrupts, each instance must be assigned a unique 4-byte instance id. The +* instance id is then combined with a 1-byte subsystem id to get a handle via * kcov_remote_handle(subsystem_id, instance_id). * * For local kernel threads that are spawned from system calls handler when a @@ -749,13 +761,48 @@ static const struct file_operations kcov_fops = {* * See Documentation/dev-tools/kcov.rst for more details. * -* Internally, this function looks up the kcov device associated with the +* Internally, kcov_remote_start() looks up the kcov device associated with the * provided handle, allocates an area for coverage collection, and saves the * pointers to kcov and area into the current task_struct to allow coverage to * be collected via __sanitizer_cov_trace_pc() * In turns kcov_remote_stop() clears those pointers from task_struct to stop * collecting coverage and copies all collected coverage into the kcov area. */ kernel/kcov.c static const struct file_operations kcov_fops = { · line 780
Quoted 10 lines
kernel/kcov.c +8
-0+ +void kcov_remote_swap_irq (struct task_struct *t, +struct kcov_remote_irq_data *irq) +{ + t->kcov =xchg (&irq->kcov, t->kcov); + t->kcov_size =xchg (&irq->size, t->kcov_size); + t->kcov_area =xchg (&irq->area, t->kcov_area); + t->kcov_mode =xchg (&irq->mode, t->kcov_mode);Do we need these xchg here? Why?
They look fishy. If somebody actually uses these fields concurrently, then they can get inconsistent kcov_area/size/mode, which will explode badly (overwrite beyond area). So these field atomic updates only seem to give a false sense of safety.
If nobody uses this, then no need in atomic updates.
If somebody uses this, atomic updates won't help.kernel/kcov.c static const struct file_operations kcov_fops = { · line 783
Quoted 5 lines
kernel/kcov.c +5
-0+} + +bool kcov_remote_start_irq (struct task_struct *t) +{ +struct kcov_remote_irq_data *irq = &get_cpu_var (kcov_remote_irq);We are already (1) in interrupt and (2) inside of
spin_lock_irqsave, and we seem to rely on that below when we do non-atomic xchg ont->kcov_interrupt. Do we need get/put_cpu_var here? It seems usingthis_cpu_ptrwill make it simpler.kernel/kcov.c static const struct file_operations kcov_fops = { · line 790
Quoted 7 lines
kernel/kcov.c +7
-0+ +if (t->kcov_interrupt) { +/* Nested interrupt. */ +put_cpu_var (kcov_remote_irq); +return false; + } + t->kcov_interrupt = true;I can't fully understand what happens with nested interrupts. We very much rely on the fact that we disabled interrupts for the whole traced region.
But what happens with NMIs? Let's say nmi arrives when we sett->kcov_interrupt= true but did not executekcov_remote_swap_irqyet (or worse, in the middle ofkcov_remote_swap_irq)?kernel/kcov.c static const struct file_operations kcov_fops = { · line 800
Quoted 10 lines
kernel/kcov.c +10
-0+kcov_remote_swap_irq (t, irq); +put_cpu_var (kcov_remote_irq); +return true; +} + +void kcov_remote_stop_irq (struct task_struct *t) +{ +struct kcov_remote_irq_data *irq = &get_cpu_var (kcov_remote_irq); + +kcov_remote_swap_irq (t, irq);What is an NMI arrives while we are swapping?
kernel/kcov.c static const struct file_operations kcov_fops = { · line 802
Quoted 2 lines
kernel/kcov.c +2
-0+ t->kcov_interrupt = false; +local_irq_restore (irq->flags);Interesting. Is it OK to prolong irq disabling region that much?...
Quoted 49 lines
kernel/kcov.c +3
-0+put_cpu_var (kcov_remote_irq); +} +void kcov_remote_start (u64 handle){ struct kcov_remote *remote;kernel/kcov.c +13
-9@@ -764,28 +811,32 @@ void kcov_remote_start(u64 handle)unsigned int size;enum kcov_mode mode;int sequence; +unsigned long flags;if (WARN_ON (!kcov_check_handle (handle, true, true, true)))return ; -if (WARN_ON (!in_task ())) +if (WARN_ON (in_nmi ()))return ; t = current;/* -* Check that kcov_remote_start is not called twice -* nor called by user tasks (with enabled kcov). +* Check that kcov_remote_start is not called twice in background +* threads nor called by user tasks (with enabled kcov). */ -if (WARN_ON (t->kcov)) +if (WARN_ON (in_task () && t->kcov))return ; -kcov_debug ("handle = %llx\n" , handle); - -spin_lock (&kcov_remote_lock); +spin_lock_irqsave (&kcov_remote_lock, flags); remote =kcov_remote_find (handle);if (!remote) { -kcov_debug ("no remote found" ); -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, flags);return ; } +if (!in_task () && !kcov_remote_start_irq (t)) { +spin_unlock_irqrestore (&kcov_remote_lock, flags); +return ; + } +kcov_debug ("handle = %llx, context: %s\n" , handle, +in_task () ?"task" :"irq" );/* Put in kcov_remote_stop(). */ kcov_get (remote->kcov); t->kcov = remote->kcov;kernel/kcov.c void kcov_remote_start(u64 handle) · line 848
Quoted 6 lines
kernel/kcov.c +2
-1@@ -793,11 +844,19 @@ void kcov_remote_start(u64 handle)* Read kcov fields before unlock to prevent races with * KCOV_DISABLE / kcov_remote_reset(). */ - size = remote->kcov->remote_size; + size = min_t(unsigned int, remote->kcov->remote_size, +CONFIG_KCOV_IRQ_AREA_SIZE );This seems to only be relevant for the irq case.
Quoted 6 lines
kernel/kcov.c +2
-2mode = remote->kcov->mode; sequence = remote->kcov->sequence; - area =kcov_remote_area_get (size); -spin_unlock (&kcov_remote_lock); +if (in_task ()) { + area =kcov_remote_area_get (size);kernel/kcov.c void kcov_remote_start(u64 handle) · line 862
Quoted 10 lines
kernel/kcov.c +7
-0+spin_unlock_irqrestore (&kcov_remote_lock, flags); + }else { + area = *this_cpu_ptr (&kcov_irq_area); +/* Flags are restored by kcov_remote_stop_irq(). */ +this_cpu_ptr (&kcov_remote_irq)->flags = flags; +spin_unlock (&kcov_remote_lock); + }if (!area) { area =vmalloc (size *sizeof (unsigned long ));And this only for the !irq case, so may be better to move inside of the if above to not confuse the reader.
Quoted 4 lines
kernel/kcov.c +0
-0@@ -810,8 +869,6 @@ void kcov_remote_start(u64 handle)/* Reset coverage size. */ *(u64 *)area =0 ;
Quoted 5 lines
kernel/kcov.c void kcov_remote_start(u64 handle) · line 872
Quoted 3 lines
kernel/kcov.c +0
-2-kcov_debug ("area = %px, size = %u" , area, size); -kcov_start (t, size, area, mode, sequence);Don't we overwrite and lose the original
t->kcov_sequencehere?
Overall it may benefit from more explicitly writing down exact sequence of changes that happens with task state during start/stop. We try to reuse some code in kcov_remote_swap_irq, but it confused me a lot initially until I realized that we don't actually swap and that rather save and restore.
We either need to rely on kcov_interrupt to start/stop tracing, but then carefully arrange memory accesses in kcov_remote_start_irq/stop_irq as we do in kcov_start/stop; or maybe play by the rules and call kcov_stop on the current task, update state, call kcov_start with interrupt state and do the opposite when we stop irq tracing.
Dmitry Vyukov
reviewerRe: [PATCH RFC 1/2] kcov: collect coverage from interrupts
In reply to Andrey KonovalovQuoted 553 lines · Andrey Konovalov
This change extends kcov remote coverage support to allow collecting coverage from interrupts in addition to kernel background threads.
To collect coverage from code that is executed in interrupt context, a part of that code has to be annotated with kcov_remote_start/stop() in a similar way as how it is done for global kernel background threads. Then the handle used for the annotations has to be passed to the
KCOV_REMOTE_ENABLEioctl.Internally this patch adjusts the
__sanitizer_cov_trace_pc()compiler inserted callback to not bail out when called from interrupt context. kcov_remote_start/stop() are updated to save/restore the current per task kcov state in a per-cpu area (in case the interrupt came when the kernel was already collecting coverage in task context). Coverage from interrupts is collected into pre-allocated per-cpu areas, whose size is controlled by the newCONFIG_KCOV_IRQ_AREA_SIZE.This patch also cleans up some of kcov debug messages.
Signed-off-by Andrey Konovalov <[email protected]>--- Documentation/dev-tools/kcov.rst | 16 +-- drivers/usb/gadget/udc/dummy_hcd.c | 1 + include/linux/sched.h | 3 + kernel/kcov.c | 196 +++++++++++++++++++---------- lib/Kconfig.debug | 9 ++ 5 files changed, 154 insertions(+), 71 deletions(-)Documentation/dev-tools/kcov.rst +8
-8@@ -217,14 +217,14 @@ This allows to collect coverage from two types of kernel background threads: the global ones, that are spawned during kernel boot in a limited number of instances (e.g. one USB hub_event() worker thread is spawned per USB HCD); and the local ones, that are spawned when a user interacts with -some kernel interface (e.g. vhost workers). +some kernel interface (e.g. vhost workers); as well as from interrupts. -To enable collecting coverage from a global background thread, a unique -global handle must be assigned and passed to the corresponding -kcov_remote_start() call. Then a userspace process can pass a list of such -handles to the KCOV_REMOTE_ENABLE ioctl in the handles array field of the -kcov_remote_arg struct. This will attach the used kcov device to the code -sections, that are referenced by those handles. +To enable collecting coverage from a global background thread or from an +interrupt, a unique global handle must be assigned and passed to the +corresponding kcov_remote_start() call. Then a userspace process can pass +a list of such handles to the KCOV_REMOTE_ENABLE ioctl in the handles +array field of the kcov_remote_arg struct. This will attach the used kcov +device to the code sections, that are referenced by those handles. Since there might be many local background threads spawned from different userspace processes, we can't use a single global handle per annotation.@@ -242,7 +242,7 @@ handles as they don't belong to a particular subsystem. The bytes 4-7 are currently reserved and must be zero. In the future the number of bytes used for the subsystem or handle ids might be increased. -When a particular userspace proccess collects coverage by via a common +When a particular userspace proccess collects coverage via a common handle, kcov will collect coverage for each code section that is annotated to use the common handle obtained as kcov_handle from the current task_struct. However non common handles allow to collect coveragedrivers/usb/gadget/udc/dummy_hcd.c +1
-0@@ -38,6 +38,7 @@#include <linux/usb/gadget.h> #include <linux/usb/hcd.h> #include <linux/scatterlist.h> +#include <linux/kcov.h> #include <asm/byteorder.h> #include <linux/io.h> include/linux/sched.h +3
-0@@ -1229,6 +1229,9 @@ struct task_struct {/* KCOV sequence number: */ int kcov_sequence; + +/* Collect coverage from interrupt context: */ +bool kcov_interrupt;#endif #ifdef CONFIG_MEMCG kernel/kcov.c +113
-62@@ -26,6 +26,7 @@#include <asm/setup.h> #define kcov_debug (fmt, ...) pr_debug("%s: " fmt, __func__, ##__VA_ARGS__) +#define kcov_err (fmt, ...) pr_err("%s: " fmt, __func__, ##__VA_ARGS__)/* Number of 64-bit words written per one comparison: */ #define KCOV_WORDS_PER_CMP 4@@ -86,6 +87,17 @@ static DEFINE_SPINLOCK(kcov_remote_lock); static DEFINE_HASHTABLE(kcov_remote_map, 4);static struct list_head kcov_remote_areas =LIST_HEAD_INIT (kcov_remote_areas); +struct kcov_remote_irq_data { +unsigned int mode; +unsigned int size; +void *area; +struct kcov *kcov; +unsigned long flags; +}; + +DEFINE_PER_CPU(struct kcov_remote_irq_data, kcov_remote_irq); +DEFINE_PER_CPU(void *, kcov_irq_area); +/* Must be called with kcov_remote_lock locked. */ static struct kcov_remote *kcov_remote_find (u64 handle) {@@ -98,6 +110,7 @@ static struct kcov_remote *kcov_remote_find(u64 handle)return NULL ; } +/* Must be called with kcov_remote_lock locked. */ static struct kcov_remote *kcov_remote_add (struct kcov *kcov,u64 handle) {struct kcov_remote *remote;@@ -119,16 +132,13 @@ static struct kcov_remote_area *kcov_remote_area_get(unsigned int size)struct kcov_remote_area *area;struct list_head *pos; -kcov_debug ("size = %u\n" , size);list_for_each (pos, &kcov_remote_areas) { area = list_entry(pos, struct kcov_remote_area, list);if (area->size == size) {list_del (&area->list); -kcov_debug ("rv = %px\n" , area);return area; } } -kcov_debug ("rv = NULL\n" );return NULL ; }@@ -136,7 +146,6 @@ static struct kcov_remote_area *kcov_remote_area_get(unsigned int size)static void kcov_remote_area_put (struct kcov_remote_area *area,unsigned int size) { -kcov_debug ("area = %px, size = %u\n" , area, size);INIT_LIST_HEAD (&area->list); area->size = size;list_add (&area->list, &kcov_remote_areas);@@ -148,9 +157,11 @@ static notrace bool check_kcov_mode(enum kcov_mode needed_mode, struct task_stru/* * We are interested in code coverage as a function of a syscall inputs, -* so we ignore code executed in interrupts. +* so we ignore code executed in interrupts, unless we are in a remote +* coverage collection section happening in an interrupt, which is +* indicated by the t->kcov_interrupt flag. */ -if (!in_task ()) +if (!in_task () && !t->kcov_interrupt)return false; mode =READ_ONCE (t->kcov_mode);/* @@ -331,12 +342,12 @@ static void kcov_stop(struct task_struct *t)barrier (); t->kcov_size =0 ; t->kcov_area =NULL ; + t->kcov =NULL ; }static void kcov_task_reset (struct task_struct *t) {kcov_stop (t); - t->kcov =NULL ; t->kcov_sequence =0 ; t->kcov_handle =0 ; }@@ -361,18 +372,18 @@ static void kcov_remote_reset(struct kcov *kcov)int bkt;struct kcov_remote *remote;struct hlist_node *tmp; +unsigned long flags; -spin_lock (&kcov_remote_lock); +spin_lock_irqsave (&kcov_remote_lock, flags);hash_for_each_safe (kcov_remote_map, bkt, tmp, remote, hnode) {if (remote->kcov != kcov)continue ; -kcov_debug ("removing handle %llx\n" , remote->handle);hash_del (&remote->hnode);kfree (remote); }/* Do reset before unlock to prevent races with kcov_remote_start(). */ kcov_reset (kcov); -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, flags); }static void kcov_disable (struct task_struct *t,struct kcov *kcov)@@ -401,12 +412,13 @@ static void kcov_put(struct kcov *kcov)void kcov_task_exit (struct task_struct *t) {struct kcov *kcov; +unsigned long flags; kcov = t->kcov;if (kcov ==NULL )return ; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags);kcov_debug ("t = %px, kcov->t = %px\n" , t, kcov->t);/* * For KCOV_ENABLE devices we want to make sure that t->kcov->t == t, @@ -430,12 +442,12 @@ void kcov_task_exit(struct task_struct *t)* By combining all three checks into one we get: */ if (WARN_ON (kcov->t != t)) { -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);return ; }/* Just to not leave dangling references behind. */ kcov_disable (t, kcov); -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);kcov_put (kcov); }@@ -446,12 +458,13 @@ static int kcov_mmap(struct file *filep, struct vm_area_struct *vma)struct kcov *kcov = vma->vm_file->private_data;unsigned long size, off;struct page *page; +unsigned long flags; area =vmalloc_user (vma->vm_end - vma->vm_start);if (!area)return -ENOMEM ; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags); size = kcov->size *sizeof (unsigned long );if (kcov->mode !=KCOV_MODE_INIT || vma->vm_pgoff !=0 || vma->vm_end - vma->vm_start != size) {@@ -461,7 +474,7 @@ static int kcov_mmap(struct file *filep, struct vm_area_struct *vma)if (!kcov->area) { kcov->area = area; vma->vm_flags |=VM_DONTEXPAND ; -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);for (off =0 ; off < size; off +=PAGE_SIZE ) { page =vmalloc_to_page (kcov->area + off);if (vm_insert_page (vma, vma->vm_start + off, page))@@ -470,7 +483,7 @@ static int kcov_mmap(struct file *filep, struct vm_area_struct *vma)return 0 ; } exit: -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);vfree (area);return res; }@@ -550,10 +563,10 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd,int mode, i;struct kcov_remote_arg *remote_arg;struct kcov_remote *remote; +unsigned long flags;switch (cmd) {case KCOV_INIT_TRACE : -kcov_debug ("KCOV_INIT_TRACE\n" );/* * Enable kcov in trace mode and setup buffer size. * Must happen before anything else. @@ -572,7 +585,6 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd, kcov->mode =KCOV_MODE_INIT ;return 0 ;case KCOV_ENABLE : -kcov_debug ("KCOV_ENABLE\n" );/* * Enable coverage for the current task. * At this point user must have been enabled trace mode, @@ -598,7 +610,6 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd,kcov_get (kcov);return 0 ;case KCOV_DISABLE : -kcov_debug ("KCOV_DISABLE\n" );/* Disable coverage for the current task. */ unused = arg;if (unused !=0 || current->kcov != kcov)@@ -610,7 +621,6 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd,kcov_put (kcov);return 0 ;case KCOV_REMOTE_ENABLE : -kcov_debug ("KCOV_REMOTE_ENABLE\n" );if (kcov->mode !=KCOV_MODE_INIT || !kcov->area)return -EINVAL ; t = current;@@ -627,41 +637,42 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd, kcov->t = t; kcov->remote = true; kcov->remote_size = remote_arg->area_size; -spin_lock (&kcov_remote_lock); +spin_lock_irqsave (&kcov_remote_lock, flags);for (i =0 ; i < remote_arg->num_handles; i++) { -kcov_debug ("handle %llx\n" , remote_arg->handles[i]);if (!kcov_check_handle (remote_arg->handles[i], false, true, false)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return -EINVAL ; } remote =kcov_remote_add (kcov, remote_arg->handles[i]);if (IS_ERR (remote)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return PTR_ERR (remote); } }if (remote_arg->common_handle) { -kcov_debug ("common handle %llx\n" , - remote_arg->common_handle);if (!kcov_check_handle (remote_arg->common_handle, true, false, false)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return -EINVAL ; } remote =kcov_remote_add (kcov, remote_arg->common_handle);if (IS_ERR (remote)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return PTR_ERR (remote); } t->kcov_handle = remote_arg->common_handle; } -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, flags);/* Put either in kcov_task_exit() or in KCOV_DISABLE. */ kcov_get (kcov);return 0 ;@@ -677,6 +688,7 @@ static long kcov_ioctl(struct file *filep, unsigned int cmd, unsigned long arg)struct kcov_remote_arg *remote_arg =NULL ;unsigned int remote_num_handles;unsigned long remote_arg_size; +unsigned long flags;if (cmd ==KCOV_REMOTE_ENABLE ) { if (get_user(remote_num_handles, (unsigned __user *)(arg +@@ -697,9 +709,9 @@ static long kcov_ioctl(struct file *filep, unsigned int cmd, unsigned long arg) } kcov = filep->private_data; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags); res =kcov_ioctl_locked (kcov, cmd, arg); -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);kfree (remote_arg);@@ -716,8 +728,8 @@ static const struct file_operations kcov_fops = {/* * kcov_remote_start() and kcov_remote_stop() can be used to annotate a section -* of code in a kernel background thread to allow kcov to be used to collect -* coverage from that part of code. +* of code in a kernel background thread or in an interrupt to allow kcov to be +* used to collect coverage from that part of code. * * The handle argument of kcov_remote_start() identifies a code section that is * used for coverage collection. A userspace process passes this handle to @@ -728,9 +740,9 @@ static const struct file_operations kcov_fops = {* the type of the kernel thread whose code is being annotated. * * For global kernel threads that are spawned in a limited number of instances -* (e.g. one USB hub_event() worker thread is spawned per USB HCD), each -* instance must be assigned a unique 4-byte instance id. The instance id is -* then combined with a 1-byte subsystem id to get a handle via +* (e.g. one USB hub_event() worker thread is spawned per USB HCD) and for +* interrupts, each instance must be assigned a unique 4-byte instance id. The +* instance id is then combined with a 1-byte subsystem id to get a handle via * kcov_remote_handle(subsystem_id, instance_id). * * For local kernel threads that are spawned from system calls handler when a @@ -749,13 +761,48 @@ static const struct file_operations kcov_fops = {* * See Documentation/dev-tools/kcov.rst for more details. * -* Internally, this function looks up the kcov device associated with the +* Internally, kcov_remote_start() looks up the kcov device associated with the * provided handle, allocates an area for coverage collection, and saves the * pointers to kcov and area into the current task_struct to allow coverage to * be collected via __sanitizer_cov_trace_pc() * In turns kcov_remote_stop() clears those pointers from task_struct to stop * collecting coverage and copies all collected coverage into the kcov area. */ + +void kcov_remote_swap_irq (struct task_struct *t, +struct kcov_remote_irq_data *irq) +{ + t->kcov =xchg (&irq->kcov, t->kcov); + t->kcov_size =xchg (&irq->size, t->kcov_size); + t->kcov_area =xchg (&irq->area, t->kcov_area); + t->kcov_mode =xchg (&irq->mode, t->kcov_mode); +} + +bool kcov_remote_start_irq (struct task_struct *t) +{ +struct kcov_remote_irq_data *irq = &get_cpu_var (kcov_remote_irq); + +if (t->kcov_interrupt) { +/* Nested interrupt. */ +put_cpu_var (kcov_remote_irq); +return false; + } + t->kcov_interrupt = true; +kcov_remote_swap_irq (t, irq); +put_cpu_var (kcov_remote_irq); +return true; +} + +void kcov_remote_stop_irq (struct task_struct *t) +{ +struct kcov_remote_irq_data *irq = &get_cpu_var (kcov_remote_irq); + +kcov_remote_swap_irq (t, irq); + t->kcov_interrupt = false; +local_irq_restore (irq->flags); +put_cpu_var (kcov_remote_irq); +} +void kcov_remote_start (u64 handle) {struct kcov_remote *remote;@@ -764,28 +811,32 @@ void kcov_remote_start(u64 handle)unsigned int size;enum kcov_mode mode;int sequence; +unsigned long flags;if (WARN_ON (!kcov_check_handle (handle, true, true, true)))return ; -if (WARN_ON (!in_task ())) +if (WARN_ON (in_nmi ()))return ; t = current;/* -* Check that kcov_remote_start is not called twice -* nor called by user tasks (with enabled kcov). +* Check that kcov_remote_start is not called twice in background +* threads nor called by user tasks (with enabled kcov). */ -if (WARN_ON (t->kcov)) +if (WARN_ON (in_task () && t->kcov))return ; -kcov_debug ("handle = %llx\n" , handle); - -spin_lock (&kcov_remote_lock); +spin_lock_irqsave (&kcov_remote_lock, flags); remote =kcov_remote_find (handle);if (!remote) { -kcov_debug ("no remote found" ); -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, flags);return ; } +if (!in_task () && !kcov_remote_start_irq (t)) { +spin_unlock_irqrestore (&kcov_remote_lock, flags); +return ; + } +kcov_debug ("handle = %llx, context: %s\n" , handle, +in_task () ?"task" :"irq" );/* Put in kcov_remote_stop(). */ kcov_get (remote->kcov); t->kcov = remote->kcov;@@ -793,11 +844,19 @@ void kcov_remote_start(u64 handle)* Read kcov fields before unlock to prevent races with * KCOV_DISABLE / kcov_remote_reset(). */ - size = remote->kcov->remote_size; + size = min_t(unsigned int, remote->kcov->remote_size, +CONFIG_KCOV_IRQ_AREA_SIZE ); mode = remote->kcov->mode; sequence = remote->kcov->sequence; - area =kcov_remote_area_get (size); -spin_unlock (&kcov_remote_lock); +if (in_task ()) { + area =kcov_remote_area_get (size); +spin_unlock_irqrestore (&kcov_remote_lock, flags); + }else { + area = *this_cpu_ptr (&kcov_irq_area); +/* Flags are restored by kcov_remote_stop_irq(). */ +this_cpu_ptr (&kcov_remote_irq)->flags = flags; +spin_unlock (&kcov_remote_lock); + }if (!area) { area =vmalloc (size *sizeof (unsigned long ));@@ -810,8 +869,6 @@ void kcov_remote_start(u64 handle)/* Reset coverage size. */ *(u64 *)area =0 ; -kcov_debug ("area = %px, size = %u" , area, size); -kcov_start (t, size, area, mode, sequence); }@@ -880,30 +937,30 @@ void kcov_remote_stop(void)void *area = t->kcov_area;unsigned int size = t->kcov_size;int sequence = t->kcov_sequence; +unsigned long flags; -if (!kcov) { -kcov_debug ("no kcov found\n" ); +if (!kcov)return ; - }kcov_stop (t); - t->kcov =NULL ; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags);/* * KCOV_DISABLE could have been called between kcov_remote_start() -* and kcov_remote_stop(), hence the check. +* and kcov_remote_stop(), hence the sequence check. */ -kcov_debug ("move if: %d == %d && %d\n" , - sequence, kcov->sequence, (int )kcov->remote);if (sequence == kcov->sequence && kcov->remote)kcov_move_area (kcov->mode, kcov->area, kcov->size, area); -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags); -spin_lock (&kcov_remote_lock); -kcov_remote_area_put (area, size);
kernel/kcov.c void kcov_remote_stop(void) · line 964
Quoted 10 lines
kernel/kcov.c +7
-1-spin_unlock (&kcov_remote_lock); +if (in_task ()) { +spin_lock_irqsave (&kcov_remote_lock, flags); +kcov_remote_area_put (area, size); +spin_unlock_irqrestore (&kcov_remote_lock, flags); + }else +kcov_remote_stop_irq (t); +/* Get in kcov_remote_start(). */ kcov_put (kcov);
Is it OK to call kcov_put from interrupts?
Quoted 45 lines
kernel/kcov.c +13
-0}EXPORT_SYMBOL (kcov_remote_stop);@@ -917,6 +974,19 @@ EXPORT_SYMBOL(kcov_common_handle);static int __init kcov_init (void ) { +int cpu; + +for_each_possible_cpu (cpu) { +void **area =per_cpu_ptr (&kcov_irq_area, cpu); + + *area =vmalloc (CONFIG_KCOV_IRQ_AREA_SIZE * +sizeof (unsigned long )); +if (!*area) { +kcov_err ("failed to allocate per-cpu area\n" ); +return -ENOMEM ; + } + } +/* * The kcov debugfs file won't ever get removed and thus, * there is no need to protect it against removal races. The lib/Kconfig.debug +9
-1@@ -1695,6 +1695,15 @@ config KCOV_INSTRUMENT_ALL filesystem fuzzing with AFL) then you will want to enable coverage for more specific subsets of files, and should say n here. +config KCOV_IRQ_AREA_SIZE + hex "Size of interrupt coverage collection area in words" + depends on KCOV + default 0x40000 + help + KCOV uses preallocated per-cpu areas to collect coverage from + interrupts. This specifies the size of those areas in the number + of unsigned long words. + menuconfig RUNTIME_TESTING_MENU bool "Runtime Testing" def_bool y --2.24.1.735.g03f4e72817-goog
Re: [PATCH RFC 1/2] kcov: collect coverage from interrupts
Quoted 563 lines · Dmitry Vyukov
Quoted 561 lines · Andrey Konovalov
This change extends kcov remote coverage support to allow collecting coverage from interrupts in addition to kernel background threads.
To collect coverage from code that is executed in interrupt context, a part of that code has to be annotated with kcov_remote_start/stop() in a similar way as how it is done for global kernel background threads. Then the handle used for the annotations has to be passed to the
KCOV_REMOTE_ENABLEioctl.Internally this patch adjusts the
__sanitizer_cov_trace_pc()compiler inserted callback to not bail out when called from interrupt context. kcov_remote_start/stop() are updated to save/restore the current per task kcov state in a per-cpu area (in case the interrupt came when the kernel was already collecting coverage in task context). Coverage from interrupts is collected into pre-allocated per-cpu areas, whose size is controlled by the newCONFIG_KCOV_IRQ_AREA_SIZE.This patch also cleans up some of kcov debug messages.
Signed-off-by Andrey Konovalov <[email protected]>--- Documentation/dev-tools/kcov.rst | 16 +-- drivers/usb/gadget/udc/dummy_hcd.c | 1 + include/linux/sched.h | 3 + kernel/kcov.c | 196 +++++++++++++++++++---------- lib/Kconfig.debug | 9 ++ 5 files changed, 154 insertions(+), 71 deletions(-)Documentation/dev-tools/kcov.rst +8
-8@@ -217,14 +217,14 @@ This allows to collect coverage from two types of kernel background threads: the global ones, that are spawned during kernel boot in a limited number of instances (e.g. one USB hub_event() worker thread is spawned per USB HCD); and the local ones, that are spawned when a user interacts with -some kernel interface (e.g. vhost workers). +some kernel interface (e.g. vhost workers); as well as from interrupts. -To enable collecting coverage from a global background thread, a unique -global handle must be assigned and passed to the corresponding -kcov_remote_start() call. Then a userspace process can pass a list of such -handles to the KCOV_REMOTE_ENABLE ioctl in the handles array field of the -kcov_remote_arg struct. This will attach the used kcov device to the code -sections, that are referenced by those handles. +To enable collecting coverage from a global background thread or from an +interrupt, a unique global handle must be assigned and passed to the +corresponding kcov_remote_start() call. Then a userspace process can pass +a list of such handles to the KCOV_REMOTE_ENABLE ioctl in the handles +array field of the kcov_remote_arg struct. This will attach the used kcov +device to the code sections, that are referenced by those handles. Since there might be many local background threads spawned from different userspace processes, we can't use a single global handle per annotation.@@ -242,7 +242,7 @@ handles as they don't belong to a particular subsystem. The bytes 4-7 are currently reserved and must be zero. In the future the number of bytes used for the subsystem or handle ids might be increased. -When a particular userspace proccess collects coverage by via a common +When a particular userspace proccess collects coverage via a common handle, kcov will collect coverage for each code section that is annotated to use the common handle obtained as kcov_handle from the current task_struct. However non common handles allow to collect coveragedrivers/usb/gadget/udc/dummy_hcd.c +1
-0@@ -38,6 +38,7 @@#include <linux/usb/gadget.h> #include <linux/usb/hcd.h> #include <linux/scatterlist.h> +#include <linux/kcov.h> #include <asm/byteorder.h> #include <linux/io.h> include/linux/sched.h +3
-0@@ -1229,6 +1229,9 @@ struct task_struct {/* KCOV sequence number: */ int kcov_sequence; + +/* Collect coverage from interrupt context: */ +bool kcov_interrupt;#endif #ifdef CONFIG_MEMCG kernel/kcov.c +119
-63@@ -26,6 +26,7 @@#include <asm/setup.h> #define kcov_debug (fmt, ...) pr_debug("%s: " fmt, __func__, ##__VA_ARGS__) +#define kcov_err (fmt, ...) pr_err("%s: " fmt, __func__, ##__VA_ARGS__)/* Number of 64-bit words written per one comparison: */ #define KCOV_WORDS_PER_CMP 4@@ -86,6 +87,17 @@ static DEFINE_SPINLOCK(kcov_remote_lock); static DEFINE_HASHTABLE(kcov_remote_map, 4);static struct list_head kcov_remote_areas =LIST_HEAD_INIT (kcov_remote_areas); +struct kcov_remote_irq_data { +unsigned int mode; +unsigned int size; +void *area; +struct kcov *kcov; +unsigned long flags; +}; + +DEFINE_PER_CPU(struct kcov_remote_irq_data, kcov_remote_irq); +DEFINE_PER_CPU(void *, kcov_irq_area); +/* Must be called with kcov_remote_lock locked. */ static struct kcov_remote *kcov_remote_find (u64 handle) {@@ -98,6 +110,7 @@ static struct kcov_remote *kcov_remote_find(u64 handle)return NULL ; } +/* Must be called with kcov_remote_lock locked. */ static struct kcov_remote *kcov_remote_add (struct kcov *kcov,u64 handle) {struct kcov_remote *remote;@@ -119,16 +132,13 @@ static struct kcov_remote_area *kcov_remote_area_get(unsigned int size)struct kcov_remote_area *area;struct list_head *pos; -kcov_debug ("size = %u\n" , size);list_for_each (pos, &kcov_remote_areas) { area = list_entry(pos, struct kcov_remote_area, list);if (area->size == size) {list_del (&area->list); -kcov_debug ("rv = %px\n" , area);return area; } } -kcov_debug ("rv = NULL\n" );return NULL ; }@@ -136,7 +146,6 @@ static struct kcov_remote_area *kcov_remote_area_get(unsigned int size)static void kcov_remote_area_put (struct kcov_remote_area *area,unsigned int size) { -kcov_debug ("area = %px, size = %u\n" , area, size);INIT_LIST_HEAD (&area->list); area->size = size;list_add (&area->list, &kcov_remote_areas);@@ -148,9 +157,11 @@ static notrace bool check_kcov_mode(enum kcov_mode needed_mode, struct task_stru/* * We are interested in code coverage as a function of a syscall inputs, -* so we ignore code executed in interrupts. +* so we ignore code executed in interrupts, unless we are in a remote +* coverage collection section happening in an interrupt, which is +* indicated by the t->kcov_interrupt flag. */ -if (!in_task ()) +if (!in_task () && !t->kcov_interrupt)return false; mode =READ_ONCE (t->kcov_mode);/* @@ -331,12 +342,12 @@ static void kcov_stop(struct task_struct *t)barrier (); t->kcov_size =0 ; t->kcov_area =NULL ; + t->kcov =NULL ; }static void kcov_task_reset (struct task_struct *t) {kcov_stop (t); - t->kcov =NULL ; t->kcov_sequence =0 ; t->kcov_handle =0 ; }@@ -361,18 +372,18 @@ static void kcov_remote_reset(struct kcov *kcov)int bkt;struct kcov_remote *remote;struct hlist_node *tmp; +unsigned long flags; -spin_lock (&kcov_remote_lock); +spin_lock_irqsave (&kcov_remote_lock, flags);hash_for_each_safe (kcov_remote_map, bkt, tmp, remote, hnode) {if (remote->kcov != kcov)continue ; -kcov_debug ("removing handle %llx\n" , remote->handle);hash_del (&remote->hnode);kfree (remote); }/* Do reset before unlock to prevent races with kcov_remote_start(). */ kcov_reset (kcov); -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, flags); }static void kcov_disable (struct task_struct *t,struct kcov *kcov)@@ -401,12 +412,13 @@ static void kcov_put(struct kcov *kcov)void kcov_task_exit (struct task_struct *t) {struct kcov *kcov; +unsigned long flags; kcov = t->kcov;if (kcov ==NULL )return ; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags);kcov_debug ("t = %px, kcov->t = %px\n" , t, kcov->t);/* * For KCOV_ENABLE devices we want to make sure that t->kcov->t == t, @@ -430,12 +442,12 @@ void kcov_task_exit(struct task_struct *t)* By combining all three checks into one we get: */ if (WARN_ON (kcov->t != t)) { -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);return ; }/* Just to not leave dangling references behind. */ kcov_disable (t, kcov); -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);kcov_put (kcov); }@@ -446,12 +458,13 @@ static int kcov_mmap(struct file *filep, struct vm_area_struct *vma)struct kcov *kcov = vma->vm_file->private_data;unsigned long size, off;struct page *page; +unsigned long flags; area =vmalloc_user (vma->vm_end - vma->vm_start);if (!area)return -ENOMEM ; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags); size = kcov->size *sizeof (unsigned long );if (kcov->mode !=KCOV_MODE_INIT || vma->vm_pgoff !=0 || vma->vm_end - vma->vm_start != size) {@@ -461,7 +474,7 @@ static int kcov_mmap(struct file *filep, struct vm_area_struct *vma)if (!kcov->area) { kcov->area = area; vma->vm_flags |=VM_DONTEXPAND ; -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);for (off =0 ; off < size; off +=PAGE_SIZE ) { page =vmalloc_to_page (kcov->area + off);if (vm_insert_page (vma, vma->vm_start + off, page))@@ -470,7 +483,7 @@ static int kcov_mmap(struct file *filep, struct vm_area_struct *vma)return 0 ; } exit: -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);vfree (area);return res; }@@ -550,10 +563,10 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd,int mode, i;struct kcov_remote_arg *remote_arg;struct kcov_remote *remote; +unsigned long flags;switch (cmd) {case KCOV_INIT_TRACE : -kcov_debug ("KCOV_INIT_TRACE\n" );/* * Enable kcov in trace mode and setup buffer size. * Must happen before anything else. @@ -572,7 +585,6 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd, kcov->mode =KCOV_MODE_INIT ;return 0 ;case KCOV_ENABLE : -kcov_debug ("KCOV_ENABLE\n" );/* * Enable coverage for the current task. * At this point user must have been enabled trace mode, @@ -598,7 +610,6 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd,kcov_get (kcov);return 0 ;case KCOV_DISABLE : -kcov_debug ("KCOV_DISABLE\n" );/* Disable coverage for the current task. */ unused = arg;if (unused !=0 || current->kcov != kcov)@@ -610,7 +621,6 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd,kcov_put (kcov);return 0 ;case KCOV_REMOTE_ENABLE : -kcov_debug ("KCOV_REMOTE_ENABLE\n" );if (kcov->mode !=KCOV_MODE_INIT || !kcov->area)return -EINVAL ; t = current;@@ -627,41 +637,42 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigned int cmd, kcov->t = t; kcov->remote = true; kcov->remote_size = remote_arg->area_size; -spin_lock (&kcov_remote_lock); +spin_lock_irqsave (&kcov_remote_lock, flags);for (i =0 ; i < remote_arg->num_handles; i++) { -kcov_debug ("handle %llx\n" , remote_arg->handles[i]);if (!kcov_check_handle (remote_arg->handles[i], false, true, false)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return -EINVAL ; } remote =kcov_remote_add (kcov, remote_arg->handles[i]);if (IS_ERR (remote)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return PTR_ERR (remote); } }if (remote_arg->common_handle) { -kcov_debug ("common handle %llx\n" , - remote_arg->common_handle);if (!kcov_check_handle (remote_arg->common_handle, true, false, false)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return -EINVAL ; } remote =kcov_remote_add (kcov, remote_arg->common_handle);if (IS_ERR (remote)) { -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, + flags);kcov_disable (t, kcov);return PTR_ERR (remote); } t->kcov_handle = remote_arg->common_handle; } -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, flags);/* Put either in kcov_task_exit() or in KCOV_DISABLE. */ kcov_get (kcov);return 0 ;@@ -677,6 +688,7 @@ static long kcov_ioctl(struct file *filep, unsigned int cmd, unsigned long arg)struct kcov_remote_arg *remote_arg =NULL ;unsigned int remote_num_handles;unsigned long remote_arg_size; +unsigned long flags;if (cmd ==KCOV_REMOTE_ENABLE ) { if (get_user(remote_num_handles, (unsigned __user *)(arg +@@ -697,9 +709,9 @@ static long kcov_ioctl(struct file *filep, unsigned int cmd, unsigned long arg) } kcov = filep->private_data; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags); res =kcov_ioctl_locked (kcov, cmd, arg); -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags);kfree (remote_arg);@@ -716,8 +728,8 @@ static const struct file_operations kcov_fops = {/* * kcov_remote_start() and kcov_remote_stop() can be used to annotate a section -* of code in a kernel background thread to allow kcov to be used to collect -* coverage from that part of code. +* of code in a kernel background thread or in an interrupt to allow kcov to be +* used to collect coverage from that part of code. * * The handle argument of kcov_remote_start() identifies a code section that is * used for coverage collection. A userspace process passes this handle to @@ -728,9 +740,9 @@ static const struct file_operations kcov_fops = {* the type of the kernel thread whose code is being annotated. * * For global kernel threads that are spawned in a limited number of instances -* (e.g. one USB hub_event() worker thread is spawned per USB HCD), each -* instance must be assigned a unique 4-byte instance id. The instance id is -* then combined with a 1-byte subsystem id to get a handle via +* (e.g. one USB hub_event() worker thread is spawned per USB HCD) and for +* interrupts, each instance must be assigned a unique 4-byte instance id. The +* instance id is then combined with a 1-byte subsystem id to get a handle via * kcov_remote_handle(subsystem_id, instance_id). * * For local kernel threads that are spawned from system calls handler when a @@ -749,13 +761,48 @@ static const struct file_operations kcov_fops = {* * See Documentation/dev-tools/kcov.rst for more details. * -* Internally, this function looks up the kcov device associated with the +* Internally, kcov_remote_start() looks up the kcov device associated with the * provided handle, allocates an area for coverage collection, and saves the * pointers to kcov and area into the current task_struct to allow coverage to * be collected via __sanitizer_cov_trace_pc() * In turns kcov_remote_stop() clears those pointers from task_struct to stop * collecting coverage and copies all collected coverage into the kcov area. */ + +void kcov_remote_swap_irq (struct task_struct *t, +struct kcov_remote_irq_data *irq) +{ + t->kcov =xchg (&irq->kcov, t->kcov); + t->kcov_size =xchg (&irq->size, t->kcov_size); + t->kcov_area =xchg (&irq->area, t->kcov_area); + t->kcov_mode =xchg (&irq->mode, t->kcov_mode); +} + +bool kcov_remote_start_irq (struct task_struct *t) +{ +struct kcov_remote_irq_data *irq = &get_cpu_var (kcov_remote_irq); + +if (t->kcov_interrupt) { +/* Nested interrupt. */ +put_cpu_var (kcov_remote_irq); +return false; + } + t->kcov_interrupt = true; +kcov_remote_swap_irq (t, irq); +put_cpu_var (kcov_remote_irq); +return true; +} + +void kcov_remote_stop_irq (struct task_struct *t) +{ +struct kcov_remote_irq_data *irq = &get_cpu_var (kcov_remote_irq); + +kcov_remote_swap_irq (t, irq); + t->kcov_interrupt = false; +local_irq_restore (irq->flags); +put_cpu_var (kcov_remote_irq); +} +void kcov_remote_start (u64 handle) {struct kcov_remote *remote;@@ -764,28 +811,32 @@ void kcov_remote_start(u64 handle)unsigned int size;enum kcov_mode mode;int sequence; +unsigned long flags;if (WARN_ON (!kcov_check_handle (handle, true, true, true)))return ; -if (WARN_ON (!in_task ())) +if (WARN_ON (in_nmi ()))return ; t = current;/* -* Check that kcov_remote_start is not called twice -* nor called by user tasks (with enabled kcov). +* Check that kcov_remote_start is not called twice in background +* threads nor called by user tasks (with enabled kcov). */ -if (WARN_ON (t->kcov)) +if (WARN_ON (in_task () && t->kcov))return ; -kcov_debug ("handle = %llx\n" , handle); - -spin_lock (&kcov_remote_lock); +spin_lock_irqsave (&kcov_remote_lock, flags); remote =kcov_remote_find (handle);if (!remote) { -kcov_debug ("no remote found" ); -spin_unlock (&kcov_remote_lock); +spin_unlock_irqrestore (&kcov_remote_lock, flags);return ; } +if (!in_task () && !kcov_remote_start_irq (t)) { +spin_unlock_irqrestore (&kcov_remote_lock, flags); +return ; + } +kcov_debug ("handle = %llx, context: %s\n" , handle, +in_task () ?"task" :"irq" );/* Put in kcov_remote_stop(). */ kcov_get (remote->kcov); t->kcov = remote->kcov;@@ -793,11 +844,19 @@ void kcov_remote_start(u64 handle)* Read kcov fields before unlock to prevent races with * KCOV_DISABLE / kcov_remote_reset(). */ - size = remote->kcov->remote_size; + size = min_t(unsigned int, remote->kcov->remote_size, +CONFIG_KCOV_IRQ_AREA_SIZE ); mode = remote->kcov->mode; sequence = remote->kcov->sequence; - area =kcov_remote_area_get (size); -spin_unlock (&kcov_remote_lock); +if (in_task ()) { + area =kcov_remote_area_get (size); +spin_unlock_irqrestore (&kcov_remote_lock, flags); + }else { + area = *this_cpu_ptr (&kcov_irq_area); +/* Flags are restored by kcov_remote_stop_irq(). */ +this_cpu_ptr (&kcov_remote_irq)->flags = flags; +spin_unlock (&kcov_remote_lock); + }if (!area) { area =vmalloc (size *sizeof (unsigned long ));@@ -810,8 +869,6 @@ void kcov_remote_start(u64 handle)/* Reset coverage size. */ *(u64 *)area =0 ; -kcov_debug ("area = %px, size = %u" , area, size); -kcov_start (t, size, area, mode, sequence); }@@ -880,30 +937,30 @@ void kcov_remote_stop(void)void *area = t->kcov_area;unsigned int size = t->kcov_size;int sequence = t->kcov_sequence; +unsigned long flags; -if (!kcov) { -kcov_debug ("no kcov found\n" ); +if (!kcov)return ; - }kcov_stop (t); - t->kcov =NULL ; -spin_lock (&kcov->lock); +spin_lock_irqsave (&kcov->lock, flags);/* * KCOV_DISABLE could have been called between kcov_remote_start() -* and kcov_remote_stop(), hence the check. +* and kcov_remote_stop(), hence the sequence check. */ -kcov_debug ("move if: %d == %d && %d\n" , - sequence, kcov->sequence, (int )kcov->remote);if (sequence == kcov->sequence && kcov->remote)kcov_move_area (kcov->mode, kcov->area, kcov->size, area); -spin_unlock (&kcov->lock); +spin_unlock_irqrestore (&kcov->lock, flags); -spin_lock (&kcov_remote_lock); -kcov_remote_area_put (area, size); -spin_unlock (&kcov_remote_lock); +if (in_task ()) { +spin_lock_irqsave (&kcov_remote_lock, flags); +kcov_remote_area_put (area, size); +spin_unlock_irqrestore (&kcov_remote_lock, flags); + }else +kcov_remote_stop_irq (t);
Quoted 4 lines
kernel/kcov.c void kcov_remote_stop(void) · line 964
Quoted 2 lines
kernel/kcov.c +1
-0+/* Get in kcov_remote_start(). */ kcov_put (kcov);Is it OK to call
kcov_putfrom interrupts?
Yes, both kfree() and vfree() are safe to call in interrupt context AFAIU. I'll fix the rest in the next version. Thanks!
Quoted 46 lines
Quoted 46 lines
kernel/kcov.c +13
-0}EXPORT_SYMBOL (kcov_remote_stop);@@ -917,6 +974,19 @@ EXPORT_SYMBOL(kcov_common_handle);static int __init kcov_init (void ) { +int cpu; + +for_each_possible_cpu (cpu) { +void **area =per_cpu_ptr (&kcov_irq_area, cpu); + + *area =vmalloc (CONFIG_KCOV_IRQ_AREA_SIZE * +sizeof (unsigned long )); +if (!*area) { +kcov_err ("failed to allocate per-cpu area\n" ); +return -ENOMEM ; + } + } +/* * The kcov debugfs file won't ever get removed and thus, * there is no need to protect it against removal races. The lib/Kconfig.debug +9
-1@@ -1695,6 +1695,15 @@ config KCOV_INSTRUMENT_ALL filesystem fuzzing with AFL) then you will want to enable coverage for more specific subsets of files, and should say n here. +config KCOV_IRQ_AREA_SIZE + hex "Size of interrupt coverage collection area in words" + depends on KCOV + default 0x40000 + help + KCOV uses preallocated per-cpu areas to collect coverage from + interrupts. This specifies the size of those areas in the number + of unsigned long words. + menuconfig RUNTIME_TESTING_MENU bool "Runtime Testing" def_bool y --2.24.1.735.g03f4e72817-goog