1 .\" Copyright (c) 1999 Daniel C. Sobral
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd kernel bootstrapping final stage
38 kernel bootstrapping process.
39 On IA32 (i386) architectures, it is a
42 It is linked statically to
44 and usually located in the directory
47 It provides a scripting language that can be used to
48 automate tasks, do pre-configuration or assist in recovery
50 This scripting language is roughly divided in
52 The smaller one is a set of commands
53 designed for direct use by the casual user, called "builtin
54 commands" for historical reasons.
55 The main drive behind these commands is user-friendliness.
56 The bigger component is an
58 Forth compatible Forth interpreter based on FICL, by
61 During initialization,
63 will probe for a console and set the
65 variable, or set it to serial console
67 if the previous boot stage used that.
68 If multiple consoles are selected, they will be listed separated by spaces.
69 Then, devices are probed,
78 is initialized, the builtin words are added to its vocabulary, and
80 is processed if it exists.
81 No disk switching is possible while that file is being read.
93 is processed if available.
94 These files are processed through the
96 command, which reads all of them into memory before processing them,
97 making disk changes possible.
101 has not been tried, and if
105 (not case sensitive), then an
108 If the system gets past this point,
112 will engage interactive mode.
113 Please note that historically even when
117 user will be able to interrupt autoboot process by pressing some key
118 on the console while kernel and modules are being loaded.
120 cases such behaviour may be undesirable, to prevent it set
126 will engage interactive mode only if
132 builtin commands take parameters from the command line.
134 the only way to call them from a script is by using
137 If an error condition occurs, an exception will be generated,
138 which can be intercepted using
140 Forth exception handling
142 If not intercepted, an error message will be displayed and
143 the interpreter's state will be reset, emptying the stack and restoring
146 The builtin commands available are:
148 .Bl -tag -width Ds -compact
149 .It Ic autoboot Op Ar seconds Op Ar prompt
150 Proceeds to bootstrap the system after a number of seconds, if not
151 interrupted by the user.
152 Displays a countdown prompt
153 warning the user the system is about to be booted,
154 unless interrupted by a key press.
155 The kernel will be loaded first if necessary.
156 Defaults to 10 seconds.
159 Displays statistics about disk cache usage.
163 .It Ic boot Ar kernelname Op Cm ...
164 .It Ic boot Fl flag Cm ...
165 Immediately proceeds to bootstrap the system, loading the kernel
167 Any flags or arguments are passed to the kernel, but they
168 must precede the kernel name, if a kernel name is provided.
171 The behavior of this builtin is changed if
179 Displays text on the screen.
180 A new line will be printed unless
185 Displays memory usage statistics.
186 For debugging purposes only.
188 .It Ic help Op topic Op subtopic
189 Shows help messages read from
190 .Pa /boot/loader.help .
193 will list the topics available.
195 .It Ic include Ar file Op Ar
196 Process script files.
197 Each file, in turn, is completely read into memory,
198 and then each of its lines is passed to the command line interpreter.
199 If any error is returned by the interpreter, the include
200 command aborts immediately, without reading any other files, and
201 returns an error itself (see
208 Loads a kernel, kernel loadable module (kld), disk image,
209 or file of opaque contents tagged as being of the type
211 Kernel and modules can be either in a.out or ELF format.
212 Any arguments passed after the name of the file to be loaded
213 will be passed as arguments to that file.
216 type to make the kernel create a file-backed
219 This is useful for booting from a temporary rootfs.
220 Currently, argument passing does not work for the kernel.
228 encryption keyfile for the given provider name.
229 The key index can be specified via
231 or will default to zero.
237 Displays a listing of files in the directory
239 or the root directory if
244 is specified, file sizes will be shown too.
247 Lists all of the devices from which it may be possible to load modules,
248 as well as ZFS pools.
251 is specified, more details are printed, including ZFS pool information
252 in a format that resembles
257 Displays loaded modules.
260 is specified, more details are shown.
262 .It Ic lszfs Ar filesystem
263 A ZFS extended command that can be used to explore the ZFS filesystem
265 Lists the immediate children of the
267 The filesystem hierarchy is rooted at a filesystem with the same name
270 .It Ic more Ar file Op Ar
271 Display the files specified, with a pause at each
275 .It Ic pnpscan Op Fl v
276 Scans for Plug-and-Play devices.
277 This is not functional at present.
284 Reads a line of input from the terminal, storing it in
287 A timeout can be specified with
289 though it will be canceled at the first key pressed.
290 A prompt may also be displayed through the
295 Immediately reboots the system.
297 .It Ic set Ar variable
298 .It Ic set Ar variable Ns = Ns Ar value
299 Set loader's environment variables.
301 .It Ic show Op Va variable
302 Displays the specified variable's value, or all variables and their
308 Remove all modules from memory.
310 .It Ic unset Va variable
313 from the environment.
316 Lists available commands.
318 .Ss BUILTIN ENVIRONMENT VARIABLES
321 has actually two different kinds of
324 There are ANS Forth's
325 .Em environmental queries ,
326 and a separate space of environment variables used by builtins, which
327 are not directly available to Forth words.
328 It is the latter type that this section covers.
330 Environment variables can be set and unset through the
334 builtins, and can have their values interactively examined through the
338 Their values can also be accessed as described in
341 Notice that these environment variables are not inherited by any shell
342 after the system has been booted.
344 A few variables are set automatically by
346 Others can affect the behavior of either
348 or the kernel at boot.
349 Some options may require a value,
350 while others define behavior just by being set.
351 Both types of builtin variables are described below.
352 .Bl -tag -width bootfile
353 .It Va autoboot_delay
356 will wait before booting.
357 If this variable is not defined,
359 will default to 10 seconds.
365 will be automatically attempted after processing
366 .Pa /boot/loader.rc ,
369 will be processed normally, defaulting to 10 seconds delay.
373 no delay will be inserted, but user still will be able to interrupt
375 process and escape into the interactive mode by pressing some key
376 on the console while kernel and
377 modules are being loaded.
381 no delay will be inserted and
383 will engage interactive mode only if
385 has failed for some reason.
387 Instructs the kernel to prompt the user for the name of the root device
388 when the kernel is booted.
390 Instructs the kernel to try to mount the root file system from CD-ROM.
392 Instructs the kernel to start in the DDB debugger, rather than
393 proceeding to initialize when booted.
395 Instructs the kernel to mount the statically compiled-in root file system.
397 Selects gdb-remote mode for the kernel debugger by default.
398 .It Va boot_multicons
399 Enables multiple console support in the kernel early on boot.
400 In a running system, console configuration can be manipulated
405 All kernel console output is suppressed when console is muted.
406 In a running system, the state of console muting can be manipulated by the
410 During the device probe, pause after each line is printed.
412 Force the use of a serial console even when an internal console
415 Prevents the kernel from initiating a multi-user startup; instead,
416 a single-user mode will be entered when the kernel has finished
419 Setting this variable causes extra debugging information to be printed
420 by the kernel during the boot phase.
422 List of semicolon-separated search path for bootable kernels.
425 .It Va comconsole_speed
426 Defines the speed of the serial console (i386 and amd64 only).
427 If the previous boot stage indicated that a serial console is in use
428 then this variable is initialized to the current speed of the console
430 Otherwise it is set to 9600 unless this was overridden using the
431 .Va BOOT_COMCONSOLE_SPEED
437 variable take effect immediately.
438 .It Va comconsole_port
439 Defines the base i/o port used to access console UART
440 (i386 and amd64 only).
441 If the variable is not set, its assumed value is 0x3F8, which
442 corresponds to PC port COM1, unless overridden by
443 .Va BOOT_COMCONSOLE_PORT
444 variable during the compilation of
448 variable automatically set
450 environment variable to provide a hint to kernel for location of the console.
451 Loader console is changed immediately after variable
454 .It Va comconsole_pcidev
455 Defines the location of a PCI device of the 'simple communication'
456 class to be used as the serial console UART (i386 and amd64 only).
457 The syntax of the variable is
458 .Li 'bus:device:function[:bar]' ,
459 where all members must be numeric, with possible
461 prefix to indicate a hexadecimal value.
464 member is optional and assumed to be 0x10 if omitted.
465 The bar must decode i/o space.
467 .Va comconsole_pcidev
468 automatically sets the variable
470 to the base of the selected bar, and hint
471 .Va hw.uart.console .
472 Loader console is changed immediately after variable
473 .Va comconsole_pcidev
476 Defines the current console or consoles.
477 Multiple consoles may be specified.
478 In that case, the first listed console will become the default console for
479 userland output (e.g.\& from
482 Selects the default device to loader the kernel from.
484 .Dl Ic loader_device:
489 .Dl Ic zfs:zroot/ROOT/default:
491 Sets the device for kernel dumps.
492 This can be used to ensure that a device is configured before the corresponding
496 has been processed, allowing kernel panics that happen during the early stages
497 of boot to be captured.
505 Sets the list of binaries which the kernel will try to run as the initial
507 The first matching binary is used.
509 .Dq Li /sbin/init:/sbin/oinit:/sbin/init.bak:\:/rescue/init .
519 if the Forth's current state is interpreting.
521 Define the number of lines on the screen, to be used by the pager.
523 Sets the list of directories which will be searched for modules
524 named in a load command or implicitly required by a dependency.
525 The default value for this variable is
526 .Dq Li /boot/kernel;/boot/modules .
528 Sets the number of IDE disks as a workaround for some problems in
529 finding the root disk at boot.
530 This has been deprecated in favor of
537 .Dq Li "${interpret}" .
540 is unset, the default prompt is
542 .It Va root_disk_unit
543 If the code which detects the disk unit number for the root disk is
544 confused, e.g.\& by a mix of SCSI and IDE disks, or IDE disks with
545 gaps in the sequence (e.g.\& no primary slave), the unit number can
546 be forced by setting this variable.
548 By default the value of
550 is used to set the root file system
551 when the kernel is booted.
552 This can be overridden by setting
557 Other variables are used to override kernel tunable parameters.
558 The following tunables are available:
560 .It Va efi.rt.disabled
561 Disable UEFI runtime services in the kernel, if applicable.
562 Runtime services are only available and used if the kernel is booted in a UEFI
565 Limit the amount of physical memory the system will use.
566 By default the size is in bytes, but the
567 .Cm k , K , m , M , g
571 are also accepted and indicate kilobytes, megabytes and gigabytes
573 An invalid suffix will result in the variable being ignored by the
575 .It Va hw.pci.host_start_mem , hw.acpi.host_start_mem
576 When not otherwise constrained, this limits the memory start
578 The default is 0x80000000 and should be set to at least size of the
579 memory and not conflict with other resources.
580 Typically, only systems without PCI bridges need to set this variable
581 since PCI bridges typically constrain the memory starting address
582 (and the variable is only used when bridges do not constrain this
584 .It Va hw.pci.enable_io_modes
585 Enable PCI resources which are left off by some BIOSes or are not
586 enabled correctly by the device driver.
587 Tunable value set to ON (1) by default, but this may cause problems
588 with some peripherals.
590 Set the size of a number of statically allocated system tables; see
592 for a description of how to select an appropriate value for this
594 When set, this tunable replaces the value declared in the kernel
595 compile-time configuration file.
596 .It Va kern.ipc.nmbclusters
597 Set the number of mbuf clusters to be allocated.
598 The value cannot be set below the default
599 determined when the kernel was compiled.
600 .It Va kern.ipc.nsfbufs
603 buffers to be allocated.
606 Not all architectures use such buffers; see
609 .It Va kern.maxswzone
610 Limits the amount of KVM to be used to hold swap
611 metadata, which directly governs the
612 maximum amount of swap the system can support,
613 at the rate of approximately 200 MB of swap space
614 per 1 MB of metadata.
615 This value is specified in bytes of KVA space.
616 If no value is provided, the system allocates
617 enough memory to handle an amount of swap
618 that corresponds to eight times the amount of
619 physical memory present in the system.
621 Note that swap metadata can be fragmented,
622 which means that the system can run out of
623 space before it reaches the theoretical limit.
624 Therefore, care should be taken to not configure
625 more swap than approximately half of the
628 Running out of space for swap metadata can leave
629 the system in an unrecoverable state.
630 Therefore, you should only change
631 this parameter if you need to greatly extend the
632 KVM reservation for other resources such as the
634 .Va kern.ipc.nmbclusters .
635 Modifies kernel option
636 .Dv VM_SWZONE_SIZE_MAX .
637 .It Va kern.maxbcache
638 Limits the amount of KVM reserved for use by the
639 buffer cache, specified in bytes.
640 The default maximum is 200MB on i386,
642 This parameter is used to
643 prevent the buffer cache from eating too much
644 KVM in large-memory machine configurations.
645 Only mess around with this parameter if you need to
646 greatly extend the KVM reservation for other resources
647 such as the swap zone or
648 .Va kern.ipc.nmbclusters .
650 the NBUF parameter will override this limit.
652 .Dv VM_BCACHE_SIZE_MAX .
653 .It Va kern.msgbufsize
654 Sets the size of the kernel message buffer.
655 The default limit of 96KB is usually sufficient unless
656 large amounts of trace data need to be collected
657 between opportunities to examine the buffer or
659 Overrides kernel option
661 .It Va machdep.disable_mtrrs
662 Disable the use of i686 MTRRs (x86 only).
663 .It Va net.inet.tcp.tcbhashsize
664 Overrides the compile-time set value of
666 or the preset default of 512.
667 Must be a power of 2.
668 .It Va twiddle_divisor
669 Throttles the output of the
671 I/O progress indicator displayed while loading the kernel and modules.
672 This is useful on slow serial consoles where the time spent waiting for
673 these characters to be written can add up to many seconds.
674 The default is 1 (full speed); a value of 2 spins half as fast, and so on.
676 Sets the size of kernel memory (bytes).
677 This overrides the value determined when the kernel was compiled.
680 .It Va vm.kmem_size_min
681 .It Va vm.kmem_size_max
682 Sets the minimum and maximum (respectively) amount of kernel memory
683 that will be automatically allocated by the kernel.
684 These override the values determined when the kernel was compiled.
688 .Dv VM_KMEM_SIZE_MAX .
692 supports the following format for specifying ZFS filesystems which
695 refers to a device specification:
697 .Ar zfs:pool/filesystem:
701 is a ZFS filesystem name as described in
706 does not have an entry for the root filesystem and
707 .Va vfs.root.mountfrom
710 refers to a ZFS filesystem, then
712 will instruct kernel to use that filesystem as the root filesystem.
714 When a builtin command is executed, the rest of the line is taken
715 by it as arguments, and it is processed by a special parser which
716 is not used for regular Forth commands.
718 This special parser applies the following rules to the parsed text:
721 All backslash characters are preprocessed.
724 \eb , \ef , \er , \en and \et are processed as in C.
726 \es is converted to a space.
733 Useful for things like
736 \e0xN and \e0xNN are replaced by the hex N or NN.
738 \eNNN is replaced by the octal NNN
742 \e" , \e' and \e$ will escape these characters, preventing them from
743 receiving special treatment in Step 2, described below.
745 \e\e will be replaced with a single \e .
747 In any other occurrence, backslash will just be removed.
750 Every string between non-escaped quotes or double-quotes will be treated
751 as a single word for the purposes of the remaining steps.
757 with the value of the environment variable
760 Space-delimited arguments are passed to the called builtin command.
761 Spaces can also be escaped through the use of \e\e .
764 An exception to this parsing rule exists, and is described in
765 .Sx BUILTINS AND FORTH .
766 .Ss BUILTINS AND FORTH
767 All builtin words are state-smart, immediate words.
768 If interpreted, they behave exactly as described previously.
769 If they are compiled, though,
770 they extract their arguments from the stack instead of the command line.
772 If compiled, the builtin words expect to find, at execution time, the
773 following parameters on the stack:
774 .D1 Ar addrN lenN ... addr2 len2 addr1 len1 N
777 are strings which will compose the command line that will be parsed
778 into the builtin's arguments.
779 Internally, these strings are concatenated in from 1 to N,
780 with a space put between each one.
782 If no arguments are passed, a 0
784 be passed, even if the builtin accepts no arguments.
786 While this behavior has benefits, it has its trade-offs.
787 If the execution token of a builtin is acquired (through
795 the builtin behavior will depend on the system state
803 This is particularly annoying for programs that want or need to
805 In this case, the use of a proxy is recommended.
810 is a Forth interpreter written in C, in the form of a forth
811 virtual machine library that can be called by C functions and vice
816 each line read interactively is then fed to
820 back to execute the builtin words.
827 The words available to
829 can be classified into four groups.
832 Forth standard words, extra
836 words, and the builtin commands;
837 the latter were already described.
840 Forth standard words are listed in the
843 The words falling in the two other groups are described in the
844 following subsections.
846 .Bl -tag -width wid-set-super
854 This is the STRING word set's
861 This is the STRING word set's
871 .Ss FREEBSD EXTRA WORDS
872 .Bl -tag -width XXXXXXXX
874 Evaluates the remainder of the input buffer, after having printed it first.
876 Evaluates the remainder of the input buffer under a
882 but without outputting a trailing space.
883 .It Ic fclose Pq Ar fd --
885 .It Ic fkey Pq Ar fd -- char
886 Reads a single character from a file.
887 .It Ic fload Pq Ar fd --
890 .It Ic fopen Pq Ar addr len mode Li -- Ar fd
892 Returns a file descriptor, or \-1 in case of failure.
895 parameter selects whether the file is to be opened for read access, write
898 .Dv O_RDONLY , O_WRONLY ,
902 .Pa /boot/support.4th ,
903 indicating read only, write only, and read-write access, respectively.
906 .Pq Ar fd addr len -- len'
914 Returns the actual number of bytes read, or -1 in case of error or end of
916 .It Ic heap? Pq -- Ar cells
917 Return the space remaining in the dictionary heap, in cells.
918 This is not related to the heap used by dynamic memory allocation words.
919 .It Ic inb Pq Ar port -- char
920 Reads a byte from a port.
921 .It Ic key Pq -- Ar char
922 Reads a single character from the console.
923 .It Ic key? Pq -- Ar flag
926 if there is a character available to be read from the console.
931 .It Ic outb Pq Ar port char --
932 Writes a byte to a port.
933 .It Ic seconds Pq -- Ar u
934 Returns the number of seconds since midnight.
935 .It Ic tib> Pq -- Ar addr len
936 Returns the remainder of the input buffer as a string on the stack.
937 .It Ic trace! Pq Ar flag --
938 Activates or deactivates tracing.
942 .Ss FREEBSD DEFINED ENVIRONMENTAL QUERIES
946 if the architecture is IA32.
949 version at compile time.
957 command line provides several ways of compromising system security,
958 including, but not limited to:
962 Booting from removable storage, by setting the
968 Executing binary of choice, by setting the
974 Overriding ACPI DSDT to inject arbitrary code into the ACPI subsystem
977 One can prevent unauthorized access
980 command line by setting the
988 In order for this to be effective, one should also configure the firmware
989 (BIOS or UEFI) to prevent booting from unauthorized devices.
991 .Bl -tag -width /usr/share/examples/bootforth/ -compact
995 .It Pa /boot/boot.4th
999 .It Pa /boot/defaults/loader.conf
1000 .It Pa /boot/loader.4th
1001 Extra builtin-like words.
1002 .It Pa /boot/loader.conf
1003 .It Pa /boot/loader.conf.local
1005 configuration files, as described in
1007 .It Pa /boot/loader.rc
1009 bootstrapping script.
1010 .It Pa /boot/loader.help
1013 Contains the help messages.
1014 .It Pa /boot/support.4th
1017 .It Pa /usr/share/examples/bootforth/
1021 Boot in single user mode:
1025 Load the kernel, a splash screen, and then autoboot in five seconds.
1026 Notice that a kernel must be loaded before any other
1028 command is attempted.
1029 .Bd -literal -offset indent
1032 load -t splash_image_data /boot/chuckrulez.bmp
1036 Set the disk unit of the root device to 2, and then boot.
1037 This would be needed in a system with two IDE disks,
1038 with the second IDE disk hardwired to ada2 instead of ada1.
1039 .Bd -literal -offset indent
1040 set root_disk_unit=2
1041 boot /boot/kernel/kernel
1044 Set the default device used for loading a kernel from a ZFS filesystem:
1045 .Bd -literal -offset indent
1046 set currdev=zfs:tank/ROOT/knowngood:
1050 The following values are thrown by
1052 .Bl -tag -width XXXXX -offset indent
1054 Any type of error in the processing of a builtin.
1065 Out of interpreting text.
1067 Need more text to succeed -- will finish on next run.
1081 For the purposes of ANS Forth compliance, loader is an
1083 ANS Forth System with Environmental Restrictions, Providing
1089 parse, pick, roll, refill, to, value, \e, false, true,
1092 compile\&, , erase, nip, tuck
1097 from the Core Extensions word set, Providing the Exception Extensions
1098 word set, Providing the Locals Extensions word set, Providing the
1099 Memory-Allocation Extensions word set, Providing
1103 bye, forget, see, words,
1110 from the Programming-Tools extension word set, Providing the
1111 Search-Order extensions word set.
1123 .An Michael Smith Aq msmith@FreeBSD.org .
1127 .An John Sadler Aq john_sadler@alum.mit.edu .
1133 words will read from the input buffer instead of the console.
1134 The latter will be fixed, but the former will not.
projects / FreeBSD / FreeBSD.git / blob