lib/efi_loader/efi_bootmgr.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  *  EFI boot manager
   4  *
   5  *  Copyright (c) 2017 Rob Clark
   6  */
   7
   8 #define LOG_CATEGORY LOGC_EFI
   9
  10 #include <common.h>
  11 #include <charset.h>
  12 #include <log.h>
  13 #include <malloc.h>
  14 #include <efi_loader.h>
  15 #include <efi_variable.h>
  16 #include <asm/unaligned.h>
  17
  18 static const struct efi_boot_services *bs;
  19 static const struct efi_runtime_services *rs;
  20
  21 /*
  22  * bootmgr implements the logic of trying to find a payload to boot
  23  * based on the BootOrder + BootXXXX variables, and then loading it.
  24  *
  25  * TODO detecting a special key held (f9?) and displaying a boot menu
  26  * like you would get on a PC would be clever.
  27  *
  28  * TODO if we had a way to write and persist variables after the OS
  29  * has started, we'd also want to check OsIndications to see if we
  30  * should do normal or recovery boot.
  31  */
  32
  33 /**
  34  * efi_set_load_options() - set the load options of a loaded image
  35  *
  36  * @handle:             the image handle
  37  * @load_options_size:  size of load options
  38  * @load_options:       pointer to load options
  39  * Return:              status code
  40  */
  41 efi_status_t efi_set_load_options(efi_handle_t handle,
  42                                   efi_uintn_t load_options_size,
  43                                   void *load_options)
  44 {
  45         struct efi_loaded_image *loaded_image_info;
  46         efi_status_t ret;
  47
  48         ret = EFI_CALL(systab.boottime->open_protocol(
  49                                         handle,
  50                                         &efi_guid_loaded_image,
  51                                         (void **)&loaded_image_info,
  52                                         efi_root, NULL,
  53                                         EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL));
  54         if (ret != EFI_SUCCESS)
  55                 return EFI_INVALID_PARAMETER;
  56
  57         loaded_image_info->load_options = load_options;
  58         loaded_image_info->load_options_size = load_options_size;
  59
  60         return EFI_CALL(systab.boottime->close_protocol(handle,
  61                                                         &efi_guid_loaded_image,
  62                                                         efi_root, NULL));
  63 }
  64
  65
  66 /**
  67  * efi_deserialize_load_option() - parse serialized data
  68  *
  69  * Parse serialized data describing a load option and transform it to the
  70  * efi_load_option structure.
  71  *
  72  * @lo:         pointer to target
  73  * @data:       serialized data
  74  * @size:       size of the load option, on return size of the optional data
  75  * Return:      status code
  76  */
  77 efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
  78                                          efi_uintn_t *size)
  79 {
  80         efi_uintn_t len;
  81
  82         len = sizeof(u32);
  83         if (*size < len + 2 * sizeof(u16))
  84                 return EFI_INVALID_PARAMETER;
  85         lo->attributes = get_unaligned_le32(data);
  86         data += len;
  87         *size -= len;
  88
  89         len = sizeof(u16);
  90         lo->file_path_length = get_unaligned_le16(data);
  91         data += len;
  92         *size -= len;
  93
  94         lo->label = (u16 *)data;
  95         len = u16_strnlen(lo->label, *size / sizeof(u16) - 1);
  96         if (lo->label[len])
  97                 return EFI_INVALID_PARAMETER;
  98         len = (len + 1) * sizeof(u16);
  99         if (*size < len)
 100                 return EFI_INVALID_PARAMETER;
 101         data += len;
 102         *size -= len;
 103
 104         len = lo->file_path_length;
 105         if (*size < len)
 106                 return EFI_INVALID_PARAMETER;
 107         lo->file_path = (struct efi_device_path *)data;
 108          /*
 109           * TODO: validate device path. There should be an end node within
 110           * the indicated file_path_length.
 111           */
 112         data += len;
 113         *size -= len;
 114
 115         lo->optional_data = data;
 116
 117         return EFI_SUCCESS;
 118 }
 119
 120 /**
 121  * efi_serialize_load_option() - serialize load option
 122  *
 123  * Serialize efi_load_option structure into byte stream for BootXXXX.
 124  *
 125  * @data:       buffer for serialized data
 126  * @lo:         load option
 127  * Return:      size of allocated buffer
 128  */
 129 unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data)
 130 {
 131         unsigned long label_len;
 132         unsigned long size;
 133         u8 *p;
 134
 135         label_len = (u16_strlen(lo->label) + 1) * sizeof(u16);
 136
 137         /* total size */
 138         size = sizeof(lo->attributes);
 139         size += sizeof(lo->file_path_length);
 140         size += label_len;
 141         size += lo->file_path_length;
 142         if (lo->optional_data)
 143                 size += (utf8_utf16_strlen((const char *)lo->optional_data)
 144                                            + 1) * sizeof(u16);
 145         p = malloc(size);
 146         if (!p)
 147                 return 0;
 148
 149         /* copy data */
 150         *data = p;
 151         memcpy(p, &lo->attributes, sizeof(lo->attributes));
 152         p += sizeof(lo->attributes);
 153
 154         memcpy(p, &lo->file_path_length, sizeof(lo->file_path_length));
 155         p += sizeof(lo->file_path_length);
 156
 157         memcpy(p, lo->label, label_len);
 158         p += label_len;
 159
 160         memcpy(p, lo->file_path, lo->file_path_length);
 161         p += lo->file_path_length;
 162
 163         if (lo->optional_data) {
 164                 utf8_utf16_strcpy((u16 **)&p, (const char *)lo->optional_data);
 165                 p += sizeof(u16); /* size of trailing \0 */
 166         }
 167         return size;
 168 }
 169
 170 /**
 171  * get_var() - get UEFI variable
 172  *
 173  * It is the caller's duty to free the returned buffer.
 174  *
 175  * @name:       name of variable
 176  * @vendor:     vendor GUID of variable
 177  * @size:       size of allocated buffer
 178  * Return:      buffer with variable data or NULL
 179  */
 180 static void *get_var(u16 *name, const efi_guid_t *vendor,
 181                      efi_uintn_t *size)
 182 {
 183         efi_status_t ret;
 184         void *buf = NULL;
 185
 186         *size = 0;
 187         ret = efi_get_variable_int(name, vendor, NULL, size, buf, NULL);
 188         if (ret == EFI_BUFFER_TOO_SMALL) {
 189                 buf = malloc(*size);
 190                 ret = efi_get_variable_int(name, vendor, NULL, size, buf, NULL);
 191         }
 192
 193         if (ret != EFI_SUCCESS) {
 194                 free(buf);
 195                 *size = 0;
 196                 return NULL;
 197         }
 198
 199         return buf;
 200 }
 201
 202 /**
 203  * try_load_entry() - try to load image for boot option
 204  *
 205  * Attempt to load load-option number 'n', returning device_path and file_path
 206  * if successful. This checks that the EFI_LOAD_OPTION is active (enabled)
 207  * and that the specified file to boot exists.
 208  *
 209  * @n:                  number of the boot option, e.g. 0x0a13 for Boot0A13
 210  * @handle:             on return handle for the newly installed image
 211  * @load_options:       load options set on the loaded image protocol
 212  * Return:              status code
 213  */
 214 static efi_status_t try_load_entry(u16 n, efi_handle_t *handle,
 215                                    void **load_options)
 216 {
 217         struct efi_load_option lo;
 218         u16 varname[] = L"Boot0000";
 219         u16 hexmap[] = L"0123456789ABCDEF";
 220         void *load_option;
 221         efi_uintn_t size;
 222         efi_status_t ret;
 223
 224         varname[4] = hexmap[(n & 0xf000) >> 12];
 225         varname[5] = hexmap[(n & 0x0f00) >> 8];
 226         varname[6] = hexmap[(n & 0x00f0) >> 4];
 227         varname[7] = hexmap[(n & 0x000f) >> 0];
 228
 229         load_option = get_var(varname, &efi_global_variable_guid, &size);
 230         if (!load_option)
 231                 return EFI_LOAD_ERROR;
 232
 233         ret = efi_deserialize_load_option(&lo, load_option, &size);
 234         if (ret != EFI_SUCCESS) {
 235                 log_warning("Invalid load option for %ls\n", varname);
 236                 goto error;
 237         }
 238
 239         if (lo.attributes & LOAD_OPTION_ACTIVE) {
 240                 u32 attributes;
 241
 242                 log_debug("%s: trying to load \"%ls\" from %pD\n",
 243                           __func__, lo.label, lo.file_path);
 244
 245                 ret = EFI_CALL(efi_load_image(true, efi_root, lo.file_path,
 246                                               NULL, 0, handle));
 247                 if (ret != EFI_SUCCESS) {
 248                         log_warning("Loading %ls '%ls' failed\n",
 249                                     varname, lo.label);
 250                         goto error;
 251                 }
 252
 253                 attributes = EFI_VARIABLE_BOOTSERVICE_ACCESS |
 254                              EFI_VARIABLE_RUNTIME_ACCESS;
 255                 ret = efi_set_variable_int(L"BootCurrent",
 256                                            &efi_global_variable_guid,
 257                                            attributes, sizeof(n), &n, false);
 258                 if (ret != EFI_SUCCESS) {
 259                         if (EFI_CALL(efi_unload_image(*handle))
 260                             != EFI_SUCCESS)
 261                                 log_err("Unloading image failed\n");
 262                         goto error;
 263                 }
 264
 265                 log_info("Booting: %ls\n", lo.label);
 266         } else {
 267                 ret = EFI_LOAD_ERROR;
 268         }
 269
 270         /* Set load options */
 271         if (size) {
 272                 *load_options = malloc(size);
 273                 if (!*load_options) {
 274                         ret = EFI_OUT_OF_RESOURCES;
 275                         goto error;
 276                 }
 277                 memcpy(*load_options, lo.optional_data, size);
 278                 ret = efi_set_load_options(*handle, size, *load_options);
 279         } else {
 280                 load_options = NULL;
 281         }
 282
 283 error:
 284         free(load_option);
 285
 286         return ret;
 287 }
 288
 289 /**
 290  * efi_bootmgr_load() - try to load from BootNext or BootOrder
 291  *
 292  * Attempt to load from BootNext or in the order specified by BootOrder
 293  * EFI variable, the available load-options, finding and returning
 294  * the first one that can be loaded successfully.
 295  *
 296  * @handle:             on return handle for the newly installed image
 297  * @load_options:       load options set on the loaded image protocol
 298  * Return:              status code
 299  */
 300 efi_status_t efi_bootmgr_load(efi_handle_t *handle, void **load_options)
 301 {
 302         u16 bootnext, *bootorder;
 303         efi_uintn_t size;
 304         int i, num;
 305         efi_status_t ret;
 306
 307         bs = systab.boottime;
 308         rs = systab.runtime;
 309
 310         /* BootNext */
 311         size = sizeof(bootnext);
 312         ret = efi_get_variable_int(L"BootNext",
 313                                    &efi_global_variable_guid,
 314                                    NULL, &size, &bootnext, NULL);
 315         if (ret == EFI_SUCCESS || ret == EFI_BUFFER_TOO_SMALL) {
 316                 /* BootNext does exist here */
 317                 if (ret == EFI_BUFFER_TOO_SMALL || size != sizeof(u16))
 318                         log_err("BootNext must be 16-bit integer\n");
 319
 320                 /* delete BootNext */
 321                 ret = efi_set_variable_int(L"BootNext",
 322                                            &efi_global_variable_guid,
 323                                            0, 0, NULL, false);
 324
 325                 /* load BootNext */
 326                 if (ret == EFI_SUCCESS) {
 327                         if (size == sizeof(u16)) {
 328                                 ret = try_load_entry(bootnext, handle,
 329                                                      load_options);
 330                                 if (ret == EFI_SUCCESS)
 331                                         return ret;
 332                                 log_warning(
 333                                         "Loading from BootNext failed, falling back to BootOrder\n");
 334                         }
 335                 } else {
 336                         log_err("Deleting BootNext failed\n");
 337                 }
 338         }
 339
 340         /* BootOrder */
 341         bootorder = get_var(L"BootOrder", &efi_global_variable_guid, &size);
 342         if (!bootorder) {
 343                 log_info("BootOrder not defined\n");
 344                 ret = EFI_NOT_FOUND;
 345                 goto error;
 346         }
 347
 348         num = size / sizeof(uint16_t);
 349         for (i = 0; i < num; i++) {
 350                 log_debug("%s trying to load Boot%04X\n", __func__,
 351                           bootorder[i]);
 352                 ret = try_load_entry(bootorder[i], handle, load_options);
 353                 if (ret == EFI_SUCCESS)
 354                         break;
 355         }
 356
 357         free(bootorder);
 358
 359 error:
 360         return ret;
 361 }