]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - stand/man/loader.8
Move around text in loader(8), in particular stuff related to ZFS,
[FreeBSD/FreeBSD.git] / stand / man / loader.8
1 .\" Copyright (c) 1999 Daniel C. Sobral
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
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.
12 .\"
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
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD$
26 .\"
27 .Dd August 13, 2018
28 .Dt LOADER 8
29 .Os
30 .Sh NAME
31 .Nm loader
32 .Nd kernel bootstrapping final stage
33 .Sh DESCRIPTION
34 The program called
35 .Nm
36 is the final stage of
37 .Fx Ns 's
38 kernel bootstrapping process.
39 On IA32 (i386) architectures, it is a
40 .Pa BTX
41 client.
42 It is linked statically to
43 .Xr libstand 3
44 and usually located in the directory
45 .Pa /boot .
46 .Pp
47 It provides a scripting language that can be used to
48 automate tasks, do pre-configuration or assist in recovery
49 procedures.
50 This scripting language is roughly divided in
51 two main components.
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
57 .Tn ANS
58 Forth compatible Forth interpreter based on FICL, by
59 .An John Sadler .
60 .Pp
61 During initialization,
62 .Nm
63 will probe for a console and set the
64 .Va console
65 variable, or set it to serial console
66 .Pq Dq Li comconsole
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,
70 .Va currdev
71 and
72 .Va loaddev
73 are set, and
74 .Va LINES
75 is set to 24.
76 Next,
77 .Tn FICL
78 is initialized, the builtin words are added to its vocabulary, and
79 .Pa /boot/boot.4th
80 is processed if it exists.
81 No disk switching is possible while that file is being read.
82 The inner interpreter
83 .Nm
84 will use with
85 .Tn FICL
86 is then set to
87 .Ic interpret ,
88 which is
89 .Tn FICL Ns 's
90 default.
91 After that,
92 .Pa /boot/loader.rc
93 is processed if available.
94 These files are processed through the
95 .Ic include
96 command, which reads all of them into memory before processing them,
97 making disk changes possible.
98 .Pp
99 At this point, if an
100 .Ic autoboot
101 has not been tried, and if
102 .Va autoboot_delay
103 is not set to
104 .Dq Li NO
105 (not case sensitive), then an
106 .Ic autoboot
107 will be tried.
108 If the system gets past this point,
109 .Va prompt
110 will be set and
111 .Nm
112 will engage interactive mode.
113 Please note that historically even when
114 .Va autoboot_delay
115 is set to
116 .Dq Li 0
117 user will be able to interrupt autoboot process by pressing some key
118 on the console while kernel and modules are being loaded.
119 In some
120 cases such behaviour may be undesirable, to prevent it set
121 .Va autoboot_delay
122 to
123 .Dq Li -1 ,
124 in this case
125 .Nm
126 will engage interactive mode only if
127 .Ic autoboot
128 has failed.
129 .Sh BUILTIN COMMANDS
130 In
131 .Nm ,
132 builtin commands take parameters from the command line.
133 Presently,
134 the only way to call them from a script is by using
135 .Pa evaluate
136 on a string.
137 If an error condition occurs, an exception will be generated,
138 which can be intercepted using
139 .Tn ANS
140 Forth exception handling
141 words.
142 If not intercepted, an error message will be displayed and
143 the interpreter's state will be reset, emptying the stack and restoring
144 interpreting mode.
145 .Pp
146 The builtin commands available are:
147 .Pp
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.
157 .Pp
158 .It Ic bcachestat
159 Displays statistics about disk cache usage.
160 For debugging only.
161 .Pp
162 .It Ic boot
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
166 if necessary.
167 Any flags or arguments are passed to the kernel, but they
168 must precede the kernel name, if a kernel name is provided.
169 .Pp
170 .Em WARNING :
171 The behavior of this builtin is changed if
172 .Xr loader.4th 8
173 is loaded.
174 .Pp
175 .It Ic echo Xo
176 .Op Fl n
177 .Op Aq message
178 .Xc
179 Displays text on the screen.
180 A new line will be printed unless
181 .Fl n
182 is specified.
183 .Pp
184 .It Ic heap
185 Displays memory usage statistics.
186 For debugging purposes only.
187 .Pp
188 .It Ic help Op topic Op subtopic
189 Shows help messages read from
190 .Pa /boot/loader.help .
191 The special topic
192 .Em index
193 will list the topics available.
194 .Pp
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
202 .Sx ERRORS ) .
203 .Pp
204 .It Ic load Xo
205 .Op Fl t Ar type
206 .Ar file Cm ...
207 .Xc
208 Loads a kernel, kernel loadable module (kld), disk image,
209 or file of opaque contents tagged as being of the type
210 .Ar 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.
214 Use the
215 .Li md_image
216 type to make the kernel create a file-backed
217 .Xr md 4
218 disk.
219 This is useful for booting from a temporary rootfs.
220 Currently, argument passing does not work for the kernel.
221 .Pp
222 .It Ic load_geli Xo
223 .Op Fl n Ar keyno
224 .Ar prov Ar file
225 .Xc
226 Loads a
227 .Xr geli 8
228 encryption keyfile for the given provider name.
229 The key index can be specified via
230 .Ar keyno
231 or will default to zero.
232 .Pp
233 .It Ic ls Xo
234 .Op Fl l
235 .Op Ar path
236 .Xc
237 Displays a listing of files in the directory
238 .Ar path ,
239 or the root directory if
240 .Ar path
241 is not specified.
242 If
243 .Fl l
244 is specified, file sizes will be shown too.
245 .Pp
246 .It Ic lsdev Op Fl v
247 Lists all of the devices from which it may be possible to load modules,
248 as well as ZFS pools.
249 If
250 .Fl v
251 is specified, more details are printed, including ZFS pool information
252 in a format that resembles
253 .Nm zpool Cm status
254 output.
255 .Pp
256 .It Ic lsmod Op Fl v
257 Displays loaded modules.
258 If
259 .Fl v
260 is specified, more details are shown.
261 .Pp
262 .It Ic lszfs Ar filesystem
263 A ZFS extended command that can be used to explore the ZFS filesystem
264 hierarchy in a pool.
265 Lists the immediate children of the
266 .Ar filesystem .
267 The filesystem hierarchy is rooted at a filesystem with the same name
268 as the pool.
269 .Pp
270 .It Ic more Ar file Op Ar
271 Display the files specified, with a pause at each
272 .Va LINES
273 displayed.
274 .Pp
275 .It Ic pnpscan Op Fl v
276 Scans for Plug-and-Play devices.
277 This is not functional at present.
278 .Pp
279 .It Ic read Xo
280 .Op Fl t Ar seconds
281 .Op Fl p Ar prompt
282 .Op Va variable
283 .Xc
284 Reads a line of input from the terminal, storing it in
285 .Va variable
286 if specified.
287 A timeout can be specified with
288 .Fl t ,
289 though it will be canceled at the first key pressed.
290 A prompt may also be displayed through the
291 .Fl p
292 flag.
293 .Pp
294 .It Ic reboot
295 Immediately reboots the system.
296 .Pp
297 .It Ic set Ar variable
298 .It Ic set Ar variable Ns = Ns Ar value
299 Set loader's environment variables.
300 .Pp
301 .It Ic show Op Va variable
302 Displays the specified variable's value, or all variables and their
303 values if
304 .Va variable
305 is not specified.
306 .Pp
307 .It Ic unload
308 Remove all modules from memory.
309 .Pp
310 .It Ic unset Va variable
311 Removes
312 .Va variable
313 from the environment.
314 .Pp
315 .It Ic \&?
316 Lists available commands.
317 .El
318 .Ss BUILTIN ENVIRONMENT VARIABLES
319 The
320 .Nm
321 has actually two different kinds of
322 .Sq environment
323 variables.
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.
329 .Pp
330 Environment variables can be set and unset through the
331 .Ic set
332 and
333 .Ic unset
334 builtins, and can have their values interactively examined through the
335 use of the
336 .Ic show
337 builtin.
338 Their values can also be accessed as described in
339 .Sx BUILTIN PARSER .
340 .Pp
341 Notice that these environment variables are not inherited by any shell
342 after the system has been booted.
343 .Pp
344 A few variables are set automatically by
345 .Nm .
346 Others can affect the behavior of either
347 .Nm
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
354 Number of seconds
355 .Ic autoboot
356 will wait before booting.
357 If this variable is not defined,
358 .Ic autoboot
359 will default to 10 seconds.
360 .Pp
361 If set to
362 .Dq Li NO ,
363 no
364 .Ic autoboot
365 will be automatically attempted after processing
366 .Pa /boot/loader.rc ,
367 though explicit
368 .Ic autoboot Ns 's
369 will be processed normally, defaulting to 10 seconds delay.
370 .Pp
371 If set to
372 .Dq Li 0 ,
373 no delay will be inserted, but user still will be able to interrupt
374 .Ic autoboot
375 process and escape into the interactive mode by pressing some key
376 on the console while kernel and
377 modules are being loaded.
378 .Pp
379 If set to
380 .Dq Li -1 ,
381 no delay will be inserted and
382 .Nm
383 will engage interactive mode only if
384 .Ic autoboot
385 has failed for some reason.
386 .It Va boot_askname
387 Instructs the kernel to prompt the user for the name of the root device
388 when the kernel is booted.
389 .It Va boot_cdrom
390 Instructs the kernel to try to mount the root file system from CD-ROM.
391 .It Va boot_ddb
392 Instructs the kernel to start in the DDB debugger, rather than
393 proceeding to initialize when booted.
394 .It Va boot_dfltroot
395 Instructs the kernel to mount the statically compiled-in root file system.
396 .It Va boot_gdb
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
401 by the
402 .Xr conscontrol 8
403 utility.
404 .It Va boot_mute
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
407 .Xr conscontrol 8
408 utility.
409 .It Va boot_pause
410 During the device probe, pause after each line is printed.
411 .It Va boot_serial
412 Force the use of a serial console even when an internal console
413 is present.
414 .It Va boot_single
415 Prevents the kernel from initiating a multi-user startup; instead,
416 a single-user mode will be entered when the kernel has finished
417 device probing.
418 .It Va boot_verbose
419 Setting this variable causes extra debugging information to be printed
420 by the kernel during the boot phase.
421 .It Va bootfile
422 List of semicolon-separated search path for bootable kernels.
423 The default is
424 .Dq Li kernel .
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
429 serial port.
430 Otherwise it is set to 9600 unless this was overridden using the
431 .Va BOOT_COMCONSOLE_SPEED
432 variable when
433 .Nm
434 was compiled.
435 Changes to the
436 .Va 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
445 .Nm .
446 Setting the
447 .Va comconsole_port
448 variable automatically set
449 .Va hw.uart.console
450 environment variable to provide a hint to kernel for location of the console.
451 Loader console is changed immediately after variable
452 .Va comconsole_port
453 is set.
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
460 .Li 0x
461 prefix to indicate a hexadecimal value.
462 The
463 .Va bar
464 member is optional and assumed to be 0x10 if omitted.
465 The bar must decode i/o space.
466 Setting the variable
467 .Va comconsole_pcidev
468 automatically sets the variable
469 .Va comconsole_port
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
474 is set.
475 .It Va console
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
480 .Xr init 8 ) .
481 .It Va currdev
482 Selects the default device.
483 Syntax for devices is odd.
484 .It Va dumpdev
485 Sets the device for kernel dumps.
486 This can be used to ensure that a device is configured before the corresponding
487 .Va dumpdev
488 directive from
489 .Xr rc.conf 5
490 has been processed, allowing kernel panics that happen during the early stages
491 of boot to be captured.
492 .It Va init_chroot
493 See
494 .Xr init 8 .
495 .It Va init_path
496 Sets the list of binaries which the kernel will try to run as the initial
497 process.
498 The first matching binary is used.
499 The default list is
500 .Dq Li /sbin/init:/sbin/oinit:/sbin/init.bak:\:/rescue/init .
501 .It Va init_script
502 See
503 .Xr init 8 .
504 .It Va init_shell
505 See
506 .Xr init 8 .
507 .It Va interpret
508 Has the value
509 .Dq Li OK
510 if the Forth's current state is interpreting.
511 .It Va LINES
512 Define the number of lines on the screen, to be used by the pager.
513 .It Va module_path
514 Sets the list of directories which will be searched for modules
515 named in a load command or implicitly required by a dependency.
516 The default value for this variable is
517 .Dq Li /boot/kernel;/boot/modules .
518 .It Va num_ide_disks
519 Sets the number of IDE disks as a workaround for some problems in
520 finding the root disk at boot.
521 This has been deprecated in favor of
522 .Va root_disk_unit .
523 .It Va prompt
524 Value of
525 .Nm Ns 's
526 prompt.
527 Defaults to
528 .Dq Li "${interpret}" .
529 If variable
530 .Va prompt
531 is unset, the default prompt is
532 .Ql > .
533 .It Va root_disk_unit
534 If the code which detects the disk unit number for the root disk is
535 confused, e.g.\& by a mix of SCSI and IDE disks, or IDE disks with
536 gaps in the sequence (e.g.\& no primary slave), the unit number can
537 be forced by setting this variable.
538 .It Va rootdev
539 By default the value of
540 .Va currdev
541 is used to set the root file system
542 when the kernel is booted.
543 This can be overridden by setting
544 .Va rootdev
545 explicitly.
546 .El
547 .Pp
548 Other variables are used to override kernel tunable parameters.
549 The following tunables are available:
550 .Bl -tag -width Va
551 .It Va efi.rt.disabled
552 Disable UEFI runtime services in the kernel, if applicable.
553 Runtime services are only available and used if the kernel is booted in a UEFI
554 environment.
555 .It Va hw.physmem
556 Limit the amount of physical memory the system will use.
557 By default the size is in bytes, but the
558 .Cm k , K , m , M , g
559 and
560 .Cm G
561 suffixes
562 are also accepted and indicate kilobytes, megabytes and gigabytes
563 respectively.
564 An invalid suffix will result in the variable being ignored by the
565 kernel.
566 .It Va hw.pci.host_start_mem , hw.acpi.host_start_mem
567 When not otherwise constrained, this limits the memory start
568 address.
569 The default is 0x80000000 and should be set to at least size of the
570 memory and not conflict with other resources.
571 Typically, only systems without PCI bridges need to set this variable
572 since PCI bridges typically constrain the memory starting address
573 (and the variable is only used when bridges do not constrain this
574 address).
575 .It Va hw.pci.enable_io_modes
576 Enable PCI resources which are left off by some BIOSes or are not
577 enabled correctly by the device driver.
578 Tunable value set to ON (1) by default, but this may cause problems
579 with some peripherals.
580 .It Va kern.maxusers
581 Set the size of a number of statically allocated system tables; see
582 .Xr tuning 7
583 for a description of how to select an appropriate value for this
584 tunable.
585 When set, this tunable replaces the value declared in the kernel
586 compile-time configuration file.
587 .It Va kern.ipc.nmbclusters
588 Set the number of mbuf clusters to be allocated.
589 The value cannot be set below the default
590 determined when the kernel was compiled.
591 .It Va kern.ipc.nsfbufs
592 Set the number of
593 .Xr sendfile 2
594 buffers to be allocated.
595 Overrides
596 .Dv NSFBUFS .
597 Not all architectures use such buffers; see
598 .Xr sendfile 2
599 for details.
600 .It Va kern.maxswzone
601 Limits the amount of KVM to be used to hold swap
602 metadata, which directly governs the
603 maximum amount of swap the system can support,
604 at the rate of approximately 200 MB of swap space
605 per 1 MB of metadata.
606 This value is specified in bytes of KVA space.
607 If no value is provided, the system allocates
608 enough memory to handle an amount of swap
609 that corresponds to eight times the amount of
610 physical memory present in the system.
611 .Pp
612 Note that swap metadata can be fragmented,
613 which means that the system can run out of
614 space before it reaches the theoretical limit.
615 Therefore, care should be taken to not configure
616 more swap than approximately half of the
617 theoretical maximum.
618 .Pp
619 Running out of space for swap metadata can leave
620 the system in an unrecoverable state.
621 Therefore, you should only change
622 this parameter if you need to greatly extend the
623 KVM reservation for other resources such as the
624 buffer cache or
625 .Va kern.ipc.nmbclusters .
626 Modifies kernel option
627 .Dv VM_SWZONE_SIZE_MAX .
628 .It Va kern.maxbcache
629 Limits the amount of KVM reserved for use by the
630 buffer cache, specified in bytes.
631 The default maximum is 200MB on i386,
632 and 400MB on amd64 and sparc64.
633 This parameter is used to
634 prevent the buffer cache from eating too much
635 KVM in large-memory machine configurations.
636 Only mess around with this parameter if you need to
637 greatly extend the KVM reservation for other resources
638 such as the swap zone or
639 .Va kern.ipc.nmbclusters .
640 Note that
641 the NBUF parameter will override this limit.
642 Modifies
643 .Dv VM_BCACHE_SIZE_MAX .
644 .It Va kern.msgbufsize
645 Sets the size of the kernel message buffer.
646 The default limit of 64KB is usually sufficient unless
647 large amounts of trace data need to be collected
648 between opportunities to examine the buffer or
649 dump it to a file.
650 Overrides kernel option
651 .Dv MSGBUF_SIZE .
652 .It Va machdep.disable_mtrrs
653 Disable the use of i686 MTRRs (x86 only).
654 .It Va net.inet.tcp.tcbhashsize
655 Overrides the compile-time set value of
656 .Dv TCBHASHSIZE
657 or the preset default of 512.
658 Must be a power of 2.
659 .It Va twiddle_divisor
660 Throttles the output of the
661 .Sq twiddle
662 I/O progress indicator displayed while loading the kernel and modules.
663 This is useful on slow serial consoles where the time spent waiting for
664 these characters to be written can add up to many seconds.
665 The default is 1 (full speed); a value of 2 spins half as fast, and so on.
666 .It Va vm.kmem_size
667 Sets the size of kernel memory (bytes).
668 This overrides the value determined when the kernel was compiled.
669 Modifies
670 .Dv VM_KMEM_SIZE .
671 .It Va vm.kmem_size_min
672 .It Va vm.kmem_size_max
673 Sets the minimum and maximum (respectively) amount of kernel memory
674 that will be automatically allocated by the kernel.
675 These override the values determined when the kernel was compiled.
676 Modifies
677 .Dv VM_KMEM_SIZE_MIN
678 and
679 .Dv VM_KMEM_SIZE_MAX .
680 .El
681 .Ss ZFS FEATURES
682 .Nm
683 supports the following format for specifying ZFS filesystems which
684 can be used wherever
685 .Xr loader 8
686 refers to a device specification:
687 .Pp
688 .Ar zfs:pool/filesystem:
689 .Pp
690 where
691 .Pa pool/filesystem
692 is a ZFS filesystem name as described in
693 .Xr zfs 8 .
694 .Pp
695 If
696 .Pa /etc/fstab
697 does not have an entry for the root filesystem and
698 .Va vfs.root.mountfrom
699 is not set, but
700 .Va currdev
701 refers to a ZFS filesystem, then
702 .Nm
703 will instruct kernel to use that filesystem as the root filesystem.
704 .Ss BUILTIN PARSER
705 When a builtin command is executed, the rest of the line is taken
706 by it as arguments, and it is processed by a special parser which
707 is not used for regular Forth commands.
708 .Pp
709 This special parser applies the following rules to the parsed text:
710 .Bl -enum
711 .It
712 All backslash characters are preprocessed.
713 .Bl -bullet
714 .It
715 \eb , \ef , \er , \en and \et are processed as in C.
716 .It
717 \es is converted to a space.
718 .It
719 \ev is converted to
720 .Tn ASCII
721 11.
722 .It
723 \ez is just skipped.
724 Useful for things like
725 .Dq \e0xf\ez\e0xf .
726 .It
727 \e0xN and \e0xNN are replaced by the hex N or NN.
728 .It
729 \eNNN is replaced by the octal NNN
730 .Tn ASCII
731 character.
732 .It
733 \e" , \e' and \e$ will escape these characters, preventing them from
734 receiving special treatment in Step 2, described below.
735 .It
736 \e\e will be replaced with a single \e .
737 .It
738 In any other occurrence, backslash will just be removed.
739 .El
740 .It
741 Every string between non-escaped quotes or double-quotes will be treated
742 as a single word for the purposes of the remaining steps.
743 .It
744 Replace any
745 .Li $VARIABLE
746 or
747 .Li ${VARIABLE}
748 with the value of the environment variable
749 .Va VARIABLE .
750 .It
751 Space-delimited arguments are passed to the called builtin command.
752 Spaces can also be escaped through the use of \e\e .
753 .El
754 .Pp
755 An exception to this parsing rule exists, and is described in
756 .Sx BUILTINS AND FORTH .
757 .Ss BUILTINS AND FORTH
758 All builtin words are state-smart, immediate words.
759 If interpreted, they behave exactly as described previously.
760 If they are compiled, though,
761 they extract their arguments from the stack instead of the command line.
762 .Pp
763 If compiled, the builtin words expect to find, at execution time, the
764 following parameters on the stack:
765 .D1 Ar addrN lenN ... addr2 len2 addr1 len1 N
766 where
767 .Ar addrX lenX
768 are strings which will compose the command line that will be parsed
769 into the builtin's arguments.
770 Internally, these strings are concatenated in from 1 to N,
771 with a space put between each one.
772 .Pp
773 If no arguments are passed, a 0
774 .Em must
775 be passed, even if the builtin accepts no arguments.
776 .Pp
777 While this behavior has benefits, it has its trade-offs.
778 If the execution token of a builtin is acquired (through
779 .Ic '
780 or
781 .Ic ['] ) ,
782 and then passed to
783 .Ic catch
784 or
785 .Ic execute ,
786 the builtin behavior will depend on the system state
787 .Bf Em
788 at the time
789 .Ic catch
790 or
791 .Ic execute
792 is processed!
793 .Ef
794 This is particularly annoying for programs that want or need to
795 handle exceptions.
796 In this case, the use of a proxy is recommended.
797 For example:
798 .Dl : (boot) boot ;
799 .Sh FICL
800 .Tn FICL
801 is a Forth interpreter written in C, in the form of a forth
802 virtual machine library that can be called by C functions and vice
803 versa.
804 .Pp
805 In
806 .Nm ,
807 each line read interactively is then fed to
808 .Tn FICL ,
809 which may call
810 .Nm
811 back to execute the builtin words.
812 The builtin
813 .Ic include
814 will also feed
815 .Tn FICL ,
816 one line at a time.
817 .Pp
818 The words available to
819 .Tn FICL
820 can be classified into four groups.
821 The
822 .Tn ANS
823 Forth standard words, extra
824 .Tn FICL
825 words, extra
826 .Fx
827 words, and the builtin commands;
828 the latter were already described.
829 The
830 .Tn ANS
831 Forth standard words are listed in the
832 .Sx STANDARDS
833 section.
834 The words falling in the two other groups are described in the
835 following subsections.
836 .Ss FICL EXTRA WORDS
837 .Bl -tag -width wid-set-super
838 .It Ic .env
839 .It Ic .ver
840 .It Ic -roll
841 .It Ic 2constant
842 .It Ic >name
843 .It Ic body>
844 .It Ic compare
845 This is the STRING word set's
846 .Ic compare .
847 .It Ic compile-only
848 .It Ic endif
849 .It Ic forget-wid
850 .It Ic parse-word
851 .It Ic sliteral
852 This is the STRING word set's
853 .Ic sliteral .
854 .It Ic wid-set-super
855 .It Ic w@
856 .It Ic w!
857 .It Ic x.
858 .It Ic empty
859 .It Ic cell-
860 .It Ic -rot
861 .El
862 .Ss FREEBSD EXTRA WORDS
863 .Bl -tag -width XXXXXXXX
864 .It Ic \&$ Pq --
865 Evaluates the remainder of the input buffer, after having printed it first.
866 .It Ic \&% Pq --
867 Evaluates the remainder of the input buffer under a
868 .Ic catch
869 exception guard.
870 .It Ic .#
871 Works like
872 .Ic "."
873 but without outputting a trailing space.
874 .It Ic fclose Pq Ar fd --
875 Closes a file.
876 .It Ic fkey Pq Ar fd -- char
877 Reads a single character from a file.
878 .It Ic fload Pq Ar fd --
879 Processes a file
880 .Em fd .
881 .It Ic fopen Pq Ar addr len mode Li -- Ar fd
882 Opens a file.
883 Returns a file descriptor, or \-1 in case of failure.
884 The
885 .Ar mode
886 parameter selects whether the file is to be opened for read access, write
887 access, or both.
888 The constants
889 .Dv O_RDONLY , O_WRONLY ,
890 and
891 .Dv O_RDWR
892 are defined in
893 .Pa /boot/support.4th ,
894 indicating read only, write only, and read-write access, respectively.
895 .It Xo
896 .Ic fread
897 .Pq Ar fd addr len -- len'
898 .Xc
899 Tries to read
900 .Em len
901 bytes from file
902 .Em fd
903 into buffer
904 .Em addr .
905 Returns the actual number of bytes read, or -1 in case of error or end of
906 file.
907 .It Ic heap? Pq -- Ar cells
908 Return the space remaining in the dictionary heap, in cells.
909 This is not related to the heap used by dynamic memory allocation words.
910 .It Ic inb Pq Ar port -- char
911 Reads a byte from a port.
912 .It Ic key Pq -- Ar char
913 Reads a single character from the console.
914 .It Ic key? Pq -- Ar flag
915 Returns
916 .Ic true
917 if there is a character available to be read from the console.
918 .It Ic ms Pq Ar u --
919 Waits
920 .Em u
921 microseconds.
922 .It Ic outb Pq Ar port char --
923 Writes a byte to a port.
924 .It Ic seconds Pq -- Ar u
925 Returns the number of seconds since midnight.
926 .It Ic tib> Pq -- Ar addr len
927 Returns the remainder of the input buffer as a string on the stack.
928 .It Ic trace! Pq Ar flag --
929 Activates or deactivates tracing.
930 Does not work with
931 .Ic catch .
932 .El
933 .Ss FREEBSD DEFINED ENVIRONMENTAL QUERIES
934 .Bl -tag -width Ds
935 .It arch-i386
936 .Ic TRUE
937 if the architecture is IA32.
938 .It FreeBSD_version
939 .Fx
940 version at compile time.
941 .It loader_version
942 .Nm
943 version.
944 .El
945 .Sh FILES
946 .Bl -tag -width /usr/share/examples/bootforth/ -compact
947 .It Pa /boot/loader
948 .Nm
949 itself.
950 .It Pa /boot/boot.4th
951 Additional
952 .Tn FICL
953 initialization.
954 .It Pa /boot/defaults/loader.conf
955 .It Pa /boot/loader.4th
956 Extra builtin-like words.
957 .It Pa /boot/loader.conf
958 .It Pa /boot/loader.conf.local
959 .Nm
960 configuration files, as described in
961 .Xr loader.conf 5 .
962 .It Pa /boot/loader.rc
963 .Nm
964 bootstrapping script.
965 .It Pa /boot/loader.help
966 Loaded by
967 .Ic help .
968 Contains the help messages.
969 .It Pa /boot/support.4th
970 .Pa loader.conf
971 processing words.
972 .It Pa /usr/share/examples/bootforth/
973 Assorted examples.
974 .El
975 .Sh EXAMPLES
976 Boot in single user mode:
977 .Pp
978 .Dl boot -s
979 .Pp
980 Load the kernel, a splash screen, and then autoboot in five seconds.
981 Notice that a kernel must be loaded before any other
982 .Ic load
983 command is attempted.
984 .Bd -literal -offset indent
985 load kernel
986 load splash_bmp
987 load -t splash_image_data /boot/chuckrulez.bmp
988 autoboot 5
989 .Ed
990 .Pp
991 Set the disk unit of the root device to 2, and then boot.
992 This would be needed in a system with two IDE disks,
993 with the second IDE disk hardwired to ada2 instead of ada1.
994 .Bd -literal -offset indent
995 set root_disk_unit=2
996 boot /boot/kernel/kernel
997 .Ed
998 .Pp
999 Set the default device used for loading a kernel from a ZFS filesystem:
1000 .Bd -literal -offset indent
1001 set currdev=zfs:tank/ROOT/knowngood:
1002 .Ed
1003 .Pp
1004 .Sh ERRORS
1005 The following values are thrown by
1006 .Nm :
1007 .Bl -tag -width XXXXX -offset indent
1008 .It 100
1009 Any type of error in the processing of a builtin.
1010 .It -1
1011 .Ic Abort
1012 executed.
1013 .It -2
1014 .Ic Abort"
1015 executed.
1016 .It -56
1017 .Ic Quit
1018 executed.
1019 .It -256
1020 Out of interpreting text.
1021 .It -257
1022 Need more text to succeed -- will finish on next run.
1023 .It -258
1024 .Ic Bye
1025 executed.
1026 .It -259
1027 Unspecified error.
1028 .El
1029 .Sh SEE ALSO
1030 .Xr libstand 3 ,
1031 .Xr loader.conf 5 ,
1032 .Xr tuning 7 ,
1033 .Xr boot 8 ,
1034 .Xr btxld 8
1035 .Sh STANDARDS
1036 For the purposes of ANS Forth compliance, loader is an
1037 .Bf Em
1038 ANS Forth System with Environmental Restrictions, Providing
1039 .Ef
1040 .Bf Li
1041 .No .( ,
1042 .No :noname ,
1043 .No ?do ,
1044 parse, pick, roll, refill, to, value, \e, false, true,
1045 .No <> ,
1046 .No 0<> ,
1047 compile\&, , erase, nip, tuck
1048 .Ef
1049 .Em and
1050 .Li marker
1051 .Bf Em
1052 from the Core Extensions word set, Providing the Exception Extensions
1053 word set, Providing the Locals Extensions word set, Providing the
1054 Memory-Allocation Extensions word set, Providing
1055 .Ef
1056 .Bf Li
1057 \&.s,
1058 bye, forget, see, words,
1059 \&[if],
1060 \&[else]
1061 .Ef
1062 .Em and
1063 .Li [then]
1064 .Bf Em
1065 from the Programming-Tools extension word set, Providing the
1066 Search-Order extensions word set.
1067 .Ef
1068 .Sh HISTORY
1069 The
1070 .Nm
1071 first appeared in
1072 .Fx 3.1 .
1073 .Sh AUTHORS
1074 .An -nosplit
1075 The
1076 .Nm
1077 was written by
1078 .An Michael Smith Aq msmith@FreeBSD.org .
1079 .Pp
1080 .Tn FICL
1081 was written by
1082 .An John Sadler Aq john_sadler@alum.mit.edu .
1083 .Sh BUGS
1084 The
1085 .Ic expect
1086 and
1087 .Ic accept
1088 words will read from the input buffer instead of the console.
1089 The latter will be fixed, but the former will not.