1. Annotations
    Linux kernel definitions  Examples 

2. See also

3. References

4. Further reading

5. External links

Sparse is a computer software tool designed to find possible coding faults in the Linux kernel.^[2] Unlike other such tools, this static analysis tool was initially designed to only flag constructs that were likely to be of interest to kernel developers, such as the mixing of pointers to user and kernel address spaces.

Sparse checks for known problems and allows the developer to include annotations in the code that convey information about data types, such as the address space that pointers point to and the locks that a function acquires or releases.

and by Luc Van Oostenryck in November 2018^[4].

Sparse is released under the MIT License.

Annotations

Some of the checks performed by Sparse require annotating the source code using the __attribute__ GCC extension, or the Sparse-specific __context__ specifier.^[5] Sparse defines the following list of attributes:

• address_space(num)
• bitwise
• force
• context(expression,in_context,out_context)

When an API is defined with a macro, the specifier __attribute__((context(...))) can be replaced by __context__(...).

Linux kernel definitions

The Linux kernel defines the following short forms as pre-processor macros in files linux/compiler.h and linux/types.h (when building without the __CHECKER__ flag, all these annotations are removed from the code):

1. ifdef __CHECKER__
2. define __user __attribute__((noderef, address_space(1)))
3. define __kernel __attribute__((address_space(0)))
4. define __safe __attribute__((safe))
5. define __force __attribute__((force))
6. define __nocast __attribute__((nocast))
7. define __iomem __attribute__((noderef, address_space(2)))
8. define __must_hold(x) __attribute__((context(x,1,1)))
9. define __acquires(x) __attribute__((context(x,0,1)))
10. define __releases(x) __attribute__((context(x,1,0)))
11. define __acquire(x) __context__(x,1)
12. define __release(x) __context__(x,-1)
13. define __cond_lock(x,c) ((c) ? ({ __acquire(x); 1; }) : 0)
14. define __percpu __attribute__((noderef, address_space(3)))
15. ifdef CONFIG_SPARSE_RCU_POINTER
16. define __rcu __attribute__((noderef, address_space(4)))
17. else
18. define __rcu
19. endif

extern void __chk_user_ptr(const volatile void __user *);

extern void __chk_io_ptr(const volatile void __iomem *);

1. else
2. define __user
3. define __kernel
4. define __safe
5. define __force
6. define __nocast
7. define __iomem
8. define __chk_user_ptr(x) (void)0
9. define __chk_io_ptr(x) (void)0
10. define __builtin_warning(x, y...) (1)
11. define __must_hold(x)
12. define __acquires(x)
13. define __releases(x)
14. define __acquire(x) (void)0
15. define __release(x) (void)0
16. define __cond_lock(x,c) (c)
17. define __percpu
18. define __rcu
19. endif

1. ifdef __CHECKER__
2. define __bitwise __attribute__((bitwise))
3. else
4. define __bitwise
5. endif

Examples

The types __le32 and __be32 represent 32-bit integer types with different endianness. However, the C language does not allow to specify that variables of these types should not be mixed. The bitwise attribute is used to mark these types as restricted, so Sparse will give a warning if variables of these types or other integer variables are mixed:

typedef __u32 __bitwise __le32;

typedef __u32 __bitwise __be32;

To mark valid conversions between restricted types, a casting with the force attribute is used to avoid Sparse giving a warning.

See also

• List of tools for static code analysis

References

Further reading

• {{cite web

• {{cite web

• {{cite conference

• {{cite thesis

External links

• {{Official website|sparse.wiki.kernel.org}}
• [https://www.kernel.org/doc/html/latest/dev-tools/sparse.html Using sparse for typechecking], Linux Kernel Documentation
• {{man|1|sparse|Linux|Semantic Parser for C}}
• {{man|1|cgcc|Linux|Compiler wrapper to run Sparse after compiling}}

• Deep Flight Merlin
• DeepFlight Super Falcon
• Deep forest
• Deep Freeze (CSI: Miami)
• Deep Freeze (CSI: Miami episode)
• Deep Freeze (disambiguation)
• Deep Freeze (film)
• Deep Freeze (software)
• Deep Fried and Minty Fresh
• Deep-fried chicken
• Deep fried chicken
• Deep Fried Film
• Deep Fried Man
• Deep-fried Mars Bar
• Deep Fried & Minty Fresh
• Deep-fried peanuts
• Deep Fried Peanuts
• Deep-fried Twinkies
• Deep fryers
• Deep-frying
• Deep fungal infections
• Deepgate Codex
• Deep Gems
• Deep Geologic Repository
• Deep Gold