git maintenance: avoid console window in scheduled tasks on Windows
[git.git] / submodule.c
blob2e78f5134964ffc60d94ee5d3a793a3624e214ba
1 #include "cache.h"
2 #include "abspath.h"
3 #include "alloc.h"
4 #include "repository.h"
5 #include "config.h"
6 #include "submodule-config.h"
7 #include "submodule.h"
8 #include "dir.h"
9 #include "diff.h"
10 #include "commit.h"
11 #include "environment.h"
12 #include "gettext.h"
13 #include "hex.h"
14 #include "revision.h"
15 #include "run-command.h"
16 #include "diffcore.h"
17 #include "refs.h"
18 #include "string-list.h"
19 #include "oid-array.h"
20 #include "strvec.h"
21 #include "blob.h"
22 #include "thread-utils.h"
23 #include "quote.h"
24 #include "remote.h"
25 #include "worktree.h"
26 #include "parse-options.h"
27 #include "object-file.h"
28 #include "object-name.h"
29 #include "object-store.h"
30 #include "commit-reach.h"
31 #include "setup.h"
32 #include "shallow.h"
33 #include "trace2.h"
35 static int config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
36 static int initialized_fetch_ref_tips;
37 static struct oid_array ref_tips_before_fetch;
38 static struct oid_array ref_tips_after_fetch;
41 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
42 * will be disabled because we can't guess what might be configured in
43 * .gitmodules unless the user resolves the conflict.
45 int is_gitmodules_unmerged(struct index_state *istate)
47 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
48 if (pos < 0) { /* .gitmodules not found or isn't merged */
49 pos = -1 - pos;
50 if (istate->cache_nr > pos) { /* there is a .gitmodules */
51 const struct cache_entry *ce = istate->cache[pos];
52 if (ce_namelen(ce) == strlen(GITMODULES_FILE) &&
53 !strcmp(ce->name, GITMODULES_FILE))
54 return 1;
58 return 0;
62 * Check if the .gitmodules file is safe to write.
64 * Writing to the .gitmodules file requires that the file exists in the
65 * working tree or, if it doesn't, that a brand new .gitmodules file is going
66 * to be created (i.e. it's neither in the index nor in the current branch).
68 * It is not safe to write to .gitmodules if it's not in the working tree but
69 * it is in the index or in the current branch, because writing new values
70 * (and staging them) would blindly overwrite ALL the old content.
72 int is_writing_gitmodules_ok(void)
74 struct object_id oid;
75 return file_exists(GITMODULES_FILE) ||
76 (repo_get_oid(the_repository, GITMODULES_INDEX, &oid) < 0 && repo_get_oid(the_repository, GITMODULES_HEAD, &oid) < 0);
80 * Check if the .gitmodules file has unstaged modifications. This must be
81 * checked before allowing modifications to the .gitmodules file with the
82 * intention to stage them later, because when continuing we would stage the
83 * modifications the user didn't stage herself too. That might change in a
84 * future version when we learn to stage the changes we do ourselves without
85 * staging any previous modifications.
87 int is_staging_gitmodules_ok(struct index_state *istate)
89 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
91 if ((pos >= 0) && (pos < istate->cache_nr)) {
92 struct stat st;
93 if (lstat(GITMODULES_FILE, &st) == 0 &&
94 ie_modified(istate, istate->cache[pos], &st, 0) & DATA_CHANGED)
95 return 0;
98 return 1;
101 static int for_each_remote_ref_submodule(const char *submodule,
102 each_ref_fn fn, void *cb_data)
104 return refs_for_each_remote_ref(get_submodule_ref_store(submodule),
105 fn, cb_data);
109 * Try to update the "path" entry in the "submodule.<name>" section of the
110 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
111 * with the correct path=<oldpath> setting was found and we could update it.
113 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
115 struct strbuf entry = STRBUF_INIT;
116 const struct submodule *submodule;
117 int ret;
119 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
120 return -1;
122 if (is_gitmodules_unmerged(the_repository->index))
123 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
125 submodule = submodule_from_path(the_repository, null_oid(), oldpath);
126 if (!submodule || !submodule->name) {
127 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
128 return -1;
130 strbuf_addstr(&entry, "submodule.");
131 strbuf_addstr(&entry, submodule->name);
132 strbuf_addstr(&entry, ".path");
133 ret = config_set_in_gitmodules_file_gently(entry.buf, newpath);
134 strbuf_release(&entry);
135 return ret;
139 * Try to remove the "submodule.<name>" section from .gitmodules where the given
140 * path is configured. Return 0 only if a .gitmodules file was found, a section
141 * with the correct path=<path> setting was found and we could remove it.
143 int remove_path_from_gitmodules(const char *path)
145 struct strbuf sect = STRBUF_INIT;
146 const struct submodule *submodule;
148 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
149 return -1;
151 if (is_gitmodules_unmerged(the_repository->index))
152 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
154 submodule = submodule_from_path(the_repository, null_oid(), path);
155 if (!submodule || !submodule->name) {
156 warning(_("Could not find section in .gitmodules where path=%s"), path);
157 return -1;
159 strbuf_addstr(&sect, "submodule.");
160 strbuf_addstr(&sect, submodule->name);
161 if (git_config_rename_section_in_file(GITMODULES_FILE, sect.buf, NULL) < 0) {
162 /* Maybe the user already did that, don't error out here */
163 warning(_("Could not remove .gitmodules entry for %s"), path);
164 strbuf_release(&sect);
165 return -1;
167 strbuf_release(&sect);
168 return 0;
171 void stage_updated_gitmodules(struct index_state *istate)
173 if (add_file_to_index(istate, GITMODULES_FILE, 0))
174 die(_("staging updated .gitmodules failed"));
177 static struct string_list added_submodule_odb_paths = STRING_LIST_INIT_NODUP;
179 void add_submodule_odb_by_path(const char *path)
181 string_list_insert(&added_submodule_odb_paths, xstrdup(path));
184 int register_all_submodule_odb_as_alternates(void)
186 int i;
187 int ret = added_submodule_odb_paths.nr;
189 for (i = 0; i < added_submodule_odb_paths.nr; i++)
190 add_to_alternates_memory(added_submodule_odb_paths.items[i].string);
191 if (ret) {
192 string_list_clear(&added_submodule_odb_paths, 0);
193 trace2_data_intmax("submodule", the_repository,
194 "register_all_submodule_odb_as_alternates/registered", ret);
195 if (git_env_bool("GIT_TEST_FATAL_REGISTER_SUBMODULE_ODB", 0))
196 BUG("register_all_submodule_odb_as_alternates() called");
198 return ret;
201 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
202 const char *path)
204 const struct submodule *submodule = submodule_from_path(the_repository,
205 null_oid(),
206 path);
207 if (submodule) {
208 const char *ignore;
209 char *key;
211 key = xstrfmt("submodule.%s.ignore", submodule->name);
212 if (repo_config_get_string_tmp(the_repository, key, &ignore))
213 ignore = submodule->ignore;
214 free(key);
216 if (ignore)
217 handle_ignore_submodules_arg(diffopt, ignore);
218 else if (is_gitmodules_unmerged(the_repository->index))
219 diffopt->flags.ignore_submodules = 1;
223 /* Cheap function that only determines if we're interested in submodules at all */
224 int git_default_submodule_config(const char *var, const char *value,
225 void *cb UNUSED)
227 if (!strcmp(var, "submodule.recurse")) {
228 int v = git_config_bool(var, value) ?
229 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
230 config_update_recurse_submodules = v;
232 return 0;
235 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
236 const char *arg, int unset)
238 if (unset) {
239 config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
240 return 0;
242 if (arg)
243 config_update_recurse_submodules =
244 parse_update_recurse_submodules_arg(opt->long_name,
245 arg);
246 else
247 config_update_recurse_submodules = RECURSE_SUBMODULES_ON;
249 return 0;
253 * Determine if a submodule has been initialized at a given 'path'
256 * NEEDSWORK: Emit a warning if submodule.active exists, but is valueless,
257 * ie, the config looks like: "[submodule] active\n".
258 * Since that is an invalid pathspec, we should inform the user.
260 int is_tree_submodule_active(struct repository *repo,
261 const struct object_id *treeish_name,
262 const char *path)
264 int ret = 0;
265 char *key = NULL;
266 char *value = NULL;
267 const struct string_list *sl;
268 const struct submodule *module;
270 module = submodule_from_path(repo, treeish_name, path);
272 /* early return if there isn't a path->module mapping */
273 if (!module)
274 return 0;
276 /* submodule.<name>.active is set */
277 key = xstrfmt("submodule.%s.active", module->name);
278 if (!repo_config_get_bool(repo, key, &ret)) {
279 free(key);
280 return ret;
282 free(key);
284 /* submodule.active is set */
285 if (!repo_config_get_string_multi(repo, "submodule.active", &sl)) {
286 struct pathspec ps;
287 struct strvec args = STRVEC_INIT;
288 const struct string_list_item *item;
290 for_each_string_list_item(item, sl) {
291 strvec_push(&args, item->string);
294 parse_pathspec(&ps, 0, 0, NULL, args.v);
295 ret = match_pathspec(repo->index, &ps, path, strlen(path), 0, NULL, 1);
297 strvec_clear(&args);
298 clear_pathspec(&ps);
299 return ret;
302 /* fallback to checking if the URL is set */
303 key = xstrfmt("submodule.%s.url", module->name);
304 ret = !repo_config_get_string(repo, key, &value);
306 free(value);
307 free(key);
308 return ret;
311 int is_submodule_active(struct repository *repo, const char *path)
313 return is_tree_submodule_active(repo, null_oid(), path);
316 int is_submodule_populated_gently(const char *path, int *return_error_code)
318 int ret = 0;
319 char *gitdir = xstrfmt("%s/.git", path);
321 if (resolve_gitdir_gently(gitdir, return_error_code))
322 ret = 1;
324 free(gitdir);
325 return ret;
329 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
331 void die_in_unpopulated_submodule(struct index_state *istate,
332 const char *prefix)
334 int i, prefixlen;
336 if (!prefix)
337 return;
339 prefixlen = strlen(prefix);
341 for (i = 0; i < istate->cache_nr; i++) {
342 struct cache_entry *ce = istate->cache[i];
343 int ce_len = ce_namelen(ce);
345 if (!S_ISGITLINK(ce->ce_mode))
346 continue;
347 if (prefixlen <= ce_len)
348 continue;
349 if (strncmp(ce->name, prefix, ce_len))
350 continue;
351 if (prefix[ce_len] != '/')
352 continue;
354 die(_("in unpopulated submodule '%s'"), ce->name);
359 * Dies if any paths in the provided pathspec descends into a submodule
361 void die_path_inside_submodule(struct index_state *istate,
362 const struct pathspec *ps)
364 int i, j;
366 for (i = 0; i < istate->cache_nr; i++) {
367 struct cache_entry *ce = istate->cache[i];
368 int ce_len = ce_namelen(ce);
370 if (!S_ISGITLINK(ce->ce_mode))
371 continue;
373 for (j = 0; j < ps->nr ; j++) {
374 const struct pathspec_item *item = &ps->items[j];
376 if (item->len <= ce_len)
377 continue;
378 if (item->match[ce_len] != '/')
379 continue;
380 if (strncmp(ce->name, item->match, ce_len))
381 continue;
382 if (item->len == ce_len + 1)
383 continue;
385 die(_("Pathspec '%s' is in submodule '%.*s'"),
386 item->original, ce_len, ce->name);
391 enum submodule_update_type parse_submodule_update_type(const char *value)
393 if (!strcmp(value, "none"))
394 return SM_UPDATE_NONE;
395 else if (!strcmp(value, "checkout"))
396 return SM_UPDATE_CHECKOUT;
397 else if (!strcmp(value, "rebase"))
398 return SM_UPDATE_REBASE;
399 else if (!strcmp(value, "merge"))
400 return SM_UPDATE_MERGE;
401 else if (*value == '!')
402 return SM_UPDATE_COMMAND;
403 else
404 return SM_UPDATE_UNSPECIFIED;
407 int parse_submodule_update_strategy(const char *value,
408 struct submodule_update_strategy *dst)
410 enum submodule_update_type type;
412 free((void*)dst->command);
413 dst->command = NULL;
415 type = parse_submodule_update_type(value);
416 if (type == SM_UPDATE_UNSPECIFIED)
417 return -1;
419 dst->type = type;
420 if (type == SM_UPDATE_COMMAND)
421 dst->command = xstrdup(value + 1);
423 return 0;
426 const char *submodule_update_type_to_string(enum submodule_update_type type)
428 switch (type) {
429 case SM_UPDATE_CHECKOUT:
430 return "checkout";
431 case SM_UPDATE_MERGE:
432 return "merge";
433 case SM_UPDATE_REBASE:
434 return "rebase";
435 case SM_UPDATE_NONE:
436 return "none";
437 case SM_UPDATE_UNSPECIFIED:
438 case SM_UPDATE_COMMAND:
439 BUG("init_submodule() should handle type %d", type);
440 default:
441 BUG("unexpected update strategy type: %d", type);
445 void handle_ignore_submodules_arg(struct diff_options *diffopt,
446 const char *arg)
448 diffopt->flags.ignore_submodule_set = 1;
449 diffopt->flags.ignore_submodules = 0;
450 diffopt->flags.ignore_untracked_in_submodules = 0;
451 diffopt->flags.ignore_dirty_submodules = 0;
453 if (!strcmp(arg, "all"))
454 diffopt->flags.ignore_submodules = 1;
455 else if (!strcmp(arg, "untracked"))
456 diffopt->flags.ignore_untracked_in_submodules = 1;
457 else if (!strcmp(arg, "dirty"))
458 diffopt->flags.ignore_dirty_submodules = 1;
459 else if (strcmp(arg, "none"))
460 die(_("bad --ignore-submodules argument: %s"), arg);
462 * Please update _git_status() in git-completion.bash when you
463 * add new options
467 static int prepare_submodule_diff_summary(struct repository *r, struct rev_info *rev,
468 const char *path,
469 struct commit *left, struct commit *right,
470 struct commit_list *merge_bases)
472 struct commit_list *list;
474 repo_init_revisions(r, rev, NULL);
475 setup_revisions(0, NULL, rev, NULL);
476 rev->left_right = 1;
477 rev->first_parent_only = 1;
478 left->object.flags |= SYMMETRIC_LEFT;
479 add_pending_object(rev, &left->object, path);
480 add_pending_object(rev, &right->object, path);
481 for (list = merge_bases; list; list = list->next) {
482 list->item->object.flags |= UNINTERESTING;
483 add_pending_object(rev, &list->item->object,
484 oid_to_hex(&list->item->object.oid));
486 return prepare_revision_walk(rev);
489 static void print_submodule_diff_summary(struct repository *r, struct rev_info *rev, struct diff_options *o)
491 static const char format[] = " %m %s";
492 struct strbuf sb = STRBUF_INIT;
493 struct commit *commit;
495 while ((commit = get_revision(rev))) {
496 struct pretty_print_context ctx = {0};
497 ctx.date_mode = rev->date_mode;
498 ctx.output_encoding = get_log_output_encoding();
499 strbuf_setlen(&sb, 0);
500 repo_format_commit_message(r, commit, format, &sb,
501 &ctx);
502 strbuf_addch(&sb, '\n');
503 if (commit->object.flags & SYMMETRIC_LEFT)
504 diff_emit_submodule_del(o, sb.buf);
505 else
506 diff_emit_submodule_add(o, sb.buf);
508 strbuf_release(&sb);
511 void prepare_submodule_repo_env(struct strvec *out)
513 prepare_other_repo_env(out, DEFAULT_GIT_DIR_ENVIRONMENT);
516 static void prepare_submodule_repo_env_in_gitdir(struct strvec *out)
518 prepare_other_repo_env(out, ".");
522 * Initialize a repository struct for a submodule based on the provided 'path'.
524 * Returns the repository struct on success,
525 * NULL when the submodule is not present.
527 static struct repository *open_submodule(const char *path)
529 struct strbuf sb = STRBUF_INIT;
530 struct repository *out = xmalloc(sizeof(*out));
532 if (submodule_to_gitdir(&sb, path) || repo_init(out, sb.buf, NULL)) {
533 strbuf_release(&sb);
534 free(out);
535 return NULL;
538 /* Mark it as a submodule */
539 out->submodule_prefix = xstrdup(path);
541 strbuf_release(&sb);
542 return out;
546 * Helper function to display the submodule header line prior to the full
547 * summary output.
549 * If it can locate the submodule git directory it will create a repository
550 * handle for the submodule and lookup both the left and right commits and
551 * put them into the left and right pointers.
553 static void show_submodule_header(struct diff_options *o,
554 const char *path,
555 struct object_id *one, struct object_id *two,
556 unsigned dirty_submodule,
557 struct repository *sub,
558 struct commit **left, struct commit **right,
559 struct commit_list **merge_bases)
561 const char *message = NULL;
562 struct strbuf sb = STRBUF_INIT;
563 int fast_forward = 0, fast_backward = 0;
565 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
566 diff_emit_submodule_untracked(o, path);
568 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
569 diff_emit_submodule_modified(o, path);
571 if (is_null_oid(one))
572 message = "(new submodule)";
573 else if (is_null_oid(two))
574 message = "(submodule deleted)";
576 if (!sub) {
577 if (!message)
578 message = "(commits not present)";
579 goto output_header;
583 * Attempt to lookup the commit references, and determine if this is
584 * a fast forward or fast backwards update.
586 *left = lookup_commit_reference(sub, one);
587 *right = lookup_commit_reference(sub, two);
590 * Warn about missing commits in the submodule project, but only if
591 * they aren't null.
593 if ((!is_null_oid(one) && !*left) ||
594 (!is_null_oid(two) && !*right))
595 message = "(commits not present)";
597 *merge_bases = repo_get_merge_bases(sub, *left, *right);
598 if (*merge_bases) {
599 if ((*merge_bases)->item == *left)
600 fast_forward = 1;
601 else if ((*merge_bases)->item == *right)
602 fast_backward = 1;
605 if (oideq(one, two)) {
606 strbuf_release(&sb);
607 return;
610 output_header:
611 strbuf_addf(&sb, "Submodule %s ", path);
612 strbuf_add_unique_abbrev(&sb, one, DEFAULT_ABBREV);
613 strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
614 strbuf_add_unique_abbrev(&sb, two, DEFAULT_ABBREV);
615 if (message)
616 strbuf_addf(&sb, " %s\n", message);
617 else
618 strbuf_addf(&sb, "%s:\n", fast_backward ? " (rewind)" : "");
619 diff_emit_submodule_header(o, sb.buf);
621 strbuf_release(&sb);
624 void show_submodule_diff_summary(struct diff_options *o, const char *path,
625 struct object_id *one, struct object_id *two,
626 unsigned dirty_submodule)
628 struct rev_info rev = REV_INFO_INIT;
629 struct commit *left = NULL, *right = NULL;
630 struct commit_list *merge_bases = NULL;
631 struct repository *sub;
633 sub = open_submodule(path);
634 show_submodule_header(o, path, one, two, dirty_submodule,
635 sub, &left, &right, &merge_bases);
638 * If we don't have both a left and a right pointer, there is no
639 * reason to try and display a summary. The header line should contain
640 * all the information the user needs.
642 if (!left || !right || !sub)
643 goto out;
645 /* Treat revision walker failure the same as missing commits */
646 if (prepare_submodule_diff_summary(sub, &rev, path, left, right, merge_bases)) {
647 diff_emit_submodule_error(o, "(revision walker failed)\n");
648 goto out;
651 print_submodule_diff_summary(sub, &rev, o);
653 out:
654 free_commit_list(merge_bases);
655 release_revisions(&rev);
656 clear_commit_marks(left, ~0);
657 clear_commit_marks(right, ~0);
658 if (sub) {
659 repo_clear(sub);
660 free(sub);
664 void show_submodule_inline_diff(struct diff_options *o, const char *path,
665 struct object_id *one, struct object_id *two,
666 unsigned dirty_submodule)
668 const struct object_id *old_oid = the_hash_algo->empty_tree, *new_oid = the_hash_algo->empty_tree;
669 struct commit *left = NULL, *right = NULL;
670 struct commit_list *merge_bases = NULL;
671 struct child_process cp = CHILD_PROCESS_INIT;
672 struct strbuf sb = STRBUF_INIT;
673 struct repository *sub;
675 sub = open_submodule(path);
676 show_submodule_header(o, path, one, two, dirty_submodule,
677 sub, &left, &right, &merge_bases);
679 /* We need a valid left and right commit to display a difference */
680 if (!(left || is_null_oid(one)) ||
681 !(right || is_null_oid(two)))
682 goto done;
684 if (left)
685 old_oid = one;
686 if (right)
687 new_oid = two;
689 cp.git_cmd = 1;
690 cp.dir = path;
691 cp.out = -1;
692 cp.no_stdin = 1;
694 /* TODO: other options may need to be passed here. */
695 strvec_pushl(&cp.args, "diff", "--submodule=diff", NULL);
696 strvec_pushf(&cp.args, "--color=%s", want_color(o->use_color) ?
697 "always" : "never");
699 if (o->flags.reverse_diff) {
700 strvec_pushf(&cp.args, "--src-prefix=%s%s/",
701 o->b_prefix, path);
702 strvec_pushf(&cp.args, "--dst-prefix=%s%s/",
703 o->a_prefix, path);
704 } else {
705 strvec_pushf(&cp.args, "--src-prefix=%s%s/",
706 o->a_prefix, path);
707 strvec_pushf(&cp.args, "--dst-prefix=%s%s/",
708 o->b_prefix, path);
710 strvec_push(&cp.args, oid_to_hex(old_oid));
712 * If the submodule has modified content, we will diff against the
713 * work tree, under the assumption that the user has asked for the
714 * diff format and wishes to actually see all differences even if they
715 * haven't yet been committed to the submodule yet.
717 if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
718 strvec_push(&cp.args, oid_to_hex(new_oid));
720 prepare_submodule_repo_env(&cp.env);
722 if (!is_directory(path)) {
723 /* fall back to absorbed git dir, if any */
724 if (!sub)
725 goto done;
726 cp.dir = sub->gitdir;
727 strvec_push(&cp.env, GIT_DIR_ENVIRONMENT "=.");
728 strvec_push(&cp.env, GIT_WORK_TREE_ENVIRONMENT "=.");
731 if (start_command(&cp)) {
732 diff_emit_submodule_error(o, "(diff failed)\n");
733 goto done;
736 while (strbuf_getwholeline_fd(&sb, cp.out, '\n') != EOF)
737 diff_emit_submodule_pipethrough(o, sb.buf, sb.len);
739 if (finish_command(&cp))
740 diff_emit_submodule_error(o, "(diff failed)\n");
742 done:
743 strbuf_release(&sb);
744 free_commit_list(merge_bases);
745 if (left)
746 clear_commit_marks(left, ~0);
747 if (right)
748 clear_commit_marks(right, ~0);
749 if (sub) {
750 repo_clear(sub);
751 free(sub);
755 int should_update_submodules(void)
757 return config_update_recurse_submodules == RECURSE_SUBMODULES_ON;
760 const struct submodule *submodule_from_ce(const struct cache_entry *ce)
762 if (!S_ISGITLINK(ce->ce_mode))
763 return NULL;
765 if (!should_update_submodules())
766 return NULL;
768 return submodule_from_path(the_repository, null_oid(), ce->name);
772 struct collect_changed_submodules_cb_data {
773 struct repository *repo;
774 struct string_list *changed;
775 const struct object_id *commit_oid;
779 * this would normally be two functions: default_name_from_path() and
780 * path_from_default_name(). Since the default name is the same as
781 * the submodule path we can get away with just one function which only
782 * checks whether there is a submodule in the working directory at that
783 * location.
785 static const char *default_name_or_path(const char *path_or_name)
787 int error_code;
789 if (!is_submodule_populated_gently(path_or_name, &error_code))
790 return NULL;
792 return path_or_name;
796 * Holds relevant information for a changed submodule. Used as the .util
797 * member of the changed submodule name string_list_item.
799 * (super_oid, path) allows the submodule config to be read from _some_
800 * .gitmodules file. We store this information the first time we find a
801 * superproject commit that points to the submodule, but this is
802 * arbitrary - we can choose any (super_oid, path) that matches the
803 * submodule's name.
805 * NEEDSWORK: Storing an arbitrary commit is undesirable because we can't
806 * guarantee that we're reading the commit that the user would expect. A better
807 * scheme would be to just fetch a submodule by its name. This requires two
808 * steps:
809 * - Create a function that behaves like repo_submodule_init(), but accepts a
810 * submodule name instead of treeish_name and path. This should be easy
811 * because repo_submodule_init() internally uses the submodule's name.
813 * - Replace most instances of 'struct submodule' (which is the .gitmodules
814 * config) with just the submodule name. This is OK because we expect
815 * submodule settings to be stored in .git/config (via "git submodule init"),
816 * not .gitmodules. This also lets us delete get_non_gitmodules_submodule(),
817 * which constructs a bogus 'struct submodule' for the sake of giving a
818 * placeholder name to a gitlink.
820 struct changed_submodule_data {
822 * The first superproject commit in the rev walk that points to
823 * the submodule.
825 const struct object_id *super_oid;
827 * Path to the submodule in the superproject commit referenced
828 * by 'super_oid'.
830 char *path;
831 /* The submodule commits that have changed in the rev walk. */
832 struct oid_array new_commits;
835 static void changed_submodule_data_clear(struct changed_submodule_data *cs_data)
837 oid_array_clear(&cs_data->new_commits);
838 free(cs_data->path);
841 static void collect_changed_submodules_cb(struct diff_queue_struct *q,
842 struct diff_options *options UNUSED,
843 void *data)
845 struct collect_changed_submodules_cb_data *me = data;
846 struct string_list *changed = me->changed;
847 const struct object_id *commit_oid = me->commit_oid;
848 int i;
850 for (i = 0; i < q->nr; i++) {
851 struct diff_filepair *p = q->queue[i];
852 const struct submodule *submodule;
853 const char *name;
854 struct string_list_item *item;
855 struct changed_submodule_data *cs_data;
857 if (!S_ISGITLINK(p->two->mode))
858 continue;
860 submodule = submodule_from_path(me->repo,
861 commit_oid, p->two->path);
862 if (submodule)
863 name = submodule->name;
864 else {
865 name = default_name_or_path(p->two->path);
866 /* make sure name does not collide with existing one */
867 if (name)
868 submodule = submodule_from_name(me->repo,
869 commit_oid, name);
870 if (submodule) {
871 warning(_("Submodule in commit %s at path: "
872 "'%s' collides with a submodule named "
873 "the same. Skipping it."),
874 oid_to_hex(commit_oid), p->two->path);
875 name = NULL;
879 if (!name)
880 continue;
882 item = string_list_insert(changed, name);
883 if (item->util)
884 cs_data = item->util;
885 else {
886 item->util = xcalloc(1, sizeof(struct changed_submodule_data));
887 cs_data = item->util;
888 cs_data->super_oid = commit_oid;
889 cs_data->path = xstrdup(p->two->path);
891 oid_array_append(&cs_data->new_commits, &p->two->oid);
896 * Collect the paths of submodules in 'changed' which have changed based on
897 * the revisions as specified in 'argv'. Each entry in 'changed' will also
898 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
899 * what the submodule pointers were updated to during the change.
901 static void collect_changed_submodules(struct repository *r,
902 struct string_list *changed,
903 struct strvec *argv)
905 struct rev_info rev;
906 const struct commit *commit;
907 int save_warning;
908 struct setup_revision_opt s_r_opt = {
909 .assume_dashdash = 1,
912 save_warning = warn_on_object_refname_ambiguity;
913 warn_on_object_refname_ambiguity = 0;
914 repo_init_revisions(r, &rev, NULL);
915 setup_revisions(argv->nr, argv->v, &rev, &s_r_opt);
916 warn_on_object_refname_ambiguity = save_warning;
917 if (prepare_revision_walk(&rev))
918 die(_("revision walk setup failed"));
920 while ((commit = get_revision(&rev))) {
921 struct rev_info diff_rev;
922 struct collect_changed_submodules_cb_data data;
923 data.repo = r;
924 data.changed = changed;
925 data.commit_oid = &commit->object.oid;
927 repo_init_revisions(r, &diff_rev, NULL);
928 diff_rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
929 diff_rev.diffopt.format_callback = collect_changed_submodules_cb;
930 diff_rev.diffopt.format_callback_data = &data;
931 diff_rev.dense_combined_merges = 1;
932 diff_tree_combined_merge(commit, &diff_rev);
933 release_revisions(&diff_rev);
936 reset_revision_walk();
937 release_revisions(&rev);
940 static void free_submodules_data(struct string_list *submodules)
942 struct string_list_item *item;
943 for_each_string_list_item(item, submodules)
944 changed_submodule_data_clear(item->util);
946 string_list_clear(submodules, 1);
949 static int has_remote(const char *refname UNUSED,
950 const struct object_id *oid UNUSED,
951 int flags UNUSED, void *cb_data UNUSED)
953 return 1;
956 static int append_oid_to_argv(const struct object_id *oid, void *data)
958 struct strvec *argv = data;
959 strvec_push(argv, oid_to_hex(oid));
960 return 0;
963 struct has_commit_data {
964 struct repository *repo;
965 int result;
966 const char *path;
967 const struct object_id *super_oid;
970 static int check_has_commit(const struct object_id *oid, void *data)
972 struct has_commit_data *cb = data;
973 struct repository subrepo;
974 enum object_type type;
976 if (repo_submodule_init(&subrepo, cb->repo, cb->path, cb->super_oid)) {
977 cb->result = 0;
978 /* subrepo failed to init, so don't clean it up. */
979 return 0;
982 type = oid_object_info(&subrepo, oid, NULL);
984 switch (type) {
985 case OBJ_COMMIT:
986 goto cleanup;
987 case OBJ_BAD:
989 * Object is missing or invalid. If invalid, an error message
990 * has already been printed.
992 cb->result = 0;
993 goto cleanup;
994 default:
995 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
996 cb->path, oid_to_hex(oid), type_name(type));
998 cleanup:
999 repo_clear(&subrepo);
1000 return 0;
1003 static int submodule_has_commits(struct repository *r,
1004 const char *path,
1005 const struct object_id *super_oid,
1006 struct oid_array *commits)
1008 struct has_commit_data has_commit = {
1009 .repo = r,
1010 .result = 1,
1011 .path = path,
1012 .super_oid = super_oid
1015 oid_array_for_each_unique(commits, check_has_commit, &has_commit);
1017 if (has_commit.result) {
1019 * Even if the submodule is checked out and the commit is
1020 * present, make sure it exists in the submodule's object store
1021 * and that it is reachable from a ref.
1023 struct child_process cp = CHILD_PROCESS_INIT;
1024 struct strbuf out = STRBUF_INIT;
1026 strvec_pushl(&cp.args, "rev-list", "-n", "1", NULL);
1027 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
1028 strvec_pushl(&cp.args, "--not", "--all", NULL);
1030 prepare_submodule_repo_env(&cp.env);
1031 cp.git_cmd = 1;
1032 cp.no_stdin = 1;
1033 cp.dir = path;
1035 if (capture_command(&cp, &out, GIT_MAX_HEXSZ + 1) || out.len)
1036 has_commit.result = 0;
1038 strbuf_release(&out);
1041 return has_commit.result;
1044 static int submodule_needs_pushing(struct repository *r,
1045 const char *path,
1046 struct oid_array *commits)
1048 if (!submodule_has_commits(r, path, null_oid(), commits))
1050 * NOTE: We do consider it safe to return "no" here. The
1051 * correct answer would be "We do not know" instead of
1052 * "No push needed", but it is quite hard to change
1053 * the submodule pointer without having the submodule
1054 * around. If a user did however change the submodules
1055 * without having the submodule around, this indicates
1056 * an expert who knows what they are doing or a
1057 * maintainer integrating work from other people. In
1058 * both cases it should be safe to skip this check.
1060 return 0;
1062 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
1063 struct child_process cp = CHILD_PROCESS_INIT;
1064 struct strbuf buf = STRBUF_INIT;
1065 int needs_pushing = 0;
1067 strvec_push(&cp.args, "rev-list");
1068 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
1069 strvec_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
1071 prepare_submodule_repo_env(&cp.env);
1072 cp.git_cmd = 1;
1073 cp.no_stdin = 1;
1074 cp.out = -1;
1075 cp.dir = path;
1076 if (start_command(&cp))
1077 die(_("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s"),
1078 path);
1079 if (strbuf_read(&buf, cp.out, the_hash_algo->hexsz + 1))
1080 needs_pushing = 1;
1081 finish_command(&cp);
1082 close(cp.out);
1083 strbuf_release(&buf);
1084 return needs_pushing;
1087 return 0;
1090 int find_unpushed_submodules(struct repository *r,
1091 struct oid_array *commits,
1092 const char *remotes_name,
1093 struct string_list *needs_pushing)
1095 struct string_list submodules = STRING_LIST_INIT_DUP;
1096 struct string_list_item *name;
1097 struct strvec argv = STRVEC_INIT;
1099 /* argv.v[0] will be ignored by setup_revisions */
1100 strvec_push(&argv, "find_unpushed_submodules");
1101 oid_array_for_each_unique(commits, append_oid_to_argv, &argv);
1102 strvec_push(&argv, "--not");
1103 strvec_pushf(&argv, "--remotes=%s", remotes_name);
1105 collect_changed_submodules(r, &submodules, &argv);
1107 for_each_string_list_item(name, &submodules) {
1108 struct changed_submodule_data *cs_data = name->util;
1109 const struct submodule *submodule;
1110 const char *path = NULL;
1112 submodule = submodule_from_name(r, null_oid(), name->string);
1113 if (submodule)
1114 path = submodule->path;
1115 else
1116 path = default_name_or_path(name->string);
1118 if (!path)
1119 continue;
1121 if (submodule_needs_pushing(r, path, &cs_data->new_commits))
1122 string_list_insert(needs_pushing, path);
1125 free_submodules_data(&submodules);
1126 strvec_clear(&argv);
1128 return needs_pushing->nr;
1131 static int push_submodule(const char *path,
1132 const struct remote *remote,
1133 const struct refspec *rs,
1134 const struct string_list *push_options,
1135 int dry_run)
1137 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
1138 struct child_process cp = CHILD_PROCESS_INIT;
1139 strvec_push(&cp.args, "push");
1141 * When recursing into a submodule, treat any "only" configurations as "on-
1142 * demand", since "only" would not work (we need all submodules to be pushed
1143 * in order to be able to push the superproject).
1145 strvec_push(&cp.args, "--recurse-submodules=only-is-on-demand");
1146 if (dry_run)
1147 strvec_push(&cp.args, "--dry-run");
1149 if (push_options && push_options->nr) {
1150 const struct string_list_item *item;
1151 for_each_string_list_item(item, push_options)
1152 strvec_pushf(&cp.args, "--push-option=%s",
1153 item->string);
1156 if (remote->origin != REMOTE_UNCONFIGURED) {
1157 int i;
1158 strvec_push(&cp.args, remote->name);
1159 for (i = 0; i < rs->raw_nr; i++)
1160 strvec_push(&cp.args, rs->raw[i]);
1163 prepare_submodule_repo_env(&cp.env);
1164 cp.git_cmd = 1;
1165 cp.no_stdin = 1;
1166 cp.dir = path;
1167 if (run_command(&cp))
1168 return 0;
1169 close(cp.out);
1172 return 1;
1176 * Perform a check in the submodule to see if the remote and refspec work.
1177 * Die if the submodule can't be pushed.
1179 static void submodule_push_check(const char *path, const char *head,
1180 const struct remote *remote,
1181 const struct refspec *rs)
1183 struct child_process cp = CHILD_PROCESS_INIT;
1184 int i;
1186 strvec_push(&cp.args, "submodule--helper");
1187 strvec_push(&cp.args, "push-check");
1188 strvec_push(&cp.args, head);
1189 strvec_push(&cp.args, remote->name);
1191 for (i = 0; i < rs->raw_nr; i++)
1192 strvec_push(&cp.args, rs->raw[i]);
1194 prepare_submodule_repo_env(&cp.env);
1195 cp.git_cmd = 1;
1196 cp.no_stdin = 1;
1197 cp.no_stdout = 1;
1198 cp.dir = path;
1201 * Simply indicate if 'submodule--helper push-check' failed.
1202 * More detailed error information will be provided by the
1203 * child process.
1205 if (run_command(&cp))
1206 die(_("process for submodule '%s' failed"), path);
1209 int push_unpushed_submodules(struct repository *r,
1210 struct oid_array *commits,
1211 const struct remote *remote,
1212 const struct refspec *rs,
1213 const struct string_list *push_options,
1214 int dry_run)
1216 int i, ret = 1;
1217 struct string_list needs_pushing = STRING_LIST_INIT_DUP;
1219 if (!find_unpushed_submodules(r, commits,
1220 remote->name, &needs_pushing))
1221 return 1;
1224 * Verify that the remote and refspec can be propagated to all
1225 * submodules. This check can be skipped if the remote and refspec
1226 * won't be propagated due to the remote being unconfigured (e.g. a URL
1227 * instead of a remote name).
1229 if (remote->origin != REMOTE_UNCONFIGURED) {
1230 char *head;
1231 struct object_id head_oid;
1233 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1234 if (!head)
1235 die(_("Failed to resolve HEAD as a valid ref."));
1237 for (i = 0; i < needs_pushing.nr; i++)
1238 submodule_push_check(needs_pushing.items[i].string,
1239 head, remote, rs);
1240 free(head);
1243 /* Actually push the submodules */
1244 for (i = 0; i < needs_pushing.nr; i++) {
1245 const char *path = needs_pushing.items[i].string;
1246 fprintf(stderr, _("Pushing submodule '%s'\n"), path);
1247 if (!push_submodule(path, remote, rs,
1248 push_options, dry_run)) {
1249 fprintf(stderr, _("Unable to push submodule '%s'\n"), path);
1250 ret = 0;
1254 string_list_clear(&needs_pushing, 0);
1256 return ret;
1259 static int append_oid_to_array(const char *ref UNUSED,
1260 const struct object_id *oid,
1261 int flags UNUSED, void *data)
1263 struct oid_array *array = data;
1264 oid_array_append(array, oid);
1265 return 0;
1268 void check_for_new_submodule_commits(struct object_id *oid)
1270 if (!initialized_fetch_ref_tips) {
1271 for_each_ref(append_oid_to_array, &ref_tips_before_fetch);
1272 initialized_fetch_ref_tips = 1;
1275 oid_array_append(&ref_tips_after_fetch, oid);
1279 * Returns 1 if there is at least one submodule gitdir in
1280 * $GIT_DIR/modules and 0 otherwise. This follows
1281 * submodule_name_to_gitdir(), which looks for submodules in
1282 * $GIT_DIR/modules, not $GIT_COMMON_DIR.
1284 * A submodule can be moved to $GIT_DIR/modules manually by running "git
1285 * submodule absorbgitdirs", or it may be initialized there by "git
1286 * submodule update".
1288 static int repo_has_absorbed_submodules(struct repository *r)
1290 int ret;
1291 struct strbuf buf = STRBUF_INIT;
1293 strbuf_repo_git_path(&buf, r, "modules/");
1294 ret = file_exists(buf.buf) && !is_empty_dir(buf.buf);
1295 strbuf_release(&buf);
1296 return ret;
1299 static void calculate_changed_submodule_paths(struct repository *r,
1300 struct string_list *changed_submodule_names)
1302 struct strvec argv = STRVEC_INIT;
1303 struct string_list_item *name;
1305 /* No need to check if no submodules would be fetched */
1306 if (!submodule_from_path(r, NULL, NULL) &&
1307 !repo_has_absorbed_submodules(r))
1308 return;
1310 strvec_push(&argv, "--"); /* argv[0] program name */
1311 oid_array_for_each_unique(&ref_tips_after_fetch,
1312 append_oid_to_argv, &argv);
1313 strvec_push(&argv, "--not");
1314 oid_array_for_each_unique(&ref_tips_before_fetch,
1315 append_oid_to_argv, &argv);
1318 * Collect all submodules (whether checked out or not) for which new
1319 * commits have been recorded upstream in "changed_submodule_names".
1321 collect_changed_submodules(r, changed_submodule_names, &argv);
1323 for_each_string_list_item(name, changed_submodule_names) {
1324 struct changed_submodule_data *cs_data = name->util;
1325 const struct submodule *submodule;
1326 const char *path = NULL;
1328 submodule = submodule_from_name(r, null_oid(), name->string);
1329 if (submodule)
1330 path = submodule->path;
1331 else
1332 path = default_name_or_path(name->string);
1334 if (!path)
1335 continue;
1337 if (submodule_has_commits(r, path, null_oid(), &cs_data->new_commits)) {
1338 changed_submodule_data_clear(cs_data);
1339 *name->string = '\0';
1343 string_list_remove_empty_items(changed_submodule_names, 1);
1345 strvec_clear(&argv);
1346 oid_array_clear(&ref_tips_before_fetch);
1347 oid_array_clear(&ref_tips_after_fetch);
1348 initialized_fetch_ref_tips = 0;
1351 int submodule_touches_in_range(struct repository *r,
1352 struct object_id *excl_oid,
1353 struct object_id *incl_oid)
1355 struct string_list subs = STRING_LIST_INIT_DUP;
1356 struct strvec args = STRVEC_INIT;
1357 int ret;
1359 /* No need to check if there are no submodules configured */
1360 if (!submodule_from_path(r, NULL, NULL))
1361 return 0;
1363 strvec_push(&args, "--"); /* args[0] program name */
1364 strvec_push(&args, oid_to_hex(incl_oid));
1365 if (!is_null_oid(excl_oid)) {
1366 strvec_push(&args, "--not");
1367 strvec_push(&args, oid_to_hex(excl_oid));
1370 collect_changed_submodules(r, &subs, &args);
1371 ret = subs.nr;
1373 strvec_clear(&args);
1375 free_submodules_data(&subs);
1376 return ret;
1379 struct submodule_parallel_fetch {
1381 * The index of the last index entry processed by
1382 * get_fetch_task_from_index().
1384 int index_count;
1386 * The index of the last string_list entry processed by
1387 * get_fetch_task_from_changed().
1389 int changed_count;
1390 struct strvec args;
1391 struct repository *r;
1392 const char *prefix;
1393 int command_line_option;
1394 int default_option;
1395 int quiet;
1396 int result;
1399 * Names of submodules that have new commits. Generated by
1400 * walking the newly fetched superproject commits.
1402 struct string_list changed_submodule_names;
1404 * Names of submodules that have already been processed. Lets us
1405 * avoid fetching the same submodule more than once.
1407 struct string_list seen_submodule_names;
1409 /* Pending fetches by OIDs */
1410 struct fetch_task **oid_fetch_tasks;
1411 int oid_fetch_tasks_nr, oid_fetch_tasks_alloc;
1413 struct strbuf submodules_with_errors;
1415 #define SPF_INIT { \
1416 .args = STRVEC_INIT, \
1417 .changed_submodule_names = STRING_LIST_INIT_DUP, \
1418 .seen_submodule_names = STRING_LIST_INIT_DUP, \
1419 .submodules_with_errors = STRBUF_INIT, \
1422 static int get_fetch_recurse_config(const struct submodule *submodule,
1423 struct submodule_parallel_fetch *spf)
1425 if (spf->command_line_option != RECURSE_SUBMODULES_DEFAULT)
1426 return spf->command_line_option;
1428 if (submodule) {
1429 char *key;
1430 const char *value;
1432 int fetch_recurse = submodule->fetch_recurse;
1433 key = xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule->name);
1434 if (!repo_config_get_string_tmp(spf->r, key, &value)) {
1435 fetch_recurse = parse_fetch_recurse_submodules_arg(key, value);
1437 free(key);
1439 if (fetch_recurse != RECURSE_SUBMODULES_NONE)
1440 /* local config overrules everything except commandline */
1441 return fetch_recurse;
1444 return spf->default_option;
1448 * Fetch in progress (if callback data) or
1449 * pending (if in oid_fetch_tasks in struct submodule_parallel_fetch)
1451 struct fetch_task {
1452 struct repository *repo;
1453 const struct submodule *sub;
1454 unsigned free_sub : 1; /* Do we need to free the submodule? */
1455 const char *default_argv; /* The default fetch mode. */
1456 struct strvec git_args; /* Args for the child git process. */
1458 struct oid_array *commits; /* Ensure these commits are fetched */
1462 * When a submodule is not defined in .gitmodules, we cannot access it
1463 * via the regular submodule-config. Create a fake submodule, which we can
1464 * work on.
1466 static const struct submodule *get_non_gitmodules_submodule(const char *path)
1468 struct submodule *ret = NULL;
1469 const char *name = default_name_or_path(path);
1471 if (!name)
1472 return NULL;
1474 ret = xmalloc(sizeof(*ret));
1475 memset(ret, 0, sizeof(*ret));
1476 ret->path = name;
1477 ret->name = name;
1479 return (const struct submodule *) ret;
1482 static void fetch_task_release(struct fetch_task *p)
1484 if (p->free_sub)
1485 free((void*)p->sub);
1486 p->free_sub = 0;
1487 p->sub = NULL;
1489 if (p->repo)
1490 repo_clear(p->repo);
1491 FREE_AND_NULL(p->repo);
1493 strvec_clear(&p->git_args);
1496 static struct repository *get_submodule_repo_for(struct repository *r,
1497 const char *path,
1498 const struct object_id *treeish_name)
1500 struct repository *ret = xmalloc(sizeof(*ret));
1502 if (repo_submodule_init(ret, r, path, treeish_name)) {
1503 free(ret);
1504 return NULL;
1507 return ret;
1510 static struct fetch_task *fetch_task_create(struct submodule_parallel_fetch *spf,
1511 const char *path,
1512 const struct object_id *treeish_name)
1514 struct fetch_task *task = xmalloc(sizeof(*task));
1515 memset(task, 0, sizeof(*task));
1517 task->sub = submodule_from_path(spf->r, treeish_name, path);
1519 if (!task->sub) {
1521 * No entry in .gitmodules? Technically not a submodule,
1522 * but historically we supported repositories that happen to be
1523 * in-place where a gitlink is. Keep supporting them.
1525 task->sub = get_non_gitmodules_submodule(path);
1526 if (!task->sub)
1527 goto cleanup;
1529 task->free_sub = 1;
1532 if (string_list_lookup(&spf->seen_submodule_names, task->sub->name))
1533 goto cleanup;
1535 switch (get_fetch_recurse_config(task->sub, spf))
1537 default:
1538 case RECURSE_SUBMODULES_DEFAULT:
1539 case RECURSE_SUBMODULES_ON_DEMAND:
1540 if (!task->sub ||
1541 !string_list_lookup(
1542 &spf->changed_submodule_names,
1543 task->sub->name))
1544 goto cleanup;
1545 task->default_argv = "on-demand";
1546 break;
1547 case RECURSE_SUBMODULES_ON:
1548 task->default_argv = "yes";
1549 break;
1550 case RECURSE_SUBMODULES_OFF:
1551 goto cleanup;
1554 task->repo = get_submodule_repo_for(spf->r, path, treeish_name);
1556 return task;
1558 cleanup:
1559 fetch_task_release(task);
1560 free(task);
1561 return NULL;
1564 static struct fetch_task *
1565 get_fetch_task_from_index(struct submodule_parallel_fetch *spf,
1566 struct strbuf *err)
1568 for (; spf->index_count < spf->r->index->cache_nr; spf->index_count++) {
1569 const struct cache_entry *ce =
1570 spf->r->index->cache[spf->index_count];
1571 struct fetch_task *task;
1573 if (!S_ISGITLINK(ce->ce_mode))
1574 continue;
1576 task = fetch_task_create(spf, ce->name, null_oid());
1577 if (!task)
1578 continue;
1580 if (task->repo) {
1581 if (!spf->quiet)
1582 strbuf_addf(err, _("Fetching submodule %s%s\n"),
1583 spf->prefix, ce->name);
1585 spf->index_count++;
1586 return task;
1587 } else {
1588 struct strbuf empty_submodule_path = STRBUF_INIT;
1590 fetch_task_release(task);
1591 free(task);
1594 * An empty directory is normal,
1595 * the submodule is not initialized
1597 strbuf_addf(&empty_submodule_path, "%s/%s/",
1598 spf->r->worktree,
1599 ce->name);
1600 if (S_ISGITLINK(ce->ce_mode) &&
1601 !is_empty_dir(empty_submodule_path.buf)) {
1602 spf->result = 1;
1603 strbuf_addf(err,
1604 _("Could not access submodule '%s'\n"),
1605 ce->name);
1607 strbuf_release(&empty_submodule_path);
1610 return NULL;
1613 static struct fetch_task *
1614 get_fetch_task_from_changed(struct submodule_parallel_fetch *spf,
1615 struct strbuf *err)
1617 for (; spf->changed_count < spf->changed_submodule_names.nr;
1618 spf->changed_count++) {
1619 struct string_list_item item =
1620 spf->changed_submodule_names.items[spf->changed_count];
1621 struct changed_submodule_data *cs_data = item.util;
1622 struct fetch_task *task;
1624 if (!is_tree_submodule_active(spf->r, cs_data->super_oid,cs_data->path))
1625 continue;
1627 task = fetch_task_create(spf, cs_data->path,
1628 cs_data->super_oid);
1629 if (!task)
1630 continue;
1632 if (!task->repo) {
1633 strbuf_addf(err, _("Could not access submodule '%s' at commit %s\n"),
1634 cs_data->path,
1635 repo_find_unique_abbrev(the_repository, cs_data->super_oid, DEFAULT_ABBREV));
1637 fetch_task_release(task);
1638 free(task);
1639 continue;
1642 if (!spf->quiet)
1643 strbuf_addf(err,
1644 _("Fetching submodule %s%s at commit %s\n"),
1645 spf->prefix, task->sub->path,
1646 repo_find_unique_abbrev(the_repository, cs_data->super_oid,
1647 DEFAULT_ABBREV));
1649 spf->changed_count++;
1651 * NEEDSWORK: Submodules set/unset a value for
1652 * core.worktree when they are populated/unpopulated by
1653 * "git checkout" (and similar commands, see
1654 * submodule_move_head() and
1655 * connect_work_tree_and_git_dir()), but if the
1656 * submodule is unpopulated in another way (e.g. "git
1657 * rm", "rm -r"), core.worktree will still be set even
1658 * though the directory doesn't exist, and the child
1659 * process will crash while trying to chdir into the
1660 * nonexistent directory.
1662 * In this case, we know that the submodule has no
1663 * working tree, so we can work around this by
1664 * setting "--work-tree=." (--bare does not work because
1665 * worktree settings take precedence over bare-ness).
1666 * However, this is not necessarily true in other cases,
1667 * so a generalized solution is still necessary.
1669 * Possible solutions:
1670 * - teach "git [add|rm]" to unset core.worktree and
1671 * discourage users from removing submodules without
1672 * using a Git command.
1673 * - teach submodule child processes to ignore stale
1674 * core.worktree values.
1676 strvec_push(&task->git_args, "--work-tree=.");
1677 return task;
1679 return NULL;
1682 static int get_next_submodule(struct child_process *cp, struct strbuf *err,
1683 void *data, void **task_cb)
1685 struct submodule_parallel_fetch *spf = data;
1686 struct fetch_task *task =
1687 get_fetch_task_from_index(spf, err);
1688 if (!task)
1689 task = get_fetch_task_from_changed(spf, err);
1691 if (task) {
1692 struct strbuf submodule_prefix = STRBUF_INIT;
1694 child_process_init(cp);
1695 cp->dir = task->repo->gitdir;
1696 prepare_submodule_repo_env_in_gitdir(&cp->env);
1697 cp->git_cmd = 1;
1698 strvec_init(&cp->args);
1699 if (task->git_args.nr)
1700 strvec_pushv(&cp->args, task->git_args.v);
1701 strvec_pushv(&cp->args, spf->args.v);
1702 strvec_push(&cp->args, task->default_argv);
1703 strvec_push(&cp->args, "--submodule-prefix");
1705 strbuf_addf(&submodule_prefix, "%s%s/",
1706 spf->prefix,
1707 task->sub->path);
1708 strvec_push(&cp->args, submodule_prefix.buf);
1709 *task_cb = task;
1711 strbuf_release(&submodule_prefix);
1712 string_list_insert(&spf->seen_submodule_names, task->sub->name);
1713 return 1;
1716 if (spf->oid_fetch_tasks_nr) {
1717 struct fetch_task *task =
1718 spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr - 1];
1719 struct strbuf submodule_prefix = STRBUF_INIT;
1720 spf->oid_fetch_tasks_nr--;
1722 strbuf_addf(&submodule_prefix, "%s%s/",
1723 spf->prefix, task->sub->path);
1725 child_process_init(cp);
1726 prepare_submodule_repo_env_in_gitdir(&cp->env);
1727 cp->git_cmd = 1;
1728 cp->dir = task->repo->gitdir;
1730 strvec_init(&cp->args);
1731 strvec_pushv(&cp->args, spf->args.v);
1732 strvec_push(&cp->args, "on-demand");
1733 strvec_push(&cp->args, "--submodule-prefix");
1734 strvec_push(&cp->args, submodule_prefix.buf);
1736 /* NEEDSWORK: have get_default_remote from submodule--helper */
1737 strvec_push(&cp->args, "origin");
1738 oid_array_for_each_unique(task->commits,
1739 append_oid_to_argv, &cp->args);
1741 *task_cb = task;
1742 strbuf_release(&submodule_prefix);
1743 return 1;
1746 return 0;
1749 static int fetch_start_failure(struct strbuf *err UNUSED,
1750 void *cb, void *task_cb)
1752 struct submodule_parallel_fetch *spf = cb;
1753 struct fetch_task *task = task_cb;
1755 spf->result = 1;
1757 fetch_task_release(task);
1758 return 0;
1761 static int commit_missing_in_sub(const struct object_id *oid, void *data)
1763 struct repository *subrepo = data;
1765 enum object_type type = oid_object_info(subrepo, oid, NULL);
1767 return type != OBJ_COMMIT;
1770 static int fetch_finish(int retvalue, struct strbuf *err UNUSED,
1771 void *cb, void *task_cb)
1773 struct submodule_parallel_fetch *spf = cb;
1774 struct fetch_task *task = task_cb;
1776 struct string_list_item *it;
1777 struct changed_submodule_data *cs_data;
1779 if (!task || !task->sub)
1780 BUG("callback cookie bogus");
1782 if (retvalue) {
1784 * NEEDSWORK: This indicates that the overall fetch
1785 * failed, even though there may be a subsequent fetch
1786 * by commit hash that might work. It may be a good
1787 * idea to not indicate failure in this case, and only
1788 * indicate failure if the subsequent fetch fails.
1790 spf->result = 1;
1792 strbuf_addf(&spf->submodules_with_errors, "\t%s\n",
1793 task->sub->name);
1796 /* Is this the second time we process this submodule? */
1797 if (task->commits)
1798 goto out;
1800 it = string_list_lookup(&spf->changed_submodule_names, task->sub->name);
1801 if (!it)
1802 /* Could be an unchanged submodule, not contained in the list */
1803 goto out;
1805 cs_data = it->util;
1806 oid_array_filter(&cs_data->new_commits,
1807 commit_missing_in_sub,
1808 task->repo);
1810 /* Are there commits we want, but do not exist? */
1811 if (cs_data->new_commits.nr) {
1812 task->commits = &cs_data->new_commits;
1813 ALLOC_GROW(spf->oid_fetch_tasks,
1814 spf->oid_fetch_tasks_nr + 1,
1815 spf->oid_fetch_tasks_alloc);
1816 spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr] = task;
1817 spf->oid_fetch_tasks_nr++;
1818 return 0;
1821 out:
1822 fetch_task_release(task);
1824 return 0;
1827 int fetch_submodules(struct repository *r,
1828 const struct strvec *options,
1829 const char *prefix, int command_line_option,
1830 int default_option,
1831 int quiet, int max_parallel_jobs)
1833 int i;
1834 struct submodule_parallel_fetch spf = SPF_INIT;
1835 const struct run_process_parallel_opts opts = {
1836 .tr2_category = "submodule",
1837 .tr2_label = "parallel/fetch",
1839 .processes = max_parallel_jobs,
1841 .get_next_task = get_next_submodule,
1842 .start_failure = fetch_start_failure,
1843 .task_finished = fetch_finish,
1844 .data = &spf,
1847 spf.r = r;
1848 spf.command_line_option = command_line_option;
1849 spf.default_option = default_option;
1850 spf.quiet = quiet;
1851 spf.prefix = prefix;
1853 if (!r->worktree)
1854 goto out;
1856 if (repo_read_index(r) < 0)
1857 die(_("index file corrupt"));
1859 strvec_push(&spf.args, "fetch");
1860 for (i = 0; i < options->nr; i++)
1861 strvec_push(&spf.args, options->v[i]);
1862 strvec_push(&spf.args, "--recurse-submodules-default");
1863 /* default value, "--submodule-prefix" and its value are added later */
1865 calculate_changed_submodule_paths(r, &spf.changed_submodule_names);
1866 string_list_sort(&spf.changed_submodule_names);
1867 run_processes_parallel(&opts);
1869 if (spf.submodules_with_errors.len > 0)
1870 fprintf(stderr, _("Errors during submodule fetch:\n%s"),
1871 spf.submodules_with_errors.buf);
1874 strvec_clear(&spf.args);
1875 out:
1876 free_submodules_data(&spf.changed_submodule_names);
1877 return spf.result;
1880 unsigned is_submodule_modified(const char *path, int ignore_untracked)
1882 struct child_process cp = CHILD_PROCESS_INIT;
1883 struct strbuf buf = STRBUF_INIT;
1884 FILE *fp;
1885 unsigned dirty_submodule = 0;
1886 const char *git_dir;
1887 int ignore_cp_exit_code = 0;
1889 strbuf_addf(&buf, "%s/.git", path);
1890 git_dir = read_gitfile(buf.buf);
1891 if (!git_dir)
1892 git_dir = buf.buf;
1893 if (!is_git_directory(git_dir)) {
1894 if (is_directory(git_dir))
1895 die(_("'%s' not recognized as a git repository"), git_dir);
1896 strbuf_release(&buf);
1897 /* The submodule is not checked out, so it is not modified */
1898 return 0;
1900 strbuf_reset(&buf);
1902 strvec_pushl(&cp.args, "status", "--porcelain=2", NULL);
1903 if (ignore_untracked)
1904 strvec_push(&cp.args, "-uno");
1906 prepare_submodule_repo_env(&cp.env);
1907 cp.git_cmd = 1;
1908 cp.no_stdin = 1;
1909 cp.out = -1;
1910 cp.dir = path;
1911 if (start_command(&cp))
1912 die(_("Could not run 'git status --porcelain=2' in submodule %s"), path);
1914 fp = xfdopen(cp.out, "r");
1915 while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
1916 /* regular untracked files */
1917 if (buf.buf[0] == '?')
1918 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1920 if (buf.buf[0] == 'u' ||
1921 buf.buf[0] == '1' ||
1922 buf.buf[0] == '2') {
1923 /* T = line type, XY = status, SSSS = submodule state */
1924 if (buf.len < strlen("T XY SSSS"))
1925 BUG("invalid status --porcelain=2 line %s",
1926 buf.buf);
1928 if (buf.buf[5] == 'S' && buf.buf[8] == 'U')
1929 /* nested untracked file */
1930 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1932 if (buf.buf[0] == 'u' ||
1933 buf.buf[0] == '2' ||
1934 memcmp(buf.buf + 5, "S..U", 4))
1935 /* other change */
1936 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1939 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1940 ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
1941 ignore_untracked)) {
1943 * We're not interested in any further information from
1944 * the child any more, neither output nor its exit code.
1946 ignore_cp_exit_code = 1;
1947 break;
1950 fclose(fp);
1952 if (finish_command(&cp) && !ignore_cp_exit_code)
1953 die(_("'git status --porcelain=2' failed in submodule %s"), path);
1955 strbuf_release(&buf);
1956 return dirty_submodule;
1959 int submodule_uses_gitfile(const char *path)
1961 struct child_process cp = CHILD_PROCESS_INIT;
1962 struct strbuf buf = STRBUF_INIT;
1963 const char *git_dir;
1965 strbuf_addf(&buf, "%s/.git", path);
1966 git_dir = read_gitfile(buf.buf);
1967 if (!git_dir) {
1968 strbuf_release(&buf);
1969 return 0;
1971 strbuf_release(&buf);
1973 /* Now test that all nested submodules use a gitfile too */
1974 strvec_pushl(&cp.args,
1975 "submodule", "foreach", "--quiet", "--recursive",
1976 "test -f .git", NULL);
1978 prepare_submodule_repo_env(&cp.env);
1979 cp.git_cmd = 1;
1980 cp.no_stdin = 1;
1981 cp.no_stderr = 1;
1982 cp.no_stdout = 1;
1983 cp.dir = path;
1984 if (run_command(&cp))
1985 return 0;
1987 return 1;
1991 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1992 * when doing so.
1994 * Return 1 if we'd lose data, return 0 if the removal is fine,
1995 * and negative values for errors.
1997 int bad_to_remove_submodule(const char *path, unsigned flags)
1999 ssize_t len;
2000 struct child_process cp = CHILD_PROCESS_INIT;
2001 struct strbuf buf = STRBUF_INIT;
2002 int ret = 0;
2004 if (!file_exists(path) || is_empty_dir(path))
2005 return 0;
2007 if (!submodule_uses_gitfile(path))
2008 return 1;
2010 strvec_pushl(&cp.args, "status", "--porcelain",
2011 "--ignore-submodules=none", NULL);
2013 if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
2014 strvec_push(&cp.args, "-uno");
2015 else
2016 strvec_push(&cp.args, "-uall");
2018 if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
2019 strvec_push(&cp.args, "--ignored");
2021 prepare_submodule_repo_env(&cp.env);
2022 cp.git_cmd = 1;
2023 cp.no_stdin = 1;
2024 cp.out = -1;
2025 cp.dir = path;
2026 if (start_command(&cp)) {
2027 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
2028 die(_("could not start 'git status' in submodule '%s'"),
2029 path);
2030 ret = -1;
2031 goto out;
2034 len = strbuf_read(&buf, cp.out, 1024);
2035 if (len > 2)
2036 ret = 1;
2037 close(cp.out);
2039 if (finish_command(&cp)) {
2040 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
2041 die(_("could not run 'git status' in submodule '%s'"),
2042 path);
2043 ret = -1;
2045 out:
2046 strbuf_release(&buf);
2047 return ret;
2050 void submodule_unset_core_worktree(const struct submodule *sub)
2052 struct strbuf config_path = STRBUF_INIT;
2054 submodule_name_to_gitdir(&config_path, the_repository, sub->name);
2055 strbuf_addstr(&config_path, "/config");
2057 if (git_config_set_in_file_gently(config_path.buf, "core.worktree", NULL))
2058 warning(_("Could not unset core.worktree setting in submodule '%s'"),
2059 sub->path);
2061 strbuf_release(&config_path);
2064 static int submodule_has_dirty_index(const struct submodule *sub)
2066 struct child_process cp = CHILD_PROCESS_INIT;
2068 prepare_submodule_repo_env(&cp.env);
2070 cp.git_cmd = 1;
2071 strvec_pushl(&cp.args, "diff-index", "--quiet",
2072 "--cached", "HEAD", NULL);
2073 cp.no_stdin = 1;
2074 cp.no_stdout = 1;
2075 cp.dir = sub->path;
2076 if (start_command(&cp))
2077 die(_("could not recurse into submodule '%s'"), sub->path);
2079 return finish_command(&cp);
2082 static void submodule_reset_index(const char *path, const char *super_prefix)
2084 struct child_process cp = CHILD_PROCESS_INIT;
2085 prepare_submodule_repo_env(&cp.env);
2087 cp.git_cmd = 1;
2088 cp.no_stdin = 1;
2089 cp.dir = path;
2091 /* TODO: determine if this might overwright untracked files */
2092 strvec_pushl(&cp.args, "read-tree", "-u", "--reset", NULL);
2093 strvec_pushf(&cp.args, "--super-prefix=%s%s/",
2094 (super_prefix ? super_prefix : ""), path);
2096 strvec_push(&cp.args, empty_tree_oid_hex());
2098 if (run_command(&cp))
2099 die(_("could not reset submodule index"));
2103 * Moves a submodule at a given path from a given head to another new head.
2104 * For edge cases (a submodule coming into existence or removing a submodule)
2105 * pass NULL for old or new respectively.
2107 int submodule_move_head(const char *path, const char *super_prefix,
2108 const char *old_head, const char *new_head,
2109 unsigned flags)
2111 int ret = 0;
2112 struct child_process cp = CHILD_PROCESS_INIT;
2113 const struct submodule *sub;
2114 int *error_code_ptr, error_code;
2116 if (!is_submodule_active(the_repository, path))
2117 return 0;
2119 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
2121 * Pass non NULL pointer to is_submodule_populated_gently
2122 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
2123 * to fixup the submodule in the force case later.
2125 error_code_ptr = &error_code;
2126 else
2127 error_code_ptr = NULL;
2129 if (old_head && !is_submodule_populated_gently(path, error_code_ptr))
2130 return 0;
2132 sub = submodule_from_path(the_repository, null_oid(), path);
2134 if (!sub)
2135 BUG("could not get submodule information for '%s'", path);
2137 if (old_head && !(flags & SUBMODULE_MOVE_HEAD_FORCE)) {
2138 /* Check if the submodule has a dirty index. */
2139 if (submodule_has_dirty_index(sub))
2140 return error(_("submodule '%s' has dirty index"), path);
2143 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
2144 if (old_head) {
2145 if (!submodule_uses_gitfile(path))
2146 absorb_git_dir_into_superproject(path,
2147 super_prefix);
2148 } else {
2149 struct strbuf gitdir = STRBUF_INIT;
2150 submodule_name_to_gitdir(&gitdir, the_repository,
2151 sub->name);
2152 connect_work_tree_and_git_dir(path, gitdir.buf, 0);
2153 strbuf_release(&gitdir);
2155 /* make sure the index is clean as well */
2156 submodule_reset_index(path, super_prefix);
2159 if (old_head && (flags & SUBMODULE_MOVE_HEAD_FORCE)) {
2160 struct strbuf gitdir = STRBUF_INIT;
2161 submodule_name_to_gitdir(&gitdir, the_repository,
2162 sub->name);
2163 connect_work_tree_and_git_dir(path, gitdir.buf, 1);
2164 strbuf_release(&gitdir);
2168 prepare_submodule_repo_env(&cp.env);
2170 cp.git_cmd = 1;
2171 cp.no_stdin = 1;
2172 cp.dir = path;
2174 strvec_pushl(&cp.args, "read-tree", "--recurse-submodules", NULL);
2175 strvec_pushf(&cp.args, "--super-prefix=%s%s/",
2176 (super_prefix ? super_prefix : ""), path);
2178 if (flags & SUBMODULE_MOVE_HEAD_DRY_RUN)
2179 strvec_push(&cp.args, "-n");
2180 else
2181 strvec_push(&cp.args, "-u");
2183 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
2184 strvec_push(&cp.args, "--reset");
2185 else
2186 strvec_push(&cp.args, "-m");
2188 if (!(flags & SUBMODULE_MOVE_HEAD_FORCE))
2189 strvec_push(&cp.args, old_head ? old_head : empty_tree_oid_hex());
2191 strvec_push(&cp.args, new_head ? new_head : empty_tree_oid_hex());
2193 if (run_command(&cp)) {
2194 ret = error(_("Submodule '%s' could not be updated."), path);
2195 goto out;
2198 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
2199 if (new_head) {
2200 child_process_init(&cp);
2201 /* also set the HEAD accordingly */
2202 cp.git_cmd = 1;
2203 cp.no_stdin = 1;
2204 cp.dir = path;
2206 prepare_submodule_repo_env(&cp.env);
2207 strvec_pushl(&cp.args, "update-ref", "HEAD",
2208 "--no-deref", new_head, NULL);
2210 if (run_command(&cp)) {
2211 ret = -1;
2212 goto out;
2214 } else {
2215 struct strbuf sb = STRBUF_INIT;
2217 strbuf_addf(&sb, "%s/.git", path);
2218 unlink_or_warn(sb.buf);
2219 strbuf_release(&sb);
2221 if (is_empty_dir(path))
2222 rmdir_or_warn(path);
2224 submodule_unset_core_worktree(sub);
2227 out:
2228 return ret;
2231 int validate_submodule_git_dir(char *git_dir, const char *submodule_name)
2233 size_t len = strlen(git_dir), suffix_len = strlen(submodule_name);
2234 char *p;
2235 int ret = 0;
2237 if (len <= suffix_len || (p = git_dir + len - suffix_len)[-1] != '/' ||
2238 strcmp(p, submodule_name))
2239 BUG("submodule name '%s' not a suffix of git dir '%s'",
2240 submodule_name, git_dir);
2243 * We prevent the contents of sibling submodules' git directories to
2244 * clash.
2246 * Example: having a submodule named `hippo` and another one named
2247 * `hippo/hooks` would result in the git directories
2248 * `.git/modules/hippo/` and `.git/modules/hippo/hooks/`, respectively,
2249 * but the latter directory is already designated to contain the hooks
2250 * of the former.
2252 for (; *p; p++) {
2253 if (is_dir_sep(*p)) {
2254 char c = *p;
2256 *p = '\0';
2257 if (is_git_directory(git_dir))
2258 ret = -1;
2259 *p = c;
2261 if (ret < 0)
2262 return error(_("submodule git dir '%s' is "
2263 "inside git dir '%.*s'"),
2264 git_dir,
2265 (int)(p - git_dir), git_dir);
2269 return 0;
2273 * Embeds a single submodules git directory into the superprojects git dir,
2274 * non recursively.
2276 static void relocate_single_git_dir_into_superproject(const char *path,
2277 const char *super_prefix)
2279 char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
2280 struct strbuf new_gitdir = STRBUF_INIT;
2281 const struct submodule *sub;
2283 if (submodule_uses_worktrees(path))
2284 die(_("relocate_gitdir for submodule '%s' with "
2285 "more than one worktree not supported"), path);
2287 old_git_dir = xstrfmt("%s/.git", path);
2288 if (read_gitfile(old_git_dir))
2289 /* If it is an actual gitfile, it doesn't need migration. */
2290 return;
2292 real_old_git_dir = real_pathdup(old_git_dir, 1);
2294 sub = submodule_from_path(the_repository, null_oid(), path);
2295 if (!sub)
2296 die(_("could not lookup name for submodule '%s'"), path);
2298 submodule_name_to_gitdir(&new_gitdir, the_repository, sub->name);
2299 if (validate_submodule_git_dir(new_gitdir.buf, sub->name) < 0)
2300 die(_("refusing to move '%s' into an existing git dir"),
2301 real_old_git_dir);
2302 if (safe_create_leading_directories_const(new_gitdir.buf) < 0)
2303 die(_("could not create directory '%s'"), new_gitdir.buf);
2304 real_new_git_dir = real_pathdup(new_gitdir.buf, 1);
2306 fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
2307 super_prefix ? super_prefix : "", path,
2308 real_old_git_dir, real_new_git_dir);
2310 relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
2312 free(old_git_dir);
2313 free(real_old_git_dir);
2314 free(real_new_git_dir);
2315 strbuf_release(&new_gitdir);
2318 static void absorb_git_dir_into_superproject_recurse(const char *path,
2319 const char *super_prefix)
2322 struct child_process cp = CHILD_PROCESS_INIT;
2324 cp.dir = path;
2325 cp.git_cmd = 1;
2326 cp.no_stdin = 1;
2327 strvec_pushl(&cp.args, "submodule--helper",
2328 "absorbgitdirs", NULL);
2329 strvec_pushf(&cp.args, "--super-prefix=%s%s/", super_prefix ?
2330 super_prefix : "", path);
2332 prepare_submodule_repo_env(&cp.env);
2333 if (run_command(&cp))
2334 die(_("could not recurse into submodule '%s'"), path);
2338 * Migrate the git directory of the submodule given by path from
2339 * having its git directory within the working tree to the git dir nested
2340 * in its superprojects git dir under modules/.
2342 void absorb_git_dir_into_superproject(const char *path,
2343 const char *super_prefix)
2345 int err_code;
2346 const char *sub_git_dir;
2347 struct strbuf gitdir = STRBUF_INIT;
2348 strbuf_addf(&gitdir, "%s/.git", path);
2349 sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
2351 /* Not populated? */
2352 if (!sub_git_dir) {
2353 const struct submodule *sub;
2354 struct strbuf sub_gitdir = STRBUF_INIT;
2356 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
2357 /* unpopulated as expected */
2358 strbuf_release(&gitdir);
2359 return;
2362 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
2363 /* We don't know what broke here. */
2364 read_gitfile_error_die(err_code, path, NULL);
2367 * Maybe populated, but no git directory was found?
2368 * This can happen if the superproject is a submodule
2369 * itself and was just absorbed. The absorption of the
2370 * superproject did not rewrite the git file links yet,
2371 * fix it now.
2373 sub = submodule_from_path(the_repository, null_oid(), path);
2374 if (!sub)
2375 die(_("could not lookup name for submodule '%s'"), path);
2376 submodule_name_to_gitdir(&sub_gitdir, the_repository, sub->name);
2377 connect_work_tree_and_git_dir(path, sub_gitdir.buf, 0);
2378 strbuf_release(&sub_gitdir);
2379 } else {
2380 /* Is it already absorbed into the superprojects git dir? */
2381 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
2382 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
2384 if (!starts_with(real_sub_git_dir, real_common_git_dir))
2385 relocate_single_git_dir_into_superproject(path, super_prefix);
2387 free(real_sub_git_dir);
2388 free(real_common_git_dir);
2390 strbuf_release(&gitdir);
2392 absorb_git_dir_into_superproject_recurse(path, super_prefix);
2395 int get_superproject_working_tree(struct strbuf *buf)
2397 struct child_process cp = CHILD_PROCESS_INIT;
2398 struct strbuf sb = STRBUF_INIT;
2399 struct strbuf one_up = STRBUF_INIT;
2400 char *cwd = xgetcwd();
2401 int ret = 0;
2402 const char *subpath;
2403 int code;
2404 ssize_t len;
2406 if (!is_inside_work_tree())
2408 * FIXME:
2409 * We might have a superproject, but it is harder
2410 * to determine.
2412 return 0;
2414 if (!strbuf_realpath(&one_up, "../", 0))
2415 return 0;
2417 subpath = relative_path(cwd, one_up.buf, &sb);
2418 strbuf_release(&one_up);
2420 prepare_submodule_repo_env(&cp.env);
2421 strvec_pop(&cp.env);
2423 strvec_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
2424 "ls-files", "-z", "--stage", "--full-name", "--",
2425 subpath, NULL);
2426 strbuf_reset(&sb);
2428 cp.no_stdin = 1;
2429 cp.no_stderr = 1;
2430 cp.out = -1;
2431 cp.git_cmd = 1;
2433 if (start_command(&cp))
2434 die(_("could not start ls-files in .."));
2436 len = strbuf_read(&sb, cp.out, PATH_MAX);
2437 close(cp.out);
2439 if (starts_with(sb.buf, "160000")) {
2440 int super_sub_len;
2441 int cwd_len = strlen(cwd);
2442 char *super_sub, *super_wt;
2445 * There is a superproject having this repo as a submodule.
2446 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
2447 * We're only interested in the name after the tab.
2449 super_sub = strchr(sb.buf, '\t') + 1;
2450 super_sub_len = strlen(super_sub);
2452 if (super_sub_len > cwd_len ||
2453 strcmp(&cwd[cwd_len - super_sub_len], super_sub))
2454 BUG("returned path string doesn't match cwd?");
2456 super_wt = xstrdup(cwd);
2457 super_wt[cwd_len - super_sub_len] = '\0';
2459 strbuf_realpath(buf, super_wt, 1);
2460 ret = 1;
2461 free(super_wt);
2463 free(cwd);
2464 strbuf_release(&sb);
2466 code = finish_command(&cp);
2468 if (code == 128)
2469 /* '../' is not a git repository */
2470 return 0;
2471 if (code == 0 && len == 0)
2472 /* There is an unrelated git repository at '../' */
2473 return 0;
2474 if (code)
2475 die(_("ls-tree returned unexpected return code %d"), code);
2477 return ret;
2481 * Put the gitdir for a submodule (given relative to the main
2482 * repository worktree) into `buf`, or return -1 on error.
2484 int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
2486 const struct submodule *sub;
2487 const char *git_dir;
2488 int ret = 0;
2490 strbuf_reset(buf);
2491 strbuf_addstr(buf, submodule);
2492 strbuf_complete(buf, '/');
2493 strbuf_addstr(buf, ".git");
2495 git_dir = read_gitfile(buf->buf);
2496 if (git_dir) {
2497 strbuf_reset(buf);
2498 strbuf_addstr(buf, git_dir);
2500 if (!is_git_directory(buf->buf)) {
2501 sub = submodule_from_path(the_repository, null_oid(),
2502 submodule);
2503 if (!sub) {
2504 ret = -1;
2505 goto cleanup;
2507 strbuf_reset(buf);
2508 submodule_name_to_gitdir(buf, the_repository, sub->name);
2511 cleanup:
2512 return ret;
2515 void submodule_name_to_gitdir(struct strbuf *buf, struct repository *r,
2516 const char *submodule_name)
2519 * NEEDSWORK: The current way of mapping a submodule's name to
2520 * its location in .git/modules/ has problems with some naming
2521 * schemes. For example, if a submodule is named "foo" and
2522 * another is named "foo/bar" (whether present in the same
2523 * superproject commit or not - the problem will arise if both
2524 * superproject commits have been checked out at any point in
2525 * time), or if two submodule names only have different cases in
2526 * a case-insensitive filesystem.
2528 * There are several solutions, including encoding the path in
2529 * some way, introducing a submodule.<name>.gitdir config in
2530 * .git/config (not .gitmodules) that allows overriding what the
2531 * gitdir of a submodule would be (and teach Git, upon noticing
2532 * a clash, to automatically determine a non-clashing name and
2533 * to write such a config), or introducing a
2534 * submodule.<name>.gitdir config in .gitmodules that repo
2535 * administrators can explicitly set. Nothing has been decided,
2536 * so for now, just append the name at the end of the path.
2538 strbuf_repo_git_path(buf, r, "modules/");
2539 strbuf_addstr(buf, submodule_name);