xref: /linux/samples/Kconfig (revision df87101f816083ad5da559f8be8eac1cee94e38f)
1# SPDX-License-Identifier: GPL-2.0-only
2menuconfig SAMPLES
3	bool "Sample kernel code"
4	help
5	  You can build and test sample kernel code here.
6
7if SAMPLES
8
9config SAMPLE_AUXDISPLAY
10	bool "auxdisplay sample"
11	depends on CC_CAN_LINK
12
13config SAMPLE_TRACE_EVENTS
14	tristate "Build trace_events examples -- loadable modules only"
15	depends on EVENT_TRACING && m
16	help
17	  This builds the trace event example module.
18
19config SAMPLE_TRACE_CUSTOM_EVENTS
20	tristate "Build custom trace event example -- loadable modules only"
21	depends on EVENT_TRACING && m
22	help
23	  This builds the custom trace event example module.
24
25config SAMPLE_TRACE_PRINTK
26	tristate "Build trace_printk module - tests various trace_printk formats"
27	depends on EVENT_TRACING && m
28	help
29	  This builds a module that calls trace_printk() and can be used to
30	  test various trace_printk() calls from a module.
31
32config SAMPLE_FTRACE_DIRECT
33	tristate "Build register_ftrace_direct() example"
34	depends on DYNAMIC_FTRACE_WITH_DIRECT_CALLS && m
35	depends on HAVE_SAMPLE_FTRACE_DIRECT
36	help
37	  This builds an ftrace direct function example
38	  that hooks to wake_up_process and prints the parameters.
39
40config SAMPLE_FTRACE_DIRECT_MULTI
41	tristate "Build register_ftrace_direct() on multiple ips example"
42	depends on DYNAMIC_FTRACE_WITH_DIRECT_CALLS && m
43	depends on HAVE_SAMPLE_FTRACE_DIRECT_MULTI
44	help
45	  This builds an ftrace direct function example
46	  that hooks to wake_up_process and schedule, and prints
47	  the function addresses.
48
49config SAMPLE_FTRACE_OPS
50	tristate "Build custom ftrace ops example"
51	depends on FUNCTION_TRACER
52	help
53	  This builds an ftrace ops example that hooks two functions and
54	  measures the time taken to invoke one function a number of times.
55
56config SAMPLE_TRACE_ARRAY
57	tristate "Build sample module for kernel access to Ftrace instances"
58	depends on EVENT_TRACING && m
59	help
60	  This builds a module that demonstrates the use of various APIs to
61	  access Ftrace instances from within the kernel.
62
63config SAMPLE_KOBJECT
64	tristate "Build kobject examples"
65	help
66	  This config option will allow you to build a number of
67	  different kobject sample modules showing how to use kobjects,
68	  ksets, and ktypes properly.
69
70	  If in doubt, say "N" here.
71
72config SAMPLE_KPROBES
73	tristate "Build kprobes examples -- loadable modules only"
74	depends on KPROBES && EVENT_TRACING && m
75	help
76	  This build several kprobes example modules.
77
78config SAMPLE_KRETPROBES
79	tristate "Build kretprobes example -- loadable modules only"
80	default m
81	depends on SAMPLE_KPROBES && KRETPROBES
82
83config SAMPLE_HW_BREAKPOINT
84	tristate "Build kernel hardware breakpoint examples -- loadable module only"
85	depends on HAVE_HW_BREAKPOINT && m
86	help
87	  This builds kernel hardware breakpoint example modules.
88
89config SAMPLE_FPROBE
90	tristate "Build fprobe examples -- loadable modules only"
91	depends on FPROBE && EVENT_TRACING && m
92	help
93	  This builds a fprobe example module. This module has an option 'symbol'.
94	  You can specify a probed symbol or symbols separated with ','.
95
96config SAMPLE_KFIFO
97	tristate "Build kfifo examples -- loadable modules only"
98	depends on m
99	help
100	  This config option will allow you to build a number of
101	  different kfifo sample modules showing how to use the
102	  generic kfifo API.
103
104	  If in doubt, say "N" here.
105
106config SAMPLE_KDB
107	tristate "Build kdb command example -- loadable modules only"
108	depends on KGDB_KDB && m
109	help
110	  Build an example of how to dynamically add the hello
111	  command to the kdb shell.
112
113config SAMPLE_QMI_CLIENT
114	tristate "Build qmi client sample -- loadable modules only"
115	depends on m
116	depends on ARCH_QCOM
117	depends on NET
118	select QCOM_QMI_HELPERS
119	help
120	  Build an QMI client sample driver, which demonstrates how to
121	  communicate with a remote QRTR service, using QMI encoded messages.
122
123config SAMPLE_RPMSG_CLIENT
124	tristate "Build rpmsg client sample -- loadable modules only"
125	depends on RPMSG && m
126	help
127	  Build an rpmsg client sample driver, which demonstrates how
128	  to communicate with an AMP-configured remote processor over
129	  the rpmsg bus.
130
131config SAMPLE_LIVEPATCH
132	tristate "Build live patching samples -- loadable modules only"
133	depends on LIVEPATCH && m
134	help
135	  Build sample live patch demonstrations.
136
137config SAMPLE_CONFIGFS
138	tristate "Build configfs patching sample -- loadable modules only"
139	depends on CONFIGFS_FS && m
140	help
141	  Builds a sample configfs interface.
142
143config SAMPLE_CONNECTOR
144	tristate "Build connector sample -- loadable modules only"
145	depends on CONNECTOR && HEADERS_INSTALL && m
146	help
147	  When enabled, this builds both a sample kernel module for
148	  the connector interface and a user space tool to communicate
149	  with it.
150	  See also Documentation/driver-api/connector.rst
151
152config SAMPLE_FANOTIFY_ERROR
153	bool "Build fanotify error monitoring sample"
154	depends on FANOTIFY && CC_CAN_LINK && HEADERS_INSTALL
155	help
156	  When enabled, this builds an example code that uses the
157	  FAN_FS_ERROR fanotify mechanism to monitor filesystem
158	  errors.
159	  See also Documentation/admin-guide/filesystem-monitoring.rst.
160
161config SAMPLE_HIDRAW
162	bool "hidraw sample"
163	depends on CC_CAN_LINK && HEADERS_INSTALL
164
165config SAMPLE_LANDLOCK
166	bool "Landlock example"
167	depends on CC_CAN_LINK && HEADERS_INSTALL
168	help
169	  Build a Landlock sandbox manager able to start a process restricted
170	  by user-defined filesystem, network, scope, namespace, and capability
171	  policies.
172
173	  The optional libcap development headers and library enable capability
174	  names.  Without them, the sample still builds, accepts capability
175	  numbers, and warns when capability settings are used.
176
177config SAMPLE_LANDLOCK_LIBCAP
178	def_bool $(cc_can_link_user,-include sys/capability.h -lcap)
179	depends on SAMPLE_LANDLOCK
180
181config SAMPLE_PIDFD
182	bool "pidfd sample"
183	depends on CC_CAN_LINK && HEADERS_INSTALL
184
185config SAMPLE_SECCOMP
186	bool "Build seccomp sample code"
187	depends on SECCOMP_FILTER && CC_CAN_LINK && HEADERS_INSTALL
188	help
189	  Build samples of seccomp filters using various methods of
190	  BPF filter construction.
191
192config SAMPLE_TIMER
193	bool "Timer sample"
194	depends on CC_CAN_LINK && HEADERS_INSTALL
195
196config SAMPLE_TSM_MR
197	tristate "TSM measurement sample"
198	select CRYPTO_LIB_SHA256
199	select CRYPTO_LIB_SHA512
200	select TSM_MEASUREMENTS
201	select VIRT_DRIVERS
202	help
203	  Build a sample module that emulates MRs (Measurement Registers) and
204	  exposes them to user mode applications through the TSM sysfs
205	  interface (/sys/class/misc/tsm_mr_sample/emulated_mr/).
206
207	  The module name will be tsm-mr-sample when built as a module.
208
209config SAMPLE_UHID
210	bool "UHID sample"
211	depends on CC_CAN_LINK && HEADERS_INSTALL
212	help
213	  Build UHID sample program.
214
215config SAMPLE_VFIO_MDEV_MTTY
216	tristate "Build VFIO mtty example mediated device sample code"
217	depends on VFIO
218	select VFIO_MDEV
219	help
220	  Build a virtual tty sample driver for use as a VFIO
221	  mediated device
222
223config SAMPLE_VFIO_MDEV_MDPY
224	tristate "Build VFIO mdpy example mediated device sample code"
225	depends on VFIO
226	select VFIO_MDEV
227	help
228	  Build a virtual display sample driver for use as a VFIO
229	  mediated device.  It is a simple framebuffer and supports
230	  the region display interface (VFIO_GFX_PLANE_TYPE_REGION).
231
232config SAMPLE_VFIO_MDEV_MDPY_FB
233	tristate "Build VFIO mdpy example guest fbdev driver"
234	depends on FB
235	select FB_IOMEM_HELPERS
236	help
237	  Guest fbdev driver for the virtual display sample driver.
238
239config SAMPLE_VFIO_MDEV_MBOCHS
240	tristate "Build VFIO mbochs example mediated device sample code"
241	depends on VFIO
242	select VFIO_MDEV
243	select DMA_SHARED_BUFFER
244	help
245	  Build a virtual display sample driver for use as a VFIO
246	  mediated device.  It supports the region display interface
247	  (VFIO_GFX_PLANE_TYPE_DMABUF).
248	  Emulate enough of qemu stdvga to make bochs-drm.ko happy.
249	  That is basically the vram memory bar and the bochs dispi
250	  interface vbe registers in the mmio register bar.
251	  Specifically it does *not* include any legacy vga stuff.
252	  Device looks a lot like "qemu -device secondary-vga".
253
254config SAMPLE_ANDROID_BINDERFS
255	bool "Build Android binderfs example"
256	depends on CC_CAN_LINK && HEADERS_INSTALL
257	help
258	  Builds a sample program to illustrate the use of the Android binderfs
259	  filesystem.
260
261config SAMPLE_VFS
262	bool "Build example programs that use new VFS system calls"
263	depends on CC_CAN_LINK && HEADERS_INSTALL
264	help
265	  Build example userspace programs that use new VFS system calls such
266	  as mount API and statx().  Note that this is restricted to the x86
267	  arch whilst it accesses system calls that aren't yet in all arches.
268
269config SAMPLE_INTEL_MEI
270	bool "Build example program working with intel mei driver"
271	depends on INTEL_MEI
272	depends on CC_CAN_LINK && HEADERS_INSTALL
273	help
274	  Build a sample program to work with mei device.
275
276config SAMPLE_TPS6594_PFSM
277	bool "Build example program working with TPS6594 PFSM driver"
278	depends on HEADERS_INSTALL
279	depends on CC_CAN_LINK
280	help
281	  Build a sample program to work with PFSM devices.
282
283config SAMPLE_WATCHDOG
284	bool "watchdog sample"
285	depends on CC_CAN_LINK
286
287config SAMPLE_WATCH_QUEUE
288	bool "Build example watch_queue notification API consumer"
289	depends on CC_CAN_LINK && HEADERS_INSTALL
290	help
291	  Build example userspace program to use the new mount_notify(),
292	  sb_notify() syscalls and the KEYCTL_WATCH_KEY keyctl() function.
293
294config SAMPLE_CORESIGHT_SYSCFG
295	tristate "Build example loadable module for CoreSight config"
296	depends on CORESIGHT && m
297	help
298	  Build an example loadable module that adds new CoreSight features
299	  and configuration using the CoreSight system configuration API.
300	  This demonstrates how a user may create their own CoreSight
301	  configurations and easily load them into the system at runtime.
302
303config SAMPLE_KMEMLEAK
304	tristate "Simple test for the kernel memory leak detector"
305	depends on DEBUG_KMEMLEAK && m
306	help
307	  Build a sample program which have explicitly leaks memory to test
308	  kmemleak.
309
310config SAMPLE_CGROUP
311	bool "Build cgroup sample code"
312	depends on CGROUPS && CC_CAN_LINK && HEADERS_INSTALL
313	help
314	  Build samples that demonstrate the usage of the cgroup API.
315
316config SAMPLE_CHECK_EXEC
317	bool "Exec secure bits examples"
318	depends on CC_CAN_LINK && HEADERS_INSTALL
319	help
320	  Build a tool to easily configure SECBIT_EXEC_RESTRICT_FILE and
321	  SECBIT_EXEC_DENY_INTERACTIVE, and a simple script interpreter to
322	  demonstrate how they should be used with execveat(2) +
323	  AT_EXECVE_CHECK.
324
325config SAMPLE_HUNG_TASK
326	tristate "Hung task detector test code"
327	depends on DETECT_HUNG_TASK && DEBUG_FS
328	help
329	  Build a module that provides debugfs files (e.g., mutex, semaphore,
330	  rw_semaphore_read, rw_semaphore_write) under <debugfs>/hung_task.
331	  Reading these files with multiple processes triggers hung task
332	  detection by holding locks for a long time (256 seconds).
333
334source "samples/rust/Kconfig"
335
336source "samples/damon/Kconfig"
337
338endif # SAMPLES
339
340config HAVE_SAMPLE_FTRACE_DIRECT
341	bool
342
343config HAVE_SAMPLE_FTRACE_DIRECT_MULTI
344	bool
345