€•nŸŒsphinx.addnodes”Œdocument”“”)”}”(Œ rawsource”Œ”Œchildren”]”(Œ translations”Œ LanguagesNode”“”)”}”(hhh]”(hŒ pending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ refdomain”Œstd”Œreftype”Œdoc”Œ reftarget”Œ"/translations/zh_CN/dev-tools/kcov”Œmodname”NŒ classname”NŒ refexplicit”ˆuŒtagname”hhh ubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ"/translations/zh_TW/dev-tools/kcov”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ"/translations/it_IT/dev-tools/kcov”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ"/translations/ja_JP/dev-tools/kcov”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ"/translations/ko_KR/dev-tools/kcov”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ"/translations/pt_BR/dev-tools/kcov”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ"/translations/sp_SP/dev-tools/kcov”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h hhŒ _document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒKCOV: code coverage for fuzzing”h]”hŒKCOV: code coverage for fuzzing”…””}”(hh¼h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhh·h²hh³Œ #include #include #include #include #include #include #include #include #include #include #define KCOV_INIT_TRACE _IOR('c', 1, unsigned long) #define KCOV_ENABLE _IO('c', 100) #define KCOV_DISABLE _IO('c', 101) #define COVER_SIZE (64<<10) #define KCOV_TRACE_PC 0 #define KCOV_TRACE_CMP 1 int main(int argc, char **argv) { int fd; unsigned long *cover, n, i; /* A single fd descriptor allows coverage collection on a single * thread. */ fd = open("/sys/kernel/debug/kcov", O_RDWR); if (fd == -1) perror("open"), exit(1); /* Setup trace mode and trace size. */ if (ioctl(fd, KCOV_INIT_TRACE, COVER_SIZE)) perror("ioctl"), exit(1); /* Mmap buffer shared between kernel- and user-space. */ cover = (unsigned long*)mmap(NULL, COVER_SIZE * sizeof(unsigned long), PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0); if ((void*)cover == MAP_FAILED) perror("mmap"), exit(1); /* Enable coverage collection on the current thread. */ if (ioctl(fd, KCOV_ENABLE, KCOV_TRACE_PC)) perror("ioctl"), exit(1); /* Reset coverage from the tail of the ioctl() call. */ __atomic_store_n(&cover[0], 0, __ATOMIC_RELAXED); /* Call the target syscall call. */ read(-1, NULL, 0); /* Read number of PCs collected. */ n = __atomic_load_n(&cover[0], __ATOMIC_RELAXED); for (i = 0; i < n; i++) printf("0x%lx\n", cover[i + 1]); /* Disable coverage collection for the current thread. After this call * coverage can be enabled for a different thread. */ if (ioctl(fd, KCOV_DISABLE, 0)) perror("ioctl"), exit(1); /* Free resources. */ if (munmap(cover, COVER_SIZE * sizeof(unsigned long))) perror("munmap"), exit(1); if (close(fd)) perror("close"), exit(1); return 0; }”h]”hX2#include #include #include #include #include #include #include #include #include #include #include #define KCOV_INIT_TRACE _IOR('c', 1, unsigned long) #define KCOV_ENABLE _IO('c', 100) #define KCOV_DISABLE _IO('c', 101) #define COVER_SIZE (64<<10) #define KCOV_TRACE_PC 0 #define KCOV_TRACE_CMP 1 int main(int argc, char **argv) { int fd; unsigned long *cover, n, i; /* A single fd descriptor allows coverage collection on a single * thread. */ fd = open("/sys/kernel/debug/kcov", O_RDWR); if (fd == -1) perror("open"), exit(1); /* Setup trace mode and trace size. */ if (ioctl(fd, KCOV_INIT_TRACE, COVER_SIZE)) perror("ioctl"), exit(1); /* Mmap buffer shared between kernel- and user-space. */ cover = (unsigned long*)mmap(NULL, COVER_SIZE * sizeof(unsigned long), PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0); if ((void*)cover == MAP_FAILED) perror("mmap"), exit(1); /* Enable coverage collection on the current thread. */ if (ioctl(fd, KCOV_ENABLE, KCOV_TRACE_PC)) perror("ioctl"), exit(1); /* Reset coverage from the tail of the ioctl() call. */ __atomic_store_n(&cover[0], 0, __ATOMIC_RELAXED); /* Call the target syscall call. */ read(-1, NULL, 0); /* Read number of PCs collected. */ n = __atomic_load_n(&cover[0], __ATOMIC_RELAXED); for (i = 0; i < n; i++) printf("0x%lx\n", cover[i + 1]); /* Disable coverage collection for the current thread. After this call * coverage can be enabled for a different thread. */ if (ioctl(fd, KCOV_DISABLE, 0)) perror("ioctl"), exit(1); /* Free resources. */ if (munmap(cover, COVER_SIZE * sizeof(unsigned long))) perror("munmap"), exit(1); if (close(fd)) perror("close"), exit(1); return 0; }”…””}”hjÅsbah}”(h]”h ]”h"]”h$]”h&]”jdjeŒforce”‰Œlanguage”Œc”Œhighlight_args”}”uh1jTh³hÊh´K1hj¦h²hubhÌ)”}”(hŒOAfter piping through ``addr2line`` the output of the program looks as follows::”h]”(hŒAfter piping through ”…””}”(hjØh²hh³Nh´NubhÖ)”}”(hŒ ``addr2line``”h]”hŒ addr2line”…””}”(hjàh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjØubhŒ, the output of the program looks as follows:”…””}”(hjØh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Krhj¦h²hubjU)”}”(hŒ¾SyS_read fs/read_write.c:562 __fdget_pos fs/file.c:774 __fget_light fs/file.c:746 __fget_light fs/file.c:750 __fget_light fs/file.c:760 __fdget_pos fs/file.c:784 SyS_read fs/read_write.c:562”h]”hŒ¾SyS_read fs/read_write.c:562 __fdget_pos fs/file.c:774 __fget_light fs/file.c:746 __fget_light fs/file.c:750 __fget_light fs/file.c:760 __fdget_pos fs/file.c:784 SyS_read fs/read_write.c:562”…””}”hjøsbah}”(h]”h ]”h"]”h$]”h&]”jdjeuh1jTh³hÊh´Kthj¦h²hubhÌ)”}”(hŒ“If a program needs to collect coverage from several threads (independently), it needs to open ``/sys/kernel/debug/kcov`` in each thread separately.”h]”(hŒ^If a program needs to collect coverage from several threads (independently), it needs to open ”…””}”(hjh²hh³Nh´NubhÖ)”}”(hŒ``/sys/kernel/debug/kcov``”h]”hŒ/sys/kernel/debug/kcov”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjubhŒ in each thread separately.”…””}”(hjh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kƒhj¦h²hubhÌ)”}”(hXCThe interface is fine-grained to allow efficient forking of test processes. That is, a parent process opens ``/sys/kernel/debug/kcov``, enables trace mode, mmaps coverage buffer, and then forks child processes in a loop. The child processes only need to enable coverage (it gets disabled automatically when a thread exits).”h]”(hŒlThe interface is fine-grained to allow efficient forking of test processes. That is, a parent process opens ”…””}”(hj&h²hh³Nh´NubhÖ)”}”(hŒ``/sys/kernel/debug/kcov``”h]”hŒ/sys/kernel/debug/kcov”…””}”(hj.h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhj&ubhŒ½, enables trace mode, mmaps coverage buffer, and then forks child processes in a loop. The child processes only need to enable coverage (it gets disabled automatically when a thread exits).”…””}”(hj&h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K†hj¦h²hubeh}”(h]”Œcoverage-collection”ah ]”h"]”Œcoverage collection”ah$]”h&]”uh1hµhh·h²hh³hÊh´K,ubh¶)”}”(hhh]”(h»)”}”(hŒComparison operands collection”h]”hŒComparison operands collection”…””}”(hjQh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjNh²hh³hÊh´KubhÌ)”}”(hŒAComparison operands collection is similar to coverage collection:”h]”hŒAComparison operands collection is similar to coverage collection:”…””}”(hj_h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KhjNh²hubjU)”}”(hXÖ /* Same includes and defines as above. */ /* Number of 64-bit words per record. */ #define KCOV_WORDS_PER_CMP 4 /* * The format for the types of collected comparisons. * * Bit 0 shows whether one of the arguments is a compile-time constant. * Bits 1 & 2 contain log2 of the argument size, up to 8 bytes. */ #define KCOV_CMP_CONST (1 << 0) #define KCOV_CMP_SIZE(n) ((n) << 1) #define KCOV_CMP_MASK KCOV_CMP_SIZE(3) int main(int argc, char **argv) { int fd; uint64_t *cover, type, arg1, arg2, is_const, size; unsigned long n, i; fd = open("/sys/kernel/debug/kcov", O_RDWR); if (fd == -1) perror("open"), exit(1); if (ioctl(fd, KCOV_INIT_TRACE, COVER_SIZE)) perror("ioctl"), exit(1); /* * Note that the buffer pointer is of type uint64_t*, because all * the comparison operands are promoted to uint64_t. */ cover = (uint64_t *)mmap(NULL, COVER_SIZE * sizeof(unsigned long), PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0); if ((void*)cover == MAP_FAILED) perror("mmap"), exit(1); /* Note KCOV_TRACE_CMP instead of KCOV_TRACE_PC. */ if (ioctl(fd, KCOV_ENABLE, KCOV_TRACE_CMP)) perror("ioctl"), exit(1); __atomic_store_n(&cover[0], 0, __ATOMIC_RELAXED); read(-1, NULL, 0); /* Read number of comparisons collected. */ n = __atomic_load_n(&cover[0], __ATOMIC_RELAXED); for (i = 0; i < n; i++) { uint64_t ip; type = cover[i * KCOV_WORDS_PER_CMP + 1]; /* arg1 and arg2 - operands of the comparison. */ arg1 = cover[i * KCOV_WORDS_PER_CMP + 2]; arg2 = cover[i * KCOV_WORDS_PER_CMP + 3]; /* ip - caller address. */ ip = cover[i * KCOV_WORDS_PER_CMP + 4]; /* size of the operands. */ size = 1 << ((type & KCOV_CMP_MASK) >> 1); /* is_const - true if either operand is a compile-time constant.*/ is_const = type & KCOV_CMP_CONST; printf("ip: 0x%lx type: 0x%lx, arg1: 0x%lx, arg2: 0x%lx, " "size: %lu, %s\n", ip, type, arg1, arg2, size, is_const ? "const" : "non-const"); } if (ioctl(fd, KCOV_DISABLE, 0)) perror("ioctl"), exit(1); /* Free resources. */ if (munmap(cover, COVER_SIZE * sizeof(unsigned long))) perror("munmap"), exit(1); if (close(fd)) perror("close"), exit(1); return 0; }”h]”hXÖ /* Same includes and defines as above. */ /* Number of 64-bit words per record. */ #define KCOV_WORDS_PER_CMP 4 /* * The format for the types of collected comparisons. * * Bit 0 shows whether one of the arguments is a compile-time constant. * Bits 1 & 2 contain log2 of the argument size, up to 8 bytes. */ #define KCOV_CMP_CONST (1 << 0) #define KCOV_CMP_SIZE(n) ((n) << 1) #define KCOV_CMP_MASK KCOV_CMP_SIZE(3) int main(int argc, char **argv) { int fd; uint64_t *cover, type, arg1, arg2, is_const, size; unsigned long n, i; fd = open("/sys/kernel/debug/kcov", O_RDWR); if (fd == -1) perror("open"), exit(1); if (ioctl(fd, KCOV_INIT_TRACE, COVER_SIZE)) perror("ioctl"), exit(1); /* * Note that the buffer pointer is of type uint64_t*, because all * the comparison operands are promoted to uint64_t. */ cover = (uint64_t *)mmap(NULL, COVER_SIZE * sizeof(unsigned long), PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0); if ((void*)cover == MAP_FAILED) perror("mmap"), exit(1); /* Note KCOV_TRACE_CMP instead of KCOV_TRACE_PC. */ if (ioctl(fd, KCOV_ENABLE, KCOV_TRACE_CMP)) perror("ioctl"), exit(1); __atomic_store_n(&cover[0], 0, __ATOMIC_RELAXED); read(-1, NULL, 0); /* Read number of comparisons collected. */ n = __atomic_load_n(&cover[0], __ATOMIC_RELAXED); for (i = 0; i < n; i++) { uint64_t ip; type = cover[i * KCOV_WORDS_PER_CMP + 1]; /* arg1 and arg2 - operands of the comparison. */ arg1 = cover[i * KCOV_WORDS_PER_CMP + 2]; arg2 = cover[i * KCOV_WORDS_PER_CMP + 3]; /* ip - caller address. */ ip = cover[i * KCOV_WORDS_PER_CMP + 4]; /* size of the operands. */ size = 1 << ((type & KCOV_CMP_MASK) >> 1); /* is_const - true if either operand is a compile-time constant.*/ is_const = type & KCOV_CMP_CONST; printf("ip: 0x%lx type: 0x%lx, arg1: 0x%lx, arg2: 0x%lx, " "size: %lu, %s\n", ip, type, arg1, arg2, size, is_const ? "const" : "non-const"); } if (ioctl(fd, KCOV_DISABLE, 0)) perror("ioctl"), exit(1); /* Free resources. */ if (munmap(cover, COVER_SIZE * sizeof(unsigned long))) perror("munmap"), exit(1); if (close(fd)) perror("close"), exit(1); return 0; }”…””}”hjmsbah}”(h]”h ]”h"]”h$]”h&]”jdjejÓ‰jÔjÕjÖ}”uh1jTh³hÊh´K‘hjNh²hubhÌ)”}”(hŒeNote that the KCOV modes (collection of code coverage or comparison operands) are mutually exclusive.”h]”hŒeNote that the KCOV modes (collection of code coverage or comparison operands) are mutually exclusive.”…””}”(hj|h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÙhjNh²hubeh}”(h]”Œcomparison-operands-collection”ah ]”h"]”Œcomparison operands collection”ah$]”h&]”uh1hµhh·h²hh³hÊh´Kubh¶)”}”(hhh]”(h»)”}”(hŒRemote coverage collection”h]”hŒRemote coverage collection”…””}”(hj•h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj’h²hh³hÊh´KÝubhÌ)”}”(hŒÍBesides collecting coverage data from handlers of syscalls issued from a userspace process, KCOV can also collect coverage for parts of the kernel executing in other contexts - so-called "remote" coverage.”h]”hŒÑBesides collecting coverage data from handlers of syscalls issued from a userspace process, KCOV can also collect coverage for parts of the kernel executing in other contexts - so-called “remote†coverage.”…””}”(hj£h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kßhj’h²hubhÌ)”}”(hŒ/Using KCOV to collect remote coverage requires:”h]”hŒ/Using KCOV to collect remote coverage requires:”…””}”(hj±h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kãhj’h²hubhŒenumerated_list”“”)”}”(hhh]”(hŒ list_item”“”)”}”(hŒModifying kernel code to annotate the code section from where coverage should be collected with ``kcov_remote_start`` and ``kcov_remote_stop``. ”h]”hÌ)”}”(hŒModifying kernel code to annotate the code section from where coverage should be collected with ``kcov_remote_start`` and ``kcov_remote_stop``.”h]”(hŒ`Modifying kernel code to annotate the code section from where coverage should be collected with ”…””}”(hjÊh²hh³Nh´NubhÖ)”}”(hŒ``kcov_remote_start``”h]”hŒkcov_remote_start”…””}”(hjÒh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjÊubhŒ and ”…””}”(hjÊh²hh³Nh´NubhÖ)”}”(hŒ``kcov_remote_stop``”h]”hŒkcov_remote_stop”…””}”(hjäh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjÊubhŒ.”…””}”(hjÊh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KåhjÆubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄhjÁh²hh³hÊh´NubjÅ)”}”(hŒiUsing ``KCOV_REMOTE_ENABLE`` instead of ``KCOV_ENABLE`` in the userspace process that collects coverage. ”h]”hÌ)”}”(hŒhUsing ``KCOV_REMOTE_ENABLE`` instead of ``KCOV_ENABLE`` in the userspace process that collects coverage.”h]”(hŒUsing ”…””}”(hjh²hh³Nh´NubhÖ)”}”(hŒ``KCOV_REMOTE_ENABLE``”h]”hŒKCOV_REMOTE_ENABLE”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjubhŒ instead of ”…””}”(hjh²hh³Nh´NubhÖ)”}”(hŒ``KCOV_ENABLE``”h]”hŒ KCOV_ENABLE”…””}”(hj h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjubhŒ1 in the userspace process that collects coverage.”…””}”(hjh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kèhjubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄhjÁh²hh³hÊh´Nubeh}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œarabic”Œprefix”hŒsuffix”Œ.”uh1j¿hj’h²hh³hÊh´KåubhÌ)”}”(hXBoth ``kcov_remote_start`` and ``kcov_remote_stop`` annotations and the ``KCOV_REMOTE_ENABLE`` ioctl accept handles that identify particular coverage collection sections. The way a handle is used depends on the context where the matching code section executes.”h]”(hŒBoth ”…””}”(hjIh²hh³Nh´NubhÖ)”}”(hŒ``kcov_remote_start``”h]”hŒkcov_remote_start”…””}”(hjQh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjIubhŒ and ”…””}”(hjIh²hh³Nh´NubhÖ)”}”(hŒ``kcov_remote_stop``”h]”hŒkcov_remote_stop”…””}”(hjch²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjIubhŒ annotations and the ”…””}”(hjIh²hh³Nh´NubhÖ)”}”(hŒ``KCOV_REMOTE_ENABLE``”h]”hŒKCOV_REMOTE_ENABLE”…””}”(hjuh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjIubhŒ¦ ioctl accept handles that identify particular coverage collection sections. The way a handle is used depends on the context where the matching code section executes.”…””}”(hjIh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Këhj’h²hubhÌ)”}”(hŒEKCOV supports collecting remote coverage from the following contexts:”h]”hŒEKCOV supports collecting remote coverage from the following contexts:”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kðhj’h²hubjÀ)”}”(hhh]”(jÅ)”}”(hŒ¹Global kernel background tasks. These are the tasks that are spawned during kernel boot in a limited number of instances (e.g. one USB ``hub_event`` worker is spawned per one USB HCD). ”h]”hÌ)”}”(hŒ¸Global kernel background tasks. These are the tasks that are spawned during kernel boot in a limited number of instances (e.g. one USB ``hub_event`` worker is spawned per one USB HCD).”h]”(hŒ‡Global kernel background tasks. These are the tasks that are spawned during kernel boot in a limited number of instances (e.g. one USB ”…””}”(hj¢h²hh³Nh´NubhÖ)”}”(hŒ ``hub_event``”h]”hŒ hub_event”…””}”(hjªh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhj¢ubhŒ$ worker is spawned per one USB HCD).”…””}”(hj¢h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kòhjžubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄhj›h²hh³hÊh´NubjÅ)”}”(hŒ³Local kernel background tasks. These are spawned when a userspace process interacts with some kernel interface and are usually killed when the process exits (e.g. vhost workers). ”h]”hÌ)”}”(hŒ²Local kernel background tasks. These are spawned when a userspace process interacts with some kernel interface and are usually killed when the process exits (e.g. vhost workers).”h]”hŒ²Local kernel background tasks. These are spawned when a userspace process interacts with some kernel interface and are usually killed when the process exits (e.g. vhost workers).”…””}”(hjÌh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KöhjÈubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄhj›h²hh³hÊh´NubjÅ)”}”(hŒSoft interrupts. ”h]”hÌ)”}”(hŒSoft interrupts.”h]”hŒSoft interrupts.”…””}”(hjäh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kúhjàubah}”(h]”h ]”h"]”h$]”h&]”uh1jÄhj›h²hh³hÊh´Nubeh}”(h]”h ]”h"]”h$]”h&]”jDjEjFhjGjHuh1j¿hj’h²hh³hÊh´KòubhÌ)”}”(hX£For #1 and #3, a unique global handle must be chosen and passed to the corresponding ``kcov_remote_start`` call. Then a userspace process must pass this handle to ``KCOV_REMOTE_ENABLE`` in the ``handles`` array field of the ``kcov_remote_arg`` struct. This will attach the used KCOV device to the code section referenced by this handle. Multiple global handles identifying different code sections can be passed at once.”h]”(hŒUFor #1 and #3, a unique global handle must be chosen and passed to the corresponding ”…””}”(hjþh²hh³Nh´NubhÖ)”}”(hŒ``kcov_remote_start``”h]”hŒkcov_remote_start”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjþubhŒ9 call. Then a userspace process must pass this handle to ”…””}”(hjþh²hh³Nh´NubhÖ)”}”(hŒ``KCOV_REMOTE_ENABLE``”h]”hŒKCOV_REMOTE_ENABLE”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjþubhŒ in the ”…””}”(hjþh²hh³Nh´NubhÖ)”}”(hŒ ``handles``”h]”hŒhandles”…””}”(hj*h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjþubhŒ array field of the ”…””}”(hjþh²hh³Nh´NubhÖ)”}”(hŒ``kcov_remote_arg``”h]”hŒkcov_remote_arg”…””}”(hj<h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjþubhŒ° struct. This will attach the used KCOV device to the code section referenced by this handle. Multiple global handles identifying different code sections can be passed at once.”…””}”(hjþh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kühj’h²hubhÌ)”}”(hX¶For #2, the userspace process instead must pass a non-zero handle through the ``common_handle`` field of the ``kcov_remote_arg`` struct. This common handle gets saved to the ``kcov_handle`` field in the current ``task_struct`` and needs to be passed to the newly spawned local tasks via custom kernel code modifications. Those tasks should in turn use the passed handle in their ``kcov_remote_start`` and ``kcov_remote_stop`` annotations.”h]”(hŒNFor #2, the userspace process instead must pass a non-zero handle through the ”…””}”(hjTh²hh³Nh´NubhÖ)”}”(hŒ``common_handle``”h]”hŒ common_handle”…””}”(hj\h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjTubhŒ field of the ”…””}”(hjTh²hh³Nh´NubhÖ)”}”(hŒ``kcov_remote_arg``”h]”hŒkcov_remote_arg”…””}”(hjnh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjTubhŒ. struct. This common handle gets saved to the ”…””}”(hjTh²hh³Nh´NubhÖ)”}”(hŒ``kcov_handle``”h]”hŒ kcov_handle”…””}”(hj€h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjTubhŒ field in the current ”…””}”(hjTh²hh³Nh´NubhÖ)”}”(hŒ``task_struct``”h]”hŒ task_struct”…””}”(hj’h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjTubhŒ™ and needs to be passed to the newly spawned local tasks via custom kernel code modifications. Those tasks should in turn use the passed handle in their ”…””}”(hjTh²hh³Nh´NubhÖ)”}”(hŒ``kcov_remote_start``”h]”hŒkcov_remote_start”…””}”(hj¤h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjTubhŒ and ”…””}”(hjTh²hh³Nh´NubhÖ)”}”(hŒ``kcov_remote_stop``”h]”hŒkcov_remote_stop”…””}”(hj¶h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjTubhŒ annotations.”…””}”(hjTh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhj’h²hubhÌ)”}”(hŒËKCOV follows a predefined format for both global and common handles. Each handle is a ``u64`` integer. Currently, only the one top and the lower 4 bytes are used. Bytes 4-7 are reserved and must be zero.”h]”(hŒVKCOV follows a predefined format for both global and common handles. Each handle is a ”…””}”(hjÎh²hh³Nh´NubhÖ)”}”(hŒ``u64``”h]”hŒu64”…””}”(hjÖh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjÎubhŒn integer. Currently, only the one top and the lower 4 bytes are used. Bytes 4-7 are reserved and must be zero.”…””}”(hjÎh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M hj’h²hubhÌ)”}”(hXOFor global handles, the top byte of the handle denotes the id of a subsystem this handle belongs to. For example, KCOV uses ``1`` as the USB subsystem id. The lower 4 bytes of a global handle denote the id of a task instance within that subsystem. For example, each ``hub_event`` worker uses the USB bus number as the task instance id.”h]”(hŒ|For global handles, the top byte of the handle denotes the id of a subsystem this handle belongs to. For example, KCOV uses ”…””}”(hjîh²hh³Nh´NubhÖ)”}”(hŒ``1``”h]”hŒ1”…””}”(hjöh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjîubhŒ‰ as the USB subsystem id. The lower 4 bytes of a global handle denote the id of a task instance within that subsystem. For example, each ”…””}”(hjîh²hh³Nh´NubhÖ)”}”(hŒ ``hub_event``”h]”hŒ hub_event”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhjîubhŒ8 worker uses the USB bus number as the task instance id.”…””}”(hjîh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhj’h²hubhÌ)”}”(hX,For common handles, a reserved value ``0`` is used as a subsystem id, as such handles don't belong to a particular subsystem. The lower 4 bytes of a common handle identify a collective instance of all local tasks spawned by the userspace process that passed a common handle to ``KCOV_REMOTE_ENABLE``.”h]”(hŒ%For common handles, a reserved value ”…””}”(hj h²hh³Nh´NubhÖ)”}”(hŒ``0``”h]”hŒ0”…””}”(hj(h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhj ubhŒí is used as a subsystem id, as such handles don’t belong to a particular subsystem. The lower 4 bytes of a common handle identify a collective instance of all local tasks spawned by the userspace process that passed a common handle to ”…””}”(hj h²hh³Nh´NubhÖ)”}”(hŒ``KCOV_REMOTE_ENABLE``”h]”hŒKCOV_REMOTE_ENABLE”…””}”(hj:h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÕhj ubhŒ.”…””}”(hj h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhj’h²hubhÌ)”}”(hXAIn practice, any value can be used for common handle instance id if coverage is only collected from a single userspace process on the system. However, if common handles are used by multiple processes, unique instance ids must be used for each process. One option is to use the process id as the common handle instance id.”h]”hXAIn practice, any value can be used for common handle instance id if coverage is only collected from a single userspace process on the system. However, if common handles are used by multiple processes, unique instance ids must be used for each process. One option is to use the process id as the common handle instance id.”…””}”(hjRh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhj’h²hubhÌ)”}”(hŒ›The following program demonstrates using KCOV to collect coverage from both local tasks spawned by the process and the global task that handles USB bus #1:”h]”hŒ›The following program demonstrates using KCOV to collect coverage from both local tasks spawned by the process and the global task that handles USB bus #1:”…””}”(hj`h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhj’h²hubjU)”}”(hXS /* Same includes and defines as above. */ struct kcov_remote_arg { __u32 trace_mode; __u32 area_size; __u32 num_handles; __aligned_u64 common_handle; __aligned_u64 handles[0]; }; #define KCOV_INIT_TRACE _IOR('c', 1, unsigned long) #define KCOV_DISABLE _IO('c', 101) #define KCOV_REMOTE_ENABLE _IOW('c', 102, struct kcov_remote_arg) #define COVER_SIZE (64 << 10) #define KCOV_TRACE_PC 0 #define KCOV_SUBSYSTEM_COMMON (0x00ull << 56) #define KCOV_SUBSYSTEM_USB (0x01ull << 56) #define KCOV_SUBSYSTEM_MASK (0xffull << 56) #define KCOV_INSTANCE_MASK (0xffffffffull) static inline __u64 kcov_remote_handle(__u64 subsys, __u64 inst) { if (subsys & ~KCOV_SUBSYSTEM_MASK || inst & ~KCOV_INSTANCE_MASK) return 0; return subsys | inst; } #define KCOV_COMMON_ID 0x42 #define KCOV_USB_BUS_NUM 1 int main(int argc, char **argv) { int fd; unsigned long *cover, n, i; struct kcov_remote_arg *arg; fd = open("/sys/kernel/debug/kcov", O_RDWR); if (fd == -1) perror("open"), exit(1); if (ioctl(fd, KCOV_INIT_TRACE, COVER_SIZE)) perror("ioctl"), exit(1); cover = (unsigned long*)mmap(NULL, COVER_SIZE * sizeof(unsigned long), PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0); if ((void*)cover == MAP_FAILED) perror("mmap"), exit(1); /* Enable coverage collection via common handle and from USB bus #1. */ arg = calloc(1, sizeof(*arg) + sizeof(uint64_t)); if (!arg) perror("calloc"), exit(1); arg->trace_mode = KCOV_TRACE_PC; arg->area_size = COVER_SIZE; arg->num_handles = 1; arg->common_handle = kcov_remote_handle(KCOV_SUBSYSTEM_COMMON, KCOV_COMMON_ID); arg->handles[0] = kcov_remote_handle(KCOV_SUBSYSTEM_USB, KCOV_USB_BUS_NUM); if (ioctl(fd, KCOV_REMOTE_ENABLE, arg)) perror("ioctl"), free(arg), exit(1); free(arg); /* * Here the user needs to trigger execution of a kernel code section * that is either annotated with the common handle, or to trigger some * activity on USB bus #1. */ sleep(2); /* * The load to the coverage count should be an acquire to pair with * pair with the corresponding write memory barrier (smp_wmb()) on * the kernel-side in kcov_move_area(). */ n = __atomic_load_n(&cover[0], __ATOMIC_ACQUIRE); for (i = 0; i < n; i++) printf("0x%lx\n", cover[i + 1]); if (ioctl(fd, KCOV_DISABLE, 0)) perror("ioctl"), exit(1); if (munmap(cover, COVER_SIZE * sizeof(unsigned long))) perror("munmap"), exit(1); if (close(fd)) perror("close"), exit(1); return 0; }”h]”hXS /* Same includes and defines as above. */ struct kcov_remote_arg { __u32 trace_mode; __u32 area_size; __u32 num_handles; __aligned_u64 common_handle; __aligned_u64 handles[0]; }; #define KCOV_INIT_TRACE _IOR('c', 1, unsigned long) #define KCOV_DISABLE _IO('c', 101) #define KCOV_REMOTE_ENABLE _IOW('c', 102, struct kcov_remote_arg) #define COVER_SIZE (64 << 10) #define KCOV_TRACE_PC 0 #define KCOV_SUBSYSTEM_COMMON (0x00ull << 56) #define KCOV_SUBSYSTEM_USB (0x01ull << 56) #define KCOV_SUBSYSTEM_MASK (0xffull << 56) #define KCOV_INSTANCE_MASK (0xffffffffull) static inline __u64 kcov_remote_handle(__u64 subsys, __u64 inst) { if (subsys & ~KCOV_SUBSYSTEM_MASK || inst & ~KCOV_INSTANCE_MASK) return 0; return subsys | inst; } #define KCOV_COMMON_ID 0x42 #define KCOV_USB_BUS_NUM 1 int main(int argc, char **argv) { int fd; unsigned long *cover, n, i; struct kcov_remote_arg *arg; fd = open("/sys/kernel/debug/kcov", O_RDWR); if (fd == -1) perror("open"), exit(1); if (ioctl(fd, KCOV_INIT_TRACE, COVER_SIZE)) perror("ioctl"), exit(1); cover = (unsigned long*)mmap(NULL, COVER_SIZE * sizeof(unsigned long), PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0); if ((void*)cover == MAP_FAILED) perror("mmap"), exit(1); /* Enable coverage collection via common handle and from USB bus #1. */ arg = calloc(1, sizeof(*arg) + sizeof(uint64_t)); if (!arg) perror("calloc"), exit(1); arg->trace_mode = KCOV_TRACE_PC; arg->area_size = COVER_SIZE; arg->num_handles = 1; arg->common_handle = kcov_remote_handle(KCOV_SUBSYSTEM_COMMON, KCOV_COMMON_ID); arg->handles[0] = kcov_remote_handle(KCOV_SUBSYSTEM_USB, KCOV_USB_BUS_NUM); if (ioctl(fd, KCOV_REMOTE_ENABLE, arg)) perror("ioctl"), free(arg), exit(1); free(arg); /* * Here the user needs to trigger execution of a kernel code section * that is either annotated with the common handle, or to trigger some * activity on USB bus #1. */ sleep(2); /* * The load to the coverage count should be an acquire to pair with * pair with the corresponding write memory barrier (smp_wmb()) on * the kernel-side in kcov_move_area(). */ n = __atomic_load_n(&cover[0], __ATOMIC_ACQUIRE); for (i = 0; i < n; i++) printf("0x%lx\n", cover[i + 1]); if (ioctl(fd, KCOV_DISABLE, 0)) perror("ioctl"), exit(1); if (munmap(cover, COVER_SIZE * sizeof(unsigned long))) perror("munmap"), exit(1); if (close(fd)) perror("close"), exit(1); return 0; }”…””}”hjnsbah}”(h]”h ]”h"]”h$]”h&]”jdjejÓ‰jÔjÕjÖ}”uh1jTh³hÊh´M"hj’h²hubeh}”(h]”Œremote-coverage-collection”ah ]”h"]”Œremote coverage collection”ah$]”h&]”uh1hµhh·h²hh³hÊh´KÝubeh}”(h]”Œkcov-code-coverage-for-fuzzing”ah ]”h"]”Œkcov: code coverage for fuzzing”ah$]”h&]”uh1hµhhh²hh³hÊh´Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”hÊuh1hŒcurrent_source”NŒ current_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(hºNŒ generator”NŒ datestamp”NŒ source_link”NŒ source_url”NŒ toc_backlinks”Œentry”Œfootnote_backlinks”KŒ sectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒ strip_classes”NŒ report_level”KŒ halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ traceback”ˆŒinput_encoding”Œ utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j°Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œ language_code”Œen”Œrecord_dependencies”NŒconfig”NŒ id_prefix”hŒauto_id_prefix”Œid”Œ dump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”hÊŒ _destination”NŒ _config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒ raw_enabled”KŒline_length_limit”M'Œpep_references”NŒ pep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒ rfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œ smart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œ docinfo_xform”KŒsectsubtitle_xform”‰Œ image_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jŠj‡j£j jKjHjjŒj‚juŒ nametypes”}”(jЉj£‰jK‰j‰j‚‰uh}”(j‡h·j jjHj¦jŒjNjj’uŒ footnote_refs”}”Œ citation_refs”}”Œ autofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ footnotes”]”Œ citations”]”Œautofootnote_start”KŒsymbol_footnote_start”KŒ id_counter”Œ collections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œ transformer”NŒ include_log”]”Œ decoration”Nh²hub.