Top | ![]() |
![]() |
![]() |
![]() |
A OstreeSysroot object represents a physical root filesystem, which in particular should contain a toplevel /ostree directory. Inside this directory is an OstreeRepo in /ostree/repo, plus a set of deployments in /ostree/deploy.
This class is not by default safe against concurrent use by threads
or external processes. You can use ostree_sysroot_lock()
to
perform locking externally.
gboolean ostree_sysroot_load (OstreeSysroot *self
,GCancellable *cancellable
,GError **error
);
Load deployment list, bootversion, and subbootversion from the
rootfs self
.
gboolean ostree_sysroot_load_if_changed (OstreeSysroot *self
,gboolean *out_changed
,GCancellable *cancellable
,GError **error
);
gboolean ostree_sysroot_lock (OstreeSysroot *self
,GError **error
);
Acquire an exclusive multi-process write lock for self
. This call
blocks until the lock has been acquired. The lock is not
reentrant.
Release the lock with ostree_sysroot_unlock()
. The lock will also
be released if self
is deallocated.
gboolean ostree_sysroot_try_lock (OstreeSysroot *self
,gboolean *out_acquired
,GError **error
);
Try to acquire an exclusive multi-process write lock for self
. If
another process holds the lock, this function will return
immediately, setting out_acquired
to FALSE
, and returning TRUE
(and no error).
Release the lock with ostree_sysroot_unlock()
. The lock will also
be released if self
is deallocated.
void ostree_sysroot_lock_async (OstreeSysroot *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
An asynchronous version of ostree_sysroot_lock()
.
gboolean ostree_sysroot_lock_finish (OstreeSysroot *self
,GAsyncResult *result
,GError **error
);
Call when ostree_sysroot_lock_async()
is ready.
void
ostree_sysroot_unlock (OstreeSysroot *self
);
Clear the lock previously acquired with ostree_sysroot_lock()
. It
is safe to call this function if the lock has not been previously
acquired.
void
ostree_sysroot_unload (OstreeSysroot *self
);
Release any resources such as file descriptors referring to the root directory of this sysroot. Normally, those resources are cleared by finalization, but in garbage collected languages that may not be predictable.
This undoes the effect of
.ostree_sysroot_load()
int
ostree_sysroot_get_fd (OstreeSysroot *self
);
Access a file descriptor that refers to the root directory of this
sysroot. ostree_sysroot_load()
must have been invoked prior to
calling this function.
gboolean ostree_sysroot_ensure_initialized (OstreeSysroot *self
,GCancellable *cancellable
,GError **error
);
Ensure that self
is set up as a valid rootfs, by creating
/ostree/repo, among other things.
OstreeDeployment *
ostree_sysroot_get_booted_deployment (OstreeSysroot *self
);
GFile * ostree_sysroot_get_deployment_directory (OstreeSysroot *self
,OstreeDeployment *deployment
);
char * ostree_sysroot_get_deployment_dirpath (OstreeSysroot *self
,OstreeDeployment *deployment
);
Note this function only returns a *relative* path - if you want
to access, it, you must either use fd-relative api such as openat()
,
or concatenate it with the full ostree_sysroot_get_path()
.
GFile *
ostree_sysroot_get_deployment_origin_path
(GFile *deployment_path
);
gboolean ostree_sysroot_cleanup (OstreeSysroot *self
,GCancellable *cancellable
,GError **error
);
Delete any state that resulted from a partially completed transaction, such as incomplete deployments.
gboolean ostree_sysroot_prepare_cleanup (OstreeSysroot *self
,GCancellable *cancellable
,GError **error
);
Like ostree_sysroot_cleanup()
in that it cleans up incomplete deployments
and old boot versions, but does NOT prune the repository.
gboolean ostree_sysroot_get_repo (OstreeSysroot *self
,OstreeRepo **out_repo
,GCancellable *cancellable
,GError **error
);
Retrieve the OSTree repository in sysroot self
.
self |
Sysroot |
|
out_repo |
Repository in sysroot |
[out] |
cancellable |
Cancellable |
|
error |
Error |
gboolean ostree_sysroot_init_osname (OstreeSysroot *self
,const char *osname
,GCancellable *cancellable
,GError **error
);
Initialize the directory structure for an "osname", which is a
group of operating system deployments, with a shared /var
. One
is required for generating a deployment.
gboolean ostree_sysroot_deployment_set_kargs (OstreeSysroot *self
,OstreeDeployment *deployment
,char **new_kargs
,GCancellable *cancellable
,GError **error
);
Entirely replace the kernel arguments of deployment
with the
values in new_kargs
.
self |
Sysroot |
|
deployment |
A deployment |
|
new_kargs |
Replace deployment's kernel arguments. |
[array zero-terminated=1][element-type utf8] |
cancellable |
Cancellable |
|
error |
Error |
gboolean ostree_sysroot_deployment_set_mutable (OstreeSysroot *self
,OstreeDeployment *deployment
,gboolean is_mutable
,GCancellable *cancellable
,GError **error
);
By default, deployment directories are not mutable. This function will allow making them temporarily mutable, for example to allow layering additional non-OSTree content.
gboolean ostree_sysroot_deployment_unlock (OstreeSysroot *self
,OstreeDeployment *deployment
,OstreeDeploymentUnlockedState unlocked_state
,GCancellable *cancellable
,GError **error
);
Configure the target deployment deployment
such that it
is writable. There are multiple modes, essentially differing
in whether or not any changes persist across reboot.
The OSTREE_DEPLOYMENT_UNLOCKED_HOTFIX
state is persistent
across reboots.
gboolean ostree_sysroot_write_deployments (OstreeSysroot *self
,GPtrArray *new_deployments
,GCancellable *cancellable
,GError **error
);
Assuming new_deployments
have already been deployed in place on
disk, atomically update bootloader configuration.
self |
Sysroot |
|
new_deployments |
List of new deployments. |
[element-type OstreeDeployment] |
cancellable |
Cancellable |
|
error |
Error |
gboolean ostree_sysroot_write_origin_file (OstreeSysroot *sysroot
,OstreeDeployment *deployment
,GKeyFile *new_origin
,GCancellable *cancellable
,GError **error
);
Immediately replace the origin file of the referenced deployment
with the contents of new_origin
. If new_origin
is NULL
,
this function will write the current origin of deployment
.
sysroot |
System root |
|
deployment |
Deployment |
|
new_origin |
Origin content. |
[allow-none] |
cancellable |
Cancellable |
|
error |
Error |
gboolean ostree_sysroot_deploy_tree (OstreeSysroot *self
,const char *osname
,const char *revision
,GKeyFile *origin
,OstreeDeployment *provided_merge_deployment
,char **override_kernel_argv
,OstreeDeployment **out_new_deployment
,GCancellable *cancellable
,GError **error
);
Check out deployment tree with revision revision
, performing a 3
way merge with provided_merge_deployment
for configuration.
self |
Sysroot |
|
osname |
osname to use for merge deployment. |
[allow-none] |
revision |
Checksum to add |
|
origin |
Origin to use for upgrades. |
[allow-none] |
provided_merge_deployment |
Use this deployment for merge path. |
[allow-none] |
override_kernel_argv |
Use these as kernel arguments; if |
[allow-none][array zero-terminated=1][element-type utf8] |
out_new_deployment |
The new deployment path. |
[out] |
cancellable |
Cancellable |
|
error |
Error |
OstreeDeployment * ostree_sysroot_get_merge_deployment (OstreeSysroot *self
,const char *osname
);
Find the deployment to use as a configuration merge source; this is the first one in the current deployment list which matches osname.
GKeyFile * ostree_sysroot_origin_new_from_refspec (OstreeSysroot *self
,const char *refspec
);
gboolean ostree_sysroot_simple_write_deployment (OstreeSysroot *sysroot
,const char *osname
,OstreeDeployment *new_deployment
,OstreeDeployment *merge_deployment
,OstreeSysrootSimpleWriteDeploymentFlags flags
,GCancellable *cancellable
,GError **error
);
Prepend new_deployment
to the list of deployments, commit, and
cleanup. By default, all other deployments for the given osname
except the merge deployment and the booted deployment will be
garbage collected.
If OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_RETAIN
is
specified, then all current deployments will be kept.
If OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_NOT_DEFAULT
is
specified, then instead of prepending, the new deployment will be
added right after the booted or merge deployment, instead of first.
sysroot |
Sysroot |
|
osname |
OS name. |
[allow-none] |
new_deployment |
Prepend this deployment to the list |
|
merge_deployment |
Use this deployment for configuration merge. |
[allow-none] |
flags |
Flags controlling behavior |
|
cancellable |
Cancellable |
|
error |
Error |