libefi.c revision 294981 
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: stable/10/sys/boot/efi/libefi/libefi.c 294981 2016-01-28 12:11:42Z smh $");
29
30#include <efi.h>
31#include <eficonsctl.h>
32#include <efilib.h>
33#include <stand.h>
34
35EFI_HANDLE		IH;
36EFI_SYSTEM_TABLE	*ST;
37EFI_BOOT_SERVICES	*BS;
38EFI_RUNTIME_SERVICES	*RS;
39
40static EFI_PHYSICAL_ADDRESS heap;
41static UINTN heapsize;
42
43static CHAR16 *
44arg_skipsep(CHAR16 *argp)
45{
46
47	while (*argp == ' ' || *argp == '\t')
48		argp++;
49	return (argp);
50}
51
52static CHAR16 *
53arg_skipword(CHAR16 *argp)
54{
55
56	while (*argp && *argp != ' ' && *argp != '\t')
57		argp++;
58	return (argp);
59}
60
61void *
62efi_get_table(EFI_GUID *tbl)
63{
64	EFI_GUID *id;
65	int i;
66
67	for (i = 0; i < ST->NumberOfTableEntries; i++) {
68		id = &ST->ConfigurationTable[i].VendorGuid;
69		if (!memcmp(id, tbl, sizeof(EFI_GUID)))
70			return (ST->ConfigurationTable[i].VendorTable);
71	}
72	return (NULL);
73}
74
75void exit(EFI_STATUS exit_code)
76{
77
78	BS->FreePages(heap, EFI_SIZE_TO_PAGES(heapsize));
79	BS->Exit(IH, exit_code, 0, NULL);
80}
81
82void
83efi_main(EFI_HANDLE image_handle, EFI_SYSTEM_TABLE *system_table)
84{
85	static EFI_GUID image_protocol = LOADED_IMAGE_PROTOCOL;
86	static EFI_GUID console_control_protocol =
87	    EFI_CONSOLE_CONTROL_PROTOCOL_GUID;
88	EFI_CONSOLE_CONTROL_PROTOCOL *console_control = NULL;
89	EFI_LOADED_IMAGE *img;
90	CHAR16 *argp, *args, **argv;
91	EFI_STATUS status;
92	int argc, addprog;
93
94	IH = image_handle;
95	ST = system_table;
96	BS = ST->BootServices;
97	RS = ST->RuntimeServices;
98
99	status = BS->LocateProtocol(&console_control_protocol, NULL,
100	    (VOID **)&console_control);
101	if (status == EFI_SUCCESS)
102		(void)console_control->SetMode(console_control,
103		    EfiConsoleControlScreenText);
104
105	heapsize = 3 * 1024 * 1024;
106	status = BS->AllocatePages(AllocateAnyPages, EfiLoaderData,
107	    EFI_SIZE_TO_PAGES(heapsize), &heap);
108	if (status != EFI_SUCCESS)
109		BS->Exit(IH, status, 0, NULL);
110
111	setheap((void *)(uintptr_t)heap, (void *)(uintptr_t)(heap + heapsize));
112
113	/* Use exit() from here on... */
114
115	status = BS->HandleProtocol(IH, &image_protocol, (VOID**)&img);
116	if (status != EFI_SUCCESS)
117		exit(status);
118
119	/*
120	 * Pre-process the (optional) load options. If the option string
121	 * is given as an ASCII string, we use a poor man's ASCII to
122	 * Unicode-16 translation. The size of the option string as given
123	 * to us includes the terminating null character. We assume the
124	 * string is an ASCII string if strlen() plus the terminating
125	 * '\0' is less than LoadOptionsSize. Even if all Unicode-16
126	 * characters have the upper 8 bits non-zero, the terminating
127	 * null character will cause a one-off.
128	 * If the string is already in Unicode-16, we make a copy so that
129	 * we know we can always modify the string.
130	 */
131	if (img->LoadOptionsSize > 0 && img->LoadOptions != NULL) {
132		if (img->LoadOptionsSize == strlen(img->LoadOptions) + 1) {
133			args = malloc(img->LoadOptionsSize << 1);
134			for (argc = 0; argc < img->LoadOptionsSize; argc++)
135				args[argc] = ((char*)img->LoadOptions)[argc];
136		} else {
137			args = malloc(img->LoadOptionsSize);
138			memcpy(args, img->LoadOptions, img->LoadOptionsSize);
139		}
140	} else
141		args = NULL;
142
143	/*
144	 * Use a quick and dirty algorithm to build the argv vector. We
145	 * first count the number of words. Then, after allocating the
146	 * vector, we split the string up. We don't deal with quotes or
147	 * other more advanced shell features.
148	 * The EFI shell will pass the name of the image as the first
149	 * word in the argument list. This does not happen if we're
150	 * loaded by the boot manager. This is not so easy to figure
151	 * out though. The ParentHandle is not always NULL, because
152	 * there can be a function (=image) that will perform the task
153	 * for the boot manager.
154	 */
155	/* Part 1: Figure out if we need to add our program name. */
156	addprog = (args == NULL || img->ParentHandle == NULL ||
157	    img->FilePath == NULL) ? 1 : 0;
158	if (!addprog) {
159		addprog =
160		    (DevicePathType(img->FilePath) != MEDIA_DEVICE_PATH ||
161		     DevicePathSubType(img->FilePath) != MEDIA_FILEPATH_DP ||
162		     DevicePathNodeLength(img->FilePath) <=
163			sizeof(FILEPATH_DEVICE_PATH)) ? 1 : 0;
164		if (!addprog) {
165			/* XXX todo. */
166		}
167	}
168	/* Part 2: count words. */
169	argc = (addprog) ? 1 : 0;
170	argp = args;
171	while (argp != NULL && *argp != 0) {
172		argp = arg_skipsep(argp);
173		if (*argp == 0)
174			break;
175		argc++;
176		argp = arg_skipword(argp);
177	}
178	/* Part 3: build vector. */
179	argv = malloc((argc + 1) * sizeof(CHAR16*));
180	argc = 0;
181	if (addprog)
182		argv[argc++] = (CHAR16 *)L"loader.efi";
183	argp = args;
184	while (argp != NULL && *argp != 0) {
185		argp = arg_skipsep(argp);
186		if (*argp == 0)
187			break;
188		argv[argc++] = argp;
189		argp = arg_skipword(argp);
190		/* Terminate the words. */
191		if (*argp != 0)
192			*argp++ = 0;
193	}
194	argv[argc] = NULL;
195
196	status = main(argc, argv);
197	exit(status);
198}
199