root/usr/src/boot/efi/loader/efi_main.c
/*
 * Copyright (c) 2000 Doug Rabson
 * 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.
 */

#include <efi.h>
#include <efilib.h>
#include <efidevp.h>
#include <stand.h>
#include <Protocol/LoadedImage.h>
#include <bootstrap.h>

static EFI_PHYSICAL_ADDRESS heap;
static UINTN heapsize;

void
efi_exit(EFI_STATUS exit_code)
{

        if (has_boot_services) {
                BS->FreePages(heap, EFI_SIZE_TO_PAGES(heapsize));
                BS->Exit(IH, exit_code, 0, NULL);
        } else {
                RS->ResetSystem(EfiResetCold, EFI_SUCCESS, 0, NULL);
        }
}

void
exit(int status __unused)
{

        efi_exit(EFI_LOAD_ERROR);
}

static CHAR16 *
arg_skipsep(CHAR16 *argp)
{

        while (*argp == ' ' || *argp == '\t' || *argp == '\n')
                argp++;
        return (argp);
}

static CHAR16 *
arg_skipword(CHAR16 *argp)
{

        while (*argp && *argp != ' ' && *argp != '\t' && *argp != '\n')
                argp++;
        return (argp);
}

EFI_STATUS
efi_main(EFI_HANDLE image_handle, EFI_SYSTEM_TABLE *system_table)
{
        CHAR16 *argp, *args, **argv;
        EFI_STATUS status;
        int argc, addprog;

        IH = image_handle;
        ST = system_table;
        BS = ST->BootServices;
        RS = ST->RuntimeServices;

        heapsize = 64 * 1024 * 1024;
        /* 4GB upper limit, try to leave some space from 1MB */
        heap = 0x0000000100000000;
        status = BS->AllocatePages(AllocateMaxAddress, EfiLoaderData,
            EFI_SIZE_TO_PAGES(heapsize), &heap);
        if (status != EFI_SUCCESS)
                BS->Exit(IH, status, 0, NULL);

        setheap((void *)(uintptr_t)heap, (void *)(uintptr_t)(heap + heapsize));

        /* Use efi_exit() from here on... */

        status = OpenProtocolByHandle(IH, &gEfiLoadedImageProtocolGuid,
            (void **)&boot_img);
        if (status != EFI_SUCCESS)
                efi_exit(status);

        /*
         * Pre-process the (optional) load options. If the option string
         * is given as an ASCII string, we use a poor man's ASCII to
         * Unicode-16 translation. The size of the option string as given
         * to us includes the terminating null character. We assume the
         * string is an ASCII string if strlen() plus the terminating
         * '\0' is less than LoadOptionsSize. Even if all Unicode-16
         * characters have the upper 8 bits non-zero, the terminating
         * null character will cause a one-off.
         * If the string is already in Unicode-16, we make a copy so that
         * we know we can always modify the string.
         */
        if (boot_img->LoadOptionsSize > 0 && boot_img->LoadOptions != NULL) {
                if (boot_img->LoadOptionsSize ==
                    strlen(boot_img->LoadOptions) + 1) {
                        args = malloc(boot_img->LoadOptionsSize << 1);
                        for (argc = 0; argc < (int)boot_img->LoadOptionsSize;
                            argc++)
                                args[argc] =
                                    ((char *)boot_img->LoadOptions)[argc];
                } else {
                        args = malloc(boot_img->LoadOptionsSize);
                        memcpy(args, boot_img->LoadOptions,
                            boot_img->LoadOptionsSize);
                }
        } else
                args = NULL;

        /*
         * Use a quick and dirty algorithm to build the argv vector. We
         * first count the number of words. Then, after allocating the
         * vector, we split the string up. We don't deal with quotes or
         * other more advanced shell features.
         * The EFI shell will pass the name of the image as the first
         * word in the argument list. This does not happen if we're
         * loaded by the boot manager. This is not so easy to figure
         * out though. The ParentHandle is not always NULL, because
         * there can be a function (=image) that will perform the task
         * for the boot manager.
         */
        /* Part 1: Figure out if we need to add our program name. */
        addprog = (args == NULL || boot_img->ParentHandle == NULL ||
            boot_img->FilePath == NULL) ? 1 : 0;
        if (!addprog) {
                addprog =
                    (DevicePathType(boot_img->FilePath) != MEDIA_DEVICE_PATH ||
                    DevicePathSubType(boot_img->FilePath) !=
                    MEDIA_FILEPATH_DP ||
                    DevicePathNodeLength(boot_img->FilePath) <=
                    sizeof (FILEPATH_DEVICE_PATH)) ? 1 : 0;
                if (!addprog) {
                        /* XXX todo. */
                }
        }
        /* Part 2: count words. */
        argc = (addprog) ? 1 : 0;
        argp = args;
        while (argp != NULL && *argp != 0) {
                argp = arg_skipsep(argp);
                if (*argp == 0)
                        break;
                argc++;
                argp = arg_skipword(argp);
        }
        /* Part 3: build vector. */
        argv = malloc((argc + 1) * sizeof (CHAR16*));
        argc = 0;
        if (addprog)
                argv[argc++] = (CHAR16 *)LOADER_EFI;
        argp = args;
        while (argp != NULL && *argp != 0) {
                argp = arg_skipsep(argp);
                if (*argp == 0)
                        break;
                argv[argc++] = argp;
                argp = arg_skipword(argp);
                /* Terminate the words. */
                if (*argp != 0)
                        *argp++ = 0;
        }
        argv[argc] = NULL;

        status = main(argc, argv);
        efi_exit(status);
        return (status);
}

static int
command_heap(int argc __unused, char *argv[] __unused)
{
        mallocstats();
        printf("heap base at %p, top at %p, upper limit at %p\n",
            (void *)(uintptr_t)heap, sbrk(0),
            (void *)(uintptr_t)heap + heapsize);
        return (CMD_OK);
}

COMMAND_SET(heap, "heap", "show heap usage", command_heap);