Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id F40FAC36010 for ; Fri, 4 Apr 2025 14:45:58 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1u0iIq-0004Iz-F9; Fri, 04 Apr 2025 10:45:52 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1u0iIn-0004HD-Vl for grub-devel@gnu.org; Fri, 04 Apr 2025 10:45:50 -0400 Received: from mail-il1-x12d.google.com ([2607:f8b0:4864:20::12d]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1u0iIl-0003oo-DJ for grub-devel@gnu.org; Fri, 04 Apr 2025 10:45:49 -0400 Received: by mail-il1-x12d.google.com with SMTP id e9e14a558f8ab-3d4369dbc68so730395ab.1 for ; Fri, 04 Apr 2025 07:45:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1743777946; x=1744382746; darn=gnu.org; h=mime-version:references:in-reply-to:message-id:subject:to:from:date :from:to:cc:subject:date:message-id:reply-to; bh=Nb4psB4wOR+crbDkyDS+Jry/ILFABYf1V76ODZvrvd0=; b=Dt72uYjEVlfPjgli5uLPltMHxxBL7qps1nt19KfhNKFzGb5KT0NrD8c2DqSxQxLQkC KRsGgHUk0bk2L3/HjT4jbFOR8a/pLflg56T5/3ez9HltMSSzqxpuepIbKDijqTfIKyuB S9+6sVGpsVeer8hkFkRZYp/Y7YZV32txaivZf00jRm8pbIiTPWGmgH0PmZGJ00MfCZNd sizVKdjBBSFUr9n8A4rOzC6LQ/KA2gitoCECA86p4d6Ze2k2FWfTK7WkW7eKXeU0F2NG 2FPqHC8k9LejiBdvg50/JyDInOnqmdsTfoTswApkIQ+9nm/BPJX271N1m+LiuPoq9d7T 47wQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1743777946; x=1744382746; h=mime-version:references:in-reply-to:message-id:subject:to:from:date :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=Nb4psB4wOR+crbDkyDS+Jry/ILFABYf1V76ODZvrvd0=; b=Y+vSxTLDh3eOuADKa/H64Rq3oE4RytIS+a7Gsoxdtjotvf7IrBUHF43bC/qWGHf7qz +LQeEXnZF+pQyP0brGUNj8qGWzzozJ1wFoyBhCD8lnBKkYbP9LHlLHfYDnES5fAPeFi6 zK7oJvkG6iQD0VbcnjIiPN+GXfmbk0FwgS2npW30lQiBW5ncmXPk1/+itIhw8Ezo6rOR LXLVDB7fjIhaNZwqr3R9W9dDBYiBA++bOXumX24QMFjbWILBRy1kBGfgw+JCpGUnxWZI X5U209TR5gRzxox2bPZKju6N8huMNBC1rABc9dMI3K1L8UJbmwpZFmRbLEPzzcJHLaK4 oOyw== X-Gm-Message-State: AOJu0YwyOCU3XclwLMGuX89KItpK2J0skYw8AfU6wtvl4BKGl6Ze4k4q 7uwj8A4ihGfUtu5qYU1gxLc9RLyindHyLMsQ5XM4GyBZDfzP/SGDBiTK0Q== X-Gm-Gg: ASbGncvdcy9FIvZBTygB2u3HZanVKckHi8WgFC6YFiolahras9HzgmM5um//xa8flBk aMi/X08slszfcyFDdxaGtWxoL/igOICJ6K0PeNUGnbQJTmya97elqH1Eyg8KSpkAmwT7Mg1C2m5 228RTUYIYBxDU1is0fFkso9L8A6/qBfnUmMqrABVBrQ2Vs62Q8pUZC3tXO8nmggTl1PJDCr83h7 iCVYLDs+qMTIcZtH8XW7QyzxfPuKINXeLMYdwyxGOheIiB+gmGoZ9V1dv080xPpO/36uaLSCtaT 2A0Se9rpS3cwAsS8ERqpb8s8xGKKebqUddqkIBshFQ== X-Google-Smtp-Source: AGHT+IHiUlCh4ApQgiLC2EBRLIbj0wX01V0cXw5es63DMlZ+IzwVAMURCPpweWq0KnuildqzjtTEfQ== X-Received: by 2002:a92:cdae:0:b0:3d5:be78:a09a with SMTP id e9e14a558f8ab-3d6e3f7574bmr10710455ab.5.1743777945656; Fri, 04 Apr 2025 07:45:45 -0700 (PDT) Received: from kf-m2g5 ([2607:fb90:cf8f:c3b4:84e1:f685:d52:5be5]) by smtp.gmail.com with ESMTPSA id 8926c6da1cb9f-4f4b5c2dfb7sm851991173.11.2025.04.04.07.45.45 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 04 Apr 2025 07:45:45 -0700 (PDT) Date: Fri, 4 Apr 2025 09:45:42 -0500 From: Aaron Rainbolt To: grub-devel@gnu.org Subject: [DRAFT PATCH 1/1] Add Xen command line parsing Message-ID: <20250404094542.0f919598@kf-m2g5> In-Reply-To: <20250404094446.6bdb8259@kf-m2g5> References: <20250404094446.6bdb8259@kf-m2g5> X-Mailer: Claws Mail 4.3.1 (GTK 3.24.41; x86_64-pc-linux-gnu) MIME-Version: 1.0 Received-SPF: pass client-ip=2607:f8b0:4864:20::12d; envelope-from=arraybolt3@gmail.com; helo=mail-il1-x12d.google.com X-Spam_score_int: -17 X-Spam_score: -1.8 X-Spam_bar: - X-Spam_report: (-1.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_ENVFROM_END_DIGIT=0.25, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: The development of GNU GRUB Content-Type: multipart/mixed; boundary="===============1545644263147724960==" Errors-To: grub-devel-bounces+grub-devel=archiver.kernel.org@gnu.org Sender: grub-devel-bounces+grub-devel=archiver.kernel.org@gnu.org --===============1545644263147724960== Content-Type: multipart/signed; boundary="Sig_/9ZfZx8Ir1K9MJOKNRLLq.FD"; protocol="application/pgp-signature"; micalg=pgp-sha512 --Sig_/9ZfZx8Ir1K9MJOKNRLLq.FD Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: quoted-printable Enable GRUB to parse the Xen command line for parameters, and expose those parameters to the GRUB config file (or rescue shell) as environment variables. --- grub-core/Makefile.core.def | 4 +- grub-core/kern/i386/xen/pvh.c | 16 +++ grub-core/kern/main.c | 12 ++ grub-core/kern/xen/cmdline.c | 223 ++++++++++++++++++++++++++++++++++ include/grub/xen.h | 2 + 5 files changed, 256 insertions(+), 1 deletion(-) create mode 100644 grub-core/kern/xen/cmdline.c diff --git a/grub-core/Makefile.core.def b/grub-core/Makefile.core.def index f70e02e69..cd6dfeb3c 100644 --- a/grub-core/Makefile.core.def +++ b/grub-core/Makefile.core.def @@ -248,6 +248,7 @@ kernel =3D { xen =3D term/xen/console.c; xen =3D disk/xen/xendisk.c; xen =3D commands/boot.c; + xen =3D kern/xen/cmdline.c; i386_xen_pvh =3D commands/boot.c; i386_xen_pvh =3D disk/xen/xendisk.c; @@ -255,6 +256,7 @@ kernel =3D { i386_xen_pvh =3D kern/i386/xen/tsc.c; i386_xen_pvh =3D kern/i386/xen/pvh.c; i386_xen_pvh =3D kern/xen/init.c; + i386_xen_pvh =3D kern/xen/cmdline.c; i386_xen_pvh =3D term/xen/console.c; ia64_efi =3D kern/ia64/efi/startup.S; @@ -468,7 +470,7 @@ image =3D { i386_pc =3D boot/i386/pc/boot.S; cppflags =3D '-DHYBRID_BOOT=3D1'; - + i386_pc_ldflags =3D '$(TARGET_IMG_LDFLAGS)'; i386_pc_ldflags =3D '$(TARGET_IMG_BASE_LDOPT),0x7C00'; diff --git a/grub-core/kern/i386/xen/pvh.c b/grub-core/kern/i386/xen/pvh.c index 91fbca859..9fb048082 100644 --- a/grub-core/kern/i386/xen/pvh.c +++ b/grub-core/kern/i386/xen/pvh.c @@ -352,6 +352,22 @@ grub_xen_setup_pvh (void) grub_xen_mm_init_regions (); grub_rsdp_addr =3D pvh_start_info->rsdp_paddr; + int xen_cmdline_fits =3D 0; + char *xen_cmdline =3D (char *) pvh_start_info->cmdline_paddr; + for (int i =3D 0; i < 1024; i++) + { + if (xen_cmdline[i] =3D=3D '\0') + { + xen_cmdline_fits =3D 1; + break; + } + } + if (xen_cmdline_fits =3D=3D 1) + { + grub_strncpy ((char *) grub_xen_start_page_addr->cmd_line, + (char *) pvh_start_info->cmdline_paddr, + MAX_GUEST_CMDLINE); + } } grub_err_t diff --git a/grub-core/kern/main.c b/grub-core/kern/main.c index 143a232b8..b4377d3ee 100644 --- a/grub-core/kern/main.c +++ b/grub-core/kern/main.c @@ -37,6 +37,10 @@ #include #endif +#if defined (GRUB_MACHINE_XEN) || defined (GRUB_MACHINE_XEN_PVH) +#include +#endif + static bool cli_disabled =3D false; static bool cli_need_auth =3D false; @@ -351,6 +355,14 @@ grub_main (void) grub_env_export ("root"); grub_env_export ("prefix"); + /* + * Parse command line parameters from Xen and export them as environment + * variables + */ +#if defined (GRUB_MACHINE_XEN) || defined (GRUB_MACHINE_XEN_PVH) + grub_parse_xen_cmdline (); +#endif + /* Reclaim space used for modules. */ reclaim_module_space (); diff --git a/grub-core/kern/xen/cmdline.c b/grub-core/kern/xen/cmdline.c new file mode 100644 index 000000000..7626799f8 --- /dev/null +++ b/grub-core/kern/xen/cmdline.c @@ -0,0 +1,223 @@ +/* + * GRUB -- GRand Unified Bootloader + * Copyright (C) 2025 Free Software Foundation, Inc. + * + * GRUB is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * GRUB is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with GRUB. If not, see . + */ + +#include +#include +#include +#include + +#define PARSER_HIT_BACKSLASH 0x1 +#define PARSER_IN_SINGLE_QUOTES 0x2 +#define PARSER_IN_DOUBLE_QUOTES 0x4 +#define PARSER_BASE_WORD_LEN 16 + +grub_size_t word_list_len; +char **word_list; +grub_size_t current_word_len; +grub_size_t current_word_pos; +char *current_word; +char current_char; +grub_size_t param_dict_len; +char **param_keys; +char **param_vals; + +static void +append_char_to_word (void) +{ + if (current_word_pos =3D=3D current_word_len) + { + current_word_len *=3D 2; + current_word =3D grub_realloc (current_word, current_word_len); + } + + current_word[current_word_pos] =3D current_char; + current_word_pos++; +} + +static void +append_word_to_list (void) +{ + for (grub_size_t i =3D 0; i < current_word_pos; i++) + { + if (current_word[i] <=3D 0x1F || current_word[i] >=3D 0x7F) + { + grub_free (current_word); + goto reset_word; + } + } + current_char =3D '\0'; + append_char_to_word (); + current_word_len =3D grub_strlen (current_word) + 1; + current_word =3D grub_realloc (current_word, current_word_len); + word_list_len++; + word_list =3D grub_realloc (word_list, word_list_len * sizeof (char *)); + word_list[word_list_len - 1] =3D current_word; + +reset_word: + current_word_len =3D PARSER_BASE_WORD_LEN; + current_word_pos =3D 0; + current_word =3D grub_malloc (current_word_len); +} + +int +check_key_is_safe (char *key, grub_size_t len) +{ + /* + * Ensure only a-z, A-Z, and _ are allowed. + */ + for (grub_size_t i =3D 0; i < len; i++) + { + if (! ((key[i] >=3D 'A' && key[i] <=3D 'Z') + || (key[i] >=3D 'a' && key[i] <=3D 'z') + || (key[i] =3D=3D '_') ) ) + { + return 0; + } + } + return 1; +} + +void +grub_parse_xen_cmdline (void) +{ + word_list =3D grub_malloc (0); + current_word_len =3D PARSER_BASE_WORD_LEN; + current_word =3D grub_malloc (current_word_len); + param_keys =3D grub_malloc (0); + param_vals =3D grub_malloc (0); + + grub_uint8_t parse_flags =3D 0; + char *cmdline =3D (char *)grub_xen_start_page_addr->cmd_line; + + for (grub_size_t i =3D 0; i < grub_strlen (cmdline); i++) + { + current_char =3D cmdline[i]; + + if (parse_flags & PARSER_HIT_BACKSLASH) + { + parse_flags ^=3D PARSER_HIT_BACKSLASH; + append_char_to_word (); + continue; + } + + if (current_char =3D=3D '\\') + { + parse_flags ^=3D PARSER_HIT_BACKSLASH; + continue; + } + + if (current_char =3D=3D '\'') + { + if (parse_flags & PARSER_IN_DOUBLE_QUOTES) + { + append_char_to_word (); + continue; + } + + parse_flags ^=3D PARSER_IN_SINGLE_QUOTES; + continue; + } + + if (current_char =3D=3D '"') + { + if (parse_flags & PARSER_IN_SINGLE_QUOTES) + { + append_char_to_word (); + continue; + } + + parse_flags ^=3D PARSER_IN_DOUBLE_QUOTES; + continue; + } + + if (current_char =3D=3D ' ') + { + if (parse_flags & PARSER_IN_SINGLE_QUOTES + || parse_flags & PARSER_IN_DOUBLE_QUOTES) + { + append_char_to_word (); + continue; + } + + append_word_to_list (); + continue; + } + + append_char_to_word (); + } + + if (current_word_pos > 0) + { + append_word_to_list (); + } + + param_keys =3D grub_realloc (param_keys, word_list_len * sizeof (char *)= ); + param_vals =3D grub_realloc (param_vals, word_list_len * sizeof (char *)= ); + for (grub_size_t i =3D 0; i < word_list_len; i++) + { + current_word =3D word_list[i]; + current_word_len =3D grub_strlen (current_word) + 1; + char *current_word_eq_ptr =3D grub_strchr (current_word, '=3D'); + if (current_word_eq_ptr) + { + grub_size_t eq_idx + =3D (grub_size_t)(current_word_eq_ptr - current_word); + grub_size_t pre_eq_len + =3D current_word_len - (current_word_len - eq_idx); + grub_size_t post_eq_len =3D current_word_len - eq_idx - 1; + if (check_key_is_safe (current_word, pre_eq_len)) + { + param_keys[param_dict_len] =3D grub_malloc (pre_eq_len + 1); + param_vals[param_dict_len] =3D grub_malloc (post_eq_len + 1); + grub_strncpy (param_keys[param_dict_len], + current_word, pre_eq_len); + grub_strncpy (param_vals[param_dict_len], + current_word + pre_eq_len + 1, post_eq_len); + param_keys[param_dict_len][pre_eq_len] =3D '\0'; + param_vals[param_dict_len][post_eq_len] =3D '\0'; + param_dict_len++; + } + } + else + { + if (check_key_is_safe (current_word, current_word_len - 1)) + { + param_keys[param_dict_len] =3D grub_malloc (current_word_len= + 1); + param_vals[param_dict_len] =3D grub_malloc (2); + grub_strncpy (param_keys[param_dict_len], + current_word, current_word_len); + param_keys[param_dict_len][current_word_len] =3D '\0'; + grub_strcpy (param_vals[param_dict_len], "1\0"); + param_dict_len++; + } + } + } + + for (grub_size_t i =3D 0; i < param_dict_len; i++) + { + grub_env_set (param_keys[i], param_vals[i]); + grub_env_export (param_keys[i]); + grub_free (param_keys[i]); + grub_free (param_vals[i]); + grub_free (word_list[i]); + } + + grub_free (param_keys); + grub_free (param_vals); + grub_free (word_list); +} diff --git a/include/grub/xen.h b/include/grub/xen.h index 91cb7cf81..7f9efee80 100644 --- a/include/grub/xen.h +++ b/include/grub/xen.h @@ -89,6 +89,8 @@ void grub_console_init (void); void grub_xendisk_fini (void); void grub_xendisk_init (void); +void grub_parse_xen_cmdline (void); + #ifdef __x86_64__ typedef grub_uint64_t grub_xen_mfn_t; #else -- 2.43.0 --Sig_/9ZfZx8Ir1K9MJOKNRLLq.FD Content-Type: application/pgp-signature Content-Description: OpenPGP digital signature -----BEGIN PGP SIGNATURE----- iQIzBAEBCgAdFiEEudh48PFXwyPDa0wGpwkWDXPHkQkFAmfv8JYACgkQpwkWDXPH kQl2iQ//SKjsEpkRNrWa68e4Pmbd5VtwPCY0NLVzSqwG7QBFI2zm42FH9BIAkgOE vBHzN1K7CoOitEugV7ZJcVVgRb7hfhlObT07KQQhd8kfHLmNWKVBODqCCOoIKqUX q6SdjMvcvl/ehC7igIePu05IBfMsC4g2zOVc5ithZJhOnL7K3CimjoAAcYeocaAb tHOXJC2zjzuAUYb7NCb6hpSCmbJ3CevoJP+ru9b4XqMGVZA1oEJ4QUAMoJmW6zr1 4dljKnTMHQ1MHVeTxWQhuzDmtk12xsu81ME0oZ2Zo+I1k3udxJOqCH/WeYTyMme1 dlYdE48km9ONNZnJrNvMVL2b3D/WqHlQMm9ofk5D1HUMnL75fcR74IPzHHWuqFgO Lh1+5zkMjFvP/9J00Hen4SjQoPLqKldonMg/uUuudRMApBH3CfipXRpwVH4IHKd7 BzCeRJnvMIcngh/3sYF9umbFHTAzGAOaWpVXHYBpLe7HJp44cfBxeTKScgGAqED4 ceQOe4OKzVT9W5MVZ7t7SsUzU7nEq9gCFQlJQY8RuZNVnNzco0cJKejtr1UVLZZl vw1l8vHys6u9PBVLatVHP97Cd6hiOSPNyQsBAu/K7rFyq7eXgS2wXcJ6LPU2MRV6 0ndz66tqBFB3YNang2VLbySHjnEjShSyBbaPAix4sRhhSGZs0eY= =Obka -----END PGP SIGNATURE----- --Sig_/9ZfZx8Ir1K9MJOKNRLLq.FD-- --===============1545644263147724960== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: inline X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX18KR3J1Yi1kZXZl bCBtYWlsaW5nIGxpc3QKR3J1Yi1kZXZlbEBnbnUub3JnCmh0dHBzOi8vbGlzdHMuZ251Lm9yZy9t YWlsbWFuL2xpc3RpbmZvL2dydWItZGV2ZWwK --===============1545644263147724960==--