2 #include "bundle-uri.h"
4 #include "object-store.h"
6 #include "run-command.h"
13 enum bundle_list_heuristic heuristic
;
15 } heuristics
[BUNDLE_HEURISTIC__COUNT
] = {
16 { BUNDLE_HEURISTIC_NONE
, ""},
17 { BUNDLE_HEURISTIC_CREATIONTOKEN
, "creationToken" },
20 static int compare_bundles(const void *hashmap_cmp_fn_data
,
21 const struct hashmap_entry
*he1
,
22 const struct hashmap_entry
*he2
,
25 const struct remote_bundle_info
*e1
=
26 container_of(he1
, const struct remote_bundle_info
, ent
);
27 const struct remote_bundle_info
*e2
=
28 container_of(he2
, const struct remote_bundle_info
, ent
);
30 return strcmp(e1
->id
, id
? (const char *)id
: e2
->id
);
33 void init_bundle_list(struct bundle_list
*list
)
35 memset(list
, 0, sizeof(*list
));
37 /* Implied defaults. */
38 list
->mode
= BUNDLE_MODE_ALL
;
41 hashmap_init(&list
->bundles
, compare_bundles
, NULL
, 0);
44 static int clear_remote_bundle_info(struct remote_bundle_info
*bundle
,
47 FREE_AND_NULL(bundle
->id
);
48 FREE_AND_NULL(bundle
->uri
);
49 FREE_AND_NULL(bundle
->file
);
50 bundle
->unbundled
= 0;
54 void clear_bundle_list(struct bundle_list
*list
)
59 for_all_bundles_in_list(list
, clear_remote_bundle_info
, NULL
);
60 hashmap_clear_and_free(&list
->bundles
, struct remote_bundle_info
, ent
);
64 int for_all_bundles_in_list(struct bundle_list
*list
,
68 struct remote_bundle_info
*info
;
69 struct hashmap_iter i
;
71 hashmap_for_each_entry(&list
->bundles
, &i
, info
, ent
) {
72 int result
= iter(info
, data
);
81 static int summarize_bundle(struct remote_bundle_info
*info
, void *data
)
84 fprintf(fp
, "[bundle \"%s\"]\n", info
->id
);
85 fprintf(fp
, "\turi = %s\n", info
->uri
);
87 if (info
->creationToken
)
88 fprintf(fp
, "\tcreationToken = %"PRIu64
"\n", info
->creationToken
);
92 void print_bundle_list(FILE *fp
, struct bundle_list
*list
)
101 case BUNDLE_MODE_ANY
:
105 case BUNDLE_MODE_NONE
:
110 fprintf(fp
, "[bundle]\n");
111 fprintf(fp
, "\tversion = %d\n", list
->version
);
112 fprintf(fp
, "\tmode = %s\n", mode
);
114 if (list
->heuristic
) {
116 for (i
= 0; i
< BUNDLE_HEURISTIC__COUNT
; i
++) {
117 if (heuristics
[i
].heuristic
== list
->heuristic
) {
118 printf("\theuristic = %s\n",
119 heuristics
[list
->heuristic
].name
);
125 for_all_bundles_in_list(list
, summarize_bundle
, fp
);
129 * Given a key-value pair, update the state of the given bundle list.
130 * Returns 0 if the key-value pair is understood. Returns -1 if the key
131 * is not understood or the value is malformed.
133 static int bundle_list_update(const char *key
, const char *value
,
134 struct bundle_list
*list
)
136 struct strbuf id
= STRBUF_INIT
;
137 struct remote_bundle_info lookup
= REMOTE_BUNDLE_INFO_INIT
;
138 struct remote_bundle_info
*bundle
;
139 const char *subsection
, *subkey
;
140 size_t subsection_len
;
142 if (parse_config_key(key
, "bundle", &subsection
, &subsection_len
, &subkey
))
145 if (!subsection_len
) {
146 if (!strcmp(subkey
, "version")) {
148 if (!git_parse_int(value
, &version
))
153 list
->version
= version
;
157 if (!strcmp(subkey
, "mode")) {
158 if (!strcmp(value
, "all"))
159 list
->mode
= BUNDLE_MODE_ALL
;
160 else if (!strcmp(value
, "any"))
161 list
->mode
= BUNDLE_MODE_ANY
;
167 if (!strcmp(subkey
, "heuristic")) {
169 for (i
= 0; i
< BUNDLE_HEURISTIC__COUNT
; i
++) {
170 if (heuristics
[i
].heuristic
&&
171 heuristics
[i
].name
&&
172 !strcmp(value
, heuristics
[i
].name
)) {
173 list
->heuristic
= heuristics
[i
].heuristic
;
178 /* Ignore unknown heuristics. */
182 /* Ignore other unknown global keys. */
186 strbuf_add(&id
, subsection
, subsection_len
);
189 * Check for an existing bundle with this <id>, or create one
193 hashmap_entry_init(&lookup
.ent
, strhash(lookup
.id
));
194 if (!(bundle
= hashmap_get_entry(&list
->bundles
, &lookup
, ent
, NULL
))) {
195 CALLOC_ARRAY(bundle
, 1);
196 bundle
->id
= strbuf_detach(&id
, NULL
);
197 hashmap_entry_init(&bundle
->ent
, strhash(bundle
->id
));
198 hashmap_add(&list
->bundles
, &bundle
->ent
);
202 if (!strcmp(subkey
, "uri")) {
205 bundle
->uri
= relative_url(list
->baseURI
, value
, NULL
);
209 if (!strcmp(subkey
, "creationtoken")) {
210 if (sscanf(value
, "%"PRIu64
, &bundle
->creationToken
) != 1)
211 warning(_("could not parse bundle list key %s with value '%s'"),
212 "creationToken", value
);
217 * At this point, we ignore any information that we don't
218 * understand, assuming it to be hints for a heuristic the client
219 * does not currently understand.
224 static int config_to_bundle_list(const char *key
, const char *value
, void *data
)
226 struct bundle_list
*list
= data
;
227 return bundle_list_update(key
, value
, list
);
230 int bundle_uri_parse_config_format(const char *uri
,
231 const char *filename
,
232 struct bundle_list
*list
)
235 struct config_options opts
= {
236 .error_action
= CONFIG_ERROR_ERROR
,
239 if (!list
->baseURI
) {
240 struct strbuf baseURI
= STRBUF_INIT
;
241 strbuf_addstr(&baseURI
, uri
);
244 * If the URI does not end with a trailing slash, then
245 * remove the filename portion of the path. This is
246 * important for relative URIs.
248 strbuf_strip_file_from_path(&baseURI
);
249 list
->baseURI
= strbuf_detach(&baseURI
, NULL
);
251 result
= git_config_from_file_with_options(config_to_bundle_list
,
255 if (!result
&& list
->mode
== BUNDLE_MODE_NONE
) {
256 warning(_("bundle list at '%s' has no mode"), uri
);
263 static char *find_temp_filename(void)
266 struct strbuf name
= STRBUF_INIT
;
268 * Find a temporary filename that is available. This is briefly
269 * racy, but unlikely to collide.
271 fd
= odb_mkstemp(&name
, "bundles/tmp_uri_XXXXXX");
273 warning(_("failed to create temporary file"));
279 return strbuf_detach(&name
, NULL
);
282 static int download_https_uri_to_file(const char *file
, const char *uri
)
285 struct child_process cp
= CHILD_PROCESS_INIT
;
286 FILE *child_in
= NULL
, *child_out
= NULL
;
287 struct strbuf line
= STRBUF_INIT
;
290 strvec_pushl(&cp
.args
, "git-remote-https", uri
, NULL
);
295 if (start_command(&cp
))
298 child_in
= fdopen(cp
.in
, "w");
304 child_out
= fdopen(cp
.out
, "r");
310 fprintf(child_in
, "capabilities\n");
313 while (!strbuf_getline(&line
, child_out
)) {
316 if (!strcmp(line
.buf
, "get"))
319 strbuf_release(&line
);
322 result
= error(_("insufficient capabilities"));
326 fprintf(child_in
, "get %s %s\n\n", uri
, file
);
331 if (finish_command(&cp
))
338 static int copy_uri_to_file(const char *filename
, const char *uri
)
342 if (starts_with(uri
, "https:") ||
343 starts_with(uri
, "http:"))
344 return download_https_uri_to_file(filename
, uri
);
346 if (skip_prefix(uri
, "file://", &out
))
350 return copy_file(filename
, uri
, 0);
353 static int unbundle_from_file(struct repository
*r
, const char *file
)
357 struct bundle_header header
= BUNDLE_HEADER_INIT
;
358 struct string_list_item
*refname
;
359 struct strbuf bundle_ref
= STRBUF_INIT
;
360 size_t bundle_prefix_len
;
362 if ((bundle_fd
= read_bundle_header(file
, &header
)) < 0)
366 * Skip the reachability walk here, since we will be adding
367 * a reachable ref pointing to the new tips, which will reach
368 * the prerequisite commits.
370 if ((result
= unbundle(r
, &header
, bundle_fd
, NULL
,
371 VERIFY_BUNDLE_QUIET
)))
375 * Convert all refs/heads/ from the bundle into refs/bundles/
376 * in the local repository.
378 strbuf_addstr(&bundle_ref
, "refs/bundles/");
379 bundle_prefix_len
= bundle_ref
.len
;
381 for_each_string_list_item(refname
, &header
.references
) {
382 struct object_id
*oid
= refname
->util
;
383 struct object_id old_oid
;
384 const char *branch_name
;
387 if (!skip_prefix(refname
->string
, "refs/heads/", &branch_name
))
390 strbuf_setlen(&bundle_ref
, bundle_prefix_len
);
391 strbuf_addstr(&bundle_ref
, branch_name
);
393 has_old
= !read_ref(bundle_ref
.buf
, &old_oid
);
394 update_ref("fetched bundle", bundle_ref
.buf
, oid
,
395 has_old
? &old_oid
: NULL
,
396 REF_SKIP_OID_VERIFICATION
,
397 UPDATE_REFS_MSG_ON_ERR
);
400 bundle_header_release(&header
);
404 struct bundle_list_context
{
405 struct repository
*r
;
406 struct bundle_list
*list
;
407 enum bundle_list_mode mode
;
413 * This early definition is necessary because we use indirect recursion:
415 * While iterating through a bundle list that was downloaded as part
416 * of fetch_bundle_uri_internal(), iterator methods eventually call it
417 * again, but with depth + 1.
419 static int fetch_bundle_uri_internal(struct repository
*r
,
420 struct remote_bundle_info
*bundle
,
422 struct bundle_list
*list
);
424 static int download_bundle_to_file(struct remote_bundle_info
*bundle
, void *data
)
427 struct bundle_list_context
*ctx
= data
;
429 if (ctx
->mode
== BUNDLE_MODE_ANY
&& ctx
->count
)
432 res
= fetch_bundle_uri_internal(ctx
->r
, bundle
, ctx
->depth
+ 1, ctx
->list
);
435 * Only increment count if the download succeeded. If our mode is
436 * BUNDLE_MODE_ANY, then we will want to try other URIs in the
437 * list in case they work instead.
443 * To be opportunistic as possible, we continue iterating and
444 * download as many bundles as we can, so we can apply the ones
445 * that work, even in BUNDLE_MODE_ALL mode.
450 struct bundles_for_sorting
{
451 struct remote_bundle_info
**items
;
456 static int append_bundle(struct remote_bundle_info
*bundle
, void *data
)
458 struct bundles_for_sorting
*list
= data
;
459 list
->items
[list
->nr
++] = bundle
;
464 * For use in QSORT() to get a list sorted by creationToken
465 * in decreasing order.
467 static int compare_creation_token_decreasing(const void *va
, const void *vb
)
469 const struct remote_bundle_info
* const *a
= va
;
470 const struct remote_bundle_info
* const *b
= vb
;
472 if ((*a
)->creationToken
> (*b
)->creationToken
)
474 if ((*a
)->creationToken
< (*b
)->creationToken
)
479 static int fetch_bundles_by_token(struct repository
*r
,
480 struct bundle_list
*list
)
483 int move_direction
= 0;
484 const char *creationTokenStr
;
485 uint64_t maxCreationToken
= 0, newMaxCreationToken
= 0;
486 struct bundle_list_context ctx
= {
491 struct bundles_for_sorting bundles
= {
492 .alloc
= hashmap_get_size(&list
->bundles
),
495 ALLOC_ARRAY(bundles
.items
, bundles
.alloc
);
497 for_all_bundles_in_list(list
, append_bundle
, &bundles
);
504 QSORT(bundles
.items
, bundles
.nr
, compare_creation_token_decreasing
);
507 * If fetch.bundleCreationToken exists, parses to a uint64t, and
508 * is not strictly smaller than the maximum creation token in the
509 * bundle list, then do not download any bundles.
511 if (!repo_config_get_value(r
,
512 "fetch.bundlecreationtoken",
513 &creationTokenStr
) &&
514 sscanf(creationTokenStr
, "%"PRIu64
, &maxCreationToken
) == 1 &&
515 bundles
.items
[0]->creationToken
<= maxCreationToken
) {
521 * Attempt to download and unbundle the minimum number of bundles by
522 * creationToken in decreasing order. If we fail to unbundle (after
523 * a successful download) then move to the next non-downloaded bundle
524 * and attempt downloading. Once we succeed in applying a bundle,
525 * move to the previous unapplied bundle and attempt to unbundle it
528 * In the case of a fresh clone, we will likely download all of the
529 * bundles before successfully unbundling the oldest one, then the
530 * rest of the bundles unbundle successfully in increasing order
533 * If there are existing objects, then this process may terminate
534 * early when all required commits from "new" bundles exist in the
535 * repo's object store.
538 while (cur
>= 0 && cur
< bundles
.nr
) {
539 struct remote_bundle_info
*bundle
= bundles
.items
[cur
];
542 * If we need to dig into bundles below the previous
543 * creation token value, then likely we are in an erroneous
544 * state due to missing or invalid bundles. Halt the process
545 * instead of continuing to download extra data.
547 if (bundle
->creationToken
<= maxCreationToken
)
552 * Not downloaded yet. Try downloading.
554 * Note that bundle->file is non-NULL if a download
555 * was attempted, even if it failed to download.
557 if (fetch_bundle_uri_internal(ctx
.r
, bundle
, ctx
.depth
+ 1, ctx
.list
)) {
558 /* Mark as unbundled so we do not retry. */
559 bundle
->unbundled
= 1;
561 /* Try looking deeper in the list. */
566 /* We expect bundles when using creationTokens. */
567 if (!is_bundle(bundle
->file
, 1)) {
568 warning(_("file downloaded from '%s' is not a bundle"),
574 if (bundle
->file
&& !bundle
->unbundled
) {
576 * This was downloaded, but not successfully
577 * unbundled. Try unbundling again.
579 if (unbundle_from_file(ctx
.r
, bundle
->file
)) {
580 /* Try looking deeper in the list. */
584 * Succeeded in unbundle. Retry bundles
585 * that previously failed to unbundle.
588 bundle
->unbundled
= 1;
590 if (bundle
->creationToken
> newMaxCreationToken
)
591 newMaxCreationToken
= bundle
->creationToken
;
596 * Else case: downloaded and unbundled successfully.
597 * Skip this by moving in the same direction as the
602 /* Move in the specified direction and repeat. */
603 cur
+= move_direction
;
607 * We succeed if the loop terminates because 'cur' drops below
608 * zero. The other case is that we terminate because 'cur'
609 * reaches the end of the list, so we have a failure no matter
610 * which bundles we apply from the list.
613 struct strbuf value
= STRBUF_INIT
;
614 strbuf_addf(&value
, "%"PRIu64
"", newMaxCreationToken
);
615 if (repo_config_set_multivar_gently(ctx
.r
,
616 "fetch.bundleCreationToken",
618 warning(_("failed to store maximum creation token"));
620 strbuf_release(&value
);
627 static int download_bundle_list(struct repository
*r
,
628 struct bundle_list
*local_list
,
629 struct bundle_list
*global_list
,
632 struct bundle_list_context ctx
= {
636 .mode
= local_list
->mode
,
639 return for_all_bundles_in_list(local_list
, download_bundle_to_file
, &ctx
);
642 static int fetch_bundle_list_in_config_format(struct repository
*r
,
643 struct bundle_list
*global_list
,
644 struct remote_bundle_info
*bundle
,
648 struct bundle_list list_from_bundle
;
650 init_bundle_list(&list_from_bundle
);
652 if ((result
= bundle_uri_parse_config_format(bundle
->uri
,
657 if (list_from_bundle
.mode
== BUNDLE_MODE_NONE
) {
658 warning(_("unrecognized bundle mode from URI '%s'"),
665 * If this list uses the creationToken heuristic, then the URIs
666 * it advertises are expected to be bundles, not nested lists.
667 * We can drop 'global_list' and 'depth'.
669 if (list_from_bundle
.heuristic
== BUNDLE_HEURISTIC_CREATIONTOKEN
) {
670 result
= fetch_bundles_by_token(r
, &list_from_bundle
);
671 global_list
->heuristic
= BUNDLE_HEURISTIC_CREATIONTOKEN
;
672 } else if ((result
= download_bundle_list(r
, &list_from_bundle
,
673 global_list
, depth
)))
677 clear_bundle_list(&list_from_bundle
);
682 * This limits the recursion on fetch_bundle_uri_internal() when following
685 static int max_bundle_uri_depth
= 4;
688 * Recursively download all bundles advertised at the given URI
689 * to files. If the file is a bundle, then add it to the given
690 * 'list'. Otherwise, expect a bundle list and recurse on the
691 * URIs in that list according to the list mode (ANY or ALL).
693 static int fetch_bundle_uri_internal(struct repository
*r
,
694 struct remote_bundle_info
*bundle
,
696 struct bundle_list
*list
)
699 struct remote_bundle_info
*bcopy
;
701 if (depth
>= max_bundle_uri_depth
) {
702 warning(_("exceeded bundle URI recursion limit (%d)"),
703 max_bundle_uri_depth
);
708 !(bundle
->file
= find_temp_filename())) {
713 if ((result
= copy_uri_to_file(bundle
->file
, bundle
->uri
))) {
714 warning(_("failed to download bundle from URI '%s'"), bundle
->uri
);
718 if ((result
= !is_bundle(bundle
->file
, 1))) {
719 result
= fetch_bundle_list_in_config_format(
720 r
, list
, bundle
, depth
);
722 warning(_("file at URI '%s' is not a bundle or bundle list"),
727 /* Copy the bundle and insert it into the global list. */
728 CALLOC_ARRAY(bcopy
, 1);
729 bcopy
->id
= xstrdup(bundle
->id
);
730 bcopy
->file
= xstrdup(bundle
->file
);
731 hashmap_entry_init(&bcopy
->ent
, strhash(bcopy
->id
));
732 hashmap_add(&list
->bundles
, &bcopy
->ent
);
735 if (result
&& bundle
->file
)
736 unlink(bundle
->file
);
741 * This loop iterator breaks the loop with nonzero return code on the
742 * first successful unbundling of a bundle.
744 static int attempt_unbundle(struct remote_bundle_info
*info
, void *data
)
746 struct repository
*r
= data
;
748 if (!info
->file
|| info
->unbundled
)
751 if (!unbundle_from_file(r
, info
->file
)) {
759 static int unbundle_all_bundles(struct repository
*r
,
760 struct bundle_list
*list
)
763 * Iterate through all bundles looking for ones that can
764 * successfully unbundle. If any succeed, then perhaps another
765 * will succeed in the next attempt.
767 * Keep in mind that a non-zero result for the loop here means
768 * the loop terminated early on a successful unbundling, which
769 * signals that we can try again.
771 while (for_all_bundles_in_list(list
, attempt_unbundle
, r
)) ;
776 static int unlink_bundle(struct remote_bundle_info
*info
, void *data
)
779 unlink_or_warn(info
->file
);
783 int fetch_bundle_uri(struct repository
*r
, const char *uri
,
787 struct bundle_list list
;
788 struct remote_bundle_info bundle
= {
793 init_bundle_list(&list
);
795 /* If a bundle is added to this global list, then it is required. */
796 list
.mode
= BUNDLE_MODE_ALL
;
798 if ((result
= fetch_bundle_uri_internal(r
, &bundle
, 0, &list
)))
801 result
= unbundle_all_bundles(r
, &list
);
805 *has_heuristic
= (list
.heuristic
!= BUNDLE_HEURISTIC_NONE
);
806 for_all_bundles_in_list(&list
, unlink_bundle
, NULL
);
807 clear_bundle_list(&list
);
808 clear_remote_bundle_info(&bundle
, NULL
);
812 int fetch_bundle_list(struct repository
*r
, struct bundle_list
*list
)
815 struct bundle_list global_list
;
818 * If the creationToken heuristic is used, then the URIs
819 * advertised by 'list' are not nested lists and instead
820 * direct bundles. We do not need to use global_list.
822 if (list
->heuristic
== BUNDLE_HEURISTIC_CREATIONTOKEN
)
823 return fetch_bundles_by_token(r
, list
);
825 init_bundle_list(&global_list
);
827 /* If a bundle is added to this global list, then it is required. */
828 global_list
.mode
= BUNDLE_MODE_ALL
;
830 if ((result
= download_bundle_list(r
, list
, &global_list
, 0)))
833 if (list
->heuristic
== BUNDLE_HEURISTIC_CREATIONTOKEN
)
834 result
= fetch_bundles_by_token(r
, list
);
836 result
= unbundle_all_bundles(r
, &global_list
);
839 for_all_bundles_in_list(&global_list
, unlink_bundle
, NULL
);
840 clear_bundle_list(&global_list
);
848 int bundle_uri_advertise(struct repository
*r
, struct strbuf
*value UNUSED
)
850 static int advertise_bundle_uri
= -1;
852 if (advertise_bundle_uri
!= -1)
855 advertise_bundle_uri
= 0;
856 repo_config_get_maybe_bool(r
, "uploadpack.advertisebundleuris", &advertise_bundle_uri
);
859 return advertise_bundle_uri
;
862 static int config_to_packet_line(const char *key
, const char *value
, void *data
)
864 struct packet_reader
*writer
= data
;
866 if (starts_with(key
, "bundle."))
867 packet_write_fmt(writer
->fd
, "%s=%s", key
, value
);
872 int bundle_uri_command(struct repository
*r
,
873 struct packet_reader
*request
)
875 struct packet_writer writer
;
876 packet_writer_init(&writer
, 1);
878 while (packet_reader_read(request
) == PACKET_READ_NORMAL
)
879 die(_("bundle-uri: unexpected argument: '%s'"), request
->line
);
880 if (request
->status
!= PACKET_READ_FLUSH
)
881 die(_("bundle-uri: expected flush after arguments"));
884 * Read all "bundle.*" config lines to the client as key=value
887 repo_config(r
, config_to_packet_line
, &writer
);
889 packet_writer_flush(&writer
);
895 * General API for {transport,connect}.c etc.
897 int bundle_uri_parse_line(struct bundle_list
*list
, const char *line
)
901 struct strbuf key
= STRBUF_INIT
;
904 return error(_("bundle-uri: got an empty line"));
906 equals
= strchr(line
, '=');
909 return error(_("bundle-uri: line is not of the form 'key=value'"));
910 if (line
== equals
|| !*(equals
+ 1))
911 return error(_("bundle-uri: line has empty key or value"));
913 strbuf_add(&key
, line
, equals
- line
);
914 result
= bundle_list_update(key
.buf
, equals
+ 1, list
);
915 strbuf_release(&key
);