1 \ Copyright (c) 1999 Daniel C. Sobral <dcs@FreeBSD.org>
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
27 \ Loader.rc support functions:
29 \ initialize ( addr len -- ) as above, plus load_conf_files
30 \ load_conf ( addr len -- ) load conf file given
31 \ include_conf_files ( -- ) load all conf files in load_conf_files
32 \ print_syntax_error ( -- ) print line and marker of where a syntax
34 \ print_line ( -- ) print last line processed
35 \ load_kernel ( -- ) load kernel
36 \ load_modules ( -- ) load modules flagged
38 \ Exported structures:
40 \ string counted string structure
41 \ cell .addr string address
42 \ cell .len string length
43 \ module module loading information structure
44 \ cell module.flag should we load it?
45 \ string module.name module's name
46 \ string module.loadname name to be used in loading the module
47 \ string module.type module's type
48 \ string module.args flags to be passed during load
49 \ string module.beforeload command to be executed before load
50 \ string module.afterload command to be executed after load
51 \ string module.loaderror command to be executed if load fails
52 \ cell module.next list chain
54 \ Exported global variables;
56 \ string conf_files configuration files to be loaded
57 \ cell modules_options pointer to first module information
58 \ value verbose? indicates if user wants a verbose loading
59 \ value any_conf_read? indicates if a conf file was successfully read
61 \ Other exported words:
62 \ note, strlen is internal
63 \ strdup ( addr len -- addr' len) similar to strdup(3)
64 \ strcat ( addr len addr' len' -- addr len+len' ) similar to strcat(3)
65 \ s' ( | string' -- addr len | ) similar to s"
66 \ rudimentary structure support
73 4 constant ESETERROR \ error setting environment variable
74 5 constant EREAD \ error reading
76 7 constant EEXEC \ XXX never catched
77 8 constant EBEFORELOAD
90 \ Crude structure support
93 create here 0 , ['] drop , 0
94 does> create here swap dup @ allot cell+ @ execute
96 : member: create dup , over , + does> cell+ @ + ;
98 : constructor! >body cell+ ! ;
99 : constructor: over :noname ;
100 : ;constructor postpone ; swap cell+ ! ; immediate
101 : sizeof ' >body @ state @ if postpone literal then ; immediate
102 : offsetof ' >body cell+ @ state @ if postpone literal then ; immediate
103 : ptr 1 cells member: ;
104 : int 1 cells member: ;
118 \ Module options linked list
122 sizeof string member: module.name
123 sizeof string member: module.loadname
124 sizeof string member: module.type
125 sizeof string member: module.args
126 sizeof string member: module.beforeload
127 sizeof string member: module.afterload
128 sizeof string member: module.loaderror
132 \ Internal loader structures (preloaded_file, kernel_module, file_metadata)
133 \ must be in sync with the C struct in stand/common/bootstrap.h
134 structure: preloaded_file
138 ptr pf.metadata \ file_metadata
142 ptr pf.modules \ kernel_module
143 ptr pf.next \ preloaded_file
146 structure: kernel_module
149 ptr km.fp \ preloaded_file
150 ptr km.next \ kernel_module
153 structure: file_metadata
155 2 member: md.type \ this is not ANS Forth compatible (XXX)
156 ptr md.next \ file_metadata
157 0 member: md.data \ variable size
165 string nextboot_conf_file
166 create module_options sizeof module.next allot 0 module_options !
167 create last_module_option sizeof module.next allot 0 last_module_option !
171 \ Support string functions
172 : strdup { addr len -- addr' len' }
173 len allocate if ENOMEM throw then
174 addr over len move len
177 : strcat { addr len addr' len' -- addr len+len' }
178 addr' addr len + len' move
182 : strchr { addr len c -- addr' len' }
186 addr c@ c = if addr len exit then
193 : s' \ same as s", allows " in the string
195 state @ if postpone sliteral then
198 : 2>r postpone >r postpone >r ; immediate
199 : 2r> postpone r> postpone r> ; immediate
200 : 2r@ postpone 2r> postpone 2dup postpone 2>r ; immediate
202 : getenv? getenv -1 = if false else drop true then ;
204 \ determine if a word appears in a string, case-insensitive
205 : contains? ( addr1 len1 addr2 len2 -- 0 | -1 )
206 2 pick 0= if 2drop 2drop true exit then
207 dup 0= if 2drop 2drop false exit then
210 swap dup c@ dup 32 = over 9 = or over 10 = or
211 over 13 = or over 44 = or swap drop
212 while 1+ swap 1- repeat
213 swap 2 pick 1- over <
215 2over 2over drop over compare-insensitive 0= if
216 2 pick over = if 2drop 2drop true exit then
217 2 pick tuck - -rot + swap over c@ dup 32 =
218 over 9 = or over 10 = or over 13 = or over 44 = or
219 swap drop if 2drop 2drop true exit then
221 swap dup c@ dup 32 = over 9 = or over 10 = or
222 over 13 = or over 44 = or swap drop
223 if false else true then 2 pick 0> and
224 while 1+ swap 1- repeat
230 : boot_serial? ( -- 0 | -1 )
231 s" console" getenv dup -1 <> if
232 s" comconsole" 2swap contains?
234 s" boot_serial" getenv dup -1 <> if
237 or \ console contains comconsole ( or ) boot_serial
238 s" boot_multicons" getenv dup -1 <> if
241 or \ previous boolean ( or ) boot_multicons
244 \ Private definitions
246 vocabulary support-functions
247 only forth also support-functions definitions
249 \ Some control characters constants
259 80 constant read_buffer_size
263 : load_module_suffix s" _load" ;
264 : module_loadname_suffix s" _name" ;
265 : module_type_suffix s" _type" ;
266 : module_args_suffix s" _flags" ;
267 : module_beforeload_suffix s" _before" ;
268 : module_afterload_suffix s" _after" ;
269 : module_loaderror_suffix s" _error" ;
276 \ Assorted support functions
278 : free-memory free if EFREE throw then ;
280 : strget { var -- addr len } var .addr @ var .len @ ;
282 \ assign addr len to variable.
283 : strset { addr len var -- } addr var .addr ! len var .len ! ;
285 \ free memory and reset fields
286 : strfree { var -- } var .addr @ ?dup if free-memory 0 0 var strset then ;
288 \ free old content, make a copy of the string and assign to variable
289 : string= { addr len var -- } var strfree addr len strdup var strset ;
291 : strtype ( str -- ) strget type ;
293 \ assign a reference to what is on the stack
294 : strref { addr len var -- addr len }
295 addr var .addr ! len var .len ! addr len
299 : unquote ( addr len -- addr len )
300 over c@ [char] " = if 2 chars - swap char+ swap then
303 \ Assignment data temporary storage
308 \ Line by line file reading functions
317 vocabulary line-reading
318 also line-reading definitions
320 \ File data temporary storage
323 0 value read_buffer_ptr
325 \ File's line reading function
327 get-current ( -- wid ) previous definitions
333 >search ( wid -- ) definitions
337 read_buffer .len @ read_buffer_ptr >
339 read_buffer .addr @ read_buffer_ptr + c@ lf = if
340 read_buffer_ptr char+ to read_buffer_ptr
347 : scan_buffer ( -- addr len )
350 read_buffer .len @ r@ >
352 read_buffer .addr @ r@ + c@ lf = if
353 read_buffer .addr @ read_buffer_ptr + ( -- addr )
354 r@ read_buffer_ptr - ( -- len )
355 r> to read_buffer_ptr
360 read_buffer .addr @ read_buffer_ptr + ( -- addr )
361 r@ read_buffer_ptr - ( -- len )
362 r> to read_buffer_ptr
365 : line_buffer_resize ( len -- len )
368 line_buffer .len @ if
370 line_buffer .len @ r@ +
371 resize if ENOMEM throw then
373 r@ allocate if ENOMEM throw then
379 : append_to_line_buffer ( addr len -- )
380 dup 0= if 2drop exit then
388 scan_buffer ( -- addr len )
389 line_buffer_resize ( len -- len )
390 append_to_line_buffer ( addr len -- )
394 read_buffer .len @ read_buffer_ptr =
400 read_buffer .addr @ 0= if
401 read_buffer_size allocate if ENOMEM throw then
404 fd @ read_buffer .addr @ read_buffer_size fread
405 dup -1 = if EREAD throw then
406 dup 0= if true to end_of_file? then
410 get-current ( -- wid ) previous definitions >search ( wid -- )
427 only forth also support-functions definitions
429 \ Conf file line parser:
430 \ <line> ::= <spaces><name><spaces>'='<spaces><value><spaces>[<comment>] |
431 \ <spaces>[<comment>]
432 \ <name> ::= <letter>{<letter>|<digit>|'_'}
433 \ <value> ::= '"'{<character_set>|'\'<anything>}'"' | <name>
434 \ <character_set> ::= ASCII 32 to 126, except '\' and '"'
435 \ <comment> ::= '#'{<anything>}
443 vocabulary file-processing
444 also file-processing definitions
452 also parser definitions
454 0 value parsing_function
457 : end_of_line? line_pointer end_of_line = ;
459 \ classifiers for various character classes in the input line
478 : quote? line_pointer c@ [char] " = ;
480 : assignment_sign? line_pointer c@ [char] = = ;
482 : comment? line_pointer c@ [char] # = ;
484 : space? line_pointer c@ bl = line_pointer c@ tab = or ;
486 : backslash? line_pointer c@ [char] \ = ;
488 : underscore? line_pointer c@ [char] _ = ;
490 : dot? line_pointer c@ [char] . = ;
492 \ manipulation of input line
493 : skip_character line_pointer char+ to line_pointer ;
495 : skip_to_end_of_line end_of_line to line_pointer ;
499 end_of_line? if 0 else space? then
505 : parse_name ( -- addr len )
508 end_of_line? if 0 else letter? digit? underscore? dot? or or or then
516 : remove_backslashes { addr len | addr' len' -- addr' len' }
517 len allocate if ENOMEM throw then
521 addr c@ [char] \ <> if
522 addr c@ addr' len' + c!
532 : parse_quote ( -- addr len )
535 end_of_line? if ESYNTAX throw then
541 end_of_line? if ESYNTAX throw then
544 end_of_line? if ESYNTAX throw then
552 parse_name ( -- addr len )
558 parse_quote ( -- addr len )
560 parse_name ( -- addr len )
571 comment? if ['] comment to parsing_function exit then
572 end_of_line? 0= if ESYNTAX throw then
577 ['] white_space_4 to parsing_function
582 letter? digit? quote? or or if
583 ['] variable_value to parsing_function exit
590 ['] white_space_3 to parsing_function
595 assignment_sign? if ['] assignment_sign to parsing_function exit then
601 ['] white_space_2 to parsing_function
606 letter? if ['] variable_name to parsing_function exit then
607 comment? if ['] comment to parsing_function exit then
608 end_of_line? 0= if ESYNTAX throw then
611 get-current ( -- wid ) previous definitions >search ( wid -- )
614 line_buffer strget + to end_of_line
615 line_buffer .addr @ to line_pointer
616 ['] white_space_1 to parsing_function
620 parsing_function execute
622 parsing_function ['] comment =
623 parsing_function ['] white_space_1 =
624 parsing_function ['] white_space_4 =
625 or or 0= if ESYNTAX throw then
628 only forth also support-functions also file-processing definitions
632 : assignment_type? ( addr len -- flag )
637 : suffix_type? ( addr len -- flag )
638 name_buffer .len @ over <= if 2drop false exit then
639 name_buffer .len @ over - name_buffer .addr @ +
643 : loader_conf_files? s" loader_conf_files" assignment_type? ;
645 : nextboot_flag? s" nextboot_enable" assignment_type? ;
647 : nextboot_conf? s" nextboot_conf" assignment_type? ;
649 : verbose_flag? s" verbose_loading" assignment_type? ;
651 : execute? s" exec" assignment_type? ;
653 : module_load? load_module_suffix suffix_type? ;
655 : module_loadname? module_loadname_suffix suffix_type? ;
657 : module_type? module_type_suffix suffix_type? ;
659 : module_args? module_args_suffix suffix_type? ;
661 : module_beforeload? module_beforeload_suffix suffix_type? ;
663 : module_afterload? module_afterload_suffix suffix_type? ;
665 : module_loaderror? module_loaderror_suffix suffix_type? ;
667 \ build a 'set' statement and execute it
668 : set_environment_variable
669 name_buffer .len @ value_buffer .len @ + 5 chars + \ size of result string
670 allocate if ENOMEM throw then
671 dup 0 \ start with an empty string and append the pieces
673 name_buffer strget strcat
675 value_buffer strget strcat
676 ['] evaluate catch if
685 set_environment_variable
686 s" loader_conf_files" getenv conf_files string=
690 value_buffer strget unquote nextboot_conf_file string=
693 : append_to_module_options_list ( addr -- )
694 module_options @ 0= if
698 dup last_module_option @ module.next !
703 : set_module_name { addr -- } \ check leaks
704 name_buffer strget addr module.name string=
708 value_buffer strget \ XXX could use unquote
709 2dup s' "YES"' compare >r
710 2dup s' "yes"' compare >r
711 2dup s" YES" compare >r
712 s" yes" compare r> r> r> and and and 0=
715 : find_module_option ( -- addr | 0 ) \ return ptr to entry matching name_buffer
720 dup module.name strget
722 compare 0= if exit then
727 : new_module_option ( -- addr )
728 sizeof module allocate if ENOMEM throw then
729 dup sizeof module erase
730 dup append_to_module_options_list
734 : get_module_option ( -- addr )
736 ?dup 0= if new_module_option then
740 name_buffer .len @ load_module_suffix nip - name_buffer .len !
741 yes_value? get_module_option module.flag !
745 name_buffer .len @ module_args_suffix nip - name_buffer .len !
746 value_buffer strget unquote
747 get_module_option module.args string=
750 : set_module_loadname
751 name_buffer .len @ module_loadname_suffix nip - name_buffer .len !
752 value_buffer strget unquote
753 get_module_option module.loadname string=
757 name_buffer .len @ module_type_suffix nip - name_buffer .len !
758 value_buffer strget unquote
759 get_module_option module.type string=
762 : set_module_beforeload
763 name_buffer .len @ module_beforeload_suffix nip - name_buffer .len !
764 value_buffer strget unquote
765 get_module_option module.beforeload string=
768 : set_module_afterload
769 name_buffer .len @ module_afterload_suffix nip - name_buffer .len !
770 value_buffer strget unquote
771 get_module_option module.afterload string=
774 : set_module_loaderror
775 name_buffer .len @ module_loaderror_suffix nip - name_buffer .len !
776 value_buffer strget unquote
777 get_module_option module.loaderror string=
781 yes_value? to nextboot?
785 yes_value? to verbose?
789 value_buffer strget unquote
790 ['] evaluate catch if EEXEC throw then
794 name_buffer .len @ 0= if exit then
795 loader_conf_files? if set_conf_files exit then
796 nextboot_flag? if set_nextboot_flag exit then
797 nextboot_conf? if set_nextboot_conf exit then
798 verbose_flag? if set_verbose exit then
799 execute? if execute_command exit then
800 module_load? if set_module_flag exit then
801 module_loadname? if set_module_loadname exit then
802 module_type? if set_module_type exit then
803 module_args? if set_module_args exit then
804 module_beforeload? if set_module_beforeload exit then
805 module_afterload? if set_module_afterload exit then
806 module_loaderror? if set_module_loaderror exit then
807 set_environment_variable
812 \ Free some pointers if needed. The code then tests for errors
813 \ in freeing, and throws an exception if needed. If a pointer is
814 \ not allocated, it's value (0) is used as flag.
821 \ Higher level file processing
823 get-current ( -- wid ) previous definitions >search ( wid -- )
832 ['] process_assignment catch
833 ['] free_buffers catch
838 : peek_file ( addr len -- )
842 fd @ -1 = if EOPEN throw then
846 ['] process_assignment catch
847 ['] free_buffers catch
852 only forth also support-functions definitions
854 \ Interface to loading conf files
856 : load_conf ( addr len -- )
860 fd @ -1 = if EOPEN throw then
861 ['] process_conf catch
866 : print_line line_buffer strtype cr ;
869 line_buffer strtype cr
881 \ Debugging support functions
883 only forth definitions also support-functions
886 ['] load_conf catch dup .
887 ESYNTAX = if cr print_syntax_error then
890 \ find a module name, leave addr on the stack (0 if not found)
891 : find-module ( <module> -- ptr | 0 )
892 bl parse ( addr len )
893 module_options @ >r ( store current pointer )
897 2dup ( addr len addr len )
898 r@ module.name strget
899 compare 0= if drop drop r> exit then ( found it )
902 type ." was not found" cr r>
905 : show-nonempty ( addr len mod -- )
906 strget dup verbose? or if
912 : show-one-module { addr -- addr }
913 ." Name: " addr module.name strtype cr
914 s" Path: " addr module.loadname show-nonempty
915 s" Type: " addr module.type show-nonempty
916 s" Flags: " addr module.args show-nonempty
917 s" Before load: " addr module.beforeload show-nonempty
918 s" After load: " addr module.afterload show-nonempty
919 s" Error: " addr module.loaderror show-nonempty
920 ." Status: " addr module.flag @ if ." Load" else ." Don't load" then cr
925 : show-module-options
935 : free-one-module { addr -- addr }
936 addr module.name strfree
937 addr module.loadname strfree
938 addr module.type strfree
939 addr module.args strfree
940 addr module.beforeload strfree
941 addr module.afterload strfree
942 addr module.loaderror strfree
946 : free-module-options
956 0 last_module_option !
959 only forth also support-functions definitions
961 \ Variables used for processing multiple conf files
963 string current_file_name_ref \ used to print the file name
965 \ Indicates if any conf file was successfully read
967 0 value any_conf_read?
969 \ loader_conf_files processing support functions
971 : get_conf_files ( -- addr len ) \ put addr/len on stack, reset var
972 conf_files strget 0 0 conf_files strset
975 : skip_leading_spaces { addr len pos -- addr len pos' }
977 pos len = if 0 else addr pos + c@ bl = then
984 \ return the file name at pos, or free the string if nothing left
985 : get_file_name { addr len pos -- addr len pos' addr' len' || 0 }
987 addr free abort" Fatal error freeing memory"
992 \ stay in the loop until have chars and they are not blank
993 pos len = if 0 else addr pos + c@ bl <> then
997 addr len pos addr r@ + pos r> -
1000 : get_next_file ( addr len ptr -- addr len ptr' addr' len' | 0 )
1005 : print_current_file
1006 current_file_name_ref strtype
1009 : process_conf_errors
1010 dup 0= if true to any_conf_read? drop exit then
1013 ." Warning: syntax error on file " print_current_file cr
1014 print_syntax_error drop exit
1017 ." Warning: bad definition on file " print_current_file cr
1018 print_line drop exit
1021 ." Warning: error reading file " print_current_file cr drop exit
1024 verbose? if ." Warning: unable to open file " print_current_file cr then
1027 dup EFREE = abort" Fatal error freeing memory"
1028 dup ENOMEM = abort" Out of memory"
1029 throw \ Unknown error -- pass ahead
1032 \ Process loader_conf_files recursively
1033 \ Interface to loader_conf_files processing
1035 : include_conf_files
1036 get_conf_files 0 ( addr len offset )
1038 get_next_file ?dup ( addr len 1 | 0 )
1040 current_file_name_ref strref
1043 conf_files .addr @ if recurse then
1047 : get_nextboot_conf_file ( -- addr len )
1048 nextboot_conf_file strget
1051 : rewrite_nextboot_file ( -- )
1052 get_nextboot_conf_file
1054 fd @ -1 = if EOPEN throw then
1055 fd @ s' nextboot_enable="NO" ' fwrite ( fd buf len -- nwritten ) drop
1059 : include_nextboot_file ( -- )
1060 get_nextboot_conf_file
1061 ['] peek_file catch if 2drop then
1063 get_nextboot_conf_file
1064 current_file_name_ref strref
1067 ['] rewrite_nextboot_file catch if 2drop then
1071 \ Module loading functions
1073 : load_parameters { addr -- addr addrN lenN ... addr1 len1 N }
1075 addr module.args strget
1076 addr module.loadname .len @ if
1077 addr module.loadname strget
1079 addr module.name strget
1081 addr module.type .len @ if
1082 addr module.type strget
1084 4 ( -t type name flags )
1090 : before_load ( addr -- addr )
1091 dup module.beforeload .len @ if
1092 dup module.beforeload strget
1093 ['] evaluate catch if EBEFORELOAD throw then
1097 : after_load ( addr -- addr )
1098 dup module.afterload .len @ if
1099 dup module.afterload strget
1100 ['] evaluate catch if EAFTERLOAD throw then
1104 : load_error ( addr -- addr )
1105 dup module.loaderror .len @ if
1106 dup module.loaderror strget
1107 evaluate \ This we do not intercept so it can throw errors
1111 : pre_load_message ( addr -- addr )
1113 dup module.name strtype
1118 : load_error_message verbose? if ." failed!" cr then ;
1120 : load_successful_message verbose? if ." ok" cr then ;
1123 load_parameters load
1126 : process_module ( addr -- addr )
1130 ['] load_module catch if
1131 dup module.loaderror .len @ if
1132 load_error \ Command should return a flag!
1134 load_error_message true \ Do not retry
1138 load_successful_message true \ Successful, do not retry
1143 : process_module_errors ( addr ior -- )
1144 dup EBEFORELOAD = if
1147 dup module.name strtype
1148 dup module.loadname .len @ if
1149 ." (" dup module.loadname strtype ." )"
1152 ." Error executing "
1153 dup module.beforeload strtype cr \ XXX there was a typo here
1160 dup module.name .addr @ over module.name .len @ type
1161 dup module.loadname .len @ if
1162 ." (" dup module.loadname strtype ." )"
1165 ." Error executing "
1166 dup module.afterload strtype cr
1170 throw \ Don't know what it is all about -- pass ahead
1173 \ Module loading interface
1175 \ scan the list of modules, load enabled ones.
1176 : load_modules ( -- ) ( throws: abort & user-defined )
1177 module_options @ ( list_head )
1181 dup module.flag @ if
1182 ['] process_module catch
1183 process_module_errors
1189 \ h00h00 magic used to try loading either a kernel with a given name,
1190 \ or a kernel with the default name in a directory of a given name
1193 : bootpath s" /boot/" ;
1194 : modulepath s" module_path" ;
1196 \ Functions used to save and restore module_path's value.
1197 : saveenv ( addr len | -1 -- addr' len | 0 -1 )
1198 dup -1 = if 0 swap exit then
1201 : freeenv ( addr len | 0 -1 )
1202 -1 = if drop else free abort" Freeing error" then
1204 : restoreenv ( addr len | 0 -1 -- )
1205 dup -1 = if ( it wasn't set )
1211 r> free abort" Freeing error"
1215 : clip_args \ Drop second string if only one argument is passed
1226 \ Parse filename from a semicolon-separated list
1228 \ replacement, not working yet
1229 : newparse-; { addr len | a1 -- a' len-x addr x }
1230 addr len [char] ; strchr dup if ( a1 len1 )
1231 swap to a1 ( store address )
1232 1 - a1 @ 1 + swap ( remove match )
1239 : parse-; ( addr len -- addr' len-x addr x )
1240 over 0 2swap ( addr 0 addr len )
1242 dup 0 <> ( addr 0 addr len )
1244 over c@ [char] ; <> ( addr 0 addr len flag )
1255 \ Try loading one of multiple kernels specified
1257 : try_multiple_kernels ( addr len addr' len' args -- flag )
1263 s" DEBUG" getenv? if
1264 s" echo Module_path: ${module_path}" evaluate
1265 ." Kernel : " >r 2dup type r> cr
1266 dup 2 = if ." Flags : " >r 2over type r> cr then
1281 \ Try to load a kernel; the kernel name is taken from one of
1282 \ the following lists, as ordered:
1284 \ 1. The "bootfile" environment variable
1285 \ 2. The "kernel" environment variable
1287 \ Flags are passed, if available. If not, dummy values must be given.
1289 \ The kernel gets loaded from the current module_path.
1291 : load_a_kernel ( flags len 1 | x x 0 -- flag )
1297 \ Check if a default kernel name exists at all, exits if not
1298 s" bootfile" getenv dup -1 <> if
1300 flags kernel args 1+ try_multiple_kernels
1305 s" kernel" getenv dup -1 <> if
1312 \ Try all default kernel names
1313 flags kernel args 1+ try_multiple_kernels
1316 \ Try to load a kernel; the kernel name is taken from one of
1317 \ the following lists, as ordered:
1319 \ 1. The "bootfile" environment variable
1320 \ 2. The "kernel" environment variable
1322 \ Flags are passed, if provided.
1324 \ The kernel will be loaded from a directory computed from the
1325 \ path given. Two directories will be tried in the following order:
1330 \ The module_path variable is overridden if load is successful, by
1331 \ prepending the successful path.
1333 : load_from_directory ( path len 1 | flags len' path len 2 -- flag )
1336 args 1 = if 0 0 then
1338 0 0 2local oldmodulepath \ like a string
1339 0 0 2local newmodulepath \ like a string
1342 \ Set the environment variable module_path, and try loading
1344 modulepath getenv saveenv to oldmodulepath
1346 \ Try prepending /boot/ first
1347 bootpath nip path nip + \ total length
1348 oldmodulepath nip dup -1 = if
1351 1+ + \ add oldpath -- XXX why the 1+ ?
1353 allocate if ( out of memory ) 1 exit then \ XXX throw ?
1358 2dup to newmodulepath
1361 \ Try all default kernel names
1362 flags args 1- load_a_kernel
1364 oldmodulepath nip -1 <> if
1365 newmodulepath s" ;" strcat
1366 oldmodulepath strcat
1368 newmodulepath drop free-memory
1369 oldmodulepath drop free-memory
1374 \ Well, try without the prepended /boot/
1375 path newmodulepath drop swap move
1376 newmodulepath drop path nip
1377 2dup to newmodulepath
1380 \ Try all default kernel names
1381 flags args 1- load_a_kernel
1382 if ( failed once more )
1383 oldmodulepath restoreenv
1384 newmodulepath drop free-memory
1387 oldmodulepath nip -1 <> if
1388 newmodulepath s" ;" strcat
1389 oldmodulepath strcat
1391 newmodulepath drop free-memory
1392 oldmodulepath drop free-memory
1398 \ Try to load a kernel; the kernel name is taken from one of
1399 \ the following lists, as ordered:
1401 \ 1. The "bootfile" environment variable
1402 \ 2. The "kernel" environment variable
1403 \ 3. The "path" argument
1405 \ Flags are passed, if provided.
1407 \ The kernel will be loaded from a directory computed from the
1408 \ path given. Two directories will be tried in the following order:
1413 \ Unless "path" is meant to be kernel name itself. In that case, it
1414 \ will first be tried as a full path, and, next, search on the
1415 \ directories pointed by module_path.
1417 \ The module_path variable is overridden if load is successful, by
1418 \ prepending the successful path.
1420 : load_directory_or_file ( path len 1 | flags len' path len 2 -- flag )
1423 args 1 = if 0 0 then
1427 \ First, assume path is an absolute path to a directory
1428 flags path args clip_args load_from_directory
1429 dup 0= if exit else drop then
1431 \ Next, assume path points to the kernel
1432 flags path args try_multiple_kernels
1435 : initialize ( addr len -- )
1436 strdup conf_files strset
1439 : kernel_options ( -- addr len 1 | 0 )
1440 s" kernel_options" getenv
1441 dup -1 = if drop 0 else 1 then
1444 : standard_kernel_search ( flags 1 | 0 -- flag )
1449 dup -1 = if 0 swap then
1453 path nip -1 = if ( there isn't a "kernel" environment variable )
1454 flags args load_a_kernel
1456 flags path args 1+ clip_args load_directory_or_file
1460 : load_kernel ( -- ) ( throws: abort )
1461 kernel_options standard_kernel_search
1462 abort" Unable to load a kernel!"
1465 : load_xen ( -- flag )
1466 s" xen_kernel" getenv dup -1 <> if
1467 1 1 load ( c-addr/u flag N -- flag )
1474 : load_xen_throw ( -- ) ( throws: abort )
1476 abort" Unable to load Xen!"
1479 : set_defaultoptions ( -- )
1480 s" kernel_options" getenv dup -1 = if
1483 s" temp_options" setenv
1487 \ pick the i-th argument, i starts at 0
1488 : argv[] ( aN uN ... a1 u1 N i -- aN uN ... a1 u1 N ai+1 ui+1 )
1489 2dup = if 0 0 exit then \ out of range
1491 1+ 2* ( skip N and ui )
1494 1+ 2* ( skip N and ai )
1498 : drop_args ( aN uN ... a1 u1 N -- )
1506 : queue_argv ( aN uN ... a1 u1 N a u -- a u aN uN ... a1 u1 N+1 )
1514 : unqueue_argv ( aN uN ... a1 u1 N -- aN uN ... a2 u2 N-1 a1 u1 )
1518 \ compute the length of the buffer including the spaces between words
1519 : strlen(argv) ( aN uN .. a1 u1 N -- aN uN .. a1 u1 N len )
1520 dup 0= if 0 exit then
1535 : concat_argv ( aN uN ... a1 u1 N -- a u )
1536 strlen(argv) allocate if ENOMEM throw then
1537 0 2>r ( save addr 0 on return stack )
1542 unqueue_argv ( ... N a1 u1 )
1543 2r> 2swap ( old a1 u1 )
1545 s" " strcat ( append one space ) \ XXX this gives a trailing space
1546 2>r ( store string on the result stack )
1552 : set_tempoptions ( addrN lenN ... addr1 len1 N -- addr len 1 | 0 )
1553 \ Save the first argument, if it exists and is not a flag
1555 0 argv[] drop c@ [char] - <> if
1556 unqueue_argv 2>r \ Filename
1557 1 >r \ Filename present
1559 0 >r \ Filename not present
1562 0 >r \ Filename not present
1565 \ If there are other arguments, assume they are flags
1568 2dup s" temp_options" setenv
1569 drop free if EFREE throw then
1574 \ Bring back the filename, if one was provided
1575 r> if 2r> 1 else 0 then
1578 : get_arguments ( -- addrN lenN ... addr1 len1 N )
1581 \ Get next word on the command line
1586 drop ( empty string )
1589 : load_kernel_and_modules ( args -- flag )
1592 s" temp_options" getenv dup -1 <> if
1598 ?dup 0= if ( success )
1599 r> if ( a path was passed )
1600 load_directory_or_file
1602 standard_kernel_search
1604 ?dup 0= if ['] load_modules catch then
1608 only forth definitions