English

• Chinese (Simplified)
• Chinese (Traditional)

Development tools for the kernel

This document is a collection of documents about development tools that can be used to work on the kernel. For now, the documents have been pulled together without any significant effort to integrate them into a coherent whole; patches welcome!

A brief overview of testing-specific tools can be found in Kernel Testing Guide

Table of contents

• Kernel Testing Guide
  • Writing and Running Tests
  • Code Coverage Tools
  • Dynamic Analysis Tools
  • Static Analysis Tools
• Checkpatch
  • Options
  • Message Levels
  • Type Descriptions
• clang-format
  • Review files and patches for coding style
  • Reformatting blocks of code
  • Missing support
  • Extra features/options
• Coccinelle
  • Getting Coccinelle
  • Supplemental documentation
  • Using Coccinelle on the Linux kernel
  • Coccinelle parallelization
  • Using Coccinelle with a single semantic patch
  • Controlling Which Files are Processed by Coccinelle
  • Debugging Coccinelle SmPL patches
  • .cocciconfig support
  • Additional flags
  • SmPL patch specific options
  • SmPL patch Coccinelle requirements
  • Proposing new semantic patches
  • Detailed description of the report mode
  • Detailed description of the patch mode
  • Detailed description of the context mode
  • Detailed description of the org mode
• Sparse
  • Using sparse for typechecking
  • Using sparse for lock checking
  • Getting sparse
  • Using sparse
• KCOV: code coverage for fuzzing
  • Prerequisites
  • Coverage collection
  • Comparison operands collection
  • Remote coverage collection
• Using gcov with the Linux kernel
  • Preparation
  • Customization
  • Files
  • Modules
  • Separated build and test machines
  • Note on compilers
  • Troubleshooting
  • Appendix A: gather_on_build.sh
  • Appendix B: gather_on_test.sh
• Kernel Address Sanitizer (KASAN)
  • Overview
  • Support
  • Usage
  • Implementation details
  • Shadow memory
  • For developers
• Kernel Memory Sanitizer (KMSAN)
  • Usage
  • Support
  • How KMSAN works
  • References
• Undefined Behavior Sanitizer - UBSAN
  • Report example
  • Usage
  • References
• Kernel Memory Leak Detector
  • Usage
  • Basic Algorithm
  • Testing specific sections with kmemleak
  • Freeing kmemleak internal objects
  • Kmemleak API
  • Dealing with false positives/negatives
  • Limitations and Drawbacks
  • Testing with kmemleak-test
• Kernel Concurrency Sanitizer (KCSAN)
  • Usage
  • Data Races
  • Race Detection Beyond Data Races
  • Implementation Details
  • Alternatives Considered
• Kernel Electric-Fence (KFENCE)
  • Usage
  • Implementation Details
  • Interface
  • Related Tools
• Debugging kernel and modules via gdb
  • Requirements
  • Setup
  • Examples of using the Linux-provided gdb helpers
  • List of commands and functions
• Using kgdb, kdb and the kernel debugger internals
  • Introduction
  • Compiling a kernel
  • Kernel Debugger Boot Arguments
  • Using kdb
  • Using kgdb / gdb
  • kgdb and kdb interoperability
  • kgdb Test Suite
  • Kernel Debugger Internals
  • Credits
• Linux Kernel Selftests
  • Running the selftests (hotplug tests are run in limited mode)
  • Running a subset of selftests
  • Running the full range hotplug selftests
  • Install selftests
  • Running installed selftests
  • Timeout for selftests
  • Packaging selftests
  • Contributing new tests
  • Contributing new tests (details)
  • Test Module
  • Test Harness
• KUnit - Linux Kernel Unit Testing
  • Getting Started
  • KUnit Architecture
  • Running tests with kunit_tool
  • Run Tests without kunit_tool
  • Writing Tests
  • Common Patterns
  • API Reference
  • Test Style and Nomenclature
  • Frequently Asked Questions
  • Tips For Running KUnit Tests
  • Introduction
  • Unit Testing
  • How do I use it?
• The Kernel Test Anything Protocol (KTAP), version 1
  • Version lines
  • Plan lines
  • Test case result lines
  • Diagnostic lines
  • Unknown lines
  • Nested tests
  • Major differences between TAP and KTAP
  • Example KTAP output
  • See also:
• UAPI Checker
  • Options
  • Examples
  • Caveats
• Linux Kernel GPIO based sloppy logic analyzer
  • Introduction
  • Setup
  • Usage