xref: /freebsd/sys/conf/options (revision 6990ffd8a95caaba6858ad44ff1b3157d1efba8f)
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.
59BLEED
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
100UCONSOLE
101VFS_AIO
102
103# POSIX kernel options
104P1003_1B			opt_posix.h
105_KPOSIX_PRIORITY_SCHEDULING	opt_posix.h
106_KPOSIX_VERSION			opt_posix.h
107
108# TrustedBSD and POSIX.1e Kernel Options
109CAPABILITIES	opt_cap.h
110
111# Do we want the config file compiled into the kernel?
112INCLUDE_CONFIG_FILE	opt_config.h
113
114# Options for static file systems.  These should only be used at config
115# time, since the corresponding lkms cannot work if there are any static
116# dependencies.  Unusability is enforced by hiding the defines for the
117# options in a never-included header.
118CD9660		opt_dontuse.h
119CODA		opt_dontuse.h
120EXT2FS		opt_dontuse.h
121FDESCFS		opt_dontuse.h
122LINPROCFS	opt_dontuse.h
123MSDOSFS		opt_dontuse.h
124NULLFS		opt_dontuse.h
125NWFS		opt_dontuse.h
126PORTALFS	opt_dontuse.h
127PROCFS		opt_dontuse.h
128PSEUDOFS	opt_dontuse.h
129UMAPFS		opt_dontuse.h
130NTFS		opt_dontuse.h
131HPFS		opt_dontuse.h
132UNIONFS		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.
142NFS
143
144# If you are following the conditions in the copyright,
145# you can enable soft-updates which will speed up a lot of thigs
146# and make the system safer from crashes at the same time.
147# otherwise a STUB module will be compiled in.
148SOFTUPDATES	opt_ffs.h
149
150# Enabling this option turns on support for Access Control Lists in UFS,
151# which can be used to support high security configurations.  Depends on
152# UFS_EXTATTR.
153UFS_ACL		opt_ufs.h
154
155# Enabling this option turns on support for extended attributes in UFS-based
156# file systems, which can be used to support high security configurations
157# as well as new file system features.
158UFS_EXTATTR	opt_ufs.h
159UFS_EXTATTR_AUTOSTART	opt_ufs.h
160
161# Enable fast hash lookups for large directories on UFS-based filesystems.
162UFS_DIRHASH	opt_ufs.h
163
164# The above static dependencies are planned removed, with a
165# <filesystem>_ROOT option to control if it usable as root.  This list
166# allows these options to be present in config files already (though
167# they won't make any difference yet).
168NFS_ROOT	opt_nfsroot.h
169
170# Options used only in subr_param.c.
171HZ		opt_param.h
172MAXFILES	opt_param.h
173NBUF		opt_param.h
174NMBCLUSTERS	opt_param.h
175NSFBUFS		opt_param.h
176VM_BCACHE_SIZE_MAX	opt_param.h
177VM_SWZONE_SIZE_MAX	opt_param.h
178MAXUSERS
179
180# Generic SCSI options.
181CAM_MAX_HIGHPOWER	opt_cam.h
182CAMDEBUG		opt_cam.h
183CAM_DEBUG_DELAY		opt_cam.h
184CAM_DEBUG_BUS		opt_cam.h
185CAM_DEBUG_TARGET	opt_cam.h
186CAM_DEBUG_LUN		opt_cam.h
187CAM_DEBUG_FLAGS		opt_cam.h
188CAM_NEW_TRAN_CODE	opt_cam.h
189SCSI_DELAY		opt_scsi.h
190SCSI_NO_SENSE_STRINGS	opt_scsi.h
191SCSI_NO_OP_STRINGS	opt_scsi.h
192
193
194
195# Options used only in cam/scsi/scsi_cd.c
196CHANGER_MIN_BUSY_SECONDS	opt_cd.h
197CHANGER_MAX_BUSY_SECONDS	opt_cd.h
198
199# Options used only in cam/scsi/scsi_sa.c.
200SA_IO_TIMEOUT		opt_sa.h
201SA_SPACE_TIMEOUT	opt_sa.h
202SA_REWIND_TIMEOUT	opt_sa.h
203SA_ERASE_TIMEOUT	opt_sa.h
204SA_1FM_AT_EOD		opt_sa.h
205
206# Options used only in cam/scsi/scsi_pt.c
207SCSI_PT_DEFAULT_TIMEOUT	opt_pt.h
208
209# Options used only in cam/scsi/scsi_ses.c
210SES_ENABLE_PASSTHROUGH	opt_ses.h
211
212# Options used in dev/sym/ (Symbios SCSI driver).
213SYM_SETUP_LP_PROBE_MAP	opt_sym.h	#-Low Priority Probe Map (bits)
214					# Allows the ncr to take precedence
215					# 1 (1<<0) -> 810a, 860
216					# 2 (1<<1) -> 825a, 875, 885, 895
217					# 4 (1<<2) -> 895a, 896, 1510d
218SYM_SETUP_SCSI_DIFF	opt_sym.h	#-HVD support for 825a, 875, 885
219					# disabled:0 (default), enabled:1
220SYM_SETUP_PCI_PARITY	opt_sym.h	#-PCI parity checking
221					# disabled:0, enabled:1 (default)
222SYM_SETUP_MAX_LUN	opt_sym.h	#-Number of LUNs supported
223					# default:8, range:[1..64]
224
225# Options used only in pci/ncr.c
226SCSI_NCR_DEBUG		opt_ncr.h
227SCSI_NCR_MAX_SYNC	opt_ncr.h
228SCSI_NCR_MAX_WIDE	opt_ncr.h
229SCSI_NCR_MYADDR		opt_ncr.h
230
231# Options used only in pci/isp_pci.c
232ISP_TARGET_MODE		opt_isp.h
233
234# Options used in the 'ata' ATA/ATAPI driver
235ACD_DEBUG		opt_ata.h
236AST_DEBUG		opt_ata.h
237ATAPI_DEBUG		opt_ata.h
238ATA_DEBUG		opt_ata.h
239ATA_STATIC_ID		opt_ata.h
240DEV_ATADISK		opt_ata.h
241DEV_ATAPICD		opt_ata.h
242DEV_ATAPIST		opt_ata.h
243DEV_ATAPIFD		opt_ata.h
244
245# Resource limits.
246DFLDSIZ			opt_rlimit.h
247MAXDSIZ			opt_rlimit.h
248MAXSSIZ			opt_rlimit.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_HOLE		opt_netgraph.h
314NETGRAPH_IFACE		opt_netgraph.h
315NETGRAPH_KSOCKET	opt_netgraph.h
316NETGRAPH_LMI		opt_netgraph.h
317# MPPC compression requires proprietary files (not included)
318NETGRAPH_MPPC_COMPRESSION	opt_netgraph.h
319NETGRAPH_MPPC_ENCRYPTION	opt_netgraph.h
320NETGRAPH_ONE2MANY	opt_netgraph.h
321NETGRAPH_PPP		opt_netgraph.h
322NETGRAPH_PPPOE		opt_netgraph.h
323NETGRAPH_PPTPGRE	opt_netgraph.h
324NETGRAPH_RFC1490	opt_netgraph.h
325NETGRAPH_SOCKET		opt_netgraph.h
326NETGRAPH_SPLIT		opt_netgraph.h
327NETGRAPH_TEE		opt_netgraph.h
328NETGRAPH_TTY		opt_netgraph.h
329NETGRAPH_UI		opt_netgraph.h
330NETGRAPH_VJC		opt_netgraph.h
331
332# ATM (HARP version)
333ATM_CORE		opt_atm.h
334ATM_IP			opt_atm.h
335ATM_SIGPVC		opt_atm.h
336ATM_SPANS		opt_atm.h
337ATM_UNI			opt_atm.h
338
339# XXX Conflict: # of devices vs network protocol (Native ATM).
340# This makes "atm.h" unusable.
341NATM			opt_natm.h
342
343DPT_ALLOW_MEMIO		opt_dpt.h	# Allow PCI devices to use memory
344					# mapped I/O
345# DPT driver debug flags
346DPT_MEASURE_PERFORMANCE	opt_dpt.h
347DPT_HANDLE_TIMEOUTS	opt_dpt.h
348DPT_TIMEOUT_FACTOR	opt_dpt.h
349DPT_LOST_IRQ		opt_dpt.h
350DPT_RESET_HBA		opt_dpt.h
351
352# Adaptec ASR and DPT V/VI controller options
353ASR_MEASURE_PERFORMANCE	opt_asr.h
354
355# Misc debug flags.  Most of these should probably be replaced with
356# 'DEBUG', and then let people recompile just the interesting modules
357# with 'make CC="cc -DDEBUG"'.
358CLUSTERDEBUG		opt_debug_cluster.h
359DEBUG_1284		opt_ppb_1284.h
360VP0_DEBUG		opt_vpo.h
361LPT_DEBUG		opt_lpt.h
362PLIP_DEBUG		opt_plip.h
363LOCKF_DEBUG		opt_debug_lockf.h
364LOUTB			opt_debug_outb.h
365NPX_DEBUG		opt_debug_npx.h
366NETATALKDEBUG		opt_atalk.h
367SI_DEBUG		opt_debug_si.h
368
369# Fb options
370FB_DEBUG		opt_fb.h
371FB_INSTALL_CDEV		opt_fb.h
372
373# ppbus related options
374PERIPH_1284		opt_ppb_1284.h
375DONTPROBE_1284		opt_ppb_1284.h
376
377# smbus related options
378ENABLE_ALART		opt_intpm.h
379
380# These cause changes all over the kernel
381BLKDEV_IOSIZE		opt_global.h
382DEBUG			opt_global.h
383DEBUG_LOCKS		opt_global.h
384DEBUG_VFS_LOCKS		opt_global.h
385DIAGNOSTIC		opt_global.h
386ENABLE_VFS_IOOPT	opt_global.h
387INVARIANT_SUPPORT	opt_global.h
388INVARIANTS		opt_global.h
389REGRESSION		opt_global.h
390RESTARTABLE_PANICS	opt_global.h
391SIMPLELOCK_DEBUG	opt_global.h
392VFS_BIO_DEBUG		opt_global.h
393
394# These are VM related options
395VM_KMEM_SIZE		opt_vm.h
396VM_KMEM_SIZE_SCALE	opt_vm.h
397VM_KMEM_SIZE_MAX	opt_vm.h
398NO_SWAPPING		opt_vm.h
399PQ_NOOPT		opt_vmpage.h
400PQ_NORMALCACHE		opt_vmpage.h
401PQ_MEDIUMCACHE		opt_vmpage.h
402PQ_LARGECACHE		opt_vmpage.h
403PQ_HUGECACHE		opt_vmpage.h
404PQ_CACHESIZE		opt_vmpage.h
405
406# Standard SMP options
407SMP			opt_global.h
408
409# sys/netkey
410KEY
411
412# Size of the kernel message buffer
413MSGBUF_SIZE		opt_msgbuf.h
414
415# PCI related options
416PCI_QUIET		opt_pci.h
417
418# NFS options
419NFS_MINATTRTIMO		opt_nfs.h
420NFS_MAXATTRTIMO		opt_nfs.h
421NFS_MINDIRATTRTIMO	opt_nfs.h
422NFS_MAXDIRATTRTIMO	opt_nfs.h
423NFS_GATHERDELAY		opt_nfs.h
424NFS_UIDHASHSIZ		opt_nfs.h
425NFS_WDELAYHASHSIZ	opt_nfs.h
426NFS_MUIDHASHSIZ		opt_nfs.h
427NFS_NOSERVER		opt_nfs.h
428NFS_DEBUG		opt_nfs.h
429
430# For the Bt848/Bt848A/Bt849/Bt878/Bt879 driver
431OVERRIDE_CARD			opt_bktr.h
432OVERRIDE_TUNER			opt_bktr.h
433OVERRIDE_DBX			opt_bktr.h
434OVERRIDE_MSP			opt_bktr.h
435BROOKTREE_SYSTEM_DEFAULT	opt_bktr.h
436BROOKTREE_ALLOC_PAGES		opt_bktr.h
437BKTR_OVERRIDE_CARD		opt_bktr.h
438BKTR_OVERRIDE_TUNER		opt_bktr.h
439BKTR_OVERRIDE_DBX		opt_bktr.h
440BKTR_OVERRIDE_MSP		opt_bktr.h
441BKTR_SYSTEM_DEFAULT		opt_bktr.h
442BKTR_ALLOC_PAGES		opt_bktr.h
443BKTR_USE_PLL			opt_bktr.h
444BKTR_GPIO_ACCESS		opt_bktr.h
445BKTR_NO_MSP_RESET		opt_bktr.h
446BKTR_430_FX_MODE		opt_bktr.h
447BKTR_SIS_VIA_MODE		opt_bktr.h
448
449# meteor opt_meteor.h
450METEOR_ALLOC_PAGES	opt_meteor.h
451METEOR_TEST_VIDEO	opt_meteor.h
452METEOR_SYSTEM_DEFAULT	opt_meteor.h
453METEOR_DEALLOC_PAGES	opt_meteor.h
454METEOR_DEALLOC_ABOVE	opt_meteor.h
455
456# Various mi ISA bus flags
457COM_ESP			opt_sio.h
458COM_MULTIPORT		opt_sio.h
459BREAK_TO_DEBUGGER	opt_comconsole.h
460ALT_BREAK_TO_DEBUGGER	opt_comconsole.h
461DEV_ISA			opt_isa.h
462
463# Include tweaks for running under the SimOS machine simulator.
464SIMOS			opt_simos.h
465
466# options for bus/device framework
467BUS_DEBUG		opt_bus.h
468DEVICE_SYSCTLS		opt_bus.h
469
470# options for USB support
471UHCI_DEBUG		opt_usb.h
472OHCI_DEBUG		opt_usb.h
473USB_DEBUG		opt_usb.h
474UGEN_DEBUG		opt_usb.h
475UHID_DEBUG		opt_usb.h
476UHUB_DEBUG		opt_usb.h
477UKBD_DEBUG		opt_usb.h
478ULPT_DEBUG		opt_usb.h
479UMASS_DEBUG		opt_usb.h
480UMS_DEBUG		opt_usb.h
481URIO_DEBUG		opt_usb.h
482UKBD_DFLT_KEYMAP	opt_ukbd.h
483
484# Vinum options
485VINUMDEBUG		opt_vinum.h
486
487# Embedded system options
488INIT_PATH		opt_init_path.h
489
490ROOTDEVNAME		opt_rootdevname.h
491
492FDC_DEBUG		opt_fdc.h
493PCFCLOCK_VERBOSE	opt_pcfclock.h
494PCFCLOCK_MAX_RETRIES	opt_pcfclock.h
495TDFX_LINUX opt_tdfx.h
496
497KTR			opt_global.h
498KTR_MASK		opt_ktr.h
499KTR_CPUMASK		opt_ktr.h
500KTR_COMPILE		opt_global.h
501KTR_ENTRIES		opt_global.h
502KTR_EXTEND		opt_global.h
503KTR_VERBOSE		opt_ktr.h
504MUTEX_DEBUG		opt_global.h
505CV_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
512AML_DEBUG		opt_acpi.h
513ACPI_NO_ENABLE_ON_BOOT	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