newhandbook - add pages
[ikiwiki.git] / docs / newhandbook / ConfigureKernel / index.mdwn
1
2
3 # Configuring the DragonFly Kernel 
4
5 ***Updated and restructured by Jim Mock. Originally contributed by Jake Hamby.***
6
7
8
9 ## Synopsis 
10
11 The kernel is the core of the DragonFly operating system. It is responsible for managing memory, enforcing security controls, networking, disk access, and much more. While more and more of DragonFly becomes dynamically configurable it is still occasionally necessary to reconfigure and recompile your kernel.
12
13 After reading this chapter, you will know:
14
15 * Why you might need to build a custom kernel.
16 * How to write a kernel configuration file, or alter an existing configuration file.
17 * How to use the kernel configuration file to create and build a new kernel.
18 * How to install the new kernel.
19 * How to troubleshoot if things go wrong.
20
21
22
23
24 ## Why Build a Custom Kernel? 
25
26
27
28 Traditionally, DragonFly has had what is called a ***monolithic*** kernel. This means that the kernel was one large program, supported a fixed list of devices, and if you wanted to change the kernel's behavior then you had to compile a new kernel, and then reboot your computer with the new kernel.
29
30 Today, DragonFly is rapidly moving to a model where much of the kernel's functionality is contained in modules which can be dynamically loaded and unloaded from the kernel as necessary. This allows the kernel to adapt to new hardware suddenly becoming available (such as PCMCIA cards in a laptop), or for new functionality to be brought into the kernel that was not necessary when the kernel was originally compiled. This is known as a modular kernel. Colloquially these are called KLDs.
31
32 Despite this, it is still necessary to carry out some static kernel configuration. In some cases this is because the functionality is so tied to the kernel that it can not be made dynamically loadable. In others it may simply be because no one has yet taken the time to write a dynamic loadable kernel module for that functionality yet.
33
34 Building a custom kernel is one of the most important rites of passage nearly every UNIX® user must endure. This process, while time consuming, will provide many benefits to your DragonFly system. Unlike the `GENERIC` kernel, which must support a wide range of hardware, a custom kernel only contains support for ***your*** PC's hardware. This has a number of benefits, such as:
35
36
37
38 * Faster boot time. Since the kernel will only probe the hardware you have on your system, the time it takes your system to boot will decrease dramatically.
39
40 * Less memory usage. A custom kernel often uses less memory than the `GENERIC` kernel, which is important because the kernel must always be present in real memory. For this reason, a custom kernel is especially useful on a system with a small amount of RAM.
41
42 * Additional hardware support. A custom kernel allows you to add in support for devices such as sound cards, which are not present in the `GENERIC` kernel.
43
44
45
46
47
48
49
50 ## Building and Installing a Custom Kernel 
51
52 First, let us take a quick tour of the kernel build directory. All directories mentioned will be relative to the main `/usr/src/sys` directory, which is also accessible through `/sys`. There are a number of subdirectories here representing different parts of the kernel, but the most important, for our purposes, is `config`, where you will edit your custom kernel configuration, and `compile`, which is the staging area where your kernel will be built.  Notice the logical organization of the directory structure, with each supported device, file system, and option in its own subdirectory.
53
54 ### Installing the Source
55
56 If there is ***not*** a `/usr/src/sys` directory on your system, then the kernel source has not been installed. One method to do this is via git.  An alternative is to install the kernel source tree from the archive distributed on the DragonFly CD named `src-sys.tar.bz2`.  This is especially useful when you do not have ready access to the internet. Use the Makefile in `/usr` to fetch the source or to unpack the archive. When installing kernel source only, use the alternate build procedure below.
57
58 The preferred way of installing the sources is:
59
60     # cd /usr
61     # make src-checkout
62     
63 This will download the whole source tree via git into /usr/src. This method also allows for easy updating of the source tree by using:
64
65     # make src-update
66
67
68
69 ### Your Custom Config File
70
71 Next, move to the `config` directory and copy the `GENERIC` configuration file to the name you want to give your kernel. For example:
72
73     # cd /usr/src/sys/config
74     # cp GENERIC MYKERNEL
75
76 Traditionally, this name is in all capital letters and, if you are maintaining multiple DragonFly machines with different hardware, it is a good idea to name it after your machine's hostname. We will call it `MYKERNEL` for the purpose of this example.
77
78 **Tip:** Storing your kernel config file directly under `/usr/src` can be a bad idea. If you are experiencing problems it can be tempting to just delete `/usr/src` and start again. Five seconds after you do that you realize that you have deleted your custom kernel config file. Do not edit `GENERIC` directly, as it may get overwritten the next time you [update your source tree](updating.html#UPDATING-SETUP), and your kernel modifications will be lost.  You might want to keep your kernel config file elsewhere, and then create a symbolic link to the file in the `config` directory.
79
80
81
82 For example:
83
84
85     # cd /usr/src/sys/config
86     # mkdir /root/kernels
87     # cp GENERIC /root/kernels/MYKERNEL
88     # ln -s /root/kernels/MYKERNEL
89
90
91 **Note:** You must execute these and all of the following commands under the `root` account or you will get permission denied errors.
92
93 Now, edit `MYKERNEL` with your favorite text editor. If you are just starting out, the only editor available will probably be ***vi***, which is too complex to explain here, but is covered well in many books in the [bibliography](bibliography.html). However, DragonFly does offer an easier editor called ***ee*** which, if you are a beginner, should be your editor of choice. Feel free to change the comment lines at the top to reflect your configuration or the changes you have made to differentiate it from `GENERIC`.
94
95 If you have built a kernel under SunOS™ or some other BSD operating system, much of this file will be very familiar to you. If you are coming from some other operating system such as DOS, on the other hand, the `GENERIC` configuration file might seem overwhelming to you, so follow the descriptions in the [[Configuration File|handbook-kernelconfig-config]] section slowly and carefully.
96
97
98
99 ### Building a Kernel - Full Source Tree
100
101 **Note:** Be sure to always check the file `/usr/src/UPDATING`, before you perform any update steps, in the case you [sync your source tree](updating.html#UPDATING-SETUP) with the latest sources of the DragonFly project. In this file all important issues with updating DragonFly are typed out. `/usr/src/UPDATING` always fits your version of the DragonFly source, and is therefore more accurate for new information than the handbook.
102
103
104
105  1. Change to the `/usr/src` directory.
106
107      
108
109           # cd /usr/src
110
111  1. Compile the kernel.
112
113           # make buildkernel KERNCONF=MYKERNEL
114
115
116  1. Install the new kernel.     
117
118           # make installkernel KERNCONF=MYKERNEL
119
120     
121
122
123
124 If you have ***not*** upgraded your source tree in any way since the last time you successfully completed a `buildworld`-`installworld` cycle (you have not run `git pull` ), then it is safe to use the `quickworld` and `quickkernel`, `buildworld`, `buildkernel` sequence.
125
126 ### Building a Kernel - Kernel Source Only
127
128 When only the kernel source is installed, you need to change step 2, above, to this:
129      
130
131       # make nativekernel KERNCONF=MYKERNEL
132
133
134 The other steps are the same.
135
136
137
138 ### Running Your New Kernel
139
140 The new kernel will have been copied to the boot directory as `kernel` and the old kernel will be moved to `/boot/kernel.old`, the same applies to the modules (`/boot/modules` -> `/boot/modules.old`). Now, shutdown the system and reboot to use your new kernel. In case something goes wrong, there are some [troubleshooting](kernelconfig-trouble.html) instructions at the end of this chapter. Be sure to read the section which explains how to recover in case your new kernel [does not boot](kernelconfig-trouble.html#KERNELCONFIG-NOBOOT).
141
142
143 **Note:** If you have added any new devices (such as sound cards), you may have to add some device nodes to your `/dev` directory before you can use them. For more information, take a look at device nodes section later on in this chapter.
144
145
146
147
148 ## The Configuration File 
149 <!-- XXX: do we really want to mention all these million config options? -->
150 The general format of a configuration file is quite simple. Each line contains a keyword and one or more arguments. For simplicity, most lines only contain one argument. Anything following a `#` is considered a comment and ignored. The following sections describe each keyword, generally in the order they are listed in `GENERIC`, although some related keywords have been grouped together in a single section (such as Networking) even though they are actually scattered throughout the `GENERIC` file.  An exhaustive list of options and more detailed explanations of the device lines is present in the `LINT` configuration file, located in the same directory as `GENERIC`. If you are in doubt as to the purpose or necessity of a line, check first in `LINT`.
151
152
153
154 The following is an example `GENERIC` kernel configuration file with various additional comments where needed for clarity. This example should match your copy in `/usr/src/sys/config/GENERIC` fairly closely. For details of all the possible kernel options, see `/usr/src/sys/config/LINT`.
155
156
157
158     
159
160     #
161
162     #
163
164     # GENERIC -- Generic kernel configuration file for DragonFly/i386
165
166     #
167
168     # Check the LINT configuration file in sys/config, for an
169
170     # exhaustive list of options.
171
172     #
173
174     # $DragonFly: src/sys/config/GENERIC,v 1.56 2007/12/26 14:02:36 sephe Exp $
175
176
177
178 The following are the mandatory keywords required in ***every*** kernel you build:
179
180
181
182     
183
184     machine         i386
185
186
187
188 This is the machine architecture. It must be `i386` at the moment.  Support for `amd64` will be added in the future.
189
190
191
192     
193
194     cpu          I386_CPU
195
196     cpu          I486_CPU
197
198     cpu          I586_CPU
199
200     cpu          I686_CPU
201
202
203
204 The above option specifies the type of CPU you have in your system. You may have multiple instances of the CPU line (i.e., you are not sure whether you should use `I586_CPU` or `I686_CPU`), however, for a custom kernel, it is best to specify only the CPU you have. If you are unsure of your CPU type, you can check the `/var/run/dmesg.boot` file to view your boot up messages.
205
206
207
208     
209
210     ident          GENERIC
211
212
213
214 This is the identification of the kernel. You should change this to whatever you named your kernel, i.e. `MYKERNEL` if you have followed the instructions of the previous examples. The value you put in the `ident` string will print when you boot up the kernel, so it is useful to give the new kernel a different name if you want to keep it separate from your usual kernel (i.e. you want to build an experimental kernel).
215
216
217
218     
219
220     maxusers          0
221
222
223
224 The `maxusers` option sets the size of a number of important system tables. This number is supposed to be roughly equal to the number of simultaneous users you expect to have on your machine.
225
226
227
228 (Recommended) The system will auto-tune this setting for you if you explicitly set it to `0`[(1)](#FTN.AEN7414). If you want to manage it yourself you will want to set `maxusers` to at least 4, especially if you are using the X Window System or compiling software. The reason is that the most important table set by `maxusers` is the maximum number of processes, which is set to `20 + 16 * maxusers`, so if you set `maxusers` to 1, then you can only have 36 simultaneous processes, including the 18 or so that the system starts up at boot time, and the 15 or so you will probably create when you start the X Window System. Even a simple task like reading a manual page will start up nine processes to filter, decompress, and view it. Setting `maxusers` to 64 will allow you to have up to 1044 simultaneous processes, which should be enough for nearly all uses. If, however, you see the dreaded proc table full error when trying to start another program, or are running a server with a large number of simultaneous users, you can always increase the number and rebuild.
229
230
231
232  **Note:** `maxusers` does ***not*** limit the number of users which can log into your machine. It simply sets various table sizes to reasonable values considering the maximum number of users you will likely have on your system and how many processes each of them will be running. One keyword which ***does*** limit the number of simultaneous ***remote logins and X terminal windows*** is [kernelconfig-config.html#KERNELCONFIG-PTYS `pseudo-device pty 16`].
233
234
235
236     
237
238     # Floating point support - do not disable.
239
240     device          npx0     at nexus? port IO_NPX irq 13
241
242
243
244 `npx0` is the interface to the floating point math unit in DragonFly, which is either the hardware co-processor or the software math emulator. This is ***not*** optional.
245
246
247
248     
249
250     # Pseudo devices - the number indicates how many units to allocate.
251
252     pseudo-device   loop          # Network loopback
253
254
255
256 This is the generic loopback device for TCP/IP. If you telnet or FTP to `localhost` (a.k.a., `127.0.0.1`) it will come back at you through this device. This is ***mandatory***.
257
258
259
260 Everything that follows is more or less optional. See the notes underneath or next to each option for more information.
261
262
263
264     
265
266     #makeoptions     DEBUG=-g          #Build kernel with gdb(1) debug symbols
267
268
269
270 The normal build process of the DragonFly does not include debugging information when building the kernel and strips most symbols after the resulting kernel is linked, to save some space at the install location. If you are going to do tests of kernels in the DEVELOPMENT branch or develop changes of your own for the DragonFly kernel, you might want to uncomment this line. It will enable the use of the `-g` option which enables debugging information when passed to [gcc(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#gcc&section1).
271
272
273
274     
275
276     options          MATH_EMULATE      #Support for x87 emulation
277
278
279
280 This line allows the kernel to simulate a math co-processor if your computer does not have one (386 or 486SX). If you have a 486DX, or a 386 or 486SX (with a separate 387 or 487 chip), or higher (Pentium®, Pentium II, etc.), you can comment this line out.
281
282
283
284  **Note:** The normal math co-processor emulation routines that come with DragonFly are ***not*** very accurate. If you do not have a math co-processor, and you need the best accuracy, it is recommended that you change this option to `GPL_MATH_EMULATE` to use the GNU math support, which is not included by default for licensing reasons.
285
286
287
288     
289
290     options          INET          #InterNETworking
291
292
293
294 Networking support. Leave this in, even if you do not plan to be connected to a network. Most programs require at least loopback networking (i.e., making network connections within your PC), so this is essentially mandatory.
295
296
297
298     
299
300     options          INET6          #IPv6 communications protocols
301
302
303
304 This enables the IPv6 communication protocols.
305
306
307
308     
309
310     options          FFS          #Berkeley Fast Filesystem
311
312     options          FFS_ROOT     #FFS usable as root device [keep this!]
313
314
315
316 This is the basic hard drive Filesystem. Leave it in if you boot from the hard disk.
317
318
319
320     
321
322     options          UFS_DIRHASH  #Improve performance on big directories
323
324
325
326 This option includes functionality to speed up disk operations on large directories, at the expense of using additional memory. You would normally keep this for a large server, or interactive workstation, and remove it if you are using DragonFly on a smaller system where memory is at a premium and disk access speed is less important, such as a firewall.
327
328
329
330     
331
332     options          SOFTUPDATES  #Enable FFS Soft Updates support
333
334
335
336 This option enables Soft Updates in the kernel, this will help speed up write access on the disks. Even when this functionality is provided by the kernel, it must be turned on for specific disks. Review the output from [mount(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#mount&section8) to see if Soft Updates is enabled for your system disks. If you do not see the `soft-updates` option then you will need to activate it using the [tunefs(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=tunefs&section=8) (for existing filesystems) or [newfs(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=newfs&section=8) (for new filesystems) commands.
337
338
339
340     
341
342     options          MFS          #Memory Filesystem
343
344     options          MD_ROOT      #MD is a potential root device
345
346
347
348 This is the memory-mapped filesystem. This is basically a RAM disk for fast storage of temporary files, useful if you have a lot of swap space that you want to take advantage of. A perfect place to mount an MFS partition is on the `/tmp` directory, since many programs store temporary data here. To mount an MFS RAM disk on `/tmp`, add the following line to `/etc/fstab`:
349
350
351
352     
353
354     /dev/ad1s2b     /tmp mfs rw 0 0
355
356
357
358 Now you simply need to either reboot, or run the command `mount /tmp`.
359
360
361
362     
363
364     options          NFS          #Network Filesystem
365
366     options          NFS_ROOT     #NFS usable as root device, NFS required
367
368
369
370 The network Filesystem. Unless you plan to mount partitions from a UNIX® file server over TCP/IP, you can comment these out.
371
372
373
374     
375
376     options          MSDOSFS      #MSDOS Filesystem
377
378
379
380 The MS-DOS® Filesystem. Unless you plan to mount a DOS formatted hard drive partition at boot time, you can safely comment this out. It will be automatically loaded the first time you mount a DOS partition, as described above. Also, the excellent ***mtools*** software (in pkgsrc®) allows you to access DOS floppies without having to mount and unmount them (and does not require `MSDOSFS` at all).
381
382
383
384     
385
386     options          CD9660       #ISO 9660 Filesystem
387
388     options          CD9660_ROOT  #CD-ROM usable as root, CD9660 required
389
390
391
392 The ISO 9660 Filesystem for CDROMs. Comment it out if you do not have a CDROM drive or only mount data CDs occasionally (since it will be dynamically loaded the first time you mount a data CD). Audio CDs do not need this Filesystem.
393
394
395
396     
397
398     options          PROCFS       #Process filesystem
399
400
401
402 The process filesystem. This is a ***pretend*** filesystem mounted on `/proc` which allows programs like [ps(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#ps&section1) to give you more information on what processes are running. ***
403
404
405
406     
407
408
409
410 Compatibility with 4.3BSD. Leave this in; some programs will act strangely if you comment this out.
411
412
413
414     
415
416     options          SCSI_DELAY=5000    #Delay (in ms) before probing SCSI
417
418
419
420 This causes the kernel to pause for 15 seconds before probing each SCSI device in your system. If you only have IDE hard drives, you can ignore this, otherwise you will probably want to lower this number, perhaps to five seconds (5000 ms), to speed up booting. Of course, if you do this, and DragonFly has trouble recognizing your SCSI devices, you will have to raise it back up.
421
422
423
424     
425
426     options          UCONSOLE            #Allow users to grab the console
427
428
429
430 Allow users to grab the console, which is useful for X users. For example, you can create a console ***xterm*** by typing `xterm -C`, which will display any [write(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#write&section1), [talk(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=talk&section=1), and any other messages you receive, as well as any console messages sent by the kernel.
431
432
433
434     
435
436     options          USERCONFIG          #boot -c editor
437
438
439
440 This option allows you to boot the configuration editor from the boot menu.
441
442
443
444     
445
446     options          VISUAL_USERCONFIG   #visual boot -c editor
447
448
449
450 This option allows you to boot the visual configuration editor from the boot menu.
451
452
453
454     
455
456     options          KTRACE              #ktrace(1) support
457
458
459
460 This enables kernel process tracing, which is useful in debugging.
461
462
463
464     
465
466     options          SYSVSHM             #SYSV-style shared memory
467
468
469
470 This option provides for System V shared memory. The most common use of this is the XSHM extension in X, which many graphics-intensive programs will automatically take advantage of for extra speed. If you use X, you will definitely want to include this.
471
472
473
474     
475
476     options          SYSVSEM             #SYSV-style semaphores
477
478
479
480 Support for System V semaphores. Less commonly used but only adds a few hundred bytes to the kernel.
481
482
483
484     
485
486     options          SYSVMSG             #SYSV-style message queues
487
488
489
490 Support for System V messages. Again, only adds a few hundred bytes to the kernel.
491
492
493
494  **Note:** The [ipcs(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#ipcs&section1) command will list any processes using each of these System V facilities.
495
496
497
498     
499
500     options         P1003_1B                #Posix P1003_1B real-time extensions
501
502     options         _KPOSIX_PRIORITY_SCHEDULING
503
504
505
506 Real-time extensions added in the 1993 POSIX®. Certain applications in the ports collection use these (such as  **StarOffice™** ).
507
508
509
510     
511
512     options         ICMP_BANDLIM            #Rate limit bad replies
513
514
515
516 This option enables ICMP error response bandwidth limiting. You typically want this option as it will help protect the machine from denial of service packet attacks.
517
518
519
520     
521
522     # To make an SMP kernel, the next two are needed
523
524     #options        SMP                     # Symmetric MultiProcessor Kernel
525
526     #options        APIC_IO                 # Symmetric (APIC) I/O
527
528
529
530 The above are both required for SMP support.
531
532
533
534     
535
536     device          isa
537
538
539
540 All PCs supported by DragonFly have one of these. Do not remove, even if you have no ISA slots. If you have an IBM PS/2 (Micro Channel Architecture), DragonFly provides some limited support at this time. For more information about the MCA support, see `/usr/src/sys/config/LINT`.
541
542
543
544     
545
546     device          eisa
547
548
549
550 Include this if you have an EISA motherboard. This enables auto-detection and configuration support for all devices on the EISA bus.
551
552
553
554     
555
556     device          pci
557
558
559
560 Include this if you have a PCI motherboard. This enables auto-detection of PCI cards and gatewaying from the PCI to ISA bus.
561
562
563
564     
565
566     device          agp
567
568
569
570 Include this if you have an AGP card in the system. This will enable support for AGP, and AGP GART for boards which have these features.
571
572
573
574     
575
576     # Floppy drives
577
578     device          fdc0        at isa? port IO_FD1 irq 6 drq 2
579
580     device          fd0         at fdc0 drive 0
581
582     device          fd1         at fdc0 drive 1
583
584
585
586 This is the floppy drive controller. `fd0` is the `A:` floppy drive, and `fd1` is the `B:` drive.
587
588
589
590     
591
592     device          ata
593
594
595
596 This driver supports all ATA and ATAPI devices. You only need one `device ata` line for the kernel to detect all PCI ATA/ATAPI devices on modern machines.
597
598
599
600     
601
602     device          atadisk                 # ATA disk drives
603
604
605
606 This is needed along with `device ata` for ATA disk drives.
607
608
609
610     
611
612     device          atapicd                 # ATAPI CDROM drives
613
614
615
616 This is needed along with `device ata` for ATAPI CDROM drives.
617
618
619
620     
621
622     device          atapifd                 # ATAPI floppy drives
623
624
625
626 This is needed along with `device ata` for ATAPI floppy drives.
627
628
629
630     
631
632     device          atapist                 # ATAPI tape drives
633
634
635
636 This is needed along with `device ata` for ATAPI tape drives.
637
638
639
640     
641
642     options         ATA_STATIC_ID           #Static device numbering
643
644
645
646 This makes the controller number static (like the old driver) or else the device numbers are dynamically allocated.
647
648
649
650     
651
652     # ATA and ATAPI devices
653
654     device          ata0        at isa? port IO_WD1 irq 14
655
656     device          ata1        at isa? port IO_WD2 irq 15
657
658
659
660 Use the above for older, non-PCI systems.
661
662
663
664     
665
666     # SCSI Controllers
667
668     device          ahb        # EISA AHA1742 family
669
670     device          ahc        # AHA2940 and onboard AIC7xxx devices
671
672     device          amd        # AMD 53C974 (Teckram DC-390(T))
673
674     device          dpt        # DPT Smartcache - See LINT for options!
675
676     device          isp        # Qlogic family
677
678     device          ncr        # NCR/Symbios Logic
679
680     device          sym        # NCR/Symbios Logic (newer chipsets)
681
682     device          adv0       at isa?
683
684     device          adw
685
686     device          bt0        at isa?
687
688     device          aha0       at isa?
689
690     device          aic0       at isa?
691
692
693
694 SCSI controllers. Comment out any you do not have in your system. If you have an IDE only system, you can remove these altogether.
695
696
697
698     
699
700     # SCSI peripherals
701
702     device          scbus      # SCSI bus (required)
703
704     device          da         # Direct Access (disks)
705
706     device          sa         # Sequential Access (tape etc)
707
708     device          cd         # CD
709
710     device          pass       # Passthrough device (direct SCSI
711
712     access)
713
714
715
716 SCSI peripherals. Again, comment out any you do not have, or if you have only IDE hardware, you can remove them completely.
717
718
719
720  **Note:** The USB [umass(4)](http://leaf.dragonflybsd.org/cgi/web-man?command#umass&section4) driver (and a few other drivers) use the SCSI subsystem even though they are not real SCSI devices. Therefore make sure not to remove SCSI support, if any such drivers are included in the kernel configuration.
721
722
723
724     
725
726     # RAID controllers
727
728     device          ida        # Compaq Smart RAID
729
730     device          amr        # AMI MegaRAID
731
732     device          mlx        # Mylex DAC960 family
733
734
735
736 Supported RAID controllers. If you do not have any of these, you can comment them out or remove them.
737
738
739
740     
741
742     # atkbdc0 controls both the keyboard and the PS/2 mouse
743
744     device          atkbdc0    at isa? port IO_KBD
745
746
747
748 The keyboard controller (`atkbdc`) provides I/O services for the AT keyboard and PS/2 style pointing devices. This controller is required by the keyboard driver (`atkbd`) and the PS/2 pointing device driver (`psm`).
749
750
751
752     
753
754     device          atkbd0     at atkbdc? irq 1
755
756
757
758 The `atkbd` driver, together with `atkbdc` controller, provides access to the AT 84 keyboard or the AT enhanced keyboard which is connected to the AT keyboard controller.
759
760
761
762     
763
764     device          psm0       at atkbdc? irq 12
765
766
767
768 Use this device if your mouse plugs into the PS/2 mouse port.
769
770
771
772     
773
774     device          vga0        at isa?
775
776
777
778 The video card driver.
779
780
781
782     
783
784     # splash screen/screen saver
785
786     pseudo-device          splash
787
788
789
790 Splash screen at start up! Screen savers require this too.
791
792
793
794     
795
796     # syscons is the default console driver, resembling an SCO console
797
798     device          sc0          at isa?
799
800
801
802 `sc0` is the default console driver, which resembles a SCO console. Since most full-screen programs access the console through a terminal database library like `termcap`, it should not matter whether you use this or `vt0`, the `VT220` compatible console driver. When you log in, set your `TERM` variable to `scoansi` if full-screen programs have trouble running under this console.
803
804
805
806     
807
808     # Enable this and PCVT_FREEBSD for pcvt vt220 compatible console driver
809
810     #device          vt0     at isa?
811
812     #options         XSERVER          # support for X server on a vt console
813
814     #options         FAT_CURSOR       # start with block cursor
815
816     # If you have a ThinkPAD, uncomment this along with the rest of the PCVT lines
817
818     #options         PCVT_SCANSET=2   # IBM keyboards are non-std
819
820
821
822 This is a VT220-compatible console driver, backward compatible to VT100/102. It works well on some laptops which have hardware incompatibilities with `sc0`. Also set your `TERM` variable to `vt100` or `vt220` when you log in. This driver might also prove useful when connecting to a large number of different machines over the network, where `termcap` or `terminfo` entries for the `sc0` device are often not available -- `vt100` should be available on virtually any platform.
823
824
825
826     
827
828     # Power management support (see LINT for more options)
829
830     device          apm0     at nexus? disable flags 0x20  # Advanced Power Management
831
832
833
834 Advanced Power Management support. Useful for laptops.
835
836
837
838     
839
840     # PCCARD (PCMCIA) support
841
842     device          card
843
844     device          pcic0    at isa? irq 10 port 0x3e0 iomem 0xd0000
845
846     device          pcic1    at isa? irq 11 port 0x3e2 iomem 0xd4000 disable
847
848
849
850 PCMCIA support. You want this if you are using a laptop.
851
852
853
854     
855
856     # Serial (COM) ports
857
858     device          sio0     at isa? port IO_COM1 flags 0x10 irq 4
859
860     device          sio1     at isa? port IO_COM2 irq 3
861
862     device          sio2     at isa? disable port IO_COM3 irq 5
863
864     device          sio3     at isa? disable port IO_COM4 irq 9
865
866
867
868 These are the four serial ports referred to as COM1 through COM4 in the MS-DOS/Windows® world.
869
870
871
872  **Note:** If you have an internal modem on COM4 and a serial port at COM2, you will have to change the IRQ of the modem to 2 (for obscure technical reasons, IRQ2 # IRQ 9) in order to access it from DragonFly. If you have a multiport serial card, check the manual page for [sio(4)](http://leaf.dragonflybsd.org/cgi/web-man?commandsio&section=4) for more information on the proper values for these lines. Some video cards (notably those based on S3 chips) use IO addresses in the form of `0x*2e8`, and since many cheap serial cards do not fully decode the 16-bit IO address space, they clash with these cards making the COM4 port practically unavailable.
873
874
875
876 Each serial port is required to have a unique IRQ (unless you are using one of the multiport cards where shared interrupts are supported), so the default IRQs for COM3 and COM4 cannot be used.
877
878
879
880     
881
882     # Parallel port
883
884     device          ppc0    at isa? irq 7
885
886
887
888 This is the ISA-bus parallel port interface.
889
890
891
892     
893
894     device          ppbus      # Parallel port bus (required)
895
896
897
898 Provides support for the parallel port bus.
899
900
901
902     
903
904     device          lpt        # Printer
905
906
907
908 Support for parallel port printers.
909
910
911
912  **Note:** All three of the above are required to enable parallel printer support.
913
914
915
916     
917
918     device          plip       # TCP/IP over parallel
919
920
921
922 This is the driver for the parallel network interface.
923
924
925
926     
927
928     device          ppi        # Parallel port interface device
929
930
931
932 The general-purpose I/O (***geek port) + IEEE1284 I/O.
933
934
935
936     
937
938     #device         vpo        # Requires scbus and da
939
940
941
942 This is for an Iomega Zip drive. It requires `scbus` and `da` support. Best performance is achieved with ports in EPP 1.9 mode.
943
944
945
946     
947
948     # PCI Ethernet NICs.
949
950     device          de         # DEC/Intel DC21x4x (Tulip)
951
952     device          fxp        # Intel EtherExpress PRO/100B (82557, 82558)
953
954     device          tx         # SMC 9432TX (83c170 EPIC)
955
956     device          vx         # 3Com 3c590, 3c595 (Vortex)
957
958     device          wx         # Intel Gigabit Ethernet Card (Wiseman)
959
960
961
962 Various PCI network card drivers. Comment out or remove any of these not present in your system.
963
964
965
966     
967
968     # PCI Ethernet NICs that use the common MII bus controller code.
969
970     device          miibus     # MII bus support
971
972
973
974 MII bus support is required for some PCI 10/100 Ethernet NICs, namely those which use MII-compliant transceivers or implement transceiver control interfaces that operate like an MII. Adding `device miibus` to the kernel config pulls in support for the generic miibus API and all of the PHY drivers, including a generic one for PHYs that are not specifically handled by an individual driver.
975
976
977
978     
979
980     device          dc         # DEC/Intel 21143 and various workalikes
981
982     device          rl         # RealTek 8129/8139
983
984     device          sf         # Adaptec AIC-6915 (Starfire)
985
986     device          sis        # Silicon Integrated Systems SiS 900/SiS 7016
987
988     device          ste        # Sundance ST201 (D-Link DFE-550TX)
989
990     device          tl         # Texas Instruments ThunderLAN
991
992     device          vr         # VIA Rhine, Rhine II
993
994     device          wb         # Winbond W89C840F
995
996     device          xl         # 3Com 3c90x (Boomerang, Cyclone)
997
998
999
1000 Drivers that use the MII bus controller code.
1001
1002
1003
1004     
1005
1006     # ISA Ethernet NICs.
1007
1008     device          ed0    at isa? port 0x280 irq 10 iomem 0xd8000
1009
1010     device          ex
1011
1012     device          ep
1013
1014     # WaveLAN/IEEE 802.11 wireless NICs. Note: the WaveLAN/IEEE really
1015
1016     # exists only as a PCMCIA device, so there is no ISA attachment needed
1017
1018     # and resources will always be dynamically assigned by the pccard code.
1019
1020     device          wi
1021
1022     # Aironet 4500/4800 802.11 wireless NICs. Note: the declaration below will
1023
1024     # work for PCMCIA and PCI cards, as well as ISA cards set to ISA PnP
1025
1026     # mode (the factory default). If you set the switches on your ISA
1027
1028     # card for a manually chosen I/O address and IRQ, you must specify
1029
1030     # those parameters here.
1031
1032     device          an
1033
1034     # The probe order of these is presently determined by i386/isa/isa_compat.c.
1035
1036     device          ie0    at isa? port 0x300 irq 10 iomem 0xd0000
1037
1038     device          fe0    at isa? port 0x300
1039
1040     device          le0    at isa? port 0x300 irq 5 iomem 0xd0000
1041
1042     device          lnc0   at isa? port 0x280 irq 10 drq 0
1043
1044     device          cs0    at isa? port 0x300
1045
1046     device          sn0    at isa? port 0x300 irq 10
1047
1048     # requires PCCARD (PCMCIA) support to be activated
1049
1050     #device         xe0    at isa?
1051
1052
1053
1054 ISA Ethernet drivers. See `/usr/src/sys/config/LINT` for which cards are supported by which driver.
1055
1056
1057
1058     
1059
1060     pseudo-device   ether         # Ethernet support
1061
1062
1063
1064 `ether` is only needed if you have an Ethernet card. It includes generic Ethernet protocol code.
1065
1066
1067
1068     
1069
1070     pseudo-device   sl      1     # Kernel SLIP
1071
1072
1073
1074 `sl` is for SLIP support. This has been almost entirely supplanted by PPP, which is easier to set up, better suited for modem-to-modem connection, and more powerful. The ***number*** after `sl` specifies how many simultaneous SLIP sessions to support.
1075
1076
1077
1078     
1079
1080     pseudo-device   ppp     1     # Kernel PPP
1081
1082
1083
1084 This is for kernel PPP support for dial-up connections. There is also a version of PPP implemented as a userland application that uses `tun` and offers more flexibility and features such as demand dialing. The ***number*** after `ppp` specifies how many simultaneous PPP connections to support. .
1085
1086
1087
1088     
1089
1090     device   tun           # Packet tunnel.
1091
1092
1093
1094 This is used by the userland PPP software. A ***number*** after `tun` specifies the number of simultaneous PPP sessions to support. See the [userppp.html PPP] section of this book for more information.
1095
1096
1097
1098     
1099
1100     pseudo-device   pty           # Pseudo-ttys (telnet etc)
1101
1102
1103
1104 This is a ***pseudo-terminal*** or simulated login port. It is used by incoming `telnet` and `rlogin` sessions, ***xterm***, and some other applications such as ***Emacs***. The ***number*** after `pty` indicates the number of `pty`s to create. If you need more than the default of 16 simultaneous ***xterm*** windows and/or remote logins, be sure to increase this number accordingly, up to a maximum of 256. ***
1105
1106
1107
1108     
1109
1110
1111
1112 Memory disk pseudo-devices.
1113
1114
1115
1116     
1117
1118     pseudo-device   gif     # IPv6 and IPv4 tunneling
1119
1120
1121
1122 This implements IPv6 over IPv4 tunneling, IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling, and IPv6 over IPv6 tunneling.
1123
1124
1125
1126     
1127
1128     pseudo-device   faith   # IPv6-to-IPv4 relaying (translation)
1129
1130
1131
1132 This pseudo-device captures packets that are sent to it and diverts them to the IPv4/IPv6 translation daemon.
1133
1134
1135
1136     
1137
1138     # The `bpf' device enables the Berkeley Packet Filter.
1139
1140     # Be aware of the administrative consequences of enabling this!
1141
1142     pseudo-device   bpf           # Berkeley packet filter
1143
1144
1145
1146 This is the Berkeley Packet Filter. This pseudo-device allows network interfaces to be placed in promiscuous mode, capturing every packet on a broadcast network (e.g., an Ethernet). These packets can be captured to disk and or examined with the [tcpdump(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#tcpdump&section1) program.
1147
1148
1149
1150  **Note:** The [bpf(4)](http://leaf.dragonflybsd.org/cgi/web-man?command#bpf&section4) device is also used by [dhclient(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=dhclient&section=8) to obtain the IP address of the default router (gateway) and so on. If you use DHCP, leave this uncommented.
1151
1152
1153
1154     
1155
1156     # USB support
1157
1158     #device         uhci          # UHCI PCI-&gt;USB interface
1159
1160     #device         ohci          # OHCI PCI-&gt;USB interface
1161
1162     #device         usb           # USB Bus (required)
1163
1164     #device         ugen          # Generic
1165
1166     #device         uhid          # ***Human Interface Devices***
1167
1168     #device         ukbd          # Keyboard
1169
1170     #device         ulpt          # Printer
1171
1172     #device         umass         # Disks/Mass storage - Requires scbus and da
1173
1174     #device         ums           # Mouse
1175
1176     # USB Ethernet, requires mii
1177
1178     #device         aue           # ADMtek USB ethernet
1179
1180     #device         cue           # CATC USB ethernet
1181
1182     #device         kue           # Kawasaki LSI USB ethernet
1183
1184
1185
1186 Support for various USB devices.
1187
1188
1189
1190 For more information and additional devices supported by DragonFly, see `/usr/src/sys/i386/conf/LINT`.
1191
1192
1193
1194 #### Notes 
1195
1196 [[!table  data="""
1197 <tablewidth="100%"> [(1)](kernelconfig-config.html#AEN7414) | The auto-tuning algorithm sets `maxuser` equal to the amount of memory in the system, with a minimum of 32, and a maximum of 384. |
1198 | | 
1199 """]]
1200
1201
1202
1203
1204
1205
1206 ## Device Nodes 
1207
1208
1209
1210 Almost every device in the kernel has a corresponding node entry in the `/dev` directory. These nodes look like regular files, but are actually special entries into the kernel which programs use to access the device. 
1211
1212 These nodes are created automatically once devfs is mounted, which happens manually for the root `/dev` during boot, just after the root mount.
1213
1214
1215
1216 ## If Something Goes Wrong 
1217
1218
1219  **Note:** If you are having trouble building a kernel, make sure to keep a `GENERIC`, or some other kernel that is known to work on hand as a different name that will not get erased on the next build. You cannot rely on `kernel.old` because when installing a new kernel, `kernel.old` is overwritten with the last installed kernel which may be non-functional. Also, as soon as possible, move the working kernel to the proper `kernel` location or commands such as [ps(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#ps&section1) will not work properly. The proper command to ***unlock*** the kernel file that `make` installs (in order to move another kernel back permanently) is:
1220
1221
1222      % chflags noschg /boot/kernel
1223      
1224
1225 If you find you cannot do this, you are probably running at a [securelevel(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#securelevel&section8) greater than zero. Edit `kern_securelevel` in `/etc/rc.conf` and set it to `-1`, then reboot. You can change it back to its previous setting when you are happy with your new kernel.
1226
1227 And, if you want to ***lock*** your new kernel into place, or any file for that matter, so that it cannot be moved or tampered with:
1228
1229     
1230
1231     % chflags schg /boot/kernel
1232     
1233
1234
1235 There are five categories of trouble that can occur when building a custom kernel. They are:
1236
1237
1238
1239
1240 * `config` fails: If the [config(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#config&section8) command fails when you give it your kernel description, you have probably made a simple error somewhere. Fortunately, [config(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=config&section=8) will print the line number that it had trouble with, so you can quickly skip to it with ***vi***. For example, if you see `config: line 17: syntax error`. You can skip to the problem in ***vi*** by typing `17G` in command mode. Make sure the keyword is typed correctly, by comparing it to the `GENERIC` kernel or another reference.
1241
1242
1243
1244
1245 * `make` fails: If the `make` command fails, it usually signals an error in your kernel description, but not severe enough for [config(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#config&section8) to catch it. Again, look over your configuration, and if you still cannot resolve the problem, send mail to the [DragonFly Bugs mailing list](http://leaf.dragonflybsd.org/mailarchive/) with your kernel configuration, and it should be diagnosed very quickly.
1246
1247
1248
1249
1250 * Installing the new kernel fails: If the kernel compiled fine, but failed to install (the `make install` or `make installkernel` command failed), the first thing to check is if your system is running at securelevel 1 or higher (see [init(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#init&section8)). The kernel installation tries to remove the immutable flag from your kernel and set the immutable flag on the new one. Since securelevel 1 or higher prevents unsetting the immutable flag for any files on the system, the kernel installation needs to be performed at securelevel 0 or lower.
1251
1252
1253
1254
1255 * The kernel does not boot: If your new kernel does not boot, or fails to recognize your devices, do not panic! Fortunately, DragonFly has an excellent mechanism for recovering from incompatible kernels. Simply choose the kernel you want to boot from at the DragonFly boot loader. You can access this when the system counts down from 10. Hit any key except for the  **Enter**  key, type `unload` and then type `boot ***kernel.old***`, or the filename of any other kernel that will boot properly. When reconfiguring a kernel, it is always a good idea to keep a kernel that is known to work on hand. After booting with a good kernel you can check over your configuration file and try to build it again. One helpful resource is the `/var/log/messages` file which records, among other things, all of the kernel messages from every successful boot. Also, the [dmesg(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#dmesg&section8) command will print the kernel messages from the current boot.
1256
1257
1258
1259 * The kernel works, but [ps(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#ps&section1) does not work any more: If you have installed a different version of the kernel from the one that the system utilities have been built with, many system-status commands like [ps(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=ps&section=1) and [vmstat(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=vmstat&section=8) will not work any more. You must recompile the `libkvm` library as well as these utilities. This is one reason it is not normally a good idea to use a different version of the kernel from the rest of the operating system.