daemon/syscore: push livefs introspection to Rust

rust/cbindgen.toml

@@ -9,9 +9,11 @@ G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(RORHistoryEntry, ror_history_entry_clear)
 
 [export]
 prefix = "ROR"
-# Here we exclude functions belonging to the C side which we use on the Rust side and so
+# Here we exclude entries belonging to the C side which we use on the Rust side and so
 # doesn't make sense to re-export.
-exclude = ["rpmostree_get_repodata_chksum_repr"]
+exclude = ["RpmOstreeOrigin",
+           "rpmostree_get_repodata_chksum_repr",
+           "rpmostree_origin_get_live_state" ]
 
 [parse]
 # We don't want cbindgen to parse libdnf-sys, since we're clients of the library, not

rust/src/includes.rs

@@ -0,0 +1,30 @@
+/*!
+Helper C functions from rpm-ostree.
+
+These are prime candidates for oxidation (e.g. to make interacting with
+strings more efficient).
+
+NOTICE: The C header definitions are canonical, please update those first
+then synchronize the entries here.
+!*/
+
+use crate::syscore::ffi::RpmOstreeOrigin;
+use libdnf_sys::DnfPackage;
+
+// From `libpriv/rpmostree-rpm-util.h`.
+extern "C" {
+    pub(crate) fn rpmostree_get_repodata_chksum_repr(
+        package: *mut DnfPackage,
+        chksum: *mut *mut libc::c_char,
+        gerror: *mut *mut glib_sys::GError,
+    ) -> libc::c_int;
+}
+
+// From `libpriv/rpmostree-origin.h`.
+extern "C" {
+    pub(crate) fn rpmostree_origin_get_live_state(
+        origin: *mut RpmOstreeOrigin,
+        out_inprogress: *mut *mut libc::c_char,
+        out_livereplaced: *mut *mut libc::c_char,
+    );
+}

rust/src/lib.rs

@@ -6,24 +6,27 @@
 
 // pub(crate) utilities
 mod ffiutil;
+mod includes;
 
 mod cliwrap;
 pub use cliwrap::*;
 mod composepost;
 pub use self::composepost::*;
-mod history;
-pub use self::history::*;
 mod coreos_rootfs;
 pub use self::coreos_rootfs::*;
+mod history;
+pub use self::history::*;
 mod journal;
 pub use self::journal::*;
+mod lockfile;
+pub use self::lockfile::*;
 mod progress;
 pub use self::progress::*;
+mod syscore;
+pub use self::syscore::ffi::*;
+mod testutils;
+pub use self::testutils::*;
 mod treefile;
 pub use self::treefile::*;
-mod lockfile;
-pub use self::lockfile::*;
 mod utils;
 pub use self::utils::*;
-mod testutils;
-pub use self::testutils::*;

rust/src/lockfile.rs

@@ -7,6 +7,8 @@
 /* Copied and adapted from: treefile.rs
  */
 
+pub use self::ffi::*;
+use crate::utils;
 use anyhow::Result;
 use chrono::prelude::*;
 use openat_ext::OpenatDirExt;
@@ -18,8 +20,6 @@ use std::io;
 use std::iter::Extend;
 use std::path::Path;
 
-use crate::utils;
-
 /// Given a lockfile filename, parse it
 fn lockfile_parse<P: AsRef<Path>>(filename: P) -> Result<LockfileConfig> {
     let filename = filename.as_ref();
@@ -191,13 +191,13 @@ mod tests {
 
 mod ffi {
     use super::*;
+    use crate::ffiutil::*;
+    use crate::includes::*;
     use glib::translate::*;
     use glib_sys;
     use libc;
-    use std::ptr;
-
-    use crate::ffiutil::*;
     use libdnf_sys::*;
+    use std::ptr;
 
     #[no_mangle]
     pub extern "C" fn ror_lockfile_read(
@@ -304,16 +304,4 @@ mod ffi {
             gerror,
         )
     }
-
-    /* Some helper rpm-ostree C functions to deal with libdnf stuff. These are prime candidates for
-     * oxidation since it makes e.g. interacting with strings less efficient. */
-    extern "C" {
-        pub(crate) fn rpmostree_get_repodata_chksum_repr(
-            package: *mut DnfPackage,
-            chksum: *mut *mut libc::c_char,
-            gerror: *mut *mut glib_sys::GError,
-        ) -> libc::c_int;
-    }
 }
-
-pub use self::ffi::*;

rust/src/syscore.rs

@@ -0,0 +1,73 @@
+use self::ffi::RpmOstreeOrigin;
+use std::ptr::NonNull;
+
+/// Reference to an `RpmOstreeOrigin`.
+#[derive(Debug)]
+pub(crate) struct OriginRef {
+    origin: NonNull<RpmOstreeOrigin>,
+}
+
+impl OriginRef {
+    /// Build a reference object from a C pointer.
+    fn from_ffi_ptr(oref: *mut RpmOstreeOrigin) -> Self {
+        Self {
+            origin: NonNull::new(oref).expect("NULL RpmOstreeOrigin"),
+        }
+    }
+
+    /// Get `livefs` details for this deployment origin.
+    pub(crate) fn get_live_state<'o>(&'o self) -> OriginLiveState<'o> {
+        use crate::includes::rpmostree_origin_get_live_state;
+        use glib::translate::from_glib_full;
+
+        let mut out_inprogress: *mut libc::c_char = std::ptr::null_mut();
+        let mut out_livereplaced: *mut libc::c_char = std::ptr::null_mut();
+        unsafe {
+            rpmostree_origin_get_live_state(
+                self.origin.as_ptr(),
+                &mut out_inprogress,
+                &mut out_livereplaced,
+            );
+        };
+        let in_progress = unsafe { from_glib_full(out_inprogress) };
+        let replaced = unsafe { from_glib_full(out_livereplaced) };
+
+        OriginLiveState {
+            _origin: self,
+            in_progress,
+            replaced,
+        }
+    }
+}
+
+/// `livefs` state and details for a given deployment origin.
+#[derive(Debug)]
+pub(crate) struct OriginLiveState<'o> {
+    /// Underlying deployment origin.
+    _origin: &'o OriginRef,
+    /// Checksum for the in-progress livefs.
+    pub in_progress: Option<String>,
+    /// Checksum for the underlying replaced commit.
+    pub replaced: Option<String>,
+}
+
+impl<'o> OriginLiveState<'o> {
+    /// Return whether the given deployment is live-modified.
+    pub(crate) fn is_live(self) -> bool {
+        self.in_progress.is_some() || self.replaced.is_some()
+    }
+}
+
+pub mod ffi {
+    use super::OriginRef;
+
+    /// Opaque type for C interop: RpmOstreeOrigin.
+    pub enum RpmOstreeOrigin {}
+
+    #[no_mangle]
+    pub extern "C" fn ror_origin_is_live(origin_ptr: *mut RpmOstreeOrigin) -> libc::c_int {
+        let origin = OriginRef::from_ffi_ptr(origin_ptr);
+        let livestate = origin.get_live_state();
+        livestate.is_live().into()
+    }
+}

src/daemon/rpmostree-sysroot-core.c

@@ -486,13 +486,10 @@ rpmostree_syscore_deployment_is_live (OstreeDeployment *deployment,
                                       gboolean         *out_is_live,
                                       GError          **error)
 {
-  g_autofree char *inprogress_checksum = NULL;
-  g_autofree char *livereplaced_checksum = NULL;
-
-  if (!rpmostree_syscore_deployment_get_live (deployment, &inprogress_checksum,
-                                              &livereplaced_checksum, error))
+  g_autoptr(RpmOstreeOrigin) origin = rpmostree_origin_parse_deployment (deployment, error);
+  if (!origin)
     return FALSE;
 
-  *out_is_live = (inprogress_checksum != NULL || livereplaced_checksum != NULL);
+  *out_is_live = ror_origin_is_live(origin);
   return TRUE;
 }

src/libpriv/rpmostree-origin.h

@@ -107,6 +107,8 @@ rpmostree_origin_get_unconfigured_state (RpmOstreeOrigin *origin);
 gboolean
 rpmostree_origin_may_require_local_assembly (RpmOstreeOrigin *origin);
 
+// WARNING: This prototype is also redefined in Rust, if changing this
+// please also update `includes.rs`.
 void
 rpmostree_origin_get_live_state (RpmOstreeOrigin *origin,
                                  char           **out_inprogress,

src/libpriv/rpmostree-rpm-util.h

@@ -178,7 +178,8 @@ rpmostree_custom_nevra_strdup (const char *name,
 char *
 rpmostree_header_custom_nevra_strdup (Header h, RpmOstreePkgNevraFlags flags);
 
-/* NB: this function is exposed to Rust */
+// WARNING: This prototype is also redefined in Rust, if changing this
+// please also update `includes.rs`.
 gboolean
 rpmostree_get_repodata_chksum_repr (DnfPackage *pkg,
                                     char      **out_chksum_repr,

src/libpriv/rpmostree-rust-prelude.h

@@ -22,6 +22,9 @@
 
 #include <gio/gio.h>
 
+/* Forward declarations */
+typedef struct RpmOstreeOrigin RpmOstreeOrigin;
+
 /* Right now cbindgen doesn't understand types from external crates, so we hackily
  * typedef them.
  **/
@@ -31,4 +34,5 @@ b(GHashTable)
 b(GPtrArray)
 b(GChecksum)
 b(OstreeRepo)
+b(RpmOstreeOrigin)
 #undef b