2 #include "bundle-uri.h"
4 #include "environment.h"
6 #include "object-store.h"
8 #include "run-command.h"
15 enum bundle_list_heuristic heuristic
;
17 } heuristics
[BUNDLE_HEURISTIC__COUNT
] = {
18 { BUNDLE_HEURISTIC_NONE
, ""},
19 { BUNDLE_HEURISTIC_CREATIONTOKEN
, "creationToken" },
22 static int compare_bundles(const void *hashmap_cmp_fn_data
,
23 const struct hashmap_entry
*he1
,
24 const struct hashmap_entry
*he2
,
27 const struct remote_bundle_info
*e1
=
28 container_of(he1
, const struct remote_bundle_info
, ent
);
29 const struct remote_bundle_info
*e2
=
30 container_of(he2
, const struct remote_bundle_info
, ent
);
32 return strcmp(e1
->id
, id
? (const char *)id
: e2
->id
);
35 void init_bundle_list(struct bundle_list
*list
)
37 memset(list
, 0, sizeof(*list
));
39 /* Implied defaults. */
40 list
->mode
= BUNDLE_MODE_ALL
;
43 hashmap_init(&list
->bundles
, compare_bundles
, NULL
, 0);
46 static int clear_remote_bundle_info(struct remote_bundle_info
*bundle
,
49 FREE_AND_NULL(bundle
->id
);
50 FREE_AND_NULL(bundle
->uri
);
51 FREE_AND_NULL(bundle
->file
);
52 bundle
->unbundled
= 0;
56 void clear_bundle_list(struct bundle_list
*list
)
61 for_all_bundles_in_list(list
, clear_remote_bundle_info
, NULL
);
62 hashmap_clear_and_free(&list
->bundles
, struct remote_bundle_info
, ent
);
66 int for_all_bundles_in_list(struct bundle_list
*list
,
70 struct remote_bundle_info
*info
;
71 struct hashmap_iter i
;
73 hashmap_for_each_entry(&list
->bundles
, &i
, info
, ent
) {
74 int result
= iter(info
, data
);
83 static int summarize_bundle(struct remote_bundle_info
*info
, void *data
)
86 fprintf(fp
, "[bundle \"%s\"]\n", info
->id
);
87 fprintf(fp
, "\turi = %s\n", info
->uri
);
89 if (info
->creationToken
)
90 fprintf(fp
, "\tcreationToken = %"PRIu64
"\n", info
->creationToken
);
94 void print_bundle_list(FILE *fp
, struct bundle_list
*list
)
103 case BUNDLE_MODE_ANY
:
107 case BUNDLE_MODE_NONE
:
112 fprintf(fp
, "[bundle]\n");
113 fprintf(fp
, "\tversion = %d\n", list
->version
);
114 fprintf(fp
, "\tmode = %s\n", mode
);
116 if (list
->heuristic
) {
118 for (i
= 0; i
< BUNDLE_HEURISTIC__COUNT
; i
++) {
119 if (heuristics
[i
].heuristic
== list
->heuristic
) {
120 printf("\theuristic = %s\n",
121 heuristics
[list
->heuristic
].name
);
127 for_all_bundles_in_list(list
, summarize_bundle
, fp
);
131 * Given a key-value pair, update the state of the given bundle list.
132 * Returns 0 if the key-value pair is understood. Returns -1 if the key
133 * is not understood or the value is malformed.
135 static int bundle_list_update(const char *key
, const char *value
,
136 struct bundle_list
*list
)
138 struct strbuf id
= STRBUF_INIT
;
139 struct remote_bundle_info lookup
= REMOTE_BUNDLE_INFO_INIT
;
140 struct remote_bundle_info
*bundle
;
141 const char *subsection
, *subkey
;
142 size_t subsection_len
;
144 if (parse_config_key(key
, "bundle", &subsection
, &subsection_len
, &subkey
))
147 if (!subsection_len
) {
148 if (!strcmp(subkey
, "version")) {
150 if (!git_parse_int(value
, &version
))
155 list
->version
= version
;
159 if (!strcmp(subkey
, "mode")) {
160 if (!strcmp(value
, "all"))
161 list
->mode
= BUNDLE_MODE_ALL
;
162 else if (!strcmp(value
, "any"))
163 list
->mode
= BUNDLE_MODE_ANY
;
169 if (!strcmp(subkey
, "heuristic")) {
171 for (i
= 0; i
< BUNDLE_HEURISTIC__COUNT
; i
++) {
172 if (heuristics
[i
].heuristic
&&
173 heuristics
[i
].name
&&
174 !strcmp(value
, heuristics
[i
].name
)) {
175 list
->heuristic
= heuristics
[i
].heuristic
;
180 /* Ignore unknown heuristics. */
184 /* Ignore other unknown global keys. */
188 strbuf_add(&id
, subsection
, subsection_len
);
191 * Check for an existing bundle with this <id>, or create one
195 hashmap_entry_init(&lookup
.ent
, strhash(lookup
.id
));
196 if (!(bundle
= hashmap_get_entry(&list
->bundles
, &lookup
, ent
, NULL
))) {
197 CALLOC_ARRAY(bundle
, 1);
198 bundle
->id
= strbuf_detach(&id
, NULL
);
199 hashmap_entry_init(&bundle
->ent
, strhash(bundle
->id
));
200 hashmap_add(&list
->bundles
, &bundle
->ent
);
204 if (!strcmp(subkey
, "uri")) {
207 bundle
->uri
= relative_url(list
->baseURI
, value
, NULL
);
211 if (!strcmp(subkey
, "creationtoken")) {
212 if (sscanf(value
, "%"PRIu64
, &bundle
->creationToken
) != 1)
213 warning(_("could not parse bundle list key %s with value '%s'"),
214 "creationToken", value
);
219 * At this point, we ignore any information that we don't
220 * understand, assuming it to be hints for a heuristic the client
221 * does not currently understand.
226 static int config_to_bundle_list(const char *key
, const char *value
, void *data
)
228 struct bundle_list
*list
= data
;
229 return bundle_list_update(key
, value
, list
);
232 int bundle_uri_parse_config_format(const char *uri
,
233 const char *filename
,
234 struct bundle_list
*list
)
237 struct config_options opts
= {
238 .error_action
= CONFIG_ERROR_ERROR
,
241 if (!list
->baseURI
) {
242 struct strbuf baseURI
= STRBUF_INIT
;
243 strbuf_addstr(&baseURI
, uri
);
246 * If the URI does not end with a trailing slash, then
247 * remove the filename portion of the path. This is
248 * important for relative URIs.
250 strbuf_strip_file_from_path(&baseURI
);
251 list
->baseURI
= strbuf_detach(&baseURI
, NULL
);
253 result
= git_config_from_file_with_options(config_to_bundle_list
,
257 if (!result
&& list
->mode
== BUNDLE_MODE_NONE
) {
258 warning(_("bundle list at '%s' has no mode"), uri
);
265 static char *find_temp_filename(void)
268 struct strbuf name
= STRBUF_INIT
;
270 * Find a temporary filename that is available. This is briefly
271 * racy, but unlikely to collide.
273 fd
= odb_mkstemp(&name
, "bundles/tmp_uri_XXXXXX");
275 warning(_("failed to create temporary file"));
281 return strbuf_detach(&name
, NULL
);
284 static int download_https_uri_to_file(const char *file
, const char *uri
)
287 struct child_process cp
= CHILD_PROCESS_INIT
;
288 FILE *child_in
= NULL
, *child_out
= NULL
;
289 struct strbuf line
= STRBUF_INIT
;
292 strvec_pushl(&cp
.args
, "git-remote-https", uri
, NULL
);
297 if (start_command(&cp
))
300 child_in
= fdopen(cp
.in
, "w");
306 child_out
= fdopen(cp
.out
, "r");
312 fprintf(child_in
, "capabilities\n");
315 while (!strbuf_getline(&line
, child_out
)) {
318 if (!strcmp(line
.buf
, "get"))
321 strbuf_release(&line
);
324 result
= error(_("insufficient capabilities"));
328 fprintf(child_in
, "get %s %s\n\n", uri
, file
);
333 if (finish_command(&cp
))
340 static int copy_uri_to_file(const char *filename
, const char *uri
)
344 if (starts_with(uri
, "https:") ||
345 starts_with(uri
, "http:"))
346 return download_https_uri_to_file(filename
, uri
);
348 if (skip_prefix(uri
, "file://", &out
))
352 return copy_file(filename
, uri
, 0);
355 static int unbundle_from_file(struct repository
*r
, const char *file
)
359 struct bundle_header header
= BUNDLE_HEADER_INIT
;
360 struct string_list_item
*refname
;
361 struct strbuf bundle_ref
= STRBUF_INIT
;
362 size_t bundle_prefix_len
;
364 if ((bundle_fd
= read_bundle_header(file
, &header
)) < 0)
368 * Skip the reachability walk here, since we will be adding
369 * a reachable ref pointing to the new tips, which will reach
370 * the prerequisite commits.
372 if ((result
= unbundle(r
, &header
, bundle_fd
, NULL
,
373 VERIFY_BUNDLE_QUIET
)))
377 * Convert all refs/heads/ from the bundle into refs/bundles/
378 * in the local repository.
380 strbuf_addstr(&bundle_ref
, "refs/bundles/");
381 bundle_prefix_len
= bundle_ref
.len
;
383 for_each_string_list_item(refname
, &header
.references
) {
384 struct object_id
*oid
= refname
->util
;
385 struct object_id old_oid
;
386 const char *branch_name
;
389 if (!skip_prefix(refname
->string
, "refs/heads/", &branch_name
))
392 strbuf_setlen(&bundle_ref
, bundle_prefix_len
);
393 strbuf_addstr(&bundle_ref
, branch_name
);
395 has_old
= !read_ref(bundle_ref
.buf
, &old_oid
);
396 update_ref("fetched bundle", bundle_ref
.buf
, oid
,
397 has_old
? &old_oid
: NULL
,
398 REF_SKIP_OID_VERIFICATION
,
399 UPDATE_REFS_MSG_ON_ERR
);
402 bundle_header_release(&header
);
406 struct bundle_list_context
{
407 struct repository
*r
;
408 struct bundle_list
*list
;
409 enum bundle_list_mode mode
;
415 * This early definition is necessary because we use indirect recursion:
417 * While iterating through a bundle list that was downloaded as part
418 * of fetch_bundle_uri_internal(), iterator methods eventually call it
419 * again, but with depth + 1.
421 static int fetch_bundle_uri_internal(struct repository
*r
,
422 struct remote_bundle_info
*bundle
,
424 struct bundle_list
*list
);
426 static int download_bundle_to_file(struct remote_bundle_info
*bundle
, void *data
)
429 struct bundle_list_context
*ctx
= data
;
431 if (ctx
->mode
== BUNDLE_MODE_ANY
&& ctx
->count
)
434 res
= fetch_bundle_uri_internal(ctx
->r
, bundle
, ctx
->depth
+ 1, ctx
->list
);
437 * Only increment count if the download succeeded. If our mode is
438 * BUNDLE_MODE_ANY, then we will want to try other URIs in the
439 * list in case they work instead.
445 * To be opportunistic as possible, we continue iterating and
446 * download as many bundles as we can, so we can apply the ones
447 * that work, even in BUNDLE_MODE_ALL mode.
452 struct bundles_for_sorting
{
453 struct remote_bundle_info
**items
;
458 static int append_bundle(struct remote_bundle_info
*bundle
, void *data
)
460 struct bundles_for_sorting
*list
= data
;
461 list
->items
[list
->nr
++] = bundle
;
466 * For use in QSORT() to get a list sorted by creationToken
467 * in decreasing order.
469 static int compare_creation_token_decreasing(const void *va
, const void *vb
)
471 const struct remote_bundle_info
* const *a
= va
;
472 const struct remote_bundle_info
* const *b
= vb
;
474 if ((*a
)->creationToken
> (*b
)->creationToken
)
476 if ((*a
)->creationToken
< (*b
)->creationToken
)
481 static int fetch_bundles_by_token(struct repository
*r
,
482 struct bundle_list
*list
)
485 int move_direction
= 0;
486 const char *creationTokenStr
;
487 uint64_t maxCreationToken
= 0, newMaxCreationToken
= 0;
488 struct bundle_list_context ctx
= {
493 struct bundles_for_sorting bundles
= {
494 .alloc
= hashmap_get_size(&list
->bundles
),
497 ALLOC_ARRAY(bundles
.items
, bundles
.alloc
);
499 for_all_bundles_in_list(list
, append_bundle
, &bundles
);
506 QSORT(bundles
.items
, bundles
.nr
, compare_creation_token_decreasing
);
509 * If fetch.bundleCreationToken exists, parses to a uint64t, and
510 * is not strictly smaller than the maximum creation token in the
511 * bundle list, then do not download any bundles.
513 if (!repo_config_get_value(r
,
514 "fetch.bundlecreationtoken",
515 &creationTokenStr
) &&
516 sscanf(creationTokenStr
, "%"PRIu64
, &maxCreationToken
) == 1 &&
517 bundles
.items
[0]->creationToken
<= maxCreationToken
) {
523 * Attempt to download and unbundle the minimum number of bundles by
524 * creationToken in decreasing order. If we fail to unbundle (after
525 * a successful download) then move to the next non-downloaded bundle
526 * and attempt downloading. Once we succeed in applying a bundle,
527 * move to the previous unapplied bundle and attempt to unbundle it
530 * In the case of a fresh clone, we will likely download all of the
531 * bundles before successfully unbundling the oldest one, then the
532 * rest of the bundles unbundle successfully in increasing order
535 * If there are existing objects, then this process may terminate
536 * early when all required commits from "new" bundles exist in the
537 * repo's object store.
540 while (cur
>= 0 && cur
< bundles
.nr
) {
541 struct remote_bundle_info
*bundle
= bundles
.items
[cur
];
544 * If we need to dig into bundles below the previous
545 * creation token value, then likely we are in an erroneous
546 * state due to missing or invalid bundles. Halt the process
547 * instead of continuing to download extra data.
549 if (bundle
->creationToken
<= maxCreationToken
)
554 * Not downloaded yet. Try downloading.
556 * Note that bundle->file is non-NULL if a download
557 * was attempted, even if it failed to download.
559 if (fetch_bundle_uri_internal(ctx
.r
, bundle
, ctx
.depth
+ 1, ctx
.list
)) {
560 /* Mark as unbundled so we do not retry. */
561 bundle
->unbundled
= 1;
563 /* Try looking deeper in the list. */
568 /* We expect bundles when using creationTokens. */
569 if (!is_bundle(bundle
->file
, 1)) {
570 warning(_("file downloaded from '%s' is not a bundle"),
576 if (bundle
->file
&& !bundle
->unbundled
) {
578 * This was downloaded, but not successfully
579 * unbundled. Try unbundling again.
581 if (unbundle_from_file(ctx
.r
, bundle
->file
)) {
582 /* Try looking deeper in the list. */
586 * Succeeded in unbundle. Retry bundles
587 * that previously failed to unbundle.
590 bundle
->unbundled
= 1;
592 if (bundle
->creationToken
> newMaxCreationToken
)
593 newMaxCreationToken
= bundle
->creationToken
;
598 * Else case: downloaded and unbundled successfully.
599 * Skip this by moving in the same direction as the
604 /* Move in the specified direction and repeat. */
605 cur
+= move_direction
;
609 * We succeed if the loop terminates because 'cur' drops below
610 * zero. The other case is that we terminate because 'cur'
611 * reaches the end of the list, so we have a failure no matter
612 * which bundles we apply from the list.
615 struct strbuf value
= STRBUF_INIT
;
616 strbuf_addf(&value
, "%"PRIu64
"", newMaxCreationToken
);
617 if (repo_config_set_multivar_gently(ctx
.r
,
618 "fetch.bundleCreationToken",
620 warning(_("failed to store maximum creation token"));
622 strbuf_release(&value
);
629 static int download_bundle_list(struct repository
*r
,
630 struct bundle_list
*local_list
,
631 struct bundle_list
*global_list
,
634 struct bundle_list_context ctx
= {
638 .mode
= local_list
->mode
,
641 return for_all_bundles_in_list(local_list
, download_bundle_to_file
, &ctx
);
644 static int fetch_bundle_list_in_config_format(struct repository
*r
,
645 struct bundle_list
*global_list
,
646 struct remote_bundle_info
*bundle
,
650 struct bundle_list list_from_bundle
;
652 init_bundle_list(&list_from_bundle
);
654 if ((result
= bundle_uri_parse_config_format(bundle
->uri
,
659 if (list_from_bundle
.mode
== BUNDLE_MODE_NONE
) {
660 warning(_("unrecognized bundle mode from URI '%s'"),
667 * If this list uses the creationToken heuristic, then the URIs
668 * it advertises are expected to be bundles, not nested lists.
669 * We can drop 'global_list' and 'depth'.
671 if (list_from_bundle
.heuristic
== BUNDLE_HEURISTIC_CREATIONTOKEN
) {
672 result
= fetch_bundles_by_token(r
, &list_from_bundle
);
673 global_list
->heuristic
= BUNDLE_HEURISTIC_CREATIONTOKEN
;
674 } else if ((result
= download_bundle_list(r
, &list_from_bundle
,
675 global_list
, depth
)))
679 clear_bundle_list(&list_from_bundle
);
684 * This limits the recursion on fetch_bundle_uri_internal() when following
687 static int max_bundle_uri_depth
= 4;
690 * Recursively download all bundles advertised at the given URI
691 * to files. If the file is a bundle, then add it to the given
692 * 'list'. Otherwise, expect a bundle list and recurse on the
693 * URIs in that list according to the list mode (ANY or ALL).
695 static int fetch_bundle_uri_internal(struct repository
*r
,
696 struct remote_bundle_info
*bundle
,
698 struct bundle_list
*list
)
701 struct remote_bundle_info
*bcopy
;
703 if (depth
>= max_bundle_uri_depth
) {
704 warning(_("exceeded bundle URI recursion limit (%d)"),
705 max_bundle_uri_depth
);
710 !(bundle
->file
= find_temp_filename())) {
715 if ((result
= copy_uri_to_file(bundle
->file
, bundle
->uri
))) {
716 warning(_("failed to download bundle from URI '%s'"), bundle
->uri
);
720 if ((result
= !is_bundle(bundle
->file
, 1))) {
721 result
= fetch_bundle_list_in_config_format(
722 r
, list
, bundle
, depth
);
724 warning(_("file at URI '%s' is not a bundle or bundle list"),
729 /* Copy the bundle and insert it into the global list. */
730 CALLOC_ARRAY(bcopy
, 1);
731 bcopy
->id
= xstrdup(bundle
->id
);
732 bcopy
->file
= xstrdup(bundle
->file
);
733 hashmap_entry_init(&bcopy
->ent
, strhash(bcopy
->id
));
734 hashmap_add(&list
->bundles
, &bcopy
->ent
);
737 if (result
&& bundle
->file
)
738 unlink(bundle
->file
);
743 * This loop iterator breaks the loop with nonzero return code on the
744 * first successful unbundling of a bundle.
746 static int attempt_unbundle(struct remote_bundle_info
*info
, void *data
)
748 struct repository
*r
= data
;
750 if (!info
->file
|| info
->unbundled
)
753 if (!unbundle_from_file(r
, info
->file
)) {
761 static int unbundle_all_bundles(struct repository
*r
,
762 struct bundle_list
*list
)
765 * Iterate through all bundles looking for ones that can
766 * successfully unbundle. If any succeed, then perhaps another
767 * will succeed in the next attempt.
769 * Keep in mind that a non-zero result for the loop here means
770 * the loop terminated early on a successful unbundling, which
771 * signals that we can try again.
773 while (for_all_bundles_in_list(list
, attempt_unbundle
, r
)) ;
778 static int unlink_bundle(struct remote_bundle_info
*info
, void *data
)
781 unlink_or_warn(info
->file
);
785 int fetch_bundle_uri(struct repository
*r
, const char *uri
,
789 struct bundle_list list
;
790 struct remote_bundle_info bundle
= {
795 init_bundle_list(&list
);
798 * Do not fetch a NULL or empty bundle URI. An empty bundle URI
799 * could signal that a configured bundle URI has been disabled.
806 /* If a bundle is added to this global list, then it is required. */
807 list
.mode
= BUNDLE_MODE_ALL
;
809 if ((result
= fetch_bundle_uri_internal(r
, &bundle
, 0, &list
)))
812 result
= unbundle_all_bundles(r
, &list
);
816 *has_heuristic
= (list
.heuristic
!= BUNDLE_HEURISTIC_NONE
);
817 for_all_bundles_in_list(&list
, unlink_bundle
, NULL
);
818 clear_bundle_list(&list
);
819 clear_remote_bundle_info(&bundle
, NULL
);
823 int fetch_bundle_list(struct repository
*r
, struct bundle_list
*list
)
826 struct bundle_list global_list
;
829 * If the creationToken heuristic is used, then the URIs
830 * advertised by 'list' are not nested lists and instead
831 * direct bundles. We do not need to use global_list.
833 if (list
->heuristic
== BUNDLE_HEURISTIC_CREATIONTOKEN
)
834 return fetch_bundles_by_token(r
, list
);
836 init_bundle_list(&global_list
);
838 /* If a bundle is added to this global list, then it is required. */
839 global_list
.mode
= BUNDLE_MODE_ALL
;
841 if ((result
= download_bundle_list(r
, list
, &global_list
, 0)))
844 if (list
->heuristic
== BUNDLE_HEURISTIC_CREATIONTOKEN
)
845 result
= fetch_bundles_by_token(r
, list
);
847 result
= unbundle_all_bundles(r
, &global_list
);
850 for_all_bundles_in_list(&global_list
, unlink_bundle
, NULL
);
851 clear_bundle_list(&global_list
);
859 int bundle_uri_advertise(struct repository
*r
, struct strbuf
*value UNUSED
)
861 static int advertise_bundle_uri
= -1;
863 if (advertise_bundle_uri
!= -1)
866 advertise_bundle_uri
= 0;
867 repo_config_get_maybe_bool(r
, "uploadpack.advertisebundleuris", &advertise_bundle_uri
);
870 return advertise_bundle_uri
;
873 static int config_to_packet_line(const char *key
, const char *value
, void *data
)
875 struct packet_reader
*writer
= data
;
877 if (starts_with(key
, "bundle."))
878 packet_write_fmt(writer
->fd
, "%s=%s", key
, value
);
883 int bundle_uri_command(struct repository
*r
,
884 struct packet_reader
*request
)
886 struct packet_writer writer
;
887 packet_writer_init(&writer
, 1);
889 while (packet_reader_read(request
) == PACKET_READ_NORMAL
)
890 die(_("bundle-uri: unexpected argument: '%s'"), request
->line
);
891 if (request
->status
!= PACKET_READ_FLUSH
)
892 die(_("bundle-uri: expected flush after arguments"));
895 * Read all "bundle.*" config lines to the client as key=value
898 repo_config(r
, config_to_packet_line
, &writer
);
900 packet_writer_flush(&writer
);
906 * General API for {transport,connect}.c etc.
908 int bundle_uri_parse_line(struct bundle_list
*list
, const char *line
)
912 struct strbuf key
= STRBUF_INIT
;
915 return error(_("bundle-uri: got an empty line"));
917 equals
= strchr(line
, '=');
920 return error(_("bundle-uri: line is not of the form 'key=value'"));
921 if (line
== equals
|| !*(equals
+ 1))
922 return error(_("bundle-uri: line has empty key or value"));
924 strbuf_add(&key
, line
, equals
- line
);
925 result
= bundle_list_update(key
.buf
, equals
+ 1, list
);
926 strbuf_release(&key
);