Commit Graph

180 Commits

Author SHA1 Message Date
Nalin Dahyabhai b0c1c886c3 "pull up" images when creating them, too
We previously started "pulling up" images when we changed their names,
and started denying the presence of images in read-only stores which
shared their ID with an image in the read-write store, so that it would
be possible to "remove" names from an image in read-only storage.  We
forgot about the Flags field, so start pulling that up, too.

Do all of the above when we're asked to create an image, since denying
the presence of images with the same ID in read-only stores would
prevent us from finding the image by any of the names that it "had" just
a moment before we created the new record.

Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2023-04-06 18:21:11 -04:00
Nalin Dahyabhai 0f2bccfa56 Complete "pulling up" of images in updateNames()
When updateNames() copies an image's record from a read-only store into
the read-write store, copy the accompanying data as well.

Add fields for setting data items at creation-time to LayerOptions,
ImageOptions, and ContainerOptions to make this easier for us and our
consumers.

Replace the store-specific Create() (and the one CreateWithFlags() and
Put()) with private create() and put() methods, since they're not
intended for consumption outside of this package, and add Flags to the
options structures we pass into those methods.  In create() methods,
make copies of those passed-in options structures before modifying any
of their contents.

Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2023-03-31 10:36:30 -04:00
Daniel J Walsh 0ee26255cd
Run codespell on codebase
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2023-02-09 12:27:59 -05:00
Nalin Dahyabhai 6d91bc12f3 cmd: add a CLI wrapper for GarbageCollect
Add "gc" as an action for the CLI wrapper, for running the
GarbageCollect() method.

Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2023-01-26 16:09:00 -05:00
Miloslav Trmač ffeaed8fa4 Optimize the "no changes" case of layerStore.startReading further
In that case, we can just get read locks, confirm that nothing has changed,
and continue; no need for any serialization on exclusively holding
loadMut / inProcessLock.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2023-01-04 00:29:39 +01:00
Miloslav Trmač 717d171f22 Rework in-process concurrency control of layerStore
Instead of basing this on exclusivity loading via loadMut (which was incorrect,
because contrary to the original design, the r.layerspathModified
check in r.Modified() could trigger during the lifetime of a read lock)
use a very traditional read-write lock to protect the fields of imageStore.

Also explicitly document how concurrent access to fields of imageStore
is managed.

Note that for the btrfs and zfs graph drivers, Diff() can trigger
Mount() and unmount() in a way that violates the locking design.
That's not fixed in this PR.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2023-01-04 00:29:27 +01:00
Miloslav Trmač d173b026cb Annotate layerStore methods with the required lock access
Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2023-01-04 00:29:27 +01:00
Miloslav Trmač 4950eef972 Don't fix, just document, a locking bug
This should be fixed, it just seems too hard to do without
breaking API (and performance).

So, just be clear about that to warn future readers.

It's tracked in https://github.com/containers/storage/issues/1379 .

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2023-01-04 00:29:26 +01:00
Miloslav Trmač 16b28bae49 Don't reload the mount data in ParentOwners and Mounted
We can't safely do that because the read-only callers don't allow us
to write to layerStore state.

Luckily, with the recent changes to Mounted, we don't really need to
reload in those places.

Also, fairly extensively document the locking design or implications
for users.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2023-01-04 00:29:26 +01:00
Miloslav Trmač 845c2f4a30 Eliminate racy uses of Layer.MountCount
Instead of reading that value, releasing the mount lock,
and then unmounting, provide a "conditional" unmount mode.
And use that in the existing "loop unmounting" code.

That's at least safer against concurrent processes unmounting
the same layer. But the callers that try to "really unmount"
the layer in a loop are still possibly racing against other processes
trying to mount the layer in the meantime.

I'm not quite sure that we need the "conditional" parameter as an
explicit choice; it seems fairly likely that Umount() should just fail
with ErrLayerNotMounted for all !force callers. I chose to use the flag
to be conservative WRT possible unknown constraints.

Similarly, it's not very clear to me that the unmount loops need to exist;
maybe they should just be unmount(force=true, conditional=true).

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2023-01-03 23:47:16 +01:00
Alexander Larsson e546955f90 layer store: Don't reload the layer store after we save it
The lockfile we use propertly handles the case that we Touch() it. In
other words, a later Modified() call will return false.

However, we're also looking at the mtime, which was failing. This
uses the new AtomicWriteFileWithOpts() feature to also record the
mtime of the file we write on updates.

Signed-off-by: Alexander Larsson <alexl@redhat.com>
2022-12-09 08:57:13 +01:00
Miloslav Trmač ac110ce1be Fix locking in store.canUseShifting
This was using the graphDriver field without locks, and the graph driver itself,
while the implementation assumed exclusivity.

Luckily all callers are actually holding the layer store lock for writing, so
use that for exclusion. (layerStore already seems to extensively assume
that locking the layer store for writing guarantees exclusive access to the graph driver,
and because we always recreate a layer store after recreating the graph driver,
that is true in practice.)

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-12-05 18:50:13 +01:00
Miloslav Trmač 55d11a0389 Make change tracking error-resilient
Only update recorded LastWrite values _after_ we succesfully reload
container/image/layer stores; so, if the reload fails, the functions
will keep failing instead of using obsolete (and possibly partially loaded
and completely invalid) data.

Also, further improve mount change tracking, so that if layerStore.load()
loads it, we don't reload it afterwards.

This does not change the store.graphLock users; they will need to be cleaned up
more comprehensively, and separately, in the future.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-11-29 18:12:43 +01:00
Miloslav Trmač b8bcdf7681 Improve mounts reloads
If the mounts file is changed, don't reload all of the layers
as well. This is more efficient, and it will allow us to better
track/update r.lastWrite and r.mountsLastWrite in the future.

Exiting code calling reloadMountsIfChanged() indicates that this
must already be safe.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-11-29 18:12:43 +01:00
Miloslav Trmač b2d3379ed4 Deprecate *LockFile.Modified and *LockFile.Touch
They are a shared state across all users of the *LockFile in the process,
and therefore incorrect to use for any single consumer for change tracking.

Direct users to user the new GetLastWrite, ModifiedSince, and RecordWrite,
instead, and convert all c/storage users.

In addition to just being correct, the new API is also more efficient:
- We now initialize stores with GetLastWrite before loading state;
  so, we don't trigger an immediate reload on the _second_ use of a store,
  due to the problematic semantics of .Modified().
- Unlike Modified() and Touch(), the new APi can be safely used without
  locking *LockFile.stateMutex, for a tiny speedup.

The conversion is, for now, trivial, just immediately updating the lastWrite
value after the ModifiedSince call.  That will get better.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-11-29 18:12:43 +01:00
Miloslav Trmač b74fdf4d23 Convert all c/storage users of Locker to *lockfile.LockFile
This will allow us to benefit from new features.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-11-29 18:12:43 +01:00
Miloslav Trmač f1c6fb0ce7 Factor out layerStore.reloadMountsIfChanged
... so that we don't need to update 4 separate copies.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-11-29 18:12:43 +01:00
Miloslav Trmač d24b8c5a13 Fix layerStore.saveLayers
- Don't exit after saving only one of the locations
- Only touch the lock once if saving both of the locations

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-11-29 18:12:43 +01:00
Alexander Larsson ddf18d41da Add Store.GarbageCollect() method
This looks in the container store for existing data dirs with ids not in
the container files and removes them. It also adds an (optional) driver
method to list available layers, then uses this and compares it to the
layers json file and removes layers that are not references.

Losing track of containers and layers can potentially happen in the
case of some kind of unclean shutdown, but mainly it happens at reboot
when using transient storage mode. Such users are recommended to run
a garbage collect at boot.

Signed-off-by: Alexander Larsson <alexl@redhat.com>
2022-11-14 16:36:30 +01:00
Alexander Larsson 58bf1c03e4 layer store: Handle volatile and transient layer
We store information about the layers in two files, layers.json and
volatile-layers.json. This allows us to treat the two stores
differently, for example saving the volatile json with the NoSync
option, which is faster (but less robust).

In normal mode we store only layers for the containers that are marked
volatile (`--rm`), as these are not expected to persist anyway. This way
informantion about such containers are faster to save, and in case
of an unclean shutdown we only risk loss of information about other
such volatile containers.

In transient mode all container layers (but not image layers) are
stored in the volatile json, and additionally it is stored in tmpfs.
This improving performance as well as automatically making sure no
container layers are persisted across boots.

Signed-off-by: Alexander Larsson <alexl@redhat.com>
2022-11-14 16:36:30 +01:00
Miloslav Trmač 7f6a670c44 Clean up inconsistent layer state in readers
... instead of failing for duplicate names, and instead of
ignoring the "incomplete" state of layers.

Try up to 3 times if other writers are creating inconsistent
state in the meantime.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-11-10 16:13:53 +01:00
Miloslav Trmač 48c7d2048f Be a bit more accurate about incomplete layer deletion
- In read-write stores, fail even readers if there are incomplete
  layers.  Right now that would increase observed failures (OTOH
  with better consistency), but we'll fix that again soon
- Decide whether to save read-write stores strictly based on
  the need to clean up, instead of cleaning up opportunistically
  (which is less predictable).
- Correctly return the right error, depending on whether there
  are duplicate layers

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-11-10 16:13:53 +01:00
Miloslav Trmač 859d1791b8 In load methods, track the inconsistency we want to fix
... as an error value instead of just a boolean.  That
will allow extending the logic to more kinds of inconsistencies,
and consolidates the specifics of the inconsistency knowledge
into a single place.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-11-10 16:13:53 +01:00
Miloslav Trmač 765414fbdb Use the simplest possible error handling flow in reloadIfChanged
... instead of combining control flow branches; we will change
behavior on some of them.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-11-10 16:13:53 +01:00
Miloslav Trmač f6776bf5dc Remove always-true err == nil checks
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-25 20:54:12 +02:00
Miloslav Trmač 68ec0a1202 Don't silently ignore failures to delete incomplete layers
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-25 20:51:24 +02:00
Miloslav Trmač 7c5820ae1d Don't silently ignore failures to decode metadata JSON
Also tighten the scope of some error variables a bit.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-25 20:50:23 +02:00
Miloslav Trmač 8e270346d0 Modify layerStore not to rely on lockfile.Locked()
Instead, have the callers of ReloadIfChanged provide the
locking state.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-21 21:10:33 +02:00
Miloslav Trmač 5c6186fe81 Fix {layerStore,imageStore}.startWriting()
This is a bad bug: we wouldn't reload state from disk
at all in writers.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-19 06:35:44 +02:00
Miloslav Trmač d0ad132945 Move layerStore.{ReloadIfChanged,Modified}
.. to be closer to the lock / load set of methods.

Only moves unchanged code, should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-17 21:40:00 +02:00
Miloslav Trmač dbe5fe3059 Remove Lock/Unlock methods from layerStore
They are now only used in the constructors, so use a variant
of startReading/startWriting instead.  This code path is not
performance-critical, so let's share as much code as possible
to ensure consistency in locking.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-17 21:39:33 +02:00
Miloslav Trmač d2defdb9fa Remove Save() from rwLayerStore API
It is done implicitly by all writers already.

Also fix the documentation not to point at an explicit Touch(),
which is not actually necessary.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-17 21:39:27 +02:00
Miloslav Trmač 328ccce601 Remove Load() and ReloadIfChanged() from roLayerStore API
Callers should just use startReading/startWriting.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-17 21:39:27 +02:00
Miloslav Trmač ee9708644f Remove Modified() from the roLayerStore API
It is an internal helper for ReloadIfChanged, with
no external users.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-17 21:39:27 +02:00
Miloslav Trmač 5791a561df Remove unused lockfile forwarders from roLayerStore API
The only callers are internal, have them access r.lockfile directly.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-17 21:39:27 +02:00
Miloslav Trmač 124e526285 Remove a completely unused method from roLayerStore
Exposing the internals of the lock is not necessary, and exposes
too many implementation details.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-17 21:39:19 +02:00
Miloslav Trmač c935245fe4 Move the writing lock methods from roLayerStore to rwLayerStore
... for a bit of extra safety.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-17 21:39:19 +02:00
Miloslav Trmač f9678cd44b Replace layerStore.{Lock,Unlock} with {startWriting,stopWriting}
This integrates ReloadIfChanged, and makes it clearer that the responsibility
for maintaining locking details is with the layerStore; we can change it
in a single place.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-17 21:39:19 +02:00
Miloslav Trmač c4089b6e3d Replace layerStore.{RLock,Unlock} with {startReading,stopReading}
This integrates ReloadIfChanged, and makes it clearer that the responsibility
for maintaining locking details is with the layerStore; we can change it
in a single place.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-17 21:39:19 +02:00
Miloslav Trmač d5b48bef6e Copy methods from included interfaces directly into *LayerStore
... so that we can modify/replace them.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-17 21:39:19 +02:00
Daniel J Walsh d02a89afb6
Merge branch 'main' into warnings 2022-10-14 13:46:03 -04:00
Miloslav Trmač 703cbe965b Simplify the name update call stack
Instead of going
	3 store methods
	store.updateNames+enum
	3 sub-store methods
	subStore.updateNames+enum
	applyNameOperation+enum,
simplify to
	3 store methods
	store.updateNames+enum
	subStore.updateNames+enum
	applyNameOperation+enum,

Should not change behavior. Looking purely at updateNameOperation,
invalid values would now be detected after doing more work,
but there is no way for an external caller to trigger use of
an invalid value anyway.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-14 17:23:08 +02:00
Miloslav Trmač 5e410ef763 Misc individual warning fixes
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-14 17:17:53 +02:00
Daniel J Walsh 714f4fc6e8
Merge pull request #1380 from mtrmac/misc
Two misc. cleanups
2022-10-13 10:36:30 -04:00
Miloslav Trmač 487febfe07 Remove unused layerStore.LoadLocked
Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-11 19:29:37 +02:00
Miloslav Trmač b157e14dd0 Remove completely unused *Store.Lookup() methods
Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-11 19:29:02 +02:00
Miloslav Trmač 821084ee68 Make all the various *Store interfaces, apart from storage.Store, private
There is no public way to obtain implementations of these interfaces; so
replace the public interfaces with private ones, to make it clear that we
_can_ modify them.

For formal API compatibility, preserve the old interface definitions
as copies.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-11 19:25:19 +02:00
Miloslav Trmač e2b1c19e34 Remove unused uidMap and gidMap fields from layerStore
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-11 19:19:55 +02:00
Miloslav Trmač 082a8161ed Remove lockfile.Locker.RecursiveLock
It is not valid as currently implemented, and there is no known user.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-07 19:45:14 +02:00
Miloslav Trmač c3dc83d3c2 Handle errors when compressing (or reading) layer diffs
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2022-10-01 02:53:06 +02:00