Merge branch 'ps/lockfile-cleanup-fix'
[git/debian.git] / builtin / fetch.c
blob5f06b21f8e97c5459fdb558302c5b9b95e99eee8
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(unsigned int flags)
228 if (gtransport)
229 transport_unlock_pack(gtransport, flags);
230 if (gsecondary)
231 transport_unlock_pack(gsecondary, flags);
234 static void unlock_pack_atexit(void)
236 unlock_pack(0);
239 static void unlock_pack_on_signal(int signo)
241 unlock_pack(TRANSPORT_UNLOCK_PACK_IN_SIGNAL_HANDLER);
242 sigchain_pop(signo);
243 raise(signo);
246 static void add_merge_config(struct ref **head,
247 const struct ref *remote_refs,
248 struct branch *branch,
249 struct ref ***tail)
251 int i;
253 for (i = 0; i < branch->merge_nr; i++) {
254 struct ref *rm, **old_tail = *tail;
255 struct refspec_item refspec;
257 for (rm = *head; rm; rm = rm->next) {
258 if (branch_merge_matches(branch, i, rm->name)) {
259 rm->fetch_head_status = FETCH_HEAD_MERGE;
260 break;
263 if (rm)
264 continue;
267 * Not fetched to a remote-tracking branch? We need to fetch
268 * it anyway to allow this branch's "branch.$name.merge"
269 * to be honored by 'git pull', but we do not have to
270 * fail if branch.$name.merge is misconfigured to point
271 * at a nonexisting branch. If we were indeed called by
272 * 'git pull', it will notice the misconfiguration because
273 * there is no entry in the resulting FETCH_HEAD marked
274 * for merging.
276 memset(&refspec, 0, sizeof(refspec));
277 refspec.src = branch->merge[i]->src;
278 get_fetch_map(remote_refs, &refspec, tail, 1);
279 for (rm = *old_tail; rm; rm = rm->next)
280 rm->fetch_head_status = FETCH_HEAD_MERGE;
284 static void create_fetch_oidset(struct ref **head, struct oidset *out)
286 struct ref *rm = *head;
287 while (rm) {
288 oidset_insert(out, &rm->old_oid);
289 rm = rm->next;
293 struct refname_hash_entry {
294 struct hashmap_entry ent;
295 struct object_id oid;
296 int ignore;
297 char refname[FLEX_ARRAY];
300 static int refname_hash_entry_cmp(const void *hashmap_cmp_fn_data,
301 const struct hashmap_entry *eptr,
302 const struct hashmap_entry *entry_or_key,
303 const void *keydata)
305 const struct refname_hash_entry *e1, *e2;
307 e1 = container_of(eptr, const struct refname_hash_entry, ent);
308 e2 = container_of(entry_or_key, const struct refname_hash_entry, ent);
309 return strcmp(e1->refname, keydata ? keydata : e2->refname);
312 static struct refname_hash_entry *refname_hash_add(struct hashmap *map,
313 const char *refname,
314 const struct object_id *oid)
316 struct refname_hash_entry *ent;
317 size_t len = strlen(refname);
319 FLEX_ALLOC_MEM(ent, refname, refname, len);
320 hashmap_entry_init(&ent->ent, strhash(refname));
321 oidcpy(&ent->oid, oid);
322 hashmap_add(map, &ent->ent);
323 return ent;
326 static int add_one_refname(const char *refname,
327 const struct object_id *oid,
328 int flag, void *cbdata)
330 struct hashmap *refname_map = cbdata;
332 (void) refname_hash_add(refname_map, refname, oid);
333 return 0;
336 static void refname_hash_init(struct hashmap *map)
338 hashmap_init(map, refname_hash_entry_cmp, NULL, 0);
341 static int refname_hash_exists(struct hashmap *map, const char *refname)
343 return !!hashmap_get_from_hash(map, strhash(refname), refname);
346 static void clear_item(struct refname_hash_entry *item)
348 item->ignore = 1;
351 static void find_non_local_tags(const struct ref *refs,
352 struct ref **head,
353 struct ref ***tail)
355 struct hashmap existing_refs;
356 struct hashmap remote_refs;
357 struct oidset fetch_oids = OIDSET_INIT;
358 struct string_list remote_refs_list = STRING_LIST_INIT_NODUP;
359 struct string_list_item *remote_ref_item;
360 const struct ref *ref;
361 struct refname_hash_entry *item = NULL;
362 const int quick_flags = OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT;
364 refname_hash_init(&existing_refs);
365 refname_hash_init(&remote_refs);
366 create_fetch_oidset(head, &fetch_oids);
368 for_each_ref(add_one_refname, &existing_refs);
369 for (ref = refs; ref; ref = ref->next) {
370 if (!starts_with(ref->name, "refs/tags/"))
371 continue;
374 * The peeled ref always follows the matching base
375 * ref, so if we see a peeled ref that we don't want
376 * to fetch then we can mark the ref entry in the list
377 * as one to ignore by setting util to NULL.
379 if (ends_with(ref->name, "^{}")) {
380 if (item &&
381 !has_object_file_with_flags(&ref->old_oid, quick_flags) &&
382 !oidset_contains(&fetch_oids, &ref->old_oid) &&
383 !has_object_file_with_flags(&item->oid, quick_flags) &&
384 !oidset_contains(&fetch_oids, &item->oid))
385 clear_item(item);
386 item = NULL;
387 continue;
391 * If item is non-NULL here, then we previously saw a
392 * ref not followed by a peeled reference, so we need
393 * to check if it is a lightweight tag that we want to
394 * fetch.
396 if (item &&
397 !has_object_file_with_flags(&item->oid, quick_flags) &&
398 !oidset_contains(&fetch_oids, &item->oid))
399 clear_item(item);
401 item = NULL;
403 /* skip duplicates and refs that we already have */
404 if (refname_hash_exists(&remote_refs, ref->name) ||
405 refname_hash_exists(&existing_refs, ref->name))
406 continue;
408 item = refname_hash_add(&remote_refs, ref->name, &ref->old_oid);
409 string_list_insert(&remote_refs_list, ref->name);
411 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
414 * We may have a final lightweight tag that needs to be
415 * checked to see if it needs fetching.
417 if (item &&
418 !has_object_file_with_flags(&item->oid, quick_flags) &&
419 !oidset_contains(&fetch_oids, &item->oid))
420 clear_item(item);
423 * For all the tags in the remote_refs_list,
424 * add them to the list of refs to be fetched
426 for_each_string_list_item(remote_ref_item, &remote_refs_list) {
427 const char *refname = remote_ref_item->string;
428 struct ref *rm;
429 unsigned int hash = strhash(refname);
431 item = hashmap_get_entry_from_hash(&remote_refs, hash, refname,
432 struct refname_hash_entry, ent);
433 if (!item)
434 BUG("unseen remote ref?");
436 /* Unless we have already decided to ignore this item... */
437 if (item->ignore)
438 continue;
440 rm = alloc_ref(item->refname);
441 rm->peer_ref = alloc_ref(item->refname);
442 oidcpy(&rm->old_oid, &item->oid);
443 **tail = rm;
444 *tail = &rm->next;
446 hashmap_clear_and_free(&remote_refs, struct refname_hash_entry, ent);
447 string_list_clear(&remote_refs_list, 0);
448 oidset_clear(&fetch_oids);
451 static void filter_prefetch_refspec(struct refspec *rs)
453 int i;
455 if (!prefetch)
456 return;
458 for (i = 0; i < rs->nr; i++) {
459 struct strbuf new_dst = STRBUF_INIT;
460 char *old_dst;
461 const char *sub = NULL;
463 if (rs->items[i].negative)
464 continue;
465 if (!rs->items[i].dst ||
466 (rs->items[i].src &&
467 !strncmp(rs->items[i].src, "refs/tags/", 10))) {
468 int j;
470 free(rs->items[i].src);
471 free(rs->items[i].dst);
473 for (j = i + 1; j < rs->nr; j++) {
474 rs->items[j - 1] = rs->items[j];
475 rs->raw[j - 1] = rs->raw[j];
477 rs->nr--;
478 i--;
479 continue;
482 old_dst = rs->items[i].dst;
483 strbuf_addstr(&new_dst, "refs/prefetch/");
486 * If old_dst starts with "refs/", then place
487 * sub after that prefix. Otherwise, start at
488 * the beginning of the string.
490 if (!skip_prefix(old_dst, "refs/", &sub))
491 sub = old_dst;
492 strbuf_addstr(&new_dst, sub);
494 rs->items[i].dst = strbuf_detach(&new_dst, NULL);
495 rs->items[i].force = 1;
497 free(old_dst);
501 static struct ref *get_ref_map(struct remote *remote,
502 const struct ref *remote_refs,
503 struct refspec *rs,
504 int tags, int *autotags)
506 int i;
507 struct ref *rm;
508 struct ref *ref_map = NULL;
509 struct ref **tail = &ref_map;
511 /* opportunistically-updated references: */
512 struct ref *orefs = NULL, **oref_tail = &orefs;
514 struct hashmap existing_refs;
515 int existing_refs_populated = 0;
517 filter_prefetch_refspec(rs);
518 if (remote)
519 filter_prefetch_refspec(&remote->fetch);
521 if (rs->nr) {
522 struct refspec *fetch_refspec;
524 for (i = 0; i < rs->nr; i++) {
525 get_fetch_map(remote_refs, &rs->items[i], &tail, 0);
526 if (rs->items[i].dst && rs->items[i].dst[0])
527 *autotags = 1;
529 /* Merge everything on the command line (but not --tags) */
530 for (rm = ref_map; rm; rm = rm->next)
531 rm->fetch_head_status = FETCH_HEAD_MERGE;
534 * For any refs that we happen to be fetching via
535 * command-line arguments, the destination ref might
536 * have been missing or have been different than the
537 * remote-tracking ref that would be derived from the
538 * configured refspec. In these cases, we want to
539 * take the opportunity to update their configured
540 * remote-tracking reference. However, we do not want
541 * to mention these entries in FETCH_HEAD at all, as
542 * they would simply be duplicates of existing
543 * entries, so we set them FETCH_HEAD_IGNORE below.
545 * We compute these entries now, based only on the
546 * refspecs specified on the command line. But we add
547 * them to the list following the refspecs resulting
548 * from the tags option so that one of the latter,
549 * which has FETCH_HEAD_NOT_FOR_MERGE, is not removed
550 * by ref_remove_duplicates() in favor of one of these
551 * opportunistic entries with FETCH_HEAD_IGNORE.
553 if (refmap.nr)
554 fetch_refspec = &refmap;
555 else
556 fetch_refspec = &remote->fetch;
558 for (i = 0; i < fetch_refspec->nr; i++)
559 get_fetch_map(ref_map, &fetch_refspec->items[i], &oref_tail, 1);
560 } else if (refmap.nr) {
561 die("--refmap option is only meaningful with command-line refspec(s)");
562 } else {
563 /* Use the defaults */
564 struct branch *branch = branch_get(NULL);
565 int has_merge = branch_has_merge_config(branch);
566 if (remote &&
567 (remote->fetch.nr ||
568 /* Note: has_merge implies non-NULL branch->remote_name */
569 (has_merge && !strcmp(branch->remote_name, remote->name)))) {
570 for (i = 0; i < remote->fetch.nr; i++) {
571 get_fetch_map(remote_refs, &remote->fetch.items[i], &tail, 0);
572 if (remote->fetch.items[i].dst &&
573 remote->fetch.items[i].dst[0])
574 *autotags = 1;
575 if (!i && !has_merge && ref_map &&
576 !remote->fetch.items[0].pattern)
577 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
580 * if the remote we're fetching from is the same
581 * as given in branch.<name>.remote, we add the
582 * ref given in branch.<name>.merge, too.
584 * Note: has_merge implies non-NULL branch->remote_name
586 if (has_merge &&
587 !strcmp(branch->remote_name, remote->name))
588 add_merge_config(&ref_map, remote_refs, branch, &tail);
589 } else if (!prefetch) {
590 ref_map = get_remote_ref(remote_refs, "HEAD");
591 if (!ref_map)
592 die(_("couldn't find remote ref HEAD"));
593 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
594 tail = &ref_map->next;
598 if (tags == TAGS_SET)
599 /* also fetch all tags */
600 get_fetch_map(remote_refs, tag_refspec, &tail, 0);
601 else if (tags == TAGS_DEFAULT && *autotags)
602 find_non_local_tags(remote_refs, &ref_map, &tail);
604 /* Now append any refs to be updated opportunistically: */
605 *tail = orefs;
606 for (rm = orefs; rm; rm = rm->next) {
607 rm->fetch_head_status = FETCH_HEAD_IGNORE;
608 tail = &rm->next;
612 * apply negative refspecs first, before we remove duplicates. This is
613 * necessary as negative refspecs might remove an otherwise conflicting
614 * duplicate.
616 if (rs->nr)
617 ref_map = apply_negative_refspecs(ref_map, rs);
618 else
619 ref_map = apply_negative_refspecs(ref_map, &remote->fetch);
621 ref_map = ref_remove_duplicates(ref_map);
623 for (rm = ref_map; rm; rm = rm->next) {
624 if (rm->peer_ref) {
625 const char *refname = rm->peer_ref->name;
626 struct refname_hash_entry *peer_item;
627 unsigned int hash = strhash(refname);
629 if (!existing_refs_populated) {
630 refname_hash_init(&existing_refs);
631 for_each_ref(add_one_refname, &existing_refs);
632 existing_refs_populated = 1;
635 peer_item = hashmap_get_entry_from_hash(&existing_refs,
636 hash, refname,
637 struct refname_hash_entry, ent);
638 if (peer_item) {
639 struct object_id *old_oid = &peer_item->oid;
640 oidcpy(&rm->peer_ref->old_oid, old_oid);
644 if (existing_refs_populated)
645 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
647 return ref_map;
650 #define STORE_REF_ERROR_OTHER 1
651 #define STORE_REF_ERROR_DF_CONFLICT 2
653 static int s_update_ref(const char *action,
654 struct ref *ref,
655 struct ref_transaction *transaction,
656 int check_old)
658 char *msg;
659 char *rla = getenv("GIT_REFLOG_ACTION");
660 struct ref_transaction *our_transaction = NULL;
661 struct strbuf err = STRBUF_INIT;
662 int ret;
664 if (dry_run)
665 return 0;
666 if (!rla)
667 rla = default_rla.buf;
668 msg = xstrfmt("%s: %s", rla, action);
671 * If no transaction was passed to us, we manage the transaction
672 * ourselves. Otherwise, we trust the caller to handle the transaction
673 * lifecycle.
675 if (!transaction) {
676 transaction = our_transaction = ref_transaction_begin(&err);
677 if (!transaction) {
678 ret = STORE_REF_ERROR_OTHER;
679 goto out;
683 ret = ref_transaction_update(transaction, ref->name, &ref->new_oid,
684 check_old ? &ref->old_oid : NULL,
685 0, msg, &err);
686 if (ret) {
687 ret = STORE_REF_ERROR_OTHER;
688 goto out;
691 if (our_transaction) {
692 switch (ref_transaction_commit(our_transaction, &err)) {
693 case 0:
694 break;
695 case TRANSACTION_NAME_CONFLICT:
696 ret = STORE_REF_ERROR_DF_CONFLICT;
697 goto out;
698 default:
699 ret = STORE_REF_ERROR_OTHER;
700 goto out;
704 out:
705 ref_transaction_free(our_transaction);
706 if (ret)
707 error("%s", err.buf);
708 strbuf_release(&err);
709 free(msg);
710 return ret;
713 static int refcol_width = 10;
714 static int compact_format;
716 static void adjust_refcol_width(const struct ref *ref)
718 int max, rlen, llen, len;
720 /* uptodate lines are only shown on high verbosity level */
721 if (verbosity <= 0 && oideq(&ref->peer_ref->old_oid, &ref->old_oid))
722 return;
724 max = term_columns();
725 rlen = utf8_strwidth(prettify_refname(ref->name));
727 llen = utf8_strwidth(prettify_refname(ref->peer_ref->name));
730 * rough estimation to see if the output line is too long and
731 * should not be counted (we can't do precise calculation
732 * anyway because we don't know if the error explanation part
733 * will be printed in update_local_ref)
735 if (compact_format) {
736 llen = 0;
737 max = max * 2 / 3;
739 len = 21 /* flag and summary */ + rlen + 4 /* -> */ + llen;
740 if (len >= max)
741 return;
744 * Not precise calculation for compact mode because '*' can
745 * appear on the left hand side of '->' and shrink the column
746 * back.
748 if (refcol_width < rlen)
749 refcol_width = rlen;
752 static void prepare_format_display(struct ref *ref_map)
754 struct ref *rm;
755 const char *format = "full";
757 if (verbosity < 0)
758 return;
760 git_config_get_string_tmp("fetch.output", &format);
761 if (!strcasecmp(format, "full"))
762 compact_format = 0;
763 else if (!strcasecmp(format, "compact"))
764 compact_format = 1;
765 else
766 die(_("configuration fetch.output contains invalid value %s"),
767 format);
769 for (rm = ref_map; rm; rm = rm->next) {
770 if (rm->status == REF_STATUS_REJECT_SHALLOW ||
771 !rm->peer_ref ||
772 !strcmp(rm->name, "HEAD"))
773 continue;
775 adjust_refcol_width(rm);
779 static void print_remote_to_local(struct strbuf *display,
780 const char *remote, const char *local)
782 strbuf_addf(display, "%-*s -> %s", refcol_width, remote, local);
785 static int find_and_replace(struct strbuf *haystack,
786 const char *needle,
787 const char *placeholder)
789 const char *p = NULL;
790 int plen, nlen;
792 nlen = strlen(needle);
793 if (ends_with(haystack->buf, needle))
794 p = haystack->buf + haystack->len - nlen;
795 else
796 p = strstr(haystack->buf, needle);
797 if (!p)
798 return 0;
800 if (p > haystack->buf && p[-1] != '/')
801 return 0;
803 plen = strlen(p);
804 if (plen > nlen && p[nlen] != '/')
805 return 0;
807 strbuf_splice(haystack, p - haystack->buf, nlen,
808 placeholder, strlen(placeholder));
809 return 1;
812 static void print_compact(struct strbuf *display,
813 const char *remote, const char *local)
815 struct strbuf r = STRBUF_INIT;
816 struct strbuf l = STRBUF_INIT;
818 if (!strcmp(remote, local)) {
819 strbuf_addf(display, "%-*s -> *", refcol_width, remote);
820 return;
823 strbuf_addstr(&r, remote);
824 strbuf_addstr(&l, local);
826 if (!find_and_replace(&r, local, "*"))
827 find_and_replace(&l, remote, "*");
828 print_remote_to_local(display, r.buf, l.buf);
830 strbuf_release(&r);
831 strbuf_release(&l);
834 static void format_display(struct strbuf *display, char code,
835 const char *summary, const char *error,
836 const char *remote, const char *local,
837 int summary_width)
839 int width;
841 if (verbosity < 0)
842 return;
844 width = (summary_width + strlen(summary) - gettext_width(summary));
846 strbuf_addf(display, "%c %-*s ", code, width, summary);
847 if (!compact_format)
848 print_remote_to_local(display, remote, local);
849 else
850 print_compact(display, remote, local);
851 if (error)
852 strbuf_addf(display, " (%s)", error);
855 static int update_local_ref(struct ref *ref,
856 struct ref_transaction *transaction,
857 const char *remote, const struct ref *remote_ref,
858 struct strbuf *display, int summary_width,
859 struct worktree **worktrees)
861 struct commit *current = NULL, *updated;
862 const struct worktree *wt;
863 const char *pretty_ref = prettify_refname(ref->name);
864 int fast_forward = 0;
866 if (!repo_has_object_file(the_repository, &ref->new_oid))
867 die(_("object %s not found"), oid_to_hex(&ref->new_oid));
869 if (oideq(&ref->old_oid, &ref->new_oid)) {
870 if (verbosity > 0)
871 format_display(display, '=', _("[up to date]"), NULL,
872 remote, pretty_ref, summary_width);
873 return 0;
876 if (!update_head_ok &&
877 (wt = find_shared_symref(worktrees, "HEAD", ref->name)) &&
878 !wt->is_bare && !is_null_oid(&ref->old_oid)) {
880 * If this is the head, and it's not okay to update
881 * the head, and the old value of the head isn't empty...
883 format_display(display, '!', _("[rejected]"),
884 wt->is_current ?
885 _("can't fetch in current branch") :
886 _("checked out in another worktree"),
887 remote, pretty_ref, summary_width);
888 return 1;
891 if (!is_null_oid(&ref->old_oid) &&
892 starts_with(ref->name, "refs/tags/")) {
893 if (force || ref->force) {
894 int r;
895 r = s_update_ref("updating tag", ref, transaction, 0);
896 format_display(display, r ? '!' : 't', _("[tag update]"),
897 r ? _("unable to update local ref") : NULL,
898 remote, pretty_ref, summary_width);
899 return r;
900 } else {
901 format_display(display, '!', _("[rejected]"), _("would clobber existing tag"),
902 remote, pretty_ref, summary_width);
903 return 1;
907 current = lookup_commit_reference_gently(the_repository,
908 &ref->old_oid, 1);
909 updated = lookup_commit_reference_gently(the_repository,
910 &ref->new_oid, 1);
911 if (!current || !updated) {
912 const char *msg;
913 const char *what;
914 int r;
916 * Nicely describe the new ref we're fetching.
917 * Base this on the remote's ref name, as it's
918 * more likely to follow a standard layout.
920 const char *name = remote_ref ? remote_ref->name : "";
921 if (starts_with(name, "refs/tags/")) {
922 msg = "storing tag";
923 what = _("[new tag]");
924 } else if (starts_with(name, "refs/heads/")) {
925 msg = "storing head";
926 what = _("[new branch]");
927 } else {
928 msg = "storing ref";
929 what = _("[new ref]");
932 r = s_update_ref(msg, ref, transaction, 0);
933 format_display(display, r ? '!' : '*', what,
934 r ? _("unable to update local ref") : NULL,
935 remote, pretty_ref, summary_width);
936 return r;
939 if (fetch_show_forced_updates) {
940 uint64_t t_before = getnanotime();
941 fast_forward = in_merge_bases(current, updated);
942 forced_updates_ms += (getnanotime() - t_before) / 1000000;
943 } else {
944 fast_forward = 1;
947 if (fast_forward) {
948 struct strbuf quickref = STRBUF_INIT;
949 int r;
951 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
952 strbuf_addstr(&quickref, "..");
953 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
954 r = s_update_ref("fast-forward", ref, transaction, 1);
955 format_display(display, r ? '!' : ' ', quickref.buf,
956 r ? _("unable to update local ref") : NULL,
957 remote, pretty_ref, summary_width);
958 strbuf_release(&quickref);
959 return r;
960 } else if (force || ref->force) {
961 struct strbuf quickref = STRBUF_INIT;
962 int r;
963 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
964 strbuf_addstr(&quickref, "...");
965 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
966 r = s_update_ref("forced-update", ref, transaction, 1);
967 format_display(display, r ? '!' : '+', quickref.buf,
968 r ? _("unable to update local ref") : _("forced update"),
969 remote, pretty_ref, summary_width);
970 strbuf_release(&quickref);
971 return r;
972 } else {
973 format_display(display, '!', _("[rejected]"), _("non-fast-forward"),
974 remote, pretty_ref, summary_width);
975 return 1;
979 static const struct object_id *iterate_ref_map(void *cb_data)
981 struct ref **rm = cb_data;
982 struct ref *ref = *rm;
984 while (ref && ref->status == REF_STATUS_REJECT_SHALLOW)
985 ref = ref->next;
986 if (!ref)
987 return NULL;
988 *rm = ref->next;
989 return &ref->old_oid;
992 struct fetch_head {
993 FILE *fp;
994 struct strbuf buf;
997 static int open_fetch_head(struct fetch_head *fetch_head)
999 const char *filename = git_path_fetch_head(the_repository);
1001 if (write_fetch_head) {
1002 fetch_head->fp = fopen(filename, "a");
1003 if (!fetch_head->fp)
1004 return error_errno(_("cannot open '%s'"), filename);
1005 strbuf_init(&fetch_head->buf, 0);
1006 } else {
1007 fetch_head->fp = NULL;
1010 return 0;
1013 static void append_fetch_head(struct fetch_head *fetch_head,
1014 const struct object_id *old_oid,
1015 enum fetch_head_status fetch_head_status,
1016 const char *note,
1017 const char *url, size_t url_len)
1019 char old_oid_hex[GIT_MAX_HEXSZ + 1];
1020 const char *merge_status_marker;
1021 size_t i;
1023 if (!fetch_head->fp)
1024 return;
1026 switch (fetch_head_status) {
1027 case FETCH_HEAD_NOT_FOR_MERGE:
1028 merge_status_marker = "not-for-merge";
1029 break;
1030 case FETCH_HEAD_MERGE:
1031 merge_status_marker = "";
1032 break;
1033 default:
1034 /* do not write anything to FETCH_HEAD */
1035 return;
1038 strbuf_addf(&fetch_head->buf, "%s\t%s\t%s",
1039 oid_to_hex_r(old_oid_hex, old_oid), merge_status_marker, note);
1040 for (i = 0; i < url_len; ++i)
1041 if ('\n' == url[i])
1042 strbuf_addstr(&fetch_head->buf, "\\n");
1043 else
1044 strbuf_addch(&fetch_head->buf, url[i]);
1045 strbuf_addch(&fetch_head->buf, '\n');
1048 * When using an atomic fetch, we do not want to update FETCH_HEAD if
1049 * any of the reference updates fails. We thus have to write all
1050 * updates to a buffer first and only commit it as soon as all
1051 * references have been successfully updated.
1053 if (!atomic_fetch) {
1054 strbuf_write(&fetch_head->buf, fetch_head->fp);
1055 strbuf_reset(&fetch_head->buf);
1059 static void commit_fetch_head(struct fetch_head *fetch_head)
1061 if (!fetch_head->fp || !atomic_fetch)
1062 return;
1063 strbuf_write(&fetch_head->buf, fetch_head->fp);
1066 static void close_fetch_head(struct fetch_head *fetch_head)
1068 if (!fetch_head->fp)
1069 return;
1071 fclose(fetch_head->fp);
1072 strbuf_release(&fetch_head->buf);
1075 static const char warn_show_forced_updates[] =
1076 N_("fetch normally indicates which branches had a forced update,\n"
1077 "but that check has been disabled; to re-enable, use '--show-forced-updates'\n"
1078 "flag or run 'git config fetch.showForcedUpdates true'");
1079 static const char warn_time_show_forced_updates[] =
1080 N_("it took %.2f seconds to check forced updates; you can use\n"
1081 "'--no-show-forced-updates' or run 'git config fetch.showForcedUpdates false'\n"
1082 "to avoid this check\n");
1084 static int store_updated_refs(const char *raw_url, const char *remote_name,
1085 int connectivity_checked, struct ref *ref_map,
1086 struct worktree **worktrees)
1088 struct fetch_head fetch_head;
1089 int url_len, i, rc = 0;
1090 struct strbuf note = STRBUF_INIT, err = STRBUF_INIT;
1091 struct ref_transaction *transaction = NULL;
1092 const char *what, *kind;
1093 struct ref *rm;
1094 char *url;
1095 int want_status;
1096 int summary_width = transport_summary_width(ref_map);
1098 rc = open_fetch_head(&fetch_head);
1099 if (rc)
1100 return -1;
1102 if (raw_url)
1103 url = transport_anonymize_url(raw_url);
1104 else
1105 url = xstrdup("foreign");
1107 if (!connectivity_checked) {
1108 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1110 rm = ref_map;
1111 if (check_connected(iterate_ref_map, &rm, &opt)) {
1112 rc = error(_("%s did not send all necessary objects\n"), url);
1113 goto abort;
1117 if (atomic_fetch) {
1118 transaction = ref_transaction_begin(&err);
1119 if (!transaction) {
1120 error("%s", err.buf);
1121 goto abort;
1125 prepare_format_display(ref_map);
1128 * We do a pass for each fetch_head_status type in their enum order, so
1129 * merged entries are written before not-for-merge. That lets readers
1130 * use FETCH_HEAD as a refname to refer to the ref to be merged.
1132 for (want_status = FETCH_HEAD_MERGE;
1133 want_status <= FETCH_HEAD_IGNORE;
1134 want_status++) {
1135 for (rm = ref_map; rm; rm = rm->next) {
1136 struct commit *commit = NULL;
1137 struct ref *ref = NULL;
1139 if (rm->status == REF_STATUS_REJECT_SHALLOW) {
1140 if (want_status == FETCH_HEAD_MERGE)
1141 warning(_("rejected %s because shallow roots are not allowed to be updated"),
1142 rm->peer_ref ? rm->peer_ref->name : rm->name);
1143 continue;
1147 * References in "refs/tags/" are often going to point
1148 * to annotated tags, which are not part of the
1149 * commit-graph. We thus only try to look up refs in
1150 * the graph which are not in that namespace to not
1151 * regress performance in repositories with many
1152 * annotated tags.
1154 if (!starts_with(rm->name, "refs/tags/"))
1155 commit = lookup_commit_in_graph(the_repository, &rm->old_oid);
1156 if (!commit) {
1157 commit = lookup_commit_reference_gently(the_repository,
1158 &rm->old_oid,
1160 if (!commit)
1161 rm->fetch_head_status = FETCH_HEAD_NOT_FOR_MERGE;
1164 if (rm->fetch_head_status != want_status)
1165 continue;
1167 if (rm->peer_ref) {
1168 ref = alloc_ref(rm->peer_ref->name);
1169 oidcpy(&ref->old_oid, &rm->peer_ref->old_oid);
1170 oidcpy(&ref->new_oid, &rm->old_oid);
1171 ref->force = rm->peer_ref->force;
1174 if (recurse_submodules != RECURSE_SUBMODULES_OFF &&
1175 (!rm->peer_ref || !oideq(&ref->old_oid, &ref->new_oid))) {
1176 check_for_new_submodule_commits(&rm->old_oid);
1179 if (!strcmp(rm->name, "HEAD")) {
1180 kind = "";
1181 what = "";
1183 else if (skip_prefix(rm->name, "refs/heads/", &what))
1184 kind = "branch";
1185 else if (skip_prefix(rm->name, "refs/tags/", &what))
1186 kind = "tag";
1187 else if (skip_prefix(rm->name, "refs/remotes/", &what))
1188 kind = "remote-tracking branch";
1189 else {
1190 kind = "";
1191 what = rm->name;
1194 url_len = strlen(url);
1195 for (i = url_len - 1; url[i] == '/' && 0 <= i; i--)
1197 url_len = i + 1;
1198 if (4 < i && !strncmp(".git", url + i - 3, 4))
1199 url_len = i - 3;
1201 strbuf_reset(&note);
1202 if (*what) {
1203 if (*kind)
1204 strbuf_addf(&note, "%s ", kind);
1205 strbuf_addf(&note, "'%s' of ", what);
1208 append_fetch_head(&fetch_head, &rm->old_oid,
1209 rm->fetch_head_status,
1210 note.buf, url, url_len);
1212 strbuf_reset(&note);
1213 if (ref) {
1214 rc |= update_local_ref(ref, transaction, what,
1215 rm, &note, summary_width,
1216 worktrees);
1217 free(ref);
1218 } else if (write_fetch_head || dry_run) {
1220 * Display fetches written to FETCH_HEAD (or
1221 * would be written to FETCH_HEAD, if --dry-run
1222 * is set).
1224 format_display(&note, '*',
1225 *kind ? kind : "branch", NULL,
1226 *what ? what : "HEAD",
1227 "FETCH_HEAD", summary_width);
1229 if (note.len) {
1230 if (!shown_url) {
1231 fprintf(stderr, _("From %.*s\n"),
1232 url_len, url);
1233 shown_url = 1;
1235 fprintf(stderr, " %s\n", note.buf);
1240 if (!rc && transaction) {
1241 rc = ref_transaction_commit(transaction, &err);
1242 if (rc) {
1243 error("%s", err.buf);
1244 goto abort;
1248 if (!rc)
1249 commit_fetch_head(&fetch_head);
1251 if (rc & STORE_REF_ERROR_DF_CONFLICT)
1252 error(_("some local refs could not be updated; try running\n"
1253 " 'git remote prune %s' to remove any old, conflicting "
1254 "branches"), remote_name);
1256 if (advice_enabled(ADVICE_FETCH_SHOW_FORCED_UPDATES)) {
1257 if (!fetch_show_forced_updates) {
1258 warning(_(warn_show_forced_updates));
1259 } else if (forced_updates_ms > FORCED_UPDATES_DELAY_WARNING_IN_MS) {
1260 warning(_(warn_time_show_forced_updates),
1261 forced_updates_ms / 1000.0);
1265 abort:
1266 strbuf_release(&note);
1267 strbuf_release(&err);
1268 ref_transaction_free(transaction);
1269 free(url);
1270 close_fetch_head(&fetch_head);
1271 return rc;
1275 * We would want to bypass the object transfer altogether if
1276 * everything we are going to fetch already exists and is connected
1277 * locally.
1279 static int check_exist_and_connected(struct ref *ref_map)
1281 struct ref *rm = ref_map;
1282 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1283 struct ref *r;
1286 * If we are deepening a shallow clone we already have these
1287 * objects reachable. Running rev-list here will return with
1288 * a good (0) exit status and we'll bypass the fetch that we
1289 * really need to perform. Claiming failure now will ensure
1290 * we perform the network exchange to deepen our history.
1292 if (deepen)
1293 return -1;
1296 * check_connected() allows objects to merely be promised, but
1297 * we need all direct targets to exist.
1299 for (r = rm; r; r = r->next) {
1300 if (!has_object_file_with_flags(&r->old_oid,
1301 OBJECT_INFO_SKIP_FETCH_OBJECT))
1302 return -1;
1305 opt.quiet = 1;
1306 return check_connected(iterate_ref_map, &rm, &opt);
1309 static int fetch_and_consume_refs(struct transport *transport,
1310 struct ref *ref_map,
1311 struct worktree **worktrees)
1313 int connectivity_checked = 1;
1314 int ret;
1317 * We don't need to perform a fetch in case we can already satisfy all
1318 * refs.
1320 ret = check_exist_and_connected(ref_map);
1321 if (ret) {
1322 trace2_region_enter("fetch", "fetch_refs", the_repository);
1323 ret = transport_fetch_refs(transport, ref_map);
1324 trace2_region_leave("fetch", "fetch_refs", the_repository);
1325 if (ret)
1326 goto out;
1327 connectivity_checked = transport->smart_options ?
1328 transport->smart_options->connectivity_checked : 0;
1331 trace2_region_enter("fetch", "consume_refs", the_repository);
1332 ret = store_updated_refs(transport->url, transport->remote->name,
1333 connectivity_checked, ref_map, worktrees);
1334 trace2_region_leave("fetch", "consume_refs", the_repository);
1336 out:
1337 transport_unlock_pack(transport, 0);
1338 return ret;
1341 static int prune_refs(struct refspec *rs, struct ref *ref_map,
1342 const char *raw_url)
1344 int url_len, i, result = 0;
1345 struct ref *ref, *stale_refs = get_stale_heads(rs, ref_map);
1346 char *url;
1347 int summary_width = transport_summary_width(stale_refs);
1348 const char *dangling_msg = dry_run
1349 ? _(" (%s will become dangling)")
1350 : _(" (%s has become dangling)");
1352 if (raw_url)
1353 url = transport_anonymize_url(raw_url);
1354 else
1355 url = xstrdup("foreign");
1357 url_len = strlen(url);
1358 for (i = url_len - 1; url[i] == '/' && 0 <= i; i--)
1361 url_len = i + 1;
1362 if (4 < i && !strncmp(".git", url + i - 3, 4))
1363 url_len = i - 3;
1365 if (!dry_run) {
1366 struct string_list refnames = STRING_LIST_INIT_NODUP;
1368 for (ref = stale_refs; ref; ref = ref->next)
1369 string_list_append(&refnames, ref->name);
1371 result = delete_refs("fetch: prune", &refnames, 0);
1372 string_list_clear(&refnames, 0);
1375 if (verbosity >= 0) {
1376 for (ref = stale_refs; ref; ref = ref->next) {
1377 struct strbuf sb = STRBUF_INIT;
1378 if (!shown_url) {
1379 fprintf(stderr, _("From %.*s\n"), url_len, url);
1380 shown_url = 1;
1382 format_display(&sb, '-', _("[deleted]"), NULL,
1383 _("(none)"), prettify_refname(ref->name),
1384 summary_width);
1385 fprintf(stderr, " %s\n",sb.buf);
1386 strbuf_release(&sb);
1387 warn_dangling_symref(stderr, dangling_msg, ref->name);
1391 free(url);
1392 free_refs(stale_refs);
1393 return result;
1396 static void check_not_current_branch(struct ref *ref_map,
1397 struct worktree **worktrees)
1399 const struct worktree *wt;
1400 for (; ref_map; ref_map = ref_map->next)
1401 if (ref_map->peer_ref &&
1402 (wt = find_shared_symref(worktrees, "HEAD",
1403 ref_map->peer_ref->name)) &&
1404 !wt->is_bare)
1405 die(_("refusing to fetch into branch '%s' "
1406 "checked out at '%s'"),
1407 ref_map->peer_ref->name, wt->path);
1410 static int truncate_fetch_head(void)
1412 const char *filename = git_path_fetch_head(the_repository);
1413 FILE *fp = fopen_for_writing(filename);
1415 if (!fp)
1416 return error_errno(_("cannot open '%s'"), filename);
1417 fclose(fp);
1418 return 0;
1421 static void set_option(struct transport *transport, const char *name, const char *value)
1423 int r = transport_set_option(transport, name, value);
1424 if (r < 0)
1425 die(_("option \"%s\" value \"%s\" is not valid for %s"),
1426 name, value, transport->url);
1427 if (r > 0)
1428 warning(_("option \"%s\" is ignored for %s\n"),
1429 name, transport->url);
1433 static int add_oid(const char *refname, const struct object_id *oid, int flags,
1434 void *cb_data)
1436 struct oid_array *oids = cb_data;
1438 oid_array_append(oids, oid);
1439 return 0;
1442 static void add_negotiation_tips(struct git_transport_options *smart_options)
1444 struct oid_array *oids = xcalloc(1, sizeof(*oids));
1445 int i;
1447 for (i = 0; i < negotiation_tip.nr; i++) {
1448 const char *s = negotiation_tip.items[i].string;
1449 int old_nr;
1450 if (!has_glob_specials(s)) {
1451 struct object_id oid;
1452 if (get_oid(s, &oid))
1453 die(_("%s is not a valid object"), s);
1454 if (!has_object(the_repository, &oid, 0))
1455 die(_("the object %s does not exist"), s);
1456 oid_array_append(oids, &oid);
1457 continue;
1459 old_nr = oids->nr;
1460 for_each_glob_ref(add_oid, s, oids);
1461 if (old_nr == oids->nr)
1462 warning("ignoring --negotiation-tip=%s because it does not match any refs",
1465 smart_options->negotiation_tips = oids;
1468 static struct transport *prepare_transport(struct remote *remote, int deepen)
1470 struct transport *transport;
1472 transport = transport_get(remote, NULL);
1473 transport_set_verbosity(transport, verbosity, progress);
1474 transport->family = family;
1475 if (upload_pack)
1476 set_option(transport, TRANS_OPT_UPLOADPACK, upload_pack);
1477 if (keep)
1478 set_option(transport, TRANS_OPT_KEEP, "yes");
1479 if (depth)
1480 set_option(transport, TRANS_OPT_DEPTH, depth);
1481 if (deepen && deepen_since)
1482 set_option(transport, TRANS_OPT_DEEPEN_SINCE, deepen_since);
1483 if (deepen && deepen_not.nr)
1484 set_option(transport, TRANS_OPT_DEEPEN_NOT,
1485 (const char *)&deepen_not);
1486 if (deepen_relative)
1487 set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, "yes");
1488 if (update_shallow)
1489 set_option(transport, TRANS_OPT_UPDATE_SHALLOW, "yes");
1490 if (filter_options.choice) {
1491 const char *spec =
1492 expand_list_objects_filter_spec(&filter_options);
1493 set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER, spec);
1494 set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1496 if (negotiation_tip.nr) {
1497 if (transport->smart_options)
1498 add_negotiation_tips(transport->smart_options);
1499 else
1500 warning("ignoring --negotiation-tip because the protocol does not support it");
1502 return transport;
1505 static void backfill_tags(struct transport *transport, struct ref *ref_map,
1506 struct worktree **worktrees)
1508 int cannot_reuse;
1511 * Once we have set TRANS_OPT_DEEPEN_SINCE, we can't unset it
1512 * when remote helper is used (setting it to an empty string
1513 * is not unsetting). We could extend the remote helper
1514 * protocol for that, but for now, just force a new connection
1515 * without deepen-since. Similar story for deepen-not.
1517 cannot_reuse = transport->cannot_reuse ||
1518 deepen_since || deepen_not.nr;
1519 if (cannot_reuse) {
1520 gsecondary = prepare_transport(transport->remote, 0);
1521 transport = gsecondary;
1524 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, NULL);
1525 transport_set_option(transport, TRANS_OPT_DEPTH, "0");
1526 transport_set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, NULL);
1527 fetch_and_consume_refs(transport, ref_map, worktrees);
1529 if (gsecondary) {
1530 transport_disconnect(gsecondary);
1531 gsecondary = NULL;
1535 static int do_fetch(struct transport *transport,
1536 struct refspec *rs)
1538 struct ref *ref_map;
1539 int autotags = (transport->remote->fetch_tags == 1);
1540 int retcode = 0;
1541 const struct ref *remote_refs;
1542 struct transport_ls_refs_options transport_ls_refs_options =
1543 TRANSPORT_LS_REFS_OPTIONS_INIT;
1544 int must_list_refs = 1;
1545 struct worktree **worktrees = get_worktrees();
1547 if (tags == TAGS_DEFAULT) {
1548 if (transport->remote->fetch_tags == 2)
1549 tags = TAGS_SET;
1550 if (transport->remote->fetch_tags == -1)
1551 tags = TAGS_UNSET;
1554 /* if not appending, truncate FETCH_HEAD */
1555 if (!append && write_fetch_head) {
1556 retcode = truncate_fetch_head();
1557 if (retcode)
1558 goto cleanup;
1561 if (rs->nr) {
1562 int i;
1564 refspec_ref_prefixes(rs, &transport_ls_refs_options.ref_prefixes);
1567 * We can avoid listing refs if all of them are exact
1568 * OIDs
1570 must_list_refs = 0;
1571 for (i = 0; i < rs->nr; i++) {
1572 if (!rs->items[i].exact_sha1) {
1573 must_list_refs = 1;
1574 break;
1577 } else if (transport->remote && transport->remote->fetch.nr)
1578 refspec_ref_prefixes(&transport->remote->fetch,
1579 &transport_ls_refs_options.ref_prefixes);
1581 if (tags == TAGS_SET || tags == TAGS_DEFAULT) {
1582 must_list_refs = 1;
1583 if (transport_ls_refs_options.ref_prefixes.nr)
1584 strvec_push(&transport_ls_refs_options.ref_prefixes,
1585 "refs/tags/");
1588 if (must_list_refs) {
1589 trace2_region_enter("fetch", "remote_refs", the_repository);
1590 remote_refs = transport_get_remote_refs(transport,
1591 &transport_ls_refs_options);
1592 trace2_region_leave("fetch", "remote_refs", the_repository);
1593 } else
1594 remote_refs = NULL;
1596 strvec_clear(&transport_ls_refs_options.ref_prefixes);
1598 ref_map = get_ref_map(transport->remote, remote_refs, rs,
1599 tags, &autotags);
1600 if (!update_head_ok)
1601 check_not_current_branch(ref_map, worktrees);
1603 if (tags == TAGS_DEFAULT && autotags)
1604 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1605 if (prune) {
1607 * We only prune based on refspecs specified
1608 * explicitly (via command line or configuration); we
1609 * don't care whether --tags was specified.
1611 if (rs->nr) {
1612 prune_refs(rs, ref_map, transport->url);
1613 } else {
1614 prune_refs(&transport->remote->fetch,
1615 ref_map,
1616 transport->url);
1619 if (fetch_and_consume_refs(transport, ref_map, worktrees)) {
1620 free_refs(ref_map);
1621 retcode = 1;
1622 goto cleanup;
1625 if (set_upstream) {
1626 struct branch *branch = branch_get("HEAD");
1627 struct ref *rm;
1628 struct ref *source_ref = NULL;
1631 * We're setting the upstream configuration for the
1632 * current branch. The relevant upstream is the
1633 * fetched branch that is meant to be merged with the
1634 * current one, i.e. the one fetched to FETCH_HEAD.
1636 * When there are several such branches, consider the
1637 * request ambiguous and err on the safe side by doing
1638 * nothing and just emit a warning.
1640 for (rm = ref_map; rm; rm = rm->next) {
1641 if (!rm->peer_ref) {
1642 if (source_ref) {
1643 warning(_("multiple branches detected, incompatible with --set-upstream"));
1644 goto skip;
1645 } else {
1646 source_ref = rm;
1650 if (source_ref) {
1651 if (!branch) {
1652 const char *shortname = source_ref->name;
1653 skip_prefix(shortname, "refs/heads/", &shortname);
1655 warning(_("could not set upstream of HEAD to '%s' from '%s' when "
1656 "it does not point to any branch."),
1657 shortname, transport->remote->name);
1658 goto skip;
1661 if (!strcmp(source_ref->name, "HEAD") ||
1662 starts_with(source_ref->name, "refs/heads/"))
1663 install_branch_config(0,
1664 branch->name,
1665 transport->remote->name,
1666 source_ref->name);
1667 else if (starts_with(source_ref->name, "refs/remotes/"))
1668 warning(_("not setting upstream for a remote remote-tracking branch"));
1669 else if (starts_with(source_ref->name, "refs/tags/"))
1670 warning(_("not setting upstream for a remote tag"));
1671 else
1672 warning(_("unknown branch type"));
1673 } else {
1674 warning(_("no source branch found;\n"
1675 "you need to specify exactly one branch with the --set-upstream option"));
1678 skip:
1679 free_refs(ref_map);
1681 /* if neither --no-tags nor --tags was specified, do automated tag
1682 * following ... */
1683 if (tags == TAGS_DEFAULT && autotags) {
1684 struct ref **tail = &ref_map;
1685 ref_map = NULL;
1686 find_non_local_tags(remote_refs, &ref_map, &tail);
1687 if (ref_map)
1688 backfill_tags(transport, ref_map, worktrees);
1689 free_refs(ref_map);
1692 cleanup:
1693 free_worktrees(worktrees);
1694 return retcode;
1697 static int get_one_remote_for_fetch(struct remote *remote, void *priv)
1699 struct string_list *list = priv;
1700 if (!remote->skip_default_update)
1701 string_list_append(list, remote->name);
1702 return 0;
1705 struct remote_group_data {
1706 const char *name;
1707 struct string_list *list;
1710 static int get_remote_group(const char *key, const char *value, void *priv)
1712 struct remote_group_data *g = priv;
1714 if (skip_prefix(key, "remotes.", &key) && !strcmp(key, g->name)) {
1715 /* split list by white space */
1716 while (*value) {
1717 size_t wordlen = strcspn(value, " \t\n");
1719 if (wordlen >= 1)
1720 string_list_append_nodup(g->list,
1721 xstrndup(value, wordlen));
1722 value += wordlen + (value[wordlen] != '\0');
1726 return 0;
1729 static int add_remote_or_group(const char *name, struct string_list *list)
1731 int prev_nr = list->nr;
1732 struct remote_group_data g;
1733 g.name = name; g.list = list;
1735 git_config(get_remote_group, &g);
1736 if (list->nr == prev_nr) {
1737 struct remote *remote = remote_get(name);
1738 if (!remote_is_configured(remote, 0))
1739 return 0;
1740 string_list_append(list, remote->name);
1742 return 1;
1745 static void add_options_to_argv(struct strvec *argv)
1747 if (dry_run)
1748 strvec_push(argv, "--dry-run");
1749 if (prune != -1)
1750 strvec_push(argv, prune ? "--prune" : "--no-prune");
1751 if (prune_tags != -1)
1752 strvec_push(argv, prune_tags ? "--prune-tags" : "--no-prune-tags");
1753 if (update_head_ok)
1754 strvec_push(argv, "--update-head-ok");
1755 if (force)
1756 strvec_push(argv, "--force");
1757 if (keep)
1758 strvec_push(argv, "--keep");
1759 if (recurse_submodules == RECURSE_SUBMODULES_ON)
1760 strvec_push(argv, "--recurse-submodules");
1761 else if (recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND)
1762 strvec_push(argv, "--recurse-submodules=on-demand");
1763 if (tags == TAGS_SET)
1764 strvec_push(argv, "--tags");
1765 else if (tags == TAGS_UNSET)
1766 strvec_push(argv, "--no-tags");
1767 if (verbosity >= 2)
1768 strvec_push(argv, "-v");
1769 if (verbosity >= 1)
1770 strvec_push(argv, "-v");
1771 else if (verbosity < 0)
1772 strvec_push(argv, "-q");
1773 if (family == TRANSPORT_FAMILY_IPV4)
1774 strvec_push(argv, "--ipv4");
1775 else if (family == TRANSPORT_FAMILY_IPV6)
1776 strvec_push(argv, "--ipv6");
1779 /* Fetch multiple remotes in parallel */
1781 struct parallel_fetch_state {
1782 const char **argv;
1783 struct string_list *remotes;
1784 int next, result;
1787 static int fetch_next_remote(struct child_process *cp, struct strbuf *out,
1788 void *cb, void **task_cb)
1790 struct parallel_fetch_state *state = cb;
1791 char *remote;
1793 if (state->next < 0 || state->next >= state->remotes->nr)
1794 return 0;
1796 remote = state->remotes->items[state->next++].string;
1797 *task_cb = remote;
1799 strvec_pushv(&cp->args, state->argv);
1800 strvec_push(&cp->args, remote);
1801 cp->git_cmd = 1;
1803 if (verbosity >= 0)
1804 printf(_("Fetching %s\n"), remote);
1806 return 1;
1809 static int fetch_failed_to_start(struct strbuf *out, void *cb, void *task_cb)
1811 struct parallel_fetch_state *state = cb;
1812 const char *remote = task_cb;
1814 state->result = error(_("could not fetch %s"), remote);
1816 return 0;
1819 static int fetch_finished(int result, struct strbuf *out,
1820 void *cb, void *task_cb)
1822 struct parallel_fetch_state *state = cb;
1823 const char *remote = task_cb;
1825 if (result) {
1826 strbuf_addf(out, _("could not fetch '%s' (exit code: %d)\n"),
1827 remote, result);
1828 state->result = -1;
1831 return 0;
1834 static int fetch_multiple(struct string_list *list, int max_children)
1836 int i, result = 0;
1837 struct strvec argv = STRVEC_INIT;
1839 if (!append && write_fetch_head) {
1840 int errcode = truncate_fetch_head();
1841 if (errcode)
1842 return errcode;
1845 strvec_pushl(&argv, "fetch", "--append", "--no-auto-gc",
1846 "--no-write-commit-graph", NULL);
1847 add_options_to_argv(&argv);
1849 if (max_children != 1 && list->nr != 1) {
1850 struct parallel_fetch_state state = { argv.v, list, 0, 0 };
1852 strvec_push(&argv, "--end-of-options");
1853 result = run_processes_parallel_tr2(max_children,
1854 &fetch_next_remote,
1855 &fetch_failed_to_start,
1856 &fetch_finished,
1857 &state,
1858 "fetch", "parallel/fetch");
1860 if (!result)
1861 result = state.result;
1862 } else
1863 for (i = 0; i < list->nr; i++) {
1864 const char *name = list->items[i].string;
1865 strvec_push(&argv, name);
1866 if (verbosity >= 0)
1867 printf(_("Fetching %s\n"), name);
1868 if (run_command_v_opt(argv.v, RUN_GIT_CMD)) {
1869 error(_("could not fetch %s"), name);
1870 result = 1;
1872 strvec_pop(&argv);
1875 strvec_clear(&argv);
1876 return !!result;
1880 * Fetching from the promisor remote should use the given filter-spec
1881 * or inherit the default filter-spec from the config.
1883 static inline void fetch_one_setup_partial(struct remote *remote)
1886 * Explicit --no-filter argument overrides everything, regardless
1887 * of any prior partial clones and fetches.
1889 if (filter_options.no_filter)
1890 return;
1893 * If no prior partial clone/fetch and the current fetch DID NOT
1894 * request a partial-fetch, do a normal fetch.
1896 if (!has_promisor_remote() && !filter_options.choice)
1897 return;
1900 * If this is a partial-fetch request, we enable partial on
1901 * this repo if not already enabled and remember the given
1902 * filter-spec as the default for subsequent fetches to this
1903 * remote if there is currently no default filter-spec.
1905 if (filter_options.choice) {
1906 partial_clone_register(remote->name, &filter_options);
1907 return;
1911 * Do a partial-fetch from the promisor remote using either the
1912 * explicitly given filter-spec or inherit the filter-spec from
1913 * the config.
1915 if (!filter_options.choice)
1916 partial_clone_get_default_filter_spec(&filter_options, remote->name);
1917 return;
1920 static int fetch_one(struct remote *remote, int argc, const char **argv,
1921 int prune_tags_ok, int use_stdin_refspecs)
1923 struct refspec rs = REFSPEC_INIT_FETCH;
1924 int i;
1925 int exit_code;
1926 int maybe_prune_tags;
1927 int remote_via_config = remote_is_configured(remote, 0);
1929 if (!remote)
1930 die(_("no remote repository specified; please specify either a URL or a\n"
1931 "remote name from which new revisions should be fetched"));
1933 gtransport = prepare_transport(remote, 1);
1935 if (prune < 0) {
1936 /* no command line request */
1937 if (0 <= remote->prune)
1938 prune = remote->prune;
1939 else if (0 <= fetch_prune_config)
1940 prune = fetch_prune_config;
1941 else
1942 prune = PRUNE_BY_DEFAULT;
1945 if (prune_tags < 0) {
1946 /* no command line request */
1947 if (0 <= remote->prune_tags)
1948 prune_tags = remote->prune_tags;
1949 else if (0 <= fetch_prune_tags_config)
1950 prune_tags = fetch_prune_tags_config;
1951 else
1952 prune_tags = PRUNE_TAGS_BY_DEFAULT;
1955 maybe_prune_tags = prune_tags_ok && prune_tags;
1956 if (maybe_prune_tags && remote_via_config)
1957 refspec_append(&remote->fetch, TAG_REFSPEC);
1959 if (maybe_prune_tags && (argc || !remote_via_config))
1960 refspec_append(&rs, TAG_REFSPEC);
1962 for (i = 0; i < argc; i++) {
1963 if (!strcmp(argv[i], "tag")) {
1964 i++;
1965 if (i >= argc)
1966 die(_("you need to specify a tag name"));
1968 refspec_appendf(&rs, "refs/tags/%s:refs/tags/%s",
1969 argv[i], argv[i]);
1970 } else {
1971 refspec_append(&rs, argv[i]);
1975 if (use_stdin_refspecs) {
1976 struct strbuf line = STRBUF_INIT;
1977 while (strbuf_getline_lf(&line, stdin) != EOF)
1978 refspec_append(&rs, line.buf);
1979 strbuf_release(&line);
1982 if (server_options.nr)
1983 gtransport->server_options = &server_options;
1985 sigchain_push_common(unlock_pack_on_signal);
1986 atexit(unlock_pack_atexit);
1987 sigchain_push(SIGPIPE, SIG_IGN);
1988 exit_code = do_fetch(gtransport, &rs);
1989 sigchain_pop(SIGPIPE);
1990 refspec_clear(&rs);
1991 transport_disconnect(gtransport);
1992 gtransport = NULL;
1993 return exit_code;
1996 int cmd_fetch(int argc, const char **argv, const char *prefix)
1998 int i;
1999 struct string_list list = STRING_LIST_INIT_DUP;
2000 struct remote *remote = NULL;
2001 int result = 0;
2002 int prune_tags_ok = 1;
2004 packet_trace_identity("fetch");
2006 /* Record the command line for the reflog */
2007 strbuf_addstr(&default_rla, "fetch");
2008 for (i = 1; i < argc; i++) {
2009 /* This handles non-URLs gracefully */
2010 char *anon = transport_anonymize_url(argv[i]);
2012 strbuf_addf(&default_rla, " %s", anon);
2013 free(anon);
2016 git_config(git_fetch_config, NULL);
2017 prepare_repo_settings(the_repository);
2018 the_repository->settings.command_requires_full_index = 0;
2020 argc = parse_options(argc, argv, prefix,
2021 builtin_fetch_options, builtin_fetch_usage, 0);
2022 if (recurse_submodules != RECURSE_SUBMODULES_OFF) {
2023 int *sfjc = submodule_fetch_jobs_config == -1
2024 ? &submodule_fetch_jobs_config : NULL;
2025 int *rs = recurse_submodules == RECURSE_SUBMODULES_DEFAULT
2026 ? &recurse_submodules : NULL;
2028 fetch_config_from_gitmodules(sfjc, rs);
2031 if (negotiate_only && !negotiation_tip.nr)
2032 die(_("--negotiate-only needs one or more --negotiate-tip=*"));
2034 if (deepen_relative) {
2035 if (deepen_relative < 0)
2036 die(_("negative depth in --deepen is not supported"));
2037 if (depth)
2038 die(_("options '%s' and '%s' cannot be used together"), "--deepen", "--depth");
2039 depth = xstrfmt("%d", deepen_relative);
2041 if (unshallow) {
2042 if (depth)
2043 die(_("options '%s' and '%s' cannot be used together"), "--depth", "--unshallow");
2044 else if (!is_repository_shallow(the_repository))
2045 die(_("--unshallow on a complete repository does not make sense"));
2046 else
2047 depth = xstrfmt("%d", INFINITE_DEPTH);
2050 /* no need to be strict, transport_set_option() will validate it again */
2051 if (depth && atoi(depth) < 1)
2052 die(_("depth %s is not a positive number"), depth);
2053 if (depth || deepen_since || deepen_not.nr)
2054 deepen = 1;
2056 /* FETCH_HEAD never gets updated in --dry-run mode */
2057 if (dry_run)
2058 write_fetch_head = 0;
2060 if (all) {
2061 if (argc == 1)
2062 die(_("fetch --all does not take a repository argument"));
2063 else if (argc > 1)
2064 die(_("fetch --all does not make sense with refspecs"));
2065 (void) for_each_remote(get_one_remote_for_fetch, &list);
2066 } else if (argc == 0) {
2067 /* No arguments -- use default remote */
2068 remote = remote_get(NULL);
2069 } else if (multiple) {
2070 /* All arguments are assumed to be remotes or groups */
2071 for (i = 0; i < argc; i++)
2072 if (!add_remote_or_group(argv[i], &list))
2073 die(_("no such remote or remote group: %s"),
2074 argv[i]);
2075 } else {
2076 /* Single remote or group */
2077 (void) add_remote_or_group(argv[0], &list);
2078 if (list.nr > 1) {
2079 /* More than one remote */
2080 if (argc > 1)
2081 die(_("fetching a group and specifying refspecs does not make sense"));
2082 } else {
2083 /* Zero or one remotes */
2084 remote = remote_get(argv[0]);
2085 prune_tags_ok = (argc == 1);
2086 argc--;
2087 argv++;
2091 if (negotiate_only) {
2092 struct oidset acked_commits = OIDSET_INIT;
2093 struct oidset_iter iter;
2094 const struct object_id *oid;
2096 if (!remote)
2097 die(_("must supply remote when using --negotiate-only"));
2098 gtransport = prepare_transport(remote, 1);
2099 if (gtransport->smart_options) {
2100 gtransport->smart_options->acked_commits = &acked_commits;
2101 } else {
2102 warning(_("protocol does not support --negotiate-only, exiting"));
2103 return 1;
2105 if (server_options.nr)
2106 gtransport->server_options = &server_options;
2107 result = transport_fetch_refs(gtransport, NULL);
2109 oidset_iter_init(&acked_commits, &iter);
2110 while ((oid = oidset_iter_next(&iter)))
2111 printf("%s\n", oid_to_hex(oid));
2112 oidset_clear(&acked_commits);
2113 } else if (remote) {
2114 if (filter_options.choice || has_promisor_remote())
2115 fetch_one_setup_partial(remote);
2116 result = fetch_one(remote, argc, argv, prune_tags_ok, stdin_refspecs);
2117 } else {
2118 int max_children = max_jobs;
2120 if (filter_options.choice)
2121 die(_("--filter can only be used with the remote "
2122 "configured in extensions.partialclone"));
2124 if (atomic_fetch)
2125 die(_("--atomic can only be used when fetching "
2126 "from one remote"));
2128 if (stdin_refspecs)
2129 die(_("--stdin can only be used when fetching "
2130 "from one remote"));
2132 if (max_children < 0)
2133 max_children = fetch_parallel_config;
2135 /* TODO should this also die if we have a previous partial-clone? */
2136 result = fetch_multiple(&list, max_children);
2139 if (!result && (recurse_submodules != RECURSE_SUBMODULES_OFF)) {
2140 struct strvec options = STRVEC_INIT;
2141 int max_children = max_jobs;
2143 if (max_children < 0)
2144 max_children = submodule_fetch_jobs_config;
2145 if (max_children < 0)
2146 max_children = fetch_parallel_config;
2148 add_options_to_argv(&options);
2149 result = fetch_populated_submodules(the_repository,
2150 &options,
2151 submodule_prefix,
2152 recurse_submodules,
2153 recurse_submodules_default,
2154 verbosity < 0,
2155 max_children);
2156 strvec_clear(&options);
2159 string_list_clear(&list, 0);
2161 prepare_repo_settings(the_repository);
2162 if (fetch_write_commit_graph > 0 ||
2163 (fetch_write_commit_graph < 0 &&
2164 the_repository->settings.fetch_write_commit_graph)) {
2165 int commit_graph_flags = COMMIT_GRAPH_WRITE_SPLIT;
2167 if (progress)
2168 commit_graph_flags |= COMMIT_GRAPH_WRITE_PROGRESS;
2170 write_commit_graph_reachable(the_repository->objects->odb,
2171 commit_graph_flags,
2172 NULL);
2175 if (enable_auto_gc)
2176 run_auto_maintenance(verbosity < 0);
2178 return result;