Print this page
NEX-16819 loader UEFI support
Includes work by Toomas Soome <tsoome@me.com>
Upstream commits:
    loader: pxe receive cleanup
    9475 libefi: Do not return only if ReceiveFilter
    installboot: should support efi system partition
    8931 boot1.efi: scan all display modes rather than
    loader: spinconsole updates
    loader: gfx experiment to try GOP Blt() function.
    sha1 build test
    loader: add sha1 hash calculation
    common/sha1: update for loader build
    loader: biosdisk rework
    uts: 32-bit kernel FB needs mapping in low memory
    uts: add diag-device
    uts: boot console mirror with diag-device
    uts: enable very early console on ttya
    kmdb: add diag-device as input/output device
    uts: test VGA memory exclusion from mapping
    uts: clear boot mapping and protect boot pages test
    uts: add dboot map debug printf
    uts: need to release FB pages in release_bootstrap()
    uts: add screenmap ioctl
    uts: update sys/queue.h
    loader: add illumos uts/common to include path
    loader: tem/gfx font cleanup
    loader: vbe checks
    uts: gfx_private set KD_TEXT when KD_RESETTEXT is
    uts: gfx 8-bit update
    loader: gfx 8-bit fix
    loader: always set media size from partition.
    uts: MB2 support for 32-bit kernel
    loader: x86 should have tem 80x25
    uts: x86 should have tem 80x25
    uts: font update
    loader: font update
    uts: tem attributes
    loader: tem.c comment added
    uts: use font module
    loader: add font module
    loader: build rules for new font setup
    uts: gfx_private update for new font structure
    uts: early boot update for new font structure
    uts: font update
    uts: font build rules update for new fonts
    uts: tem update to new font structure
    loader: module.c needs to include tem_impl.h
    uts: gfx_private 8x16 font rework
    uts: make font_lookup public
    loader: font rework
    uts: font rework
    9259 libefi: efi_alloc_and_read should check for PMBR
    uts: tem utf-8 support
    loader: implement tem utf-8 support
    loader: tem should be able to display UTF-8
    7784 uts: console input should support utf-8
    7796 uts: ldterm default to utf-8
    uts: do not reset serial console
    uts: set up colors even if tem is not console
    uts: add type for early boot properties
    uts: gfx_private experiment with drm and vga
    uts: gfx_private should use setmode drm callback.
    uts: identify FB types and set up gfx_private based
    loader: replace gop and vesa with framebuffer
    uts: boot needs simple tem to support mdb
    uts: boot_keyboard should emit esc sequences for
    uts: gfx_private FB showuld be written by line
    kmdb: set terminal window size
    uts: gfx_private needs to keep track of early boot FB
    pnglite: move pnglite to usr/src/common
    loader: gfx_fb
    ficl-sys: add gfx primitives
    loader: add illumos.png logo
    ficl: add fb-putimage
    loader: add png support
    loader: add alpha blending for gfx_fb
    loader: use term-drawrect for menu frame
    ficl: add simple gfx words
    uts: provide fb_info via fbgattr dev_specific array.
    uts: gfx_private add alpha blending
    uts: update sys/ascii.h
    uts: tem OSC support (incomplete)
    uts: implement env module support and use data from
    uts: tem get colors from early boot data
    loader: use crc32 from libstand (libz)
    loader: optimize for size
    loader: pass tem info to the environment
    loader: import tem for loader console
    loader: UEFI loader needs to set ISADIR based on
    loader: need UEFI32 support
    8918 loader.efi: add vesa edid support
    uts: tem_safe_pix_clear_prom_output() should only
    uts: tem_safe_pix_clear_entire_screen() should use
    uts: tem_safe_check_first_time() should query cursor
    uts: tem implement cls callback & visual_io v4
    uts: gfx_vgatext use block cursor for vgatext
    uts: gfx_private implement cls callback & visual_io
    uts: gfx_private bitmap framebuffer implementation
    uts: early start frame buffer console support
    uts: font functions should check the input char
    uts: font rendering should support 16/24/32bit depths
    uts: use smallest font as fallback default.
    uts: update terminal dimensions based on selected
    7834 uts: vgatext should use gfx_private
    uts: add spacing property to 8859-1.bdf
    terminfo: add underline for sun-color
    terminfo: sun-color has 16 colors
    uts: add font load callback type
    loader: do not repeat int13 calls with error 0x20 and
    8905 loader: add skein/edonr support
    8904 common/crypto: make skein and edonr loader
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Reviewed by: Sanjay Nadkarni <sanjay.nadkarni@nexenta.com>
Reviewed by: Evan Layton <evan.layton@nexenta.com>
Revert "NEX-16819 loader UEFI support"
This reverts commit ec06b9fc617b99234e538bf2e7e4d02a24993e0c.
Reverting due to failures in the zfs-tests and the sharefs-tests
NEX-16819 loader UEFI support
Includes work by Toomas Soome <tsoome@me.com>
Upstream commits:
    loader: pxe receive cleanup
    9475 libefi: Do not return only if ReceiveFilter
    installboot: should support efi system partition
    8931 boot1.efi: scan all display modes rather than
    loader: spinconsole updates
    loader: gfx experiment to try GOP Blt() function.
    sha1 build test
    loader: add sha1 hash calculation
    common/sha1: update for loader build
    loader: biosdisk rework
    uts: 32-bit kernel FB needs mapping in low memory
    uts: add diag-device
    uts: boot console mirror with diag-device
    uts: enable very early console on ttya
    kmdb: add diag-device as input/output device
    uts: test VGA memory exclusion from mapping
    uts: clear boot mapping and protect boot pages test
    uts: add dboot map debug printf
    uts: need to release FB pages in release_bootstrap()
    uts: add screenmap ioctl
    uts: update sys/queue.h
    loader: add illumos uts/common to include path
    loader: tem/gfx font cleanup
    loader: vbe checks
    uts: gfx_private set KD_TEXT when KD_RESETTEXT is
    uts: gfx 8-bit update
    loader: gfx 8-bit fix
    loader: always set media size from partition.
    uts: MB2 support for 32-bit kernel
    loader: x86 should have tem 80x25
    uts: x86 should have tem 80x25
    uts: font update
    loader: font update
    uts: tem attributes
    loader: tem.c comment added
    uts: use font module
    loader: add font module
    loader: build rules for new font setup
    uts: gfx_private update for new font structure
    uts: early boot update for new font structure
    uts: font update
    uts: font build rules update for new fonts
    uts: tem update to new font structure
    loader: module.c needs to include tem_impl.h
    uts: gfx_private 8x16 font rework
    uts: make font_lookup public
    loader: font rework
    uts: font rework
    libefi: efi_alloc_and_read should check for PMBR
    uts: tem utf-8 support
    loader: implement tem utf-8 support
    loader: tem should be able to display UTF-8
    7784 uts: console input should support utf-8
    7796 uts: ldterm default to utf-8
    uts: do not reset serial console
    uts: set up colors even if tem is not console
    uts: add type for early boot properties
    uts: gfx_private experiment with drm and vga
    uts: gfx_private should use setmode drm callback.
    uts: identify FB types and set up gfx_private based
    loader: replace gop and vesa with framebuffer
    uts: boot needs simple tem to support mdb
    uts: boot_keyboard should emit esc sequences for
    uts: gfx_private FB showuld be written by line
    kmdb: set terminal window size
    uts: gfx_private needs to keep track of early boot FB
    pnglite: move pnglite to usr/src/common
    loader: gfx_fb
    ficl-sys: add gfx primitives
    loader: add illumos.png logo
    ficl: add fb-putimage
    loader: add png support
    loader: add alpha blending for gfx_fb
    loader: use term-drawrect for menu frame
    ficl: add simple gfx words
    uts: provide fb_info via fbgattr dev_specific array.
    uts: gfx_private add alpha blending
    uts: update sys/ascii.h
    uts: tem OSC support (incomplete)
    uts: implement env module support and use data from
    uts: tem get colors from early boot data
    loader: use crc32 from libstand (libz)
    loader: optimize for size
    loader: pass tem info to the environment
    loader: import tem for loader console
    loader: UEFI loader needs to set ISADIR based on
    loader: need UEFI32 support
    8918 loader.efi: add vesa edid support
    uts: tem_safe_pix_clear_prom_output() should only
    uts: tem_safe_pix_clear_entire_screen() should use
    uts: tem_safe_check_first_time() should query cursor
    uts: tem implement cls callback & visual_io v4
    uts: gfx_vgatext use block cursor for vgatext
    uts: gfx_private implement cls callback & visual_io
    uts: gfx_private bitmap framebuffer implementation
    uts: early start frame buffer console support
    uts: font functions should check the input char
    uts: font rendering should support 16/24/32bit depths
    uts: use smallest font as fallback default.
    uts: update terminal dimensions based on selected
    7834 uts: vgatext should use gfx_private
    uts: add spacing property to 8859-1.bdf
    terminfo: add underline for sun-color
    terminfo: sun-color has 16 colors
    uts: add font load callback type
    loader: do not repeat int13 calls with error 0x20 and
    8905 loader: add skein/edonr support
    8904 common/crypto: make skein and edonr loader
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Reviewed by: Sanjay Nadkarni <sanjay.nadkarni@nexenta.com>
Reviewed by: Evan Layton <evan.layton@nexenta.com>

@@ -30,10 +30,11 @@
 #include <fcntl.h>
 #include <assert.h>
 #include <locale.h>
 #include <strings.h>
 #include <libfdisk.h>
+#include <libgen.h>
 
 #include <sys/dktp/fdisk.h>
 #include <sys/dkio.h>
 #include <sys/vtoc.h>
 #include <sys/multiboot.h>

@@ -91,10 +92,22 @@
  * starting from bss_end_addr structure member location; stage2 will
  * detect the partition and file system based on this value.
  *
  * Stored location values in MBR/stage2 also mean the bootblocks must be
  * reinstalled in case the partition content is relocated.
+ *
+ * EFI boot program installation:
+ * EFI boot requires EFI System partition with following directory
+ * hierarchy:
+ * EFI/VENDOR/file
+ * EFI/BOOT/BOOTx64.EFI
+ * Where EFI/BOOT is fallback directory. While we have no mechanism to set
+ * EFI variable values to define vendor specific boot program location, we
+ * will just use EFI/BOOT/BOOTx64.EFI; also this setup is only possible
+ * solution for removable media.
+ * For now the boot1.efi is used for boot program, boot1.efi is also
+ * versioned as is gptzfsboot.
  */
 
 static boolean_t        write_mbr = B_FALSE;
 static boolean_t        force_mbr = B_FALSE;
 static boolean_t        force_update = B_FALSE;

@@ -102,10 +115,13 @@
 static boolean_t        do_version = B_FALSE;
 static boolean_t        do_mirror_bblk = B_FALSE;
 static boolean_t        strip = B_FALSE;
 static boolean_t        verbose_dump = B_FALSE;
 
+#define EFIBOOT64       "bootx64.efi"
+#define EFIBOOT32       "bootia32.efi"
+
 /* Versioning string, if present. */
 static char             *update_str;
 
 /*
  * Temporary buffer to store the first 32K of data looking for a multiboot

@@ -942,11 +958,11 @@
 {
         uint_t i;
         char *path, *ptr;
 
         for (i = 0; i < vtoc->efi_nparts; i++) {
-                if (vtoc->efi_parts[i].p_tag == V_BOOT) {
+                if (vtoc->efi_parts[i].p_tag == V_SYSTEM) {
                         if ((path = strdup(device->target.path)) == NULL) {
                                 perror(gettext("Memory allocation failure"));
                                 return (BC_ERROR);
                         }
                         ptr = strrchr(path, 's');

@@ -956,19 +972,40 @@
                         free(path);
                         if (ptr == NULL) {
                                 perror(gettext("Memory allocation failure"));
                                 return (BC_ERROR);
                         }
+                        device->system.path = ptr;
+                        device->system.fd = open_device(ptr);
+                        device->system.id = i;
+                        device->system.devtype = IG_DEV_EFI;
+                        device->system.fstype = IG_FS_PCFS;
+                        device->system.start = vtoc->efi_parts[i].p_start;
+                        device->system.size = vtoc->efi_parts[i].p_size;
+                        device->system.offset = 0;
+                } else if (vtoc->efi_parts[i].p_tag == V_BOOT) {
+                        if ((path = strdup(device->target.path)) == NULL) {
+                                perror(gettext("Memory allocation failure"));
+                                return (BC_ERROR);
+                        }
+                        ptr = strrchr(path, 's');
+                        ptr++;
+                        *ptr = '\0';
+                        (void) asprintf(&ptr, "%s%d", path, i);
+                        free(path);
+                        if (ptr == NULL) {
+                                perror(gettext("Memory allocation failure"));
+                                return (BC_ERROR);
+                        }
                         device->stage.path = ptr;
                         device->stage.fd = open_device(ptr);
                         device->stage.id = i;
                         device->stage.devtype = IG_DEV_EFI;
                         device->stage.fstype = IG_FS_NONE;
                         device->stage.start = vtoc->efi_parts[i].p_start;
                         device->stage.size = vtoc->efi_parts[i].p_size;
                         device->stage.offset = 1; /* leave sector 0 for VBR */
-                        return (BC_SUCCESS);
                 }
         }
         return (BC_SUCCESS);
 }
 

@@ -983,10 +1020,11 @@
         int ret;
 
         bzero(device, sizeof (*device));
         device->fd = -1;        /* whole disk fd */
         device->stage.fd = -1;  /* bootblock partition fd */
+        device->system.fd = -1; /* efi system partition fd */
         device->target.fd = -1; /* target fs partition fd */
 
         /* basic check, whole disk is not allowed */
         if ((p = strrchr(path, '/')) == NULL)
                 p = path;

@@ -1140,17 +1178,21 @@
 {
         if (device->path)
                 free(device->path);
         if (device->stage.path)
                 free(device->stage.path);
+        if (device->system.path)
+                free(device->system.path);
         if (device->target.path)
                 free(device->target.path);
 
         if (device->fd != -1)
                 (void) close(device->fd);
         if (device->stage.fd != -1)
                 (void) close(device->stage.fd);
+        if (device->system.fd != -1)
+                (void) close(device->system.fd);
         if (device->target.fd != -1)
                 (void) close(device->target.fd);
         bzero(device, sizeof (*device));
 }
 

@@ -1250,13 +1292,16 @@
 static int
 handle_install(char *progname, char **argv)
 {
         ib_data_t       install_data;
         ib_bootblock_t  *bblock = &install_data.bootblock;
+        ib_bootblock_t  *eblock = &install_data.efiblock;
         char            *stage1 = NULL;
         char            *bootblock = NULL;
+        char            *efiboot = NULL;
         char            *device_path = NULL;
+        char            *tmp;
         int             ret = BC_ERROR;
 
         stage1 = strdup(argv[0]);
         bootblock = strdup(argv[1]);
         device_path = strdup(argv[2]);

@@ -1265,10 +1310,22 @@
                 (void) fprintf(stderr, gettext("Missing parameter"));
                 usage(progname);
                 goto out;
         }
 
+        tmp = strdup(argv[1]);
+        if (tmp == NULL) {
+                perror(gettext("Memory allocation failure"));
+                goto out;
+        }
+        (void) asprintf(&efiboot, "%s/" EFIBOOT64, dirname(tmp));
+        free(tmp);
+        if (efiboot == NULL) {
+                perror(gettext("Memory allocation failure"));
+                goto out;
+        }
+
         BOOT_DEBUG("device path: %s, stage1 path: %s bootblock path: %s\n",
             device_path, stage1, bootblock);
         bzero(&install_data, sizeof (ib_data_t));
 
         if (init_device(&install_data.device, device_path) != BC_SUCCESS) {

@@ -1286,10 +1343,19 @@
                 (void) fprintf(stderr, gettext("Error reading %s\n"),
                     bootblock);
                 goto out_dev;
         }
 
+        /* only read EFI boot program if there is system partition */
+        if (install_data.device.system.fd != -1) {
+                if (read_bootblock_from_file(efiboot, eblock) != BC_SUCCESS) {
+                        (void) fprintf(stderr, gettext("Error reading %s\n"),
+                            efiboot);
+                        goto out_dev;
+                }
+        }
+
         /*
          * is_update_necessary() will take care of checking if versioning and/or
          * forcing the update have been specified. It will also emit a warning
          * if a non-versioned update is attempted over a versioned bootblock.
          */

@@ -1306,10 +1372,11 @@
         ret = commit_to_disk(&install_data, update_str);
 
 out_dev:
         cleanup_device(&install_data.device);
 out:
+        free(efiboot);
         free(stage1);
         free(bootblock);
         free(device_path);
         return (ret);
 }