Merge pull request #1554 from jeckersb/kernel-cmdline-crate

Move kernel cmdline parsing to dedicated crate

Author: cgwalters

Cargo.lock

@@ -0,0 +1,18 @@
+[package]
+name = "bootc-kernel-cmdline"
+description = "Kernel command line parsing utilities for bootc"
+version = "0.0.0"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/bootc-dev/bootc"
+
+[dependencies]
+# Workspace dependencies
+anyhow = { workspace = true }
+
+[dev-dependencies]
+similar-asserts = { workspace = true }
+static_assertions = { workspace = true }
+
+[lints]
+workspace = true

crates/kernel_cmdline/Cargo.toml

@@ -8,16 +8,17 @@ use std::borrow::Cow;
 use anyhow::Result;
 
 /// This is used by dracut.
-pub(crate) const INITRD_ARG_PREFIX: &str = "rd.";
+pub const INITRD_ARG_PREFIX: &str = "rd.";
 /// The kernel argument for configuring the rootfs flags.
-pub(crate) const ROOTFLAGS: &str = "rootflags";
+pub const ROOTFLAGS: &str = "rootflags";
 
 /// A parsed kernel command line.
 ///
 /// Wraps the raw command line bytes and provides methods for parsing and iterating
 /// over individual parameters. Uses copy-on-write semantics to avoid unnecessary
 /// allocations when working with borrowed data.
-pub(crate) struct Cmdline<'a>(Cow<'a, [u8]>);
+#[derive(Debug)]
+pub struct Cmdline<'a>(Cow<'a, [u8]>);
 
 impl<'a, T: AsRef<[u8]> + ?Sized> From<&'a T> for Cmdline<'a> {
     /// Creates a new `Cmdline` from any type that can be referenced as bytes.
@@ -128,7 +129,7 @@ impl<'a> Cmdline<'a> {
 ///
 /// Handles quoted values and treats dashes and underscores in keys as equivalent.
 #[derive(Debug, Eq)]
-pub(crate) struct ParameterKey<'a>(&'a [u8]);
+pub struct ParameterKey<'a>(&'a [u8]);
 
 impl<'a> std::ops::Deref for ParameterKey<'a> {
     type Target = [u8];
@@ -148,7 +149,7 @@ impl<'a> From<&'a [u8]> for ParameterKey<'a> {
 ///
 /// Otherwise the same as [`ParameterKey`].
 #[derive(Debug, Eq)]
-pub(crate) struct ParameterKeyStr<'a>(&'a str);
+pub struct ParameterKeyStr<'a>(&'a str);
 
 impl<'a> From<&'a str> for ParameterKeyStr<'a> {
     fn from(value: &'a str) -> Self {
@@ -158,7 +159,7 @@ impl<'a> From<&'a str> for ParameterKeyStr<'a> {
 
 /// A single kernel command line parameter.
 #[derive(Debug, Eq)]
-pub(crate) struct Parameter<'a> {
+pub struct Parameter<'a> {
     /// The full original value
     pub parameter: &'a [u8],
     /// The parameter key as raw bytes
@@ -169,7 +170,7 @@ pub(crate) struct Parameter<'a> {
 
 /// A single kernel command line parameter.
 #[derive(Debug, PartialEq, Eq)]
-pub(crate) struct ParameterStr<'a> {
+pub struct ParameterStr<'a> {
     /// The original value
     pub parameter: &'a str,
     /// The parameter key
@@ -179,6 +180,9 @@ pub(crate) struct ParameterStr<'a> {
 }
 
 impl<'a> Parameter<'a> {
+    /// Convert this parameter to a UTF-8 string parameter, if possible.
+    ///
+    /// Returns `None` if the parameter contains invalid UTF-8.
     pub fn to_str(&self) -> Option<ParameterStr<'a>> {
         let Ok(parameter) = std::str::from_utf8(self.parameter) else {
             return None;

crates/lib/src/kernel_cmdline.rs renamed to crates/kernel_cmdline/src/lib.rs

@@ -16,6 +16,7 @@ include = ["/src", "LICENSE-APACHE", "LICENSE-MIT"]
 [dependencies]
 # Internal crates
 bootc-blockdev = { package = "bootc-internal-blockdev", path = "../blockdev", version = "0.0.0" }
+bootc-kernel-cmdline = { path = "../kernel_cmdline", version = "0.0.0" }
 bootc-mount = { path = "../mount" }
 bootc-sysusers = { path = "../sysusers" }
 bootc-tmpfiles = { path = "../tmpfiles" }

crates/lib/Cargo.toml

@@ -56,13 +56,13 @@ use self::baseline::InstallBlockDeviceOpts;
 use crate::boundimage::{BoundImage, ResolvedBoundImage};
 use crate::containerenv::ContainerExecutionInfo;
 use crate::deploy::{prepare_for_pull, pull_from_prepared, PreparedImportMeta, PreparedPullResult};
-use crate::kernel_cmdline::Cmdline;
 use crate::lsm;
 use crate::progress_jsonl::ProgressWriter;
 use crate::spec::ImageReference;
 use crate::store::Storage;
 use crate::task::Task;
 use crate::utils::sigpolicy_from_opt;
+use bootc_kernel_cmdline::Cmdline;
 use bootc_mount::Filesystem;
 
 /// The toplevel boot directory
@@ -1639,9 +1639,9 @@ fn find_root_args_to_inherit(cmdline: &Cmdline, root_info: &Filesystem) -> Resul
         .context("Parsing root= karg")?;
     // If we have a root= karg, then use that
     let (mount_spec, kargs) = if let Some(root) = root {
-        let rootflags = cmdline.find_str(crate::kernel_cmdline::ROOTFLAGS);
+        let rootflags = cmdline.find_str(bootc_kernel_cmdline::ROOTFLAGS);
         let inherit_kargs =
-            cmdline.find_all_starting_with_str(crate::kernel_cmdline::INITRD_ARG_PREFIX);
+            cmdline.find_all_starting_with_str(bootc_kernel_cmdline::INITRD_ARG_PREFIX);
         (
             root.to_owned(),
             rootflags

crates/lib/src/install.rs

@@ -34,7 +34,6 @@ mod docgen;
 mod bootloader;
 mod containerenv;
 mod install;
-mod kernel_cmdline;
 
 #[cfg(feature = "composefs-backend")]
 #[allow(dead_code)]