Merge branch 'ab/retire-parse-remote'
[git/debian.git] / submodule.c
blobeef5204e641e198847e86e5e36c1115970831b8e
2 #include "cache.h"
3 #include "repository.h"
4 #include "config.h"
5 #include "submodule-config.h"
6 #include "submodule.h"
7 #include "dir.h"
8 #include "diff.h"
9 #include "commit.h"
10 #include "revision.h"
11 #include "run-command.h"
12 #include "diffcore.h"
13 #include "refs.h"
14 #include "string-list.h"
15 #include "oid-array.h"
16 #include "strvec.h"
17 #include "blob.h"
18 #include "thread-utils.h"
19 #include "quote.h"
20 #include "remote.h"
21 #include "worktree.h"
22 #include "parse-options.h"
23 #include "object-store.h"
24 #include "commit-reach.h"
26 static int config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
27 static int initialized_fetch_ref_tips;
28 static struct oid_array ref_tips_before_fetch;
29 static struct oid_array ref_tips_after_fetch;
32 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
33 * will be disabled because we can't guess what might be configured in
34 * .gitmodules unless the user resolves the conflict.
36 int is_gitmodules_unmerged(const struct index_state *istate)
38 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
39 if (pos < 0) { /* .gitmodules not found or isn't merged */
40 pos = -1 - pos;
41 if (istate->cache_nr > pos) { /* there is a .gitmodules */
42 const struct cache_entry *ce = istate->cache[pos];
43 if (ce_namelen(ce) == strlen(GITMODULES_FILE) &&
44 !strcmp(ce->name, GITMODULES_FILE))
45 return 1;
49 return 0;
53 * Check if the .gitmodules file is safe to write.
55 * Writing to the .gitmodules file requires that the file exists in the
56 * working tree or, if it doesn't, that a brand new .gitmodules file is going
57 * to be created (i.e. it's neither in the index nor in the current branch).
59 * It is not safe to write to .gitmodules if it's not in the working tree but
60 * it is in the index or in the current branch, because writing new values
61 * (and staging them) would blindly overwrite ALL the old content.
63 int is_writing_gitmodules_ok(void)
65 struct object_id oid;
66 return file_exists(GITMODULES_FILE) ||
67 (get_oid(GITMODULES_INDEX, &oid) < 0 && get_oid(GITMODULES_HEAD, &oid) < 0);
71 * Check if the .gitmodules file has unstaged modifications. This must be
72 * checked before allowing modifications to the .gitmodules file with the
73 * intention to stage them later, because when continuing we would stage the
74 * modifications the user didn't stage herself too. That might change in a
75 * future version when we learn to stage the changes we do ourselves without
76 * staging any previous modifications.
78 int is_staging_gitmodules_ok(struct index_state *istate)
80 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
82 if ((pos >= 0) && (pos < istate->cache_nr)) {
83 struct stat st;
84 if (lstat(GITMODULES_FILE, &st) == 0 &&
85 ie_modified(istate, istate->cache[pos], &st, 0) & DATA_CHANGED)
86 return 0;
89 return 1;
92 static int for_each_remote_ref_submodule(const char *submodule,
93 each_ref_fn fn, void *cb_data)
95 return refs_for_each_remote_ref(get_submodule_ref_store(submodule),
96 fn, cb_data);
100 * Try to update the "path" entry in the "submodule.<name>" section of the
101 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
102 * with the correct path=<oldpath> setting was found and we could update it.
104 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
106 struct strbuf entry = STRBUF_INIT;
107 const struct submodule *submodule;
108 int ret;
110 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
111 return -1;
113 if (is_gitmodules_unmerged(the_repository->index))
114 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
116 submodule = submodule_from_path(the_repository, &null_oid, oldpath);
117 if (!submodule || !submodule->name) {
118 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
119 return -1;
121 strbuf_addstr(&entry, "submodule.");
122 strbuf_addstr(&entry, submodule->name);
123 strbuf_addstr(&entry, ".path");
124 ret = config_set_in_gitmodules_file_gently(entry.buf, newpath);
125 strbuf_release(&entry);
126 return ret;
130 * Try to remove the "submodule.<name>" section from .gitmodules where the given
131 * path is configured. Return 0 only if a .gitmodules file was found, a section
132 * with the correct path=<path> setting was found and we could remove it.
134 int remove_path_from_gitmodules(const char *path)
136 struct strbuf sect = STRBUF_INIT;
137 const struct submodule *submodule;
139 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
140 return -1;
142 if (is_gitmodules_unmerged(the_repository->index))
143 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
145 submodule = submodule_from_path(the_repository, &null_oid, path);
146 if (!submodule || !submodule->name) {
147 warning(_("Could not find section in .gitmodules where path=%s"), path);
148 return -1;
150 strbuf_addstr(&sect, "submodule.");
151 strbuf_addstr(&sect, submodule->name);
152 if (git_config_rename_section_in_file(GITMODULES_FILE, sect.buf, NULL) < 0) {
153 /* Maybe the user already did that, don't error out here */
154 warning(_("Could not remove .gitmodules entry for %s"), path);
155 strbuf_release(&sect);
156 return -1;
158 strbuf_release(&sect);
159 return 0;
162 void stage_updated_gitmodules(struct index_state *istate)
164 if (add_file_to_index(istate, GITMODULES_FILE, 0))
165 die(_("staging updated .gitmodules failed"));
168 /* TODO: remove this function, use repo_submodule_init instead. */
169 int add_submodule_odb(const char *path)
171 struct strbuf objects_directory = STRBUF_INIT;
172 int ret = 0;
174 ret = strbuf_git_path_submodule(&objects_directory, path, "objects/");
175 if (ret)
176 goto done;
177 if (!is_directory(objects_directory.buf)) {
178 ret = -1;
179 goto done;
181 add_to_alternates_memory(objects_directory.buf);
182 done:
183 strbuf_release(&objects_directory);
184 return ret;
187 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
188 const char *path)
190 const struct submodule *submodule = submodule_from_path(the_repository,
191 &null_oid, path);
192 if (submodule) {
193 const char *ignore;
194 char *key;
196 key = xstrfmt("submodule.%s.ignore", submodule->name);
197 if (repo_config_get_string_tmp(the_repository, key, &ignore))
198 ignore = submodule->ignore;
199 free(key);
201 if (ignore)
202 handle_ignore_submodules_arg(diffopt, ignore);
203 else if (is_gitmodules_unmerged(the_repository->index))
204 diffopt->flags.ignore_submodules = 1;
208 /* Cheap function that only determines if we're interested in submodules at all */
209 int git_default_submodule_config(const char *var, const char *value, void *cb)
211 if (!strcmp(var, "submodule.recurse")) {
212 int v = git_config_bool(var, value) ?
213 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
214 config_update_recurse_submodules = v;
216 return 0;
219 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
220 const char *arg, int unset)
222 if (unset) {
223 config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
224 return 0;
226 if (arg)
227 config_update_recurse_submodules =
228 parse_update_recurse_submodules_arg(opt->long_name,
229 arg);
230 else
231 config_update_recurse_submodules = RECURSE_SUBMODULES_ON;
233 return 0;
237 * Determine if a submodule has been initialized at a given 'path'
239 int is_submodule_active(struct repository *repo, const char *path)
241 int ret = 0;
242 char *key = NULL;
243 char *value = NULL;
244 const struct string_list *sl;
245 const struct submodule *module;
247 module = submodule_from_path(repo, &null_oid, path);
249 /* early return if there isn't a path->module mapping */
250 if (!module)
251 return 0;
253 /* submodule.<name>.active is set */
254 key = xstrfmt("submodule.%s.active", module->name);
255 if (!repo_config_get_bool(repo, key, &ret)) {
256 free(key);
257 return ret;
259 free(key);
261 /* submodule.active is set */
262 sl = repo_config_get_value_multi(repo, "submodule.active");
263 if (sl) {
264 struct pathspec ps;
265 struct strvec args = STRVEC_INIT;
266 const struct string_list_item *item;
268 for_each_string_list_item(item, sl) {
269 strvec_push(&args, item->string);
272 parse_pathspec(&ps, 0, 0, NULL, args.v);
273 ret = match_pathspec(repo->index, &ps, path, strlen(path), 0, NULL, 1);
275 strvec_clear(&args);
276 clear_pathspec(&ps);
277 return ret;
280 /* fallback to checking if the URL is set */
281 key = xstrfmt("submodule.%s.url", module->name);
282 ret = !repo_config_get_string(repo, key, &value);
284 free(value);
285 free(key);
286 return ret;
289 int is_submodule_populated_gently(const char *path, int *return_error_code)
291 int ret = 0;
292 char *gitdir = xstrfmt("%s/.git", path);
294 if (resolve_gitdir_gently(gitdir, return_error_code))
295 ret = 1;
297 free(gitdir);
298 return ret;
302 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
304 void die_in_unpopulated_submodule(const struct index_state *istate,
305 const char *prefix)
307 int i, prefixlen;
309 if (!prefix)
310 return;
312 prefixlen = strlen(prefix);
314 for (i = 0; i < istate->cache_nr; i++) {
315 struct cache_entry *ce = istate->cache[i];
316 int ce_len = ce_namelen(ce);
318 if (!S_ISGITLINK(ce->ce_mode))
319 continue;
320 if (prefixlen <= ce_len)
321 continue;
322 if (strncmp(ce->name, prefix, ce_len))
323 continue;
324 if (prefix[ce_len] != '/')
325 continue;
327 die(_("in unpopulated submodule '%s'"), ce->name);
332 * Dies if any paths in the provided pathspec descends into a submodule
334 void die_path_inside_submodule(const struct index_state *istate,
335 const struct pathspec *ps)
337 int i, j;
339 for (i = 0; i < istate->cache_nr; i++) {
340 struct cache_entry *ce = istate->cache[i];
341 int ce_len = ce_namelen(ce);
343 if (!S_ISGITLINK(ce->ce_mode))
344 continue;
346 for (j = 0; j < ps->nr ; j++) {
347 const struct pathspec_item *item = &ps->items[j];
349 if (item->len <= ce_len)
350 continue;
351 if (item->match[ce_len] != '/')
352 continue;
353 if (strncmp(ce->name, item->match, ce_len))
354 continue;
355 if (item->len == ce_len + 1)
356 continue;
358 die(_("Pathspec '%s' is in submodule '%.*s'"),
359 item->original, ce_len, ce->name);
364 enum submodule_update_type parse_submodule_update_type(const char *value)
366 if (!strcmp(value, "none"))
367 return SM_UPDATE_NONE;
368 else if (!strcmp(value, "checkout"))
369 return SM_UPDATE_CHECKOUT;
370 else if (!strcmp(value, "rebase"))
371 return SM_UPDATE_REBASE;
372 else if (!strcmp(value, "merge"))
373 return SM_UPDATE_MERGE;
374 else if (*value == '!')
375 return SM_UPDATE_COMMAND;
376 else
377 return SM_UPDATE_UNSPECIFIED;
380 int parse_submodule_update_strategy(const char *value,
381 struct submodule_update_strategy *dst)
383 enum submodule_update_type type;
385 free((void*)dst->command);
386 dst->command = NULL;
388 type = parse_submodule_update_type(value);
389 if (type == SM_UPDATE_UNSPECIFIED)
390 return -1;
392 dst->type = type;
393 if (type == SM_UPDATE_COMMAND)
394 dst->command = xstrdup(value + 1);
396 return 0;
399 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
401 struct strbuf sb = STRBUF_INIT;
402 switch (s->type) {
403 case SM_UPDATE_CHECKOUT:
404 return "checkout";
405 case SM_UPDATE_MERGE:
406 return "merge";
407 case SM_UPDATE_REBASE:
408 return "rebase";
409 case SM_UPDATE_NONE:
410 return "none";
411 case SM_UPDATE_UNSPECIFIED:
412 return NULL;
413 case SM_UPDATE_COMMAND:
414 strbuf_addf(&sb, "!%s", s->command);
415 return strbuf_detach(&sb, NULL);
417 return NULL;
420 void handle_ignore_submodules_arg(struct diff_options *diffopt,
421 const char *arg)
423 diffopt->flags.ignore_submodules = 0;
424 diffopt->flags.ignore_untracked_in_submodules = 0;
425 diffopt->flags.ignore_dirty_submodules = 0;
427 if (!strcmp(arg, "all"))
428 diffopt->flags.ignore_submodules = 1;
429 else if (!strcmp(arg, "untracked"))
430 diffopt->flags.ignore_untracked_in_submodules = 1;
431 else if (!strcmp(arg, "dirty"))
432 diffopt->flags.ignore_dirty_submodules = 1;
433 else if (strcmp(arg, "none"))
434 die(_("bad --ignore-submodules argument: %s"), arg);
436 * Please update _git_status() in git-completion.bash when you
437 * add new options
441 static int prepare_submodule_diff_summary(struct repository *r, struct rev_info *rev,
442 const char *path,
443 struct commit *left, struct commit *right,
444 struct commit_list *merge_bases)
446 struct commit_list *list;
448 repo_init_revisions(r, rev, NULL);
449 setup_revisions(0, NULL, rev, NULL);
450 rev->left_right = 1;
451 rev->first_parent_only = 1;
452 left->object.flags |= SYMMETRIC_LEFT;
453 add_pending_object(rev, &left->object, path);
454 add_pending_object(rev, &right->object, path);
455 for (list = merge_bases; list; list = list->next) {
456 list->item->object.flags |= UNINTERESTING;
457 add_pending_object(rev, &list->item->object,
458 oid_to_hex(&list->item->object.oid));
460 return prepare_revision_walk(rev);
463 static void print_submodule_diff_summary(struct repository *r, struct rev_info *rev, struct diff_options *o)
465 static const char format[] = " %m %s";
466 struct strbuf sb = STRBUF_INIT;
467 struct commit *commit;
469 while ((commit = get_revision(rev))) {
470 struct pretty_print_context ctx = {0};
471 ctx.date_mode = rev->date_mode;
472 ctx.output_encoding = get_log_output_encoding();
473 strbuf_setlen(&sb, 0);
474 repo_format_commit_message(r, commit, format, &sb,
475 &ctx);
476 strbuf_addch(&sb, '\n');
477 if (commit->object.flags & SYMMETRIC_LEFT)
478 diff_emit_submodule_del(o, sb.buf);
479 else
480 diff_emit_submodule_add(o, sb.buf);
482 strbuf_release(&sb);
485 static void prepare_submodule_repo_env_no_git_dir(struct strvec *out)
487 const char * const *var;
489 for (var = local_repo_env; *var; var++) {
490 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
491 strvec_push(out, *var);
495 void prepare_submodule_repo_env(struct strvec *out)
497 prepare_submodule_repo_env_no_git_dir(out);
498 strvec_pushf(out, "%s=%s", GIT_DIR_ENVIRONMENT,
499 DEFAULT_GIT_DIR_ENVIRONMENT);
503 * Initialize a repository struct for a submodule based on the provided 'path'.
505 * Unlike repo_submodule_init, this tolerates submodules not present
506 * in .gitmodules. This function exists only to preserve historical behavior,
508 * Returns the repository struct on success,
509 * NULL when the submodule is not present.
511 static struct repository *open_submodule(const char *path)
513 struct strbuf sb = STRBUF_INIT;
514 struct repository *out = xmalloc(sizeof(*out));
516 if (submodule_to_gitdir(&sb, path) || repo_init(out, sb.buf, NULL)) {
517 strbuf_release(&sb);
518 free(out);
519 return NULL;
522 /* Mark it as a submodule */
523 out->submodule_prefix = xstrdup(path);
525 strbuf_release(&sb);
526 return out;
530 * Helper function to display the submodule header line prior to the full
531 * summary output.
533 * If it can locate the submodule git directory it will create a repository
534 * handle for the submodule and lookup both the left and right commits and
535 * put them into the left and right pointers.
537 static void show_submodule_header(struct diff_options *o,
538 const char *path,
539 struct object_id *one, struct object_id *two,
540 unsigned dirty_submodule,
541 struct repository *sub,
542 struct commit **left, struct commit **right,
543 struct commit_list **merge_bases)
545 const char *message = NULL;
546 struct strbuf sb = STRBUF_INIT;
547 int fast_forward = 0, fast_backward = 0;
549 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
550 diff_emit_submodule_untracked(o, path);
552 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
553 diff_emit_submodule_modified(o, path);
555 if (is_null_oid(one))
556 message = "(new submodule)";
557 else if (is_null_oid(two))
558 message = "(submodule deleted)";
560 if (!sub) {
561 if (!message)
562 message = "(commits not present)";
563 goto output_header;
567 * Attempt to lookup the commit references, and determine if this is
568 * a fast forward or fast backwards update.
570 *left = lookup_commit_reference(sub, one);
571 *right = lookup_commit_reference(sub, two);
574 * Warn about missing commits in the submodule project, but only if
575 * they aren't null.
577 if ((!is_null_oid(one) && !*left) ||
578 (!is_null_oid(two) && !*right))
579 message = "(commits not present)";
581 *merge_bases = repo_get_merge_bases(sub, *left, *right);
582 if (*merge_bases) {
583 if ((*merge_bases)->item == *left)
584 fast_forward = 1;
585 else if ((*merge_bases)->item == *right)
586 fast_backward = 1;
589 if (oideq(one, two)) {
590 strbuf_release(&sb);
591 return;
594 output_header:
595 strbuf_addf(&sb, "Submodule %s ", path);
596 strbuf_add_unique_abbrev(&sb, one, DEFAULT_ABBREV);
597 strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
598 strbuf_add_unique_abbrev(&sb, two, DEFAULT_ABBREV);
599 if (message)
600 strbuf_addf(&sb, " %s\n", message);
601 else
602 strbuf_addf(&sb, "%s:\n", fast_backward ? " (rewind)" : "");
603 diff_emit_submodule_header(o, sb.buf);
605 strbuf_release(&sb);
608 void show_submodule_diff_summary(struct diff_options *o, const char *path,
609 struct object_id *one, struct object_id *two,
610 unsigned dirty_submodule)
612 struct rev_info rev;
613 struct commit *left = NULL, *right = NULL;
614 struct commit_list *merge_bases = NULL;
615 struct repository *sub;
617 sub = open_submodule(path);
618 show_submodule_header(o, path, one, two, dirty_submodule,
619 sub, &left, &right, &merge_bases);
622 * If we don't have both a left and a right pointer, there is no
623 * reason to try and display a summary. The header line should contain
624 * all the information the user needs.
626 if (!left || !right || !sub)
627 goto out;
629 /* Treat revision walker failure the same as missing commits */
630 if (prepare_submodule_diff_summary(sub, &rev, path, left, right, merge_bases)) {
631 diff_emit_submodule_error(o, "(revision walker failed)\n");
632 goto out;
635 print_submodule_diff_summary(sub, &rev, o);
637 out:
638 if (merge_bases)
639 free_commit_list(merge_bases);
640 clear_commit_marks(left, ~0);
641 clear_commit_marks(right, ~0);
642 if (sub) {
643 repo_clear(sub);
644 free(sub);
648 void show_submodule_inline_diff(struct diff_options *o, const char *path,
649 struct object_id *one, struct object_id *two,
650 unsigned dirty_submodule)
652 const struct object_id *old_oid = the_hash_algo->empty_tree, *new_oid = the_hash_algo->empty_tree;
653 struct commit *left = NULL, *right = NULL;
654 struct commit_list *merge_bases = NULL;
655 struct child_process cp = CHILD_PROCESS_INIT;
656 struct strbuf sb = STRBUF_INIT;
657 struct repository *sub;
659 sub = open_submodule(path);
660 show_submodule_header(o, path, one, two, dirty_submodule,
661 sub, &left, &right, &merge_bases);
663 /* We need a valid left and right commit to display a difference */
664 if (!(left || is_null_oid(one)) ||
665 !(right || is_null_oid(two)))
666 goto done;
668 if (left)
669 old_oid = one;
670 if (right)
671 new_oid = two;
673 cp.git_cmd = 1;
674 cp.dir = path;
675 cp.out = -1;
676 cp.no_stdin = 1;
678 /* TODO: other options may need to be passed here. */
679 strvec_pushl(&cp.args, "diff", "--submodule=diff", NULL);
680 strvec_pushf(&cp.args, "--color=%s", want_color(o->use_color) ?
681 "always" : "never");
683 if (o->flags.reverse_diff) {
684 strvec_pushf(&cp.args, "--src-prefix=%s%s/",
685 o->b_prefix, path);
686 strvec_pushf(&cp.args, "--dst-prefix=%s%s/",
687 o->a_prefix, path);
688 } else {
689 strvec_pushf(&cp.args, "--src-prefix=%s%s/",
690 o->a_prefix, path);
691 strvec_pushf(&cp.args, "--dst-prefix=%s%s/",
692 o->b_prefix, path);
694 strvec_push(&cp.args, oid_to_hex(old_oid));
696 * If the submodule has modified content, we will diff against the
697 * work tree, under the assumption that the user has asked for the
698 * diff format and wishes to actually see all differences even if they
699 * haven't yet been committed to the submodule yet.
701 if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
702 strvec_push(&cp.args, oid_to_hex(new_oid));
704 prepare_submodule_repo_env(&cp.env_array);
705 if (start_command(&cp))
706 diff_emit_submodule_error(o, "(diff failed)\n");
708 while (strbuf_getwholeline_fd(&sb, cp.out, '\n') != EOF)
709 diff_emit_submodule_pipethrough(o, sb.buf, sb.len);
711 if (finish_command(&cp))
712 diff_emit_submodule_error(o, "(diff failed)\n");
714 done:
715 strbuf_release(&sb);
716 if (merge_bases)
717 free_commit_list(merge_bases);
718 if (left)
719 clear_commit_marks(left, ~0);
720 if (right)
721 clear_commit_marks(right, ~0);
722 if (sub) {
723 repo_clear(sub);
724 free(sub);
728 int should_update_submodules(void)
730 return config_update_recurse_submodules == RECURSE_SUBMODULES_ON;
733 const struct submodule *submodule_from_ce(const struct cache_entry *ce)
735 if (!S_ISGITLINK(ce->ce_mode))
736 return NULL;
738 if (!should_update_submodules())
739 return NULL;
741 return submodule_from_path(the_repository, &null_oid, ce->name);
744 static struct oid_array *submodule_commits(struct string_list *submodules,
745 const char *name)
747 struct string_list_item *item;
749 item = string_list_insert(submodules, name);
750 if (item->util)
751 return (struct oid_array *) item->util;
753 /* NEEDSWORK: should we have oid_array_init()? */
754 item->util = xcalloc(1, sizeof(struct oid_array));
755 return (struct oid_array *) item->util;
758 struct collect_changed_submodules_cb_data {
759 struct repository *repo;
760 struct string_list *changed;
761 const struct object_id *commit_oid;
765 * this would normally be two functions: default_name_from_path() and
766 * path_from_default_name(). Since the default name is the same as
767 * the submodule path we can get away with just one function which only
768 * checks whether there is a submodule in the working directory at that
769 * location.
771 static const char *default_name_or_path(const char *path_or_name)
773 int error_code;
775 if (!is_submodule_populated_gently(path_or_name, &error_code))
776 return NULL;
778 return path_or_name;
781 static void collect_changed_submodules_cb(struct diff_queue_struct *q,
782 struct diff_options *options,
783 void *data)
785 struct collect_changed_submodules_cb_data *me = data;
786 struct string_list *changed = me->changed;
787 const struct object_id *commit_oid = me->commit_oid;
788 int i;
790 for (i = 0; i < q->nr; i++) {
791 struct diff_filepair *p = q->queue[i];
792 struct oid_array *commits;
793 const struct submodule *submodule;
794 const char *name;
796 if (!S_ISGITLINK(p->two->mode))
797 continue;
799 submodule = submodule_from_path(me->repo,
800 commit_oid, p->two->path);
801 if (submodule)
802 name = submodule->name;
803 else {
804 name = default_name_or_path(p->two->path);
805 /* make sure name does not collide with existing one */
806 if (name)
807 submodule = submodule_from_name(me->repo,
808 commit_oid, name);
809 if (submodule) {
810 warning(_("Submodule in commit %s at path: "
811 "'%s' collides with a submodule named "
812 "the same. Skipping it."),
813 oid_to_hex(commit_oid), p->two->path);
814 name = NULL;
818 if (!name)
819 continue;
821 commits = submodule_commits(changed, name);
822 oid_array_append(commits, &p->two->oid);
827 * Collect the paths of submodules in 'changed' which have changed based on
828 * the revisions as specified in 'argv'. Each entry in 'changed' will also
829 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
830 * what the submodule pointers were updated to during the change.
832 static void collect_changed_submodules(struct repository *r,
833 struct string_list *changed,
834 struct strvec *argv)
836 struct rev_info rev;
837 const struct commit *commit;
838 int save_warning;
839 struct setup_revision_opt s_r_opt = {
840 .assume_dashdash = 1,
843 save_warning = warn_on_object_refname_ambiguity;
844 warn_on_object_refname_ambiguity = 0;
845 repo_init_revisions(r, &rev, NULL);
846 setup_revisions(argv->nr, argv->v, &rev, &s_r_opt);
847 warn_on_object_refname_ambiguity = save_warning;
848 if (prepare_revision_walk(&rev))
849 die(_("revision walk setup failed"));
851 while ((commit = get_revision(&rev))) {
852 struct rev_info diff_rev;
853 struct collect_changed_submodules_cb_data data;
854 data.repo = r;
855 data.changed = changed;
856 data.commit_oid = &commit->object.oid;
858 repo_init_revisions(r, &diff_rev, NULL);
859 diff_rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
860 diff_rev.diffopt.format_callback = collect_changed_submodules_cb;
861 diff_rev.diffopt.format_callback_data = &data;
862 diff_rev.dense_combined_merges = 1;
863 diff_tree_combined_merge(commit, &diff_rev);
866 reset_revision_walk();
869 static void free_submodules_oids(struct string_list *submodules)
871 struct string_list_item *item;
872 for_each_string_list_item(item, submodules)
873 oid_array_clear((struct oid_array *) item->util);
874 string_list_clear(submodules, 1);
877 static int has_remote(const char *refname, const struct object_id *oid,
878 int flags, void *cb_data)
880 return 1;
883 static int append_oid_to_argv(const struct object_id *oid, void *data)
885 struct strvec *argv = data;
886 strvec_push(argv, oid_to_hex(oid));
887 return 0;
890 struct has_commit_data {
891 struct repository *repo;
892 int result;
893 const char *path;
896 static int check_has_commit(const struct object_id *oid, void *data)
898 struct has_commit_data *cb = data;
900 enum object_type type = oid_object_info(cb->repo, oid, NULL);
902 switch (type) {
903 case OBJ_COMMIT:
904 return 0;
905 case OBJ_BAD:
907 * Object is missing or invalid. If invalid, an error message
908 * has already been printed.
910 cb->result = 0;
911 return 0;
912 default:
913 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
914 cb->path, oid_to_hex(oid), type_name(type));
918 static int submodule_has_commits(struct repository *r,
919 const char *path,
920 struct oid_array *commits)
922 struct has_commit_data has_commit = { r, 1, path };
925 * Perform a cheap, but incorrect check for the existence of 'commits'.
926 * This is done by adding the submodule's object store to the in-core
927 * object store, and then querying for each commit's existence. If we
928 * do not have the commit object anywhere, there is no chance we have
929 * it in the object store of the correct submodule and have it
930 * reachable from a ref, so we can fail early without spawning rev-list
931 * which is expensive.
933 if (add_submodule_odb(path))
934 return 0;
936 oid_array_for_each_unique(commits, check_has_commit, &has_commit);
938 if (has_commit.result) {
940 * Even if the submodule is checked out and the commit is
941 * present, make sure it exists in the submodule's object store
942 * and that it is reachable from a ref.
944 struct child_process cp = CHILD_PROCESS_INIT;
945 struct strbuf out = STRBUF_INIT;
947 strvec_pushl(&cp.args, "rev-list", "-n", "1", NULL);
948 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
949 strvec_pushl(&cp.args, "--not", "--all", NULL);
951 prepare_submodule_repo_env(&cp.env_array);
952 cp.git_cmd = 1;
953 cp.no_stdin = 1;
954 cp.dir = path;
956 if (capture_command(&cp, &out, GIT_MAX_HEXSZ + 1) || out.len)
957 has_commit.result = 0;
959 strbuf_release(&out);
962 return has_commit.result;
965 static int submodule_needs_pushing(struct repository *r,
966 const char *path,
967 struct oid_array *commits)
969 if (!submodule_has_commits(r, path, commits))
971 * NOTE: We do consider it safe to return "no" here. The
972 * correct answer would be "We do not know" instead of
973 * "No push needed", but it is quite hard to change
974 * the submodule pointer without having the submodule
975 * around. If a user did however change the submodules
976 * without having the submodule around, this indicates
977 * an expert who knows what they are doing or a
978 * maintainer integrating work from other people. In
979 * both cases it should be safe to skip this check.
981 return 0;
983 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
984 struct child_process cp = CHILD_PROCESS_INIT;
985 struct strbuf buf = STRBUF_INIT;
986 int needs_pushing = 0;
988 strvec_push(&cp.args, "rev-list");
989 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
990 strvec_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
992 prepare_submodule_repo_env(&cp.env_array);
993 cp.git_cmd = 1;
994 cp.no_stdin = 1;
995 cp.out = -1;
996 cp.dir = path;
997 if (start_command(&cp))
998 die(_("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s"),
999 path);
1000 if (strbuf_read(&buf, cp.out, the_hash_algo->hexsz + 1))
1001 needs_pushing = 1;
1002 finish_command(&cp);
1003 close(cp.out);
1004 strbuf_release(&buf);
1005 return needs_pushing;
1008 return 0;
1011 int find_unpushed_submodules(struct repository *r,
1012 struct oid_array *commits,
1013 const char *remotes_name,
1014 struct string_list *needs_pushing)
1016 struct string_list submodules = STRING_LIST_INIT_DUP;
1017 struct string_list_item *name;
1018 struct strvec argv = STRVEC_INIT;
1020 /* argv.v[0] will be ignored by setup_revisions */
1021 strvec_push(&argv, "find_unpushed_submodules");
1022 oid_array_for_each_unique(commits, append_oid_to_argv, &argv);
1023 strvec_push(&argv, "--not");
1024 strvec_pushf(&argv, "--remotes=%s", remotes_name);
1026 collect_changed_submodules(r, &submodules, &argv);
1028 for_each_string_list_item(name, &submodules) {
1029 struct oid_array *commits = name->util;
1030 const struct submodule *submodule;
1031 const char *path = NULL;
1033 submodule = submodule_from_name(r, &null_oid, name->string);
1034 if (submodule)
1035 path = submodule->path;
1036 else
1037 path = default_name_or_path(name->string);
1039 if (!path)
1040 continue;
1042 if (submodule_needs_pushing(r, path, commits))
1043 string_list_insert(needs_pushing, path);
1046 free_submodules_oids(&submodules);
1047 strvec_clear(&argv);
1049 return needs_pushing->nr;
1052 static int push_submodule(const char *path,
1053 const struct remote *remote,
1054 const struct refspec *rs,
1055 const struct string_list *push_options,
1056 int dry_run)
1058 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
1059 struct child_process cp = CHILD_PROCESS_INIT;
1060 strvec_push(&cp.args, "push");
1061 if (dry_run)
1062 strvec_push(&cp.args, "--dry-run");
1064 if (push_options && push_options->nr) {
1065 const struct string_list_item *item;
1066 for_each_string_list_item(item, push_options)
1067 strvec_pushf(&cp.args, "--push-option=%s",
1068 item->string);
1071 if (remote->origin != REMOTE_UNCONFIGURED) {
1072 int i;
1073 strvec_push(&cp.args, remote->name);
1074 for (i = 0; i < rs->raw_nr; i++)
1075 strvec_push(&cp.args, rs->raw[i]);
1078 prepare_submodule_repo_env(&cp.env_array);
1079 cp.git_cmd = 1;
1080 cp.no_stdin = 1;
1081 cp.dir = path;
1082 if (run_command(&cp))
1083 return 0;
1084 close(cp.out);
1087 return 1;
1091 * Perform a check in the submodule to see if the remote and refspec work.
1092 * Die if the submodule can't be pushed.
1094 static void submodule_push_check(const char *path, const char *head,
1095 const struct remote *remote,
1096 const struct refspec *rs)
1098 struct child_process cp = CHILD_PROCESS_INIT;
1099 int i;
1101 strvec_push(&cp.args, "submodule--helper");
1102 strvec_push(&cp.args, "push-check");
1103 strvec_push(&cp.args, head);
1104 strvec_push(&cp.args, remote->name);
1106 for (i = 0; i < rs->raw_nr; i++)
1107 strvec_push(&cp.args, rs->raw[i]);
1109 prepare_submodule_repo_env(&cp.env_array);
1110 cp.git_cmd = 1;
1111 cp.no_stdin = 1;
1112 cp.no_stdout = 1;
1113 cp.dir = path;
1116 * Simply indicate if 'submodule--helper push-check' failed.
1117 * More detailed error information will be provided by the
1118 * child process.
1120 if (run_command(&cp))
1121 die(_("process for submodule '%s' failed"), path);
1124 int push_unpushed_submodules(struct repository *r,
1125 struct oid_array *commits,
1126 const struct remote *remote,
1127 const struct refspec *rs,
1128 const struct string_list *push_options,
1129 int dry_run)
1131 int i, ret = 1;
1132 struct string_list needs_pushing = STRING_LIST_INIT_DUP;
1134 if (!find_unpushed_submodules(r, commits,
1135 remote->name, &needs_pushing))
1136 return 1;
1139 * Verify that the remote and refspec can be propagated to all
1140 * submodules. This check can be skipped if the remote and refspec
1141 * won't be propagated due to the remote being unconfigured (e.g. a URL
1142 * instead of a remote name).
1144 if (remote->origin != REMOTE_UNCONFIGURED) {
1145 char *head;
1146 struct object_id head_oid;
1148 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1149 if (!head)
1150 die(_("Failed to resolve HEAD as a valid ref."));
1152 for (i = 0; i < needs_pushing.nr; i++)
1153 submodule_push_check(needs_pushing.items[i].string,
1154 head, remote, rs);
1155 free(head);
1158 /* Actually push the submodules */
1159 for (i = 0; i < needs_pushing.nr; i++) {
1160 const char *path = needs_pushing.items[i].string;
1161 fprintf(stderr, _("Pushing submodule '%s'\n"), path);
1162 if (!push_submodule(path, remote, rs,
1163 push_options, dry_run)) {
1164 fprintf(stderr, _("Unable to push submodule '%s'\n"), path);
1165 ret = 0;
1169 string_list_clear(&needs_pushing, 0);
1171 return ret;
1174 static int append_oid_to_array(const char *ref, const struct object_id *oid,
1175 int flags, void *data)
1177 struct oid_array *array = data;
1178 oid_array_append(array, oid);
1179 return 0;
1182 void check_for_new_submodule_commits(struct object_id *oid)
1184 if (!initialized_fetch_ref_tips) {
1185 for_each_ref(append_oid_to_array, &ref_tips_before_fetch);
1186 initialized_fetch_ref_tips = 1;
1189 oid_array_append(&ref_tips_after_fetch, oid);
1192 static void calculate_changed_submodule_paths(struct repository *r,
1193 struct string_list *changed_submodule_names)
1195 struct strvec argv = STRVEC_INIT;
1196 struct string_list_item *name;
1198 /* No need to check if there are no submodules configured */
1199 if (!submodule_from_path(r, NULL, NULL))
1200 return;
1202 strvec_push(&argv, "--"); /* argv[0] program name */
1203 oid_array_for_each_unique(&ref_tips_after_fetch,
1204 append_oid_to_argv, &argv);
1205 strvec_push(&argv, "--not");
1206 oid_array_for_each_unique(&ref_tips_before_fetch,
1207 append_oid_to_argv, &argv);
1210 * Collect all submodules (whether checked out or not) for which new
1211 * commits have been recorded upstream in "changed_submodule_names".
1213 collect_changed_submodules(r, changed_submodule_names, &argv);
1215 for_each_string_list_item(name, changed_submodule_names) {
1216 struct oid_array *commits = name->util;
1217 const struct submodule *submodule;
1218 const char *path = NULL;
1220 submodule = submodule_from_name(r, &null_oid, name->string);
1221 if (submodule)
1222 path = submodule->path;
1223 else
1224 path = default_name_or_path(name->string);
1226 if (!path)
1227 continue;
1229 if (submodule_has_commits(r, path, commits)) {
1230 oid_array_clear(commits);
1231 *name->string = '\0';
1235 string_list_remove_empty_items(changed_submodule_names, 1);
1237 strvec_clear(&argv);
1238 oid_array_clear(&ref_tips_before_fetch);
1239 oid_array_clear(&ref_tips_after_fetch);
1240 initialized_fetch_ref_tips = 0;
1243 int submodule_touches_in_range(struct repository *r,
1244 struct object_id *excl_oid,
1245 struct object_id *incl_oid)
1247 struct string_list subs = STRING_LIST_INIT_DUP;
1248 struct strvec args = STRVEC_INIT;
1249 int ret;
1251 /* No need to check if there are no submodules configured */
1252 if (!submodule_from_path(r, NULL, NULL))
1253 return 0;
1255 strvec_push(&args, "--"); /* args[0] program name */
1256 strvec_push(&args, oid_to_hex(incl_oid));
1257 if (!is_null_oid(excl_oid)) {
1258 strvec_push(&args, "--not");
1259 strvec_push(&args, oid_to_hex(excl_oid));
1262 collect_changed_submodules(r, &subs, &args);
1263 ret = subs.nr;
1265 strvec_clear(&args);
1267 free_submodules_oids(&subs);
1268 return ret;
1271 struct submodule_parallel_fetch {
1272 int count;
1273 struct strvec args;
1274 struct repository *r;
1275 const char *prefix;
1276 int command_line_option;
1277 int default_option;
1278 int quiet;
1279 int result;
1281 struct string_list changed_submodule_names;
1283 /* Pending fetches by OIDs */
1284 struct fetch_task **oid_fetch_tasks;
1285 int oid_fetch_tasks_nr, oid_fetch_tasks_alloc;
1287 struct strbuf submodules_with_errors;
1289 #define SPF_INIT {0, STRVEC_INIT, NULL, NULL, 0, 0, 0, 0, \
1290 STRING_LIST_INIT_DUP, \
1291 NULL, 0, 0, STRBUF_INIT}
1293 static int get_fetch_recurse_config(const struct submodule *submodule,
1294 struct submodule_parallel_fetch *spf)
1296 if (spf->command_line_option != RECURSE_SUBMODULES_DEFAULT)
1297 return spf->command_line_option;
1299 if (submodule) {
1300 char *key;
1301 const char *value;
1303 int fetch_recurse = submodule->fetch_recurse;
1304 key = xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule->name);
1305 if (!repo_config_get_string_tmp(spf->r, key, &value)) {
1306 fetch_recurse = parse_fetch_recurse_submodules_arg(key, value);
1308 free(key);
1310 if (fetch_recurse != RECURSE_SUBMODULES_NONE)
1311 /* local config overrules everything except commandline */
1312 return fetch_recurse;
1315 return spf->default_option;
1319 * Fetch in progress (if callback data) or
1320 * pending (if in oid_fetch_tasks in struct submodule_parallel_fetch)
1322 struct fetch_task {
1323 struct repository *repo;
1324 const struct submodule *sub;
1325 unsigned free_sub : 1; /* Do we need to free the submodule? */
1327 struct oid_array *commits; /* Ensure these commits are fetched */
1331 * When a submodule is not defined in .gitmodules, we cannot access it
1332 * via the regular submodule-config. Create a fake submodule, which we can
1333 * work on.
1335 static const struct submodule *get_non_gitmodules_submodule(const char *path)
1337 struct submodule *ret = NULL;
1338 const char *name = default_name_or_path(path);
1340 if (!name)
1341 return NULL;
1343 ret = xmalloc(sizeof(*ret));
1344 memset(ret, 0, sizeof(*ret));
1345 ret->path = name;
1346 ret->name = name;
1348 return (const struct submodule *) ret;
1351 static struct fetch_task *fetch_task_create(struct repository *r,
1352 const char *path)
1354 struct fetch_task *task = xmalloc(sizeof(*task));
1355 memset(task, 0, sizeof(*task));
1357 task->sub = submodule_from_path(r, &null_oid, path);
1358 if (!task->sub) {
1360 * No entry in .gitmodules? Technically not a submodule,
1361 * but historically we supported repositories that happen to be
1362 * in-place where a gitlink is. Keep supporting them.
1364 task->sub = get_non_gitmodules_submodule(path);
1365 if (!task->sub) {
1366 free(task);
1367 return NULL;
1370 task->free_sub = 1;
1373 return task;
1376 static void fetch_task_release(struct fetch_task *p)
1378 if (p->free_sub)
1379 free((void*)p->sub);
1380 p->free_sub = 0;
1381 p->sub = NULL;
1383 if (p->repo)
1384 repo_clear(p->repo);
1385 FREE_AND_NULL(p->repo);
1388 static struct repository *get_submodule_repo_for(struct repository *r,
1389 const struct submodule *sub)
1391 struct repository *ret = xmalloc(sizeof(*ret));
1393 if (repo_submodule_init(ret, r, sub)) {
1395 * No entry in .gitmodules? Technically not a submodule,
1396 * but historically we supported repositories that happen to be
1397 * in-place where a gitlink is. Keep supporting them.
1399 struct strbuf gitdir = STRBUF_INIT;
1400 strbuf_repo_worktree_path(&gitdir, r, "%s/.git", sub->path);
1401 if (repo_init(ret, gitdir.buf, NULL)) {
1402 strbuf_release(&gitdir);
1403 free(ret);
1404 return NULL;
1406 strbuf_release(&gitdir);
1409 return ret;
1412 static int get_next_submodule(struct child_process *cp,
1413 struct strbuf *err, void *data, void **task_cb)
1415 struct submodule_parallel_fetch *spf = data;
1417 for (; spf->count < spf->r->index->cache_nr; spf->count++) {
1418 const struct cache_entry *ce = spf->r->index->cache[spf->count];
1419 const char *default_argv;
1420 struct fetch_task *task;
1422 if (!S_ISGITLINK(ce->ce_mode))
1423 continue;
1425 task = fetch_task_create(spf->r, ce->name);
1426 if (!task)
1427 continue;
1429 switch (get_fetch_recurse_config(task->sub, spf))
1431 default:
1432 case RECURSE_SUBMODULES_DEFAULT:
1433 case RECURSE_SUBMODULES_ON_DEMAND:
1434 if (!task->sub ||
1435 !string_list_lookup(
1436 &spf->changed_submodule_names,
1437 task->sub->name))
1438 continue;
1439 default_argv = "on-demand";
1440 break;
1441 case RECURSE_SUBMODULES_ON:
1442 default_argv = "yes";
1443 break;
1444 case RECURSE_SUBMODULES_OFF:
1445 continue;
1448 task->repo = get_submodule_repo_for(spf->r, task->sub);
1449 if (task->repo) {
1450 struct strbuf submodule_prefix = STRBUF_INIT;
1451 child_process_init(cp);
1452 cp->dir = task->repo->worktree;
1453 prepare_submodule_repo_env(&cp->env_array);
1454 cp->git_cmd = 1;
1455 if (!spf->quiet)
1456 strbuf_addf(err, _("Fetching submodule %s%s\n"),
1457 spf->prefix, ce->name);
1458 strvec_init(&cp->args);
1459 strvec_pushv(&cp->args, spf->args.v);
1460 strvec_push(&cp->args, default_argv);
1461 strvec_push(&cp->args, "--submodule-prefix");
1463 strbuf_addf(&submodule_prefix, "%s%s/",
1464 spf->prefix,
1465 task->sub->path);
1466 strvec_push(&cp->args, submodule_prefix.buf);
1468 spf->count++;
1469 *task_cb = task;
1471 strbuf_release(&submodule_prefix);
1472 return 1;
1473 } else {
1475 fetch_task_release(task);
1476 free(task);
1479 * An empty directory is normal,
1480 * the submodule is not initialized
1482 if (S_ISGITLINK(ce->ce_mode) &&
1483 !is_empty_dir(ce->name)) {
1484 spf->result = 1;
1485 strbuf_addf(err,
1486 _("Could not access submodule '%s'\n"),
1487 ce->name);
1492 if (spf->oid_fetch_tasks_nr) {
1493 struct fetch_task *task =
1494 spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr - 1];
1495 struct strbuf submodule_prefix = STRBUF_INIT;
1496 spf->oid_fetch_tasks_nr--;
1498 strbuf_addf(&submodule_prefix, "%s%s/",
1499 spf->prefix, task->sub->path);
1501 child_process_init(cp);
1502 prepare_submodule_repo_env(&cp->env_array);
1503 cp->git_cmd = 1;
1504 cp->dir = task->repo->worktree;
1506 strvec_init(&cp->args);
1507 strvec_pushv(&cp->args, spf->args.v);
1508 strvec_push(&cp->args, "on-demand");
1509 strvec_push(&cp->args, "--submodule-prefix");
1510 strvec_push(&cp->args, submodule_prefix.buf);
1512 /* NEEDSWORK: have get_default_remote from submodule--helper */
1513 strvec_push(&cp->args, "origin");
1514 oid_array_for_each_unique(task->commits,
1515 append_oid_to_argv, &cp->args);
1517 *task_cb = task;
1518 strbuf_release(&submodule_prefix);
1519 return 1;
1522 return 0;
1525 static int fetch_start_failure(struct strbuf *err,
1526 void *cb, void *task_cb)
1528 struct submodule_parallel_fetch *spf = cb;
1529 struct fetch_task *task = task_cb;
1531 spf->result = 1;
1533 fetch_task_release(task);
1534 return 0;
1537 static int commit_missing_in_sub(const struct object_id *oid, void *data)
1539 struct repository *subrepo = data;
1541 enum object_type type = oid_object_info(subrepo, oid, NULL);
1543 return type != OBJ_COMMIT;
1546 static int fetch_finish(int retvalue, struct strbuf *err,
1547 void *cb, void *task_cb)
1549 struct submodule_parallel_fetch *spf = cb;
1550 struct fetch_task *task = task_cb;
1552 struct string_list_item *it;
1553 struct oid_array *commits;
1555 if (!task || !task->sub)
1556 BUG("callback cookie bogus");
1558 if (retvalue) {
1560 * NEEDSWORK: This indicates that the overall fetch
1561 * failed, even though there may be a subsequent fetch
1562 * by commit hash that might work. It may be a good
1563 * idea to not indicate failure in this case, and only
1564 * indicate failure if the subsequent fetch fails.
1566 spf->result = 1;
1568 strbuf_addf(&spf->submodules_with_errors, "\t%s\n",
1569 task->sub->name);
1572 /* Is this the second time we process this submodule? */
1573 if (task->commits)
1574 goto out;
1576 it = string_list_lookup(&spf->changed_submodule_names, task->sub->name);
1577 if (!it)
1578 /* Could be an unchanged submodule, not contained in the list */
1579 goto out;
1581 commits = it->util;
1582 oid_array_filter(commits,
1583 commit_missing_in_sub,
1584 task->repo);
1586 /* Are there commits we want, but do not exist? */
1587 if (commits->nr) {
1588 task->commits = commits;
1589 ALLOC_GROW(spf->oid_fetch_tasks,
1590 spf->oid_fetch_tasks_nr + 1,
1591 spf->oid_fetch_tasks_alloc);
1592 spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr] = task;
1593 spf->oid_fetch_tasks_nr++;
1594 return 0;
1597 out:
1598 fetch_task_release(task);
1600 return 0;
1603 int fetch_populated_submodules(struct repository *r,
1604 const struct strvec *options,
1605 const char *prefix, int command_line_option,
1606 int default_option,
1607 int quiet, int max_parallel_jobs)
1609 int i;
1610 struct submodule_parallel_fetch spf = SPF_INIT;
1612 spf.r = r;
1613 spf.command_line_option = command_line_option;
1614 spf.default_option = default_option;
1615 spf.quiet = quiet;
1616 spf.prefix = prefix;
1618 if (!r->worktree)
1619 goto out;
1621 if (repo_read_index(r) < 0)
1622 die(_("index file corrupt"));
1624 strvec_push(&spf.args, "fetch");
1625 for (i = 0; i < options->nr; i++)
1626 strvec_push(&spf.args, options->v[i]);
1627 strvec_push(&spf.args, "--recurse-submodules-default");
1628 /* default value, "--submodule-prefix" and its value are added later */
1630 calculate_changed_submodule_paths(r, &spf.changed_submodule_names);
1631 string_list_sort(&spf.changed_submodule_names);
1632 run_processes_parallel_tr2(max_parallel_jobs,
1633 get_next_submodule,
1634 fetch_start_failure,
1635 fetch_finish,
1636 &spf,
1637 "submodule", "parallel/fetch");
1639 if (spf.submodules_with_errors.len > 0)
1640 fprintf(stderr, _("Errors during submodule fetch:\n%s"),
1641 spf.submodules_with_errors.buf);
1644 strvec_clear(&spf.args);
1645 out:
1646 free_submodules_oids(&spf.changed_submodule_names);
1647 return spf.result;
1650 unsigned is_submodule_modified(const char *path, int ignore_untracked)
1652 struct child_process cp = CHILD_PROCESS_INIT;
1653 struct strbuf buf = STRBUF_INIT;
1654 FILE *fp;
1655 unsigned dirty_submodule = 0;
1656 const char *git_dir;
1657 int ignore_cp_exit_code = 0;
1659 strbuf_addf(&buf, "%s/.git", path);
1660 git_dir = read_gitfile(buf.buf);
1661 if (!git_dir)
1662 git_dir = buf.buf;
1663 if (!is_git_directory(git_dir)) {
1664 if (is_directory(git_dir))
1665 die(_("'%s' not recognized as a git repository"), git_dir);
1666 strbuf_release(&buf);
1667 /* The submodule is not checked out, so it is not modified */
1668 return 0;
1670 strbuf_reset(&buf);
1672 strvec_pushl(&cp.args, "status", "--porcelain=2", NULL);
1673 if (ignore_untracked)
1674 strvec_push(&cp.args, "-uno");
1676 prepare_submodule_repo_env(&cp.env_array);
1677 cp.git_cmd = 1;
1678 cp.no_stdin = 1;
1679 cp.out = -1;
1680 cp.dir = path;
1681 if (start_command(&cp))
1682 die(_("Could not run 'git status --porcelain=2' in submodule %s"), path);
1684 fp = xfdopen(cp.out, "r");
1685 while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
1686 /* regular untracked files */
1687 if (buf.buf[0] == '?')
1688 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1690 if (buf.buf[0] == 'u' ||
1691 buf.buf[0] == '1' ||
1692 buf.buf[0] == '2') {
1693 /* T = line type, XY = status, SSSS = submodule state */
1694 if (buf.len < strlen("T XY SSSS"))
1695 BUG("invalid status --porcelain=2 line %s",
1696 buf.buf);
1698 if (buf.buf[5] == 'S' && buf.buf[8] == 'U')
1699 /* nested untracked file */
1700 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1702 if (buf.buf[0] == 'u' ||
1703 buf.buf[0] == '2' ||
1704 memcmp(buf.buf + 5, "S..U", 4))
1705 /* other change */
1706 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1709 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1710 ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
1711 ignore_untracked)) {
1713 * We're not interested in any further information from
1714 * the child any more, neither output nor its exit code.
1716 ignore_cp_exit_code = 1;
1717 break;
1720 fclose(fp);
1722 if (finish_command(&cp) && !ignore_cp_exit_code)
1723 die(_("'git status --porcelain=2' failed in submodule %s"), path);
1725 strbuf_release(&buf);
1726 return dirty_submodule;
1729 int submodule_uses_gitfile(const char *path)
1731 struct child_process cp = CHILD_PROCESS_INIT;
1732 struct strbuf buf = STRBUF_INIT;
1733 const char *git_dir;
1735 strbuf_addf(&buf, "%s/.git", path);
1736 git_dir = read_gitfile(buf.buf);
1737 if (!git_dir) {
1738 strbuf_release(&buf);
1739 return 0;
1741 strbuf_release(&buf);
1743 /* Now test that all nested submodules use a gitfile too */
1744 strvec_pushl(&cp.args,
1745 "submodule", "foreach", "--quiet", "--recursive",
1746 "test -f .git", NULL);
1748 prepare_submodule_repo_env(&cp.env_array);
1749 cp.git_cmd = 1;
1750 cp.no_stdin = 1;
1751 cp.no_stderr = 1;
1752 cp.no_stdout = 1;
1753 cp.dir = path;
1754 if (run_command(&cp))
1755 return 0;
1757 return 1;
1761 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1762 * when doing so.
1764 * Return 1 if we'd lose data, return 0 if the removal is fine,
1765 * and negative values for errors.
1767 int bad_to_remove_submodule(const char *path, unsigned flags)
1769 ssize_t len;
1770 struct child_process cp = CHILD_PROCESS_INIT;
1771 struct strbuf buf = STRBUF_INIT;
1772 int ret = 0;
1774 if (!file_exists(path) || is_empty_dir(path))
1775 return 0;
1777 if (!submodule_uses_gitfile(path))
1778 return 1;
1780 strvec_pushl(&cp.args, "status", "--porcelain",
1781 "--ignore-submodules=none", NULL);
1783 if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
1784 strvec_push(&cp.args, "-uno");
1785 else
1786 strvec_push(&cp.args, "-uall");
1788 if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
1789 strvec_push(&cp.args, "--ignored");
1791 prepare_submodule_repo_env(&cp.env_array);
1792 cp.git_cmd = 1;
1793 cp.no_stdin = 1;
1794 cp.out = -1;
1795 cp.dir = path;
1796 if (start_command(&cp)) {
1797 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1798 die(_("could not start 'git status' in submodule '%s'"),
1799 path);
1800 ret = -1;
1801 goto out;
1804 len = strbuf_read(&buf, cp.out, 1024);
1805 if (len > 2)
1806 ret = 1;
1807 close(cp.out);
1809 if (finish_command(&cp)) {
1810 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1811 die(_("could not run 'git status' in submodule '%s'"),
1812 path);
1813 ret = -1;
1815 out:
1816 strbuf_release(&buf);
1817 return ret;
1820 void submodule_unset_core_worktree(const struct submodule *sub)
1822 char *config_path = xstrfmt("%s/modules/%s/config",
1823 get_git_dir(), sub->name);
1825 if (git_config_set_in_file_gently(config_path, "core.worktree", NULL))
1826 warning(_("Could not unset core.worktree setting in submodule '%s'"),
1827 sub->path);
1829 free(config_path);
1832 static const char *get_super_prefix_or_empty(void)
1834 const char *s = get_super_prefix();
1835 if (!s)
1836 s = "";
1837 return s;
1840 static int submodule_has_dirty_index(const struct submodule *sub)
1842 struct child_process cp = CHILD_PROCESS_INIT;
1844 prepare_submodule_repo_env(&cp.env_array);
1846 cp.git_cmd = 1;
1847 strvec_pushl(&cp.args, "diff-index", "--quiet",
1848 "--cached", "HEAD", NULL);
1849 cp.no_stdin = 1;
1850 cp.no_stdout = 1;
1851 cp.dir = sub->path;
1852 if (start_command(&cp))
1853 die(_("could not recurse into submodule '%s'"), sub->path);
1855 return finish_command(&cp);
1858 static void submodule_reset_index(const char *path)
1860 struct child_process cp = CHILD_PROCESS_INIT;
1861 prepare_submodule_repo_env(&cp.env_array);
1863 cp.git_cmd = 1;
1864 cp.no_stdin = 1;
1865 cp.dir = path;
1867 strvec_pushf(&cp.args, "--super-prefix=%s%s/",
1868 get_super_prefix_or_empty(), path);
1869 strvec_pushl(&cp.args, "read-tree", "-u", "--reset", NULL);
1871 strvec_push(&cp.args, empty_tree_oid_hex());
1873 if (run_command(&cp))
1874 die(_("could not reset submodule index"));
1878 * Moves a submodule at a given path from a given head to another new head.
1879 * For edge cases (a submodule coming into existence or removing a submodule)
1880 * pass NULL for old or new respectively.
1882 int submodule_move_head(const char *path,
1883 const char *old_head,
1884 const char *new_head,
1885 unsigned flags)
1887 int ret = 0;
1888 struct child_process cp = CHILD_PROCESS_INIT;
1889 const struct submodule *sub;
1890 int *error_code_ptr, error_code;
1892 if (!is_submodule_active(the_repository, path))
1893 return 0;
1895 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1897 * Pass non NULL pointer to is_submodule_populated_gently
1898 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1899 * to fixup the submodule in the force case later.
1901 error_code_ptr = &error_code;
1902 else
1903 error_code_ptr = NULL;
1905 if (old_head && !is_submodule_populated_gently(path, error_code_ptr))
1906 return 0;
1908 sub = submodule_from_path(the_repository, &null_oid, path);
1910 if (!sub)
1911 BUG("could not get submodule information for '%s'", path);
1913 if (old_head && !(flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1914 /* Check if the submodule has a dirty index. */
1915 if (submodule_has_dirty_index(sub))
1916 return error(_("submodule '%s' has dirty index"), path);
1919 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1920 if (old_head) {
1921 if (!submodule_uses_gitfile(path))
1922 absorb_git_dir_into_superproject(path,
1923 ABSORB_GITDIR_RECURSE_SUBMODULES);
1924 } else {
1925 char *gitdir = xstrfmt("%s/modules/%s",
1926 get_git_dir(), sub->name);
1927 connect_work_tree_and_git_dir(path, gitdir, 0);
1928 free(gitdir);
1930 /* make sure the index is clean as well */
1931 submodule_reset_index(path);
1934 if (old_head && (flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1935 char *gitdir = xstrfmt("%s/modules/%s",
1936 get_git_dir(), sub->name);
1937 connect_work_tree_and_git_dir(path, gitdir, 1);
1938 free(gitdir);
1942 prepare_submodule_repo_env(&cp.env_array);
1944 cp.git_cmd = 1;
1945 cp.no_stdin = 1;
1946 cp.dir = path;
1948 strvec_pushf(&cp.args, "--super-prefix=%s%s/",
1949 get_super_prefix_or_empty(), path);
1950 strvec_pushl(&cp.args, "read-tree", "--recurse-submodules", NULL);
1952 if (flags & SUBMODULE_MOVE_HEAD_DRY_RUN)
1953 strvec_push(&cp.args, "-n");
1954 else
1955 strvec_push(&cp.args, "-u");
1957 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1958 strvec_push(&cp.args, "--reset");
1959 else
1960 strvec_push(&cp.args, "-m");
1962 if (!(flags & SUBMODULE_MOVE_HEAD_FORCE))
1963 strvec_push(&cp.args, old_head ? old_head : empty_tree_oid_hex());
1965 strvec_push(&cp.args, new_head ? new_head : empty_tree_oid_hex());
1967 if (run_command(&cp)) {
1968 ret = error(_("Submodule '%s' could not be updated."), path);
1969 goto out;
1972 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1973 if (new_head) {
1974 child_process_init(&cp);
1975 /* also set the HEAD accordingly */
1976 cp.git_cmd = 1;
1977 cp.no_stdin = 1;
1978 cp.dir = path;
1980 prepare_submodule_repo_env(&cp.env_array);
1981 strvec_pushl(&cp.args, "update-ref", "HEAD",
1982 "--no-deref", new_head, NULL);
1984 if (run_command(&cp)) {
1985 ret = -1;
1986 goto out;
1988 } else {
1989 struct strbuf sb = STRBUF_INIT;
1991 strbuf_addf(&sb, "%s/.git", path);
1992 unlink_or_warn(sb.buf);
1993 strbuf_release(&sb);
1995 if (is_empty_dir(path))
1996 rmdir_or_warn(path);
1998 submodule_unset_core_worktree(sub);
2001 out:
2002 return ret;
2005 int validate_submodule_git_dir(char *git_dir, const char *submodule_name)
2007 size_t len = strlen(git_dir), suffix_len = strlen(submodule_name);
2008 char *p;
2009 int ret = 0;
2011 if (len <= suffix_len || (p = git_dir + len - suffix_len)[-1] != '/' ||
2012 strcmp(p, submodule_name))
2013 BUG("submodule name '%s' not a suffix of git dir '%s'",
2014 submodule_name, git_dir);
2017 * We prevent the contents of sibling submodules' git directories to
2018 * clash.
2020 * Example: having a submodule named `hippo` and another one named
2021 * `hippo/hooks` would result in the git directories
2022 * `.git/modules/hippo/` and `.git/modules/hippo/hooks/`, respectively,
2023 * but the latter directory is already designated to contain the hooks
2024 * of the former.
2026 for (; *p; p++) {
2027 if (is_dir_sep(*p)) {
2028 char c = *p;
2030 *p = '\0';
2031 if (is_git_directory(git_dir))
2032 ret = -1;
2033 *p = c;
2035 if (ret < 0)
2036 return error(_("submodule git dir '%s' is "
2037 "inside git dir '%.*s'"),
2038 git_dir,
2039 (int)(p - git_dir), git_dir);
2043 return 0;
2047 * Embeds a single submodules git directory into the superprojects git dir,
2048 * non recursively.
2050 static void relocate_single_git_dir_into_superproject(const char *path)
2052 char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
2053 char *new_git_dir;
2054 const struct submodule *sub;
2056 if (submodule_uses_worktrees(path))
2057 die(_("relocate_gitdir for submodule '%s' with "
2058 "more than one worktree not supported"), path);
2060 old_git_dir = xstrfmt("%s/.git", path);
2061 if (read_gitfile(old_git_dir))
2062 /* If it is an actual gitfile, it doesn't need migration. */
2063 return;
2065 real_old_git_dir = real_pathdup(old_git_dir, 1);
2067 sub = submodule_from_path(the_repository, &null_oid, path);
2068 if (!sub)
2069 die(_("could not lookup name for submodule '%s'"), path);
2071 new_git_dir = git_pathdup("modules/%s", sub->name);
2072 if (validate_submodule_git_dir(new_git_dir, sub->name) < 0)
2073 die(_("refusing to move '%s' into an existing git dir"),
2074 real_old_git_dir);
2075 if (safe_create_leading_directories_const(new_git_dir) < 0)
2076 die(_("could not create directory '%s'"), new_git_dir);
2077 real_new_git_dir = real_pathdup(new_git_dir, 1);
2078 free(new_git_dir);
2080 fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
2081 get_super_prefix_or_empty(), path,
2082 real_old_git_dir, real_new_git_dir);
2084 relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
2086 free(old_git_dir);
2087 free(real_old_git_dir);
2088 free(real_new_git_dir);
2092 * Migrate the git directory of the submodule given by path from
2093 * having its git directory within the working tree to the git dir nested
2094 * in its superprojects git dir under modules/.
2096 void absorb_git_dir_into_superproject(const char *path,
2097 unsigned flags)
2099 int err_code;
2100 const char *sub_git_dir;
2101 struct strbuf gitdir = STRBUF_INIT;
2102 strbuf_addf(&gitdir, "%s/.git", path);
2103 sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
2105 /* Not populated? */
2106 if (!sub_git_dir) {
2107 const struct submodule *sub;
2109 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
2110 /* unpopulated as expected */
2111 strbuf_release(&gitdir);
2112 return;
2115 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
2116 /* We don't know what broke here. */
2117 read_gitfile_error_die(err_code, path, NULL);
2120 * Maybe populated, but no git directory was found?
2121 * This can happen if the superproject is a submodule
2122 * itself and was just absorbed. The absorption of the
2123 * superproject did not rewrite the git file links yet,
2124 * fix it now.
2126 sub = submodule_from_path(the_repository, &null_oid, path);
2127 if (!sub)
2128 die(_("could not lookup name for submodule '%s'"), path);
2129 connect_work_tree_and_git_dir(path,
2130 git_path("modules/%s", sub->name), 0);
2131 } else {
2132 /* Is it already absorbed into the superprojects git dir? */
2133 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
2134 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
2136 if (!starts_with(real_sub_git_dir, real_common_git_dir))
2137 relocate_single_git_dir_into_superproject(path);
2139 free(real_sub_git_dir);
2140 free(real_common_git_dir);
2142 strbuf_release(&gitdir);
2144 if (flags & ABSORB_GITDIR_RECURSE_SUBMODULES) {
2145 struct child_process cp = CHILD_PROCESS_INIT;
2146 struct strbuf sb = STRBUF_INIT;
2148 if (flags & ~ABSORB_GITDIR_RECURSE_SUBMODULES)
2149 BUG("we don't know how to pass the flags down?");
2151 strbuf_addstr(&sb, get_super_prefix_or_empty());
2152 strbuf_addstr(&sb, path);
2153 strbuf_addch(&sb, '/');
2155 cp.dir = path;
2156 cp.git_cmd = 1;
2157 cp.no_stdin = 1;
2158 strvec_pushl(&cp.args, "--super-prefix", sb.buf,
2159 "submodule--helper",
2160 "absorb-git-dirs", NULL);
2161 prepare_submodule_repo_env(&cp.env_array);
2162 if (run_command(&cp))
2163 die(_("could not recurse into submodule '%s'"), path);
2165 strbuf_release(&sb);
2169 int get_superproject_working_tree(struct strbuf *buf)
2171 struct child_process cp = CHILD_PROCESS_INIT;
2172 struct strbuf sb = STRBUF_INIT;
2173 struct strbuf one_up = STRBUF_INIT;
2174 const char *cwd = xgetcwd();
2175 int ret = 0;
2176 const char *subpath;
2177 int code;
2178 ssize_t len;
2180 if (!is_inside_work_tree())
2182 * FIXME:
2183 * We might have a superproject, but it is harder
2184 * to determine.
2186 return 0;
2188 if (!strbuf_realpath(&one_up, "../", 0))
2189 return 0;
2191 subpath = relative_path(cwd, one_up.buf, &sb);
2192 strbuf_release(&one_up);
2194 prepare_submodule_repo_env(&cp.env_array);
2195 strvec_pop(&cp.env_array);
2197 strvec_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
2198 "ls-files", "-z", "--stage", "--full-name", "--",
2199 subpath, NULL);
2200 strbuf_reset(&sb);
2202 cp.no_stdin = 1;
2203 cp.no_stderr = 1;
2204 cp.out = -1;
2205 cp.git_cmd = 1;
2207 if (start_command(&cp))
2208 die(_("could not start ls-files in .."));
2210 len = strbuf_read(&sb, cp.out, PATH_MAX);
2211 close(cp.out);
2213 if (starts_with(sb.buf, "160000")) {
2214 int super_sub_len;
2215 int cwd_len = strlen(cwd);
2216 char *super_sub, *super_wt;
2219 * There is a superproject having this repo as a submodule.
2220 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
2221 * We're only interested in the name after the tab.
2223 super_sub = strchr(sb.buf, '\t') + 1;
2224 super_sub_len = strlen(super_sub);
2226 if (super_sub_len > cwd_len ||
2227 strcmp(&cwd[cwd_len - super_sub_len], super_sub))
2228 BUG("returned path string doesn't match cwd?");
2230 super_wt = xstrdup(cwd);
2231 super_wt[cwd_len - super_sub_len] = '\0';
2233 strbuf_realpath(buf, super_wt, 1);
2234 ret = 1;
2235 free(super_wt);
2237 strbuf_release(&sb);
2239 code = finish_command(&cp);
2241 if (code == 128)
2242 /* '../' is not a git repository */
2243 return 0;
2244 if (code == 0 && len == 0)
2245 /* There is an unrelated git repository at '../' */
2246 return 0;
2247 if (code)
2248 die(_("ls-tree returned unexpected return code %d"), code);
2250 return ret;
2254 * Put the gitdir for a submodule (given relative to the main
2255 * repository worktree) into `buf`, or return -1 on error.
2257 int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
2259 const struct submodule *sub;
2260 const char *git_dir;
2261 int ret = 0;
2263 strbuf_reset(buf);
2264 strbuf_addstr(buf, submodule);
2265 strbuf_complete(buf, '/');
2266 strbuf_addstr(buf, ".git");
2268 git_dir = read_gitfile(buf->buf);
2269 if (git_dir) {
2270 strbuf_reset(buf);
2271 strbuf_addstr(buf, git_dir);
2273 if (!is_git_directory(buf->buf)) {
2274 sub = submodule_from_path(the_repository, &null_oid, submodule);
2275 if (!sub) {
2276 ret = -1;
2277 goto cleanup;
2279 strbuf_reset(buf);
2280 strbuf_git_path(buf, "%s/%s", "modules", sub->name);
2283 cleanup:
2284 return ret;