Merge pull request #3511 from ethomson/racy_fixes_2 Racy fixes for writing new indexes
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
diff --git a/src/index.c b/src/index.c
index 0903770..bce1634 100644
--- a/src/index.c
+++ b/src/index.c
@@ -18,6 +18,7 @@
#include "ignore.h"
#include "blob.h"
#include "idxmap.h"
+#include "diff.h"
#include "git2/odb.h"
#include "git2/oid.h"
@@ -752,7 +753,9 @@ static int truncate_racily_clean(git_index *index)
int error;
git_index_entry *entry;
git_diff_options diff_opts = GIT_DIFF_OPTIONS_INIT;
- git_diff *diff;
+ git_diff *diff = NULL;
+ git_vector paths = GIT_VECTOR_INIT;
+ git_diff_delta *delta;
/* Nothing to do if there's no repo to talk about */
if (!INDEX_OWNER(index))
@@ -764,22 +767,33 @@ static int truncate_racily_clean(git_index *index)
diff_opts.flags |= GIT_DIFF_INCLUDE_TYPECHANGE | GIT_DIFF_IGNORE_SUBMODULES | GIT_DIFF_DISABLE_PATHSPEC_MATCH;
git_vector_foreach(&index->entries, i, entry) {
- if (!is_racy_timestamp(&index->stamp.mtime, entry))
- continue;
+ if ((entry->flags_extended & GIT_IDXENTRY_UPTODATE) == 0 &&
+ is_racy_timestamp(&index->stamp.mtime, entry))
+ git_vector_insert(&paths, (char *)entry->path);
+ }
- /* TODO: use the (non-fnmatching) filelist iterator */
- diff_opts.pathspec.count = 1;
- diff_opts.pathspec.strings = (char **) &entry->path;
+ if (paths.length == 0)
+ goto done;
- if ((error = git_diff_index_to_workdir(&diff, INDEX_OWNER(index), index, &diff_opts)) < 0)
- return error;
+ diff_opts.pathspec.count = paths.length;
+ diff_opts.pathspec.strings = (char **)paths.contents;
- if (git_diff_num_deltas(diff) > 0)
- entry->file_size = 0;
+ if ((error = git_diff_index_to_workdir(&diff, INDEX_OWNER(index), index, &diff_opts)) < 0)
+ return error;
- git_diff_free(diff);
+ git_vector_foreach(&diff->deltas, i, delta) {
+ entry = (git_index_entry *)git_index_get_bypath(index, delta->old_file.path, 0);
+
+ /* Ensure that we have a stage 0 for this file (ie, it's not a
+ * conflict), otherwise smudging it is quite pointless.
+ */
+ if (entry)
+ entry->file_size = 0;
}
+done:
+ git_diff_free(diff);
+ git_vector_free(&paths);
return 0;
}
@@ -989,20 +1003,11 @@ static int index_entry_reuc_init(git_index_reuc_entry **reuc_out,
static void index_entry_cpy(
git_index_entry *tgt,
- git_index *index,
- const git_index_entry *src,
- bool update_path)
+ const git_index_entry *src)
{
const char *tgt_path = tgt->path;
memcpy(tgt, src, sizeof(*tgt));
-
- /* keep the existing path buffer, but update the path to the one
- * given by the caller, if we trust it.
- */
tgt->path = tgt_path;
-
- if (index->ignore_case && update_path)
- memcpy((char *)tgt->path, src->path, strlen(tgt->path));
}
static int index_entry_dup(
@@ -1010,18 +1015,32 @@ static int index_entry_dup(
git_index *index,
const git_index_entry *src)
{
- git_index_entry *entry;
+ if (index_entry_create(out, INDEX_OWNER(index), src->path) < 0)
+ return -1;
- if (!src) {
- *out = NULL;
- return 0;
- }
+ index_entry_cpy(*out, src);
+ return 0;
+}
+
+static void index_entry_cpy_nocache(
+ git_index_entry *tgt,
+ const git_index_entry *src)
+{
+ git_oid_cpy(&tgt->id, &src->id);
+ tgt->mode = src->mode;
+ tgt->flags = src->flags;
+ tgt->flags_extended = (src->flags_extended & GIT_IDXENTRY_EXTENDED_FLAGS);
+}
- if (index_entry_create(&entry, INDEX_OWNER(index), src->path) < 0)
+static int index_entry_dup_nocache(
+ git_index_entry **out,
+ git_index *index,
+ const git_index_entry *src)
+{
+ if (index_entry_create(out, INDEX_OWNER(index), src->path) < 0)
return -1;
- index_entry_cpy(entry, index, src, false);
- *out = entry;
+ index_entry_cpy_nocache(*out, src);
return 0;
}
@@ -1282,6 +1301,9 @@ static int index_insert(
else
entry->flags |= GIT_IDXENTRY_NAMEMASK;
+ /* this entry is now up-to-date and should not be checked for raciness */
+ entry->flags_extended |= GIT_IDXENTRY_UPTODATE;
+
if (git_mutex_lock(&index->lock) < 0) {
giterr_set(GITERR_OS, "Unable to acquire index lock");
return -1;
@@ -1314,8 +1336,13 @@ static int index_insert(
* and return it in place of the passed in one.
*/
else if (existing) {
- if (replace)
- index_entry_cpy(existing, index, entry, trust_path);
+ if (replace) {
+ index_entry_cpy(existing, entry);
+
+ if (trust_path)
+ memcpy((char *)existing->path, entry->path, strlen(entry->path));
+ }
+
index_entry_free(entry);
*entry_ptr = entry = existing;
}
@@ -1692,9 +1719,12 @@ int git_index_conflict_add(git_index *index,
assert (index);
- if ((ret = index_entry_dup(&entries[0], index, ancestor_entry)) < 0 ||
- (ret = index_entry_dup(&entries[1], index, our_entry)) < 0 ||
- (ret = index_entry_dup(&entries[2], index, their_entry)) < 0)
+ if ((ancestor_entry &&
+ (ret = index_entry_dup(&entries[0], index, ancestor_entry)) < 0) ||
+ (our_entry &&
+ (ret = index_entry_dup(&entries[1], index, our_entry)) < 0) ||
+ (their_entry &&
+ (ret = index_entry_dup(&entries[2], index, their_entry)) < 0))
goto on_error;
/* Validate entries */
@@ -2545,7 +2575,8 @@ static int write_disk_entry(git_filebuf *file, git_index_entry *entry)
if (entry->flags & GIT_IDXENTRY_EXTENDED) {
struct entry_long *ondisk_ext;
ondisk_ext = (struct entry_long *)ondisk;
- ondisk_ext->flags_extended = htons(entry->flags_extended);
+ ondisk_ext->flags_extended = htons(entry->flags_extended &
+ GIT_IDXENTRY_EXTENDED_FLAGS);
path = ondisk_ext->path;
}
else
@@ -2728,6 +2759,15 @@ static int write_tree_extension(git_index *index, git_filebuf *file)
return error;
}
+static void clear_uptodate(git_index *index)
+{
+ git_index_entry *entry;
+ size_t i;
+
+ git_vector_foreach(&index->entries, i, entry)
+ entry->flags_extended &= ~GIT_IDXENTRY_UPTODATE;
+}
+
static int write_index(git_oid *checksum, git_index *index, git_filebuf *file)
{
git_oid hash_final;
@@ -2767,7 +2807,13 @@ static int write_index(git_oid *checksum, git_index *index, git_filebuf *file)
git_oid_cpy(checksum, &hash_final);
/* write it at the end of the file */
- return git_filebuf_write(file, hash_final.id, GIT_OID_RAWSZ);
+ if (git_filebuf_write(file, hash_final.id, GIT_OID_RAWSZ) < 0)
+ return -1;
+
+ /* file entries are no longer up to date */
+ clear_uptodate(index);
+
+ return 0;
}
int git_index_entry_stage(const git_index_entry *entry)
@@ -2816,7 +2862,7 @@ static int read_tree_cb(
entry->mode == old_entry->mode &&
git_oid_equal(&entry->id, &old_entry->id))
{
- index_entry_cpy(entry, data->index, old_entry, false);
+ index_entry_cpy(entry, old_entry);
entry->flags_extended = 0;
}
@@ -2941,7 +2987,10 @@ int git_index_read_index(
goto done;
while (true) {
- git_index_entry *add_entry = NULL, *remove_entry = NULL;
+ git_index_entry
+ *dup_entry = NULL,
+ *add_entry = NULL,
+ *remove_entry = NULL;
int diff;
if (old_entry && new_entry)
@@ -2956,8 +3005,7 @@ int git_index_read_index(
if (diff < 0) {
remove_entry = (git_index_entry *)old_entry;
} else if (diff > 0) {
- if ((error = index_entry_dup(&add_entry, index, new_entry)) < 0)
- goto done;
+ dup_entry = (git_index_entry *)new_entry;
} else {
/* Path and stage are equal, if the OID is equal, keep it to
* keep the stat cache data.
@@ -2965,13 +3013,16 @@ int git_index_read_index(
if (git_oid_equal(&old_entry->id, &new_entry->id)) {
add_entry = (git_index_entry *)old_entry;
} else {
- if ((error = index_entry_dup(&add_entry, index, new_entry)) < 0)
- goto done;
-
+ dup_entry = (git_index_entry *)new_entry;
remove_entry = (git_index_entry *)old_entry;
}
}
+ if (dup_entry) {
+ if ((error = index_entry_dup_nocache(&add_entry, index, dup_entry)) < 0)
+ goto done;
+ }
+
if (add_entry) {
if ((error = git_vector_insert(&new_entries, add_entry)) == 0)
INSERT_IN_MAP_EX(index, new_entries_map, add_entry, error);
diff --git a/tests/checkout/crlf.c b/tests/checkout/crlf.c
index 8e77d08..347c221 100644
--- a/tests/checkout/crlf.c
+++ b/tests/checkout/crlf.c
@@ -278,6 +278,7 @@ void test_checkout_crlf__autocrlf_true_index_size_is_filtered_size(void)
void test_checkout_crlf__with_ident(void)
{
git_index *index;
+ git_index_entry *entry;
git_blob *blob;
git_checkout_options opts = GIT_CHECKOUT_OPTIONS_INIT;
opts.checkout_strategy = GIT_CHECKOUT_FORCE;
@@ -310,14 +311,14 @@ void test_checkout_crlf__with_ident(void)
/* check that blobs have $Id$ */
- cl_git_pass(git_blob_lookup(&blob, g_repo,
- & git_index_get_bypath(index, "lf.ident", 0)->id));
+ cl_assert((entry = git_index_get_bypath(index, "lf.ident", 0)));
+ cl_git_pass(git_blob_lookup(&blob, g_repo, &entry->id));
cl_assert_equal_s(
ALL_LF_TEXT_RAW "\n$Id$\n", git_blob_rawcontent(blob));
git_blob_free(blob);
- cl_git_pass(git_blob_lookup(&blob, g_repo,
- & git_index_get_bypath(index, "more2.identcrlf", 0)->id));
+ cl_assert((entry = git_index_get_bypath(index, "more2.identcrlf", 0)));
+ cl_git_pass(git_blob_lookup(&blob, g_repo, &entry->id));
cl_assert_equal_s(
"\n$Id$\n" MORE_CRLF_TEXT_AS_LF, git_blob_rawcontent(blob));
git_blob_free(blob);
diff --git a/tests/index/racy.c b/tests/index/racy.c
index df25c85..f7440c3 100644
--- a/tests/index/racy.c
+++ b/tests/index/racy.c
@@ -100,13 +100,13 @@ void test_index_racy__write_index_just_after_file(void)
git_index_free(index);
}
-void test_index_racy__empty_file_after_smudge(void)
+
+static void setup_race(void)
{
- git_index *index;
- git_diff *diff;
git_buf path = GIT_BUF_INIT;
- int i, found_race = 0;
+ git_index *index;
const git_index_entry *entry;
+ int i, found_race = 0;
/* Make sure we do have a timestamp */
cl_git_pass(git_repository_index__weakptr(&index, g_repo));
@@ -131,17 +131,198 @@ void test_index_racy__empty_file_after_smudge(void)
found_race = 1;
break;
}
-
}
if (!found_race)
cl_fail("failed to find race after 10 attempts");
+ git_buf_free(&path);
+}
+
+void test_index_racy__smudges_index_entry_on_save(void)
+{
+ git_index *index;
+ const git_index_entry *entry;
+
+ setup_race();
+
+ /* write the index, which will smudge anything that had the same timestamp
+ * as the index when the index was loaded. that way future loads of the
+ * index (with the new timestamp) will know that these files were not
+ * clean.
+ */
+
+ cl_git_pass(git_repository_index__weakptr(&index, g_repo));
+ cl_git_pass(git_index_write(index));
+
+ cl_assert(entry = git_index_get_bypath(index, "A", 0));
cl_assert_equal_i(0, entry->file_size);
+}
+
+void test_index_racy__detects_diff_of_change_in_identical_timestamp(void)
+{
+ git_index *index;
+ git_diff *diff;
+
+ cl_git_pass(git_repository_index__weakptr(&index, g_repo));
+
+ setup_race();
cl_git_pass(git_diff_index_to_workdir(&diff, g_repo, index, NULL));
cl_assert_equal_i(1, git_diff_num_deltas(diff));
- git_buf_free(&path);
git_diff_free(diff);
}
+
+static void setup_uptodate_files(void)
+{
+ git_buf path = GIT_BUF_INIT;
+ git_index *index;
+ git_index_entry new_entry = {0};
+
+ cl_git_pass(git_repository_index(&index, g_repo));
+
+ cl_git_pass(git_buf_joinpath(&path, git_repository_workdir(g_repo), "A"));
+ cl_git_mkfile(path.ptr, "A");
+
+ /* Put 'A' into the index */
+ cl_git_pass(git_index_add_bypath(index, "A"));
+
+ /* Put 'B' into the index */
+ new_entry.path = "B";
+ new_entry.mode = GIT_FILEMODE_BLOB;
+ cl_git_pass(git_index_add(index, &new_entry));
+
+ /* Put 'C' into the index */
+ new_entry.path = "C";
+ new_entry.mode = GIT_FILEMODE_BLOB;
+ cl_git_pass(git_index_add_frombuffer(index, &new_entry, "hello!\n", 7));
+
+ git_index_free(index);
+ git_buf_free(&path);
+}
+
+void test_index_racy__adding_to_index_is_uptodate(void)
+{
+ git_index *index;
+ const git_index_entry *entry;
+
+ setup_uptodate_files();
+
+ cl_git_pass(git_repository_index(&index, g_repo));
+
+ /* ensure that they're all uptodate */
+ cl_assert((entry = git_index_get_bypath(index, "A", 0)));
+ cl_assert_equal_i(GIT_IDXENTRY_UPTODATE, (entry->flags_extended & GIT_IDXENTRY_UPTODATE));
+
+ cl_assert((entry = git_index_get_bypath(index, "B", 0)));
+ cl_assert_equal_i(GIT_IDXENTRY_UPTODATE, (entry->flags_extended & GIT_IDXENTRY_UPTODATE));
+
+ cl_assert((entry = git_index_get_bypath(index, "C", 0)));
+ cl_assert_equal_i(GIT_IDXENTRY_UPTODATE, (entry->flags_extended & GIT_IDXENTRY_UPTODATE));
+
+ cl_git_pass(git_index_write(index));
+
+ git_index_free(index);
+}
+
+void test_index_racy__reading_clears_uptodate_bit(void)
+{
+ git_index *index;
+ const git_index_entry *entry;
+
+ setup_uptodate_files();
+
+ cl_git_pass(git_repository_index(&index, g_repo));
+ cl_git_pass(git_index_write(index));
+
+ cl_git_pass(git_index_read(index, true));
+
+ /* ensure that no files are uptodate */
+ cl_assert((entry = git_index_get_bypath(index, "A", 0)));
+ cl_assert_equal_i(0, (entry->flags_extended & GIT_IDXENTRY_UPTODATE));
+
+ cl_assert((entry = git_index_get_bypath(index, "B", 0)));
+ cl_assert_equal_i(0, (entry->flags_extended & GIT_IDXENTRY_UPTODATE));
+
+ cl_assert((entry = git_index_get_bypath(index, "C", 0)));
+ cl_assert_equal_i(0, (entry->flags_extended & GIT_IDXENTRY_UPTODATE));
+
+ git_index_free(index);
+}
+
+void test_index_racy__read_tree_clears_uptodate_bit(void)
+{
+ git_index *index;
+ git_tree *tree;
+ const git_index_entry *entry;
+ git_oid id;
+
+ setup_uptodate_files();
+
+ cl_git_pass(git_repository_index(&index, g_repo));
+ cl_git_pass(git_index_write_tree_to(&id, index, g_repo));
+ cl_git_pass(git_tree_lookup(&tree, g_repo, &id));
+ cl_git_pass(git_index_read_tree(index, tree));
+
+ /* ensure that no files are uptodate */
+ cl_assert((entry = git_index_get_bypath(index, "A", 0)));
+ cl_assert_equal_i(0, (entry->flags_extended & GIT_IDXENTRY_UPTODATE));
+
+ cl_assert((entry = git_index_get_bypath(index, "B", 0)));
+ cl_assert_equal_i(0, (entry->flags_extended & GIT_IDXENTRY_UPTODATE));
+
+ cl_assert((entry = git_index_get_bypath(index, "C", 0)));
+ cl_assert_equal_i(0, (entry->flags_extended & GIT_IDXENTRY_UPTODATE));
+
+ git_tree_free(tree);
+ git_index_free(index);
+}
+
+void test_index_racy__read_index_smudges(void)
+{
+ git_index *index, *newindex;
+ const git_index_entry *entry;
+
+ /* if we are reading an index into our new index, ensure that any
+ * racy entries in the index that we're reading are smudged so that
+ * we don't propagate their timestamps without further investigation.
+ */
+ setup_race();
+
+ cl_git_pass(git_repository_index(&index, g_repo));
+ cl_git_pass(git_index_new(&newindex));
+ cl_git_pass(git_index_read_index(newindex, index));
+
+ cl_assert(entry = git_index_get_bypath(newindex, "A", 0));
+ cl_assert_equal_i(0, entry->file_size);
+
+ git_index_free(index);
+ git_index_free(newindex);
+}
+
+void test_index_racy__read_index_clears_uptodate_bit(void)
+{
+ git_index *index, *newindex;
+ const git_index_entry *entry;
+ git_oid id;
+
+ setup_uptodate_files();
+
+ cl_git_pass(git_repository_index(&index, g_repo));
+ cl_git_pass(git_index_new(&newindex));
+ cl_git_pass(git_index_read_index(newindex, index));
+
+ /* ensure that files brought in from the other index are not uptodate */
+ cl_assert((entry = git_index_get_bypath(newindex, "A", 0)));
+ cl_assert_equal_i(0, (entry->flags_extended & GIT_IDXENTRY_UPTODATE));
+
+ cl_assert((entry = git_index_get_bypath(newindex, "B", 0)));
+ cl_assert_equal_i(0, (entry->flags_extended & GIT_IDXENTRY_UPTODATE));
+
+ cl_assert((entry = git_index_get_bypath(newindex, "C", 0)));
+ cl_assert_equal_i(0, (entry->flags_extended & GIT_IDXENTRY_UPTODATE));
+
+ git_index_free(index);
+ git_index_free(newindex);
+}