mirror of
https://github.com/opnsense/src.git
synced 2026-04-22 23:02:02 -04:00
ca49b3342d
Implement a subset of the multiboot specification in order to boot Xen and a FreeBSD Dom0 from the FreeBSD bootloader. This multiboot implementation is tailored to boot Xen and FreeBSD Dom0, and it will most surely fail to boot any other multiboot compilant kernel. In order to detect and boot the Xen microkernel, two new file formats are added to the bootloader, multiboot and multiboot_obj. Multiboot support must be tested before regular ELF support, since Xen is a multiboot kernel that also uses ELF. After a multiboot kernel is detected, all the other loaded kernels/modules are parsed by the multiboot_obj format. The layout of the loaded objects in memory is the following; first the Xen kernel is loaded as a 32bit ELF into memory (Xen will switch to long mode by itself), after that the FreeBSD kernel is loaded as a RAW file (Xen will parse and load it using it's internal ELF loader), and finally the metadata and the modules are loaded using the native FreeBSD way. After everything is loaded we jump into Xen's entry point using a small trampoline. The order of the multiboot modules passed to Xen is the following, the first module is the RAW FreeBSD kernel, and the second module is the metadata and the FreeBSD modules. Since Xen will relocate the memory position of the second multiboot module (the one that contains the metadata and native FreeBSD modules), we need to stash the original modulep address inside of the metadata itself in order to recalculate its position once booted. This also means the metadata must come before the loaded modules, so after loading the FreeBSD kernel a portion of memory is reserved in order to place the metadata before booting. In order to tell the loader to boot Xen and then the FreeBSD kernel the following has to be added to the /boot/loader.conf file: xen_cmdline="dom0_mem=1024M dom0_max_vcpus=2 dom0pvh=1 console=com1,vga" xen_kernel="/boot/xen" The first argument contains the command line that will be passed to the Xen kernel, while the second argument is the path to the Xen kernel itself. This can also be done manually from the loader command line, by for example typing the following set of commands: OK unload OK load /boot/xen dom0_mem=1024M dom0_max_vcpus=2 dom0pvh=1 console=com1,vga OK load kernel OK load zfs OK load if_tap OK load ... OK boot Sponsored by: Citrix Systems R&D Reviewed by: jhb Differential Revision: https://reviews.freebsd.org/D517 For the Forth bits: Submitted by: Julien Grall <julien.grall AT citrix.com>
276 lines
9.6 KiB
Forth
276 lines
9.6 KiB
Forth
\ Copyright (c) 2003 Scott Long <scottl@freebsd.org>
|
||
\ Copyright (c) 2003 Aleksander Fafula <alex@fafula.com>
|
||
\ Copyright (c) 2006-2013 Devin Teske <dteske@FreeBSD.org>
|
||
\ All rights reserved.
|
||
\
|
||
\ Redistribution and use in source and binary forms, with or without
|
||
\ modification, are permitted provided that the following conditions
|
||
\ are met:
|
||
\ 1. Redistributions of source code must retain the above copyright
|
||
\ notice, this list of conditions and the following disclaimer.
|
||
\ 2. Redistributions in binary form must reproduce the above copyright
|
||
\ notice, this list of conditions and the following disclaimer in the
|
||
\ documentation and/or other materials provided with the distribution.
|
||
\
|
||
\ THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||
\ ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||
\ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||
\ ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||
\ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||
\ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||
\ OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||
\ HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||
\ LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||
\ OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||
\ SUCH DAMAGE.
|
||
\
|
||
\ $FreeBSD$
|
||
|
||
marker task-beastie.4th
|
||
|
||
only forth definitions also support-functions
|
||
|
||
variable logoX
|
||
variable logoY
|
||
|
||
\ Initialize logo placement to defaults
|
||
46 logoX !
|
||
4 logoY !
|
||
|
||
: beastie-logo ( x y -- ) \ color BSD mascot (19 rows x 34 columns)
|
||
|
||
2dup at-xy ." [31m, ," 1+
|
||
2dup at-xy ." /( )`" 1+
|
||
2dup at-xy ." \ \___ / |" 1+
|
||
2dup at-xy ." /- [37m_[31m `-/ '" 1+
|
||
2dup at-xy ." ([37m/\/ \[31m \ /\" 1+
|
||
2dup at-xy ." [37m/ / |[31m ` \" 1+
|
||
2dup at-xy ." [34mO O [37m) [31m/ |" 1+
|
||
2dup at-xy ." [37m`-^--'[31m`< '" 1+
|
||
2dup at-xy ." (_.) _ ) /" 1+
|
||
2dup at-xy ." `.___/` /" 1+
|
||
2dup at-xy ." `-----' /" 1+
|
||
2dup at-xy ." [33m<----.[31m __ / __ \" 1+
|
||
2dup at-xy ." [33m<----|====[31mO)))[33m==[31m) \) /[33m====|" 1+
|
||
2dup at-xy ." [33m<----'[31m `--' `.__,' \" 1+
|
||
2dup at-xy ." | |" 1+
|
||
2dup at-xy ." \ / /\" 1+
|
||
2dup at-xy ." [36m______[31m( (_ / \______/" 1+
|
||
2dup at-xy ." [36m,' ,-----' |" 1+
|
||
at-xy ." `--{__________)[37m"
|
||
|
||
\ Put the cursor back at the bottom
|
||
0 25 at-xy
|
||
;
|
||
|
||
: beastiebw-logo ( x y -- ) \ B/W BSD mascot (19 rows x 34 columns)
|
||
|
||
2dup at-xy ." , ," 1+
|
||
2dup at-xy ." /( )`" 1+
|
||
2dup at-xy ." \ \___ / |" 1+
|
||
2dup at-xy ." /- _ `-/ '" 1+
|
||
2dup at-xy ." (/\/ \ \ /\" 1+
|
||
2dup at-xy ." / / | ` \" 1+
|
||
2dup at-xy ." O O ) / |" 1+
|
||
2dup at-xy ." `-^--'`< '" 1+
|
||
2dup at-xy ." (_.) _ ) /" 1+
|
||
2dup at-xy ." `.___/` /" 1+
|
||
2dup at-xy ." `-----' /" 1+
|
||
2dup at-xy ." <----. __ / __ \" 1+
|
||
2dup at-xy ." <----|====O)))==) \) /====|" 1+
|
||
2dup at-xy ." <----' `--' `.__,' \" 1+
|
||
2dup at-xy ." | |" 1+
|
||
2dup at-xy ." \ / /\" 1+
|
||
2dup at-xy ." ______( (_ / \______/" 1+
|
||
2dup at-xy ." ,' ,-----' |" 1+
|
||
at-xy ." `--{__________)"
|
||
|
||
\ Put the cursor back at the bottom
|
||
0 25 at-xy
|
||
;
|
||
|
||
: fbsdbw-logo ( x y -- ) \ "FreeBSD" logo in B/W (13 rows x 21 columns)
|
||
|
||
\ We used to use the beastie himself as our default... until the
|
||
\ eventual complaint derided his reign of the advanced boot-menu.
|
||
\
|
||
\ This is the replacement of beastie to satiate the haters of our
|
||
\ beloved helper-daemon (ready to track down and spear bugs with
|
||
\ his trident and sporty sneakers; see above).
|
||
\
|
||
\ Since we merely just changed the default and not the default-
|
||
\ location, below is an adjustment to the passed-in coordinates,
|
||
\ forever influenced by the proper location of beastie himself
|
||
\ kept as the default loader_logo_x/loader_logo_y values.
|
||
\
|
||
5 + swap 6 + swap
|
||
|
||
2dup at-xy ." ______" 1+
|
||
2dup at-xy ." | ____| __ ___ ___ " 1+
|
||
2dup at-xy ." | |__ | '__/ _ \/ _ \" 1+
|
||
2dup at-xy ." | __|| | | __/ __/" 1+
|
||
2dup at-xy ." | | | | | | |" 1+
|
||
2dup at-xy ." |_| |_| \___|\___|" 1+
|
||
2dup at-xy ." ____ _____ _____" 1+
|
||
2dup at-xy ." | _ \ / ____| __ \" 1+
|
||
2dup at-xy ." | |_) | (___ | | | |" 1+
|
||
2dup at-xy ." | _ < \___ \| | | |" 1+
|
||
2dup at-xy ." | |_) |____) | |__| |" 1+
|
||
2dup at-xy ." | | | |" 1+
|
||
at-xy ." |____/|_____/|_____/"
|
||
|
||
\ Put the cursor back at the bottom
|
||
0 25 at-xy
|
||
;
|
||
|
||
: orb-logo ( x y -- ) \ color Orb mascot (15 rows x 30 columns)
|
||
|
||
3 + \ beastie adjustment (see `fbsdbw-logo' comments above)
|
||
|
||
2dup at-xy ." [31m``` [31;1m`[31m" 1+
|
||
2dup at-xy ." s` `.....---...[31;1m....--.``` -/[31m" 1+
|
||
2dup at-xy ." +o .--` [31;1m/y:` +.[31m" 1+
|
||
2dup at-xy ." yo`:. [31;1m:o `+-[31m" 1+
|
||
2dup at-xy ." y/ [31;1m-/` -o/[31m" 1+
|
||
2dup at-xy ." .- [31;1m::/sy+:.[31m" 1+
|
||
2dup at-xy ." / [31;1m`-- /[31m" 1+
|
||
2dup at-xy ." `: [31;1m:`[31m" 1+
|
||
2dup at-xy ." `: [31;1m:`[31m" 1+
|
||
2dup at-xy ." / [31;1m/[31m" 1+
|
||
2dup at-xy ." .- [31;1m-.[31m" 1+
|
||
2dup at-xy ." -- [31;1m-.[31m" 1+
|
||
2dup at-xy ." `:` [31;1m`:`" 1+
|
||
2dup at-xy ." [31;1m.-- `--." 1+
|
||
at-xy ." .---.....----.[37m"
|
||
|
||
\ Put the cursor back at the bottom
|
||
0 25 at-xy
|
||
;
|
||
|
||
: orbbw-logo ( x y -- ) \ B/W Orb mascot (15 rows x 32 columns)
|
||
|
||
3 + \ beastie adjustment (see `fbsdbw-logo' comments above)
|
||
|
||
2dup at-xy ." ``` `" 1+
|
||
2dup at-xy ." s` `.....---.......--.``` -/" 1+
|
||
2dup at-xy ." +o .--` /y:` +." 1+
|
||
2dup at-xy ." yo`:. :o `+-" 1+
|
||
2dup at-xy ." y/ -/` -o/" 1+
|
||
2dup at-xy ." .- ::/sy+:." 1+
|
||
2dup at-xy ." / `-- /" 1+
|
||
2dup at-xy ." `: :`" 1+
|
||
2dup at-xy ." `: :`" 1+
|
||
2dup at-xy ." / /" 1+
|
||
2dup at-xy ." .- -." 1+
|
||
2dup at-xy ." -- -." 1+
|
||
2dup at-xy ." `:` `:`" 1+
|
||
2dup at-xy ." .-- `--." 1+
|
||
at-xy ." .---.....----."
|
||
|
||
\ Put the cursor back at the bottom
|
||
0 25 at-xy
|
||
;
|
||
|
||
\ This function draws any number of beastie logos at (loader_logo_x,
|
||
\ loader_logo_y) if defined, else (46,4) (to the right of the menu). To choose
|
||
\ your beastie, set the variable `loader_logo' to the respective logo name.
|
||
\
|
||
\ Currently available:
|
||
\
|
||
\ NAME DESCRIPTION
|
||
\ beastie Color ``Helper Daemon'' mascot (19 rows x 34 columns)
|
||
\ beastiebw B/W ``Helper Daemon'' mascot (19 rows x 34 columns)
|
||
\ fbsdbw "FreeBSD" logo in B/W (13 rows x 21 columns)
|
||
\ orb Color ``Orb'' mascot (15 rows x 30 columns) (2nd default)
|
||
\ orbbw B/W ``Orb'' mascot (15 rows x 32 columns)
|
||
\ tribute Color ``Tribute'' (must fit 19 rows x 34 columns) (default)
|
||
\ tributebw B/W ``Tribute'' (must fit 19 rows x 34 columns)
|
||
\
|
||
\ NOTE: Setting `loader_logo' to an undefined value (such as "none") will
|
||
\ prevent beastie from being drawn.
|
||
\
|
||
: draw-beastie ( -- ) \ at (loader_logo_x,loader_logo_y), else (46,4)
|
||
|
||
s" loader_logo_x" getenv dup -1 <> if
|
||
?number 1 = if logoX ! then
|
||
else
|
||
drop
|
||
then
|
||
s" loader_logo_y" getenv dup -1 <> if
|
||
?number 1 = if logoY ! then
|
||
else
|
||
drop
|
||
then
|
||
|
||
s" loader_logo" getenv dup -1 <> if
|
||
dup 5 + allocate if ENOMEM throw then
|
||
0 2swap strcat s" -logo" strcat
|
||
over -rot ( a-addr/u -- a-addr a-addr/u )
|
||
sfind ( a-addr a-addr/u -- a-addr xt bool )
|
||
rot ( a-addr xt bool -- xt bool a-addr )
|
||
free ( xt bool a-addr -- xt bool ior )
|
||
if EFREE throw then
|
||
else
|
||
0 ( cruft -- cruft bool ) \ load the default below
|
||
then
|
||
0= if
|
||
drop ( cruft -- )
|
||
loader_color? if
|
||
['] orb-logo
|
||
else
|
||
['] orbbw-logo
|
||
then
|
||
then
|
||
logoX @ logoY @ rot execute
|
||
;
|
||
|
||
: clear-beastie ( -- ) \ clears beastie from the screen
|
||
logoX @ logoY @
|
||
2dup at-xy 34 spaces 1+ 2dup at-xy 34 spaces 1+
|
||
2dup at-xy 34 spaces 1+ 2dup at-xy 34 spaces 1+
|
||
2dup at-xy 34 spaces 1+ 2dup at-xy 34 spaces 1+
|
||
2dup at-xy 34 spaces 1+ 2dup at-xy 34 spaces 1+
|
||
2dup at-xy 34 spaces 1+ 2dup at-xy 34 spaces 1+
|
||
2dup at-xy 34 spaces 1+ 2dup at-xy 34 spaces 1+
|
||
2dup at-xy 34 spaces 1+ 2dup at-xy 34 spaces 1+
|
||
2dup at-xy 34 spaces 1+ 2dup at-xy 34 spaces 1+
|
||
2dup at-xy 34 spaces 1+ 2dup at-xy 34 spaces 1+
|
||
2dup at-xy 34 spaces 2drop
|
||
|
||
\ Put the cursor back at the bottom
|
||
0 25 at-xy
|
||
;
|
||
|
||
: beastie-start ( -- ) \ starts the menu
|
||
s" console" getenv dup -1 <> if
|
||
s" efi" 2swap contains? if
|
||
s" set beastie_disable=YES" evaluate
|
||
then
|
||
else drop then
|
||
s" beastie_disable" getenv
|
||
dup -1 <> if
|
||
s" YES" compare-insensitive 0= if
|
||
any_conf_read? if
|
||
load_xen_throw
|
||
load_kernel
|
||
load_modules
|
||
then
|
||
exit \ to autoboot (default)
|
||
then
|
||
else
|
||
drop
|
||
then
|
||
|
||
s" loader_delay" getenv
|
||
-1 = if
|
||
s" include /boot/menu.rc" evaluate
|
||
else
|
||
drop
|
||
." Loading Menu (Ctrl-C to Abort)" cr
|
||
s" set delay_command='include /boot/menu.rc'" evaluate
|
||
s" set delay_showdots" evaluate
|
||
delay_execute
|
||
then
|
||
;
|
||
|
||
only forth also
|