Rename imgstorage/Storage -> CStorage

Previously we had two different `Storage` structs, this
ensures that the main one is primary and `CStorage` is secondary.

This should be less confusing.

Signed-off-by: Colin Walters <[email protected]>

Author: cgwalters

crates/lib/src/boundimage.rs

@@ -13,7 +13,7 @@ use fn_error_context::context;
 use ostree_ext::containers_image_proxy;
 use ostree_ext::ostree::Deployment;
 
-use crate::imgstorage::PullMode;
+use crate::imgstorage::{CStorage, PullMode};
 use crate::store::Storage;
 
 /// The path in a root for bound images; this directory should only contain
@@ -158,7 +158,7 @@ pub(crate) async fn pull_images(
 
 #[context("Pulling bound images")]
 pub(crate) async fn pull_images_impl(
-    imgstore: &crate::imgstorage::Storage,
+    imgstore: &CStorage,
     bound_images: Vec<crate::boundimage::BoundImage>,
 ) -> Result<()> {
     let n = bound_images.len();

crates/lib/src/image.rs

@@ -14,7 +14,7 @@ use serde::Serialize;
 use crate::{
     boundimage::query_bound_images,
     cli::{ImageListFormat, ImageListType},
-    imgstorage::ensure_floating_c_storage_initialized,
+    imgstorage::{ensure_floating_c_storage_initialized, CStorage},
 };
 
 /// The name of the image we push to containers-storage if nothing is specified.
@@ -172,7 +172,7 @@ pub(crate) async fn push_entrypoint(source: Option<&str>, target: Option<&str>)
 /// Thin wrapper for invoking `podman image <X>` but set up for our internal
 /// image store (as distinct from /var/lib/containers default).
 pub(crate) async fn imgcmd_entrypoint(
-    storage: &crate::imgstorage::Storage,
+    storage: &CStorage,
     arg: &str,
     args: &[std::ffi::OsString],
 ) -> std::result::Result<(), anyhow::Error> {

crates/lib/src/imgstorage.rs

@@ -1,9 +1,12 @@
-//! # bootc-managed container storage
+//! # bootc-managed instance of containers-storage:
 //!
-//! The default storage for this project uses ostree, canonically storing all of its state in
-//! `/sysroot/ostree`.
+//! The backend for podman and other tools is known as `container-storage:`,
+//! with a canonical instance that lives in `/var/lib/containers`.
 //!
-//! This containers-storage: which canonically lives in `/sysroot/ostree/bootc`.
+//! This is a `containers-storage:` instance` which is owned by bootc and
+//! is stored at `/sysroot/ostree/bootc`.
+//!
+//! At the current time, this is only used for Logically Bound Images.
 
 use std::collections::HashSet;
 use std::io::Seek;
@@ -43,7 +46,9 @@ pub(crate) const SUBPATH: &str = "storage";
 /// The path to the "runroot" with transient runtime state; this is
 /// relative to the /run directory
 const RUNROOT: &str = "bootc/storage";
-pub(crate) struct Storage {
+
+/// A bootc-owned instance of `containers-storage:`.
+pub(crate) struct CStorage {
     /// The root directory
     sysroot: Dir,
     /// The location of container storage
@@ -147,7 +152,7 @@ pub(crate) fn ensure_floating_c_storage_initialized() {
     }
 }
 
-impl Storage {
+impl CStorage {
     /// Create a `podman image` Command instance prepared to operate on our alternative
     /// root.
     pub(crate) fn new_image_cmd(&self) -> Result<Command> {
@@ -380,5 +385,5 @@ impl Storage {
 #[cfg(test)]
 mod tests {
     use super::*;
-    static_assertions::assert_not_impl_any!(Storage: Sync);
+    static_assertions::assert_not_impl_any!(CStorage: Sync);
 }

crates/lib/src/install/completion.rs

@@ -14,6 +14,7 @@ use ostree_ext::{gio, ostree};
 use rustix::fs::Mode;
 use rustix::fs::OFlags;
 
+use crate::imgstorage::CStorage;
 use crate::utils::deployment_fd;
 
 use super::config;
@@ -297,8 +298,7 @@ pub(crate) async fn impl_completion(
 
         // When we're run through ostree, we only lazily initialize the podman storage to avoid
         // having a hard dependency on it.
-        let imgstorage =
-            &crate::imgstorage::Storage::create(&sysroot_dir, &rundir, sepolicy.as_ref())?;
+        let imgstorage = &CStorage::create(&sysroot_dir, &rundir, sepolicy.as_ref())?;
         crate::boundimage::pull_images_impl(imgstorage, bound_images)
             .await
             .context("pulling bound images")?;

crates/lib/src/store/mod.rs

@@ -30,6 +30,7 @@ use ostree_ext::ostree;
 use ostree_ext::sysroot::SysrootLock;
 use rustix::fs::Mode;
 
+use crate::imgstorage::CStorage;
 use crate::lsm;
 use crate::spec::ImageStatus;
 use crate::utils::deployment_fd;
@@ -60,7 +61,7 @@ pub(crate) struct Storage {
     /// The composefs storage
     composefs: OnceCell<Arc<ComposefsRepository>>,
     /// The containers-image storage used foR LBIs
-    imgstore: OnceCell<crate::imgstorage::Storage>,
+    imgstore: OnceCell<CStorage>,
 
     /// Our runtime state
     run: Dir,
@@ -113,7 +114,7 @@ impl Storage {
     }
 
     /// Access the image storage; will automatically initialize it if necessary.
-    pub(crate) fn get_ensure_imgstore(&self) -> Result<&crate::imgstorage::Storage> {
+    pub(crate) fn get_ensure_imgstore(&self) -> Result<&CStorage> {
         if let Some(imgstore) = self.imgstore.get() {
             return Ok(imgstore);
         }
@@ -136,8 +137,7 @@ impl Storage {
 
         tracing::trace!("sepolicy in get_ensure_imgstore: {sepolicy:?}");
 
-        let imgstore =
-            crate::imgstorage::Storage::create(&sysroot_dir, &self.run, sepolicy.as_ref())?;
+        let imgstore = CStorage::create(&sysroot_dir, &self.run, sepolicy.as_ref())?;
         Ok(self.imgstore.get_or_init(|| imgstore))
     }