xref: /freebsd/sys/conf/options (revision 6adf353a56a161443406b44a45d00c688ca7b857)
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
122FFS		opt_dontuse.h
123IFS		opt_dontuse.h
124LINPROCFS	opt_dontuse.h
125MSDOSFS		opt_dontuse.h
126NULLFS		opt_dontuse.h
127NWFS		opt_dontuse.h
128PORTALFS	opt_dontuse.h
129PROCFS		opt_dontuse.h
130PSEUDOFS	opt_dontuse.h
131UMAPFS		opt_dontuse.h
132NTFS		opt_dontuse.h
133HPFS		opt_dontuse.h
134UNIONFS		opt_dontuse.h
135
136# These static filesystems has one slightly bogus static dependency in
137# sys/i386/i386/autoconf.c.  If any of these filesystems are
138# statically compiled into the kernel, code for mounting them as root
139# filesystems will be enabled - but look below.
140NFS
141
142# If you are following the conditions in the copyright,
143# you can enable soft-updates which will speed up a lot of thigs
144# and make the system safer from crashes at the same time.
145# otherwise a STUB module will be compiled in.
146SOFTUPDATES	opt_ffs.h
147
148# Enabling this option turns on support for Access Control Lists in UFS,
149# which can be used to support high security configurations.  Depends on
150# UFS_EXTATTR.
151UFS_ACL		opt_ufs.h
152
153# Enabling this option turns on support for extended attributes in UFS-based
154# file systems, which can be used to support high security configurations
155# as well as new file system features.
156UFS_EXTATTR	opt_ufs.h
157UFS_EXTATTR_AUTOSTART	opt_ufs.h
158
159# Enable fast hash lookups for large directories on UFS-based filesystems.
160UFS_DIRHASH	opt_ufs.h
161
162# The above static dependencies are planned removed, with a
163# <filesystem>_ROOT option to control if it usable as root.  This list
164# allows these options to be present in config files already (though
165# they won't make any difference yet).
166NFS_ROOT	opt_nfsroot.h
167
168# Options used only in subr_param.c.
169HZ		opt_param.h
170MAXFILES	opt_param.h
171NBUF		opt_param.h
172NMBCLUSTERS	opt_param.h
173NSFBUFS		opt_param.h
174MAXUSERS
175
176# Generic SCSI options.
177CAM_MAX_HIGHPOWER	opt_cam.h
178CAMDEBUG		opt_cam.h
179CAM_DEBUG_DELAY		opt_cam.h
180CAM_DEBUG_BUS		opt_cam.h
181CAM_DEBUG_TARGET	opt_cam.h
182CAM_DEBUG_LUN		opt_cam.h
183CAM_DEBUG_FLAGS		opt_cam.h
184CAM_NEW_TRAN_CODE	opt_cam.h
185SCSI_DELAY		opt_scsi.h
186SCSI_NO_SENSE_STRINGS	opt_scsi.h
187SCSI_NO_OP_STRINGS	opt_scsi.h
188
189
190
191# Options used only in cam/scsi/scsi_cd.c
192CHANGER_MIN_BUSY_SECONDS	opt_cd.h
193CHANGER_MAX_BUSY_SECONDS	opt_cd.h
194
195# Options used only in cam/scsi/scsi_sa.c.
196SA_IO_TIMEOUT		opt_sa.h
197SA_SPACE_TIMEOUT	opt_sa.h
198SA_REWIND_TIMEOUT	opt_sa.h
199SA_ERASE_TIMEOUT	opt_sa.h
200SA_1FM_AT_EOD		opt_sa.h
201
202# Options used only in cam/scsi/scsi_pt.c
203SCSI_PT_DEFAULT_TIMEOUT	opt_pt.h
204
205# Options used only in cam/scsi/scsi_ses.c
206SES_ENABLE_PASSTHROUGH	opt_ses.h
207
208# Options used in dev/sym/ (Symbios SCSI driver).
209SYM_SETUP_LP_PROBE_MAP	opt_sym.h	#-Low Priority Probe Map (bits)
210					# Allows the ncr to take precedence
211					# 1 (1<<0) -> 810a, 860
212					# 2 (1<<1) -> 825a, 875, 885, 895
213					# 4 (1<<2) -> 895a, 896, 1510d
214SYM_SETUP_SCSI_DIFF	opt_sym.h	#-HVD support for 825a, 875, 885
215					# disabled:0 (default), enabled:1
216SYM_SETUP_PCI_PARITY	opt_sym.h	#-PCI parity checking
217					# disabled:0, enabled:1 (default)
218SYM_SETUP_MAX_LUN	opt_sym.h	#-Number of LUNs supported
219					# default:8, range:[1..64]
220
221# Options used only in pci/ncr.c
222SCSI_NCR_DEBUG		opt_ncr.h
223SCSI_NCR_MAX_SYNC	opt_ncr.h
224SCSI_NCR_MAX_WIDE	opt_ncr.h
225SCSI_NCR_MYADDR		opt_ncr.h
226
227# Options used only in pci/isp_pci.c
228ISP_TARGET_MODE		opt_isp.h
229
230# Options used in the 'ata' ATA/ATAPI driver
231ACD_DEBUG		opt_ata.h
232AST_DEBUG		opt_ata.h
233ATAPI_DEBUG		opt_ata.h
234ATA_DEBUG		opt_ata.h
235ATA_STATIC_ID		opt_ata.h
236DEV_ATADISK		opt_ata.h
237DEV_ATAPICD		opt_ata.h
238DEV_ATAPIST		opt_ata.h
239DEV_ATAPIFD		opt_ata.h
240
241# Resource limits.
242DFLDSIZ			opt_rlimit.h
243MAXDSIZ			opt_rlimit.h
244MAXSSIZ			opt_rlimit.h
245
246# Net stuff.
247ACCEPT_FILTER_DATA
248ACCEPT_FILTER_HTTP
249BOOTP			opt_bootp.h
250BOOTP_COMPAT		opt_bootp.h
251BOOTP_NFSROOT		opt_bootp.h
252BOOTP_NFSV3		opt_bootp.h
253BOOTP_WIRED_TO		opt_bootp.h
254BRIDGE			opt_bdg.h
255ETHER_II		opt_ef.h
256ETHER_8023		opt_ef.h
257ETHER_8022		opt_ef.h
258ETHER_SNAP		opt_ef.h
259MROUTING		opt_mrouting.h
260INET			opt_inet.h
261SOMAXCONN		opt_inet.h
262INET6			opt_inet6.h
263IPSEC			opt_ipsec.h
264IPSEC_ESP		opt_ipsec.h
265IPSEC_DEBUG		opt_ipsec.h
266IPDIVERT
267DUMMYNET		opt_ipdn.h
268IPFILTER		opt_ipfilter.h
269IPFILTER_LOG		opt_ipfilter.h
270IPFILTER_DEFAULT_BLOCK	opt_ipfilter.h
271PFIL_HOOKS		opt_pfil_hooks.h
272IPFIREWALL		opt_ipfw.h
273IPFIREWALL_VERBOSE	opt_ipfw.h
274IPFIREWALL_VERBOSE_LIMIT	opt_ipfw.h
275IPFIREWALL_DEFAULT_TO_ACCEPT	opt_ipfw.h
276IPFIREWALL_FORWARD		opt_ipfw.h
277IPV6FIREWALL		opt_ip6fw.h
278IPV6FIREWALL_VERBOSE	opt_ip6fw.h
279IPV6FIREWALL_VERBOSE_LIMIT	opt_ip6fw.h
280IPV6FIREWALL_DEFAULT_TO_ACCEPT	opt_ip6fw.h
281IPSTEALTH
282IPX			opt_ipx.h
283IPXIP			opt_ipx.h
284IPTUNNEL		opt_ipx.h
285LIBMCHAIN
286NCP			opt_ncp.h
287NETATALK		opt_atalk.h
288PPP_BSDCOMP		opt_ppp.h
289PPP_DEFLATE		opt_ppp.h
290PPP_FILTER		opt_ppp.h
291RANDOM_IP_ID
292SLIP_IFF_OPTS		opt_slip.h
293TCPDEBUG
294TCP_DROP_SYNFIN		opt_tcp_input.h
295XBONEHACK
296
297# Netgraph(4). Use option NETGRAPH to enable the base netgraph code.
298# Each netgraph node type can be either be compiled into the kernel
299# or loaded dynamically. To get the former, include the corresponding
300# option below. Each type has its own man page, e.g. ng_async(4).
301NETGRAPH
302NETGRAPH_ASYNC		opt_netgraph.h
303NETGRAPH_BPF		opt_netgraph.h
304NETGRAPH_BRIDGE		opt_netgraph.h
305NETGRAPH_CISCO		opt_netgraph.h
306NETGRAPH_ECHO		opt_netgraph.h
307NETGRAPH_ETHER		opt_netgraph.h
308NETGRAPH_FRAME_RELAY	opt_netgraph.h
309NETGRAPH_HOLE		opt_netgraph.h
310NETGRAPH_IFACE		opt_netgraph.h
311NETGRAPH_KSOCKET	opt_netgraph.h
312NETGRAPH_LMI		opt_netgraph.h
313# MPPC compression requires proprietary files (not included)
314NETGRAPH_MPPC_COMPRESSION	opt_netgraph.h
315NETGRAPH_MPPC_ENCRYPTION	opt_netgraph.h
316NETGRAPH_ONE2MANY	opt_netgraph.h
317NETGRAPH_PPP		opt_netgraph.h
318NETGRAPH_PPPOE		opt_netgraph.h
319NETGRAPH_PPTPGRE	opt_netgraph.h
320NETGRAPH_RFC1490	opt_netgraph.h
321NETGRAPH_SOCKET		opt_netgraph.h
322NETGRAPH_SPLIT		opt_netgraph.h
323NETGRAPH_TEE		opt_netgraph.h
324NETGRAPH_TTY		opt_netgraph.h
325NETGRAPH_UI		opt_netgraph.h
326NETGRAPH_VJC		opt_netgraph.h
327
328# ATM (HARP version)
329ATM_CORE		opt_atm.h
330ATM_IP			opt_atm.h
331ATM_SIGPVC		opt_atm.h
332ATM_SPANS		opt_atm.h
333ATM_UNI			opt_atm.h
334
335# XXX Conflict: # of devices vs network protocol (Native ATM).
336# This makes "atm.h" unusable.
337NATM			opt_natm.h
338
339DPT_ALLOW_MEMIO		opt_dpt.h	# Allow PCI devices to use memory
340					# mapped I/O
341# DPT driver debug flags
342DPT_MEASURE_PERFORMANCE	opt_dpt.h
343DPT_HANDLE_TIMEOUTS	opt_dpt.h
344DPT_TIMEOUT_FACTOR	opt_dpt.h
345DPT_LOST_IRQ		opt_dpt.h
346DPT_RESET_HBA		opt_dpt.h
347
348# Adaptec ASR and DPT V/VI controller options
349ASR_MEASURE_PERFORMANCE	opt_asr.h
350
351# Misc debug flags.  Most of these should probably be replaced with
352# 'DEBUG', and then let people recompile just the interesting modules
353# with 'make CC="cc -DDEBUG"'.
354CLUSTERDEBUG		opt_debug_cluster.h
355DEBUG_1284		opt_ppb_1284.h
356VP0_DEBUG		opt_vpo.h
357LPT_DEBUG		opt_lpt.h
358PLIP_DEBUG		opt_plip.h
359LOCKF_DEBUG		opt_debug_lockf.h
360LOUTB			opt_debug_outb.h
361NPX_DEBUG		opt_debug_npx.h
362NETATALKDEBUG		opt_atalk.h
363SI_DEBUG		opt_debug_si.h
364
365# Fb options
366FB_DEBUG		opt_fb.h
367FB_INSTALL_CDEV		opt_fb.h
368
369# ppbus related options
370PERIPH_1284		opt_ppb_1284.h
371DONTPROBE_1284		opt_ppb_1284.h
372
373# smbus related options
374ENABLE_ALART		opt_intpm.h
375
376# These cause changes all over the kernel
377BLKDEV_IOSIZE		opt_global.h
378DEBUG			opt_global.h
379DEBUG_LOCKS		opt_global.h
380DEBUG_VFS_LOCKS		opt_global.h
381DIAGNOSTIC		opt_global.h
382ENABLE_VFS_IOOPT	opt_global.h
383INVARIANT_SUPPORT	opt_global.h
384INVARIANTS		opt_global.h
385REGRESSION		opt_global.h
386SIMPLELOCK_DEBUG	opt_global.h
387VFS_BIO_DEBUG		opt_global.h
388
389# These are VM related options
390VM_KMEM_SIZE		opt_vm.h
391VM_KMEM_SIZE_SCALE	opt_vm.h
392VM_KMEM_SIZE_MAX	opt_vm.h
393NO_SWAPPING		opt_vm.h
394PQ_NOOPT		opt_vmpage.h
395PQ_NORMALCACHE		opt_vmpage.h
396PQ_MEDIUMCACHE		opt_vmpage.h
397PQ_LARGECACHE		opt_vmpage.h
398PQ_HUGECACHE		opt_vmpage.h
399PQ_CACHESIZE		opt_vmpage.h
400
401# Standard SMP options
402SMP			opt_global.h
403
404# sys/netkey
405KEY
406
407# Size of the kernel message buffer
408MSGBUF_SIZE		opt_msgbuf.h
409
410# PCI related options
411PCI_QUIET		opt_pci.h
412
413# NFS options
414NFS_MINATTRTIMO		opt_nfs.h
415NFS_MAXATTRTIMO		opt_nfs.h
416NFS_MINDIRATTRTIMO	opt_nfs.h
417NFS_MAXDIRATTRTIMO	opt_nfs.h
418NFS_GATHERDELAY		opt_nfs.h
419NFS_UIDHASHSIZ		opt_nfs.h
420NFS_WDELAYHASHSIZ	opt_nfs.h
421NFS_MUIDHASHSIZ		opt_nfs.h
422NFS_NOSERVER		opt_nfs.h
423NFS_DEBUG		opt_nfs.h
424
425# For the Bt848/Bt848A/Bt849/Bt878/Bt879 driver
426OVERRIDE_CARD			opt_bktr.h
427OVERRIDE_TUNER			opt_bktr.h
428OVERRIDE_DBX			opt_bktr.h
429OVERRIDE_MSP			opt_bktr.h
430BROOKTREE_SYSTEM_DEFAULT	opt_bktr.h
431BROOKTREE_ALLOC_PAGES		opt_bktr.h
432BKTR_OVERRIDE_CARD		opt_bktr.h
433BKTR_OVERRIDE_TUNER		opt_bktr.h
434BKTR_OVERRIDE_DBX		opt_bktr.h
435BKTR_OVERRIDE_MSP		opt_bktr.h
436BKTR_SYSTEM_DEFAULT		opt_bktr.h
437BKTR_ALLOC_PAGES		opt_bktr.h
438BKTR_USE_PLL			opt_bktr.h
439BKTR_GPIO_ACCESS		opt_bktr.h
440BKTR_NO_MSP_RESET		opt_bktr.h
441BKTR_430_FX_MODE		opt_bktr.h
442BKTR_SIS_VIA_MODE		opt_bktr.h
443
444# meteor opt_meteor.h
445METEOR_ALLOC_PAGES	opt_meteor.h
446METEOR_TEST_VIDEO	opt_meteor.h
447METEOR_SYSTEM_DEFAULT	opt_meteor.h
448METEOR_DEALLOC_PAGES	opt_meteor.h
449METEOR_DEALLOC_ABOVE	opt_meteor.h
450
451# Various mi ISA bus flags
452COM_ESP			opt_sio.h
453COM_MULTIPORT		opt_sio.h
454BREAK_TO_DEBUGGER	opt_comconsole.h
455ALT_BREAK_TO_DEBUGGER	opt_comconsole.h
456DEV_ISA			opt_isa.h
457
458# Include tweaks for running under the SimOS machine simulator.
459SIMOS			opt_simos.h
460
461# options for bus/device framework
462BUS_DEBUG		opt_bus.h
463DEVICE_SYSCTLS		opt_bus.h
464
465# options for USB support
466UHCI_DEBUG		opt_usb.h
467OHCI_DEBUG		opt_usb.h
468USB_DEBUG		opt_usb.h
469UGEN_DEBUG		opt_usb.h
470UHID_DEBUG		opt_usb.h
471UHUB_DEBUG		opt_usb.h
472UKBD_DEBUG		opt_usb.h
473ULPT_DEBUG		opt_usb.h
474UMASS_DEBUG		opt_usb.h
475UMS_DEBUG		opt_usb.h
476URIO_DEBUG		opt_usb.h
477UKBD_DFLT_KEYMAP	opt_ukbd.h
478
479# Vinum options
480VINUMDEBUG		opt_vinum.h
481
482# Embedded system options
483INIT_PATH		opt_init_path.h
484
485ROOTDEVNAME		opt_rootdevname.h
486
487FDC_DEBUG		opt_fdc.h
488PCFCLOCK_VERBOSE	opt_pcfclock.h
489PCFCLOCK_MAX_RETRIES	opt_pcfclock.h
490TDFX_LINUX opt_tdfx.h
491
492KTR			opt_global.h
493KTR_MASK		opt_ktr.h
494KTR_CPUMASK		opt_ktr.h
495KTR_COMPILE		opt_global.h
496KTR_ENTRIES		opt_global.h
497KTR_EXTEND		opt_global.h
498KTR_VERBOSE		opt_ktr.h
499MUTEX_DEBUG		opt_global.h
500CV_DEBUG		opt_global.h
501WITNESS			opt_global.h
502WITNESS_DDB		opt_witness.h
503WITNESS_SKIPSPIN	opt_witness.h
504
505# options for ACPI support
506ACPI_DEBUG		opt_acpi.h
507AML_DEBUG		opt_acpi.h
508ACPI_NO_ENABLE_ON_BOOT	opt_acpi.h
509
510# options for DEVFS, see sys/fs/devfs/devfs.h
511NDEVFSINO		opt_devfs.h
512NDEVFSOVERFLOW		opt_devfs.h
513
514# various 'device presence' options.
515DEV_MCA			opt_mca.h
516DEV_BPF			opt_bpf.h
517