xref: /freebsd/sys/conf/options (revision ee2ea5ceafed78a5bd9810beb9e3ca927180c226)
1# $FreeBSD$
2#
3#        On the handling of kernel options
4#
5# All kernel options should be listed in NOTES, with suitable
6# descriptions.  Negative options (options that make some code not
7# compile) should be commented out; LINT (generated from NOTES) should
8# compile as much code as possible.  Try to structure option-using
9# code so that a single option only switch code on, or only switch
10# code off, to make it possible to have a full compile-test.  If
11# necessary, you can check for COMPILING_LINT to get maximum code
12# coverage.
13#
14# All new options shall also be listed in either "conf/options" or
15# "conf/options.<machine>".  Options that affect a single source-file
16# <xxx>.[c|s] should be directed into "opt_<xxx>.h", while options
17# that affect multiple files should either go in "opt_global.h" if
18# this is a kernel-wide option (used just about everywhere), or in
19# "opt_<option-name-in-lower-case>.h" if it affect only some files.
20# Note that the effect of listing only an option without a
21# header-file-name in conf/options (and cousins) is that the last
22# convention is followed.
23#
24# This handling scheme is not yet fully implemented.
25#
26#
27# Format of this file:
28# Option name	filename
29#
30# If filename is missing, the default is
31# opt_<name-of-option-in-lower-case>.h
32
33# Adaptec Array Controller driver options
34AAC_COMPAT_LINUX	opt_aac.h	# Enable the linux ioctl interface
35
36AAC_DEBUG		opt_aac.h	# Debugging levels:
37					# 0 - quiet, only emit warnings
38					# 1 - noisy, emit major function
39					#     points and things done
40					# 2 - extremely noisy, emit trace
41					#     items in loops, etc.
42
43# Adaptec aic7xxx SCSI controller options
44AHC_ALLOW_MEMIO		opt_aic7xxx.h	# Allow PCI devices to use memory
45					# mapped I/O
46
47AHC_TMODE_ENABLE	opt_aic7xxx.h	# Bitmap of units to enable
48					# targetmode operations.
49
50AHC_DUMP_EEPROM		opt_aic7xxx.h	# Dump the contents of our
51					# configuration prom.
52
53AHC_DEBUG_SEQUENCER	opt_aic7xxx.h	# Enable diagnostic sequencer code
54
55ADW_ALLOW_MEMIO		opt_adw.h	# Allow PCI devices to use memory
56					# mapped I/O
57
58# Miscellaneous options.
59GEOM		opt_geom.h
60COMPAT_43	opt_compat.h
61COMPAT_SUNOS	opt_compat.h
62COMPILING_LINT	opt_global.h
63CY_PCI_FASTINTR
64DDB
65DDB_UNATTENDED	opt_ddb.h
66GDB_REMOTE_CHAT	opt_ddb.h
67NODEVFS		opt_devfs.h
68HW_WDOG
69KTRACE
70LIBICONV
71MD_ROOT		opt_md.h
72MD_ROOT_SIZE	opt_md.h
73NTIMECOUNTER	opt_ntp.h
74NSWAPDEV	opt_swap.h
75PPS_SYNC	opt_ntp.h
76QUOTA
77SPX_HACK
78SUIDDIR		opt_suiddir.h
79SYSVMSG		opt_sysvipc.h
80SYSVSEM		opt_sysvipc.h
81SYSVSHM		opt_sysvipc.h
82SHMALL		opt_sysvipc.h
83SHMMAX		opt_sysvipc.h
84SHMMAXPGS	opt_sysvipc.h
85SHMMIN		opt_sysvipc.h
86SHMMNI		opt_sysvipc.h
87SHMSEG		opt_sysvipc.h
88SEMMAP		opt_sysvipc.h
89SEMMNI		opt_sysvipc.h
90SEMMNS		opt_sysvipc.h
91SEMMNU		opt_sysvipc.h
92SEMMSL		opt_sysvipc.h
93SEMOPM		opt_sysvipc.h
94SEMUME		opt_sysvipc.h
95MSGMNB		opt_sysvipc.h
96MSGMNI		opt_sysvipc.h
97MSGSEG		opt_sysvipc.h
98MSGSSZ		opt_sysvipc.h
99MSGTQL		opt_sysvipc.h
100VFS_AIO
101
102# POSIX kernel options
103P1003_1B			opt_posix.h
104_KPOSIX_PRIORITY_SCHEDULING	opt_posix.h
105_KPOSIX_VERSION			opt_posix.h
106
107# TrustedBSD and POSIX.1e Kernel Options
108CAPABILITIES	opt_cap.h
109
110# Do we want the config file compiled into the kernel?
111INCLUDE_CONFIG_FILE	opt_config.h
112
113# Options for static file systems.  These should only be used at config
114# time, since the corresponding lkms cannot work if there are any static
115# dependencies.  Unusability is enforced by hiding the defines for the
116# options in a never-included header.
117CD9660		opt_dontuse.h
118CODA		opt_dontuse.h
119EXT2FS		opt_dontuse.h
120FDESCFS		opt_dontuse.h
121LINPROCFS	opt_dontuse.h
122MSDOSFS		opt_dontuse.h
123NULLFS		opt_dontuse.h
124NWFS		opt_dontuse.h
125PORTALFS	opt_dontuse.h
126PROCFS		opt_dontuse.h
127PSEUDOFS	opt_dontuse.h
128UMAPFS		opt_dontuse.h
129NTFS		opt_dontuse.h
130HPFS		opt_dontuse.h
131UNIONFS		opt_dontuse.h
132UDF		opt_dontuse.h
133
134# Broken - ffs_snapshot() dependency from ufs_lookup() :-(
135FFS		opt_ffs_broken_fixme.h
136IFS		opt_ffs_broken_fixme.h
137
138# These static filesystems has one slightly bogus static dependency in
139# sys/i386/i386/autoconf.c.  If any of these filesystems are
140# statically compiled into the kernel, code for mounting them as root
141# filesystems will be enabled - but look below.
142NFSCLIENT	opt_nfs.h
143NFSSERVER	opt_nfs.h
144
145# If you are following the conditions in the copyright,
146# you can enable soft-updates which will speed up a lot of thigs
147# and make the system safer from crashes at the same time.
148# otherwise a STUB module will be compiled in.
149SOFTUPDATES	opt_ffs.h
150
151# Enabling this option turns on support for Access Control Lists in UFS,
152# which can be used to support high security configurations.  Depends on
153# UFS_EXTATTR.
154UFS_ACL		opt_ufs.h
155
156# Enabling this option turns on support for extended attributes in UFS-based
157# file systems, which can be used to support high security configurations
158# as well as new file system features.
159UFS_EXTATTR	opt_ufs.h
160UFS_EXTATTR_AUTOSTART	opt_ufs.h
161
162# Enable fast hash lookups for large directories on UFS-based filesystems.
163UFS_DIRHASH	opt_ufs.h
164
165# The above static dependencies are planned removed, with a
166# <filesystem>_ROOT option to control if it usable as root.  This list
167# allows these options to be present in config files already (though
168# they won't make any difference yet).
169NFS_ROOT	opt_nfsroot.h
170
171# Options used only in subr_param.c.
172HZ		opt_param.h
173MAXFILES	opt_param.h
174NBUF		opt_param.h
175NMBCLUSTERS	opt_param.h
176NSFBUFS		opt_param.h
177VM_BCACHE_SIZE_MAX	opt_param.h
178VM_SWZONE_SIZE_MAX	opt_param.h
179MAXUSERS
180DFLDSIZ		opt_param.h
181MAXDSIZ		opt_param.h
182MAXSSIZ		opt_param.h
183
184# Generic SCSI options.
185CAM_MAX_HIGHPOWER	opt_cam.h
186CAMDEBUG		opt_cam.h
187CAM_DEBUG_DELAY		opt_cam.h
188CAM_DEBUG_BUS		opt_cam.h
189CAM_DEBUG_TARGET	opt_cam.h
190CAM_DEBUG_LUN		opt_cam.h
191CAM_DEBUG_FLAGS		opt_cam.h
192CAM_NEW_TRAN_CODE	opt_cam.h
193SCSI_DELAY		opt_scsi.h
194SCSI_NO_SENSE_STRINGS	opt_scsi.h
195SCSI_NO_OP_STRINGS	opt_scsi.h
196
197
198
199# Options used only in cam/scsi/scsi_cd.c
200CHANGER_MIN_BUSY_SECONDS	opt_cd.h
201CHANGER_MAX_BUSY_SECONDS	opt_cd.h
202
203# Options used only in cam/scsi/scsi_sa.c.
204SA_IO_TIMEOUT		opt_sa.h
205SA_SPACE_TIMEOUT	opt_sa.h
206SA_REWIND_TIMEOUT	opt_sa.h
207SA_ERASE_TIMEOUT	opt_sa.h
208SA_1FM_AT_EOD		opt_sa.h
209
210# Options used only in cam/scsi/scsi_pt.c
211SCSI_PT_DEFAULT_TIMEOUT	opt_pt.h
212
213# Options used only in cam/scsi/scsi_ses.c
214SES_ENABLE_PASSTHROUGH	opt_ses.h
215
216# Options used in dev/sym/ (Symbios SCSI driver).
217SYM_SETUP_LP_PROBE_MAP	opt_sym.h	#-Low Priority Probe Map (bits)
218					# Allows the ncr to take precedence
219					# 1 (1<<0) -> 810a, 860
220					# 2 (1<<1) -> 825a, 875, 885, 895
221					# 4 (1<<2) -> 895a, 896, 1510d
222SYM_SETUP_SCSI_DIFF	opt_sym.h	#-HVD support for 825a, 875, 885
223					# disabled:0 (default), enabled:1
224SYM_SETUP_PCI_PARITY	opt_sym.h	#-PCI parity checking
225					# disabled:0, enabled:1 (default)
226SYM_SETUP_MAX_LUN	opt_sym.h	#-Number of LUNs supported
227					# default:8, range:[1..64]
228
229# Options used only in pci/ncr.c
230SCSI_NCR_DEBUG		opt_ncr.h
231SCSI_NCR_MAX_SYNC	opt_ncr.h
232SCSI_NCR_MAX_WIDE	opt_ncr.h
233SCSI_NCR_MYADDR		opt_ncr.h
234
235# Options used only in dev/isp/*
236ISP_TARGET_MODE		opt_isp.h
237ISP_FW_CRASH_DUMP	opt_isp.h
238
239# Options used in the 'ata' ATA/ATAPI driver
240ACD_DEBUG		opt_ata.h
241AST_DEBUG		opt_ata.h
242ATAPI_DEBUG		opt_ata.h
243ATA_DEBUG		opt_ata.h
244ATA_STATIC_ID		opt_ata.h
245DEV_ATADISK		opt_ata.h
246DEV_ATAPICD		opt_ata.h
247DEV_ATAPIST		opt_ata.h
248DEV_ATAPIFD		opt_ata.h
249
250# Net stuff.
251ACCEPT_FILTER_DATA
252ACCEPT_FILTER_HTTP
253BOOTP			opt_bootp.h
254BOOTP_COMPAT		opt_bootp.h
255BOOTP_NFSROOT		opt_bootp.h
256BOOTP_NFSV3		opt_bootp.h
257BOOTP_WIRED_TO		opt_bootp.h
258BRIDGE			opt_bdg.h
259ETHER_II		opt_ef.h
260ETHER_8023		opt_ef.h
261ETHER_8022		opt_ef.h
262ETHER_SNAP		opt_ef.h
263MROUTING		opt_mrouting.h
264INET			opt_inet.h
265SOMAXCONN		opt_inet.h
266INET6			opt_inet6.h
267IPSEC			opt_ipsec.h
268IPSEC_ESP		opt_ipsec.h
269IPSEC_DEBUG		opt_ipsec.h
270IPDIVERT
271DUMMYNET		opt_ipdn.h
272IPFILTER		opt_ipfilter.h
273IPFILTER_LOG		opt_ipfilter.h
274IPFILTER_DEFAULT_BLOCK	opt_ipfilter.h
275PFIL_HOOKS		opt_pfil_hooks.h
276IPFIREWALL		opt_ipfw.h
277IPFIREWALL_VERBOSE	opt_ipfw.h
278IPFIREWALL_VERBOSE_LIMIT	opt_ipfw.h
279IPFIREWALL_DEFAULT_TO_ACCEPT	opt_ipfw.h
280IPFIREWALL_FORWARD		opt_ipfw.h
281IPV6FIREWALL		opt_ip6fw.h
282IPV6FIREWALL_VERBOSE	opt_ip6fw.h
283IPV6FIREWALL_VERBOSE_LIMIT	opt_ip6fw.h
284IPV6FIREWALL_DEFAULT_TO_ACCEPT	opt_ip6fw.h
285IPSTEALTH
286IPX			opt_ipx.h
287IPXIP			opt_ipx.h
288IPTUNNEL		opt_ipx.h
289LIBMCHAIN
290NCP			opt_ncp.h
291NETATALK		opt_atalk.h
292PPP_BSDCOMP		opt_ppp.h
293PPP_DEFLATE		opt_ppp.h
294PPP_FILTER		opt_ppp.h
295RANDOM_IP_ID
296SLIP_IFF_OPTS		opt_slip.h
297TCPDEBUG
298TCP_DROP_SYNFIN		opt_tcp_input.h
299XBONEHACK
300
301# Netgraph(4). Use option NETGRAPH to enable the base netgraph code.
302# Each netgraph node type can be either be compiled into the kernel
303# or loaded dynamically. To get the former, include the corresponding
304# option below. Each type has its own man page, e.g. ng_async(4).
305NETGRAPH
306NETGRAPH_ASYNC		opt_netgraph.h
307NETGRAPH_BPF		opt_netgraph.h
308NETGRAPH_BRIDGE		opt_netgraph.h
309NETGRAPH_CISCO		opt_netgraph.h
310NETGRAPH_ECHO		opt_netgraph.h
311NETGRAPH_ETHER		opt_netgraph.h
312NETGRAPH_FRAME_RELAY	opt_netgraph.h
313NETGRAPH_GIF		opt_netgraph.h
314NETGRAPH_GIF_DEMUX	opt_netgraph.h
315NETGRAPH_HOLE		opt_netgraph.h
316NETGRAPH_IFACE		opt_netgraph.h
317NETGRAPH_IP_INPUT	opt_netgraph.h
318NETGRAPH_KSOCKET	opt_netgraph.h
319NETGRAPH_LMI		opt_netgraph.h
320# MPPC compression requires proprietary files (not included)
321NETGRAPH_MPPC_COMPRESSION	opt_netgraph.h
322NETGRAPH_MPPC_ENCRYPTION	opt_netgraph.h
323NETGRAPH_ONE2MANY	opt_netgraph.h
324NETGRAPH_PPP		opt_netgraph.h
325NETGRAPH_PPPOE		opt_netgraph.h
326NETGRAPH_PPTPGRE	opt_netgraph.h
327NETGRAPH_RFC1490	opt_netgraph.h
328NETGRAPH_SOCKET		opt_netgraph.h
329NETGRAPH_SPLIT		opt_netgraph.h
330NETGRAPH_TEE		opt_netgraph.h
331NETGRAPH_TTY		opt_netgraph.h
332NETGRAPH_UI		opt_netgraph.h
333NETGRAPH_VJC		opt_netgraph.h
334
335# DRM options
336DRM_LINUX		opt_drm.h
337DRM_DEBUG		opt_drm.h
338
339# ATM (HARP version)
340ATM_CORE		opt_atm.h
341ATM_IP			opt_atm.h
342ATM_SIGPVC		opt_atm.h
343ATM_SPANS		opt_atm.h
344ATM_UNI			opt_atm.h
345
346# XXX Conflict: # of devices vs network protocol (Native ATM).
347# This makes "atm.h" unusable.
348NATM			opt_natm.h
349
350DPT_ALLOW_MEMIO		opt_dpt.h	# Allow PCI devices to use memory
351					# mapped I/O
352# DPT driver debug flags
353DPT_MEASURE_PERFORMANCE	opt_dpt.h
354DPT_HANDLE_TIMEOUTS	opt_dpt.h
355DPT_TIMEOUT_FACTOR	opt_dpt.h
356DPT_LOST_IRQ		opt_dpt.h
357DPT_RESET_HBA		opt_dpt.h
358
359# Adaptec ASR and DPT V/VI controller options
360ASR_MEASURE_PERFORMANCE	opt_asr.h
361
362# Misc debug flags.  Most of these should probably be replaced with
363# 'DEBUG', and then let people recompile just the interesting modules
364# with 'make CC="cc -DDEBUG"'.
365CLUSTERDEBUG		opt_debug_cluster.h
366DEBUG_1284		opt_ppb_1284.h
367VP0_DEBUG		opt_vpo.h
368LPT_DEBUG		opt_lpt.h
369PLIP_DEBUG		opt_plip.h
370LOCKF_DEBUG		opt_debug_lockf.h
371NPX_DEBUG		opt_debug_npx.h
372NETATALKDEBUG		opt_atalk.h
373SI_DEBUG		opt_debug_si.h
374
375# Fb options
376FB_DEBUG		opt_fb.h
377FB_INSTALL_CDEV		opt_fb.h
378
379# ppbus related options
380PERIPH_1284		opt_ppb_1284.h
381DONTPROBE_1284		opt_ppb_1284.h
382
383# smbus related options
384ENABLE_ALART		opt_intpm.h
385
386# These cause changes all over the kernel
387BLKDEV_IOSIZE		opt_global.h
388DEBUG			opt_global.h
389DEBUG_LOCKS		opt_global.h
390DEBUG_VFS_LOCKS		opt_global.h
391LOOKUP_EXCLUSIVE	opt_global.h
392DIAGNOSTIC		opt_global.h
393ENABLE_VFS_IOOPT	opt_global.h
394INVARIANT_SUPPORT	opt_global.h
395INVARIANTS		opt_global.h
396REGRESSION		opt_global.h
397RESTARTABLE_PANICS	opt_global.h
398VFS_BIO_DEBUG		opt_global.h
399
400# These are VM related options
401VM_KMEM_SIZE		opt_vm.h
402VM_KMEM_SIZE_SCALE	opt_vm.h
403VM_KMEM_SIZE_MAX	opt_vm.h
404NO_SWAPPING		opt_vm.h
405MALLOC_PROFILE		opt_vm.h
406PQ_NOOPT		opt_vmpage.h
407PQ_NORMALCACHE		opt_vmpage.h
408PQ_MEDIUMCACHE		opt_vmpage.h
409PQ_LARGECACHE		opt_vmpage.h
410PQ_HUGECACHE		opt_vmpage.h
411PQ_CACHESIZE		opt_vmpage.h
412
413# Standard SMP options
414SMP			opt_global.h
415
416# Size of the kernel message buffer
417MSGBUF_SIZE		opt_msgbuf.h
418
419# PCI related options
420PCI_ENABLE_IO_MODES	opt_pci.h
421PCI_ALLOW_UNSUPPORTED_IO_RANGE	opt_pci.h
422
423# NFS options
424NFS_MINATTRTIMO		opt_nfs.h
425NFS_MAXATTRTIMO		opt_nfs.h
426NFS_MINDIRATTRTIMO	opt_nfs.h
427NFS_MAXDIRATTRTIMO	opt_nfs.h
428NFS_GATHERDELAY		opt_nfs.h
429NFS_WDELAYHASHSIZ	opt_nfs.h
430NFS_DEBUG		opt_nfs.h
431
432# For the Bt848/Bt848A/Bt849/Bt878/Bt879 driver
433OVERRIDE_CARD			opt_bktr.h
434OVERRIDE_TUNER			opt_bktr.h
435OVERRIDE_DBX			opt_bktr.h
436OVERRIDE_MSP			opt_bktr.h
437BROOKTREE_SYSTEM_DEFAULT	opt_bktr.h
438BROOKTREE_ALLOC_PAGES		opt_bktr.h
439BKTR_OVERRIDE_CARD		opt_bktr.h
440BKTR_OVERRIDE_TUNER		opt_bktr.h
441BKTR_OVERRIDE_DBX		opt_bktr.h
442BKTR_OVERRIDE_MSP		opt_bktr.h
443BKTR_SYSTEM_DEFAULT		opt_bktr.h
444BKTR_ALLOC_PAGES		opt_bktr.h
445BKTR_USE_PLL			opt_bktr.h
446BKTR_GPIO_ACCESS		opt_bktr.h
447BKTR_NO_MSP_RESET		opt_bktr.h
448BKTR_430_FX_MODE		opt_bktr.h
449BKTR_SIS_VIA_MODE		opt_bktr.h
450BKTR_USE_FREEBSD_SMBUS		opt_bktr.h
451
452# meteor opt_meteor.h
453METEOR_ALLOC_PAGES	opt_meteor.h
454METEOR_TEST_VIDEO	opt_meteor.h
455METEOR_SYSTEM_DEFAULT	opt_meteor.h
456METEOR_DEALLOC_PAGES	opt_meteor.h
457METEOR_DEALLOC_ABOVE	opt_meteor.h
458
459# Various mi ISA bus flags
460COM_ESP			opt_sio.h
461COM_MULTIPORT		opt_sio.h
462BREAK_TO_DEBUGGER	opt_comconsole.h
463ALT_BREAK_TO_DEBUGGER	opt_comconsole.h
464DEV_ISA			opt_isa.h
465
466# Include tweaks for running under the SimOS machine simulator.
467SIMOS			opt_simos.h
468
469# options for bus/device framework
470BUS_DEBUG		opt_bus.h
471
472# options for USB support
473UHCI_DEBUG		opt_usb.h
474OHCI_DEBUG		opt_usb.h
475USB_DEBUG		opt_usb.h
476UGEN_DEBUG		opt_usb.h
477UHID_DEBUG		opt_usb.h
478UHUB_DEBUG		opt_usb.h
479UKBD_DEBUG		opt_usb.h
480ULPT_DEBUG		opt_usb.h
481UMASS_DEBUG		opt_usb.h
482UMS_DEBUG		opt_usb.h
483URIO_DEBUG		opt_usb.h
484UKBD_DFLT_KEYMAP	opt_ukbd.h
485
486# Vinum options
487VINUMDEBUG		opt_vinum.h
488
489# Embedded system options
490INIT_PATH		opt_init_path.h
491
492ROOTDEVNAME		opt_rootdevname.h
493
494FDC_DEBUG		opt_fdc.h
495PCFCLOCK_VERBOSE	opt_pcfclock.h
496PCFCLOCK_MAX_RETRIES	opt_pcfclock.h
497TDFX_LINUX opt_tdfx.h
498
499KTR			opt_global.h
500KTR_MASK		opt_ktr.h
501KTR_CPUMASK		opt_ktr.h
502KTR_COMPILE		opt_global.h
503KTR_ENTRIES		opt_global.h
504KTR_VERBOSE		opt_ktr.h
505MUTEX_DEBUG		opt_global.h
506WITNESS			opt_global.h
507WITNESS_DDB		opt_witness.h
508WITNESS_SKIPSPIN	opt_witness.h
509
510# options for ACPI support
511ACPI_DEBUG		opt_acpi.h
512ACPI_NO_SEMAPHORES	opt_acpi.h
513ACPI_MAX_THREADS	opt_acpi.h
514
515# options for DEVFS, see sys/fs/devfs/devfs.h
516NDEVFSINO		opt_devfs.h
517NDEVFSOVERFLOW		opt_devfs.h
518
519# various 'device presence' options.
520DEV_MCA			opt_mca.h
521DEV_BPF			opt_bpf.h
522
523# ed driver
524ED_NO_MIIBUS		opt_ed.h
525
526# Polling device handling
527DEVICE_POLLING		opt_global.h
528
529# Mutex profiling
530MUTEX_PROFILING		opt_global.h
531