Merge branch 'backport/js/ci-gcc-12-fixes'
[git/debian.git] / submodule.c
blobb561445329204f20a326cf7f7a5b897ca28d0934
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);
502 static void prepare_submodule_repo_env_in_gitdir(struct strvec *out)
504 prepare_submodule_repo_env_no_git_dir(out);
505 strvec_pushf(out, "%s=.", GIT_DIR_ENVIRONMENT);
509 * Initialize a repository struct for a submodule based on the provided 'path'.
511 * Unlike repo_submodule_init, this tolerates submodules not present
512 * in .gitmodules. This function exists only to preserve historical behavior,
514 * Returns the repository struct on success,
515 * NULL when the submodule is not present.
517 static struct repository *open_submodule(const char *path)
519 struct strbuf sb = STRBUF_INIT;
520 struct repository *out = xmalloc(sizeof(*out));
522 if (submodule_to_gitdir(&sb, path) || repo_init(out, sb.buf, NULL)) {
523 strbuf_release(&sb);
524 free(out);
525 return NULL;
528 /* Mark it as a submodule */
529 out->submodule_prefix = xstrdup(path);
531 strbuf_release(&sb);
532 return out;
536 * Helper function to display the submodule header line prior to the full
537 * summary output.
539 * If it can locate the submodule git directory it will create a repository
540 * handle for the submodule and lookup both the left and right commits and
541 * put them into the left and right pointers.
543 static void show_submodule_header(struct diff_options *o,
544 const char *path,
545 struct object_id *one, struct object_id *two,
546 unsigned dirty_submodule,
547 struct repository *sub,
548 struct commit **left, struct commit **right,
549 struct commit_list **merge_bases)
551 const char *message = NULL;
552 struct strbuf sb = STRBUF_INIT;
553 int fast_forward = 0, fast_backward = 0;
555 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
556 diff_emit_submodule_untracked(o, path);
558 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
559 diff_emit_submodule_modified(o, path);
561 if (is_null_oid(one))
562 message = "(new submodule)";
563 else if (is_null_oid(two))
564 message = "(submodule deleted)";
566 if (!sub) {
567 if (!message)
568 message = "(commits not present)";
569 goto output_header;
573 * Attempt to lookup the commit references, and determine if this is
574 * a fast forward or fast backwards update.
576 *left = lookup_commit_reference(sub, one);
577 *right = lookup_commit_reference(sub, two);
580 * Warn about missing commits in the submodule project, but only if
581 * they aren't null.
583 if ((!is_null_oid(one) && !*left) ||
584 (!is_null_oid(two) && !*right))
585 message = "(commits not present)";
587 *merge_bases = repo_get_merge_bases(sub, *left, *right);
588 if (*merge_bases) {
589 if ((*merge_bases)->item == *left)
590 fast_forward = 1;
591 else if ((*merge_bases)->item == *right)
592 fast_backward = 1;
595 if (oideq(one, two)) {
596 strbuf_release(&sb);
597 return;
600 output_header:
601 strbuf_addf(&sb, "Submodule %s ", path);
602 strbuf_add_unique_abbrev(&sb, one, DEFAULT_ABBREV);
603 strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
604 strbuf_add_unique_abbrev(&sb, two, DEFAULT_ABBREV);
605 if (message)
606 strbuf_addf(&sb, " %s\n", message);
607 else
608 strbuf_addf(&sb, "%s:\n", fast_backward ? " (rewind)" : "");
609 diff_emit_submodule_header(o, sb.buf);
611 strbuf_release(&sb);
614 void show_submodule_diff_summary(struct diff_options *o, const char *path,
615 struct object_id *one, struct object_id *two,
616 unsigned dirty_submodule)
618 struct rev_info rev;
619 struct commit *left = NULL, *right = NULL;
620 struct commit_list *merge_bases = NULL;
621 struct repository *sub;
623 sub = open_submodule(path);
624 show_submodule_header(o, path, one, two, dirty_submodule,
625 sub, &left, &right, &merge_bases);
628 * If we don't have both a left and a right pointer, there is no
629 * reason to try and display a summary. The header line should contain
630 * all the information the user needs.
632 if (!left || !right || !sub)
633 goto out;
635 /* Treat revision walker failure the same as missing commits */
636 if (prepare_submodule_diff_summary(sub, &rev, path, left, right, merge_bases)) {
637 diff_emit_submodule_error(o, "(revision walker failed)\n");
638 goto out;
641 print_submodule_diff_summary(sub, &rev, o);
643 out:
644 if (merge_bases)
645 free_commit_list(merge_bases);
646 clear_commit_marks(left, ~0);
647 clear_commit_marks(right, ~0);
648 if (sub) {
649 repo_clear(sub);
650 free(sub);
654 void show_submodule_inline_diff(struct diff_options *o, const char *path,
655 struct object_id *one, struct object_id *two,
656 unsigned dirty_submodule)
658 const struct object_id *old_oid = the_hash_algo->empty_tree, *new_oid = the_hash_algo->empty_tree;
659 struct commit *left = NULL, *right = NULL;
660 struct commit_list *merge_bases = NULL;
661 struct child_process cp = CHILD_PROCESS_INIT;
662 struct strbuf sb = STRBUF_INIT;
663 struct repository *sub;
665 sub = open_submodule(path);
666 show_submodule_header(o, path, one, two, dirty_submodule,
667 sub, &left, &right, &merge_bases);
669 /* We need a valid left and right commit to display a difference */
670 if (!(left || is_null_oid(one)) ||
671 !(right || is_null_oid(two)))
672 goto done;
674 if (left)
675 old_oid = one;
676 if (right)
677 new_oid = two;
679 cp.git_cmd = 1;
680 cp.dir = path;
681 cp.out = -1;
682 cp.no_stdin = 1;
684 /* TODO: other options may need to be passed here. */
685 strvec_pushl(&cp.args, "diff", "--submodule=diff", NULL);
686 strvec_pushf(&cp.args, "--color=%s", want_color(o->use_color) ?
687 "always" : "never");
689 if (o->flags.reverse_diff) {
690 strvec_pushf(&cp.args, "--src-prefix=%s%s/",
691 o->b_prefix, path);
692 strvec_pushf(&cp.args, "--dst-prefix=%s%s/",
693 o->a_prefix, path);
694 } else {
695 strvec_pushf(&cp.args, "--src-prefix=%s%s/",
696 o->a_prefix, path);
697 strvec_pushf(&cp.args, "--dst-prefix=%s%s/",
698 o->b_prefix, path);
700 strvec_push(&cp.args, oid_to_hex(old_oid));
702 * If the submodule has modified content, we will diff against the
703 * work tree, under the assumption that the user has asked for the
704 * diff format and wishes to actually see all differences even if they
705 * haven't yet been committed to the submodule yet.
707 if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
708 strvec_push(&cp.args, oid_to_hex(new_oid));
710 prepare_submodule_repo_env(&cp.env_array);
711 if (start_command(&cp))
712 diff_emit_submodule_error(o, "(diff failed)\n");
714 while (strbuf_getwholeline_fd(&sb, cp.out, '\n') != EOF)
715 diff_emit_submodule_pipethrough(o, sb.buf, sb.len);
717 if (finish_command(&cp))
718 diff_emit_submodule_error(o, "(diff failed)\n");
720 done:
721 strbuf_release(&sb);
722 if (merge_bases)
723 free_commit_list(merge_bases);
724 if (left)
725 clear_commit_marks(left, ~0);
726 if (right)
727 clear_commit_marks(right, ~0);
728 if (sub) {
729 repo_clear(sub);
730 free(sub);
734 int should_update_submodules(void)
736 return config_update_recurse_submodules == RECURSE_SUBMODULES_ON;
739 const struct submodule *submodule_from_ce(const struct cache_entry *ce)
741 if (!S_ISGITLINK(ce->ce_mode))
742 return NULL;
744 if (!should_update_submodules())
745 return NULL;
747 return submodule_from_path(the_repository, &null_oid, ce->name);
750 static struct oid_array *submodule_commits(struct string_list *submodules,
751 const char *name)
753 struct string_list_item *item;
755 item = string_list_insert(submodules, name);
756 if (item->util)
757 return (struct oid_array *) item->util;
759 /* NEEDSWORK: should we have oid_array_init()? */
760 item->util = xcalloc(1, sizeof(struct oid_array));
761 return (struct oid_array *) item->util;
764 struct collect_changed_submodules_cb_data {
765 struct repository *repo;
766 struct string_list *changed;
767 const struct object_id *commit_oid;
771 * this would normally be two functions: default_name_from_path() and
772 * path_from_default_name(). Since the default name is the same as
773 * the submodule path we can get away with just one function which only
774 * checks whether there is a submodule in the working directory at that
775 * location.
777 static const char *default_name_or_path(const char *path_or_name)
779 int error_code;
781 if (!is_submodule_populated_gently(path_or_name, &error_code))
782 return NULL;
784 return path_or_name;
787 static void collect_changed_submodules_cb(struct diff_queue_struct *q,
788 struct diff_options *options,
789 void *data)
791 struct collect_changed_submodules_cb_data *me = data;
792 struct string_list *changed = me->changed;
793 const struct object_id *commit_oid = me->commit_oid;
794 int i;
796 for (i = 0; i < q->nr; i++) {
797 struct diff_filepair *p = q->queue[i];
798 struct oid_array *commits;
799 const struct submodule *submodule;
800 const char *name;
802 if (!S_ISGITLINK(p->two->mode))
803 continue;
805 submodule = submodule_from_path(me->repo,
806 commit_oid, p->two->path);
807 if (submodule)
808 name = submodule->name;
809 else {
810 name = default_name_or_path(p->two->path);
811 /* make sure name does not collide with existing one */
812 if (name)
813 submodule = submodule_from_name(me->repo,
814 commit_oid, name);
815 if (submodule) {
816 warning(_("Submodule in commit %s at path: "
817 "'%s' collides with a submodule named "
818 "the same. Skipping it."),
819 oid_to_hex(commit_oid), p->two->path);
820 name = NULL;
824 if (!name)
825 continue;
827 commits = submodule_commits(changed, name);
828 oid_array_append(commits, &p->two->oid);
833 * Collect the paths of submodules in 'changed' which have changed based on
834 * the revisions as specified in 'argv'. Each entry in 'changed' will also
835 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
836 * what the submodule pointers were updated to during the change.
838 static void collect_changed_submodules(struct repository *r,
839 struct string_list *changed,
840 struct strvec *argv)
842 struct rev_info rev;
843 const struct commit *commit;
844 int save_warning;
845 struct setup_revision_opt s_r_opt = {
846 .assume_dashdash = 1,
849 save_warning = warn_on_object_refname_ambiguity;
850 warn_on_object_refname_ambiguity = 0;
851 repo_init_revisions(r, &rev, NULL);
852 setup_revisions(argv->nr, argv->v, &rev, &s_r_opt);
853 warn_on_object_refname_ambiguity = save_warning;
854 if (prepare_revision_walk(&rev))
855 die(_("revision walk setup failed"));
857 while ((commit = get_revision(&rev))) {
858 struct rev_info diff_rev;
859 struct collect_changed_submodules_cb_data data;
860 data.repo = r;
861 data.changed = changed;
862 data.commit_oid = &commit->object.oid;
864 repo_init_revisions(r, &diff_rev, NULL);
865 diff_rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
866 diff_rev.diffopt.format_callback = collect_changed_submodules_cb;
867 diff_rev.diffopt.format_callback_data = &data;
868 diff_rev.dense_combined_merges = 1;
869 diff_tree_combined_merge(commit, &diff_rev);
872 reset_revision_walk();
875 static void free_submodules_oids(struct string_list *submodules)
877 struct string_list_item *item;
878 for_each_string_list_item(item, submodules)
879 oid_array_clear((struct oid_array *) item->util);
880 string_list_clear(submodules, 1);
883 static int has_remote(const char *refname, const struct object_id *oid,
884 int flags, void *cb_data)
886 return 1;
889 static int append_oid_to_argv(const struct object_id *oid, void *data)
891 struct strvec *argv = data;
892 strvec_push(argv, oid_to_hex(oid));
893 return 0;
896 struct has_commit_data {
897 struct repository *repo;
898 int result;
899 const char *path;
902 static int check_has_commit(const struct object_id *oid, void *data)
904 struct has_commit_data *cb = data;
906 enum object_type type = oid_object_info(cb->repo, oid, NULL);
908 switch (type) {
909 case OBJ_COMMIT:
910 return 0;
911 case OBJ_BAD:
913 * Object is missing or invalid. If invalid, an error message
914 * has already been printed.
916 cb->result = 0;
917 return 0;
918 default:
919 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
920 cb->path, oid_to_hex(oid), type_name(type));
924 static int submodule_has_commits(struct repository *r,
925 const char *path,
926 struct oid_array *commits)
928 struct has_commit_data has_commit = { r, 1, path };
931 * Perform a cheap, but incorrect check for the existence of 'commits'.
932 * This is done by adding the submodule's object store to the in-core
933 * object store, and then querying for each commit's existence. If we
934 * do not have the commit object anywhere, there is no chance we have
935 * it in the object store of the correct submodule and have it
936 * reachable from a ref, so we can fail early without spawning rev-list
937 * which is expensive.
939 if (add_submodule_odb(path))
940 return 0;
942 oid_array_for_each_unique(commits, check_has_commit, &has_commit);
944 if (has_commit.result) {
946 * Even if the submodule is checked out and the commit is
947 * present, make sure it exists in the submodule's object store
948 * and that it is reachable from a ref.
950 struct child_process cp = CHILD_PROCESS_INIT;
951 struct strbuf out = STRBUF_INIT;
953 strvec_pushl(&cp.args, "rev-list", "-n", "1", NULL);
954 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
955 strvec_pushl(&cp.args, "--not", "--all", NULL);
957 prepare_submodule_repo_env(&cp.env_array);
958 cp.git_cmd = 1;
959 cp.no_stdin = 1;
960 cp.dir = path;
962 if (capture_command(&cp, &out, GIT_MAX_HEXSZ + 1) || out.len)
963 has_commit.result = 0;
965 strbuf_release(&out);
968 return has_commit.result;
971 static int submodule_needs_pushing(struct repository *r,
972 const char *path,
973 struct oid_array *commits)
975 if (!submodule_has_commits(r, path, commits))
977 * NOTE: We do consider it safe to return "no" here. The
978 * correct answer would be "We do not know" instead of
979 * "No push needed", but it is quite hard to change
980 * the submodule pointer without having the submodule
981 * around. If a user did however change the submodules
982 * without having the submodule around, this indicates
983 * an expert who knows what they are doing or a
984 * maintainer integrating work from other people. In
985 * both cases it should be safe to skip this check.
987 return 0;
989 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
990 struct child_process cp = CHILD_PROCESS_INIT;
991 struct strbuf buf = STRBUF_INIT;
992 int needs_pushing = 0;
994 strvec_push(&cp.args, "rev-list");
995 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
996 strvec_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
998 prepare_submodule_repo_env(&cp.env_array);
999 cp.git_cmd = 1;
1000 cp.no_stdin = 1;
1001 cp.out = -1;
1002 cp.dir = path;
1003 if (start_command(&cp))
1004 die(_("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s"),
1005 path);
1006 if (strbuf_read(&buf, cp.out, the_hash_algo->hexsz + 1))
1007 needs_pushing = 1;
1008 finish_command(&cp);
1009 close(cp.out);
1010 strbuf_release(&buf);
1011 return needs_pushing;
1014 return 0;
1017 int find_unpushed_submodules(struct repository *r,
1018 struct oid_array *commits,
1019 const char *remotes_name,
1020 struct string_list *needs_pushing)
1022 struct string_list submodules = STRING_LIST_INIT_DUP;
1023 struct string_list_item *name;
1024 struct strvec argv = STRVEC_INIT;
1026 /* argv.v[0] will be ignored by setup_revisions */
1027 strvec_push(&argv, "find_unpushed_submodules");
1028 oid_array_for_each_unique(commits, append_oid_to_argv, &argv);
1029 strvec_push(&argv, "--not");
1030 strvec_pushf(&argv, "--remotes=%s", remotes_name);
1032 collect_changed_submodules(r, &submodules, &argv);
1034 for_each_string_list_item(name, &submodules) {
1035 struct oid_array *commits = name->util;
1036 const struct submodule *submodule;
1037 const char *path = NULL;
1039 submodule = submodule_from_name(r, &null_oid, name->string);
1040 if (submodule)
1041 path = submodule->path;
1042 else
1043 path = default_name_or_path(name->string);
1045 if (!path)
1046 continue;
1048 if (submodule_needs_pushing(r, path, commits))
1049 string_list_insert(needs_pushing, path);
1052 free_submodules_oids(&submodules);
1053 strvec_clear(&argv);
1055 return needs_pushing->nr;
1058 static int push_submodule(const char *path,
1059 const struct remote *remote,
1060 const struct refspec *rs,
1061 const struct string_list *push_options,
1062 int dry_run)
1064 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
1065 struct child_process cp = CHILD_PROCESS_INIT;
1066 strvec_push(&cp.args, "push");
1067 if (dry_run)
1068 strvec_push(&cp.args, "--dry-run");
1070 if (push_options && push_options->nr) {
1071 const struct string_list_item *item;
1072 for_each_string_list_item(item, push_options)
1073 strvec_pushf(&cp.args, "--push-option=%s",
1074 item->string);
1077 if (remote->origin != REMOTE_UNCONFIGURED) {
1078 int i;
1079 strvec_push(&cp.args, remote->name);
1080 for (i = 0; i < rs->raw_nr; i++)
1081 strvec_push(&cp.args, rs->raw[i]);
1084 prepare_submodule_repo_env(&cp.env_array);
1085 cp.git_cmd = 1;
1086 cp.no_stdin = 1;
1087 cp.dir = path;
1088 if (run_command(&cp))
1089 return 0;
1090 close(cp.out);
1093 return 1;
1097 * Perform a check in the submodule to see if the remote and refspec work.
1098 * Die if the submodule can't be pushed.
1100 static void submodule_push_check(const char *path, const char *head,
1101 const struct remote *remote,
1102 const struct refspec *rs)
1104 struct child_process cp = CHILD_PROCESS_INIT;
1105 int i;
1107 strvec_push(&cp.args, "submodule--helper");
1108 strvec_push(&cp.args, "push-check");
1109 strvec_push(&cp.args, head);
1110 strvec_push(&cp.args, remote->name);
1112 for (i = 0; i < rs->raw_nr; i++)
1113 strvec_push(&cp.args, rs->raw[i]);
1115 prepare_submodule_repo_env(&cp.env_array);
1116 cp.git_cmd = 1;
1117 cp.no_stdin = 1;
1118 cp.no_stdout = 1;
1119 cp.dir = path;
1122 * Simply indicate if 'submodule--helper push-check' failed.
1123 * More detailed error information will be provided by the
1124 * child process.
1126 if (run_command(&cp))
1127 die(_("process for submodule '%s' failed"), path);
1130 int push_unpushed_submodules(struct repository *r,
1131 struct oid_array *commits,
1132 const struct remote *remote,
1133 const struct refspec *rs,
1134 const struct string_list *push_options,
1135 int dry_run)
1137 int i, ret = 1;
1138 struct string_list needs_pushing = STRING_LIST_INIT_DUP;
1140 if (!find_unpushed_submodules(r, commits,
1141 remote->name, &needs_pushing))
1142 return 1;
1145 * Verify that the remote and refspec can be propagated to all
1146 * submodules. This check can be skipped if the remote and refspec
1147 * won't be propagated due to the remote being unconfigured (e.g. a URL
1148 * instead of a remote name).
1150 if (remote->origin != REMOTE_UNCONFIGURED) {
1151 char *head;
1152 struct object_id head_oid;
1154 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1155 if (!head)
1156 die(_("Failed to resolve HEAD as a valid ref."));
1158 for (i = 0; i < needs_pushing.nr; i++)
1159 submodule_push_check(needs_pushing.items[i].string,
1160 head, remote, rs);
1161 free(head);
1164 /* Actually push the submodules */
1165 for (i = 0; i < needs_pushing.nr; i++) {
1166 const char *path = needs_pushing.items[i].string;
1167 fprintf(stderr, _("Pushing submodule '%s'\n"), path);
1168 if (!push_submodule(path, remote, rs,
1169 push_options, dry_run)) {
1170 fprintf(stderr, _("Unable to push submodule '%s'\n"), path);
1171 ret = 0;
1175 string_list_clear(&needs_pushing, 0);
1177 return ret;
1180 static int append_oid_to_array(const char *ref, const struct object_id *oid,
1181 int flags, void *data)
1183 struct oid_array *array = data;
1184 oid_array_append(array, oid);
1185 return 0;
1188 void check_for_new_submodule_commits(struct object_id *oid)
1190 if (!initialized_fetch_ref_tips) {
1191 for_each_ref(append_oid_to_array, &ref_tips_before_fetch);
1192 initialized_fetch_ref_tips = 1;
1195 oid_array_append(&ref_tips_after_fetch, oid);
1198 static void calculate_changed_submodule_paths(struct repository *r,
1199 struct string_list *changed_submodule_names)
1201 struct strvec argv = STRVEC_INIT;
1202 struct string_list_item *name;
1204 /* No need to check if there are no submodules configured */
1205 if (!submodule_from_path(r, NULL, NULL))
1206 return;
1208 strvec_push(&argv, "--"); /* argv[0] program name */
1209 oid_array_for_each_unique(&ref_tips_after_fetch,
1210 append_oid_to_argv, &argv);
1211 strvec_push(&argv, "--not");
1212 oid_array_for_each_unique(&ref_tips_before_fetch,
1213 append_oid_to_argv, &argv);
1216 * Collect all submodules (whether checked out or not) for which new
1217 * commits have been recorded upstream in "changed_submodule_names".
1219 collect_changed_submodules(r, changed_submodule_names, &argv);
1221 for_each_string_list_item(name, changed_submodule_names) {
1222 struct oid_array *commits = name->util;
1223 const struct submodule *submodule;
1224 const char *path = NULL;
1226 submodule = submodule_from_name(r, &null_oid, name->string);
1227 if (submodule)
1228 path = submodule->path;
1229 else
1230 path = default_name_or_path(name->string);
1232 if (!path)
1233 continue;
1235 if (submodule_has_commits(r, path, commits)) {
1236 oid_array_clear(commits);
1237 *name->string = '\0';
1241 string_list_remove_empty_items(changed_submodule_names, 1);
1243 strvec_clear(&argv);
1244 oid_array_clear(&ref_tips_before_fetch);
1245 oid_array_clear(&ref_tips_after_fetch);
1246 initialized_fetch_ref_tips = 0;
1249 int submodule_touches_in_range(struct repository *r,
1250 struct object_id *excl_oid,
1251 struct object_id *incl_oid)
1253 struct string_list subs = STRING_LIST_INIT_DUP;
1254 struct strvec args = STRVEC_INIT;
1255 int ret;
1257 /* No need to check if there are no submodules configured */
1258 if (!submodule_from_path(r, NULL, NULL))
1259 return 0;
1261 strvec_push(&args, "--"); /* args[0] program name */
1262 strvec_push(&args, oid_to_hex(incl_oid));
1263 if (!is_null_oid(excl_oid)) {
1264 strvec_push(&args, "--not");
1265 strvec_push(&args, oid_to_hex(excl_oid));
1268 collect_changed_submodules(r, &subs, &args);
1269 ret = subs.nr;
1271 strvec_clear(&args);
1273 free_submodules_oids(&subs);
1274 return ret;
1277 struct submodule_parallel_fetch {
1278 int count;
1279 struct strvec args;
1280 struct repository *r;
1281 const char *prefix;
1282 int command_line_option;
1283 int default_option;
1284 int quiet;
1285 int result;
1287 struct string_list changed_submodule_names;
1289 /* Pending fetches by OIDs */
1290 struct fetch_task **oid_fetch_tasks;
1291 int oid_fetch_tasks_nr, oid_fetch_tasks_alloc;
1293 struct strbuf submodules_with_errors;
1295 #define SPF_INIT {0, STRVEC_INIT, NULL, NULL, 0, 0, 0, 0, \
1296 STRING_LIST_INIT_DUP, \
1297 NULL, 0, 0, STRBUF_INIT}
1299 static int get_fetch_recurse_config(const struct submodule *submodule,
1300 struct submodule_parallel_fetch *spf)
1302 if (spf->command_line_option != RECURSE_SUBMODULES_DEFAULT)
1303 return spf->command_line_option;
1305 if (submodule) {
1306 char *key;
1307 const char *value;
1309 int fetch_recurse = submodule->fetch_recurse;
1310 key = xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule->name);
1311 if (!repo_config_get_string_tmp(spf->r, key, &value)) {
1312 fetch_recurse = parse_fetch_recurse_submodules_arg(key, value);
1314 free(key);
1316 if (fetch_recurse != RECURSE_SUBMODULES_NONE)
1317 /* local config overrules everything except commandline */
1318 return fetch_recurse;
1321 return spf->default_option;
1325 * Fetch in progress (if callback data) or
1326 * pending (if in oid_fetch_tasks in struct submodule_parallel_fetch)
1328 struct fetch_task {
1329 struct repository *repo;
1330 const struct submodule *sub;
1331 unsigned free_sub : 1; /* Do we need to free the submodule? */
1333 struct oid_array *commits; /* Ensure these commits are fetched */
1337 * When a submodule is not defined in .gitmodules, we cannot access it
1338 * via the regular submodule-config. Create a fake submodule, which we can
1339 * work on.
1341 static const struct submodule *get_non_gitmodules_submodule(const char *path)
1343 struct submodule *ret = NULL;
1344 const char *name = default_name_or_path(path);
1346 if (!name)
1347 return NULL;
1349 ret = xmalloc(sizeof(*ret));
1350 memset(ret, 0, sizeof(*ret));
1351 ret->path = name;
1352 ret->name = name;
1354 return (const struct submodule *) ret;
1357 static struct fetch_task *fetch_task_create(struct repository *r,
1358 const char *path)
1360 struct fetch_task *task = xmalloc(sizeof(*task));
1361 memset(task, 0, sizeof(*task));
1363 task->sub = submodule_from_path(r, &null_oid, path);
1364 if (!task->sub) {
1366 * No entry in .gitmodules? Technically not a submodule,
1367 * but historically we supported repositories that happen to be
1368 * in-place where a gitlink is. Keep supporting them.
1370 task->sub = get_non_gitmodules_submodule(path);
1371 if (!task->sub) {
1372 free(task);
1373 return NULL;
1376 task->free_sub = 1;
1379 return task;
1382 static void fetch_task_release(struct fetch_task *p)
1384 if (p->free_sub)
1385 free((void*)p->sub);
1386 p->free_sub = 0;
1387 p->sub = NULL;
1389 if (p->repo)
1390 repo_clear(p->repo);
1391 FREE_AND_NULL(p->repo);
1394 static struct repository *get_submodule_repo_for(struct repository *r,
1395 const struct submodule *sub)
1397 struct repository *ret = xmalloc(sizeof(*ret));
1399 if (repo_submodule_init(ret, r, sub)) {
1401 * No entry in .gitmodules? Technically not a submodule,
1402 * but historically we supported repositories that happen to be
1403 * in-place where a gitlink is. Keep supporting them.
1405 struct strbuf gitdir = STRBUF_INIT;
1406 strbuf_repo_worktree_path(&gitdir, r, "%s/.git", sub->path);
1407 if (repo_init(ret, gitdir.buf, NULL)) {
1408 strbuf_release(&gitdir);
1409 free(ret);
1410 return NULL;
1412 strbuf_release(&gitdir);
1415 return ret;
1418 static int get_next_submodule(struct child_process *cp,
1419 struct strbuf *err, void *data, void **task_cb)
1421 struct submodule_parallel_fetch *spf = data;
1423 for (; spf->count < spf->r->index->cache_nr; spf->count++) {
1424 const struct cache_entry *ce = spf->r->index->cache[spf->count];
1425 const char *default_argv;
1426 struct fetch_task *task;
1428 if (!S_ISGITLINK(ce->ce_mode))
1429 continue;
1431 task = fetch_task_create(spf->r, ce->name);
1432 if (!task)
1433 continue;
1435 switch (get_fetch_recurse_config(task->sub, spf))
1437 default:
1438 case RECURSE_SUBMODULES_DEFAULT:
1439 case RECURSE_SUBMODULES_ON_DEMAND:
1440 if (!task->sub ||
1441 !string_list_lookup(
1442 &spf->changed_submodule_names,
1443 task->sub->name))
1444 continue;
1445 default_argv = "on-demand";
1446 break;
1447 case RECURSE_SUBMODULES_ON:
1448 default_argv = "yes";
1449 break;
1450 case RECURSE_SUBMODULES_OFF:
1451 continue;
1454 task->repo = get_submodule_repo_for(spf->r, task->sub);
1455 if (task->repo) {
1456 struct strbuf submodule_prefix = STRBUF_INIT;
1457 child_process_init(cp);
1458 cp->dir = task->repo->gitdir;
1459 prepare_submodule_repo_env_in_gitdir(&cp->env_array);
1460 cp->git_cmd = 1;
1461 if (!spf->quiet)
1462 strbuf_addf(err, _("Fetching submodule %s%s\n"),
1463 spf->prefix, ce->name);
1464 strvec_init(&cp->args);
1465 strvec_pushv(&cp->args, spf->args.v);
1466 strvec_push(&cp->args, default_argv);
1467 strvec_push(&cp->args, "--submodule-prefix");
1469 strbuf_addf(&submodule_prefix, "%s%s/",
1470 spf->prefix,
1471 task->sub->path);
1472 strvec_push(&cp->args, submodule_prefix.buf);
1474 spf->count++;
1475 *task_cb = task;
1477 strbuf_release(&submodule_prefix);
1478 return 1;
1479 } else {
1480 struct strbuf empty_submodule_path = STRBUF_INIT;
1482 fetch_task_release(task);
1483 free(task);
1486 * An empty directory is normal,
1487 * the submodule is not initialized
1489 strbuf_addf(&empty_submodule_path, "%s/%s/",
1490 spf->r->worktree,
1491 ce->name);
1492 if (S_ISGITLINK(ce->ce_mode) &&
1493 !is_empty_dir(empty_submodule_path.buf)) {
1494 spf->result = 1;
1495 strbuf_addf(err,
1496 _("Could not access submodule '%s'\n"),
1497 ce->name);
1499 strbuf_release(&empty_submodule_path);
1503 if (spf->oid_fetch_tasks_nr) {
1504 struct fetch_task *task =
1505 spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr - 1];
1506 struct strbuf submodule_prefix = STRBUF_INIT;
1507 spf->oid_fetch_tasks_nr--;
1509 strbuf_addf(&submodule_prefix, "%s%s/",
1510 spf->prefix, task->sub->path);
1512 child_process_init(cp);
1513 prepare_submodule_repo_env_in_gitdir(&cp->env_array);
1514 cp->git_cmd = 1;
1515 cp->dir = task->repo->gitdir;
1517 strvec_init(&cp->args);
1518 strvec_pushv(&cp->args, spf->args.v);
1519 strvec_push(&cp->args, "on-demand");
1520 strvec_push(&cp->args, "--submodule-prefix");
1521 strvec_push(&cp->args, submodule_prefix.buf);
1523 /* NEEDSWORK: have get_default_remote from submodule--helper */
1524 strvec_push(&cp->args, "origin");
1525 oid_array_for_each_unique(task->commits,
1526 append_oid_to_argv, &cp->args);
1528 *task_cb = task;
1529 strbuf_release(&submodule_prefix);
1530 return 1;
1533 return 0;
1536 static int fetch_start_failure(struct strbuf *err,
1537 void *cb, void *task_cb)
1539 struct submodule_parallel_fetch *spf = cb;
1540 struct fetch_task *task = task_cb;
1542 spf->result = 1;
1544 fetch_task_release(task);
1545 return 0;
1548 static int commit_missing_in_sub(const struct object_id *oid, void *data)
1550 struct repository *subrepo = data;
1552 enum object_type type = oid_object_info(subrepo, oid, NULL);
1554 return type != OBJ_COMMIT;
1557 static int fetch_finish(int retvalue, struct strbuf *err,
1558 void *cb, void *task_cb)
1560 struct submodule_parallel_fetch *spf = cb;
1561 struct fetch_task *task = task_cb;
1563 struct string_list_item *it;
1564 struct oid_array *commits;
1566 if (!task || !task->sub)
1567 BUG("callback cookie bogus");
1569 if (retvalue) {
1571 * NEEDSWORK: This indicates that the overall fetch
1572 * failed, even though there may be a subsequent fetch
1573 * by commit hash that might work. It may be a good
1574 * idea to not indicate failure in this case, and only
1575 * indicate failure if the subsequent fetch fails.
1577 spf->result = 1;
1579 strbuf_addf(&spf->submodules_with_errors, "\t%s\n",
1580 task->sub->name);
1583 /* Is this the second time we process this submodule? */
1584 if (task->commits)
1585 goto out;
1587 it = string_list_lookup(&spf->changed_submodule_names, task->sub->name);
1588 if (!it)
1589 /* Could be an unchanged submodule, not contained in the list */
1590 goto out;
1592 commits = it->util;
1593 oid_array_filter(commits,
1594 commit_missing_in_sub,
1595 task->repo);
1597 /* Are there commits we want, but do not exist? */
1598 if (commits->nr) {
1599 task->commits = commits;
1600 ALLOC_GROW(spf->oid_fetch_tasks,
1601 spf->oid_fetch_tasks_nr + 1,
1602 spf->oid_fetch_tasks_alloc);
1603 spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr] = task;
1604 spf->oid_fetch_tasks_nr++;
1605 return 0;
1608 out:
1609 fetch_task_release(task);
1611 return 0;
1614 int fetch_populated_submodules(struct repository *r,
1615 const struct strvec *options,
1616 const char *prefix, int command_line_option,
1617 int default_option,
1618 int quiet, int max_parallel_jobs)
1620 int i;
1621 struct submodule_parallel_fetch spf = SPF_INIT;
1623 spf.r = r;
1624 spf.command_line_option = command_line_option;
1625 spf.default_option = default_option;
1626 spf.quiet = quiet;
1627 spf.prefix = prefix;
1629 if (!r->worktree)
1630 goto out;
1632 if (repo_read_index(r) < 0)
1633 die(_("index file corrupt"));
1635 strvec_push(&spf.args, "fetch");
1636 for (i = 0; i < options->nr; i++)
1637 strvec_push(&spf.args, options->v[i]);
1638 strvec_push(&spf.args, "--recurse-submodules-default");
1639 /* default value, "--submodule-prefix" and its value are added later */
1641 calculate_changed_submodule_paths(r, &spf.changed_submodule_names);
1642 string_list_sort(&spf.changed_submodule_names);
1643 run_processes_parallel_tr2(max_parallel_jobs,
1644 get_next_submodule,
1645 fetch_start_failure,
1646 fetch_finish,
1647 &spf,
1648 "submodule", "parallel/fetch");
1650 if (spf.submodules_with_errors.len > 0)
1651 fprintf(stderr, _("Errors during submodule fetch:\n%s"),
1652 spf.submodules_with_errors.buf);
1655 strvec_clear(&spf.args);
1656 out:
1657 free_submodules_oids(&spf.changed_submodule_names);
1658 return spf.result;
1661 unsigned is_submodule_modified(const char *path, int ignore_untracked)
1663 struct child_process cp = CHILD_PROCESS_INIT;
1664 struct strbuf buf = STRBUF_INIT;
1665 FILE *fp;
1666 unsigned dirty_submodule = 0;
1667 const char *git_dir;
1668 int ignore_cp_exit_code = 0;
1670 strbuf_addf(&buf, "%s/.git", path);
1671 git_dir = read_gitfile(buf.buf);
1672 if (!git_dir)
1673 git_dir = buf.buf;
1674 if (!is_git_directory(git_dir)) {
1675 if (is_directory(git_dir))
1676 die(_("'%s' not recognized as a git repository"), git_dir);
1677 strbuf_release(&buf);
1678 /* The submodule is not checked out, so it is not modified */
1679 return 0;
1681 strbuf_reset(&buf);
1683 strvec_pushl(&cp.args, "status", "--porcelain=2", NULL);
1684 if (ignore_untracked)
1685 strvec_push(&cp.args, "-uno");
1687 prepare_submodule_repo_env(&cp.env_array);
1688 cp.git_cmd = 1;
1689 cp.no_stdin = 1;
1690 cp.out = -1;
1691 cp.dir = path;
1692 if (start_command(&cp))
1693 die(_("Could not run 'git status --porcelain=2' in submodule %s"), path);
1695 fp = xfdopen(cp.out, "r");
1696 while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
1697 /* regular untracked files */
1698 if (buf.buf[0] == '?')
1699 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1701 if (buf.buf[0] == 'u' ||
1702 buf.buf[0] == '1' ||
1703 buf.buf[0] == '2') {
1704 /* T = line type, XY = status, SSSS = submodule state */
1705 if (buf.len < strlen("T XY SSSS"))
1706 BUG("invalid status --porcelain=2 line %s",
1707 buf.buf);
1709 if (buf.buf[5] == 'S' && buf.buf[8] == 'U')
1710 /* nested untracked file */
1711 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1713 if (buf.buf[0] == 'u' ||
1714 buf.buf[0] == '2' ||
1715 memcmp(buf.buf + 5, "S..U", 4))
1716 /* other change */
1717 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1720 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1721 ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
1722 ignore_untracked)) {
1724 * We're not interested in any further information from
1725 * the child any more, neither output nor its exit code.
1727 ignore_cp_exit_code = 1;
1728 break;
1731 fclose(fp);
1733 if (finish_command(&cp) && !ignore_cp_exit_code)
1734 die(_("'git status --porcelain=2' failed in submodule %s"), path);
1736 strbuf_release(&buf);
1737 return dirty_submodule;
1740 int submodule_uses_gitfile(const char *path)
1742 struct child_process cp = CHILD_PROCESS_INIT;
1743 struct strbuf buf = STRBUF_INIT;
1744 const char *git_dir;
1746 strbuf_addf(&buf, "%s/.git", path);
1747 git_dir = read_gitfile(buf.buf);
1748 if (!git_dir) {
1749 strbuf_release(&buf);
1750 return 0;
1752 strbuf_release(&buf);
1754 /* Now test that all nested submodules use a gitfile too */
1755 strvec_pushl(&cp.args,
1756 "submodule", "foreach", "--quiet", "--recursive",
1757 "test -f .git", NULL);
1759 prepare_submodule_repo_env(&cp.env_array);
1760 cp.git_cmd = 1;
1761 cp.no_stdin = 1;
1762 cp.no_stderr = 1;
1763 cp.no_stdout = 1;
1764 cp.dir = path;
1765 if (run_command(&cp))
1766 return 0;
1768 return 1;
1772 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1773 * when doing so.
1775 * Return 1 if we'd lose data, return 0 if the removal is fine,
1776 * and negative values for errors.
1778 int bad_to_remove_submodule(const char *path, unsigned flags)
1780 ssize_t len;
1781 struct child_process cp = CHILD_PROCESS_INIT;
1782 struct strbuf buf = STRBUF_INIT;
1783 int ret = 0;
1785 if (!file_exists(path) || is_empty_dir(path))
1786 return 0;
1788 if (!submodule_uses_gitfile(path))
1789 return 1;
1791 strvec_pushl(&cp.args, "status", "--porcelain",
1792 "--ignore-submodules=none", NULL);
1794 if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
1795 strvec_push(&cp.args, "-uno");
1796 else
1797 strvec_push(&cp.args, "-uall");
1799 if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
1800 strvec_push(&cp.args, "--ignored");
1802 prepare_submodule_repo_env(&cp.env_array);
1803 cp.git_cmd = 1;
1804 cp.no_stdin = 1;
1805 cp.out = -1;
1806 cp.dir = path;
1807 if (start_command(&cp)) {
1808 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1809 die(_("could not start 'git status' in submodule '%s'"),
1810 path);
1811 ret = -1;
1812 goto out;
1815 len = strbuf_read(&buf, cp.out, 1024);
1816 if (len > 2)
1817 ret = 1;
1818 close(cp.out);
1820 if (finish_command(&cp)) {
1821 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1822 die(_("could not run 'git status' in submodule '%s'"),
1823 path);
1824 ret = -1;
1826 out:
1827 strbuf_release(&buf);
1828 return ret;
1831 void submodule_unset_core_worktree(const struct submodule *sub)
1833 char *config_path = xstrfmt("%s/modules/%s/config",
1834 get_git_dir(), sub->name);
1836 if (git_config_set_in_file_gently(config_path, "core.worktree", NULL))
1837 warning(_("Could not unset core.worktree setting in submodule '%s'"),
1838 sub->path);
1840 free(config_path);
1843 static const char *get_super_prefix_or_empty(void)
1845 const char *s = get_super_prefix();
1846 if (!s)
1847 s = "";
1848 return s;
1851 static int submodule_has_dirty_index(const struct submodule *sub)
1853 struct child_process cp = CHILD_PROCESS_INIT;
1855 prepare_submodule_repo_env(&cp.env_array);
1857 cp.git_cmd = 1;
1858 strvec_pushl(&cp.args, "diff-index", "--quiet",
1859 "--cached", "HEAD", NULL);
1860 cp.no_stdin = 1;
1861 cp.no_stdout = 1;
1862 cp.dir = sub->path;
1863 if (start_command(&cp))
1864 die(_("could not recurse into submodule '%s'"), sub->path);
1866 return finish_command(&cp);
1869 static void submodule_reset_index(const char *path)
1871 struct child_process cp = CHILD_PROCESS_INIT;
1872 prepare_submodule_repo_env(&cp.env_array);
1874 cp.git_cmd = 1;
1875 cp.no_stdin = 1;
1876 cp.dir = path;
1878 strvec_pushf(&cp.args, "--super-prefix=%s%s/",
1879 get_super_prefix_or_empty(), path);
1880 strvec_pushl(&cp.args, "read-tree", "-u", "--reset", NULL);
1882 strvec_push(&cp.args, empty_tree_oid_hex());
1884 if (run_command(&cp))
1885 die(_("could not reset submodule index"));
1889 * Moves a submodule at a given path from a given head to another new head.
1890 * For edge cases (a submodule coming into existence or removing a submodule)
1891 * pass NULL for old or new respectively.
1893 int submodule_move_head(const char *path,
1894 const char *old_head,
1895 const char *new_head,
1896 unsigned flags)
1898 int ret = 0;
1899 struct child_process cp = CHILD_PROCESS_INIT;
1900 const struct submodule *sub;
1901 int *error_code_ptr, error_code;
1903 if (!is_submodule_active(the_repository, path))
1904 return 0;
1906 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1908 * Pass non NULL pointer to is_submodule_populated_gently
1909 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1910 * to fixup the submodule in the force case later.
1912 error_code_ptr = &error_code;
1913 else
1914 error_code_ptr = NULL;
1916 if (old_head && !is_submodule_populated_gently(path, error_code_ptr))
1917 return 0;
1919 sub = submodule_from_path(the_repository, &null_oid, path);
1921 if (!sub)
1922 BUG("could not get submodule information for '%s'", path);
1924 if (old_head && !(flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1925 /* Check if the submodule has a dirty index. */
1926 if (submodule_has_dirty_index(sub))
1927 return error(_("submodule '%s' has dirty index"), path);
1930 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1931 if (old_head) {
1932 if (!submodule_uses_gitfile(path))
1933 absorb_git_dir_into_superproject(path,
1934 ABSORB_GITDIR_RECURSE_SUBMODULES);
1935 } else {
1936 char *gitdir = xstrfmt("%s/modules/%s",
1937 get_git_dir(), sub->name);
1938 connect_work_tree_and_git_dir(path, gitdir, 0);
1939 free(gitdir);
1941 /* make sure the index is clean as well */
1942 submodule_reset_index(path);
1945 if (old_head && (flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1946 char *gitdir = xstrfmt("%s/modules/%s",
1947 get_git_dir(), sub->name);
1948 connect_work_tree_and_git_dir(path, gitdir, 1);
1949 free(gitdir);
1953 prepare_submodule_repo_env(&cp.env_array);
1955 cp.git_cmd = 1;
1956 cp.no_stdin = 1;
1957 cp.dir = path;
1959 strvec_pushf(&cp.args, "--super-prefix=%s%s/",
1960 get_super_prefix_or_empty(), path);
1961 strvec_pushl(&cp.args, "read-tree", "--recurse-submodules", NULL);
1963 if (flags & SUBMODULE_MOVE_HEAD_DRY_RUN)
1964 strvec_push(&cp.args, "-n");
1965 else
1966 strvec_push(&cp.args, "-u");
1968 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1969 strvec_push(&cp.args, "--reset");
1970 else
1971 strvec_push(&cp.args, "-m");
1973 if (!(flags & SUBMODULE_MOVE_HEAD_FORCE))
1974 strvec_push(&cp.args, old_head ? old_head : empty_tree_oid_hex());
1976 strvec_push(&cp.args, new_head ? new_head : empty_tree_oid_hex());
1978 if (run_command(&cp)) {
1979 ret = error(_("Submodule '%s' could not be updated."), path);
1980 goto out;
1983 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1984 if (new_head) {
1985 child_process_init(&cp);
1986 /* also set the HEAD accordingly */
1987 cp.git_cmd = 1;
1988 cp.no_stdin = 1;
1989 cp.dir = path;
1991 prepare_submodule_repo_env(&cp.env_array);
1992 strvec_pushl(&cp.args, "update-ref", "HEAD",
1993 "--no-deref", new_head, NULL);
1995 if (run_command(&cp)) {
1996 ret = -1;
1997 goto out;
1999 } else {
2000 struct strbuf sb = STRBUF_INIT;
2002 strbuf_addf(&sb, "%s/.git", path);
2003 unlink_or_warn(sb.buf);
2004 strbuf_release(&sb);
2006 if (is_empty_dir(path))
2007 rmdir_or_warn(path);
2009 submodule_unset_core_worktree(sub);
2012 out:
2013 return ret;
2016 int validate_submodule_git_dir(char *git_dir, const char *submodule_name)
2018 size_t len = strlen(git_dir), suffix_len = strlen(submodule_name);
2019 char *p;
2020 int ret = 0;
2022 if (len <= suffix_len || (p = git_dir + len - suffix_len)[-1] != '/' ||
2023 strcmp(p, submodule_name))
2024 BUG("submodule name '%s' not a suffix of git dir '%s'",
2025 submodule_name, git_dir);
2028 * We prevent the contents of sibling submodules' git directories to
2029 * clash.
2031 * Example: having a submodule named `hippo` and another one named
2032 * `hippo/hooks` would result in the git directories
2033 * `.git/modules/hippo/` and `.git/modules/hippo/hooks/`, respectively,
2034 * but the latter directory is already designated to contain the hooks
2035 * of the former.
2037 for (; *p; p++) {
2038 if (is_dir_sep(*p)) {
2039 char c = *p;
2041 *p = '\0';
2042 if (is_git_directory(git_dir))
2043 ret = -1;
2044 *p = c;
2046 if (ret < 0)
2047 return error(_("submodule git dir '%s' is "
2048 "inside git dir '%.*s'"),
2049 git_dir,
2050 (int)(p - git_dir), git_dir);
2054 return 0;
2058 * Embeds a single submodules git directory into the superprojects git dir,
2059 * non recursively.
2061 static void relocate_single_git_dir_into_superproject(const char *path)
2063 char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
2064 char *new_git_dir;
2065 const struct submodule *sub;
2067 if (submodule_uses_worktrees(path))
2068 die(_("relocate_gitdir for submodule '%s' with "
2069 "more than one worktree not supported"), path);
2071 old_git_dir = xstrfmt("%s/.git", path);
2072 if (read_gitfile(old_git_dir))
2073 /* If it is an actual gitfile, it doesn't need migration. */
2074 return;
2076 real_old_git_dir = real_pathdup(old_git_dir, 1);
2078 sub = submodule_from_path(the_repository, &null_oid, path);
2079 if (!sub)
2080 die(_("could not lookup name for submodule '%s'"), path);
2082 new_git_dir = git_pathdup("modules/%s", sub->name);
2083 if (validate_submodule_git_dir(new_git_dir, sub->name) < 0)
2084 die(_("refusing to move '%s' into an existing git dir"),
2085 real_old_git_dir);
2086 if (safe_create_leading_directories_const(new_git_dir) < 0)
2087 die(_("could not create directory '%s'"), new_git_dir);
2088 real_new_git_dir = real_pathdup(new_git_dir, 1);
2089 free(new_git_dir);
2091 fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
2092 get_super_prefix_or_empty(), path,
2093 real_old_git_dir, real_new_git_dir);
2095 relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
2097 free(old_git_dir);
2098 free(real_old_git_dir);
2099 free(real_new_git_dir);
2103 * Migrate the git directory of the submodule given by path from
2104 * having its git directory within the working tree to the git dir nested
2105 * in its superprojects git dir under modules/.
2107 void absorb_git_dir_into_superproject(const char *path,
2108 unsigned flags)
2110 int err_code;
2111 const char *sub_git_dir;
2112 struct strbuf gitdir = STRBUF_INIT;
2113 strbuf_addf(&gitdir, "%s/.git", path);
2114 sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
2116 /* Not populated? */
2117 if (!sub_git_dir) {
2118 const struct submodule *sub;
2120 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
2121 /* unpopulated as expected */
2122 strbuf_release(&gitdir);
2123 return;
2126 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
2127 /* We don't know what broke here. */
2128 read_gitfile_error_die(err_code, path, NULL);
2131 * Maybe populated, but no git directory was found?
2132 * This can happen if the superproject is a submodule
2133 * itself and was just absorbed. The absorption of the
2134 * superproject did not rewrite the git file links yet,
2135 * fix it now.
2137 sub = submodule_from_path(the_repository, &null_oid, path);
2138 if (!sub)
2139 die(_("could not lookup name for submodule '%s'"), path);
2140 connect_work_tree_and_git_dir(path,
2141 git_path("modules/%s", sub->name), 0);
2142 } else {
2143 /* Is it already absorbed into the superprojects git dir? */
2144 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
2145 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
2147 if (!starts_with(real_sub_git_dir, real_common_git_dir))
2148 relocate_single_git_dir_into_superproject(path);
2150 free(real_sub_git_dir);
2151 free(real_common_git_dir);
2153 strbuf_release(&gitdir);
2155 if (flags & ABSORB_GITDIR_RECURSE_SUBMODULES) {
2156 struct child_process cp = CHILD_PROCESS_INIT;
2157 struct strbuf sb = STRBUF_INIT;
2159 if (flags & ~ABSORB_GITDIR_RECURSE_SUBMODULES)
2160 BUG("we don't know how to pass the flags down?");
2162 strbuf_addstr(&sb, get_super_prefix_or_empty());
2163 strbuf_addstr(&sb, path);
2164 strbuf_addch(&sb, '/');
2166 cp.dir = path;
2167 cp.git_cmd = 1;
2168 cp.no_stdin = 1;
2169 strvec_pushl(&cp.args, "--super-prefix", sb.buf,
2170 "submodule--helper",
2171 "absorb-git-dirs", NULL);
2172 prepare_submodule_repo_env(&cp.env_array);
2173 if (run_command(&cp))
2174 die(_("could not recurse into submodule '%s'"), path);
2176 strbuf_release(&sb);
2180 int get_superproject_working_tree(struct strbuf *buf)
2182 struct child_process cp = CHILD_PROCESS_INIT;
2183 struct strbuf sb = STRBUF_INIT;
2184 struct strbuf one_up = STRBUF_INIT;
2185 const char *cwd = xgetcwd();
2186 int ret = 0;
2187 const char *subpath;
2188 int code;
2189 ssize_t len;
2191 if (!is_inside_work_tree())
2193 * FIXME:
2194 * We might have a superproject, but it is harder
2195 * to determine.
2197 return 0;
2199 if (!strbuf_realpath(&one_up, "../", 0))
2200 return 0;
2202 subpath = relative_path(cwd, one_up.buf, &sb);
2203 strbuf_release(&one_up);
2205 prepare_submodule_repo_env(&cp.env_array);
2206 strvec_pop(&cp.env_array);
2208 strvec_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
2209 "ls-files", "-z", "--stage", "--full-name", "--",
2210 subpath, NULL);
2211 strbuf_reset(&sb);
2213 cp.no_stdin = 1;
2214 cp.no_stderr = 1;
2215 cp.out = -1;
2216 cp.git_cmd = 1;
2218 if (start_command(&cp))
2219 die(_("could not start ls-files in .."));
2221 len = strbuf_read(&sb, cp.out, PATH_MAX);
2222 close(cp.out);
2224 if (starts_with(sb.buf, "160000")) {
2225 int super_sub_len;
2226 int cwd_len = strlen(cwd);
2227 char *super_sub, *super_wt;
2230 * There is a superproject having this repo as a submodule.
2231 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
2232 * We're only interested in the name after the tab.
2234 super_sub = strchr(sb.buf, '\t') + 1;
2235 super_sub_len = strlen(super_sub);
2237 if (super_sub_len > cwd_len ||
2238 strcmp(&cwd[cwd_len - super_sub_len], super_sub))
2239 BUG("returned path string doesn't match cwd?");
2241 super_wt = xstrdup(cwd);
2242 super_wt[cwd_len - super_sub_len] = '\0';
2244 strbuf_realpath(buf, super_wt, 1);
2245 ret = 1;
2246 free(super_wt);
2248 strbuf_release(&sb);
2250 code = finish_command(&cp);
2252 if (code == 128)
2253 /* '../' is not a git repository */
2254 return 0;
2255 if (code == 0 && len == 0)
2256 /* There is an unrelated git repository at '../' */
2257 return 0;
2258 if (code)
2259 die(_("ls-tree returned unexpected return code %d"), code);
2261 return ret;
2265 * Put the gitdir for a submodule (given relative to the main
2266 * repository worktree) into `buf`, or return -1 on error.
2268 int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
2270 const struct submodule *sub;
2271 const char *git_dir;
2272 int ret = 0;
2274 strbuf_reset(buf);
2275 strbuf_addstr(buf, submodule);
2276 strbuf_complete(buf, '/');
2277 strbuf_addstr(buf, ".git");
2279 git_dir = read_gitfile(buf->buf);
2280 if (git_dir) {
2281 strbuf_reset(buf);
2282 strbuf_addstr(buf, git_dir);
2284 if (!is_git_directory(buf->buf)) {
2285 sub = submodule_from_path(the_repository, &null_oid, submodule);
2286 if (!sub) {
2287 ret = -1;
2288 goto cleanup;
2290 strbuf_reset(buf);
2291 strbuf_git_path(buf, "%s/%s", "modules", sub->name);
2294 cleanup:
2295 return ret;