2 * GRUB -- GRand Unified Bootloader
3 * Copyright (C) 2014 Free Software Foundation, Inc.
5 * GRUB is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * GRUB is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
19 #include <grub/cache.h>
20 #include <grub/charset.h>
21 #include <grub/command.h>
23 #include <grub/file.h>
25 #include <grub/list.h>
26 #include <grub/loader.h>
27 #include <grub/misc.h>
29 #include <grub/types.h>
30 #include <grub/cpu/linux.h>
31 #include <grub/efi/efi.h>
32 #include <grub/efi/fdtload.h>
33 #include <grub/efi/pe32.h> /* required by struct xen_hypervisor_header */
34 #include <grub/i18n.h>
35 #include <grub/lib/cmdline.h>
37 GRUB_MOD_LICENSE ("GPLv3+");
39 #define XEN_HYPERVISOR_NAME "xen_hypervisor"
40 #define MODULE_CUSTOM_COMPATIBLE "multiboot,module"
42 /* This maximum size is defined in Power.org ePAPR V1.1
43 * https://www.power.org/documentation/epapr-version-1-1/
44 * 2.2.1.1 Node Name Requirements
45 * node-name@unit-address
46 * 31 + 1(@) + 16(64bit address in hex format) + 1(\0) = 49
48 #define FDT_NODE_NAME_MAX_SIZE (49)
50 struct compat_string_struct
53 const char *compat_string
;
55 typedef struct compat_string_struct compat_string_struct_t
;
56 #define FDT_COMPATIBLE(x) {.size = sizeof(x), .compat_string = (x)}
65 typedef enum module_type module_type_t
;
67 struct xen_hypervisor_header
69 struct grub_arm64_linux_kernel_header efi_head
;
71 /* This is always PE\0\0. */
72 grub_uint8_t signature
[GRUB_PE32_SIGNATURE_SIZE
];
73 /* The COFF file header. */
74 struct grub_pe32_coff_header coff_header
;
75 /* The Optional header. */
76 struct grub_pe64_optional_header optional_header
;
79 struct xen_boot_binary
81 struct xen_boot_binary
*next
;
82 struct xen_boot_binary
**prev
;
93 static grub_dl_t my_mod
;
97 static struct xen_boot_binary
*xen_hypervisor
;
98 static struct xen_boot_binary
*module_head
;
100 static __inline grub_addr_t
101 xen_boot_address_align (grub_addr_t start
, grub_size_t align
)
103 return (align
? (ALIGN_UP (start
, align
)) : start
);
107 prepare_xen_hypervisor_params (void *xen_boot_fdt
)
112 chosen_node
= grub_fdt_find_subnode (xen_boot_fdt
, 0, "chosen");
114 chosen_node
= grub_fdt_add_subnode (xen_boot_fdt
, 0, "chosen");
116 return grub_error (GRUB_ERR_IO
, "failed to get chosen node in FDT");
118 grub_dprintf ("xen_loader",
119 "Xen Hypervisor cmdline : %s @ %p size:%d\n",
120 xen_hypervisor
->cmdline
, xen_hypervisor
->cmdline
,
121 xen_hypervisor
->cmdline_size
);
123 retval
= grub_fdt_set_prop (xen_boot_fdt
, chosen_node
, "bootargs",
124 xen_hypervisor
->cmdline
,
125 xen_hypervisor
->cmdline_size
);
127 return grub_error (GRUB_ERR_IO
, "failed to install/update FDT");
129 return GRUB_ERR_NONE
;
133 prepare_xen_module_params (struct xen_boot_binary
*module
, void *xen_boot_fdt
)
135 int retval
, chosen_node
= 0, module_node
= 0;
136 char module_name
[FDT_NODE_NAME_MAX_SIZE
];
138 retval
= grub_snprintf (module_name
, FDT_NODE_NAME_MAX_SIZE
, "module@%lx",
139 xen_boot_address_align (module
->start
,
141 grub_dprintf ("xen_loader", "Module node name %s \n", module_name
);
143 if (retval
< (int) sizeof ("module@"))
144 return grub_error (GRUB_ERR_IO
, N_("failed to get FDT"));
146 chosen_node
= grub_fdt_find_subnode (xen_boot_fdt
, 0, "chosen");
148 chosen_node
= grub_fdt_add_subnode (xen_boot_fdt
, 0, "chosen");
150 return grub_error (GRUB_ERR_IO
, "failed to get chosen node in FDT");
153 grub_fdt_find_subnode (xen_boot_fdt
, chosen_node
, module_name
);
156 grub_fdt_add_subnode (xen_boot_fdt
, chosen_node
, module_name
);
158 retval
= grub_fdt_set_prop (xen_boot_fdt
, module_node
, "compatible",
159 MODULE_CUSTOM_COMPATIBLE
, sizeof(MODULE_CUSTOM_COMPATIBLE
));
161 return grub_error (GRUB_ERR_IO
, "failed to update FDT");
163 grub_dprintf ("xen_loader", "Module\n");
165 retval
= grub_fdt_set_reg64 (xen_boot_fdt
, module_node
,
166 xen_boot_address_align (module
->start
,
170 return grub_error (GRUB_ERR_IO
, "failed to update FDT");
172 if (module
->cmdline
&& module
->cmdline_size
> 0)
174 grub_dprintf ("xen_loader",
175 "Module cmdline : %s @ %p size:%d\n",
176 module
->cmdline
, module
->cmdline
, module
->cmdline_size
);
178 retval
= grub_fdt_set_prop (xen_boot_fdt
, module_node
, "bootargs",
179 module
->cmdline
, module
->cmdline_size
+ 1);
181 return grub_error (GRUB_ERR_IO
, "failed to update FDT");
185 grub_dprintf ("xen_loader", "Module has no bootargs!\n");
188 return GRUB_ERR_NONE
;
192 finalize_params_xen_boot (void)
194 struct xen_boot_binary
*module
;
196 grub_size_t additional_size
= 0x1000;
199 additional_size
+= FDT_NODE_NAME_MAX_SIZE
+ xen_hypervisor
->cmdline_size
;
200 FOR_LIST_ELEMENTS (module
, module_head
)
202 additional_size
+= 6 * FDT_NODE_NAME_MAX_SIZE
+ sizeof(MODULE_CUSTOM_COMPATIBLE
) - 1
203 + module
->cmdline_size
;
206 xen_boot_fdt
= grub_fdt_load (additional_size
);
208 return grub_error (GRUB_ERR_IO
, "failed to get FDT");
212 if (prepare_xen_hypervisor_params (xen_boot_fdt
) != GRUB_ERR_NONE
)
217 grub_dprintf ("xen_loader", "Failed to get Xen Hypervisor info!\n");
221 /* Set module params info */
222 FOR_LIST_ELEMENTS (module
, module_head
)
224 if (module
->start
&& module
->size
> 0)
226 grub_dprintf ("xen_loader", "Module @ 0x%lx size:0x%lx\n",
227 xen_boot_address_align (module
->start
, module
->align
),
229 if (prepare_xen_module_params (module
, xen_boot_fdt
) != GRUB_ERR_NONE
)
234 grub_dprintf ("xen_loader", "Module info error!\n");
239 if (grub_fdt_install() == GRUB_ERR_NONE
)
240 return GRUB_ERR_NONE
;
245 return grub_error (GRUB_ERR_IO
, "failed to install/update FDT");
252 grub_err_t err
= finalize_params_xen_boot ();
256 return grub_arm64_uefi_boot_image (xen_hypervisor
->start
,
257 xen_hypervisor
->size
,
258 xen_hypervisor
->cmdline
);
262 single_binary_unload (struct xen_boot_binary
*binary
)
267 if (binary
->start
&& binary
->size
> 0)
269 grub_efi_free_pages ((grub_efi_physical_address_t
) binary
->start
,
270 GRUB_EFI_BYTES_TO_PAGES (binary
->size
+ binary
->align
));
273 if (binary
->cmdline
&& binary
->cmdline_size
> 0)
275 grub_free (binary
->cmdline
);
276 grub_dprintf ("xen_loader",
277 "Module cmdline memory free @ %p size: %d\n",
278 binary
->cmdline
, binary
->cmdline_size
);
281 if (!binary
->is_hypervisor
)
282 grub_list_remove (GRUB_AS_LIST (binary
));
284 grub_dprintf ("xen_loader",
285 "Module struct memory free @ %p size: 0x%lx\n",
286 binary
, sizeof (binary
));
293 all_binaries_unload (void)
295 struct xen_boot_binary
*binary
;
297 FOR_LIST_ELEMENTS (binary
, module_head
)
299 single_binary_unload (binary
);
303 single_binary_unload (xen_hypervisor
);
312 all_binaries_unload ();
314 grub_dl_unref (my_mod
);
316 return GRUB_ERR_NONE
;
320 xen_boot_binary_load (struct xen_boot_binary
*binary
, grub_file_t file
,
321 int argc
, char *argv
[])
323 binary
->size
= grub_file_size (file
);
324 grub_dprintf ("xen_loader", "Xen_boot file size: 0x%lx\n", binary
->size
);
327 = (grub_addr_t
) grub_efi_allocate_any_pages (GRUB_EFI_BYTES_TO_PAGES
332 grub_error (GRUB_ERR_OUT_OF_MEMORY
, N_("out of memory"));
336 grub_dprintf ("xen_loader", "Xen_boot numpages: 0x%lx\n",
337 GRUB_EFI_BYTES_TO_PAGES (binary
->size
+ binary
->align
));
339 if (grub_file_read (file
, (void *) xen_boot_address_align (binary
->start
,
341 binary
->size
) != (grub_ssize_t
) binary
->size
)
343 single_binary_unload (binary
);
344 grub_error (GRUB_ERR_BAD_OS
, N_("premature end of file %s"), argv
[0]);
350 binary
->cmdline_size
= grub_loader_cmdline_size (argc
- 1, argv
+ 1);
351 binary
->cmdline
= grub_zalloc (binary
->cmdline_size
);
352 if (!binary
->cmdline
)
354 single_binary_unload (binary
);
355 grub_error (GRUB_ERR_OUT_OF_MEMORY
, N_("out of memory"));
358 grub_create_loader_cmdline (argc
- 1, argv
+ 1, binary
->cmdline
,
359 binary
->cmdline_size
);
360 grub_dprintf ("xen_loader",
361 "Xen_boot cmdline @ %p %s, size: %d\n",
362 binary
->cmdline
, binary
->cmdline
, binary
->cmdline_size
);
366 binary
->cmdline_size
= 0;
367 binary
->cmdline
= NULL
;
370 grub_errno
= GRUB_ERR_NONE
;
375 grub_cmd_xen_module (grub_command_t cmd
__attribute__((unused
)),
376 int argc
, char *argv
[])
379 struct xen_boot_binary
*module
= NULL
;
380 grub_file_t file
= 0;
385 grub_error (GRUB_ERR_BAD_ARGUMENT
, N_("filename expected"));
389 if (grub_strcmp (argv
[0], "--nounzip") == 0)
398 grub_error (GRUB_ERR_BAD_ARGUMENT
, N_("filename expected"));
404 grub_error (GRUB_ERR_BAD_ARGUMENT
,
405 N_("you need to load the Xen Hypervisor first"));
410 (struct xen_boot_binary
*) grub_zalloc (sizeof (struct xen_boot_binary
));
414 module
->is_hypervisor
= 0;
415 module
->align
= 4096;
417 grub_dprintf ("xen_loader", "Init module and node info\n");
420 grub_file_filter_disable_compression ();
421 file
= grub_file_open (argv
[0]);
425 xen_boot_binary_load (module
, file
, argc
, argv
);
426 if (grub_errno
== GRUB_ERR_NONE
)
427 grub_list_push (GRUB_AS_LIST_P (&module_head
), GRUB_AS_LIST (module
));
431 grub_file_close (file
);
432 if (grub_errno
!= GRUB_ERR_NONE
)
433 single_binary_unload (module
);
439 grub_cmd_xen_hypervisor (grub_command_t cmd
__attribute__ ((unused
)),
440 int argc
, char *argv
[])
442 struct xen_hypervisor_header sh
;
443 grub_file_t file
= NULL
;
445 grub_dl_ref (my_mod
);
449 grub_error (GRUB_ERR_BAD_ARGUMENT
, N_("filename expected"));
453 file
= grub_file_open (argv
[0]);
457 if (grub_file_read (file
, &sh
, sizeof (sh
)) != (long) sizeof (sh
))
459 if (grub_arm64_uefi_check_image
460 ((struct grub_arm64_linux_kernel_header
*) &sh
) != GRUB_ERR_NONE
)
462 grub_file_seek (file
, 0);
464 /* if another module has called grub_loader_set,
465 we need to make sure that another module is unloaded properly */
466 grub_loader_unset ();
469 (struct xen_boot_binary
*) grub_zalloc (sizeof (struct xen_boot_binary
));
473 xen_hypervisor
->is_hypervisor
= 1;
474 xen_hypervisor
->align
= (grub_size_t
) sh
.optional_header
.section_alignment
;
476 xen_boot_binary_load (xen_hypervisor
, file
, argc
, argv
);
477 if (grub_errno
== GRUB_ERR_NONE
)
479 grub_loader_set (xen_boot
, xen_unload
, 0);
485 grub_file_close (file
);
486 if (grub_errno
!= GRUB_ERR_NONE
)
489 all_binaries_unload ();
490 grub_dl_unref (my_mod
);
496 static grub_command_t cmd_xen_hypervisor
;
497 static grub_command_t cmd_xen_module
;
499 GRUB_MOD_INIT (xen_boot
)
502 grub_register_command ("xen_hypervisor", grub_cmd_xen_hypervisor
, 0,
503 N_("Load a xen hypervisor."));
505 grub_register_command ("xen_module", grub_cmd_xen_module
, 0,
506 N_("Load a xen module."));
510 GRUB_MOD_FINI (xen_boot
)
512 grub_unregister_command (cmd_xen_hypervisor
);
513 grub_unregister_command (cmd_xen_module
);