submodule.c

   1 #define NO_THE_INDEX_COMPATIBILITY_MACROS
   2
   3 #include "cache.h"
   4 #include "repository.h"
   5 #include "config.h"
   6 #include "submodule-config.h"
   7 #include "submodule.h"
   8 #include "dir.h"
   9 #include "diff.h"
  10 #include "commit.h"
  11 #include "revision.h"
  12 #include "run-command.h"
  13 #include "diffcore.h"
  14 #include "refs.h"
  15 #include "string-list.h"
  16 #include "sha1-array.h"
  17 #include "argv-array.h"
  18 #include "blob.h"
  19 #include "thread-utils.h"
  20 #include "quote.h"
  21 #include "remote.h"
  22 #include "worktree.h"
  23 #include "parse-options.h"
  24 #include "object-store.h"
  25
  26 static int config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
  27 static struct string_list changed_submodule_names = STRING_LIST_INIT_DUP;
  28 static int initialized_fetch_ref_tips;
  29 static struct oid_array ref_tips_before_fetch;
  30 static struct oid_array ref_tips_after_fetch;
  31
  32 /*
  33  * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
  34  * will be disabled because we can't guess what might be configured in
  35  * .gitmodules unless the user resolves the conflict.
  36  */
  37 int is_gitmodules_unmerged(const struct index_state *istate)
  38 {
  39         int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
  40         if (pos < 0) { /* .gitmodules not found or isn't merged */
  41                 pos = -1 - pos;
  42                 if (istate->cache_nr > pos) {  /* there is a .gitmodules */
  43                         const struct cache_entry *ce = istate->cache[pos];
  44                         if (ce_namelen(ce) == strlen(GITMODULES_FILE) &&
  45                             !strcmp(ce->name, GITMODULES_FILE))
  46                                 return 1;
  47                 }
  48         }
  49
  50         return 0;
  51 }
  52
  53 /*
  54  * Check if the .gitmodules file has unstaged modifications.  This must be
  55  * checked before allowing modifications to the .gitmodules file with the
  56  * intention to stage them later, because when continuing we would stage the
  57  * modifications the user didn't stage herself too. That might change in a
  58  * future version when we learn to stage the changes we do ourselves without
  59  * staging any previous modifications.
  60  */
  61 int is_staging_gitmodules_ok(struct index_state *istate)
  62 {
  63         int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
  64
  65         if ((pos >= 0) && (pos < istate->cache_nr)) {
  66                 struct stat st;
  67                 if (lstat(GITMODULES_FILE, &st) == 0 &&
  68                     ie_match_stat(istate, istate->cache[pos], &st,
  69                                   CE_MATCH_IGNORE_FSMONITOR) & DATA_CHANGED)
  70                         return 0;
  71         }
  72
  73         return 1;
  74 }
  75
  76 static int for_each_remote_ref_submodule(const char *submodule,
  77                                          each_ref_fn fn, void *cb_data)
  78 {
  79         return refs_for_each_remote_ref(get_submodule_ref_store(submodule),
  80                                         fn, cb_data);
  81 }
  82
  83 /*
  84  * Try to update the "path" entry in the "submodule.<name>" section of the
  85  * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
  86  * with the correct path=<oldpath> setting was found and we could update it.
  87  */
  88 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
  89 {
  90         struct strbuf entry = STRBUF_INIT;
  91         const struct submodule *submodule;
  92
  93         if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
  94                 return -1;
  95
  96         if (is_gitmodules_unmerged(&the_index))
  97                 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
  98
  99         submodule = submodule_from_path(the_repository, &null_oid, oldpath);
 100         if (!submodule || !submodule->name) {
 101                 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
 102                 return -1;
 103         }
 104         strbuf_addstr(&entry, "submodule.");
 105         strbuf_addstr(&entry, submodule->name);
 106         strbuf_addstr(&entry, ".path");
 107         if (git_config_set_in_file_gently(GITMODULES_FILE, entry.buf, newpath) < 0) {
 108                 /* Maybe the user already did that, don't error out here */
 109                 warning(_("Could not update .gitmodules entry %s"), entry.buf);
 110                 strbuf_release(&entry);
 111                 return -1;
 112         }
 113         strbuf_release(&entry);
 114         return 0;
 115 }
 116
 117 /*
 118  * Try to remove the "submodule.<name>" section from .gitmodules where the given
 119  * path is configured. Return 0 only if a .gitmodules file was found, a section
 120  * with the correct path=<path> setting was found and we could remove it.
 121  */
 122 int remove_path_from_gitmodules(const char *path)
 123 {
 124         struct strbuf sect = STRBUF_INIT;
 125         const struct submodule *submodule;
 126
 127         if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
 128                 return -1;
 129
 130         if (is_gitmodules_unmerged(&the_index))
 131                 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
 132
 133         submodule = submodule_from_path(the_repository, &null_oid, path);
 134         if (!submodule || !submodule->name) {
 135                 warning(_("Could not find section in .gitmodules where path=%s"), path);
 136                 return -1;
 137         }
 138         strbuf_addstr(&sect, "submodule.");
 139         strbuf_addstr(&sect, submodule->name);
 140         if (git_config_rename_section_in_file(GITMODULES_FILE, sect.buf, NULL) < 0) {
 141                 /* Maybe the user already did that, don't error out here */
 142                 warning(_("Could not remove .gitmodules entry for %s"), path);
 143                 strbuf_release(&sect);
 144                 return -1;
 145         }
 146         strbuf_release(&sect);
 147         return 0;
 148 }
 149
 150 void stage_updated_gitmodules(struct index_state *istate)
 151 {
 152         if (add_file_to_index(istate, GITMODULES_FILE, 0))
 153                 die(_("staging updated .gitmodules failed"));
 154 }
 155
 156 /* TODO: remove this function, use repo_submodule_init instead. */
 157 int add_submodule_odb(const char *path)
 158 {
 159         struct strbuf objects_directory = STRBUF_INIT;
 160         int ret = 0;
 161
 162         ret = strbuf_git_path_submodule(&objects_directory, path, "objects/");
 163         if (ret)
 164                 goto done;
 165         if (!is_directory(objects_directory.buf)) {
 166                 ret = -1;
 167                 goto done;
 168         }
 169         add_to_alternates_memory(objects_directory.buf);
 170 done:
 171         strbuf_release(&objects_directory);
 172         return ret;
 173 }
 174
 175 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
 176                                              const char *path)
 177 {
 178         const struct submodule *submodule = submodule_from_path(the_repository,
 179                                                                 &null_oid, path);
 180         if (submodule) {
 181                 const char *ignore;
 182                 char *key;
 183
 184                 key = xstrfmt("submodule.%s.ignore", submodule->name);
 185                 if (repo_config_get_string_const(the_repository, key, &ignore))
 186                         ignore = submodule->ignore;
 187                 free(key);
 188
 189                 if (ignore)
 190                         handle_ignore_submodules_arg(diffopt, ignore);
 191                 else if (is_gitmodules_unmerged(&the_index))
 192                         diffopt->flags.ignore_submodules = 1;
 193         }
 194 }
 195
 196 /* Cheap function that only determines if we're interested in submodules at all */
 197 int git_default_submodule_config(const char *var, const char *value, void *cb)
 198 {
 199         if (!strcmp(var, "submodule.recurse")) {
 200                 int v = git_config_bool(var, value) ?
 201                         RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
 202                 config_update_recurse_submodules = v;
 203         }
 204         return 0;
 205 }
 206
 207 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
 208                                                      const char *arg, int unset)
 209 {
 210         if (unset) {
 211                 config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
 212                 return 0;
 213         }
 214         if (arg)
 215                 config_update_recurse_submodules =
 216                         parse_update_recurse_submodules_arg(opt->long_name,
 217                                                             arg);
 218         else
 219                 config_update_recurse_submodules = RECURSE_SUBMODULES_ON;
 220
 221         return 0;
 222 }
 223
 224 /*
 225  * Determine if a submodule has been initialized at a given 'path'
 226  */
 227 int is_submodule_active(struct repository *repo, const char *path)
 228 {
 229         int ret = 0;
 230         char *key = NULL;
 231         char *value = NULL;
 232         const struct string_list *sl;
 233         const struct submodule *module;
 234
 235         module = submodule_from_path(repo, &null_oid, path);
 236
 237         /* early return if there isn't a path->module mapping */
 238         if (!module)
 239                 return 0;
 240
 241         /* submodule.<name>.active is set */
 242         key = xstrfmt("submodule.%s.active", module->name);
 243         if (!repo_config_get_bool(repo, key, &ret)) {
 244                 free(key);
 245                 return ret;
 246         }
 247         free(key);
 248
 249         /* submodule.active is set */
 250         sl = repo_config_get_value_multi(repo, "submodule.active");
 251         if (sl) {
 252                 struct pathspec ps;
 253                 struct argv_array args = ARGV_ARRAY_INIT;
 254                 const struct string_list_item *item;
 255
 256                 for_each_string_list_item(item, sl) {
 257                         argv_array_push(&args, item->string);
 258                 }
 259
 260                 parse_pathspec(&ps, 0, 0, NULL, args.argv);
 261                 ret = match_pathspec(&ps, path, strlen(path), 0, NULL, 1);
 262
 263                 argv_array_clear(&args);
 264                 clear_pathspec(&ps);
 265                 return ret;
 266         }
 267
 268         /* fallback to checking if the URL is set */
 269         key = xstrfmt("submodule.%s.url", module->name);
 270         ret = !repo_config_get_string(repo, key, &value);
 271
 272         free(value);
 273         free(key);
 274         return ret;
 275 }
 276
 277 int is_submodule_populated_gently(const char *path, int *return_error_code)
 278 {
 279         int ret = 0;
 280         char *gitdir = xstrfmt("%s/.git", path);
 281
 282         if (resolve_gitdir_gently(gitdir, return_error_code))
 283                 ret = 1;
 284
 285         free(gitdir);
 286         return ret;
 287 }
 288
 289 /*
 290  * Dies if the provided 'prefix' corresponds to an unpopulated submodule
 291  */
 292 void die_in_unpopulated_submodule(const struct index_state *istate,
 293                                   const char *prefix)
 294 {
 295         int i, prefixlen;
 296
 297         if (!prefix)
 298                 return;
 299
 300         prefixlen = strlen(prefix);
 301
 302         for (i = 0; i < istate->cache_nr; i++) {
 303                 struct cache_entry *ce = istate->cache[i];
 304                 int ce_len = ce_namelen(ce);
 305
 306                 if (!S_ISGITLINK(ce->ce_mode))
 307                         continue;
 308                 if (prefixlen <= ce_len)
 309                         continue;
 310                 if (strncmp(ce->name, prefix, ce_len))
 311                         continue;
 312                 if (prefix[ce_len] != '/')
 313                         continue;
 314
 315                 die(_("in unpopulated submodule '%s'"), ce->name);
 316         }
 317 }
 318
 319 /*
 320  * Dies if any paths in the provided pathspec descends into a submodule
 321  */
 322 void die_path_inside_submodule(const struct index_state *istate,
 323                                const struct pathspec *ps)
 324 {
 325         int i, j;
 326
 327         for (i = 0; i < istate->cache_nr; i++) {
 328                 struct cache_entry *ce = istate->cache[i];
 329                 int ce_len = ce_namelen(ce);
 330
 331                 if (!S_ISGITLINK(ce->ce_mode))
 332                         continue;
 333
 334                 for (j = 0; j < ps->nr ; j++) {
 335                         const struct pathspec_item *item = &ps->items[j];
 336
 337                         if (item->len <= ce_len)
 338                                 continue;
 339                         if (item->match[ce_len] != '/')
 340                                 continue;
 341                         if (strncmp(ce->name, item->match, ce_len))
 342                                 continue;
 343                         if (item->len == ce_len + 1)
 344                                 continue;
 345
 346                         die(_("Pathspec '%s' is in submodule '%.*s'"),
 347                             item->original, ce_len, ce->name);
 348                 }
 349         }
 350 }
 351
 352 enum submodule_update_type parse_submodule_update_type(const char *value)
 353 {
 354         if (!strcmp(value, "none"))
 355                 return SM_UPDATE_NONE;
 356         else if (!strcmp(value, "checkout"))
 357                 return SM_UPDATE_CHECKOUT;
 358         else if (!strcmp(value, "rebase"))
 359                 return SM_UPDATE_REBASE;
 360         else if (!strcmp(value, "merge"))
 361                 return SM_UPDATE_MERGE;
 362         else if (*value == '!')
 363                 return SM_UPDATE_COMMAND;
 364         else
 365                 return SM_UPDATE_UNSPECIFIED;
 366 }
 367
 368 int parse_submodule_update_strategy(const char *value,
 369                 struct submodule_update_strategy *dst)
 370 {
 371         enum submodule_update_type type;
 372
 373         free((void*)dst->command);
 374         dst->command = NULL;
 375
 376         type = parse_submodule_update_type(value);
 377         if (type == SM_UPDATE_UNSPECIFIED)
 378                 return -1;
 379
 380         dst->type = type;
 381         if (type == SM_UPDATE_COMMAND)
 382                 dst->command = xstrdup(value + 1);
 383
 384         return 0;
 385 }
 386
 387 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
 388 {
 389         struct strbuf sb = STRBUF_INIT;
 390         switch (s->type) {
 391         case SM_UPDATE_CHECKOUT:
 392                 return "checkout";
 393         case SM_UPDATE_MERGE:
 394                 return "merge";
 395         case SM_UPDATE_REBASE:
 396                 return "rebase";
 397         case SM_UPDATE_NONE:
 398                 return "none";
 399         case SM_UPDATE_UNSPECIFIED:
 400                 return NULL;
 401         case SM_UPDATE_COMMAND:
 402                 strbuf_addf(&sb, "!%s", s->command);
 403                 return strbuf_detach(&sb, NULL);
 404         }
 405         return NULL;
 406 }
 407
 408 void handle_ignore_submodules_arg(struct diff_options *diffopt,
 409                                   const char *arg)
 410 {
 411         diffopt->flags.ignore_submodules = 0;
 412         diffopt->flags.ignore_untracked_in_submodules = 0;
 413         diffopt->flags.ignore_dirty_submodules = 0;
 414
 415         if (!strcmp(arg, "all"))
 416                 diffopt->flags.ignore_submodules = 1;
 417         else if (!strcmp(arg, "untracked"))
 418                 diffopt->flags.ignore_untracked_in_submodules = 1;
 419         else if (!strcmp(arg, "dirty"))
 420                 diffopt->flags.ignore_dirty_submodules = 1;
 421         else if (strcmp(arg, "none"))
 422                 die("bad --ignore-submodules argument: %s", arg);
 423 }
 424
 425 static int prepare_submodule_summary(struct rev_info *rev, const char *path,
 426                 struct commit *left, struct commit *right,
 427                 struct commit_list *merge_bases)
 428 {
 429         struct commit_list *list;
 430
 431         init_revisions(rev, NULL);
 432         setup_revisions(0, NULL, rev, NULL);
 433         rev->left_right = 1;
 434         rev->first_parent_only = 1;
 435         left->object.flags |= SYMMETRIC_LEFT;
 436         add_pending_object(rev, &left->object, path);
 437         add_pending_object(rev, &right->object, path);
 438         for (list = merge_bases; list; list = list->next) {
 439                 list->item->object.flags |= UNINTERESTING;
 440                 add_pending_object(rev, &list->item->object,
 441                         oid_to_hex(&list->item->object.oid));
 442         }
 443         return prepare_revision_walk(rev);
 444 }
 445
 446 static void print_submodule_summary(struct rev_info *rev, struct diff_options *o)
 447 {
 448         static const char format[] = "  %m %s";
 449         struct strbuf sb = STRBUF_INIT;
 450         struct commit *commit;
 451
 452         while ((commit = get_revision(rev))) {
 453                 struct pretty_print_context ctx = {0};
 454                 ctx.date_mode = rev->date_mode;
 455                 ctx.output_encoding = get_log_output_encoding();
 456                 strbuf_setlen(&sb, 0);
 457                 format_commit_message(commit, format, &sb, &ctx);
 458                 strbuf_addch(&sb, '\n');
 459                 if (commit->object.flags & SYMMETRIC_LEFT)
 460                         diff_emit_submodule_del(o, sb.buf);
 461                 else
 462                         diff_emit_submodule_add(o, sb.buf);
 463         }
 464         strbuf_release(&sb);
 465 }
 466
 467 static void prepare_submodule_repo_env_no_git_dir(struct argv_array *out)
 468 {
 469         const char * const *var;
 470
 471         for (var = local_repo_env; *var; var++) {
 472                 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
 473                         argv_array_push(out, *var);
 474         }
 475 }
 476
 477 void prepare_submodule_repo_env(struct argv_array *out)
 478 {
 479         prepare_submodule_repo_env_no_git_dir(out);
 480         argv_array_pushf(out, "%s=%s", GIT_DIR_ENVIRONMENT,
 481                          DEFAULT_GIT_DIR_ENVIRONMENT);
 482 }
 483
 484 /* Helper function to display the submodule header line prior to the full
 485  * summary output. If it can locate the submodule objects directory it will
 486  * attempt to lookup both the left and right commits and put them into the
 487  * left and right pointers.
 488  */
 489 static void show_submodule_header(struct diff_options *o, const char *path,
 490                 struct object_id *one, struct object_id *two,
 491                 unsigned dirty_submodule,
 492                 struct commit **left, struct commit **right,
 493                 struct commit_list **merge_bases)
 494 {
 495         const char *message = NULL;
 496         struct strbuf sb = STRBUF_INIT;
 497         int fast_forward = 0, fast_backward = 0;
 498
 499         if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
 500                 diff_emit_submodule_untracked(o, path);
 501
 502         if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
 503                 diff_emit_submodule_modified(o, path);
 504
 505         if (is_null_oid(one))
 506                 message = "(new submodule)";
 507         else if (is_null_oid(two))
 508                 message = "(submodule deleted)";
 509
 510         if (add_submodule_odb(path)) {
 511                 if (!message)
 512                         message = "(commits not present)";
 513                 goto output_header;
 514         }
 515
 516         /*
 517          * Attempt to lookup the commit references, and determine if this is
 518          * a fast forward or fast backwards update.
 519          */
 520         *left = lookup_commit_reference(one);
 521         *right = lookup_commit_reference(two);
 522
 523         /*
 524          * Warn about missing commits in the submodule project, but only if
 525          * they aren't null.
 526          */
 527         if ((!is_null_oid(one) && !*left) ||
 528              (!is_null_oid(two) && !*right))
 529                 message = "(commits not present)";
 530
 531         *merge_bases = get_merge_bases(*left, *right);
 532         if (*merge_bases) {
 533                 if ((*merge_bases)->item == *left)
 534                         fast_forward = 1;
 535                 else if ((*merge_bases)->item == *right)
 536                         fast_backward = 1;
 537         }
 538
 539         if (!oidcmp(one, two)) {
 540                 strbuf_release(&sb);
 541                 return;
 542         }
 543
 544 output_header:
 545         strbuf_addf(&sb, "Submodule %s ", path);
 546         strbuf_add_unique_abbrev(&sb, one, DEFAULT_ABBREV);
 547         strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
 548         strbuf_add_unique_abbrev(&sb, two, DEFAULT_ABBREV);
 549         if (message)
 550                 strbuf_addf(&sb, " %s\n", message);
 551         else
 552                 strbuf_addf(&sb, "%s:\n", fast_backward ? " (rewind)" : "");
 553         diff_emit_submodule_header(o, sb.buf);
 554
 555         strbuf_release(&sb);
 556 }
 557
 558 void show_submodule_summary(struct diff_options *o, const char *path,
 559                 struct object_id *one, struct object_id *two,
 560                 unsigned dirty_submodule)
 561 {
 562         struct rev_info rev;
 563         struct commit *left = NULL, *right = NULL;
 564         struct commit_list *merge_bases = NULL;
 565
 566         show_submodule_header(o, path, one, two, dirty_submodule,
 567                               &left, &right, &merge_bases);
 568
 569         /*
 570          * If we don't have both a left and a right pointer, there is no
 571          * reason to try and display a summary. The header line should contain
 572          * all the information the user needs.
 573          */
 574         if (!left || !right)
 575                 goto out;
 576
 577         /* Treat revision walker failure the same as missing commits */
 578         if (prepare_submodule_summary(&rev, path, left, right, merge_bases)) {
 579                 diff_emit_submodule_error(o, "(revision walker failed)\n");
 580                 goto out;
 581         }
 582
 583         print_submodule_summary(&rev, o);
 584
 585 out:
 586         if (merge_bases)
 587                 free_commit_list(merge_bases);
 588         clear_commit_marks(left, ~0);
 589         clear_commit_marks(right, ~0);
 590 }
 591
 592 void show_submodule_inline_diff(struct diff_options *o, const char *path,
 593                 struct object_id *one, struct object_id *two,
 594                 unsigned dirty_submodule)
 595 {
 596         const struct object_id *old_oid = the_hash_algo->empty_tree, *new_oid = the_hash_algo->empty_tree;
 597         struct commit *left = NULL, *right = NULL;
 598         struct commit_list *merge_bases = NULL;
 599         struct child_process cp = CHILD_PROCESS_INIT;
 600         struct strbuf sb = STRBUF_INIT;
 601
 602         show_submodule_header(o, path, one, two, dirty_submodule,
 603                               &left, &right, &merge_bases);
 604
 605         /* We need a valid left and right commit to display a difference */
 606         if (!(left || is_null_oid(one)) ||
 607             !(right || is_null_oid(two)))
 608                 goto done;
 609
 610         if (left)
 611                 old_oid = one;
 612         if (right)
 613                 new_oid = two;
 614
 615         cp.git_cmd = 1;
 616         cp.dir = path;
 617         cp.out = -1;
 618         cp.no_stdin = 1;
 619
 620         /* TODO: other options may need to be passed here. */
 621         argv_array_pushl(&cp.args, "diff", "--submodule=diff", NULL);
 622         argv_array_pushf(&cp.args, "--color=%s", want_color(o->use_color) ?
 623                          "always" : "never");
 624
 625         if (o->flags.reverse_diff) {
 626                 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
 627                                  o->b_prefix, path);
 628                 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
 629                                  o->a_prefix, path);
 630         } else {
 631                 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
 632                                  o->a_prefix, path);
 633                 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
 634                                  o->b_prefix, path);
 635         }
 636         argv_array_push(&cp.args, oid_to_hex(old_oid));
 637         /*
 638          * If the submodule has modified content, we will diff against the
 639          * work tree, under the assumption that the user has asked for the
 640          * diff format and wishes to actually see all differences even if they
 641          * haven't yet been committed to the submodule yet.
 642          */
 643         if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
 644                 argv_array_push(&cp.args, oid_to_hex(new_oid));
 645
 646         prepare_submodule_repo_env(&cp.env_array);
 647         if (start_command(&cp))
 648                 diff_emit_submodule_error(o, "(diff failed)\n");
 649
 650         while (strbuf_getwholeline_fd(&sb, cp.out, '\n') != EOF)
 651                 diff_emit_submodule_pipethrough(o, sb.buf, sb.len);
 652
 653         if (finish_command(&cp))
 654                 diff_emit_submodule_error(o, "(diff failed)\n");
 655
 656 done:
 657         strbuf_release(&sb);
 658         if (merge_bases)
 659                 free_commit_list(merge_bases);
 660         if (left)
 661                 clear_commit_marks(left, ~0);
 662         if (right)
 663                 clear_commit_marks(right, ~0);
 664 }
 665
 666 int should_update_submodules(void)
 667 {
 668         return config_update_recurse_submodules == RECURSE_SUBMODULES_ON;
 669 }
 670
 671 const struct submodule *submodule_from_ce(const struct cache_entry *ce)
 672 {
 673         if (!S_ISGITLINK(ce->ce_mode))
 674                 return NULL;
 675
 676         if (!should_update_submodules())
 677                 return NULL;
 678
 679         return submodule_from_path(the_repository, &null_oid, ce->name);
 680 }
 681
 682 static struct oid_array *submodule_commits(struct string_list *submodules,
 683                                            const char *name)
 684 {
 685         struct string_list_item *item;
 686
 687         item = string_list_insert(submodules, name);
 688         if (item->util)
 689                 return (struct oid_array *) item->util;
 690
 691         /* NEEDSWORK: should we have oid_array_init()? */
 692         item->util = xcalloc(1, sizeof(struct oid_array));
 693         return (struct oid_array *) item->util;
 694 }
 695
 696 struct collect_changed_submodules_cb_data {
 697         struct string_list *changed;
 698         const struct object_id *commit_oid;
 699 };
 700
 701 /*
 702  * this would normally be two functions: default_name_from_path() and
 703  * path_from_default_name(). Since the default name is the same as
 704  * the submodule path we can get away with just one function which only
 705  * checks whether there is a submodule in the working directory at that
 706  * location.
 707  */
 708 static const char *default_name_or_path(const char *path_or_name)
 709 {
 710         int error_code;
 711
 712         if (!is_submodule_populated_gently(path_or_name, &error_code))
 713                 return NULL;
 714
 715         return path_or_name;
 716 }
 717
 718 static void collect_changed_submodules_cb(struct diff_queue_struct *q,
 719                                           struct diff_options *options,
 720                                           void *data)
 721 {
 722         struct collect_changed_submodules_cb_data *me = data;
 723         struct string_list *changed = me->changed;
 724         const struct object_id *commit_oid = me->commit_oid;
 725         int i;
 726
 727         for (i = 0; i < q->nr; i++) {
 728                 struct diff_filepair *p = q->queue[i];
 729                 struct oid_array *commits;
 730                 const struct submodule *submodule;
 731                 const char *name;
 732
 733                 if (!S_ISGITLINK(p->two->mode))
 734                         continue;
 735
 736                 submodule = submodule_from_path(the_repository,
 737                                                 commit_oid, p->two->path);
 738                 if (submodule)
 739                         name = submodule->name;
 740                 else {
 741                         name = default_name_or_path(p->two->path);
 742                         /* make sure name does not collide with existing one */
 743                         submodule = submodule_from_name(the_repository, commit_oid, name);
 744                         if (submodule) {
 745                                 warning("Submodule in commit %s at path: "
 746                                         "'%s' collides with a submodule named "
 747                                         "the same. Skipping it.",
 748                                         oid_to_hex(commit_oid), name);
 749                                 name = NULL;
 750                         }
 751                 }
 752
 753                 if (!name)
 754                         continue;
 755
 756                 commits = submodule_commits(changed, name);
 757                 oid_array_append(commits, &p->two->oid);
 758         }
 759 }
 760
 761 /*
 762  * Collect the paths of submodules in 'changed' which have changed based on
 763  * the revisions as specified in 'argv'.  Each entry in 'changed' will also
 764  * have a corresponding 'struct oid_array' (in the 'util' field) which lists
 765  * what the submodule pointers were updated to during the change.
 766  */
 767 static void collect_changed_submodules(struct string_list *changed,
 768                                        struct argv_array *argv)
 769 {
 770         struct rev_info rev;
 771         const struct commit *commit;
 772
 773         init_revisions(&rev, NULL);
 774         setup_revisions(argv->argc, argv->argv, &rev, NULL);
 775         if (prepare_revision_walk(&rev))
 776                 die("revision walk setup failed");
 777
 778         while ((commit = get_revision(&rev))) {
 779                 struct rev_info diff_rev;
 780                 struct collect_changed_submodules_cb_data data;
 781                 data.changed = changed;
 782                 data.commit_oid = &commit->object.oid;
 783
 784                 init_revisions(&diff_rev, NULL);
 785                 diff_rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
 786                 diff_rev.diffopt.format_callback = collect_changed_submodules_cb;
 787                 diff_rev.diffopt.format_callback_data = &data;
 788                 diff_tree_combined_merge(commit, 1, &diff_rev);
 789         }
 790
 791         reset_revision_walk();
 792 }
 793
 794 static void free_submodules_oids(struct string_list *submodules)
 795 {
 796         struct string_list_item *item;
 797         for_each_string_list_item(item, submodules)
 798                 oid_array_clear((struct oid_array *) item->util);
 799         string_list_clear(submodules, 1);
 800 }
 801
 802 static int has_remote(const char *refname, const struct object_id *oid,
 803                       int flags, void *cb_data)
 804 {
 805         return 1;
 806 }
 807
 808 static int append_oid_to_argv(const struct object_id *oid, void *data)
 809 {
 810         struct argv_array *argv = data;
 811         argv_array_push(argv, oid_to_hex(oid));
 812         return 0;
 813 }
 814
 815 struct has_commit_data {
 816         int result;
 817         const char *path;
 818 };
 819
 820 static int check_has_commit(const struct object_id *oid, void *data)
 821 {
 822         struct has_commit_data *cb = data;
 823
 824         enum object_type type = oid_object_info(the_repository, oid, NULL);
 825
 826         switch (type) {
 827         case OBJ_COMMIT:
 828                 return 0;
 829         case OBJ_BAD:
 830                 /*
 831                  * Object is missing or invalid. If invalid, an error message
 832                  * has already been printed.
 833                  */
 834                 cb->result = 0;
 835                 return 0;
 836         default:
 837                 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
 838                     cb->path, oid_to_hex(oid), type_name(type));
 839         }
 840 }
 841
 842 static int submodule_has_commits(const char *path, struct oid_array *commits)
 843 {
 844         struct has_commit_data has_commit = { 1, path };
 845
 846         /*
 847          * Perform a cheap, but incorrect check for the existence of 'commits'.
 848          * This is done by adding the submodule's object store to the in-core
 849          * object store, and then querying for each commit's existence.  If we
 850          * do not have the commit object anywhere, there is no chance we have
 851          * it in the object store of the correct submodule and have it
 852          * reachable from a ref, so we can fail early without spawning rev-list
 853          * which is expensive.
 854          */
 855         if (add_submodule_odb(path))
 856                 return 0;
 857
 858         oid_array_for_each_unique(commits, check_has_commit, &has_commit);
 859
 860         if (has_commit.result) {
 861                 /*
 862                  * Even if the submodule is checked out and the commit is
 863                  * present, make sure it exists in the submodule's object store
 864                  * and that it is reachable from a ref.
 865                  */
 866                 struct child_process cp = CHILD_PROCESS_INIT;
 867                 struct strbuf out = STRBUF_INIT;
 868
 869                 argv_array_pushl(&cp.args, "rev-list", "-n", "1", NULL);
 870                 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
 871                 argv_array_pushl(&cp.args, "--not", "--all", NULL);
 872
 873                 prepare_submodule_repo_env(&cp.env_array);
 874                 cp.git_cmd = 1;
 875                 cp.no_stdin = 1;
 876                 cp.dir = path;
 877
 878                 if (capture_command(&cp, &out, GIT_MAX_HEXSZ + 1) || out.len)
 879                         has_commit.result = 0;
 880
 881                 strbuf_release(&out);
 882         }
 883
 884         return has_commit.result;
 885 }
 886
 887 static int submodule_needs_pushing(const char *path, struct oid_array *commits)
 888 {
 889         if (!submodule_has_commits(path, commits))
 890                 /*
 891                  * NOTE: We do consider it safe to return "no" here. The
 892                  * correct answer would be "We do not know" instead of
 893                  * "No push needed", but it is quite hard to change
 894                  * the submodule pointer without having the submodule
 895                  * around. If a user did however change the submodules
 896                  * without having the submodule around, this indicates
 897                  * an expert who knows what they are doing or a
 898                  * maintainer integrating work from other people. In
 899                  * both cases it should be safe to skip this check.
 900                  */
 901                 return 0;
 902
 903         if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
 904                 struct child_process cp = CHILD_PROCESS_INIT;
 905                 struct strbuf buf = STRBUF_INIT;
 906                 int needs_pushing = 0;
 907
 908                 argv_array_push(&cp.args, "rev-list");
 909                 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
 910                 argv_array_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
 911
 912                 prepare_submodule_repo_env(&cp.env_array);
 913                 cp.git_cmd = 1;
 914                 cp.no_stdin = 1;
 915                 cp.out = -1;
 916                 cp.dir = path;
 917                 if (start_command(&cp))
 918                         die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
 919                                         path);
 920                 if (strbuf_read(&buf, cp.out, 41))
 921                         needs_pushing = 1;
 922                 finish_command(&cp);
 923                 close(cp.out);
 924                 strbuf_release(&buf);
 925                 return needs_pushing;
 926         }
 927
 928         return 0;
 929 }
 930
 931 int find_unpushed_submodules(struct oid_array *commits,
 932                 const char *remotes_name, struct string_list *needs_pushing)
 933 {
 934         struct string_list submodules = STRING_LIST_INIT_DUP;
 935         struct string_list_item *name;
 936         struct argv_array argv = ARGV_ARRAY_INIT;
 937
 938         /* argv.argv[0] will be ignored by setup_revisions */
 939         argv_array_push(&argv, "find_unpushed_submodules");
 940         oid_array_for_each_unique(commits, append_oid_to_argv, &argv);
 941         argv_array_push(&argv, "--not");
 942         argv_array_pushf(&argv, "--remotes=%s", remotes_name);
 943
 944         collect_changed_submodules(&submodules, &argv);
 945
 946         for_each_string_list_item(name, &submodules) {
 947                 struct oid_array *commits = name->util;
 948                 const struct submodule *submodule;
 949                 const char *path = NULL;
 950
 951                 submodule = submodule_from_name(the_repository, &null_oid, name->string);
 952                 if (submodule)
 953                         path = submodule->path;
 954                 else
 955                         path = default_name_or_path(name->string);
 956
 957                 if (!path)
 958                         continue;
 959
 960                 if (submodule_needs_pushing(path, commits))
 961                         string_list_insert(needs_pushing, path);
 962         }
 963
 964         free_submodules_oids(&submodules);
 965         argv_array_clear(&argv);
 966
 967         return needs_pushing->nr;
 968 }
 969
 970 static int push_submodule(const char *path,
 971                           const struct remote *remote,
 972                           const struct refspec *rs,
 973                           const struct string_list *push_options,
 974                           int dry_run)
 975 {
 976         if (add_submodule_odb(path))
 977                 return 1;
 978
 979         if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
 980                 struct child_process cp = CHILD_PROCESS_INIT;
 981                 argv_array_push(&cp.args, "push");
 982                 if (dry_run)
 983                         argv_array_push(&cp.args, "--dry-run");
 984
 985                 if (push_options && push_options->nr) {
 986                         const struct string_list_item *item;
 987                         for_each_string_list_item(item, push_options)
 988                                 argv_array_pushf(&cp.args, "--push-option=%s",
 989                                                  item->string);
 990                 }
 991
 992                 if (remote->origin != REMOTE_UNCONFIGURED) {
 993                         int i;
 994                         argv_array_push(&cp.args, remote->name);
 995                         for (i = 0; i < rs->raw_nr; i++)
 996                                 argv_array_push(&cp.args, rs->raw[i]);
 997                 }
 998
 999                 prepare_submodule_repo_env(&cp.env_array);
1000                 cp.git_cmd = 1;
1001                 cp.no_stdin = 1;
1002                 cp.dir = path;
1003                 if (run_command(&cp))
1004                         return 0;
1005                 close(cp.out);
1006         }
1007
1008         return 1;
1009 }
1010
1011 /*
1012  * Perform a check in the submodule to see if the remote and refspec work.
1013  * Die if the submodule can't be pushed.
1014  */
1015 static void submodule_push_check(const char *path, const char *head,
1016                                  const struct remote *remote,
1017                                  const struct refspec *rs)
1018 {
1019         struct child_process cp = CHILD_PROCESS_INIT;
1020         int i;
1021
1022         argv_array_push(&cp.args, "submodule--helper");
1023         argv_array_push(&cp.args, "push-check");
1024         argv_array_push(&cp.args, head);
1025         argv_array_push(&cp.args, remote->name);
1026
1027         for (i = 0; i < rs->raw_nr; i++)
1028                 argv_array_push(&cp.args, rs->raw[i]);
1029
1030         prepare_submodule_repo_env(&cp.env_array);
1031         cp.git_cmd = 1;
1032         cp.no_stdin = 1;
1033         cp.no_stdout = 1;
1034         cp.dir = path;
1035
1036         /*
1037          * Simply indicate if 'submodule--helper push-check' failed.
1038          * More detailed error information will be provided by the
1039          * child process.
1040          */
1041         if (run_command(&cp))
1042                 die("process for submodule '%s' failed", path);
1043 }
1044
1045 int push_unpushed_submodules(struct oid_array *commits,
1046                              const struct remote *remote,
1047                              const struct refspec *rs,
1048                              const struct string_list *push_options,
1049                              int dry_run)
1050 {
1051         int i, ret = 1;
1052         struct string_list needs_pushing = STRING_LIST_INIT_DUP;
1053
1054         if (!find_unpushed_submodules(commits, remote->name, &needs_pushing))
1055                 return 1;
1056
1057         /*
1058          * Verify that the remote and refspec can be propagated to all
1059          * submodules.  This check can be skipped if the remote and refspec
1060          * won't be propagated due to the remote being unconfigured (e.g. a URL
1061          * instead of a remote name).
1062          */
1063         if (remote->origin != REMOTE_UNCONFIGURED) {
1064                 char *head;
1065                 struct object_id head_oid;
1066
1067                 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1068                 if (!head)
1069                         die(_("Failed to resolve HEAD as a valid ref."));
1070
1071                 for (i = 0; i < needs_pushing.nr; i++)
1072                         submodule_push_check(needs_pushing.items[i].string,
1073                                              head, remote, rs);
1074                 free(head);
1075         }
1076
1077         /* Actually push the submodules */
1078         for (i = 0; i < needs_pushing.nr; i++) {
1079                 const char *path = needs_pushing.items[i].string;
1080                 fprintf(stderr, "Pushing submodule '%s'\n", path);
1081                 if (!push_submodule(path, remote, rs,
1082                                     push_options, dry_run)) {
1083                         fprintf(stderr, "Unable to push submodule '%s'\n", path);
1084                         ret = 0;
1085                 }
1086         }
1087
1088         string_list_clear(&needs_pushing, 0);
1089
1090         return ret;
1091 }
1092
1093 static int append_oid_to_array(const char *ref, const struct object_id *oid,
1094                                int flags, void *data)
1095 {
1096         struct oid_array *array = data;
1097         oid_array_append(array, oid);
1098         return 0;
1099 }
1100
1101 void check_for_new_submodule_commits(struct object_id *oid)
1102 {
1103         if (!initialized_fetch_ref_tips) {
1104                 for_each_ref(append_oid_to_array, &ref_tips_before_fetch);
1105                 initialized_fetch_ref_tips = 1;
1106         }
1107
1108         oid_array_append(&ref_tips_after_fetch, oid);
1109 }
1110
1111 static void calculate_changed_submodule_paths(void)
1112 {
1113         struct argv_array argv = ARGV_ARRAY_INIT;
1114         struct string_list changed_submodules = STRING_LIST_INIT_DUP;
1115         const struct string_list_item *name;
1116
1117         /* No need to check if there are no submodules configured */
1118         if (!submodule_from_path(the_repository, NULL, NULL))
1119                 return;
1120
1121         argv_array_push(&argv, "--"); /* argv[0] program name */
1122         oid_array_for_each_unique(&ref_tips_after_fetch,
1123                                    append_oid_to_argv, &argv);
1124         argv_array_push(&argv, "--not");
1125         oid_array_for_each_unique(&ref_tips_before_fetch,
1126                                    append_oid_to_argv, &argv);
1127
1128         /*
1129          * Collect all submodules (whether checked out or not) for which new
1130          * commits have been recorded upstream in "changed_submodule_names".
1131          */
1132         collect_changed_submodules(&changed_submodules, &argv);
1133
1134         for_each_string_list_item(name, &changed_submodules) {
1135                 struct oid_array *commits = name->util;
1136                 const struct submodule *submodule;
1137                 const char *path = NULL;
1138
1139                 submodule = submodule_from_name(the_repository, &null_oid, name->string);
1140                 if (submodule)
1141                         path = submodule->path;
1142                 else
1143                         path = default_name_or_path(name->string);
1144
1145                 if (!path)
1146                         continue;
1147
1148                 if (!submodule_has_commits(path, commits))
1149                         string_list_append(&changed_submodule_names, name->string);
1150         }
1151
1152         free_submodules_oids(&changed_submodules);
1153         argv_array_clear(&argv);
1154         oid_array_clear(&ref_tips_before_fetch);
1155         oid_array_clear(&ref_tips_after_fetch);
1156         initialized_fetch_ref_tips = 0;
1157 }
1158
1159 int submodule_touches_in_range(struct object_id *excl_oid,
1160                                struct object_id *incl_oid)
1161 {
1162         struct string_list subs = STRING_LIST_INIT_DUP;
1163         struct argv_array args = ARGV_ARRAY_INIT;
1164         int ret;
1165
1166         /* No need to check if there are no submodules configured */
1167         if (!submodule_from_path(the_repository, NULL, NULL))
1168                 return 0;
1169
1170         argv_array_push(&args, "--"); /* args[0] program name */
1171         argv_array_push(&args, oid_to_hex(incl_oid));
1172         if (!is_null_oid(excl_oid)) {
1173                 argv_array_push(&args, "--not");
1174                 argv_array_push(&args, oid_to_hex(excl_oid));
1175         }
1176
1177         collect_changed_submodules(&subs, &args);
1178         ret = subs.nr;
1179
1180         argv_array_clear(&args);
1181
1182         free_submodules_oids(&subs);
1183         return ret;
1184 }
1185
1186 struct submodule_parallel_fetch {
1187         int count;
1188         struct argv_array args;
1189         struct repository *r;
1190         const char *prefix;
1191         int command_line_option;
1192         int default_option;
1193         int quiet;
1194         int result;
1195 };
1196 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0, 0}
1197
1198 static int get_fetch_recurse_config(const struct submodule *submodule,
1199                                     struct submodule_parallel_fetch *spf)
1200 {
1201         if (spf->command_line_option != RECURSE_SUBMODULES_DEFAULT)
1202                 return spf->command_line_option;
1203
1204         if (submodule) {
1205                 char *key;
1206                 const char *value;
1207
1208                 int fetch_recurse = submodule->fetch_recurse;
1209                 key = xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule->name);
1210                 if (!repo_config_get_string_const(spf->r, key, &value)) {
1211                         fetch_recurse = parse_fetch_recurse_submodules_arg(key, value);
1212                 }
1213                 free(key);
1214
1215                 if (fetch_recurse != RECURSE_SUBMODULES_NONE)
1216                         /* local config overrules everything except commandline */
1217                         return fetch_recurse;
1218         }
1219
1220         return spf->default_option;
1221 }
1222
1223 static int get_next_submodule(struct child_process *cp,
1224                               struct strbuf *err, void *data, void **task_cb)
1225 {
1226         int ret = 0;
1227         struct submodule_parallel_fetch *spf = data;
1228
1229         for (; spf->count < spf->r->index->cache_nr; spf->count++) {
1230                 struct strbuf submodule_path = STRBUF_INIT;
1231                 struct strbuf submodule_git_dir = STRBUF_INIT;
1232                 struct strbuf submodule_prefix = STRBUF_INIT;
1233                 const struct cache_entry *ce = spf->r->index->cache[spf->count];
1234                 const char *git_dir, *default_argv;
1235                 const struct submodule *submodule;
1236                 struct submodule default_submodule = SUBMODULE_INIT;
1237
1238                 if (!S_ISGITLINK(ce->ce_mode))
1239                         continue;
1240
1241                 submodule = submodule_from_path(spf->r, &null_oid, ce->name);
1242                 if (!submodule) {
1243                         const char *name = default_name_or_path(ce->name);
1244                         if (name) {
1245                                 default_submodule.path = default_submodule.name = name;
1246                                 submodule = &default_submodule;
1247                         }
1248                 }
1249
1250                 switch (get_fetch_recurse_config(submodule, spf))
1251                 {
1252                 default:
1253                 case RECURSE_SUBMODULES_DEFAULT:
1254                 case RECURSE_SUBMODULES_ON_DEMAND:
1255                         if (!submodule || !unsorted_string_list_lookup(&changed_submodule_names,
1256                                                          submodule->name))
1257                                 continue;
1258                         default_argv = "on-demand";
1259                         break;
1260                 case RECURSE_SUBMODULES_ON:
1261                         default_argv = "yes";
1262                         break;
1263                 case RECURSE_SUBMODULES_OFF:
1264                         continue;
1265                 }
1266
1267                 strbuf_repo_worktree_path(&submodule_path, spf->r, "%s", ce->name);
1268                 strbuf_addf(&submodule_git_dir, "%s/.git", submodule_path.buf);
1269                 strbuf_addf(&submodule_prefix, "%s%s/", spf->prefix, ce->name);
1270                 git_dir = read_gitfile(submodule_git_dir.buf);
1271                 if (!git_dir)
1272                         git_dir = submodule_git_dir.buf;
1273                 if (is_directory(git_dir)) {
1274                         child_process_init(cp);
1275                         cp->dir = strbuf_detach(&submodule_path, NULL);
1276                         prepare_submodule_repo_env(&cp->env_array);
1277                         cp->git_cmd = 1;
1278                         if (!spf->quiet)
1279                                 strbuf_addf(err, "Fetching submodule %s%s\n",
1280                                             spf->prefix, ce->name);
1281                         argv_array_init(&cp->args);
1282                         argv_array_pushv(&cp->args, spf->args.argv);
1283                         argv_array_push(&cp->args, default_argv);
1284                         argv_array_push(&cp->args, "--submodule-prefix");
1285                         argv_array_push(&cp->args, submodule_prefix.buf);
1286                         ret = 1;
1287                 }
1288                 strbuf_release(&submodule_path);
1289                 strbuf_release(&submodule_git_dir);
1290                 strbuf_release(&submodule_prefix);
1291                 if (ret) {
1292                         spf->count++;
1293                         return 1;
1294                 }
1295         }
1296         return 0;
1297 }
1298
1299 static int fetch_start_failure(struct strbuf *err,
1300                                void *cb, void *task_cb)
1301 {
1302         struct submodule_parallel_fetch *spf = cb;
1303
1304         spf->result = 1;
1305
1306         return 0;
1307 }
1308
1309 static int fetch_finish(int retvalue, struct strbuf *err,
1310                         void *cb, void *task_cb)
1311 {
1312         struct submodule_parallel_fetch *spf = cb;
1313
1314         if (retvalue)
1315                 spf->result = 1;
1316
1317         return 0;
1318 }
1319
1320 int fetch_populated_submodules(struct repository *r,
1321                                const struct argv_array *options,
1322                                const char *prefix, int command_line_option,
1323                                int default_option,
1324                                int quiet, int max_parallel_jobs)
1325 {
1326         int i;
1327         struct submodule_parallel_fetch spf = SPF_INIT;
1328
1329         spf.r = r;
1330         spf.command_line_option = command_line_option;
1331         spf.default_option = default_option;
1332         spf.quiet = quiet;
1333         spf.prefix = prefix;
1334
1335         if (!r->worktree)
1336                 goto out;
1337
1338         if (repo_read_index(r) < 0)
1339                 die("index file corrupt");
1340
1341         argv_array_push(&spf.args, "fetch");
1342         for (i = 0; i < options->argc; i++)
1343                 argv_array_push(&spf.args, options->argv[i]);
1344         argv_array_push(&spf.args, "--recurse-submodules-default");
1345         /* default value, "--submodule-prefix" and its value are added later */
1346
1347         calculate_changed_submodule_paths();
1348         run_processes_parallel(max_parallel_jobs,
1349                                get_next_submodule,
1350                                fetch_start_failure,
1351                                fetch_finish,
1352                                &spf);
1353
1354         argv_array_clear(&spf.args);
1355 out:
1356         string_list_clear(&changed_submodule_names, 1);
1357         return spf.result;
1358 }
1359
1360 unsigned is_submodule_modified(const char *path, int ignore_untracked)
1361 {
1362         struct child_process cp = CHILD_PROCESS_INIT;
1363         struct strbuf buf = STRBUF_INIT;
1364         FILE *fp;
1365         unsigned dirty_submodule = 0;
1366         const char *git_dir;
1367         int ignore_cp_exit_code = 0;
1368
1369         strbuf_addf(&buf, "%s/.git", path);
1370         git_dir = read_gitfile(buf.buf);
1371         if (!git_dir)
1372                 git_dir = buf.buf;
1373         if (!is_git_directory(git_dir)) {
1374                 if (is_directory(git_dir))
1375                         die(_("'%s' not recognized as a git repository"), git_dir);
1376                 strbuf_release(&buf);
1377                 /* The submodule is not checked out, so it is not modified */
1378                 return 0;
1379         }
1380         strbuf_reset(&buf);
1381
1382         argv_array_pushl(&cp.args, "status", "--porcelain=2", NULL);
1383         if (ignore_untracked)
1384                 argv_array_push(&cp.args, "-uno");
1385
1386         prepare_submodule_repo_env(&cp.env_array);
1387         cp.git_cmd = 1;
1388         cp.no_stdin = 1;
1389         cp.out = -1;
1390         cp.dir = path;
1391         if (start_command(&cp))
1392                 die("Could not run 'git status --porcelain=2' in submodule %s", path);
1393
1394         fp = xfdopen(cp.out, "r");
1395         while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
1396                 /* regular untracked files */
1397                 if (buf.buf[0] == '?')
1398                         dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1399
1400                 if (buf.buf[0] == 'u' ||
1401                     buf.buf[0] == '1' ||
1402                     buf.buf[0] == '2') {
1403                         /* T = line type, XY = status, SSSS = submodule state */
1404                         if (buf.len < strlen("T XY SSSS"))
1405                                 BUG("invalid status --porcelain=2 line %s",
1406                                     buf.buf);
1407
1408                         if (buf.buf[5] == 'S' && buf.buf[8] == 'U')
1409                                 /* nested untracked file */
1410                                 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1411
1412                         if (buf.buf[0] == 'u' ||
1413                             buf.buf[0] == '2' ||
1414                             memcmp(buf.buf + 5, "S..U", 4))
1415                                 /* other change */
1416                                 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1417                 }
1418
1419                 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1420                     ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
1421                      ignore_untracked)) {
1422                         /*
1423                          * We're not interested in any further information from
1424                          * the child any more, neither output nor its exit code.
1425                          */
1426                         ignore_cp_exit_code = 1;
1427                         break;
1428                 }
1429         }
1430         fclose(fp);
1431
1432         if (finish_command(&cp) && !ignore_cp_exit_code)
1433                 die("'git status --porcelain=2' failed in submodule %s", path);
1434
1435         strbuf_release(&buf);
1436         return dirty_submodule;
1437 }
1438
1439 int submodule_uses_gitfile(const char *path)
1440 {
1441         struct child_process cp = CHILD_PROCESS_INIT;
1442         const char *argv[] = {
1443                 "submodule",
1444                 "foreach",
1445                 "--quiet",
1446                 "--recursive",
1447                 "test -f .git",
1448                 NULL,
1449         };
1450         struct strbuf buf = STRBUF_INIT;
1451         const char *git_dir;
1452
1453         strbuf_addf(&buf, "%s/.git", path);
1454         git_dir = read_gitfile(buf.buf);
1455         if (!git_dir) {
1456                 strbuf_release(&buf);
1457                 return 0;
1458         }
1459         strbuf_release(&buf);
1460
1461         /* Now test that all nested submodules use a gitfile too */
1462         cp.argv = argv;
1463         prepare_submodule_repo_env(&cp.env_array);
1464         cp.git_cmd = 1;
1465         cp.no_stdin = 1;
1466         cp.no_stderr = 1;
1467         cp.no_stdout = 1;
1468         cp.dir = path;
1469         if (run_command(&cp))
1470                 return 0;
1471
1472         return 1;
1473 }
1474
1475 /*
1476  * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1477  * when doing so.
1478  *
1479  * Return 1 if we'd lose data, return 0 if the removal is fine,
1480  * and negative values for errors.
1481  */
1482 int bad_to_remove_submodule(const char *path, unsigned flags)
1483 {
1484         ssize_t len;
1485         struct child_process cp = CHILD_PROCESS_INIT;
1486         struct strbuf buf = STRBUF_INIT;
1487         int ret = 0;
1488
1489         if (!file_exists(path) || is_empty_dir(path))
1490                 return 0;
1491
1492         if (!submodule_uses_gitfile(path))
1493                 return 1;
1494
1495         argv_array_pushl(&cp.args, "status", "--porcelain",
1496                                    "--ignore-submodules=none", NULL);
1497
1498         if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
1499                 argv_array_push(&cp.args, "-uno");
1500         else
1501                 argv_array_push(&cp.args, "-uall");
1502
1503         if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
1504                 argv_array_push(&cp.args, "--ignored");
1505
1506         prepare_submodule_repo_env(&cp.env_array);
1507         cp.git_cmd = 1;
1508         cp.no_stdin = 1;
1509         cp.out = -1;
1510         cp.dir = path;
1511         if (start_command(&cp)) {
1512                 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1513                         die(_("could not start 'git status' in submodule '%s'"),
1514                                 path);
1515                 ret = -1;
1516                 goto out;
1517         }
1518
1519         len = strbuf_read(&buf, cp.out, 1024);
1520         if (len > 2)
1521                 ret = 1;
1522         close(cp.out);
1523
1524         if (finish_command(&cp)) {
1525                 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1526                         die(_("could not run 'git status' in submodule '%s'"),
1527                                 path);
1528                 ret = -1;
1529         }
1530 out:
1531         strbuf_release(&buf);
1532         return ret;
1533 }
1534
1535 static const char *get_super_prefix_or_empty(void)
1536 {
1537         const char *s = get_super_prefix();
1538         if (!s)
1539                 s = "";
1540         return s;
1541 }
1542
1543 static int submodule_has_dirty_index(const struct submodule *sub)
1544 {
1545         struct child_process cp = CHILD_PROCESS_INIT;
1546
1547         prepare_submodule_repo_env(&cp.env_array);
1548
1549         cp.git_cmd = 1;
1550         argv_array_pushl(&cp.args, "diff-index", "--quiet",
1551                                    "--cached", "HEAD", NULL);
1552         cp.no_stdin = 1;
1553         cp.no_stdout = 1;
1554         cp.dir = sub->path;
1555         if (start_command(&cp))
1556                 die("could not recurse into submodule '%s'", sub->path);
1557
1558         return finish_command(&cp);
1559 }
1560
1561 static void submodule_reset_index(const char *path)
1562 {
1563         struct child_process cp = CHILD_PROCESS_INIT;
1564         prepare_submodule_repo_env(&cp.env_array);
1565
1566         cp.git_cmd = 1;
1567         cp.no_stdin = 1;
1568         cp.dir = path;
1569
1570         argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1571                                    get_super_prefix_or_empty(), path);
1572         argv_array_pushl(&cp.args, "read-tree", "-u", "--reset", NULL);
1573
1574         argv_array_push(&cp.args, empty_tree_oid_hex());
1575
1576         if (run_command(&cp))
1577                 die("could not reset submodule index");
1578 }
1579
1580 /**
1581  * Moves a submodule at a given path from a given head to another new head.
1582  * For edge cases (a submodule coming into existence or removing a submodule)
1583  * pass NULL for old or new respectively.
1584  */
1585 int submodule_move_head(const char *path,
1586                          const char *old_head,
1587                          const char *new_head,
1588                          unsigned flags)
1589 {
1590         int ret = 0;
1591         struct child_process cp = CHILD_PROCESS_INIT;
1592         const struct submodule *sub;
1593         int *error_code_ptr, error_code;
1594
1595         if (!is_submodule_active(the_repository, path))
1596                 return 0;
1597
1598         if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1599                 /*
1600                  * Pass non NULL pointer to is_submodule_populated_gently
1601                  * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1602                  * to fixup the submodule in the force case later.
1603                  */
1604                 error_code_ptr = &error_code;
1605         else
1606                 error_code_ptr = NULL;
1607
1608         if (old_head && !is_submodule_populated_gently(path, error_code_ptr))
1609                 return 0;
1610
1611         sub = submodule_from_path(the_repository, &null_oid, path);
1612
1613         if (!sub)
1614                 BUG("could not get submodule information for '%s'", path);
1615
1616         if (old_head && !(flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1617                 /* Check if the submodule has a dirty index. */
1618                 if (submodule_has_dirty_index(sub))
1619                         return error(_("submodule '%s' has dirty index"), path);
1620         }
1621
1622         if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1623                 if (old_head) {
1624                         if (!submodule_uses_gitfile(path))
1625                                 absorb_git_dir_into_superproject("", path,
1626                                         ABSORB_GITDIR_RECURSE_SUBMODULES);
1627                 } else {
1628                         char *gitdir = xstrfmt("%s/modules/%s",
1629                                     get_git_common_dir(), sub->name);
1630                         connect_work_tree_and_git_dir(path, gitdir, 0);
1631                         free(gitdir);
1632
1633                         /* make sure the index is clean as well */
1634                         submodule_reset_index(path);
1635                 }
1636
1637                 if (old_head && (flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1638                         char *gitdir = xstrfmt("%s/modules/%s",
1639                                     get_git_common_dir(), sub->name);
1640                         connect_work_tree_and_git_dir(path, gitdir, 1);
1641                         free(gitdir);
1642                 }
1643         }
1644
1645         prepare_submodule_repo_env(&cp.env_array);
1646
1647         cp.git_cmd = 1;
1648         cp.no_stdin = 1;
1649         cp.dir = path;
1650
1651         argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1652                         get_super_prefix_or_empty(), path);
1653         argv_array_pushl(&cp.args, "read-tree", "--recurse-submodules", NULL);
1654
1655         if (flags & SUBMODULE_MOVE_HEAD_DRY_RUN)
1656                 argv_array_push(&cp.args, "-n");
1657         else
1658                 argv_array_push(&cp.args, "-u");
1659
1660         if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1661                 argv_array_push(&cp.args, "--reset");
1662         else
1663                 argv_array_push(&cp.args, "-m");
1664
1665         if (!(flags & SUBMODULE_MOVE_HEAD_FORCE))
1666                 argv_array_push(&cp.args, old_head ? old_head : empty_tree_oid_hex());
1667
1668         argv_array_push(&cp.args, new_head ? new_head : empty_tree_oid_hex());
1669
1670         if (run_command(&cp)) {
1671                 ret = -1;
1672                 goto out;
1673         }
1674
1675         if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1676                 if (new_head) {
1677                         child_process_init(&cp);
1678                         /* also set the HEAD accordingly */
1679                         cp.git_cmd = 1;
1680                         cp.no_stdin = 1;
1681                         cp.dir = path;
1682
1683                         prepare_submodule_repo_env(&cp.env_array);
1684                         argv_array_pushl(&cp.args, "update-ref", "HEAD",
1685                                          "--no-deref", new_head, NULL);
1686
1687                         if (run_command(&cp)) {
1688                                 ret = -1;
1689                                 goto out;
1690                         }
1691                 } else {
1692                         struct strbuf sb = STRBUF_INIT;
1693
1694                         strbuf_addf(&sb, "%s/.git", path);
1695                         unlink_or_warn(sb.buf);
1696                         strbuf_release(&sb);
1697
1698                         if (is_empty_dir(path))
1699                                 rmdir_or_warn(path);
1700                 }
1701         }
1702 out:
1703         return ret;
1704 }
1705
1706 int validate_submodule_git_dir(char *git_dir, const char *submodule_name)
1707 {
1708         size_t len = strlen(git_dir), suffix_len = strlen(submodule_name);
1709         char *p;
1710         int ret = 0;
1711
1712         if (len <= suffix_len || (p = git_dir + len - suffix_len)[-1] != '/' ||
1713             strcmp(p, submodule_name))
1714                 BUG("submodule name '%s' not a suffix of git dir '%s'",
1715                     submodule_name, git_dir);
1716
1717         /*
1718          * We prevent the contents of sibling submodules' git directories to
1719          * clash.
1720          *
1721          * Example: having a submodule named `hippo` and another one named
1722          * `hippo/hooks` would result in the git directories
1723          * `.git/modules/hippo/` and `.git/modules/hippo/hooks/`, respectively,
1724          * but the latter directory is already designated to contain the hooks
1725          * of the former.
1726          */
1727         for (; *p; p++) {
1728                 if (is_dir_sep(*p)) {
1729                         char c = *p;
1730
1731                         *p = '\0';
1732                         if (is_git_directory(git_dir))
1733                                 ret = -1;
1734                         *p = c;
1735
1736                         if (ret < 0)
1737                                 return error(_("submodule git dir '%s' is "
1738                                                "inside git dir '%.*s'"),
1739                                              git_dir,
1740                                              (int)(p - git_dir), git_dir);
1741                 }
1742         }
1743
1744         return 0;
1745 }
1746
1747 /*
1748  * Embeds a single submodules git directory into the superprojects git dir,
1749  * non recursively.
1750  */
1751 static void relocate_single_git_dir_into_superproject(const char *prefix,
1752                                                       const char *path)
1753 {
1754         char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
1755         char *new_git_dir;
1756         const struct submodule *sub;
1757
1758         if (submodule_uses_worktrees(path))
1759                 die(_("relocate_gitdir for submodule '%s' with "
1760                       "more than one worktree not supported"), path);
1761
1762         old_git_dir = xstrfmt("%s/.git", path);
1763         if (read_gitfile(old_git_dir))
1764                 /* If it is an actual gitfile, it doesn't need migration. */
1765                 return;
1766
1767         real_old_git_dir = real_pathdup(old_git_dir, 1);
1768
1769         sub = submodule_from_path(the_repository, &null_oid, path);
1770         if (!sub)
1771                 die(_("could not lookup name for submodule '%s'"), path);
1772
1773         new_git_dir = git_pathdup("modules/%s", sub->name);
1774         if (validate_submodule_git_dir(new_git_dir, sub->name) < 0)
1775                 die(_("refusing to move '%s' into an existing git dir"),
1776                     real_old_git_dir);
1777         if (safe_create_leading_directories_const(new_git_dir) < 0)
1778                 die(_("could not create directory '%s'"), new_git_dir);
1779         real_new_git_dir = real_pathdup(new_git_dir, 1);
1780         free(new_git_dir);
1781
1782         fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
1783                 get_super_prefix_or_empty(), path,
1784                 real_old_git_dir, real_new_git_dir);
1785
1786         relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
1787
1788         free(old_git_dir);
1789         free(real_old_git_dir);
1790         free(real_new_git_dir);
1791 }
1792
1793 /*
1794  * Migrate the git directory of the submodule given by path from
1795  * having its git directory within the working tree to the git dir nested
1796  * in its superprojects git dir under modules/.
1797  */
1798 void absorb_git_dir_into_superproject(const char *prefix,
1799                                       const char *path,
1800                                       unsigned flags)
1801 {
1802         int err_code;
1803         const char *sub_git_dir;
1804         struct strbuf gitdir = STRBUF_INIT;
1805         strbuf_addf(&gitdir, "%s/.git", path);
1806         sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
1807
1808         /* Not populated? */
1809         if (!sub_git_dir) {
1810                 const struct submodule *sub;
1811
1812                 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
1813                         /* unpopulated as expected */
1814                         strbuf_release(&gitdir);
1815                         return;
1816                 }
1817
1818                 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
1819                         /* We don't know what broke here. */
1820                         read_gitfile_error_die(err_code, path, NULL);
1821
1822                 /*
1823                 * Maybe populated, but no git directory was found?
1824                 * This can happen if the superproject is a submodule
1825                 * itself and was just absorbed. The absorption of the
1826                 * superproject did not rewrite the git file links yet,
1827                 * fix it now.
1828                 */
1829                 sub = submodule_from_path(the_repository, &null_oid, path);
1830                 if (!sub)
1831                         die(_("could not lookup name for submodule '%s'"), path);
1832                 connect_work_tree_and_git_dir(path,
1833                         git_path("modules/%s", sub->name), 0);
1834         } else {
1835                 /* Is it already absorbed into the superprojects git dir? */
1836                 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
1837                 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
1838
1839                 if (!starts_with(real_sub_git_dir, real_common_git_dir))
1840                         relocate_single_git_dir_into_superproject(prefix, path);
1841
1842                 free(real_sub_git_dir);
1843                 free(real_common_git_dir);
1844         }
1845         strbuf_release(&gitdir);
1846
1847         if (flags & ABSORB_GITDIR_RECURSE_SUBMODULES) {
1848                 struct child_process cp = CHILD_PROCESS_INIT;
1849                 struct strbuf sb = STRBUF_INIT;
1850
1851                 if (flags & ~ABSORB_GITDIR_RECURSE_SUBMODULES)
1852                         BUG("we don't know how to pass the flags down?");
1853
1854                 strbuf_addstr(&sb, get_super_prefix_or_empty());
1855                 strbuf_addstr(&sb, path);
1856                 strbuf_addch(&sb, '/');
1857
1858                 cp.dir = path;
1859                 cp.git_cmd = 1;
1860                 cp.no_stdin = 1;
1861                 argv_array_pushl(&cp.args, "--super-prefix", sb.buf,
1862                                            "submodule--helper",
1863                                            "absorb-git-dirs", NULL);
1864                 prepare_submodule_repo_env(&cp.env_array);
1865                 if (run_command(&cp))
1866                         die(_("could not recurse into submodule '%s'"), path);
1867
1868                 strbuf_release(&sb);
1869         }
1870 }
1871
1872 const char *get_superproject_working_tree(void)
1873 {
1874         struct child_process cp = CHILD_PROCESS_INIT;
1875         struct strbuf sb = STRBUF_INIT;
1876         const char *one_up = real_path_if_valid("../");
1877         const char *cwd = xgetcwd();
1878         const char *ret = NULL;
1879         const char *subpath;
1880         int code;
1881         ssize_t len;
1882
1883         if (!is_inside_work_tree())
1884                 /*
1885                  * FIXME:
1886                  * We might have a superproject, but it is harder
1887                  * to determine.
1888                  */
1889                 return NULL;
1890
1891         if (!one_up)
1892                 return NULL;
1893
1894         subpath = relative_path(cwd, one_up, &sb);
1895
1896         prepare_submodule_repo_env(&cp.env_array);
1897         argv_array_pop(&cp.env_array);
1898
1899         argv_array_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
1900                         "ls-files", "-z", "--stage", "--full-name", "--",
1901                         subpath, NULL);
1902         strbuf_reset(&sb);
1903
1904         cp.no_stdin = 1;
1905         cp.no_stderr = 1;
1906         cp.out = -1;
1907         cp.git_cmd = 1;
1908
1909         if (start_command(&cp))
1910                 die(_("could not start ls-files in .."));
1911
1912         len = strbuf_read(&sb, cp.out, PATH_MAX);
1913         close(cp.out);
1914
1915         if (starts_with(sb.buf, "160000")) {
1916                 int super_sub_len;
1917                 int cwd_len = strlen(cwd);
1918                 char *super_sub, *super_wt;
1919
1920                 /*
1921                  * There is a superproject having this repo as a submodule.
1922                  * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
1923                  * We're only interested in the name after the tab.
1924                  */
1925                 super_sub = strchr(sb.buf, '\t') + 1;
1926                 super_sub_len = sb.buf + sb.len - super_sub - 1;
1927
1928                 if (super_sub_len > cwd_len ||
1929                     strcmp(&cwd[cwd_len - super_sub_len], super_sub))
1930                         BUG("returned path string doesn't match cwd?");
1931
1932                 super_wt = xstrdup(cwd);
1933                 super_wt[cwd_len - super_sub_len] = '\0';
1934
1935                 ret = real_path(super_wt);
1936                 free(super_wt);
1937         }
1938         strbuf_release(&sb);
1939
1940         code = finish_command(&cp);
1941
1942         if (code == 128)
1943                 /* '../' is not a git repository */
1944                 return NULL;
1945         if (code == 0 && len == 0)
1946                 /* There is an unrelated git repository at '../' */
1947                 return NULL;
1948         if (code)
1949                 die(_("ls-tree returned unexpected return code %d"), code);
1950
1951         return ret;
1952 }
1953
1954 /*
1955  * Put the gitdir for a submodule (given relative to the main
1956  * repository worktree) into `buf`, or return -1 on error.
1957  */
1958 int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
1959 {
1960         const struct submodule *sub;
1961         const char *git_dir;
1962         int ret = 0;
1963
1964         strbuf_reset(buf);
1965         strbuf_addstr(buf, submodule);
1966         strbuf_complete(buf, '/');
1967         strbuf_addstr(buf, ".git");
1968
1969         git_dir = read_gitfile(buf->buf);
1970         if (git_dir) {
1971                 strbuf_reset(buf);
1972                 strbuf_addstr(buf, git_dir);
1973         }
1974         if (!is_git_directory(buf->buf)) {
1975                 sub = submodule_from_path(the_repository, &null_oid, submodule);
1976                 if (!sub) {
1977                         ret = -1;
1978                         goto cleanup;
1979                 }
1980                 strbuf_reset(buf);
1981                 strbuf_git_path(buf, "%s/%s", "modules", sub->name);
1982         }
1983
1984 cleanup:
1985         return ret;
1986 }