unpack-trees.c

   1 #define NO_THE_INDEX_COMPATIBILITY_MACROS
   2 #include "cache.h"
   3 #include "dir.h"
   4 #include "tree.h"
   5 #include "tree-walk.h"
   6 #include "cache-tree.h"
   7 #include "unpack-trees.h"
   8 #include "progress.h"
   9 #include "refs.h"
  10 #include "attr.h"
  11
  12 /*
  13  * Error messages expected by scripts out of plumbing commands such as
  14  * read-tree.  Non-scripted Porcelain is not required to use these messages
  15  * and in fact are encouraged to reword them to better suit their particular
  16  * situation better.  See how "git checkout" replaces not_uptodate_file to
  17  * explain why it does not allow switching between branches when you have
  18  * local changes, for example.
  19  */
  20 static struct unpack_trees_error_msgs unpack_plumbing_errors = {
  21         /* would_overwrite */
  22         "Entry '%s' would be overwritten by merge. Cannot merge.",
  23
  24         /* not_uptodate_file */
  25         "Entry '%s' not uptodate. Cannot merge.",
  26
  27         /* not_uptodate_dir */
  28         "Updating '%s' would lose untracked files in it",
  29
  30         /* would_lose_untracked */
  31         "Untracked working tree file '%s' would be %s by merge.",
  32
  33         /* bind_overlap */
  34         "Entry '%s' overlaps with '%s'.  Cannot bind.",
  35
  36         /* sparse_not_uptodate_file */
  37         "Entry '%s' not uptodate. Cannot update sparse checkout.",
  38
  39         /* would_lose_orphaned */
  40         "Working tree file '%s' would be %s by sparse checkout update.",
  41 };
  42
  43 #define ERRORMSG(o,fld) \
  44         ( ((o) && (o)->msgs.fld) \
  45         ? ((o)->msgs.fld) \
  46         : (unpack_plumbing_errors.fld) )
  47
  48 static void add_entry(struct unpack_trees_options *o, struct cache_entry *ce,
  49         unsigned int set, unsigned int clear)
  50 {
  51         unsigned int size = ce_size(ce);
  52         struct cache_entry *new = xmalloc(size);
  53
  54         clear |= CE_HASHED | CE_UNHASHED;
  55
  56         memcpy(new, ce, size);
  57         new->next = NULL;
  58         new->ce_flags = (new->ce_flags & ~clear) | set;
  59         add_index_entry(&o->result, new, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
  60 }
  61
  62 /*
  63  * Unlink the last component and schedule the leading directories for
  64  * removal, such that empty directories get removed.
  65  */
  66 static void unlink_entry(struct cache_entry *ce)
  67 {
  68         if (has_symlink_or_noent_leading_path(ce->name, ce_namelen(ce)))
  69                 return;
  70         if (unlink_or_warn(ce->name))
  71                 return;
  72         schedule_dir_for_removal(ce->name, ce_namelen(ce));
  73 }
  74
  75 static struct checkout state;
  76 static int check_updates(struct unpack_trees_options *o)
  77 {
  78         unsigned cnt = 0, total = 0;
  79         struct progress *progress = NULL;
  80         struct index_state *index = &o->result;
  81         int i;
  82         int errs = 0;
  83
  84         if (o->update && o->verbose_update) {
  85                 for (total = cnt = 0; cnt < index->cache_nr; cnt++) {
  86                         struct cache_entry *ce = index->cache[cnt];
  87                         if (ce->ce_flags & (CE_UPDATE | CE_REMOVE | CE_WT_REMOVE))
  88                                 total++;
  89                 }
  90
  91                 progress = start_progress_delay("Checking out files",
  92                                                 total, 50, 1);
  93                 cnt = 0;
  94         }
  95
  96         if (o->update)
  97                 git_attr_set_direction(GIT_ATTR_CHECKOUT, &o->result);
  98         for (i = 0; i < index->cache_nr; i++) {
  99                 struct cache_entry *ce = index->cache[i];
 100
 101                 if (ce->ce_flags & CE_WT_REMOVE) {
 102                         display_progress(progress, ++cnt);
 103                         if (o->update)
 104                                 unlink_entry(ce);
 105                         continue;
 106                 }
 107
 108                 if (ce->ce_flags & CE_REMOVE) {
 109                         display_progress(progress, ++cnt);
 110                         if (o->update)
 111                                 unlink_entry(ce);
 112                 }
 113         }
 114         remove_marked_cache_entries(&o->result);
 115         remove_scheduled_dirs();
 116
 117         for (i = 0; i < index->cache_nr; i++) {
 118                 struct cache_entry *ce = index->cache[i];
 119
 120                 if (ce->ce_flags & CE_UPDATE) {
 121                         display_progress(progress, ++cnt);
 122                         ce->ce_flags &= ~CE_UPDATE;
 123                         if (o->update) {
 124                                 errs |= checkout_entry(ce, &state, NULL);
 125                         }
 126                 }
 127         }
 128         stop_progress(&progress);
 129         if (o->update)
 130                 git_attr_set_direction(GIT_ATTR_CHECKIN, NULL);
 131         return errs != 0;
 132 }
 133
 134 static int verify_uptodate_sparse(struct cache_entry *ce, struct unpack_trees_options *o);
 135 static int verify_absent_sparse(struct cache_entry *ce, const char *action, struct unpack_trees_options *o);
 136
 137 static int will_have_skip_worktree(const struct cache_entry *ce, struct unpack_trees_options *o)
 138 {
 139         const char *basename;
 140
 141         if (ce_stage(ce))
 142                 return 0;
 143
 144         basename = strrchr(ce->name, '/');
 145         basename = basename ? basename+1 : ce->name;
 146         return excluded_from_list(ce->name, ce_namelen(ce), basename, NULL, o->el) <= 0;
 147 }
 148
 149 static int apply_sparse_checkout(struct cache_entry *ce, struct unpack_trees_options *o)
 150 {
 151         int was_skip_worktree = ce_skip_worktree(ce);
 152
 153         if (will_have_skip_worktree(ce, o))
 154                 ce->ce_flags |= CE_SKIP_WORKTREE;
 155         else
 156                 ce->ce_flags &= ~CE_SKIP_WORKTREE;
 157
 158         /*
 159          * We only care about files getting into the checkout area
 160          * If merge strategies want to remove some, go ahead, this
 161          * flag will be removed eventually in unpack_trees() if it's
 162          * outside checkout area.
 163          */
 164         if (ce->ce_flags & CE_REMOVE)
 165                 return 0;
 166
 167         if (!was_skip_worktree && ce_skip_worktree(ce)) {
 168                 /*
 169                  * If CE_UPDATE is set, verify_uptodate() must be called already
 170                  * also stat info may have lost after merged_entry() so calling
 171                  * verify_uptodate() again may fail
 172                  */
 173                 if (!(ce->ce_flags & CE_UPDATE) && verify_uptodate_sparse(ce, o))
 174                         return -1;
 175                 ce->ce_flags |= CE_WT_REMOVE;
 176         }
 177         if (was_skip_worktree && !ce_skip_worktree(ce)) {
 178                 if (verify_absent_sparse(ce, "overwritten", o))
 179                         return -1;
 180                 ce->ce_flags |= CE_UPDATE;
 181         }
 182         return 0;
 183 }
 184
 185 static inline int call_unpack_fn(struct cache_entry **src, struct unpack_trees_options *o)
 186 {
 187         int ret = o->fn(src, o);
 188         if (ret > 0)
 189                 ret = 0;
 190         return ret;
 191 }
 192
 193 static int unpack_index_entry(struct cache_entry *ce, struct unpack_trees_options *o)
 194 {
 195         struct cache_entry *src[5] = { ce, NULL, };
 196
 197         o->pos++;
 198         if (ce_stage(ce)) {
 199                 if (o->skip_unmerged) {
 200                         add_entry(o, ce, 0, 0);
 201                         return 0;
 202                 }
 203         }
 204         return call_unpack_fn(src, o);
 205 }
 206
 207 static int traverse_trees_recursive(int n, unsigned long dirmask, unsigned long df_conflicts, struct name_entry *names, struct traverse_info *info)
 208 {
 209         int i;
 210         struct tree_desc t[MAX_UNPACK_TREES];
 211         struct traverse_info newinfo;
 212         struct name_entry *p;
 213
 214         p = names;
 215         while (!p->mode)
 216                 p++;
 217
 218         newinfo = *info;
 219         newinfo.prev = info;
 220         newinfo.name = *p;
 221         newinfo.pathlen += tree_entry_len(p->path, p->sha1) + 1;
 222         newinfo.conflicts |= df_conflicts;
 223
 224         for (i = 0; i < n; i++, dirmask >>= 1) {
 225                 const unsigned char *sha1 = NULL;
 226                 if (dirmask & 1)
 227                         sha1 = names[i].sha1;
 228                 fill_tree_descriptor(t+i, sha1);
 229         }
 230         return traverse_trees(n, t, &newinfo);
 231 }
 232
 233 /*
 234  * Compare the traverse-path to the cache entry without actually
 235  * having to generate the textual representation of the traverse
 236  * path.
 237  *
 238  * NOTE! This *only* compares up to the size of the traverse path
 239  * itself - the caller needs to do the final check for the cache
 240  * entry having more data at the end!
 241  */
 242 static int do_compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
 243 {
 244         int len, pathlen, ce_len;
 245         const char *ce_name;
 246
 247         if (info->prev) {
 248                 int cmp = do_compare_entry(ce, info->prev, &info->name);
 249                 if (cmp)
 250                         return cmp;
 251         }
 252         pathlen = info->pathlen;
 253         ce_len = ce_namelen(ce);
 254
 255         /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
 256         if (ce_len < pathlen)
 257                 return -1;
 258
 259         ce_len -= pathlen;
 260         ce_name = ce->name + pathlen;
 261
 262         len = tree_entry_len(n->path, n->sha1);
 263         return df_name_compare(ce_name, ce_len, S_IFREG, n->path, len, n->mode);
 264 }
 265
 266 static int compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
 267 {
 268         int cmp = do_compare_entry(ce, info, n);
 269         if (cmp)
 270                 return cmp;
 271
 272         /*
 273          * Even if the beginning compared identically, the ce should
 274          * compare as bigger than a directory leading up to it!
 275          */
 276         return ce_namelen(ce) > traverse_path_len(info, n);
 277 }
 278
 279 static struct cache_entry *create_ce_entry(const struct traverse_info *info, const struct name_entry *n, int stage)
 280 {
 281         int len = traverse_path_len(info, n);
 282         struct cache_entry *ce = xcalloc(1, cache_entry_size(len));
 283
 284         ce->ce_mode = create_ce_mode(n->mode);
 285         ce->ce_flags = create_ce_flags(len, stage);
 286         hashcpy(ce->sha1, n->sha1);
 287         make_traverse_path(ce->name, info, n);
 288
 289         return ce;
 290 }
 291
 292 static int unpack_nondirectories(int n, unsigned long mask,
 293                                  unsigned long dirmask,
 294                                  struct cache_entry **src,
 295                                  const struct name_entry *names,
 296                                  const struct traverse_info *info)
 297 {
 298         int i;
 299         struct unpack_trees_options *o = info->data;
 300         unsigned long conflicts;
 301
 302         /* Do we have *only* directories? Nothing to do */
 303         if (mask == dirmask && !src[0])
 304                 return 0;
 305
 306         conflicts = info->conflicts;
 307         if (o->merge)
 308                 conflicts >>= 1;
 309         conflicts |= dirmask;
 310
 311         /*
 312          * Ok, we've filled in up to any potential index entry in src[0],
 313          * now do the rest.
 314          */
 315         for (i = 0; i < n; i++) {
 316                 int stage;
 317                 unsigned int bit = 1ul << i;
 318                 if (conflicts & bit) {
 319                         src[i + o->merge] = o->df_conflict_entry;
 320                         continue;
 321                 }
 322                 if (!(mask & bit))
 323                         continue;
 324                 if (!o->merge)
 325                         stage = 0;
 326                 else if (i + 1 < o->head_idx)
 327                         stage = 1;
 328                 else if (i + 1 > o->head_idx)
 329                         stage = 3;
 330                 else
 331                         stage = 2;
 332                 src[i + o->merge] = create_ce_entry(info, names + i, stage);
 333         }
 334
 335         if (o->merge)
 336                 return call_unpack_fn(src, o);
 337
 338         for (i = 0; i < n; i++)
 339                 if (src[i] && src[i] != o->df_conflict_entry)
 340                         add_entry(o, src[i], 0, 0);
 341         return 0;
 342 }
 343
 344 static int unpack_callback(int n, unsigned long mask, unsigned long dirmask, struct name_entry *names, struct traverse_info *info)
 345 {
 346         struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
 347         struct unpack_trees_options *o = info->data;
 348         const struct name_entry *p = names;
 349
 350         /* Find first entry with a real name (we could use "mask" too) */
 351         while (!p->mode)
 352                 p++;
 353
 354         /* Are we supposed to look at the index too? */
 355         if (o->merge) {
 356                 while (o->pos < o->src_index->cache_nr) {
 357                         struct cache_entry *ce = o->src_index->cache[o->pos];
 358                         int cmp = compare_entry(ce, info, p);
 359                         if (cmp < 0) {
 360                                 if (unpack_index_entry(ce, o) < 0)
 361                                         return -1;
 362                                 continue;
 363                         }
 364                         if (!cmp) {
 365                                 o->pos++;
 366                                 if (ce_stage(ce)) {
 367                                         /*
 368                                          * If we skip unmerged index entries, we'll skip this
 369                                          * entry *and* the tree entries associated with it!
 370                                          */
 371                                         if (o->skip_unmerged) {
 372                                                 add_entry(o, ce, 0, 0);
 373                                                 return mask;
 374                                         }
 375                                 }
 376                                 src[0] = ce;
 377                         }
 378                         break;
 379                 }
 380         }
 381
 382         if (unpack_nondirectories(n, mask, dirmask, src, names, info) < 0)
 383                 return -1;
 384
 385         /* Now handle any directories.. */
 386         if (dirmask) {
 387                 unsigned long conflicts = mask & ~dirmask;
 388                 if (o->merge) {
 389                         conflicts <<= 1;
 390                         if (src[0])
 391                                 conflicts |= 1;
 392                 }
 393
 394                 /* special case: "diff-index --cached" looking at a tree */
 395                 if (o->diff_index_cached &&
 396                     n == 1 && dirmask == 1 && S_ISDIR(names->mode)) {
 397                         int matches;
 398                         matches = cache_tree_matches_traversal(o->src_index->cache_tree,
 399                                                                names, info);
 400                         /*
 401                          * Everything under the name matches.  Adjust o->pos to
 402                          * skip the entire hierarchy.
 403                          */
 404                         if (matches) {
 405                                 o->pos += matches;
 406                                 return mask;
 407                         }
 408                 }
 409
 410                 if (traverse_trees_recursive(n, dirmask, conflicts,
 411                                              names, info) < 0)
 412                         return -1;
 413                 return mask;
 414         }
 415
 416         return mask;
 417 }
 418
 419 static int unpack_failed(struct unpack_trees_options *o, const char *message)
 420 {
 421         discard_index(&o->result);
 422         if (!o->gently) {
 423                 if (message)
 424                         return error("%s", message);
 425                 return -1;
 426         }
 427         return -1;
 428 }
 429
 430 /*
 431  * N-way merge "len" trees.  Returns 0 on success, -1 on failure to manipulate the
 432  * resulting index, -2 on failure to reflect the changes to the work tree.
 433  */
 434 int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options *o)
 435 {
 436         int i, ret;
 437         static struct cache_entry *dfc;
 438         struct exclude_list el;
 439
 440         if (len > MAX_UNPACK_TREES)
 441                 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES);
 442         memset(&state, 0, sizeof(state));
 443         state.base_dir = "";
 444         state.force = 1;
 445         state.quiet = 1;
 446         state.refresh_cache = 1;
 447
 448         memset(&el, 0, sizeof(el));
 449         if (!core_apply_sparse_checkout || !o->update)
 450                 o->skip_sparse_checkout = 1;
 451         if (!o->skip_sparse_checkout) {
 452                 if (add_excludes_from_file_to_list(git_path("info/sparse-checkout"), "", 0, NULL, &el, 0) < 0)
 453                         o->skip_sparse_checkout = 1;
 454                 else
 455                         o->el = &el;
 456         }
 457
 458         memset(&o->result, 0, sizeof(o->result));
 459         o->result.initialized = 1;
 460         if (o->src_index) {
 461                 o->result.timestamp.sec = o->src_index->timestamp.sec;
 462                 o->result.timestamp.nsec = o->src_index->timestamp.nsec;
 463         }
 464         o->merge_size = len;
 465
 466         if (!dfc)
 467                 dfc = xcalloc(1, cache_entry_size(0));
 468         o->df_conflict_entry = dfc;
 469
 470         if (len) {
 471                 const char *prefix = o->prefix ? o->prefix : "";
 472                 struct traverse_info info;
 473
 474                 setup_traverse_info(&info, prefix);
 475                 info.fn = unpack_callback;
 476                 info.data = o;
 477
 478                 if (traverse_trees(len, t, &info) < 0) {
 479                         ret = unpack_failed(o, NULL);
 480                         goto done;
 481                 }
 482         }
 483
 484         /* Any left-over entries in the index? */
 485         if (o->merge) {
 486                 while (o->pos < o->src_index->cache_nr) {
 487                         struct cache_entry *ce = o->src_index->cache[o->pos];
 488                         if (unpack_index_entry(ce, o) < 0) {
 489                                 ret = unpack_failed(o, NULL);
 490                                 goto done;
 491                         }
 492                 }
 493         }
 494
 495         if (o->trivial_merges_only && o->nontrivial_merge) {
 496                 ret = unpack_failed(o, "Merge requires file-level merging");
 497                 goto done;
 498         }
 499
 500         if (!o->skip_sparse_checkout) {
 501                 for (i = 0;i < o->result.cache_nr;i++) {
 502                         struct cache_entry *ce = o->result.cache[i];
 503
 504                         if (apply_sparse_checkout(ce, o)) {
 505                                 ret = -1;
 506                                 goto done;
 507                         }
 508                         /*
 509                          * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
 510                          * area as a result of ce_skip_worktree() shortcuts in
 511                          * verify_absent() and verify_uptodate(). Clear them.
 512                          */
 513                         if (ce_skip_worktree(ce))
 514                                 ce->ce_flags &= ~(CE_UPDATE | CE_REMOVE);
 515
 516                 }
 517         }
 518
 519         o->src_index = NULL;
 520         ret = check_updates(o) ? (-2) : 0;
 521         if (o->dst_index)
 522                 *o->dst_index = o->result;
 523
 524 done:
 525         for (i = 0;i < el.nr;i++)
 526                 free(el.excludes[i]);
 527         if (el.excludes)
 528                 free(el.excludes);
 529
 530         return ret;
 531 }
 532
 533 /* Here come the merge functions */
 534
 535 static int reject_merge(struct cache_entry *ce, struct unpack_trees_options *o)
 536 {
 537         return error(ERRORMSG(o, would_overwrite), ce->name);
 538 }
 539
 540 static int same(struct cache_entry *a, struct cache_entry *b)
 541 {
 542         if (!!a != !!b)
 543                 return 0;
 544         if (!a && !b)
 545                 return 1;
 546         return a->ce_mode == b->ce_mode &&
 547                !hashcmp(a->sha1, b->sha1);
 548 }
 549
 550
 551 /*
 552  * When a CE gets turned into an unmerged entry, we
 553  * want it to be up-to-date
 554  */
 555 static int verify_uptodate_1(struct cache_entry *ce,
 556                                    struct unpack_trees_options *o,
 557                                    const char *error_msg)
 558 {
 559         struct stat st;
 560
 561         if (o->index_only || (!ce_skip_worktree(ce) && (o->reset || ce_uptodate(ce))))
 562                 return 0;
 563
 564         if (!lstat(ce->name, &st)) {
 565                 unsigned changed = ie_match_stat(o->src_index, ce, &st, CE_MATCH_IGNORE_VALID);
 566                 if (!changed)
 567                         return 0;
 568                 /*
 569                  * NEEDSWORK: the current default policy is to allow
 570                  * submodule to be out of sync wrt the supermodule
 571                  * index.  This needs to be tightened later for
 572                  * submodules that are marked to be automatically
 573                  * checked out.
 574                  */
 575                 if (S_ISGITLINK(ce->ce_mode))
 576                         return 0;
 577                 errno = 0;
 578         }
 579         if (errno == ENOENT)
 580                 return 0;
 581         return o->gently ? -1 :
 582                 error(error_msg, ce->name);
 583 }
 584
 585 static int verify_uptodate(struct cache_entry *ce,
 586                            struct unpack_trees_options *o)
 587 {
 588         if (!o->skip_sparse_checkout && will_have_skip_worktree(ce, o))
 589                 return 0;
 590         return verify_uptodate_1(ce, o, ERRORMSG(o, not_uptodate_file));
 591 }
 592
 593 static int verify_uptodate_sparse(struct cache_entry *ce,
 594                                   struct unpack_trees_options *o)
 595 {
 596         return verify_uptodate_1(ce, o, ERRORMSG(o, sparse_not_uptodate_file));
 597 }
 598
 599 static void invalidate_ce_path(struct cache_entry *ce, struct unpack_trees_options *o)
 600 {
 601         if (ce)
 602                 cache_tree_invalidate_path(o->src_index->cache_tree, ce->name);
 603 }
 604
 605 /*
 606  * Check that checking out ce->sha1 in subdir ce->name is not
 607  * going to overwrite any working files.
 608  *
 609  * Currently, git does not checkout subprojects during a superproject
 610  * checkout, so it is not going to overwrite anything.
 611  */
 612 static int verify_clean_submodule(struct cache_entry *ce, const char *action,
 613                                       struct unpack_trees_options *o)
 614 {
 615         return 0;
 616 }
 617
 618 static int verify_clean_subdirectory(struct cache_entry *ce, const char *action,
 619                                       struct unpack_trees_options *o)
 620 {
 621         /*
 622          * we are about to extract "ce->name"; we would not want to lose
 623          * anything in the existing directory there.
 624          */
 625         int namelen;
 626         int i;
 627         struct dir_struct d;
 628         char *pathbuf;
 629         int cnt = 0;
 630         unsigned char sha1[20];
 631
 632         if (S_ISGITLINK(ce->ce_mode) &&
 633             resolve_gitlink_ref(ce->name, "HEAD", sha1) == 0) {
 634                 /* If we are not going to update the submodule, then
 635                  * we don't care.
 636                  */
 637                 if (!hashcmp(sha1, ce->sha1))
 638                         return 0;
 639                 return verify_clean_submodule(ce, action, o);
 640         }
 641
 642         /*
 643          * First let's make sure we do not have a local modification
 644          * in that directory.
 645          */
 646         namelen = strlen(ce->name);
 647         for (i = o->pos; i < o->src_index->cache_nr; i++) {
 648                 struct cache_entry *ce2 = o->src_index->cache[i];
 649                 int len = ce_namelen(ce2);
 650                 if (len < namelen ||
 651                     strncmp(ce->name, ce2->name, namelen) ||
 652                     ce2->name[namelen] != '/')
 653                         break;
 654                 /*
 655                  * ce2->name is an entry in the subdirectory.
 656                  */
 657                 if (!ce_stage(ce2)) {
 658                         if (verify_uptodate(ce2, o))
 659                                 return -1;
 660                         add_entry(o, ce2, CE_REMOVE, 0);
 661                 }
 662                 cnt++;
 663         }
 664
 665         /*
 666          * Then we need to make sure that we do not lose a locally
 667          * present file that is not ignored.
 668          */
 669         pathbuf = xmalloc(namelen + 2);
 670         memcpy(pathbuf, ce->name, namelen);
 671         strcpy(pathbuf+namelen, "/");
 672
 673         memset(&d, 0, sizeof(d));
 674         if (o->dir)
 675                 d.exclude_per_dir = o->dir->exclude_per_dir;
 676         i = read_directory(&d, pathbuf, namelen+1, NULL);
 677         if (i)
 678                 return o->gently ? -1 :
 679                         error(ERRORMSG(o, not_uptodate_dir), ce->name);
 680         free(pathbuf);
 681         return cnt;
 682 }
 683
 684 /*
 685  * This gets called when there was no index entry for the tree entry 'dst',
 686  * but we found a file in the working tree that 'lstat()' said was fine,
 687  * and we're on a case-insensitive filesystem.
 688  *
 689  * See if we can find a case-insensitive match in the index that also
 690  * matches the stat information, and assume it's that other file!
 691  */
 692 static int icase_exists(struct unpack_trees_options *o, struct cache_entry *dst, struct stat *st)
 693 {
 694         struct cache_entry *src;
 695
 696         src = index_name_exists(o->src_index, dst->name, ce_namelen(dst), 1);
 697         return src && !ie_match_stat(o->src_index, src, st, CE_MATCH_IGNORE_VALID);
 698 }
 699
 700 /*
 701  * We do not want to remove or overwrite a working tree file that
 702  * is not tracked, unless it is ignored.
 703  */
 704 static int verify_absent_1(struct cache_entry *ce, const char *action,
 705                                  struct unpack_trees_options *o,
 706                                  const char *error_msg)
 707 {
 708         struct stat st;
 709
 710         if (o->index_only || o->reset || !o->update)
 711                 return 0;
 712
 713         if (has_symlink_or_noent_leading_path(ce->name, ce_namelen(ce)))
 714                 return 0;
 715
 716         if (!lstat(ce->name, &st)) {
 717                 int ret;
 718                 int dtype = ce_to_dtype(ce);
 719                 struct cache_entry *result;
 720
 721                 /*
 722                  * It may be that the 'lstat()' succeeded even though
 723                  * target 'ce' was absent, because there is an old
 724                  * entry that is different only in case..
 725                  *
 726                  * Ignore that lstat() if it matches.
 727                  */
 728                 if (ignore_case && icase_exists(o, ce, &st))
 729                         return 0;
 730
 731                 if (o->dir && excluded(o->dir, ce->name, &dtype))
 732                         /*
 733                          * ce->name is explicitly excluded, so it is Ok to
 734                          * overwrite it.
 735                          */
 736                         return 0;
 737                 if (S_ISDIR(st.st_mode)) {
 738                         /*
 739                          * We are checking out path "foo" and
 740                          * found "foo/." in the working tree.
 741                          * This is tricky -- if we have modified
 742                          * files that are in "foo/" we would lose
 743                          * it.
 744                          */
 745                         ret = verify_clean_subdirectory(ce, action, o);
 746                         if (ret < 0)
 747                                 return ret;
 748
 749                         /*
 750                          * If this removed entries from the index,
 751                          * what that means is:
 752                          *
 753                          * (1) the caller unpack_callback() saw path/foo
 754                          * in the index, and it has not removed it because
 755                          * it thinks it is handling 'path' as blob with
 756                          * D/F conflict;
 757                          * (2) we will return "ok, we placed a merged entry
 758                          * in the index" which would cause o->pos to be
 759                          * incremented by one;
 760                          * (3) however, original o->pos now has 'path/foo'
 761                          * marked with "to be removed".
 762                          *
 763                          * We need to increment it by the number of
 764                          * deleted entries here.
 765                          */
 766                         o->pos += ret;
 767                         return 0;
 768                 }
 769
 770                 /*
 771                  * The previous round may already have decided to
 772                  * delete this path, which is in a subdirectory that
 773                  * is being replaced with a blob.
 774                  */
 775                 result = index_name_exists(&o->result, ce->name, ce_namelen(ce), 0);
 776                 if (result) {
 777                         if (result->ce_flags & CE_REMOVE)
 778                                 return 0;
 779                 }
 780
 781                 return o->gently ? -1 :
 782                         error(ERRORMSG(o, would_lose_untracked), ce->name, action);
 783         }
 784         return 0;
 785 }
 786 static int verify_absent(struct cache_entry *ce, const char *action,
 787                          struct unpack_trees_options *o)
 788 {
 789         if (!o->skip_sparse_checkout && will_have_skip_worktree(ce, o))
 790                 return 0;
 791         return verify_absent_1(ce, action, o, ERRORMSG(o, would_lose_untracked));
 792 }
 793
 794 static int verify_absent_sparse(struct cache_entry *ce, const char *action,
 795                          struct unpack_trees_options *o)
 796 {
 797         return verify_absent_1(ce, action, o, ERRORMSG(o, would_lose_orphaned));
 798 }
 799
 800 static int merged_entry(struct cache_entry *merge, struct cache_entry *old,
 801                 struct unpack_trees_options *o)
 802 {
 803         int update = CE_UPDATE;
 804
 805         if (old) {
 806                 /*
 807                  * See if we can re-use the old CE directly?
 808                  * That way we get the uptodate stat info.
 809                  *
 810                  * This also removes the UPDATE flag on a match; otherwise
 811                  * we will end up overwriting local changes in the work tree.
 812                  */
 813                 if (same(old, merge)) {
 814                         copy_cache_entry(merge, old);
 815                         update = 0;
 816                 } else {
 817                         if (verify_uptodate(old, o))
 818                                 return -1;
 819                         if (ce_skip_worktree(old))
 820                                 update |= CE_SKIP_WORKTREE;
 821                         invalidate_ce_path(old, o);
 822                 }
 823         }
 824         else {
 825                 if (verify_absent(merge, "overwritten", o))
 826                         return -1;
 827                 invalidate_ce_path(merge, o);
 828         }
 829
 830         add_entry(o, merge, update, CE_STAGEMASK);
 831         return 1;
 832 }
 833
 834 static int deleted_entry(struct cache_entry *ce, struct cache_entry *old,
 835                 struct unpack_trees_options *o)
 836 {
 837         /* Did it exist in the index? */
 838         if (!old) {
 839                 if (verify_absent(ce, "removed", o))
 840                         return -1;
 841                 return 0;
 842         }
 843         if (verify_uptodate(old, o))
 844                 return -1;
 845         add_entry(o, ce, CE_REMOVE, 0);
 846         invalidate_ce_path(ce, o);
 847         return 1;
 848 }
 849
 850 static int keep_entry(struct cache_entry *ce, struct unpack_trees_options *o)
 851 {
 852         add_entry(o, ce, 0, 0);
 853         return 1;
 854 }
 855
 856 #if DBRT_DEBUG
 857 static void show_stage_entry(FILE *o,
 858                              const char *label, const struct cache_entry *ce)
 859 {
 860         if (!ce)
 861                 fprintf(o, "%s (missing)\n", label);
 862         else
 863                 fprintf(o, "%s%06o %s %d\t%s\n",
 864                         label,
 865                         ce->ce_mode,
 866                         sha1_to_hex(ce->sha1),
 867                         ce_stage(ce),
 868                         ce->name);
 869 }
 870 #endif
 871
 872 int threeway_merge(struct cache_entry **stages, struct unpack_trees_options *o)
 873 {
 874         struct cache_entry *index;
 875         struct cache_entry *head;
 876         struct cache_entry *remote = stages[o->head_idx + 1];
 877         int count;
 878         int head_match = 0;
 879         int remote_match = 0;
 880
 881         int df_conflict_head = 0;
 882         int df_conflict_remote = 0;
 883
 884         int any_anc_missing = 0;
 885         int no_anc_exists = 1;
 886         int i;
 887
 888         for (i = 1; i < o->head_idx; i++) {
 889                 if (!stages[i] || stages[i] == o->df_conflict_entry)
 890                         any_anc_missing = 1;
 891                 else
 892                         no_anc_exists = 0;
 893         }
 894
 895         index = stages[0];
 896         head = stages[o->head_idx];
 897
 898         if (head == o->df_conflict_entry) {
 899                 df_conflict_head = 1;
 900                 head = NULL;
 901         }
 902
 903         if (remote == o->df_conflict_entry) {
 904                 df_conflict_remote = 1;
 905                 remote = NULL;
 906         }
 907
 908         /* First, if there's a #16 situation, note that to prevent #13
 909          * and #14.
 910          */
 911         if (!same(remote, head)) {
 912                 for (i = 1; i < o->head_idx; i++) {
 913                         if (same(stages[i], head)) {
 914                                 head_match = i;
 915                         }
 916                         if (same(stages[i], remote)) {
 917                                 remote_match = i;
 918                         }
 919                 }
 920         }
 921
 922         /* We start with cases where the index is allowed to match
 923          * something other than the head: #14(ALT) and #2ALT, where it
 924          * is permitted to match the result instead.
 925          */
 926         /* #14, #14ALT, #2ALT */
 927         if (remote && !df_conflict_head && head_match && !remote_match) {
 928                 if (index && !same(index, remote) && !same(index, head))
 929                         return o->gently ? -1 : reject_merge(index, o);
 930                 return merged_entry(remote, index, o);
 931         }
 932         /*
 933          * If we have an entry in the index cache, then we want to
 934          * make sure that it matches head.
 935          */
 936         if (index && !same(index, head))
 937                 return o->gently ? -1 : reject_merge(index, o);
 938
 939         if (head) {
 940                 /* #5ALT, #15 */
 941                 if (same(head, remote))
 942                         return merged_entry(head, index, o);
 943                 /* #13, #3ALT */
 944                 if (!df_conflict_remote && remote_match && !head_match)
 945                         return merged_entry(head, index, o);
 946         }
 947
 948         /* #1 */
 949         if (!head && !remote && any_anc_missing)
 950                 return 0;
 951
 952         /* Under the new "aggressive" rule, we resolve mostly trivial
 953          * cases that we historically had git-merge-one-file resolve.
 954          */
 955         if (o->aggressive) {
 956                 int head_deleted = !head && !df_conflict_head;
 957                 int remote_deleted = !remote && !df_conflict_remote;
 958                 struct cache_entry *ce = NULL;
 959
 960                 if (index)
 961                         ce = index;
 962                 else if (head)
 963                         ce = head;
 964                 else if (remote)
 965                         ce = remote;
 966                 else {
 967                         for (i = 1; i < o->head_idx; i++) {
 968                                 if (stages[i] && stages[i] != o->df_conflict_entry) {
 969                                         ce = stages[i];
 970                                         break;
 971                                 }
 972                         }
 973                 }
 974
 975                 /*
 976                  * Deleted in both.
 977                  * Deleted in one and unchanged in the other.
 978                  */
 979                 if ((head_deleted && remote_deleted) ||
 980                     (head_deleted && remote && remote_match) ||
 981                     (remote_deleted && head && head_match)) {
 982                         if (index)
 983                                 return deleted_entry(index, index, o);
 984                         if (ce && !head_deleted) {
 985                                 if (verify_absent(ce, "removed", o))
 986                                         return -1;
 987                         }
 988                         return 0;
 989                 }
 990                 /*
 991                  * Added in both, identically.
 992                  */
 993                 if (no_anc_exists && head && remote && same(head, remote))
 994                         return merged_entry(head, index, o);
 995
 996         }
 997
 998         /* Below are "no merge" cases, which require that the index be
 999          * up-to-date to avoid the files getting overwritten with
1000          * conflict resolution files.
1001          */
1002         if (index) {
1003                 if (verify_uptodate(index, o))
1004                         return -1;
1005         }
1006
1007         o->nontrivial_merge = 1;
1008
1009         /* #2, #3, #4, #6, #7, #9, #10, #11. */
1010         count = 0;
1011         if (!head_match || !remote_match) {
1012                 for (i = 1; i < o->head_idx; i++) {
1013                         if (stages[i] && stages[i] != o->df_conflict_entry) {
1014                                 keep_entry(stages[i], o);
1015                                 count++;
1016                                 break;
1017                         }
1018                 }
1019         }
1020 #if DBRT_DEBUG
1021         else {
1022                 fprintf(stderr, "read-tree: warning #16 detected\n");
1023                 show_stage_entry(stderr, "head   ", stages[head_match]);
1024                 show_stage_entry(stderr, "remote ", stages[remote_match]);
1025         }
1026 #endif
1027         if (head) { count += keep_entry(head, o); }
1028         if (remote) { count += keep_entry(remote, o); }
1029         return count;
1030 }
1031
1032 /*
1033  * Two-way merge.
1034  *
1035  * The rule is to "carry forward" what is in the index without losing
1036  * information across a "fast forward", favoring a successful merge
1037  * over a merge failure when it makes sense.  For details of the
1038  * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
1039  *
1040  */
1041 int twoway_merge(struct cache_entry **src, struct unpack_trees_options *o)
1042 {
1043         struct cache_entry *current = src[0];
1044         struct cache_entry *oldtree = src[1];
1045         struct cache_entry *newtree = src[2];
1046
1047         if (o->merge_size != 2)
1048                 return error("Cannot do a twoway merge of %d trees",
1049                              o->merge_size);
1050
1051         if (oldtree == o->df_conflict_entry)
1052                 oldtree = NULL;
1053         if (newtree == o->df_conflict_entry)
1054                 newtree = NULL;
1055
1056         if (current) {
1057                 if ((!oldtree && !newtree) || /* 4 and 5 */
1058                     (!oldtree && newtree &&
1059                      same(current, newtree)) || /* 6 and 7 */
1060                     (oldtree && newtree &&
1061                      same(oldtree, newtree)) || /* 14 and 15 */
1062                     (oldtree && newtree &&
1063                      !same(oldtree, newtree) && /* 18 and 19 */
1064                      same(current, newtree))) {
1065                         return keep_entry(current, o);
1066                 }
1067                 else if (oldtree && !newtree && same(current, oldtree)) {
1068                         /* 10 or 11 */
1069                         return deleted_entry(oldtree, current, o);
1070                 }
1071                 else if (oldtree && newtree &&
1072                          same(current, oldtree) && !same(current, newtree)) {
1073                         /* 20 or 21 */
1074                         return merged_entry(newtree, current, o);
1075                 }
1076                 else {
1077                         /* all other failures */
1078                         if (oldtree)
1079                                 return o->gently ? -1 : reject_merge(oldtree, o);
1080                         if (current)
1081                                 return o->gently ? -1 : reject_merge(current, o);
1082                         if (newtree)
1083                                 return o->gently ? -1 : reject_merge(newtree, o);
1084                         return -1;
1085                 }
1086         }
1087         else if (newtree) {
1088                 if (oldtree && !o->initial_checkout) {
1089                         /*
1090                          * deletion of the path was staged;
1091                          */
1092                         if (same(oldtree, newtree))
1093                                 return 1;
1094                         return reject_merge(oldtree, o);
1095                 }
1096                 return merged_entry(newtree, current, o);
1097         }
1098         return deleted_entry(oldtree, current, o);
1099 }
1100
1101 /*
1102  * Bind merge.
1103  *
1104  * Keep the index entries at stage0, collapse stage1 but make sure
1105  * stage0 does not have anything there.
1106  */
1107 int bind_merge(struct cache_entry **src,
1108                 struct unpack_trees_options *o)
1109 {
1110         struct cache_entry *old = src[0];
1111         struct cache_entry *a = src[1];
1112
1113         if (o->merge_size != 1)
1114                 return error("Cannot do a bind merge of %d trees\n",
1115                              o->merge_size);
1116         if (a && old)
1117                 return o->gently ? -1 :
1118                         error(ERRORMSG(o, bind_overlap), a->name, old->name);
1119         if (!a)
1120                 return keep_entry(old, o);
1121         else
1122                 return merged_entry(a, NULL, o);
1123 }
1124
1125 /*
1126  * One-way merge.
1127  *
1128  * The rule is:
1129  * - take the stat information from stage0, take the data from stage1
1130  */
1131 int oneway_merge(struct cache_entry **src, struct unpack_trees_options *o)
1132 {
1133         struct cache_entry *old = src[0];
1134         struct cache_entry *a = src[1];
1135
1136         if (o->merge_size != 1)
1137                 return error("Cannot do a oneway merge of %d trees",
1138                              o->merge_size);
1139
1140         if (!a || a == o->df_conflict_entry)
1141                 return deleted_entry(old, old, o);
1142
1143         if (old && same(old, a)) {
1144                 int update = 0;
1145                 if (o->reset && !ce_uptodate(old) && !ce_skip_worktree(old)) {
1146                         struct stat st;
1147                         if (lstat(old->name, &st) ||
1148                             ie_match_stat(o->src_index, old, &st, CE_MATCH_IGNORE_VALID))
1149                                 update |= CE_UPDATE;
1150                 }
1151                 add_entry(o, old, update, 0);
1152                 return 0;
1153         }
1154         return merged_entry(a, old, o);
1155 }