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 C76D9C369CB for ; Thu, 24 Apr 2025 02:48:34 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1u7mdH-0007HM-CI; Wed, 23 Apr 2025 22:48:12 -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 1u7md2-0007At-Td for grub-devel@gnu.org; Wed, 23 Apr 2025 22:47:59 -0400 Received: from mail-il1-x129.google.com ([2607:f8b0:4864:20::129]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1u7mcz-0007e8-VX for grub-devel@gnu.org; Wed, 23 Apr 2025 22:47:56 -0400 Received: by mail-il1-x129.google.com with SMTP id e9e14a558f8ab-3cffaa0962eso115545ab.3 for ; Wed, 23 Apr 2025 19:47:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1745462871; x=1746067671; 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=C4oVKbRKZbXHUStAlr5Pc8YKssGePPBna1/m45wN4gw=; b=fwBxJioCbGni2IUPvV4SlcLtCsu0ZYdUSHQjKSAiPquYvfLWoKYZthH7V82Sr/CS++ M7ozDiT+1ZtXb5TQ8xbXy7nwe2LpyJyUdsfqmtiPXnr/RBSfiiLjWGKN6vvETrW2kObv CHK1DyfUeqREJnssHRi9TbqLIuXts6Bs5YFLTou7gBgYib0bJgUrt1ZiY9Zu0jkm78WJ CfjgUC9cIu3ykLKVJd4qYueoogUCI6wwpG9ZShoCLkGhW9LzY7fV3wtGmhRC6Zsz0mX6 BAEMuylLVH5bbq1CGbluG0iQ4jlFn1w3rH0pQeMqt/jIR5jC1LWnPxJ45UoR+59kvYCc qjAA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1745462871; x=1746067671; 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=C4oVKbRKZbXHUStAlr5Pc8YKssGePPBna1/m45wN4gw=; b=GfkRSsQBVIPtOkh4Sr/9X+19O2C+PDt9938tckU4ZY1KkPtIVj0CNuKoA5rhgHVFiA So09cxTZOUBNiYOgRTbRlLhtmOpTm6izTgzg23vad9z6S8iIZYGmqNdXZ1k4/v1Pyjzf 8n7v+u2FKXxTztHq+EdIzwauprSb8P6zv+w6xtpHTl8FVFRoSPw0s1kKXpLDs6m3p1md hb48+6q9uZWILrfGfCQ+vT8Q4vLf1Z1zF/XDGXUwjmuGHLqD7DETUaigtDXwIAajFDYX mnjc+oKtRKCFpcIAlCSbhjuusjecFsDXLy72jzysZ6iA8jG1DtAPKTtEQcOHwLFLB5SY jV/w== X-Gm-Message-State: AOJu0YzIPAXDSqEz1G9Z9WPAoNhMy9OuBfAweXz0rfSbQWGJwphMkVQI ScRWD/DP3B7cuJ4Bj+qItlnM6apBdbZ0f0NiCjfZNuprhAomsA2MyPrd0qP6 X-Gm-Gg: ASbGncvVbhW75aUNq2VMuLx3aWqHad7ZCJ1ZZAGNARUvy3mYljoAo+Rs2B4sTWVUWMa n7sKhlHJUBUpQhuAmLcp7W4NCpNfFPONFmqDMlDA8TwlSmI18uO5FUym0ZLnk0bseaVH8QxhRMy Dt3+tWX1HuTlrMpmL1A+B7Tmjv+uWwpKph66HNdPYwctaFNcigGDVHqKkdPjKCvLtLX523PKdra y1PaxoBE66JJKU0yfgf3LNWv0GFR3jsssHyS12gaA2WrKgYbN9d3sdfT2VoBadIVKDsL1Lt4mkx mLyQH4cVfrZ6NlVhe1kEe1Z1K352eL18rRJr+pk= X-Google-Smtp-Source: AGHT+IF6V2nZwTcfdT1exVu+nKuD8GZDmepkrAhGOcFhYayakA8U/QMEoNHmxYho3QXMFWsaQ/ZpOQ== X-Received: by 2002:a05:6e02:1fc9:b0:3d5:be78:a09a with SMTP id e9e14a558f8ab-3d930467250mr2385205ab.5.1745462871339; Wed, 23 Apr 2025 19:47:51 -0700 (PDT) Received: from kf-m2g5 ([2607:fb90:cf1d:8c21:c767:68fc:f6f5:fe2a]) by smtp.gmail.com with ESMTPSA id e9e14a558f8ab-3d9314f5637sm821355ab.35.2025.04.23.19.47.50 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 23 Apr 2025 19:47:50 -0700 (PDT) Date: Wed, 23 Apr 2025 21:47:48 -0500 From: Aaron Rainbolt To: grub-devel@gnu.org Subject: [PATCH 1/1] Add Xen command line parsing Message-ID: <20250423214748.0e6f2ee1@kf-m2g5> In-Reply-To: <20250423214615.23d46d47@kf-m2g5> References: <20250423214615.23d46d47@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::129; envelope-from=arraybolt3@gmail.com; helo=mail-il1-x129.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="===============0999902194872115951==" Errors-To: grub-devel-bounces+grub-devel=archiver.kernel.org@gnu.org Sender: grub-devel-bounces+grub-devel=archiver.kernel.org@gnu.org --===============0999902194872115951== Content-Type: multipart/signed; boundary="Sig_/4Oy3yXEnma+lBzlUgSZNz5k"; protocol="application/pgp-signature"; micalg=pgp-sha512 --Sig_/4Oy3yXEnma+lBzlUgSZNz5k Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: quoted-printable Enable GRUB to parse the Xen command line for parameters, and expose certain of those parameters to the GRUB config file (or rescue shell) as environment variables. --- grub-core/Makefile.core.def | 2 + grub-core/kern/i386/xen/pvh.c | 16 ++ grub-core/kern/main.c | 12 ++ grub-core/kern/xen/cmdline.c | 270 ++++++++++++++++++++++++++++++++++ include/grub/xen.h | 2 + 5 files changed, 302 insertions(+) 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..79e681a7b 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; =20 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; =20 ia64_efi =3D kern/ia64/efi/startup.S; 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 (); =20 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); + } } =20 grub_err_t diff --git a/grub-core/kern/main.c b/grub-core/kern/main.c index 143a232b8..f96b16f73 100644 --- a/grub-core/kern/main.c +++ b/grub-core/kern/main.c @@ -40,6 +40,10 @@ static bool cli_disabled =3D false; static bool cli_need_auth =3D false; =20 +#if defined (GRUB_MACHINE_XEN) || defined (GRUB_MACHINE_XEN_PVH) +#include +#endif + grub_addr_t grub_modules_get_end (void) { @@ -351,6 +355,14 @@ grub_main (void) grub_env_export ("root"); grub_env_export ("prefix"); =20 + /* + * 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 (); =20 diff --git a/grub-core/kern/xen/cmdline.c b/grub-core/kern/xen/cmdline.c new file mode 100644 index 000000000..0084f3e77 --- /dev/null +++ b/grub-core/kern/xen/cmdline.c @@ -0,0 +1,270 @@ +/* + * 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 bool +append_char_to_word (bool allow_null) +{ + if (!(current_char >=3D 0x20) || !(current_char <=3D 0x7E)) + { + if (current_char !=3D '\0' || !allow_null) + { + return false; + } + } + 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++; + return true; +} + +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'; + if (!append_char_to_word (true)) + { + grub_error (GRUB_ERR_BUG, N_("couldn't append null terminator to wor= d during Xen cmdline parsing")); + grub_print_error (); + grub_exit (); + } + 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; + if (!append_char_to_word (false)) + { + goto cleanup; + } + 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) + { + if (!append_char_to_word (false)) + { + goto cleanup; + } + continue; + } + + parse_flags ^=3D PARSER_IN_SINGLE_QUOTES; + continue; + } + + if (current_char =3D=3D '"') + { + if (parse_flags & PARSER_IN_SINGLE_QUOTES) + { + if (!append_char_to_word (false)) + { + goto cleanup; + } + 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) + { + if (!append_char_to_word (false)) + { + goto cleanup; + } + continue; + } + + append_word_to_list (); + continue; + } + + if (!append_char_to_word (false)) + { + goto cleanup; + } + } + + 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++) + { + /*=20 + * Find keys that start with "xen_grub_env_" and export them + * as environment variables. + */ + if (grub_strlen (param_keys[i]) < (sizeof ("xen_grub_env_") - 1)) + { + continue; + } + if (grub_strncmp (param_keys[i], + "xen_grub_env_", + sizeof ("xen_grub_env_") - 1) !=3D 0) + { + continue; + } + 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]); + } + +cleanup: =20 + for (grub_size_t i =3D 0; i < word_list_len; 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); =20 +void grub_parse_xen_cmdline (void); + #ifdef __x86_64__ typedef grub_uint64_t grub_xen_mfn_t; #else --=20 2.49.0 --Sig_/4Oy3yXEnma+lBzlUgSZNz5k Content-Type: application/pgp-signature Content-Description: OpenPGP digital signature -----BEGIN PGP SIGNATURE----- iQIzBAEBCgAdFiEEudh48PFXwyPDa0wGpwkWDXPHkQkFAmgJplQACgkQpwkWDXPH kQkcZA/9ENp71HYVMyPdTtE73tghXo9Tg8zBUOwxXX5Tn2HsGoni3pUkHN5rBM+z yzWNN5pc94Y8HX/6OwUE+AzFQZMInm/XrI09sOaXdJgLJo0jPd/9OFdbUSROI4Ph XUsNZe/+I9AxcfU1uMoDPeVx+PQINRyvyuTZE68U50MCAUgFeOfGOlnsNRfrBSHX YHK0li8oMz1CusoLv/tDaA/pEiTNfedRtJ1DK7H57RizIplVmNrWfnN7vXgqwFKv x3ic9qjd+OsliPP6wGdsfWczG6HMz/txTUpnMj9sHAF7djyEbhqw456p4y9SpPhv 4F87aezvVHPN878v+wiNK0xaZYYE0EXtNCK33EU+J/k7NvTfErQ7/A1nlCvm3SfB COcZzSBoiPYZkVT78dbuaiQuGqZmkun5PHM1TxUIfcHwqi0hq5v47gdyp20Fjnop psNk5ae6FR37Vlg5nd5TNxQUv98W59SIUmDKw9emGpugvADf9tKXAnyZnXcfeKRJ VdJnjN3kA2IlaMeVl7o3+Nm+dGYy4d4lVCIyyUtkOT68DJv52xgBglmRidtmvTR9 eW60jlt9+qIAYofTHjMnNdqRnWebTH8Ou5ZVwWm1PiOs9V8nzNZfIfeZyyOdweFf SKmEzTf393MQF8C7fD8DaFOXvgy4DqAjOMccqEnZHESQ0En0UvI= =6+gg -----END PGP SIGNATURE----- --Sig_/4Oy3yXEnma+lBzlUgSZNz5k-- --===============0999902194872115951== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: inline X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX18KR3J1Yi1kZXZl bCBtYWlsaW5nIGxpc3QKR3J1Yi1kZXZlbEBnbnUub3JnCmh0dHBzOi8vbGlzdHMuZ251Lm9yZy9t YWlsbWFuL2xpc3RpbmZvL2dydWItZGV2ZWwK --===============0999902194872115951==--