From nobody Mon Oct 6 01:28:22 2025 Received: from mail-wr1-f74.google.com (mail-wr1-f74.google.com [209.85.221.74]) (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 F3C10275110 for ; Mon, 28 Jul 2025 15:26:21 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.74 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1753716384; cv=none; b=RMy6s/aA/rjabNIKzS9flO2HcCBoPQuspof5JXI4DEOl5xp92FlE1uYwCubpxYMbcdgENd4wbIwuwMr0K1qjvlyRXMFsEhZSvGF/Dcxo6CG7XWiVRhDgri9N2VTdCOhH0VkMnftGqOvSz9Z0zZfU1DGAnLXjAZ+3FIIJUDkS3WE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1753716384; c=relaxed/simple; bh=oHEHQI2Km0t4tE8MDoNKRGZsz2Pa0IaBV64EzSKIXhE=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=sjwTadBwieAYzW5zHIUUoUQK/zMNBVi9wa+P73odwbfpJok22crH2mJLrRKHlfkFH/UjjWTewWRJ6g/8l3lY7uuTfs9TjS+f/Qzbl42s6vZ+G4PBjJdKBrnnrUrKMdVyDuFQOoLiioyGBrj5GRj5dcXrDF0QCQkuHa0o5KrQ1E4= 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=atRBkrGG; arc=none smtp.client-ip=209.85.221.74 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="atRBkrGG" Received: by mail-wr1-f74.google.com with SMTP id ffacd0b85a97d-3b7886bfc16so708491f8f.1 for ; Mon, 28 Jul 2025 08:26:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1753716380; x=1754321180; 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=RM3rYcVJaPkMmvCtgqhtUuIHqeUyU5KTFhX1F5xwLi8=; b=atRBkrGGNaZTXsWeZ3QxmIxv6eKypIScn4CIAvBl0akBlX3oeFZOnsoUTZr1yKUIIu k0FOe2m427KuLMLtkyInnPLMilcbu1dBlX/fEpM64bgR/93r7Au6nkfgcZfm576S0WVs e+qp0E1o8Sv0l0fBdojuWnP84n0QLmhUiY3USdHwY9Qv/6xWLhFf/rzAFSXafdR9Do91 WAKzAonzRM9La1e+MidGq+eGB/tM4Qe316Gi5/0rxAH1Gk77cOG3qyHSSMRMpuQ8VAeH 6Xl2sp1iyUtWalqbNaSAZF5tPqXUUnjOOP2yMJWGrOIIvfc/I6iKmXt/G6pqnYEtS0g/ uh+Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1753716380; x=1754321180; 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=RM3rYcVJaPkMmvCtgqhtUuIHqeUyU5KTFhX1F5xwLi8=; b=PNfYr59zmfPvcMT59LdEeWe8BT5mjWWswtEjK1hCWRU5ki7VLqxnbM+FXGOKRQQS10 HYIR0Q1SXMARR28Sp5VfkoI1hXeqyrF6r1iMa6ZPjc0u9SWUYSVowGm55fzkAAnLcgbl kjCeK/yDTXM89Oc6mw3ZSH1Sxvt/e6Yf3rR8Pwyv+tNqYPtrHzRjhKfX9cvdjkK79Muh o7I/ynji2LDHGL5prKBtlqHCgEVJr+ie+HQzp9eCdask11t6rckb7715zo8oktxuKYf1 kPAR/uJ9pNYt024EBEImF+WG2crbMpFKkzHRWhZfgK7NJvezuqnP01eT6B32SvlfEOpp Frbw== X-Forwarded-Encrypted: i=1; AJvYcCWXGM4GG/rLSl0KKEl9epnTXbW+395rh1OgqdJ691JACPg9od4GBwFO5ivET5KCA0V8ffgd5/Fg97Cg9MM=@vger.kernel.org X-Gm-Message-State: AOJu0YwRlMipr66vdDy/D7wywS3mRuj0EfsKEseWwcG9JATMvh8SiKRK HHEoOhN8Dismn/MXLSdCWNNfVudmMOsm0BYNTH698PZKhsx7dsUWocC48jFuKxY22XVj/bDQI6A gEwnxvg== X-Google-Smtp-Source: AGHT+IHUCNbr51JQqwUCi3muVJ1RbQXkO5iU5ZjMpw/FpHYsNBwRad9q0Gv6T6yMJ8thDgb01Sr1heviZRA= X-Received: from wrf6-n1.prod.google.com ([2002:a05:6000:43c6:10b0:3b7:887e:816]) (user=glider job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6000:2582:b0:3b7:868d:435e with SMTP id ffacd0b85a97d-3b7868d4705mr3391930f8f.41.1753716380342; Mon, 28 Jul 2025 08:26:20 -0700 (PDT) Date: Mon, 28 Jul 2025 17:25:47 +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-10-glider@google.com> Subject: [PATCH v3 09/10] kcov: selftests: add kcov_test 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" Implement test fixtures for testing different combinations of coverage collection modes: - unique and non-unique coverage; - collecting PCs and comparison arguments; - mapping the buffer as RO and RW. To build: $ make -C tools/testing/selftests/kcov kcov_test Signed-off-by: Alexander Potapenko --- v3: - Address comments by Dmitry Vyukov: - add tools/testing/selftests/kcov/config - add ifdefs to KCOV_UNIQUE_ENABLE and KCOV_RESET_TRACE - Properly handle/reset the coverage buffer when collecting unique coverage Change-Id: I0793f1b91685873c77bcb222a03f64321244df8f --- MAINTAINERS | 1 + tools/testing/selftests/kcov/Makefile | 6 + tools/testing/selftests/kcov/config | 1 + tools/testing/selftests/kcov/kcov_test.c | 401 +++++++++++++++++++++++ 4 files changed, 409 insertions(+) create mode 100644 tools/testing/selftests/kcov/Makefile create mode 100644 tools/testing/selftests/kcov/config create mode 100644 tools/testing/selftests/kcov/kcov_test.c diff --git a/MAINTAINERS b/MAINTAINERS index 6906eb9d88dae..c1d64cef693b9 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -13018,6 +13018,7 @@ F: include/linux/kcov_types.h F: include/uapi/linux/kcov.h F: kernel/kcov.c F: scripts/Makefile.kcov +F: tools/testing/selftests/kcov/ =20 KCSAN M: Marco Elver diff --git a/tools/testing/selftests/kcov/Makefile b/tools/testing/selftest= s/kcov/Makefile new file mode 100644 index 0000000000000..08abf8b60bcf9 --- /dev/null +++ b/tools/testing/selftests/kcov/Makefile @@ -0,0 +1,6 @@ +# SPDX-License-Identifier: GPL-2.0-only +LDFLAGS +=3D -static + +TEST_GEN_PROGS :=3D kcov_test + +include ../lib.mk diff --git a/tools/testing/selftests/kcov/config b/tools/testing/selftests/= kcov/config new file mode 100644 index 0000000000000..75726b2aa9979 --- /dev/null +++ b/tools/testing/selftests/kcov/config @@ -0,0 +1 @@ +CONFIG_KCOV=3Dy diff --git a/tools/testing/selftests/kcov/kcov_test.c b/tools/testing/selft= ests/kcov/kcov_test.c new file mode 100644 index 0000000000000..daf12aeb374b5 --- /dev/null +++ b/tools/testing/selftests/kcov/kcov_test.c @@ -0,0 +1,401 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Test the kernel coverage (/sys/kernel/debug/kcov). + * + * Copyright 2025 Google LLC. + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "../kselftest_harness.h" + +/* Normally these defines should be provided by linux/kcov.h, but they are= n't there yet. */ +#ifndef KCOV_UNIQUE_ENABLE +#define KCOV_UNIQUE_ENABLE _IOW('c', 103, unsigned long) +#endif +#ifndef KCOV_RESET_TRACE +#define KCOV_RESET_TRACE _IO('c', 104) +#endif + +#define COVER_SIZE (64 << 10) +#define BITMAP_SIZE (4 << 10) + +#define DEBUG_COVER_PCS 0 + +FIXTURE(kcov) +{ + int fd; + unsigned long *mapping; + size_t mapping_size; +}; + +FIXTURE_VARIANT(kcov) +{ + int mode; + bool fast_reset; + bool map_readonly; +}; + +/* clang-format off */ +FIXTURE_VARIANT_ADD(kcov, mode_trace_pc) +{ + /* clang-format on */ + .mode =3D KCOV_TRACE_PC, + .fast_reset =3D true, + .map_readonly =3D false, +}; + +/* clang-format off */ +FIXTURE_VARIANT_ADD(kcov, mode_trace_cmp) +{ + /* clang-format on */ + .mode =3D KCOV_TRACE_CMP, + .fast_reset =3D true, + .map_readonly =3D false, +}; + +/* clang-format off */ +FIXTURE_VARIANT_ADD(kcov, reset_ioctl_rw) +{ + /* clang-format on */ + .mode =3D KCOV_TRACE_PC, + .fast_reset =3D false, + .map_readonly =3D false, +}; + +FIXTURE_VARIANT_ADD(kcov, reset_ioctl_ro) +/* clang-format off */ +{ + /* clang-format on */ + .mode =3D KCOV_TRACE_PC, + .fast_reset =3D false, + .map_readonly =3D true, +}; + +int kcov_open_init(struct __test_metadata *_metadata, unsigned long size, + int prot, unsigned long **out_mapping) +{ + unsigned long *mapping; + + /* A single fd descriptor allows coverage collection on a single thread. = */ + int fd =3D open("/sys/kernel/debug/kcov", O_RDWR); + + ASSERT_NE(fd, -1) + { + perror("open"); + } + + EXPECT_EQ(ioctl(fd, KCOV_INIT_TRACE, size), 0) + { + perror("ioctl KCOV_INIT_TRACE"); + close(fd); + } + + /* Mmap buffer shared between kernel- and user-space. */ + mapping =3D (unsigned long *)mmap(NULL, size * sizeof(unsigned long), + prot, MAP_SHARED, fd, 0); + ASSERT_NE((void *)mapping, MAP_FAILED) + { + perror("mmap"); + close(fd); + } + *out_mapping =3D mapping; + + return fd; +} + +FIXTURE_SETUP(kcov) +{ + int prot =3D variant->map_readonly ? PROT_READ : (PROT_READ | PROT_WRITE); + + /* Read-only mapping is incompatible with fast reset. */ + ASSERT_FALSE(variant->map_readonly && variant->fast_reset); + + self->mapping_size =3D COVER_SIZE; + self->fd =3D kcov_open_init(_metadata, self->mapping_size, prot, + &(self->mapping)); + + /* Enable coverage collection on the current thread. */ + EXPECT_EQ(ioctl(self->fd, KCOV_ENABLE, variant->mode), 0) + { + perror("ioctl KCOV_ENABLE"); + /* Cleanup will be handled by FIXTURE_TEARDOWN. */ + return; + } +} + +void kcov_uninit_close(struct __test_metadata *_metadata, int fd, + unsigned long *mapping, size_t size) +{ + /* Disable coverage collection for the current thread. */ + EXPECT_EQ(ioctl(fd, KCOV_DISABLE, 0), 0) + { + perror("ioctl KCOV_DISABLE"); + } + + /* Free resources. */ + EXPECT_EQ(munmap(mapping, size * sizeof(unsigned long)), 0) + { + perror("munmap"); + } + + EXPECT_EQ(close(fd), 0) + { + perror("close"); + } +} + +FIXTURE_TEARDOWN(kcov) +{ + kcov_uninit_close(_metadata, self->fd, self->mapping, + self->mapping_size); +} + +void dump_collected_pcs(struct __test_metadata *_metadata, unsigned long *= cover, + size_t start, size_t end) +{ + int i =3D 0; + + TH_LOG("Collected %lu PCs", end - start); +#if DEBUG_COVER_PCS + for (i =3D start; i < end; i++) + TH_LOG("0x%lx", cover[i + 1]); +#endif +} + +/* Coverage collection helper without assertions. */ +unsigned long collect_coverage_unchecked(struct __test_metadata *_metadata, + unsigned long *cover, bool dump) +{ + unsigned long before, after; + + before =3D __atomic_load_n(&cover[0], __ATOMIC_RELAXED); + /* + * Call the target syscall call. Here we use read(-1, NULL, 0) as an exam= ple. + * This will likely return an error (-EFAULT or -EBADF), but the goal is = to + * collect coverage for the syscall's entry/exit paths. + */ + read(-1, NULL, 0); + + after =3D __atomic_load_n(&cover[0], __ATOMIC_RELAXED); + + if (dump) + dump_collected_pcs(_metadata, cover, before, after); + return after - before; +} + +unsigned long collect_coverage_once(struct __test_metadata *_metadata, + unsigned long *cover) +{ + unsigned long collected =3D + collect_coverage_unchecked(_metadata, cover, /*dump*/ true); + + /* Coverage must be non-zero. */ + EXPECT_GT(collected, 0); + return collected; +} + +void reset_coverage(struct __test_metadata *_metadata, bool fast, int fd, + unsigned long *mapping) +{ + unsigned long count; + + if (fast) { + __atomic_store_n(&mapping[0], 0, __ATOMIC_RELAXED); + } else { + EXPECT_EQ(ioctl(fd, KCOV_RESET_TRACE, 0), 0) + { + perror("ioctl KCOV_RESET_TRACE"); + } + count =3D __atomic_load_n(&mapping[0], __ATOMIC_RELAXED); + EXPECT_NE(count, 0); + } +} + +TEST_F(kcov, kcov_basic_syscall_coverage) +{ + unsigned long first, second, before, after, i; + + /* Reset coverage that may be left over from the fixture setup. */ + reset_coverage(_metadata, variant->fast_reset, self->fd, self->mapping); + + /* Collect the coverage for a single syscall two times in a row. */ + first =3D collect_coverage_once(_metadata, self->mapping); + second =3D collect_coverage_once(_metadata, self->mapping); + /* Collected coverage should not differ too much. */ + EXPECT_GT(first * 10, second); + EXPECT_GT(second * 10, first); + + /* Now reset the buffer and collect the coverage again. */ + reset_coverage(_metadata, variant->fast_reset, self->fd, self->mapping); + collect_coverage_once(_metadata, self->mapping); + + /* Now try many times to fill up the buffer. */ + reset_coverage(_metadata, variant->fast_reset, self->fd, self->mapping); + while (collect_coverage_unchecked(_metadata, self->mapping, + /*dump*/ false)) { + /* Do nothing. */ + } + before =3D __atomic_load_n(&(self->mapping[0]), __ATOMIC_RELAXED); + /* + * Resetting with ioctl may still generate some coverage, but much less + * than there was before. + */ + reset_coverage(_metadata, variant->fast_reset, self->fd, self->mapping); + after =3D __atomic_load_n(&(self->mapping[0]), __ATOMIC_RELAXED); + EXPECT_GT(before, after); + /* Collecting coverage after reset will now succeed. */ + collect_coverage_once(_metadata, self->mapping); +} + +FIXTURE(kcov_uniq) +{ + int fd; + unsigned long *mapping; + size_t mapping_size; + unsigned long *bitmap; + size_t bitmap_size; + unsigned long *cover; + size_t cover_size; +}; + +FIXTURE_VARIANT(kcov_uniq) +{ + bool fast_reset; + bool map_readonly; +}; + +/* clang-format off */ +FIXTURE_VARIANT_ADD(kcov_uniq, fast_rw) +{ + /* clang-format on */ + .fast_reset =3D true, + .map_readonly =3D false, +}; + +/* clang-format off */ +FIXTURE_VARIANT_ADD(kcov_uniq, slow_rw) +{ + /* clang-format on */ + .fast_reset =3D false, + .map_readonly =3D false, +}; + +/* clang-format off */ +FIXTURE_VARIANT_ADD(kcov_uniq, slow_ro) +{ + /* clang-format on */ + .fast_reset =3D false, + .map_readonly =3D true, +}; + +FIXTURE_SETUP(kcov_uniq) +{ + int prot =3D variant->map_readonly ? PROT_READ : (PROT_READ | PROT_WRITE); + + /* Read-only mapping is incompatible with fast reset. */ + ASSERT_FALSE(variant->map_readonly && variant->fast_reset); + + self->mapping_size =3D COVER_SIZE; + self->fd =3D kcov_open_init(_metadata, self->mapping_size, prot, + &(self->mapping)); + + self->bitmap =3D self->mapping; + self->bitmap_size =3D BITMAP_SIZE; + /* + * Enable unique coverage collection on the current thread. Carve out + * self->bitmap_size unsigned long's for the bitmap. + */ + EXPECT_EQ(ioctl(self->fd, KCOV_UNIQUE_ENABLE, self->bitmap_size), 0) + { + perror("ioctl KCOV_ENABLE"); + /* Cleanup will be handled by FIXTURE_TEARDOWN. */ + return; + } + self->cover =3D self->mapping + BITMAP_SIZE; + self->cover_size =3D self->mapping_size - BITMAP_SIZE; +} + +FIXTURE_TEARDOWN(kcov_uniq) +{ + kcov_uninit_close(_metadata, self->fd, self->mapping, + self->mapping_size); +} + +void reset_uniq_coverage(struct __test_metadata *_metadata, bool fast, int= fd, + unsigned long *bitmap, unsigned long *cover) +{ + unsigned long count; + + if (fast) { + /* + * Resetting the buffer for unique coverage collection requires + * zeroing out the bitmap and cover[0]. We are assuming that + * the coverage buffer immediately follows the bitmap, as they + * belong to the same memory mapping. + */ + if (cover > bitmap) + memset(bitmap, 0, sizeof(unsigned long) * (cover - bitmap)); + __atomic_store_n(&cover[0], 0, __ATOMIC_RELAXED); + } else { + EXPECT_EQ(ioctl(fd, KCOV_RESET_TRACE, 0), 0) + { + perror("ioctl KCOV_RESET_TRACE"); + } + count =3D __atomic_load_n(&cover[0], __ATOMIC_RELAXED); + EXPECT_NE(count, 0); + } +} + +TEST_F(kcov_uniq, kcov_uniq_coverage) +{ + unsigned long first, second, before, after, i; + + /* Reset coverage that may be left over from the fixture setup. */ + reset_uniq_coverage(_metadata, variant->fast_reset, self->fd, self->bitma= p, self->cover); + + /* + * Collect the coverage for a single syscall two times in a row. + * Use collect_coverage_unchecked(), because it may return zero coverage. + */ + first =3D collect_coverage_unchecked(_metadata, self->cover, + /*dump*/ true); + second =3D collect_coverage_unchecked(_metadata, self->cover, + /*dump*/ true); + + /* Now reset the buffer and collect the coverage again. */ + reset_uniq_coverage(_metadata, variant->fast_reset, self->fd, self->bitma= p, self->cover); + collect_coverage_once(_metadata, self->cover); + + /* Now try many times to saturate the unique coverage bitmap. */ + reset_uniq_coverage(_metadata, variant->fast_reset, self->fd, self->bitma= p, self->cover); + for (i =3D 0; i < 1000; i++) + collect_coverage_unchecked(_metadata, self->cover, + /*dump*/ false); + + /* Another invocation of collect_coverage_unchecked() should not produce = new coverage. */ + EXPECT_EQ(collect_coverage_unchecked(_metadata, self->cover, + /*dump*/ false), + 0); + + before =3D __atomic_load_n(&(self->cover[0]), __ATOMIC_RELAXED); + /* + * Resetting with ioctl may still generate some coverage, but much less + * than there was before. + */ + reset_uniq_coverage(_metadata, variant->fast_reset, self->fd, self->bitma= p, self->cover); + after =3D __atomic_load_n(&(self->cover[0]), __ATOMIC_RELAXED); + EXPECT_GT(before, after); + /* Collecting coverage after reset will now succeed. */ + collect_coverage_once(_metadata, self->cover); +} + +TEST_HARNESS_MAIN --=20 2.50.1.470.g6ba607880d-goog