From nobody Mon Oct 6 01:28:23 2025 Received: from mail-ed1-f73.google.com (mail-ed1-f73.google.com [209.85.208.73]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 86DD82741CE for ; Mon, 28 Jul 2025 15:26:08 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.208.73 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1753716370; cv=none; b=TjLGOo2ICIbIPFOZYD1KpTZ+NmKzkYu//5BcevhCnsZXC8mx88oMYLhzy4jEifnbdzDBHtKnrwKZ4kQKxv2xnRF2K2+1LggEoD+szmB+cL7/AWkjTL3tCnm6VXqfXsxgeXbg1pPgnZQ0+Obxk9ORs1D5vNHnCiYBKfl3mmGPRrc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1753716370; c=relaxed/simple; bh=MaLiA46sivEF5ovv9hlz50NlHkSs2YRFbyGnO20cyTI=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=agF0bGgXMNaYAbMuBXphfe/veugO/eWDQkDpbAZHsaC248G5w6PF6PM3yLojFnL7WTG/Gd/u5YNjIJbBCR793L41+x+LX/dEhw0QHdtLAb0LWUszxUCl6eHqRqGq15jruZn87Tvl2fkj6tQowBIhjMoMuEYJN9oVm8ILHo1AVzk= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--glider.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=aY0Gmr0Q; arc=none smtp.client-ip=209.85.208.73 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--glider.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="aY0Gmr0Q" Received: by mail-ed1-f73.google.com with SMTP id 4fb4d7f45d1cf-615293aeea9so1546621a12.3 for ; Mon, 28 Jul 2025 08:26:08 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1753716367; x=1754321167; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=x81fL8jUmjkAzRsxHSSAhVNkBiMxf9fqzVJGZhSQsxk=; b=aY0Gmr0QMCWBWoe4chYMFDrzd+2iMt+luiFoZ1biiUWDYkAtRN4qRCRUZtJ6gjXkQj C659wwcmYjB3hxiT60GJv/l/RpZp+VogawmOIFrE90AW/vG1Lxc5GaDDiUiSSAkgyMWW Iy6/byL5mUPmRQpS9KQnifJHqRLZr/Y5ODtNsJjGnUYG8DZL7Lidkut1YQEJ+Koc84N1 KZEGJrO9MXvHZ5nmpkPRxpYyE5BsRV8/CNnu0ZSALrXgZwQ4a6RZL5lR99v50eB6KgCs 9I7P0SF/w5//1i781g11icfhA9CrirdPB7C2PoMGDcmlGn16FwlZVcvjbIwuZt9RTYmz Z6WA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1753716367; x=1754321167; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=x81fL8jUmjkAzRsxHSSAhVNkBiMxf9fqzVJGZhSQsxk=; b=tCNnqukoSKLDvp8sDwkdBqSj+2tfFaLmlHWKw302cHt6NKdCMbwDyLSU/0ZfOQ/EAE vb9W+cumRHQHxY55kP/b9Q8scgkfdIEDm0NEud7dUCN2fVXw90C0MRK/uMuRdtsIdyom wz0GO87KdFWLroA2ClVNDPR81L+t8m6n0ZrcmdJ5i8sFaJIuGYbseqxxo5q2UkLb4d8m 8IKo2p11P0pJzHxn+JAxfhwGkB//3xVGCTL/UTFIM8oVuMmWayw/3XJPWZvFr2xoFY1T UyPjBYh7cDKFr6Cc1PbJfh8PbWrbUgcqa8ST5KVskAhNmsPn5bcuxCAvyZRi3XNT2j4k drRg== X-Forwarded-Encrypted: i=1; AJvYcCUxQHUsuJ3FwR9OzWP7vK/N16xCZAORanhdggBVTxmlalZDTrixmbJ5Q9XOKF4dLb+NXEkfPGcG719EI0Y=@vger.kernel.org X-Gm-Message-State: AOJu0YxVve9/o/D4cNa3wkzNRvIoli5mlsBJh0YPQzT+Ym1L17R0NqVt 53I6YwNrSHksfYzJ63mDG9z5EkVZjW2ruqCytxp79VcrRwmeCbWrVuHBe0utNW1Ok2Bn+DE/gnx ApYLtYw== X-Google-Smtp-Source: AGHT+IFLHmGdalewYQBnVMF3u/DjpqVqoFNJ15U8QZHFyuIahsV/7khrSovKQnnZRcEg8mde3IOLLcPioDU= X-Received: from edbdn24.prod.google.com ([2002:a05:6402:22f8:b0:608:89ec:59b3]) (user=glider job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6402:84c:b0:614:f982:6335 with SMTP id 4fb4d7f45d1cf-614f98266b1mr10815929a12.22.1753716365086; Mon, 28 Jul 2025 08:26:05 -0700 (PDT) Date: Mon, 28 Jul 2025 17:25:41 +0200 In-Reply-To: <20250728152548.3969143-1-glider@google.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20250728152548.3969143-1-glider@google.com> X-Mailer: git-send-email 2.50.1.470.g6ba607880d-goog Message-ID: <20250728152548.3969143-4-glider@google.com> Subject: [PATCH v3 03/10] kcov: factor out struct kcov_state From: Alexander Potapenko To: glider@google.com Cc: quic_jiangenj@quicinc.com, linux-kernel@vger.kernel.org, kasan-dev@googlegroups.com, Aleksandr Nogikh , Andrey Konovalov , Borislav Petkov , Dave Hansen , Dmitry Vyukov , Ingo Molnar , Josh Poimboeuf , Marco Elver , Peter Zijlstra , Thomas Gleixner Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Group several kcov-related fields (area, size, sequence) that are stored in various structures, into `struct kcov_state`, so that these fields can be easily passed around and manipulated. Note that now the spinlock in struct kcov applies to every member of struct kcov_state, including the sequence number. This prepares us for the upcoming change that will introduce more kcov state. Also update the MAINTAINERS entry: add include/linux/kcov_types.h, add myself as kcov reviewer. Signed-off-by: Alexander Potapenko Reviewed-by: Dmitry Vyukov --- v3: - fix comments by Dmitry Vyukov: - adjust a comment in sched.h - fix incorrect parameters passed to kcov_start() v2: - add myself to kcov MAINTAINERS - rename kcov-state.h to kcov_types.h - update the description - do not move mode into struct kcov_state - use '{ }' instead of '{ 0 }' Change-Id: If225682ea2f6e91245381b3270de16e7ea40df39 --- MAINTAINERS | 2 + include/linux/kcov.h | 2 +- include/linux/kcov_types.h | 22 ++++++++ include/linux/sched.h | 13 +---- kernel/kcov.c | 112 ++++++++++++++++--------------------- 5 files changed, 77 insertions(+), 74 deletions(-) create mode 100644 include/linux/kcov_types.h diff --git a/MAINTAINERS b/MAINTAINERS index c0b444e5fd5ad..6906eb9d88dae 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -13008,11 +13008,13 @@ F: include/linux/kcore.h KCOV R: Dmitry Vyukov R: Andrey Konovalov +R: Alexander Potapenko L: kasan-dev@googlegroups.com S: Maintained B: https://bugzilla.kernel.org/buglist.cgi?component=3DSanitizers&product= =3DMemory%20Management F: Documentation/dev-tools/kcov.rst F: include/linux/kcov.h +F: include/linux/kcov_types.h F: include/uapi/linux/kcov.h F: kernel/kcov.c F: scripts/Makefile.kcov diff --git a/include/linux/kcov.h b/include/linux/kcov.h index 75a2fb8b16c32..2b3655c0f2278 100644 --- a/include/linux/kcov.h +++ b/include/linux/kcov.h @@ -2,7 +2,7 @@ #ifndef _LINUX_KCOV_H #define _LINUX_KCOV_H =20 -#include +#include #include =20 struct task_struct; diff --git a/include/linux/kcov_types.h b/include/linux/kcov_types.h new file mode 100644 index 0000000000000..53b25b6f0addd --- /dev/null +++ b/include/linux/kcov_types.h @@ -0,0 +1,22 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +#ifndef _LINUX_KCOV_STATE_H +#define _LINUX_KCOV_STATE_H + +#ifdef CONFIG_KCOV +/* See kernel/kcov.c for more details. */ +struct kcov_state { + /* Size of the area (in long's). */ + unsigned int size; + + /* Buffer for coverage collection, shared with the userspace. */ + void *area; + + /* + * KCOV sequence number: incremented each time kcov is reenabled, used + * by kcov_remote_stop(), see the comment there. + */ + int sequence; +}; +#endif /* CONFIG_KCOV */ + +#endif /* _LINUX_KCOV_STATE_H */ diff --git a/include/linux/sched.h b/include/linux/sched.h index aa9c5be7a6325..7901fece5aba3 100644 --- a/include/linux/sched.h +++ b/include/linux/sched.h @@ -42,6 +42,7 @@ #include #include #include +#include #include #include #include @@ -1516,16 +1517,11 @@ struct task_struct { #endif /* CONFIG_TRACING */ =20 #ifdef CONFIG_KCOV - /* See kernel/kcov.c for more details. */ - /* Coverage collection mode enabled for this task (0 if disabled): */ unsigned int kcov_mode; =20 - /* Size of the kcov_area: */ - unsigned int kcov_size; - - /* Buffer for coverage collection: */ - void *kcov_area; + /* KCOV buffer state for this task. */ + struct kcov_state kcov_state; =20 /* KCOV descriptor wired with this task or NULL: */ struct kcov *kcov; @@ -1533,9 +1529,6 @@ struct task_struct { /* KCOV common handle for remote coverage collection: */ u64 kcov_handle; =20 - /* KCOV sequence number: */ - int kcov_sequence; - /* Collect coverage from softirq context: */ unsigned int kcov_softirq; #endif diff --git a/kernel/kcov.c b/kernel/kcov.c index 187ba1b80bda1..5170f367c8a1b 100644 --- a/kernel/kcov.c +++ b/kernel/kcov.c @@ -23,6 +23,7 @@ #include #include #include +#include #include #include #include @@ -53,24 +54,17 @@ struct kcov { * - each code section for remote coverage collection */ refcount_t refcount; - /* The lock protects mode, size, area and t. */ + /* The lock protects mode, state and t. */ spinlock_t lock; enum kcov_mode mode; - /* Size of arena (in long's). */ - unsigned int size; - /* Coverage buffer shared with user space. */ - void *area; + struct kcov_state state; + /* Task for which we collect coverage, or NULL. */ struct task_struct *t; /* Collecting coverage from remote (background) threads. */ bool remote; /* Size of remote area (in long's). */ unsigned int remote_size; - /* - * Sequence is incremented each time kcov is reenabled, used by - * kcov_remote_stop(), see the comment there. - */ - int sequence; }; =20 struct kcov_remote_area { @@ -92,11 +86,9 @@ struct kcov_percpu_data { void *irq_area; local_lock_t lock; =20 - unsigned int saved_mode; - unsigned int saved_size; - void *saved_area; + enum kcov_mode saved_mode; struct kcov *saved_kcov; - int saved_sequence; + struct kcov_state saved_state; }; =20 static DEFINE_PER_CPU(struct kcov_percpu_data, kcov_percpu_data) =3D { @@ -217,10 +209,10 @@ void notrace __sanitizer_cov_trace_pc(void) if (!check_kcov_mode(KCOV_MODE_TRACE_PC, t)) return; =20 - area =3D t->kcov_area; + area =3D t->kcov_state.area; /* The first 64-bit word is the number of subsequent PCs. */ pos =3D READ_ONCE(area[0]) + 1; - if (likely(pos < t->kcov_size)) { + if (likely(pos < t->kcov_state.size)) { /* Previously we write pc before updating pos. However, some * early interrupt code could bypass check_kcov_mode() check * and invoke __sanitizer_cov_trace_pc(). If such interrupt is @@ -250,10 +242,10 @@ static void notrace write_comp_data(u64 type, u64 arg= 1, u64 arg2, u64 ip) =20 /* * We write all comparison arguments and types as u64. - * The buffer was allocated for t->kcov_size unsigned longs. + * The buffer was allocated for t->kcov_state.size unsigned longs. */ - area =3D (u64 *)t->kcov_area; - max_pos =3D t->kcov_size * sizeof(unsigned long); + area =3D (u64 *)t->kcov_state.area; + max_pos =3D t->kcov_state.size * sizeof(unsigned long); =20 count =3D READ_ONCE(area[0]); =20 @@ -354,15 +346,13 @@ EXPORT_SYMBOL(__sanitizer_cov_trace_switch); #endif /* ifdef CONFIG_KCOV_ENABLE_COMPARISONS */ =20 static void kcov_start(struct task_struct *t, struct kcov *kcov, - unsigned int size, void *area, enum kcov_mode mode, - int sequence) + enum kcov_mode mode, struct kcov_state *state) { - kcov_debug("t =3D %px, size =3D %u, area =3D %px\n", t, size, area); + kcov_debug("t =3D %px, size =3D %u, area =3D %px\n", t, state->size, + state->area); t->kcov =3D kcov; /* Cache in task struct for performance. */ - t->kcov_size =3D size; - t->kcov_area =3D area; - t->kcov_sequence =3D sequence; + t->kcov_state =3D *state; /* See comment in check_kcov_mode(). */ barrier(); WRITE_ONCE(t->kcov_mode, mode); @@ -373,14 +363,14 @@ static void kcov_stop(struct task_struct *t) WRITE_ONCE(t->kcov_mode, KCOV_MODE_DISABLED); barrier(); t->kcov =3D NULL; - t->kcov_size =3D 0; - t->kcov_area =3D NULL; + t->kcov_state.size =3D 0; + t->kcov_state.area =3D NULL; } =20 static void kcov_task_reset(struct task_struct *t) { kcov_stop(t); - t->kcov_sequence =3D 0; + t->kcov_state.sequence =3D 0; t->kcov_handle =3D 0; } =20 @@ -396,7 +386,7 @@ static void kcov_reset(struct kcov *kcov) kcov->mode =3D KCOV_MODE_INIT; kcov->remote =3D false; kcov->remote_size =3D 0; - kcov->sequence++; + kcov->state.sequence++; } =20 static void kcov_remote_reset(struct kcov *kcov) @@ -436,7 +426,7 @@ static void kcov_put(struct kcov *kcov) { if (refcount_dec_and_test(&kcov->refcount)) { kcov_remote_reset(kcov); - vfree(kcov->area); + vfree(kcov->state.area); kfree(kcov); } } @@ -493,8 +483,8 @@ static int kcov_mmap(struct file *filep, struct vm_area= _struct *vma) unsigned long flags; =20 spin_lock_irqsave(&kcov->lock, flags); - size =3D kcov->size * sizeof(unsigned long); - if (kcov->area =3D=3D NULL || vma->vm_pgoff !=3D 0 || + size =3D kcov->state.size * sizeof(unsigned long); + if (kcov->state.area =3D=3D NULL || vma->vm_pgoff !=3D 0 || vma->vm_end - vma->vm_start !=3D size) { res =3D -EINVAL; goto exit; @@ -502,7 +492,7 @@ static int kcov_mmap(struct file *filep, struct vm_area= _struct *vma) spin_unlock_irqrestore(&kcov->lock, flags); vm_flags_set(vma, VM_DONTEXPAND); for (off =3D 0; off < size; off +=3D PAGE_SIZE) { - page =3D vmalloc_to_page(kcov->area + off); + page =3D vmalloc_to_page(kcov->state.area + off); res =3D vm_insert_page(vma, vma->vm_start + off, page); if (res) { pr_warn_once("kcov: vm_insert_page() failed\n"); @@ -523,7 +513,7 @@ static int kcov_open(struct inode *inode, struct file *= filep) if (!kcov) return -ENOMEM; kcov->mode =3D KCOV_MODE_DISABLED; - kcov->sequence =3D 1; + kcov->state.sequence =3D 1; refcount_set(&kcov->refcount, 1); spin_lock_init(&kcov->lock); filep->private_data =3D kcov; @@ -558,10 +548,10 @@ static int kcov_get_mode(unsigned long arg) static void kcov_fault_in_area(struct kcov *kcov) { unsigned long stride =3D PAGE_SIZE / sizeof(unsigned long); - unsigned long *area =3D kcov->area; + unsigned long *area =3D kcov->state.area; unsigned long offset; =20 - for (offset =3D 0; offset < kcov->size; offset +=3D stride) + for (offset =3D 0; offset < kcov->state.size; offset +=3D stride) READ_ONCE(area[offset]); } =20 @@ -600,7 +590,7 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigne= d int cmd, * at task exit or voluntary by KCOV_DISABLE. After that it can * be enabled for another task. */ - if (kcov->mode !=3D KCOV_MODE_INIT || !kcov->area) + if (kcov->mode !=3D KCOV_MODE_INIT || !kcov->state.area) return -EINVAL; t =3D current; if (kcov->t !=3D NULL || t->kcov !=3D NULL) @@ -610,8 +600,7 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigne= d int cmd, return mode; kcov_fault_in_area(kcov); kcov->mode =3D mode; - kcov_start(t, kcov, kcov->size, kcov->area, kcov->mode, - kcov->sequence); + kcov_start(t, kcov, mode, &kcov->state); kcov->t =3D t; /* Put either in kcov_task_exit() or in KCOV_DISABLE. */ kcov_get(kcov); @@ -628,7 +617,7 @@ static int kcov_ioctl_locked(struct kcov *kcov, unsigne= d int cmd, kcov_put(kcov); return 0; case KCOV_REMOTE_ENABLE: - if (kcov->mode !=3D KCOV_MODE_INIT || !kcov->area) + if (kcov->mode !=3D KCOV_MODE_INIT || !kcov->state.area) return -EINVAL; t =3D current; if (kcov->t !=3D NULL || t->kcov !=3D NULL) @@ -722,8 +711,8 @@ static long kcov_ioctl(struct file *filep, unsigned int= cmd, unsigned long arg) vfree(area); return -EBUSY; } - kcov->area =3D area; - kcov->size =3D size; + kcov->state.area =3D area; + kcov->state.size =3D size; kcov->mode =3D KCOV_MODE_INIT; spin_unlock_irqrestore(&kcov->lock, flags); return 0; @@ -821,10 +810,8 @@ static void kcov_remote_softirq_start(struct task_stru= ct *t) mode =3D READ_ONCE(t->kcov_mode); barrier(); if (kcov_mode_enabled(mode)) { + data->saved_state =3D t->kcov_state; data->saved_mode =3D mode; - data->saved_size =3D t->kcov_size; - data->saved_area =3D t->kcov_area; - data->saved_sequence =3D t->kcov_sequence; data->saved_kcov =3D t->kcov; kcov_stop(t); } @@ -835,13 +822,9 @@ static void kcov_remote_softirq_stop(struct task_struc= t *t) struct kcov_percpu_data *data =3D this_cpu_ptr(&kcov_percpu_data); =20 if (data->saved_kcov) { - kcov_start(t, data->saved_kcov, data->saved_size, - data->saved_area, data->saved_mode, - data->saved_sequence); - data->saved_mode =3D 0; - data->saved_size =3D 0; - data->saved_area =3D NULL; - data->saved_sequence =3D 0; + kcov_start(t, data->saved_kcov, data->saved_mode, + &data->saved_state); + data->saved_state =3D (struct kcov_state){}; data->saved_kcov =3D NULL; } } @@ -850,12 +833,12 @@ void kcov_remote_start(u64 handle) { struct task_struct *t =3D current; struct kcov_remote *remote; + struct kcov_state state; + enum kcov_mode mode; + unsigned long flags; + unsigned int size; struct kcov *kcov; - unsigned int mode; void *area; - unsigned int size; - int sequence; - unsigned long flags; =20 if (WARN_ON(!kcov_check_handle(handle, true, true, true))) return; @@ -900,7 +883,7 @@ void kcov_remote_start(u64 handle) * KCOV_DISABLE / kcov_remote_reset(). */ mode =3D kcov->mode; - sequence =3D kcov->sequence; + state.sequence =3D kcov->state.sequence; if (in_task()) { size =3D kcov->remote_size; area =3D kcov_remote_area_get(size); @@ -923,12 +906,14 @@ void kcov_remote_start(u64 handle) =20 /* Reset coverage size. */ *(u64 *)area =3D 0; + state.area =3D area; + state.size =3D size; =20 if (in_serving_softirq()) { kcov_remote_softirq_start(t); t->kcov_softirq =3D 1; } - kcov_start(t, kcov, size, area, mode, sequence); + kcov_start(t, kcov, mode, &state); =20 local_unlock_irqrestore(&kcov_percpu_data.lock, flags); =20 @@ -1027,9 +1012,9 @@ void kcov_remote_stop(void) } =20 kcov =3D t->kcov; - area =3D t->kcov_area; - size =3D t->kcov_size; - sequence =3D t->kcov_sequence; + area =3D t->kcov_state.area; + size =3D t->kcov_state.size; + sequence =3D t->kcov_state.sequence; =20 kcov_stop(t); if (in_serving_softirq()) { @@ -1042,8 +1027,9 @@ void kcov_remote_stop(void) * KCOV_DISABLE could have been called between kcov_remote_start() * and kcov_remote_stop(), hence the sequence check. */ - if (sequence =3D=3D kcov->sequence && kcov->remote) - kcov_move_area(kcov->mode, kcov->area, kcov->size, area); + if (sequence =3D=3D kcov->state.sequence && kcov->remote) + kcov_move_area(kcov->mode, kcov->state.area, kcov->state.size, + area); spin_unlock(&kcov->lock); =20 if (in_task()) { --=20 2.50.1.470.g6ba607880d-goog