packaging
/
ostree
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

repo: Make locking APIs public 

Doing anything even somewhat sophisticated requires this;
turns out our own `ostree prune` CLI wants this, e.g.
https://github.com/ostreedev/ostree/issues/2337

Closes: https://github.com/ostreedev/ostree/issues/2286
This commit is contained in:
Colin Walters 2021-04-14 20:43:53 -04:00 committed by Dan Nicholson
parent a7b590f7ae
commit 0f36d8c221
12 changed files with 139 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Makefile-libostree.am
View File

@ -173,9 +173,9 @@ endif # USE_GPGME
symbol_files = $(top_srcdir)/src/libostree/libostree-released.sym symbol_files = $(top_srcdir)/src/libostree/libostree-released.sym
# Uncomment this include when adding new development symbols. # Uncomment this include when adding new development symbols.
#if BUILDOPT_IS_DEVEL_BUILD if BUILDOPT_IS_DEVEL_BUILD
#symbol_files += $(top_srcdir)/src/libostree/libostree-devel.sym symbol_files += $(top_srcdir)/src/libostree/libostree-devel.sym
#endif endif
# http://blog.jgc.org/2007/06/escaping-comma-and-space-in-gnu-make.html # http://blog.jgc.org/2007/06/escaping-comma-and-space-in-gnu-make.html
wl_versionscript_arg = -Wl,--version-script= wl_versionscript_arg = -Wl,--version-script=

6
apidoc/ostree-sections.txt
View File

@ -319,6 +319,12 @@ ostree_repo_get_min_free_space_bytes
ostree_repo_get_config ostree_repo_get_config
ostree_repo_get_dfd ostree_repo_get_dfd
ostree_repo_get_default_repo_finders ostree_repo_get_default_repo_finders
OstreeRepoLockType
ostree_repo_lock_pop
ostree_repo_lock_push
OstreeRepoAutoLock
ostree_repo_auto_lock_push
ostree_repo_auto_lock_cleanup
ostree_repo_hash ostree_repo_hash
ostree_repo_equal ostree_repo_equal
ostree_repo_copy_config ostree_repo_copy_config

8
src/libostree/libostree-devel.sym
View File

@ -22,6 +22,14 @@
- uncomment the include in Makefile-libostree.am - uncomment the include in Makefile-libostree.am
*/ */
LIBOSTREE_2021.3 {
global:
ostree_repo_auto_lock_push;
ostree_repo_auto_lock_cleanup;
ostree_repo_lock_push;
ostree_repo_lock_pop;
} LIBOSTREE_2021.2;
/* Stub section for the stable release *after* this development one; don't /* Stub section for the stable release *after* this development one; don't
* edit this other than to update the year. This is just a copy/paste * edit this other than to update the year. This is just a copy/paste
* source. Replace $LASTSTABLE with the last stable version, and $NEWVERSION * source. Replace $LASTSTABLE with the last stable version, and $NEWVERSION

6
src/libostree/ostree-repo-commit.c
View File

@ -1684,7 +1684,7 @@ ostree_repo_prepare_transaction (OstreeRepo *self,
memset (&self->txn.stats, 0, sizeof (OstreeRepoTransactionStats)); memset (&self->txn.stats, 0, sizeof (OstreeRepoTransactionStats));
self->txn_locked = _ostree_repo_lock_push (self, OSTREE_REPO_LOCK_SHARED, self->txn_locked = ostree_repo_lock_push (self, OSTREE_REPO_LOCK_SHARED,
cancellable, error); cancellable, error);
if (!self->txn_locked) if (!self->txn_locked)
return FALSE; return FALSE;
@ -2341,7 +2341,7 @@ ostree_repo_commit_transaction (OstreeRepo *self,
if (self->txn_locked) if (self->txn_locked)
{ {
if (!_ostree_repo_lock_pop (self, cancellable, error)) if (!ostree_repo_lock_pop (self, cancellable, error))
return FALSE; return FALSE;
self->txn_locked = FALSE; self->txn_locked = FALSE;
} }
@ -2399,7 +2399,7 @@ ostree_repo_abort_transaction (OstreeRepo *self,
if (self->txn_locked) if (self->txn_locked)
{ {
if (!_ostree_repo_lock_pop (self, cancellable, error)) if (!ostree_repo_lock_pop (self, cancellable, error))
return FALSE; return FALSE;
self->txn_locked = FALSE; self->txn_locked = FALSE;
} }

24
src/libostree/ostree-repo-private.h
View File

@ -506,30 +506,6 @@ _ostree_repo_maybe_regenerate_summary (OstreeRepo *self,
GCancellable *cancellable, GCancellable *cancellable,
GError **error); GError **error);
/* Locking APIs are currently private.
* See https://github.com/ostreedev/ostree/pull/1555
*/
typedef enum {
OSTREE_REPO_LOCK_SHARED,
OSTREE_REPO_LOCK_EXCLUSIVE
} OstreeRepoLockType;
gboolean _ostree_repo_lock_push (OstreeRepo *self,
OstreeRepoLockType lock_type,
GCancellable *cancellable,
GError **error);
gboolean _ostree_repo_lock_pop (OstreeRepo *self,
GCancellable *cancellable,
GError **error);
typedef OstreeRepo OstreeRepoAutoLock;
OstreeRepoAutoLock * _ostree_repo_auto_lock_push (OstreeRepo *self,
OstreeRepoLockType lock_type,
GCancellable *cancellable,
GError **error);
void _ostree_repo_auto_lock_cleanup (OstreeRepoAutoLock *lock);
G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeRepoAutoLock, _ostree_repo_auto_lock_cleanup)
gboolean _ostree_repo_parse_fsverity_config (OstreeRepo *self, GError **error); gboolean _ostree_repo_parse_fsverity_config (OstreeRepo *self, GError **error);

8
src/libostree/ostree-repo-prune.c
View File

@ -204,7 +204,7 @@ ostree_repo_prune_static_deltas (OstreeRepo *self, const char *commit,
GError **error) GError **error)
{ {
g_autoptr(OstreeRepoAutoLock) lock = g_autoptr(OstreeRepoAutoLock) lock =
_ostree_repo_auto_lock_push (self, OSTREE_REPO_LOCK_EXCLUSIVE, cancellable, error); ostree_repo_auto_lock_push (self, OSTREE_REPO_LOCK_EXCLUSIVE, cancellable, error);
if (!lock) if (!lock)
return FALSE; return FALSE;
@ -325,7 +325,7 @@ ostree_repo_traverse_reachable_refs (OstreeRepo *self,
GError **error) GError **error)
{ {
g_autoptr(OstreeRepoAutoLock) lock = g_autoptr(OstreeRepoAutoLock) lock =
_ostree_repo_auto_lock_push (self, OSTREE_REPO_LOCK_SHARED, cancellable, error); ostree_repo_auto_lock_push (self, OSTREE_REPO_LOCK_SHARED, cancellable, error);
if (!lock) if (!lock)
return FALSE; return FALSE;
@ -400,7 +400,7 @@ ostree_repo_prune (OstreeRepo *self,
GError **error) GError **error)
{ {
g_autoptr(OstreeRepoAutoLock) lock = g_autoptr(OstreeRepoAutoLock) lock =
_ostree_repo_auto_lock_push (self, OSTREE_REPO_LOCK_EXCLUSIVE, cancellable, error); ostree_repo_auto_lock_push (self, OSTREE_REPO_LOCK_EXCLUSIVE, cancellable, error);
if (!lock) if (!lock)
return FALSE; return FALSE;
@ -486,7 +486,7 @@ ostree_repo_prune_from_reachable (OstreeRepo *self,
GError **error) GError **error)
{ {
g_autoptr(OstreeRepoAutoLock) lock = g_autoptr(OstreeRepoAutoLock) lock =
_ostree_repo_auto_lock_push (self, OSTREE_REPO_LOCK_EXCLUSIVE, cancellable, error); ostree_repo_auto_lock_push (self, OSTREE_REPO_LOCK_EXCLUSIVE, cancellable, error);
if (!lock) if (!lock)
return FALSE; return FALSE;

2
src/libostree/ostree-repo-static-delta-core.c
View File

@ -1270,7 +1270,7 @@ ostree_repo_static_delta_reindex (OstreeRepo *repo,
/* Protect against parallel prune operation */ /* Protect against parallel prune operation */
g_autoptr(OstreeRepoAutoLock) lock = g_autoptr(OstreeRepoAutoLock) lock =
_ostree_repo_auto_lock_push (repo, OSTREE_REPO_LOCK_SHARED, cancellable, error); ostree_repo_auto_lock_push (repo, OSTREE_REPO_LOCK_SHARED, cancellable, error);
if (!lock) if (!lock)
return FALSE; return FALSE;

33
src/libostree/ostree-repo.c
View File

@ -444,7 +444,7 @@ pop_repo_lock (OstreeRepo *self,
return TRUE; return TRUE;
} }
/* /**
* ostree_repo_lock_push: * ostree_repo_lock_push:
* @self: a #OstreeRepo * @self: a #OstreeRepo
* @lock_type: the type of lock to acquire * @lock_type: the type of lock to acquire
@ -470,9 +470,10 @@ pop_repo_lock (OstreeRepo *self,
* %TRUE is returned. * %TRUE is returned.
* *
* Returns: %TRUE on success, otherwise %FALSE with @error set * Returns: %TRUE on success, otherwise %FALSE with @error set
* Since: 2021.3
*/ */
gboolean gboolean
_ostree_repo_lock_push (OstreeRepo *self, ostree_repo_lock_push (OstreeRepo *self,
OstreeRepoLockType lock_type, OstreeRepoLockType lock_type,
GCancellable *cancellable, GCancellable *cancellable,
GError **error) GError **error)
@ -538,8 +539,8 @@ _ostree_repo_lock_push (OstreeRepo *self,
} }
} }
/* /**
* _ostree_repo_lock_pop: * ostree_repo_lock_pop:
* @self: a #OstreeRepo * @self: a #OstreeRepo
* @cancellable: a #GCancellable * @cancellable: a #GCancellable
* @error: a #GError * @error: a #GError
@ -560,9 +561,10 @@ _ostree_repo_lock_push (OstreeRepo *self,
* %TRUE is returned. * %TRUE is returned.
* *
* Returns: %TRUE on success, otherwise %FALSE with @error set * Returns: %TRUE on success, otherwise %FALSE with @error set
* Since: 2021.3
*/ */
gboolean gboolean
_ostree_repo_lock_pop (OstreeRepo *self, ostree_repo_lock_pop (OstreeRepo *self,
GCancellable *cancellable, GCancellable *cancellable,
GError **error) GError **error)
{ {
@ -628,7 +630,7 @@ _ostree_repo_lock_pop (OstreeRepo *self,
} }
/* /*
* _ostree_repo_auto_lock_push: (skip) * ostree_repo_auto_lock_push: (skip)
* @self: a #OstreeRepo * @self: a #OstreeRepo
* @lock_type: the type of lock to acquire * @lock_type: the type of lock to acquire
* @cancellable: a #GCancellable * @cancellable: a #GCancellable
@ -642,34 +644,37 @@ _ostree_repo_lock_pop (OstreeRepo *self,
* *
* |[<!-- language="C" --> * |[<!-- language="C" -->
* g_autoptr(OstreeRepoAutoLock) lock = NULL; * g_autoptr(OstreeRepoAutoLock) lock = NULL;
* lock = _ostree_repo_auto_lock_push (repo, lock_type, cancellable, error); * lock = ostree_repo_auto_lock_push (repo, lock_type, cancellable, error);
* if (!lock) * if (!lock)
* return FALSE; * return FALSE;
* ]| * ]|
* *
* Returns: @self on success, otherwise %NULL with @error set * Returns: @self on success, otherwise %NULL with @error set
* Since: 2021.3
*/ */
OstreeRepoAutoLock * OstreeRepoAutoLock *
_ostree_repo_auto_lock_push (OstreeRepo *self, ostree_repo_auto_lock_push (OstreeRepo *self,
OstreeRepoLockType lock_type, OstreeRepoLockType lock_type,
GCancellable *cancellable, GCancellable *cancellable,
GError **error) GError **error)
{ {
if (!_ostree_repo_lock_push (self, lock_type, cancellable, error)) if (!ostree_repo_lock_push (self, lock_type, cancellable, error))
return NULL; return NULL;
return (OstreeRepoAutoLock *)self; return (OstreeRepoAutoLock *)self;
} }
/* /**
* _ostree_repo_auto_lock_cleanup: (skip) * ostree_repo_auto_lock_cleanup: (skip)
* @lock: a #OstreeRepoAutoLock * @lock: a #OstreeRepoAutoLock
* *
* A cleanup handler for use with ostree_repo_auto_lock_push(). If @lock is * A cleanup handler for use with ostree_repo_auto_lock_push(). If @lock is
* not %NULL, ostree_repo_lock_pop() will be called on it. If * not %NULL, ostree_repo_lock_pop() will be called on it. If
* ostree_repo_lock_pop() fails, a critical warning will be emitted. * ostree_repo_lock_pop() fails, a critical warning will be emitted.
*
* Since: 2021.3
*/ */
void void
_ostree_repo_auto_lock_cleanup (OstreeRepoAutoLock *lock) ostree_repo_auto_lock_cleanup (OstreeRepoAutoLock *lock)
{ {
OstreeRepo *repo = lock; OstreeRepo *repo = lock;
if (repo) if (repo)
@ -677,7 +682,7 @@ _ostree_repo_auto_lock_cleanup (OstreeRepoAutoLock *lock)
g_autoptr(GError) error = NULL; g_autoptr(GError) error = NULL;
int errsv = errno; int errsv = errno;
if (!_ostree_repo_lock_pop (repo, NULL, &error)) if (!ostree_repo_lock_pop (repo, NULL, &error))
g_critical ("Cleanup repo lock failed: %s", error->message); g_critical ("Cleanup repo lock failed: %s", error->message);
errno = errsv; errno = errsv;
@ -5791,7 +5796,7 @@ ostree_repo_regenerate_summary (OstreeRepo *self,
g_autoptr(OstreeRepoAutoLock) lock = NULL; g_autoptr(OstreeRepoAutoLock) lock = NULL;
gboolean no_deltas_in_summary = FALSE; gboolean no_deltas_in_summary = FALSE;
lock = _ostree_repo_auto_lock_push (self, OSTREE_REPO_LOCK_EXCLUSIVE, lock = ostree_repo_auto_lock_push (self, OSTREE_REPO_LOCK_EXCLUSIVE,
cancellable, error); cancellable, error);
if (!lock) if (!lock)
return FALSE; return FALSE;

50
src/libostree/ostree-repo.h
View File

@ -1498,6 +1498,56 @@ gboolean ostree_repo_regenerate_summary (OstreeRepo *self,
GCancellable *cancellable, GCancellable *cancellable,
GError **error); GError **error);
/**
* OstreeRepoLockType:
* @OSTREE_REPO_LOCK_SHARED: A "read only" lock; multiple readers are allowed.
* @OSTREE_REPO_LOCK_EXCLUSIVE: A writable lock at most one writer can be active, and zero readers.
*
* Flags controlling repository locking.
*
* Since: 2021.3
*/
typedef enum {
OSTREE_REPO_LOCK_SHARED,
OSTREE_REPO_LOCK_EXCLUSIVE
} OstreeRepoLockType;
_OSTREE_PUBLIC
gboolean ostree_repo_lock_push (OstreeRepo *self,
OstreeRepoLockType lock_type,
GCancellable *cancellable,
GError **error);
_OSTREE_PUBLIC
gboolean ostree_repo_lock_pop (OstreeRepo *self,
GCancellable *cancellable,
GError **error);
/* C convenience API only */
#ifndef __GI_SCANNER__
/**
* OstreeRepoAutoLock: (skip)
*
* An opaque type for use with ostree_repo_auto_lock_push().
*
* Since: 2021.3
*/
typedef OstreeRepo OstreeRepoAutoLock;
_OSTREE_PUBLIC
OstreeRepoAutoLock * ostree_repo_auto_lock_push (OstreeRepo *self,
OstreeRepoLockType lock_type,
GCancellable *cancellable,
GError **error);
_OSTREE_PUBLIC
void ostree_repo_auto_lock_cleanup (OstreeRepoAutoLock *lock);
G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeRepoAutoLock, ostree_repo_auto_lock_cleanup)
#endif
/** /**
* OSTREE_REPO_METADATA_REF: * OSTREE_REPO_METADATA_REF:
* *

2
src/libostree/ostree-sysroot-cleanup.c
View File

@ -505,7 +505,7 @@ ostree_sysroot_cleanup_prune_repo (OstreeSysroot *sysroot,
* the prune. * the prune.
*/ */
g_autoptr(OstreeRepoAutoLock) lock = g_autoptr(OstreeRepoAutoLock) lock =
_ostree_repo_auto_lock_push (repo, OSTREE_REPO_LOCK_EXCLUSIVE, cancellable, error); ostree_repo_auto_lock_push (repo, OSTREE_REPO_LOCK_EXCLUSIVE, cancellable, error);
if (!lock) if (!lock)
return FALSE; return FALSE;

8
tests/test-core.js
View File

@ -134,4 +134,12 @@ w.write(inline_content.slice(10), null)
let actual_checksum = w.finish(null) let actual_checksum = w.finish(null)
assertEquals(actual_checksum, networks_checksum) assertEquals(actual_checksum, networks_checksum)
// Basic locking API sanity test
repo.lock_push(OSTree.RepoLockType.SHARED, null);
repo.lock_push(OSTree.RepoLockType.SHARED, null);
repo.lock_pop(null);
repo.lock_pop(null);
repo.lock_push(OSTree.RepoLockType.EXCLUSIVE, null);
repo.lock_pop(null);
print("ok test-core"); print("ok test-core");

26
tests/test-repo.c
View File

@ -249,6 +249,30 @@ test_write_regfile_api (Fixture *fixture,
g_assert_cmpstr (checksum, ==, "23a2e97d21d960ac7a4e39a8721b1baff7b213e00e5e5641334f50506012fcff"); g_assert_cmpstr (checksum, ==, "23a2e97d21d960ac7a4e39a8721b1baff7b213e00e5e5641334f50506012fcff");
} }
/* Just a sanity check of the C autolocking API */
static void
test_repo_autolock (Fixture *fixture,
gconstpointer test_data)
{
g_autoptr(GError) error = NULL;
g_autoptr(OstreeRepo) repo = ostree_repo_create_at (fixture->tmpdir.fd, ".",
OSTREE_REPO_MODE_ARCHIVE,
NULL,
NULL, &error);
g_assert_no_error (error);
{
g_autoptr(OstreeRepoAutoLock) lock = ostree_repo_auto_lock_push (repo, OSTREE_REPO_LOCK_EXCLUSIVE, NULL, &error);
g_assert_no_error (error);
}
g_autoptr(OstreeRepoAutoLock) lock1 = ostree_repo_auto_lock_push (repo, OSTREE_REPO_LOCK_SHARED, NULL, &error);
g_assert_no_error (error);
g_autoptr(OstreeRepoAutoLock) lock2 = ostree_repo_auto_lock_push (repo, OSTREE_REPO_LOCK_SHARED, NULL, &error);
g_assert_no_error (error);
}
int int
main (int argc, main (int argc,
char **argv) char **argv)
@ -266,6 +290,8 @@ main (int argc,
test_repo_get_min_free_space, teardown); test_repo_get_min_free_space, teardown);
g_test_add ("/repo/write_regfile_api", Fixture, NULL, setup, g_test_add ("/repo/write_regfile_api", Fixture, NULL, setup,
test_write_regfile_api, teardown); test_write_regfile_api, teardown);
g_test_add ("/repo/autolock", Fixture, NULL, setup,
test_repo_autolock, teardown);
return g_test_run (); return g_test_run ();
} }