Browse code

Don't fail on two concurrent reference.store.AddDigest calls

reference.store.addReference fails when adding a digest reference
that already exists (regardless of the reference target). Both
callers (via reference.store.AddDigest) do check in advance, using
reference.store.Get, whether the digest reference exists before
calling AddDigest, but the reference store lock is released between
the two calls, so if another thread sets the reference in the meantime,
AddDigest may fail with
> Cannot overwrite digest ...
.

Handle this by checking that the pre-existing reference points at the
same image, i.e. that there is nothing to do, and succeeding immediately
in that case. This is even cheaper, avoids a reference.store.save() call.

(In principle, the same failure could have happened via
reference.store.AddTag, as
> Conflict: Tag %s is already set to image %s, if you want to replace it, please use -f option
but almost all callers (except for migrate/v1.Migrate, which is run
single-threaded anyway) set the "force" parameter of AddTag to true,
which makes the race invisible. This commit does not change the behavior
of that case, except for speeding it up by avoiding the
reference.store.save() call.)

The existing reference.store.Get checks are now, in a sense, redundant
as such, but their existence allows the callers to provide nice
context-dependent error messages, so this commit leaves them unchanged.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>

Miloslav Trmač authored on 2018/09/07 06:24:06
Showing 2 changed files
... ...
@@ -149,6 +149,11 @@ func (store *store) addReference(ref reference.Named, id digest.Digest, force bo
149 149
 	oldID, exists := repository[refStr]
150 150
 
151 151
 	if exists {
152
+		if oldID == id {
153
+			// Nothing to do. The caller may have checked for this using store.Get in advance, but store.mu was unlocked in the meantime, so this can legitimately happen nevertheless.
154
+			return nil
155
+		}
156
+
152 157
 		// force only works for tags
153 158
 		if digested, isDigest := ref.(reference.Canonical); isDigest {
154 159
 			return errors.WithStack(conflictingTagError("Cannot overwrite digest " + digested.Digest().String()))
... ...
@@ -163,6 +163,10 @@ func TestAddDeleteGet(t *testing.T) {
163 163
 	if err = store.AddTag(ref4, testImageID2, false); err != nil {
164 164
 		t.Fatalf("error adding to store: %v", err)
165 165
 	}
166
+	// Write the same values again; should silently succeed
167
+	if err = store.AddTag(ref4, testImageID2, false); err != nil {
168
+		t.Fatalf("error redundantly adding to store: %v", err)
169
+	}
166 170
 
167 171
 	ref5, err := reference.ParseNormalizedNamed("username/repo3@sha256:58153dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c")
168 172
 	if err != nil {
... ...
@@ -171,6 +175,10 @@ func TestAddDeleteGet(t *testing.T) {
171 171
 	if err = store.AddDigest(ref5.(reference.Canonical), testImageID2, false); err != nil {
172 172
 		t.Fatalf("error adding to store: %v", err)
173 173
 	}
174
+	// Write the same values again; should silently succeed
175
+	if err = store.AddDigest(ref5.(reference.Canonical), testImageID2, false); err != nil {
176
+		t.Fatalf("error redundantly adding to store: %v", err)
177
+	}
174 178
 
175 179
 	// Attempt to overwrite with force == false
176 180
 	if err = store.AddTag(ref4, testImageID3, false); err == nil || !strings.HasPrefix(err.Error(), "Conflict:") {