Merge branch 'jc/doc-submitting-patches-choice-of-base'
[git/debian.git] / builtin / fetch.c
blobe33fda4174233fc47403a4c5fb53241bc7345205
1 /*
2 * "git fetch"
3 */
4 #include "cache.h"
5 #include "config.h"
6 #include "repository.h"
7 #include "refs.h"
8 #include "refspec.h"
9 #include "object-store.h"
10 #include "oidset.h"
11 #include "commit.h"
12 #include "builtin.h"
13 #include "string-list.h"
14 #include "remote.h"
15 #include "transport.h"
16 #include "run-command.h"
17 #include "parse-options.h"
18 #include "sigchain.h"
19 #include "submodule-config.h"
20 #include "submodule.h"
21 #include "connected.h"
22 #include "strvec.h"
23 #include "utf8.h"
24 #include "packfile.h"
25 #include "list-objects-filter-options.h"
26 #include "commit-reach.h"
27 #include "branch.h"
28 #include "promisor-remote.h"
29 #include "commit-graph.h"
30 #include "shallow.h"
31 #include "worktree.h"
33 #define FORCED_UPDATES_DELAY_WARNING_IN_MS (10 * 1000)
35 static const char * const builtin_fetch_usage[] = {
36 N_("git fetch [<options>] [<repository> [<refspec>...]]"),
37 N_("git fetch [<options>] <group>"),
38 N_("git fetch --multiple [<options>] [(<repository> | <group>)...]"),
39 N_("git fetch --all [<options>]"),
40 NULL
43 enum {
44 TAGS_UNSET = 0,
45 TAGS_DEFAULT = 1,
46 TAGS_SET = 2
49 static int fetch_prune_config = -1; /* unspecified */
50 static int fetch_show_forced_updates = 1;
51 static uint64_t forced_updates_ms = 0;
52 static int prefetch = 0;
53 static int prune = -1; /* unspecified */
54 #define PRUNE_BY_DEFAULT 0 /* do we prune by default? */
56 static int fetch_prune_tags_config = -1; /* unspecified */
57 static int prune_tags = -1; /* unspecified */
58 #define PRUNE_TAGS_BY_DEFAULT 0 /* do we prune tags by default? */
60 static int all, append, dry_run, force, keep, multiple, update_head_ok;
61 static int write_fetch_head = 1;
62 static int verbosity, deepen_relative, set_upstream;
63 static int progress = -1;
64 static int enable_auto_gc = 1;
65 static int tags = TAGS_DEFAULT, unshallow, update_shallow, deepen;
66 static int max_jobs = -1, submodule_fetch_jobs_config = -1;
67 static int fetch_parallel_config = 1;
68 static int atomic_fetch;
69 static enum transport_family family;
70 static const char *depth;
71 static const char *deepen_since;
72 static const char *upload_pack;
73 static struct string_list deepen_not = STRING_LIST_INIT_NODUP;
74 static struct strbuf default_rla = STRBUF_INIT;
75 static struct transport *gtransport;
76 static struct transport *gsecondary;
77 static const char *submodule_prefix = "";
78 static int recurse_submodules = RECURSE_SUBMODULES_DEFAULT;
79 static int recurse_submodules_default = RECURSE_SUBMODULES_ON_DEMAND;
80 static int shown_url = 0;
81 static struct refspec refmap = REFSPEC_INIT_FETCH;
82 static struct list_objects_filter_options filter_options;
83 static struct string_list server_options = STRING_LIST_INIT_DUP;
84 static struct string_list negotiation_tip = STRING_LIST_INIT_NODUP;
85 static int fetch_write_commit_graph = -1;
86 static int stdin_refspecs = 0;
87 static int negotiate_only;
89 static int git_fetch_config(const char *k, const char *v, void *cb)
91 if (!strcmp(k, "fetch.prune")) {
92 fetch_prune_config = git_config_bool(k, v);
93 return 0;
96 if (!strcmp(k, "fetch.prunetags")) {
97 fetch_prune_tags_config = git_config_bool(k, v);
98 return 0;
101 if (!strcmp(k, "fetch.showforcedupdates")) {
102 fetch_show_forced_updates = git_config_bool(k, v);
103 return 0;
106 if (!strcmp(k, "submodule.recurse")) {
107 int r = git_config_bool(k, v) ?
108 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
109 recurse_submodules = r;
112 if (!strcmp(k, "submodule.fetchjobs")) {
113 submodule_fetch_jobs_config = parse_submodule_fetchjobs(k, v);
114 return 0;
115 } else if (!strcmp(k, "fetch.recursesubmodules")) {
116 recurse_submodules = parse_fetch_recurse_submodules_arg(k, v);
117 return 0;
120 if (!strcmp(k, "fetch.parallel")) {
121 fetch_parallel_config = git_config_int(k, v);
122 if (fetch_parallel_config < 0)
123 die(_("fetch.parallel cannot be negative"));
124 return 0;
127 return git_default_config(k, v, cb);
130 static int parse_refmap_arg(const struct option *opt, const char *arg, int unset)
132 BUG_ON_OPT_NEG(unset);
135 * "git fetch --refmap='' origin foo"
136 * can be used to tell the command not to store anywhere
138 refspec_append(&refmap, arg);
140 return 0;
143 static struct option builtin_fetch_options[] = {
144 OPT__VERBOSITY(&verbosity),
145 OPT_BOOL(0, "all", &all,
146 N_("fetch from all remotes")),
147 OPT_BOOL(0, "set-upstream", &set_upstream,
148 N_("set upstream for git pull/fetch")),
149 OPT_BOOL('a', "append", &append,
150 N_("append to .git/FETCH_HEAD instead of overwriting")),
151 OPT_BOOL(0, "atomic", &atomic_fetch,
152 N_("use atomic transaction to update references")),
153 OPT_STRING(0, "upload-pack", &upload_pack, N_("path"),
154 N_("path to upload pack on remote end")),
155 OPT__FORCE(&force, N_("force overwrite of local reference"), 0),
156 OPT_BOOL('m', "multiple", &multiple,
157 N_("fetch from multiple remotes")),
158 OPT_SET_INT('t', "tags", &tags,
159 N_("fetch all tags and associated objects"), TAGS_SET),
160 OPT_SET_INT('n', NULL, &tags,
161 N_("do not fetch all tags (--no-tags)"), TAGS_UNSET),
162 OPT_INTEGER('j', "jobs", &max_jobs,
163 N_("number of submodules fetched in parallel")),
164 OPT_BOOL(0, "prefetch", &prefetch,
165 N_("modify the refspec to place all refs within refs/prefetch/")),
166 OPT_BOOL('p', "prune", &prune,
167 N_("prune remote-tracking branches no longer on remote")),
168 OPT_BOOL('P', "prune-tags", &prune_tags,
169 N_("prune local tags no longer on remote and clobber changed tags")),
170 OPT_CALLBACK_F(0, "recurse-submodules", &recurse_submodules, N_("on-demand"),
171 N_("control recursive fetching of submodules"),
172 PARSE_OPT_OPTARG, option_fetch_parse_recurse_submodules),
173 OPT_BOOL(0, "dry-run", &dry_run,
174 N_("dry run")),
175 OPT_BOOL(0, "write-fetch-head", &write_fetch_head,
176 N_("write fetched references to the FETCH_HEAD file")),
177 OPT_BOOL('k', "keep", &keep, N_("keep downloaded pack")),
178 OPT_BOOL('u', "update-head-ok", &update_head_ok,
179 N_("allow updating of HEAD ref")),
180 OPT_BOOL(0, "progress", &progress, N_("force progress reporting")),
181 OPT_STRING(0, "depth", &depth, N_("depth"),
182 N_("deepen history of shallow clone")),
183 OPT_STRING(0, "shallow-since", &deepen_since, N_("time"),
184 N_("deepen history of shallow repository based on time")),
185 OPT_STRING_LIST(0, "shallow-exclude", &deepen_not, N_("revision"),
186 N_("deepen history of shallow clone, excluding rev")),
187 OPT_INTEGER(0, "deepen", &deepen_relative,
188 N_("deepen history of shallow clone")),
189 OPT_SET_INT_F(0, "unshallow", &unshallow,
190 N_("convert to a complete repository"),
191 1, PARSE_OPT_NONEG),
192 { OPTION_STRING, 0, "submodule-prefix", &submodule_prefix, N_("dir"),
193 N_("prepend this to submodule path output"), PARSE_OPT_HIDDEN },
194 OPT_CALLBACK_F(0, "recurse-submodules-default",
195 &recurse_submodules_default, N_("on-demand"),
196 N_("default for recursive fetching of submodules "
197 "(lower priority than config files)"),
198 PARSE_OPT_HIDDEN, option_fetch_parse_recurse_submodules),
199 OPT_BOOL(0, "update-shallow", &update_shallow,
200 N_("accept refs that update .git/shallow")),
201 OPT_CALLBACK_F(0, "refmap", NULL, N_("refmap"),
202 N_("specify fetch refmap"), PARSE_OPT_NONEG, parse_refmap_arg),
203 OPT_STRING_LIST('o', "server-option", &server_options, N_("server-specific"), N_("option to transmit")),
204 OPT_SET_INT('4', "ipv4", &family, N_("use IPv4 addresses only"),
205 TRANSPORT_FAMILY_IPV4),
206 OPT_SET_INT('6', "ipv6", &family, N_("use IPv6 addresses only"),
207 TRANSPORT_FAMILY_IPV6),
208 OPT_STRING_LIST(0, "negotiation-tip", &negotiation_tip, N_("revision"),
209 N_("report that we have only objects reachable from this object")),
210 OPT_BOOL(0, "negotiate-only", &negotiate_only,
211 N_("do not fetch a packfile; instead, print ancestors of negotiation tips")),
212 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
213 OPT_BOOL(0, "auto-maintenance", &enable_auto_gc,
214 N_("run 'maintenance --auto' after fetching")),
215 OPT_BOOL(0, "auto-gc", &enable_auto_gc,
216 N_("run 'maintenance --auto' after fetching")),
217 OPT_BOOL(0, "show-forced-updates", &fetch_show_forced_updates,
218 N_("check for forced-updates on all updated branches")),
219 OPT_BOOL(0, "write-commit-graph", &fetch_write_commit_graph,
220 N_("write the commit-graph after fetching")),
221 OPT_BOOL(0, "stdin", &stdin_refspecs,
222 N_("accept refspecs from stdin")),
223 OPT_END()
226 static void unlock_pack(void)
228 if (gtransport)
229 transport_unlock_pack(gtransport);
230 if (gsecondary)
231 transport_unlock_pack(gsecondary);
234 static void unlock_pack_on_signal(int signo)
236 unlock_pack();
237 sigchain_pop(signo);
238 raise(signo);
241 static void add_merge_config(struct ref **head,
242 const struct ref *remote_refs,
243 struct branch *branch,
244 struct ref ***tail)
246 int i;
248 for (i = 0; i < branch->merge_nr; i++) {
249 struct ref *rm, **old_tail = *tail;
250 struct refspec_item refspec;
252 for (rm = *head; rm; rm = rm->next) {
253 if (branch_merge_matches(branch, i, rm->name)) {
254 rm->fetch_head_status = FETCH_HEAD_MERGE;
255 break;
258 if (rm)
259 continue;
262 * Not fetched to a remote-tracking branch? We need to fetch
263 * it anyway to allow this branch's "branch.$name.merge"
264 * to be honored by 'git pull', but we do not have to
265 * fail if branch.$name.merge is misconfigured to point
266 * at a nonexisting branch. If we were indeed called by
267 * 'git pull', it will notice the misconfiguration because
268 * there is no entry in the resulting FETCH_HEAD marked
269 * for merging.
271 memset(&refspec, 0, sizeof(refspec));
272 refspec.src = branch->merge[i]->src;
273 get_fetch_map(remote_refs, &refspec, tail, 1);
274 for (rm = *old_tail; rm; rm = rm->next)
275 rm->fetch_head_status = FETCH_HEAD_MERGE;
279 static void create_fetch_oidset(struct ref **head, struct oidset *out)
281 struct ref *rm = *head;
282 while (rm) {
283 oidset_insert(out, &rm->old_oid);
284 rm = rm->next;
288 struct refname_hash_entry {
289 struct hashmap_entry ent;
290 struct object_id oid;
291 int ignore;
292 char refname[FLEX_ARRAY];
295 static int refname_hash_entry_cmp(const void *hashmap_cmp_fn_data,
296 const struct hashmap_entry *eptr,
297 const struct hashmap_entry *entry_or_key,
298 const void *keydata)
300 const struct refname_hash_entry *e1, *e2;
302 e1 = container_of(eptr, const struct refname_hash_entry, ent);
303 e2 = container_of(entry_or_key, const struct refname_hash_entry, ent);
304 return strcmp(e1->refname, keydata ? keydata : e2->refname);
307 static struct refname_hash_entry *refname_hash_add(struct hashmap *map,
308 const char *refname,
309 const struct object_id *oid)
311 struct refname_hash_entry *ent;
312 size_t len = strlen(refname);
314 FLEX_ALLOC_MEM(ent, refname, refname, len);
315 hashmap_entry_init(&ent->ent, strhash(refname));
316 oidcpy(&ent->oid, oid);
317 hashmap_add(map, &ent->ent);
318 return ent;
321 static int add_one_refname(const char *refname,
322 const struct object_id *oid,
323 int flag, void *cbdata)
325 struct hashmap *refname_map = cbdata;
327 (void) refname_hash_add(refname_map, refname, oid);
328 return 0;
331 static void refname_hash_init(struct hashmap *map)
333 hashmap_init(map, refname_hash_entry_cmp, NULL, 0);
336 static int refname_hash_exists(struct hashmap *map, const char *refname)
338 return !!hashmap_get_from_hash(map, strhash(refname), refname);
341 static void clear_item(struct refname_hash_entry *item)
343 item->ignore = 1;
346 static void find_non_local_tags(const struct ref *refs,
347 struct ref **head,
348 struct ref ***tail)
350 struct hashmap existing_refs;
351 struct hashmap remote_refs;
352 struct oidset fetch_oids = OIDSET_INIT;
353 struct string_list remote_refs_list = STRING_LIST_INIT_NODUP;
354 struct string_list_item *remote_ref_item;
355 const struct ref *ref;
356 struct refname_hash_entry *item = NULL;
357 const int quick_flags = OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT;
359 refname_hash_init(&existing_refs);
360 refname_hash_init(&remote_refs);
361 create_fetch_oidset(head, &fetch_oids);
363 for_each_ref(add_one_refname, &existing_refs);
364 for (ref = refs; ref; ref = ref->next) {
365 if (!starts_with(ref->name, "refs/tags/"))
366 continue;
369 * The peeled ref always follows the matching base
370 * ref, so if we see a peeled ref that we don't want
371 * to fetch then we can mark the ref entry in the list
372 * as one to ignore by setting util to NULL.
374 if (ends_with(ref->name, "^{}")) {
375 if (item &&
376 !has_object_file_with_flags(&ref->old_oid, quick_flags) &&
377 !oidset_contains(&fetch_oids, &ref->old_oid) &&
378 !has_object_file_with_flags(&item->oid, quick_flags) &&
379 !oidset_contains(&fetch_oids, &item->oid))
380 clear_item(item);
381 item = NULL;
382 continue;
386 * If item is non-NULL here, then we previously saw a
387 * ref not followed by a peeled reference, so we need
388 * to check if it is a lightweight tag that we want to
389 * fetch.
391 if (item &&
392 !has_object_file_with_flags(&item->oid, quick_flags) &&
393 !oidset_contains(&fetch_oids, &item->oid))
394 clear_item(item);
396 item = NULL;
398 /* skip duplicates and refs that we already have */
399 if (refname_hash_exists(&remote_refs, ref->name) ||
400 refname_hash_exists(&existing_refs, ref->name))
401 continue;
403 item = refname_hash_add(&remote_refs, ref->name, &ref->old_oid);
404 string_list_insert(&remote_refs_list, ref->name);
406 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
409 * We may have a final lightweight tag that needs to be
410 * checked to see if it needs fetching.
412 if (item &&
413 !has_object_file_with_flags(&item->oid, quick_flags) &&
414 !oidset_contains(&fetch_oids, &item->oid))
415 clear_item(item);
418 * For all the tags in the remote_refs_list,
419 * add them to the list of refs to be fetched
421 for_each_string_list_item(remote_ref_item, &remote_refs_list) {
422 const char *refname = remote_ref_item->string;
423 struct ref *rm;
424 unsigned int hash = strhash(refname);
426 item = hashmap_get_entry_from_hash(&remote_refs, hash, refname,
427 struct refname_hash_entry, ent);
428 if (!item)
429 BUG("unseen remote ref?");
431 /* Unless we have already decided to ignore this item... */
432 if (item->ignore)
433 continue;
435 rm = alloc_ref(item->refname);
436 rm->peer_ref = alloc_ref(item->refname);
437 oidcpy(&rm->old_oid, &item->oid);
438 **tail = rm;
439 *tail = &rm->next;
441 hashmap_clear_and_free(&remote_refs, struct refname_hash_entry, ent);
442 string_list_clear(&remote_refs_list, 0);
443 oidset_clear(&fetch_oids);
446 static void filter_prefetch_refspec(struct refspec *rs)
448 int i;
450 if (!prefetch)
451 return;
453 for (i = 0; i < rs->nr; i++) {
454 struct strbuf new_dst = STRBUF_INIT;
455 char *old_dst;
456 const char *sub = NULL;
458 if (rs->items[i].negative)
459 continue;
460 if (!rs->items[i].dst ||
461 (rs->items[i].src &&
462 !strncmp(rs->items[i].src, "refs/tags/", 10))) {
463 int j;
465 free(rs->items[i].src);
466 free(rs->items[i].dst);
468 for (j = i + 1; j < rs->nr; j++) {
469 rs->items[j - 1] = rs->items[j];
470 rs->raw[j - 1] = rs->raw[j];
472 rs->nr--;
473 i--;
474 continue;
477 old_dst = rs->items[i].dst;
478 strbuf_addstr(&new_dst, "refs/prefetch/");
481 * If old_dst starts with "refs/", then place
482 * sub after that prefix. Otherwise, start at
483 * the beginning of the string.
485 if (!skip_prefix(old_dst, "refs/", &sub))
486 sub = old_dst;
487 strbuf_addstr(&new_dst, sub);
489 rs->items[i].dst = strbuf_detach(&new_dst, NULL);
490 rs->items[i].force = 1;
492 free(old_dst);
496 static struct ref *get_ref_map(struct remote *remote,
497 const struct ref *remote_refs,
498 struct refspec *rs,
499 int tags, int *autotags)
501 int i;
502 struct ref *rm;
503 struct ref *ref_map = NULL;
504 struct ref **tail = &ref_map;
506 /* opportunistically-updated references: */
507 struct ref *orefs = NULL, **oref_tail = &orefs;
509 struct hashmap existing_refs;
510 int existing_refs_populated = 0;
512 filter_prefetch_refspec(rs);
513 if (remote)
514 filter_prefetch_refspec(&remote->fetch);
516 if (rs->nr) {
517 struct refspec *fetch_refspec;
519 for (i = 0; i < rs->nr; i++) {
520 get_fetch_map(remote_refs, &rs->items[i], &tail, 0);
521 if (rs->items[i].dst && rs->items[i].dst[0])
522 *autotags = 1;
524 /* Merge everything on the command line (but not --tags) */
525 for (rm = ref_map; rm; rm = rm->next)
526 rm->fetch_head_status = FETCH_HEAD_MERGE;
529 * For any refs that we happen to be fetching via
530 * command-line arguments, the destination ref might
531 * have been missing or have been different than the
532 * remote-tracking ref that would be derived from the
533 * configured refspec. In these cases, we want to
534 * take the opportunity to update their configured
535 * remote-tracking reference. However, we do not want
536 * to mention these entries in FETCH_HEAD at all, as
537 * they would simply be duplicates of existing
538 * entries, so we set them FETCH_HEAD_IGNORE below.
540 * We compute these entries now, based only on the
541 * refspecs specified on the command line. But we add
542 * them to the list following the refspecs resulting
543 * from the tags option so that one of the latter,
544 * which has FETCH_HEAD_NOT_FOR_MERGE, is not removed
545 * by ref_remove_duplicates() in favor of one of these
546 * opportunistic entries with FETCH_HEAD_IGNORE.
548 if (refmap.nr)
549 fetch_refspec = &refmap;
550 else
551 fetch_refspec = &remote->fetch;
553 for (i = 0; i < fetch_refspec->nr; i++)
554 get_fetch_map(ref_map, &fetch_refspec->items[i], &oref_tail, 1);
555 } else if (refmap.nr) {
556 die("--refmap option is only meaningful with command-line refspec(s)");
557 } else {
558 /* Use the defaults */
559 struct branch *branch = branch_get(NULL);
560 int has_merge = branch_has_merge_config(branch);
561 if (remote &&
562 (remote->fetch.nr ||
563 /* Note: has_merge implies non-NULL branch->remote_name */
564 (has_merge && !strcmp(branch->remote_name, remote->name)))) {
565 for (i = 0; i < remote->fetch.nr; i++) {
566 get_fetch_map(remote_refs, &remote->fetch.items[i], &tail, 0);
567 if (remote->fetch.items[i].dst &&
568 remote->fetch.items[i].dst[0])
569 *autotags = 1;
570 if (!i && !has_merge && ref_map &&
571 !remote->fetch.items[0].pattern)
572 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
575 * if the remote we're fetching from is the same
576 * as given in branch.<name>.remote, we add the
577 * ref given in branch.<name>.merge, too.
579 * Note: has_merge implies non-NULL branch->remote_name
581 if (has_merge &&
582 !strcmp(branch->remote_name, remote->name))
583 add_merge_config(&ref_map, remote_refs, branch, &tail);
584 } else if (!prefetch) {
585 ref_map = get_remote_ref(remote_refs, "HEAD");
586 if (!ref_map)
587 die(_("couldn't find remote ref HEAD"));
588 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
589 tail = &ref_map->next;
593 if (tags == TAGS_SET)
594 /* also fetch all tags */
595 get_fetch_map(remote_refs, tag_refspec, &tail, 0);
596 else if (tags == TAGS_DEFAULT && *autotags)
597 find_non_local_tags(remote_refs, &ref_map, &tail);
599 /* Now append any refs to be updated opportunistically: */
600 *tail = orefs;
601 for (rm = orefs; rm; rm = rm->next) {
602 rm->fetch_head_status = FETCH_HEAD_IGNORE;
603 tail = &rm->next;
607 * apply negative refspecs first, before we remove duplicates. This is
608 * necessary as negative refspecs might remove an otherwise conflicting
609 * duplicate.
611 if (rs->nr)
612 ref_map = apply_negative_refspecs(ref_map, rs);
613 else
614 ref_map = apply_negative_refspecs(ref_map, &remote->fetch);
616 ref_map = ref_remove_duplicates(ref_map);
618 for (rm = ref_map; rm; rm = rm->next) {
619 if (rm->peer_ref) {
620 const char *refname = rm->peer_ref->name;
621 struct refname_hash_entry *peer_item;
622 unsigned int hash = strhash(refname);
624 if (!existing_refs_populated) {
625 refname_hash_init(&existing_refs);
626 for_each_ref(add_one_refname, &existing_refs);
627 existing_refs_populated = 1;
630 peer_item = hashmap_get_entry_from_hash(&existing_refs,
631 hash, refname,
632 struct refname_hash_entry, ent);
633 if (peer_item) {
634 struct object_id *old_oid = &peer_item->oid;
635 oidcpy(&rm->peer_ref->old_oid, old_oid);
639 if (existing_refs_populated)
640 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
642 return ref_map;
645 #define STORE_REF_ERROR_OTHER 1
646 #define STORE_REF_ERROR_DF_CONFLICT 2
648 static int s_update_ref(const char *action,
649 struct ref *ref,
650 struct ref_transaction *transaction,
651 int check_old)
653 char *msg;
654 char *rla = getenv("GIT_REFLOG_ACTION");
655 struct ref_transaction *our_transaction = NULL;
656 struct strbuf err = STRBUF_INIT;
657 int ret;
659 if (dry_run)
660 return 0;
661 if (!rla)
662 rla = default_rla.buf;
663 msg = xstrfmt("%s: %s", rla, action);
666 * If no transaction was passed to us, we manage the transaction
667 * ourselves. Otherwise, we trust the caller to handle the transaction
668 * lifecycle.
670 if (!transaction) {
671 transaction = our_transaction = ref_transaction_begin(&err);
672 if (!transaction) {
673 ret = STORE_REF_ERROR_OTHER;
674 goto out;
678 ret = ref_transaction_update(transaction, ref->name, &ref->new_oid,
679 check_old ? &ref->old_oid : NULL,
680 0, msg, &err);
681 if (ret) {
682 ret = STORE_REF_ERROR_OTHER;
683 goto out;
686 if (our_transaction) {
687 switch (ref_transaction_commit(our_transaction, &err)) {
688 case 0:
689 break;
690 case TRANSACTION_NAME_CONFLICT:
691 ret = STORE_REF_ERROR_DF_CONFLICT;
692 goto out;
693 default:
694 ret = STORE_REF_ERROR_OTHER;
695 goto out;
699 out:
700 ref_transaction_free(our_transaction);
701 if (ret)
702 error("%s", err.buf);
703 strbuf_release(&err);
704 free(msg);
705 return ret;
708 static int refcol_width = 10;
709 static int compact_format;
711 static void adjust_refcol_width(const struct ref *ref)
713 int max, rlen, llen, len;
715 /* uptodate lines are only shown on high verbosity level */
716 if (verbosity <= 0 && oideq(&ref->peer_ref->old_oid, &ref->old_oid))
717 return;
719 max = term_columns();
720 rlen = utf8_strwidth(prettify_refname(ref->name));
722 llen = utf8_strwidth(prettify_refname(ref->peer_ref->name));
725 * rough estimation to see if the output line is too long and
726 * should not be counted (we can't do precise calculation
727 * anyway because we don't know if the error explanation part
728 * will be printed in update_local_ref)
730 if (compact_format) {
731 llen = 0;
732 max = max * 2 / 3;
734 len = 21 /* flag and summary */ + rlen + 4 /* -> */ + llen;
735 if (len >= max)
736 return;
739 * Not precise calculation for compact mode because '*' can
740 * appear on the left hand side of '->' and shrink the column
741 * back.
743 if (refcol_width < rlen)
744 refcol_width = rlen;
747 static void prepare_format_display(struct ref *ref_map)
749 struct ref *rm;
750 const char *format = "full";
752 if (verbosity < 0)
753 return;
755 git_config_get_string_tmp("fetch.output", &format);
756 if (!strcasecmp(format, "full"))
757 compact_format = 0;
758 else if (!strcasecmp(format, "compact"))
759 compact_format = 1;
760 else
761 die(_("configuration fetch.output contains invalid value %s"),
762 format);
764 for (rm = ref_map; rm; rm = rm->next) {
765 if (rm->status == REF_STATUS_REJECT_SHALLOW ||
766 !rm->peer_ref ||
767 !strcmp(rm->name, "HEAD"))
768 continue;
770 adjust_refcol_width(rm);
774 static void print_remote_to_local(struct strbuf *display,
775 const char *remote, const char *local)
777 strbuf_addf(display, "%-*s -> %s", refcol_width, remote, local);
780 static int find_and_replace(struct strbuf *haystack,
781 const char *needle,
782 const char *placeholder)
784 const char *p = NULL;
785 int plen, nlen;
787 nlen = strlen(needle);
788 if (ends_with(haystack->buf, needle))
789 p = haystack->buf + haystack->len - nlen;
790 else
791 p = strstr(haystack->buf, needle);
792 if (!p)
793 return 0;
795 if (p > haystack->buf && p[-1] != '/')
796 return 0;
798 plen = strlen(p);
799 if (plen > nlen && p[nlen] != '/')
800 return 0;
802 strbuf_splice(haystack, p - haystack->buf, nlen,
803 placeholder, strlen(placeholder));
804 return 1;
807 static void print_compact(struct strbuf *display,
808 const char *remote, const char *local)
810 struct strbuf r = STRBUF_INIT;
811 struct strbuf l = STRBUF_INIT;
813 if (!strcmp(remote, local)) {
814 strbuf_addf(display, "%-*s -> *", refcol_width, remote);
815 return;
818 strbuf_addstr(&r, remote);
819 strbuf_addstr(&l, local);
821 if (!find_and_replace(&r, local, "*"))
822 find_and_replace(&l, remote, "*");
823 print_remote_to_local(display, r.buf, l.buf);
825 strbuf_release(&r);
826 strbuf_release(&l);
829 static void format_display(struct strbuf *display, char code,
830 const char *summary, const char *error,
831 const char *remote, const char *local,
832 int summary_width)
834 int width;
836 if (verbosity < 0)
837 return;
839 width = (summary_width + strlen(summary) - gettext_width(summary));
841 strbuf_addf(display, "%c %-*s ", code, width, summary);
842 if (!compact_format)
843 print_remote_to_local(display, remote, local);
844 else
845 print_compact(display, remote, local);
846 if (error)
847 strbuf_addf(display, " (%s)", error);
850 static int update_local_ref(struct ref *ref,
851 struct ref_transaction *transaction,
852 const char *remote, const struct ref *remote_ref,
853 struct strbuf *display, int summary_width,
854 struct worktree **worktrees)
856 struct commit *current = NULL, *updated;
857 const struct worktree *wt;
858 const char *pretty_ref = prettify_refname(ref->name);
859 int fast_forward = 0;
861 if (!repo_has_object_file(the_repository, &ref->new_oid))
862 die(_("object %s not found"), oid_to_hex(&ref->new_oid));
864 if (oideq(&ref->old_oid, &ref->new_oid)) {
865 if (verbosity > 0)
866 format_display(display, '=', _("[up to date]"), NULL,
867 remote, pretty_ref, summary_width);
868 return 0;
871 if (!update_head_ok &&
872 (wt = find_shared_symref(worktrees, "HEAD", ref->name)) &&
873 !wt->is_bare && !is_null_oid(&ref->old_oid)) {
875 * If this is the head, and it's not okay to update
876 * the head, and the old value of the head isn't empty...
878 format_display(display, '!', _("[rejected]"),
879 wt->is_current ?
880 _("can't fetch in current branch") :
881 _("checked out in another worktree"),
882 remote, pretty_ref, summary_width);
883 return 1;
886 if (!is_null_oid(&ref->old_oid) &&
887 starts_with(ref->name, "refs/tags/")) {
888 if (force || ref->force) {
889 int r;
890 r = s_update_ref("updating tag", ref, transaction, 0);
891 format_display(display, r ? '!' : 't', _("[tag update]"),
892 r ? _("unable to update local ref") : NULL,
893 remote, pretty_ref, summary_width);
894 return r;
895 } else {
896 format_display(display, '!', _("[rejected]"), _("would clobber existing tag"),
897 remote, pretty_ref, summary_width);
898 return 1;
902 current = lookup_commit_reference_gently(the_repository,
903 &ref->old_oid, 1);
904 updated = lookup_commit_reference_gently(the_repository,
905 &ref->new_oid, 1);
906 if (!current || !updated) {
907 const char *msg;
908 const char *what;
909 int r;
911 * Nicely describe the new ref we're fetching.
912 * Base this on the remote's ref name, as it's
913 * more likely to follow a standard layout.
915 const char *name = remote_ref ? remote_ref->name : "";
916 if (starts_with(name, "refs/tags/")) {
917 msg = "storing tag";
918 what = _("[new tag]");
919 } else if (starts_with(name, "refs/heads/")) {
920 msg = "storing head";
921 what = _("[new branch]");
922 } else {
923 msg = "storing ref";
924 what = _("[new ref]");
927 r = s_update_ref(msg, ref, transaction, 0);
928 format_display(display, r ? '!' : '*', what,
929 r ? _("unable to update local ref") : NULL,
930 remote, pretty_ref, summary_width);
931 return r;
934 if (fetch_show_forced_updates) {
935 uint64_t t_before = getnanotime();
936 fast_forward = in_merge_bases(current, updated);
937 forced_updates_ms += (getnanotime() - t_before) / 1000000;
938 } else {
939 fast_forward = 1;
942 if (fast_forward) {
943 struct strbuf quickref = STRBUF_INIT;
944 int r;
946 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
947 strbuf_addstr(&quickref, "..");
948 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
949 r = s_update_ref("fast-forward", ref, transaction, 1);
950 format_display(display, r ? '!' : ' ', quickref.buf,
951 r ? _("unable to update local ref") : NULL,
952 remote, pretty_ref, summary_width);
953 strbuf_release(&quickref);
954 return r;
955 } else if (force || ref->force) {
956 struct strbuf quickref = STRBUF_INIT;
957 int r;
958 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
959 strbuf_addstr(&quickref, "...");
960 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
961 r = s_update_ref("forced-update", ref, transaction, 1);
962 format_display(display, r ? '!' : '+', quickref.buf,
963 r ? _("unable to update local ref") : _("forced update"),
964 remote, pretty_ref, summary_width);
965 strbuf_release(&quickref);
966 return r;
967 } else {
968 format_display(display, '!', _("[rejected]"), _("non-fast-forward"),
969 remote, pretty_ref, summary_width);
970 return 1;
974 static const struct object_id *iterate_ref_map(void *cb_data)
976 struct ref **rm = cb_data;
977 struct ref *ref = *rm;
979 while (ref && ref->status == REF_STATUS_REJECT_SHALLOW)
980 ref = ref->next;
981 if (!ref)
982 return NULL;
983 *rm = ref->next;
984 return &ref->old_oid;
987 struct fetch_head {
988 FILE *fp;
989 struct strbuf buf;
992 static int open_fetch_head(struct fetch_head *fetch_head)
994 const char *filename = git_path_fetch_head(the_repository);
996 if (write_fetch_head) {
997 fetch_head->fp = fopen(filename, "a");
998 if (!fetch_head->fp)
999 return error_errno(_("cannot open %s"), filename);
1000 strbuf_init(&fetch_head->buf, 0);
1001 } else {
1002 fetch_head->fp = NULL;
1005 return 0;
1008 static void append_fetch_head(struct fetch_head *fetch_head,
1009 const struct object_id *old_oid,
1010 enum fetch_head_status fetch_head_status,
1011 const char *note,
1012 const char *url, size_t url_len)
1014 char old_oid_hex[GIT_MAX_HEXSZ + 1];
1015 const char *merge_status_marker;
1016 size_t i;
1018 if (!fetch_head->fp)
1019 return;
1021 switch (fetch_head_status) {
1022 case FETCH_HEAD_NOT_FOR_MERGE:
1023 merge_status_marker = "not-for-merge";
1024 break;
1025 case FETCH_HEAD_MERGE:
1026 merge_status_marker = "";
1027 break;
1028 default:
1029 /* do not write anything to FETCH_HEAD */
1030 return;
1033 strbuf_addf(&fetch_head->buf, "%s\t%s\t%s",
1034 oid_to_hex_r(old_oid_hex, old_oid), merge_status_marker, note);
1035 for (i = 0; i < url_len; ++i)
1036 if ('\n' == url[i])
1037 strbuf_addstr(&fetch_head->buf, "\\n");
1038 else
1039 strbuf_addch(&fetch_head->buf, url[i]);
1040 strbuf_addch(&fetch_head->buf, '\n');
1043 * When using an atomic fetch, we do not want to update FETCH_HEAD if
1044 * any of the reference updates fails. We thus have to write all
1045 * updates to a buffer first and only commit it as soon as all
1046 * references have been successfully updated.
1048 if (!atomic_fetch) {
1049 strbuf_write(&fetch_head->buf, fetch_head->fp);
1050 strbuf_reset(&fetch_head->buf);
1054 static void commit_fetch_head(struct fetch_head *fetch_head)
1056 if (!fetch_head->fp || !atomic_fetch)
1057 return;
1058 strbuf_write(&fetch_head->buf, fetch_head->fp);
1061 static void close_fetch_head(struct fetch_head *fetch_head)
1063 if (!fetch_head->fp)
1064 return;
1066 fclose(fetch_head->fp);
1067 strbuf_release(&fetch_head->buf);
1070 static const char warn_show_forced_updates[] =
1071 N_("fetch normally indicates which branches had a forced update,\n"
1072 "but that check has been disabled; to re-enable, use '--show-forced-updates'\n"
1073 "flag or run 'git config fetch.showForcedUpdates true'");
1074 static const char warn_time_show_forced_updates[] =
1075 N_("it took %.2f seconds to check forced updates; you can use\n"
1076 "'--no-show-forced-updates' or run 'git config fetch.showForcedUpdates false'\n"
1077 "to avoid this check\n");
1079 static int store_updated_refs(const char *raw_url, const char *remote_name,
1080 int connectivity_checked, struct ref *ref_map,
1081 struct worktree **worktrees)
1083 struct fetch_head fetch_head;
1084 int url_len, i, rc = 0;
1085 struct strbuf note = STRBUF_INIT, err = STRBUF_INIT;
1086 struct ref_transaction *transaction = NULL;
1087 const char *what, *kind;
1088 struct ref *rm;
1089 char *url;
1090 int want_status;
1091 int summary_width = transport_summary_width(ref_map);
1093 rc = open_fetch_head(&fetch_head);
1094 if (rc)
1095 return -1;
1097 if (raw_url)
1098 url = transport_anonymize_url(raw_url);
1099 else
1100 url = xstrdup("foreign");
1102 if (!connectivity_checked) {
1103 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1105 rm = ref_map;
1106 if (check_connected(iterate_ref_map, &rm, &opt)) {
1107 rc = error(_("%s did not send all necessary objects\n"), url);
1108 goto abort;
1112 if (atomic_fetch) {
1113 transaction = ref_transaction_begin(&err);
1114 if (!transaction) {
1115 error("%s", err.buf);
1116 goto abort;
1120 prepare_format_display(ref_map);
1123 * We do a pass for each fetch_head_status type in their enum order, so
1124 * merged entries are written before not-for-merge. That lets readers
1125 * use FETCH_HEAD as a refname to refer to the ref to be merged.
1127 for (want_status = FETCH_HEAD_MERGE;
1128 want_status <= FETCH_HEAD_IGNORE;
1129 want_status++) {
1130 for (rm = ref_map; rm; rm = rm->next) {
1131 struct commit *commit = NULL;
1132 struct ref *ref = NULL;
1134 if (rm->status == REF_STATUS_REJECT_SHALLOW) {
1135 if (want_status == FETCH_HEAD_MERGE)
1136 warning(_("rejected %s because shallow roots are not allowed to be updated"),
1137 rm->peer_ref ? rm->peer_ref->name : rm->name);
1138 continue;
1142 * References in "refs/tags/" are often going to point
1143 * to annotated tags, which are not part of the
1144 * commit-graph. We thus only try to look up refs in
1145 * the graph which are not in that namespace to not
1146 * regress performance in repositories with many
1147 * annotated tags.
1149 if (!starts_with(rm->name, "refs/tags/"))
1150 commit = lookup_commit_in_graph(the_repository, &rm->old_oid);
1151 if (!commit) {
1152 commit = lookup_commit_reference_gently(the_repository,
1153 &rm->old_oid,
1155 if (!commit)
1156 rm->fetch_head_status = FETCH_HEAD_NOT_FOR_MERGE;
1159 if (rm->fetch_head_status != want_status)
1160 continue;
1162 if (rm->peer_ref) {
1163 ref = alloc_ref(rm->peer_ref->name);
1164 oidcpy(&ref->old_oid, &rm->peer_ref->old_oid);
1165 oidcpy(&ref->new_oid, &rm->old_oid);
1166 ref->force = rm->peer_ref->force;
1169 if (recurse_submodules != RECURSE_SUBMODULES_OFF &&
1170 (!rm->peer_ref || !oideq(&ref->old_oid, &ref->new_oid))) {
1171 check_for_new_submodule_commits(&rm->old_oid);
1174 if (!strcmp(rm->name, "HEAD")) {
1175 kind = "";
1176 what = "";
1178 else if (skip_prefix(rm->name, "refs/heads/", &what))
1179 kind = "branch";
1180 else if (skip_prefix(rm->name, "refs/tags/", &what))
1181 kind = "tag";
1182 else if (skip_prefix(rm->name, "refs/remotes/", &what))
1183 kind = "remote-tracking branch";
1184 else {
1185 kind = "";
1186 what = rm->name;
1189 url_len = strlen(url);
1190 for (i = url_len - 1; url[i] == '/' && 0 <= i; i--)
1192 url_len = i + 1;
1193 if (4 < i && !strncmp(".git", url + i - 3, 4))
1194 url_len = i - 3;
1196 strbuf_reset(&note);
1197 if (*what) {
1198 if (*kind)
1199 strbuf_addf(&note, "%s ", kind);
1200 strbuf_addf(&note, "'%s' of ", what);
1203 append_fetch_head(&fetch_head, &rm->old_oid,
1204 rm->fetch_head_status,
1205 note.buf, url, url_len);
1207 strbuf_reset(&note);
1208 if (ref) {
1209 rc |= update_local_ref(ref, transaction, what,
1210 rm, &note, summary_width,
1211 worktrees);
1212 free(ref);
1213 } else if (write_fetch_head || dry_run) {
1215 * Display fetches written to FETCH_HEAD (or
1216 * would be written to FETCH_HEAD, if --dry-run
1217 * is set).
1219 format_display(&note, '*',
1220 *kind ? kind : "branch", NULL,
1221 *what ? what : "HEAD",
1222 "FETCH_HEAD", summary_width);
1224 if (note.len) {
1225 if (!shown_url) {
1226 fprintf(stderr, _("From %.*s\n"),
1227 url_len, url);
1228 shown_url = 1;
1230 fprintf(stderr, " %s\n", note.buf);
1235 if (!rc && transaction) {
1236 rc = ref_transaction_commit(transaction, &err);
1237 if (rc) {
1238 error("%s", err.buf);
1239 goto abort;
1243 if (!rc)
1244 commit_fetch_head(&fetch_head);
1246 if (rc & STORE_REF_ERROR_DF_CONFLICT)
1247 error(_("some local refs could not be updated; try running\n"
1248 " 'git remote prune %s' to remove any old, conflicting "
1249 "branches"), remote_name);
1251 if (advice_enabled(ADVICE_FETCH_SHOW_FORCED_UPDATES)) {
1252 if (!fetch_show_forced_updates) {
1253 warning(_(warn_show_forced_updates));
1254 } else if (forced_updates_ms > FORCED_UPDATES_DELAY_WARNING_IN_MS) {
1255 warning(_(warn_time_show_forced_updates),
1256 forced_updates_ms / 1000.0);
1260 abort:
1261 strbuf_release(&note);
1262 strbuf_release(&err);
1263 ref_transaction_free(transaction);
1264 free(url);
1265 close_fetch_head(&fetch_head);
1266 return rc;
1270 * We would want to bypass the object transfer altogether if
1271 * everything we are going to fetch already exists and is connected
1272 * locally.
1274 static int check_exist_and_connected(struct ref *ref_map)
1276 struct ref *rm = ref_map;
1277 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1278 struct ref *r;
1281 * If we are deepening a shallow clone we already have these
1282 * objects reachable. Running rev-list here will return with
1283 * a good (0) exit status and we'll bypass the fetch that we
1284 * really need to perform. Claiming failure now will ensure
1285 * we perform the network exchange to deepen our history.
1287 if (deepen)
1288 return -1;
1291 * check_connected() allows objects to merely be promised, but
1292 * we need all direct targets to exist.
1294 for (r = rm; r; r = r->next) {
1295 if (!has_object_file_with_flags(&r->old_oid,
1296 OBJECT_INFO_SKIP_FETCH_OBJECT))
1297 return -1;
1300 opt.quiet = 1;
1301 return check_connected(iterate_ref_map, &rm, &opt);
1304 static int fetch_and_consume_refs(struct transport *transport,
1305 struct ref *ref_map,
1306 struct worktree **worktrees)
1308 int connectivity_checked = 1;
1309 int ret;
1312 * We don't need to perform a fetch in case we can already satisfy all
1313 * refs.
1315 ret = check_exist_and_connected(ref_map);
1316 if (ret) {
1317 trace2_region_enter("fetch", "fetch_refs", the_repository);
1318 ret = transport_fetch_refs(transport, ref_map);
1319 trace2_region_leave("fetch", "fetch_refs", the_repository);
1320 if (ret)
1321 goto out;
1322 connectivity_checked = transport->smart_options ?
1323 transport->smart_options->connectivity_checked : 0;
1326 trace2_region_enter("fetch", "consume_refs", the_repository);
1327 ret = store_updated_refs(transport->url, transport->remote->name,
1328 connectivity_checked, ref_map, worktrees);
1329 trace2_region_leave("fetch", "consume_refs", the_repository);
1331 out:
1332 transport_unlock_pack(transport);
1333 return ret;
1336 static int prune_refs(struct refspec *rs, struct ref *ref_map,
1337 const char *raw_url)
1339 int url_len, i, result = 0;
1340 struct ref *ref, *stale_refs = get_stale_heads(rs, ref_map);
1341 char *url;
1342 int summary_width = transport_summary_width(stale_refs);
1343 const char *dangling_msg = dry_run
1344 ? _(" (%s will become dangling)")
1345 : _(" (%s has become dangling)");
1347 if (raw_url)
1348 url = transport_anonymize_url(raw_url);
1349 else
1350 url = xstrdup("foreign");
1352 url_len = strlen(url);
1353 for (i = url_len - 1; url[i] == '/' && 0 <= i; i--)
1356 url_len = i + 1;
1357 if (4 < i && !strncmp(".git", url + i - 3, 4))
1358 url_len = i - 3;
1360 if (!dry_run) {
1361 struct string_list refnames = STRING_LIST_INIT_NODUP;
1363 for (ref = stale_refs; ref; ref = ref->next)
1364 string_list_append(&refnames, ref->name);
1366 result = delete_refs("fetch: prune", &refnames, 0);
1367 string_list_clear(&refnames, 0);
1370 if (verbosity >= 0) {
1371 for (ref = stale_refs; ref; ref = ref->next) {
1372 struct strbuf sb = STRBUF_INIT;
1373 if (!shown_url) {
1374 fprintf(stderr, _("From %.*s\n"), url_len, url);
1375 shown_url = 1;
1377 format_display(&sb, '-', _("[deleted]"), NULL,
1378 _("(none)"), prettify_refname(ref->name),
1379 summary_width);
1380 fprintf(stderr, " %s\n",sb.buf);
1381 strbuf_release(&sb);
1382 warn_dangling_symref(stderr, dangling_msg, ref->name);
1386 free(url);
1387 free_refs(stale_refs);
1388 return result;
1391 static void check_not_current_branch(struct ref *ref_map,
1392 struct worktree **worktrees)
1394 const struct worktree *wt;
1395 for (; ref_map; ref_map = ref_map->next)
1396 if (ref_map->peer_ref &&
1397 (wt = find_shared_symref(worktrees, "HEAD",
1398 ref_map->peer_ref->name)) &&
1399 !wt->is_bare)
1400 die(_("refusing to fetch into branch '%s' "
1401 "checked out at '%s'"),
1402 ref_map->peer_ref->name, wt->path);
1405 static int truncate_fetch_head(void)
1407 const char *filename = git_path_fetch_head(the_repository);
1408 FILE *fp = fopen_for_writing(filename);
1410 if (!fp)
1411 return error_errno(_("cannot open %s"), filename);
1412 fclose(fp);
1413 return 0;
1416 static void set_option(struct transport *transport, const char *name, const char *value)
1418 int r = transport_set_option(transport, name, value);
1419 if (r < 0)
1420 die(_("option \"%s\" value \"%s\" is not valid for %s"),
1421 name, value, transport->url);
1422 if (r > 0)
1423 warning(_("option \"%s\" is ignored for %s\n"),
1424 name, transport->url);
1428 static int add_oid(const char *refname, const struct object_id *oid, int flags,
1429 void *cb_data)
1431 struct oid_array *oids = cb_data;
1433 oid_array_append(oids, oid);
1434 return 0;
1437 static void add_negotiation_tips(struct git_transport_options *smart_options)
1439 struct oid_array *oids = xcalloc(1, sizeof(*oids));
1440 int i;
1442 for (i = 0; i < negotiation_tip.nr; i++) {
1443 const char *s = negotiation_tip.items[i].string;
1444 int old_nr;
1445 if (!has_glob_specials(s)) {
1446 struct object_id oid;
1447 if (get_oid(s, &oid))
1448 die(_("%s is not a valid object"), s);
1449 if (!has_object(the_repository, &oid, 0))
1450 die(_("the object %s does not exist"), s);
1451 oid_array_append(oids, &oid);
1452 continue;
1454 old_nr = oids->nr;
1455 for_each_glob_ref(add_oid, s, oids);
1456 if (old_nr == oids->nr)
1457 warning("ignoring --negotiation-tip=%s because it does not match any refs",
1460 smart_options->negotiation_tips = oids;
1463 static struct transport *prepare_transport(struct remote *remote, int deepen)
1465 struct transport *transport;
1467 transport = transport_get(remote, NULL);
1468 transport_set_verbosity(transport, verbosity, progress);
1469 transport->family = family;
1470 if (upload_pack)
1471 set_option(transport, TRANS_OPT_UPLOADPACK, upload_pack);
1472 if (keep)
1473 set_option(transport, TRANS_OPT_KEEP, "yes");
1474 if (depth)
1475 set_option(transport, TRANS_OPT_DEPTH, depth);
1476 if (deepen && deepen_since)
1477 set_option(transport, TRANS_OPT_DEEPEN_SINCE, deepen_since);
1478 if (deepen && deepen_not.nr)
1479 set_option(transport, TRANS_OPT_DEEPEN_NOT,
1480 (const char *)&deepen_not);
1481 if (deepen_relative)
1482 set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, "yes");
1483 if (update_shallow)
1484 set_option(transport, TRANS_OPT_UPDATE_SHALLOW, "yes");
1485 if (filter_options.choice) {
1486 const char *spec =
1487 expand_list_objects_filter_spec(&filter_options);
1488 set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER, spec);
1489 set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1491 if (negotiation_tip.nr) {
1492 if (transport->smart_options)
1493 add_negotiation_tips(transport->smart_options);
1494 else
1495 warning("ignoring --negotiation-tip because the protocol does not support it");
1497 return transport;
1500 static void backfill_tags(struct transport *transport, struct ref *ref_map,
1501 struct worktree **worktrees)
1503 int cannot_reuse;
1506 * Once we have set TRANS_OPT_DEEPEN_SINCE, we can't unset it
1507 * when remote helper is used (setting it to an empty string
1508 * is not unsetting). We could extend the remote helper
1509 * protocol for that, but for now, just force a new connection
1510 * without deepen-since. Similar story for deepen-not.
1512 cannot_reuse = transport->cannot_reuse ||
1513 deepen_since || deepen_not.nr;
1514 if (cannot_reuse) {
1515 gsecondary = prepare_transport(transport->remote, 0);
1516 transport = gsecondary;
1519 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, NULL);
1520 transport_set_option(transport, TRANS_OPT_DEPTH, "0");
1521 transport_set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, NULL);
1522 fetch_and_consume_refs(transport, ref_map, worktrees);
1524 if (gsecondary) {
1525 transport_disconnect(gsecondary);
1526 gsecondary = NULL;
1530 static int do_fetch(struct transport *transport,
1531 struct refspec *rs)
1533 struct ref *ref_map;
1534 int autotags = (transport->remote->fetch_tags == 1);
1535 int retcode = 0;
1536 const struct ref *remote_refs;
1537 struct transport_ls_refs_options transport_ls_refs_options =
1538 TRANSPORT_LS_REFS_OPTIONS_INIT;
1539 int must_list_refs = 1;
1540 struct worktree **worktrees = get_worktrees();
1542 if (tags == TAGS_DEFAULT) {
1543 if (transport->remote->fetch_tags == 2)
1544 tags = TAGS_SET;
1545 if (transport->remote->fetch_tags == -1)
1546 tags = TAGS_UNSET;
1549 /* if not appending, truncate FETCH_HEAD */
1550 if (!append && write_fetch_head) {
1551 retcode = truncate_fetch_head();
1552 if (retcode)
1553 goto cleanup;
1556 if (rs->nr) {
1557 int i;
1559 refspec_ref_prefixes(rs, &transport_ls_refs_options.ref_prefixes);
1562 * We can avoid listing refs if all of them are exact
1563 * OIDs
1565 must_list_refs = 0;
1566 for (i = 0; i < rs->nr; i++) {
1567 if (!rs->items[i].exact_sha1) {
1568 must_list_refs = 1;
1569 break;
1572 } else if (transport->remote && transport->remote->fetch.nr)
1573 refspec_ref_prefixes(&transport->remote->fetch,
1574 &transport_ls_refs_options.ref_prefixes);
1576 if (tags == TAGS_SET || tags == TAGS_DEFAULT) {
1577 must_list_refs = 1;
1578 if (transport_ls_refs_options.ref_prefixes.nr)
1579 strvec_push(&transport_ls_refs_options.ref_prefixes,
1580 "refs/tags/");
1583 if (must_list_refs) {
1584 trace2_region_enter("fetch", "remote_refs", the_repository);
1585 remote_refs = transport_get_remote_refs(transport,
1586 &transport_ls_refs_options);
1587 trace2_region_leave("fetch", "remote_refs", the_repository);
1588 } else
1589 remote_refs = NULL;
1591 strvec_clear(&transport_ls_refs_options.ref_prefixes);
1593 ref_map = get_ref_map(transport->remote, remote_refs, rs,
1594 tags, &autotags);
1595 if (!update_head_ok)
1596 check_not_current_branch(ref_map, worktrees);
1598 if (tags == TAGS_DEFAULT && autotags)
1599 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1600 if (prune) {
1602 * We only prune based on refspecs specified
1603 * explicitly (via command line or configuration); we
1604 * don't care whether --tags was specified.
1606 if (rs->nr) {
1607 prune_refs(rs, ref_map, transport->url);
1608 } else {
1609 prune_refs(&transport->remote->fetch,
1610 ref_map,
1611 transport->url);
1614 if (fetch_and_consume_refs(transport, ref_map, worktrees)) {
1615 free_refs(ref_map);
1616 retcode = 1;
1617 goto cleanup;
1620 if (set_upstream) {
1621 struct branch *branch = branch_get("HEAD");
1622 struct ref *rm;
1623 struct ref *source_ref = NULL;
1626 * We're setting the upstream configuration for the
1627 * current branch. The relevant upstream is the
1628 * fetched branch that is meant to be merged with the
1629 * current one, i.e. the one fetched to FETCH_HEAD.
1631 * When there are several such branches, consider the
1632 * request ambiguous and err on the safe side by doing
1633 * nothing and just emit a warning.
1635 for (rm = ref_map; rm; rm = rm->next) {
1636 if (!rm->peer_ref) {
1637 if (source_ref) {
1638 warning(_("multiple branches detected, incompatible with --set-upstream"));
1639 goto skip;
1640 } else {
1641 source_ref = rm;
1645 if (source_ref) {
1646 if (!branch) {
1647 const char *shortname = source_ref->name;
1648 skip_prefix(shortname, "refs/heads/", &shortname);
1650 warning(_("could not set upstream of HEAD to '%s' from '%s' when "
1651 "it does not point to any branch."),
1652 shortname, transport->remote->name);
1653 goto skip;
1656 if (!strcmp(source_ref->name, "HEAD") ||
1657 starts_with(source_ref->name, "refs/heads/"))
1658 install_branch_config(0,
1659 branch->name,
1660 transport->remote->name,
1661 source_ref->name);
1662 else if (starts_with(source_ref->name, "refs/remotes/"))
1663 warning(_("not setting upstream for a remote remote-tracking branch"));
1664 else if (starts_with(source_ref->name, "refs/tags/"))
1665 warning(_("not setting upstream for a remote tag"));
1666 else
1667 warning(_("unknown branch type"));
1668 } else {
1669 warning(_("no source branch found;\n"
1670 "you need to specify exactly one branch with the --set-upstream option"));
1673 skip:
1674 free_refs(ref_map);
1676 /* if neither --no-tags nor --tags was specified, do automated tag
1677 * following ... */
1678 if (tags == TAGS_DEFAULT && autotags) {
1679 struct ref **tail = &ref_map;
1680 ref_map = NULL;
1681 find_non_local_tags(remote_refs, &ref_map, &tail);
1682 if (ref_map)
1683 backfill_tags(transport, ref_map, worktrees);
1684 free_refs(ref_map);
1687 cleanup:
1688 free_worktrees(worktrees);
1689 return retcode;
1692 static int get_one_remote_for_fetch(struct remote *remote, void *priv)
1694 struct string_list *list = priv;
1695 if (!remote->skip_default_update)
1696 string_list_append(list, remote->name);
1697 return 0;
1700 struct remote_group_data {
1701 const char *name;
1702 struct string_list *list;
1705 static int get_remote_group(const char *key, const char *value, void *priv)
1707 struct remote_group_data *g = priv;
1709 if (skip_prefix(key, "remotes.", &key) && !strcmp(key, g->name)) {
1710 /* split list by white space */
1711 while (*value) {
1712 size_t wordlen = strcspn(value, " \t\n");
1714 if (wordlen >= 1)
1715 string_list_append_nodup(g->list,
1716 xstrndup(value, wordlen));
1717 value += wordlen + (value[wordlen] != '\0');
1721 return 0;
1724 static int add_remote_or_group(const char *name, struct string_list *list)
1726 int prev_nr = list->nr;
1727 struct remote_group_data g;
1728 g.name = name; g.list = list;
1730 git_config(get_remote_group, &g);
1731 if (list->nr == prev_nr) {
1732 struct remote *remote = remote_get(name);
1733 if (!remote_is_configured(remote, 0))
1734 return 0;
1735 string_list_append(list, remote->name);
1737 return 1;
1740 static void add_options_to_argv(struct strvec *argv)
1742 if (dry_run)
1743 strvec_push(argv, "--dry-run");
1744 if (prune != -1)
1745 strvec_push(argv, prune ? "--prune" : "--no-prune");
1746 if (prune_tags != -1)
1747 strvec_push(argv, prune_tags ? "--prune-tags" : "--no-prune-tags");
1748 if (update_head_ok)
1749 strvec_push(argv, "--update-head-ok");
1750 if (force)
1751 strvec_push(argv, "--force");
1752 if (keep)
1753 strvec_push(argv, "--keep");
1754 if (recurse_submodules == RECURSE_SUBMODULES_ON)
1755 strvec_push(argv, "--recurse-submodules");
1756 else if (recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND)
1757 strvec_push(argv, "--recurse-submodules=on-demand");
1758 if (tags == TAGS_SET)
1759 strvec_push(argv, "--tags");
1760 else if (tags == TAGS_UNSET)
1761 strvec_push(argv, "--no-tags");
1762 if (verbosity >= 2)
1763 strvec_push(argv, "-v");
1764 if (verbosity >= 1)
1765 strvec_push(argv, "-v");
1766 else if (verbosity < 0)
1767 strvec_push(argv, "-q");
1768 if (family == TRANSPORT_FAMILY_IPV4)
1769 strvec_push(argv, "--ipv4");
1770 else if (family == TRANSPORT_FAMILY_IPV6)
1771 strvec_push(argv, "--ipv6");
1774 /* Fetch multiple remotes in parallel */
1776 struct parallel_fetch_state {
1777 const char **argv;
1778 struct string_list *remotes;
1779 int next, result;
1782 static int fetch_next_remote(struct child_process *cp, struct strbuf *out,
1783 void *cb, void **task_cb)
1785 struct parallel_fetch_state *state = cb;
1786 char *remote;
1788 if (state->next < 0 || state->next >= state->remotes->nr)
1789 return 0;
1791 remote = state->remotes->items[state->next++].string;
1792 *task_cb = remote;
1794 strvec_pushv(&cp->args, state->argv);
1795 strvec_push(&cp->args, remote);
1796 cp->git_cmd = 1;
1798 if (verbosity >= 0)
1799 printf(_("Fetching %s\n"), remote);
1801 return 1;
1804 static int fetch_failed_to_start(struct strbuf *out, void *cb, void *task_cb)
1806 struct parallel_fetch_state *state = cb;
1807 const char *remote = task_cb;
1809 state->result = error(_("could not fetch %s"), remote);
1811 return 0;
1814 static int fetch_finished(int result, struct strbuf *out,
1815 void *cb, void *task_cb)
1817 struct parallel_fetch_state *state = cb;
1818 const char *remote = task_cb;
1820 if (result) {
1821 strbuf_addf(out, _("could not fetch '%s' (exit code: %d)\n"),
1822 remote, result);
1823 state->result = -1;
1826 return 0;
1829 static int fetch_multiple(struct string_list *list, int max_children)
1831 int i, result = 0;
1832 struct strvec argv = STRVEC_INIT;
1834 if (!append && write_fetch_head) {
1835 int errcode = truncate_fetch_head();
1836 if (errcode)
1837 return errcode;
1840 strvec_pushl(&argv, "fetch", "--append", "--no-auto-gc",
1841 "--no-write-commit-graph", NULL);
1842 add_options_to_argv(&argv);
1844 if (max_children != 1 && list->nr != 1) {
1845 struct parallel_fetch_state state = { argv.v, list, 0, 0 };
1847 strvec_push(&argv, "--end-of-options");
1848 result = run_processes_parallel_tr2(max_children,
1849 &fetch_next_remote,
1850 &fetch_failed_to_start,
1851 &fetch_finished,
1852 &state,
1853 "fetch", "parallel/fetch");
1855 if (!result)
1856 result = state.result;
1857 } else
1858 for (i = 0; i < list->nr; i++) {
1859 const char *name = list->items[i].string;
1860 strvec_push(&argv, name);
1861 if (verbosity >= 0)
1862 printf(_("Fetching %s\n"), name);
1863 if (run_command_v_opt(argv.v, RUN_GIT_CMD)) {
1864 error(_("could not fetch %s"), name);
1865 result = 1;
1867 strvec_pop(&argv);
1870 strvec_clear(&argv);
1871 return !!result;
1875 * Fetching from the promisor remote should use the given filter-spec
1876 * or inherit the default filter-spec from the config.
1878 static inline void fetch_one_setup_partial(struct remote *remote)
1881 * Explicit --no-filter argument overrides everything, regardless
1882 * of any prior partial clones and fetches.
1884 if (filter_options.no_filter)
1885 return;
1888 * If no prior partial clone/fetch and the current fetch DID NOT
1889 * request a partial-fetch, do a normal fetch.
1891 if (!has_promisor_remote() && !filter_options.choice)
1892 return;
1895 * If this is a partial-fetch request, we enable partial on
1896 * this repo if not already enabled and remember the given
1897 * filter-spec as the default for subsequent fetches to this
1898 * remote if there is currently no default filter-spec.
1900 if (filter_options.choice) {
1901 partial_clone_register(remote->name, &filter_options);
1902 return;
1906 * Do a partial-fetch from the promisor remote using either the
1907 * explicitly given filter-spec or inherit the filter-spec from
1908 * the config.
1910 if (!filter_options.choice)
1911 partial_clone_get_default_filter_spec(&filter_options, remote->name);
1912 return;
1915 static int fetch_one(struct remote *remote, int argc, const char **argv,
1916 int prune_tags_ok, int use_stdin_refspecs)
1918 struct refspec rs = REFSPEC_INIT_FETCH;
1919 int i;
1920 int exit_code;
1921 int maybe_prune_tags;
1922 int remote_via_config = remote_is_configured(remote, 0);
1924 if (!remote)
1925 die(_("no remote repository specified; please specify either a URL or a\n"
1926 "remote name from which new revisions should be fetched"));
1928 gtransport = prepare_transport(remote, 1);
1930 if (prune < 0) {
1931 /* no command line request */
1932 if (0 <= remote->prune)
1933 prune = remote->prune;
1934 else if (0 <= fetch_prune_config)
1935 prune = fetch_prune_config;
1936 else
1937 prune = PRUNE_BY_DEFAULT;
1940 if (prune_tags < 0) {
1941 /* no command line request */
1942 if (0 <= remote->prune_tags)
1943 prune_tags = remote->prune_tags;
1944 else if (0 <= fetch_prune_tags_config)
1945 prune_tags = fetch_prune_tags_config;
1946 else
1947 prune_tags = PRUNE_TAGS_BY_DEFAULT;
1950 maybe_prune_tags = prune_tags_ok && prune_tags;
1951 if (maybe_prune_tags && remote_via_config)
1952 refspec_append(&remote->fetch, TAG_REFSPEC);
1954 if (maybe_prune_tags && (argc || !remote_via_config))
1955 refspec_append(&rs, TAG_REFSPEC);
1957 for (i = 0; i < argc; i++) {
1958 if (!strcmp(argv[i], "tag")) {
1959 i++;
1960 if (i >= argc)
1961 die(_("you need to specify a tag name"));
1963 refspec_appendf(&rs, "refs/tags/%s:refs/tags/%s",
1964 argv[i], argv[i]);
1965 } else {
1966 refspec_append(&rs, argv[i]);
1970 if (use_stdin_refspecs) {
1971 struct strbuf line = STRBUF_INIT;
1972 while (strbuf_getline_lf(&line, stdin) != EOF)
1973 refspec_append(&rs, line.buf);
1974 strbuf_release(&line);
1977 if (server_options.nr)
1978 gtransport->server_options = &server_options;
1980 sigchain_push_common(unlock_pack_on_signal);
1981 atexit(unlock_pack);
1982 sigchain_push(SIGPIPE, SIG_IGN);
1983 exit_code = do_fetch(gtransport, &rs);
1984 sigchain_pop(SIGPIPE);
1985 refspec_clear(&rs);
1986 transport_disconnect(gtransport);
1987 gtransport = NULL;
1988 return exit_code;
1991 int cmd_fetch(int argc, const char **argv, const char *prefix)
1993 int i;
1994 struct string_list list = STRING_LIST_INIT_DUP;
1995 struct remote *remote = NULL;
1996 int result = 0;
1997 int prune_tags_ok = 1;
1999 packet_trace_identity("fetch");
2001 /* Record the command line for the reflog */
2002 strbuf_addstr(&default_rla, "fetch");
2003 for (i = 1; i < argc; i++) {
2004 /* This handles non-URLs gracefully */
2005 char *anon = transport_anonymize_url(argv[i]);
2007 strbuf_addf(&default_rla, " %s", anon);
2008 free(anon);
2011 git_config(git_fetch_config, NULL);
2012 prepare_repo_settings(the_repository);
2013 the_repository->settings.command_requires_full_index = 0;
2015 argc = parse_options(argc, argv, prefix,
2016 builtin_fetch_options, builtin_fetch_usage, 0);
2017 if (recurse_submodules != RECURSE_SUBMODULES_OFF) {
2018 int *sfjc = submodule_fetch_jobs_config == -1
2019 ? &submodule_fetch_jobs_config : NULL;
2020 int *rs = recurse_submodules == RECURSE_SUBMODULES_DEFAULT
2021 ? &recurse_submodules : NULL;
2023 fetch_config_from_gitmodules(sfjc, rs);
2026 if (negotiate_only && !negotiation_tip.nr)
2027 die(_("--negotiate-only needs one or more --negotiate-tip=*"));
2029 if (deepen_relative) {
2030 if (deepen_relative < 0)
2031 die(_("negative depth in --deepen is not supported"));
2032 if (depth)
2033 die(_("--deepen and --depth are mutually exclusive"));
2034 depth = xstrfmt("%d", deepen_relative);
2036 if (unshallow) {
2037 if (depth)
2038 die(_("--depth and --unshallow cannot be used together"));
2039 else if (!is_repository_shallow(the_repository))
2040 die(_("--unshallow on a complete repository does not make sense"));
2041 else
2042 depth = xstrfmt("%d", INFINITE_DEPTH);
2045 /* no need to be strict, transport_set_option() will validate it again */
2046 if (depth && atoi(depth) < 1)
2047 die(_("depth %s is not a positive number"), depth);
2048 if (depth || deepen_since || deepen_not.nr)
2049 deepen = 1;
2051 /* FETCH_HEAD never gets updated in --dry-run mode */
2052 if (dry_run)
2053 write_fetch_head = 0;
2055 if (all) {
2056 if (argc == 1)
2057 die(_("fetch --all does not take a repository argument"));
2058 else if (argc > 1)
2059 die(_("fetch --all does not make sense with refspecs"));
2060 (void) for_each_remote(get_one_remote_for_fetch, &list);
2061 } else if (argc == 0) {
2062 /* No arguments -- use default remote */
2063 remote = remote_get(NULL);
2064 } else if (multiple) {
2065 /* All arguments are assumed to be remotes or groups */
2066 for (i = 0; i < argc; i++)
2067 if (!add_remote_or_group(argv[i], &list))
2068 die(_("no such remote or remote group: %s"),
2069 argv[i]);
2070 } else {
2071 /* Single remote or group */
2072 (void) add_remote_or_group(argv[0], &list);
2073 if (list.nr > 1) {
2074 /* More than one remote */
2075 if (argc > 1)
2076 die(_("fetching a group and specifying refspecs does not make sense"));
2077 } else {
2078 /* Zero or one remotes */
2079 remote = remote_get(argv[0]);
2080 prune_tags_ok = (argc == 1);
2081 argc--;
2082 argv++;
2086 if (negotiate_only) {
2087 struct oidset acked_commits = OIDSET_INIT;
2088 struct oidset_iter iter;
2089 const struct object_id *oid;
2091 if (!remote)
2092 die(_("must supply remote when using --negotiate-only"));
2093 gtransport = prepare_transport(remote, 1);
2094 if (gtransport->smart_options) {
2095 gtransport->smart_options->acked_commits = &acked_commits;
2096 } else {
2097 warning(_("protocol does not support --negotiate-only, exiting"));
2098 return 1;
2100 if (server_options.nr)
2101 gtransport->server_options = &server_options;
2102 result = transport_fetch_refs(gtransport, NULL);
2104 oidset_iter_init(&acked_commits, &iter);
2105 while ((oid = oidset_iter_next(&iter)))
2106 printf("%s\n", oid_to_hex(oid));
2107 oidset_clear(&acked_commits);
2108 } else if (remote) {
2109 if (filter_options.choice || has_promisor_remote())
2110 fetch_one_setup_partial(remote);
2111 result = fetch_one(remote, argc, argv, prune_tags_ok, stdin_refspecs);
2112 } else {
2113 int max_children = max_jobs;
2115 if (filter_options.choice)
2116 die(_("--filter can only be used with the remote "
2117 "configured in extensions.partialclone"));
2119 if (atomic_fetch)
2120 die(_("--atomic can only be used when fetching "
2121 "from one remote"));
2123 if (stdin_refspecs)
2124 die(_("--stdin can only be used when fetching "
2125 "from one remote"));
2127 if (max_children < 0)
2128 max_children = fetch_parallel_config;
2130 /* TODO should this also die if we have a previous partial-clone? */
2131 result = fetch_multiple(&list, max_children);
2134 if (!result && (recurse_submodules != RECURSE_SUBMODULES_OFF)) {
2135 struct strvec options = STRVEC_INIT;
2136 int max_children = max_jobs;
2138 if (max_children < 0)
2139 max_children = submodule_fetch_jobs_config;
2140 if (max_children < 0)
2141 max_children = fetch_parallel_config;
2143 add_options_to_argv(&options);
2144 result = fetch_populated_submodules(the_repository,
2145 &options,
2146 submodule_prefix,
2147 recurse_submodules,
2148 recurse_submodules_default,
2149 verbosity < 0,
2150 max_children);
2151 strvec_clear(&options);
2154 string_list_clear(&list, 0);
2156 prepare_repo_settings(the_repository);
2157 if (fetch_write_commit_graph > 0 ||
2158 (fetch_write_commit_graph < 0 &&
2159 the_repository->settings.fetch_write_commit_graph)) {
2160 int commit_graph_flags = COMMIT_GRAPH_WRITE_SPLIT;
2162 if (progress)
2163 commit_graph_flags |= COMMIT_GRAPH_WRITE_PROGRESS;
2165 write_commit_graph_reachable(the_repository->objects->odb,
2166 commit_graph_flags,
2167 NULL);
2170 if (enable_auto_gc)
2171 run_auto_maintenance(verbosity < 0);
2173 return result;