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