xref: /freebsd/stand/efi/loader/efi_main.c (revision 3078531de10dcae44b253a35125c949ff4235284)
1 /*-
2  * Copyright (c) 2000 Doug Rabson
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <bootstrap.h>
31 #include <efi.h>
32 #include <eficonsctl.h>
33 #include <efilib.h>
34 #include <stand.h>
35 
36 static EFI_PHYSICAL_ADDRESS heap;
37 static UINTN heapsize;
38 
39 void
40 efi_exit(EFI_STATUS exit_code)
41 {
42 
43 	if (boot_services_active) {
44 		BS->FreePages(heap, EFI_SIZE_TO_PAGES(heapsize));
45 		BS->Exit(IH, exit_code, 0, NULL);
46 	} else {
47 		RS->ResetSystem(EfiResetCold, EFI_SUCCESS, 0, NULL);
48 	}
49 }
50 
51 void
52 exit(int status)
53 {
54 
55 	efi_exit(EFI_LOAD_ERROR);
56 }
57 
58 static CHAR16 *
59 arg_skipsep(CHAR16 *argp)
60 {
61 
62 	while (*argp == ' ' || *argp == '\t' || *argp == '\n')
63 		argp++;
64 	return (argp);
65 }
66 
67 static CHAR16 *
68 arg_skipword(CHAR16 *argp)
69 {
70 
71 	while (*argp && *argp != ' ' && *argp != '\t' && *argp != '\n')
72 		argp++;
73 	return (argp);
74 }
75 
76 EFI_STATUS
77 efi_main(EFI_HANDLE image_handle, EFI_SYSTEM_TABLE *system_table)
78 {
79 	static EFI_GUID image_protocol = LOADED_IMAGE_PROTOCOL;
80 	static EFI_GUID console_control_protocol =
81 	    EFI_CONSOLE_CONTROL_PROTOCOL_GUID;
82 	EFI_CONSOLE_CONTROL_PROTOCOL *console_control = NULL;
83 	EFI_LOADED_IMAGE *img;
84 	CHAR16 *argp, *args, **argv;
85 	EFI_STATUS status;
86 	int argc, addprog;
87 
88 	IH = image_handle;
89 	ST = system_table;
90 	BS = ST->BootServices;
91 	RS = ST->RuntimeServices;
92 
93 	status = BS->LocateProtocol(&console_control_protocol, NULL,
94 	    (VOID **)&console_control);
95 	if (status == EFI_SUCCESS)
96 		(void)console_control->SetMode(console_control,
97 		    EfiConsoleControlScreenText);
98 
99 	heapsize = 64 * 1024 * 1024;
100 	status = BS->AllocatePages(AllocateAnyPages, EfiLoaderData,
101 	    EFI_SIZE_TO_PAGES(heapsize), &heap);
102 	if (status != EFI_SUCCESS) {
103 		ST->ConOut->OutputString(ST->ConOut, (CHAR16 *)L"Failed to allocate memory for heap.\r\n");
104 		BS->Exit(IH, status, 0, NULL);
105 	}
106 
107 	setheap((void *)(uintptr_t)heap, (void *)(uintptr_t)(heap + heapsize));
108 
109 	/* Start tslog now that we have a heap.*/
110 	tslog_init();
111 
112 	/* Use efi_exit() from here on... */
113 
114 	status = OpenProtocolByHandle(IH, &image_protocol, (void**)&img);
115 	if (status != EFI_SUCCESS)
116 		efi_exit(status);
117 
118 	/*
119 	 * Pre-process the (optional) load options. If the option string
120 	 * is given as an ASCII string, we use a poor man's ASCII to
121 	 * Unicode-16 translation. The size of the option string as given
122 	 * to us includes the terminating null character. We assume the
123 	 * string is an ASCII string if strlen() plus the terminating
124 	 * '\0' is less than LoadOptionsSize. Even if all Unicode-16
125 	 * characters have the upper 8 bits non-zero, the terminating
126 	 * null character will cause a one-off.
127 	 * If the string is already in Unicode-16, we make a copy so that
128 	 * we know we can always modify the string.
129 	 */
130 	if (img->LoadOptionsSize > 0 && img->LoadOptions != NULL) {
131 		if (img->LoadOptionsSize == strlen(img->LoadOptions) + 1) {
132 			args = malloc(img->LoadOptionsSize << 1);
133 			for (argc = 0; argc < (int)img->LoadOptionsSize; argc++)
134 				args[argc] = ((char*)img->LoadOptions)[argc];
135 		} else {
136 			args = malloc(img->LoadOptionsSize);
137 			memcpy(args, img->LoadOptions, img->LoadOptionsSize);
138 		}
139 	} else
140 		args = NULL;
141 
142 	/*
143 	 * Use a quick and dirty algorithm to build the argv vector. We
144 	 * first count the number of words. Then, after allocating the
145 	 * vector, we split the string up. We don't deal with quotes or
146 	 * other more advanced shell features.
147 	 * The EFI shell will pass the name of the image as the first
148 	 * word in the argument list. This does not happen if we're
149 	 * loaded by the boot manager. This is not so easy to figure
150 	 * out though. The ParentHandle is not always NULL, because
151 	 * there can be a function (=image) that will perform the task
152 	 * for the boot manager.
153 	 */
154 	/* Part 1: Figure out if we need to add our program name. */
155 	addprog = (args == NULL || img->ParentHandle == NULL ||
156 	    img->FilePath == NULL) ? 1 : 0;
157 	if (!addprog) {
158 		addprog =
159 		    (DevicePathType(img->FilePath) != MEDIA_DEVICE_PATH ||
160 		     DevicePathSubType(img->FilePath) != MEDIA_FILEPATH_DP ||
161 		     DevicePathNodeLength(img->FilePath) <=
162 			sizeof(FILEPATH_DEVICE_PATH)) ? 1 : 0;
163 		if (!addprog) {
164 			/* XXX todo. */
165 		}
166 	}
167 	/* Part 2: count words. */
168 	argc = (addprog) ? 1 : 0;
169 	argp = args;
170 	while (argp != NULL && *argp != 0) {
171 		argp = arg_skipsep(argp);
172 		if (*argp == 0)
173 			break;
174 		argc++;
175 		argp = arg_skipword(argp);
176 	}
177 	/* Part 3: build vector. */
178 	argv = malloc((argc + 1) * sizeof(CHAR16*));
179 	argc = 0;
180 	if (addprog)
181 		argv[argc++] = (CHAR16 *)L"loader.efi";
182 	argp = args;
183 	while (argp != NULL && *argp != 0) {
184 		argp = arg_skipsep(argp);
185 		if (*argp == 0)
186 			break;
187 		argv[argc++] = argp;
188 		argp = arg_skipword(argp);
189 		/* Terminate the words. */
190 		if (*argp != 0)
191 			*argp++ = 0;
192 	}
193 	argv[argc] = NULL;
194 
195 	status = main(argc, argv);
196 	efi_exit(status);
197 	return (status);
198 }
199