1 #define USE_THE_REPOSITORY_VARIABLE
3 #include "git-compat-util.h"
4 #include "bundle-uri.h"
7 #include "environment.h"
10 #include "run-command.h"
17 enum bundle_list_heuristic heuristic
;
19 } heuristics
[BUNDLE_HEURISTIC__COUNT
] = {
20 { BUNDLE_HEURISTIC_NONE
, ""},
21 { BUNDLE_HEURISTIC_CREATIONTOKEN
, "creationToken" },
24 static int compare_bundles(const void *hashmap_cmp_fn_data UNUSED
,
25 const struct hashmap_entry
*he1
,
26 const struct hashmap_entry
*he2
,
29 const struct remote_bundle_info
*e1
=
30 container_of(he1
, const struct remote_bundle_info
, ent
);
31 const struct remote_bundle_info
*e2
=
32 container_of(he2
, const struct remote_bundle_info
, ent
);
34 return strcmp(e1
->id
, id
? (const char *)id
: e2
->id
);
37 void init_bundle_list(struct bundle_list
*list
)
39 memset(list
, 0, sizeof(*list
));
41 /* Implied defaults. */
42 list
->mode
= BUNDLE_MODE_ALL
;
45 hashmap_init(&list
->bundles
, compare_bundles
, NULL
, 0);
48 static int clear_remote_bundle_info(struct remote_bundle_info
*bundle
,
51 FREE_AND_NULL(bundle
->id
);
52 FREE_AND_NULL(bundle
->uri
);
53 FREE_AND_NULL(bundle
->file
);
54 bundle
->unbundled
= 0;
58 void clear_bundle_list(struct bundle_list
*list
)
63 for_all_bundles_in_list(list
, clear_remote_bundle_info
, NULL
);
64 hashmap_clear_and_free(&list
->bundles
, struct remote_bundle_info
, ent
);
68 int for_all_bundles_in_list(struct bundle_list
*list
,
72 struct remote_bundle_info
*info
;
73 struct hashmap_iter i
;
75 hashmap_for_each_entry(&list
->bundles
, &i
, info
, ent
) {
76 int result
= iter(info
, data
);
85 static int summarize_bundle(struct remote_bundle_info
*info
, void *data
)
88 fprintf(fp
, "[bundle \"%s\"]\n", info
->id
);
89 fprintf(fp
, "\turi = %s\n", info
->uri
);
91 if (info
->creationToken
)
92 fprintf(fp
, "\tcreationToken = %"PRIu64
"\n", info
->creationToken
);
96 void print_bundle_list(FILE *fp
, struct bundle_list
*list
)
100 switch (list
->mode
) {
101 case BUNDLE_MODE_ALL
:
105 case BUNDLE_MODE_ANY
:
109 case BUNDLE_MODE_NONE
:
114 fprintf(fp
, "[bundle]\n");
115 fprintf(fp
, "\tversion = %d\n", list
->version
);
116 fprintf(fp
, "\tmode = %s\n", mode
);
118 if (list
->heuristic
) {
120 for (i
= 0; i
< BUNDLE_HEURISTIC__COUNT
; i
++) {
121 if (heuristics
[i
].heuristic
== list
->heuristic
) {
122 printf("\theuristic = %s\n",
123 heuristics
[list
->heuristic
].name
);
129 for_all_bundles_in_list(list
, summarize_bundle
, fp
);
133 * Given a key-value pair, update the state of the given bundle list.
134 * Returns 0 if the key-value pair is understood. Returns -1 if the key
135 * is not understood or the value is malformed.
137 static int bundle_list_update(const char *key
, const char *value
,
138 struct bundle_list
*list
)
140 struct strbuf id
= STRBUF_INIT
;
141 struct remote_bundle_info lookup
= REMOTE_BUNDLE_INFO_INIT
;
142 struct remote_bundle_info
*bundle
;
143 const char *subsection
, *subkey
;
144 size_t subsection_len
;
146 if (parse_config_key(key
, "bundle", &subsection
, &subsection_len
, &subkey
))
149 if (!subsection_len
) {
150 if (!strcmp(subkey
, "version")) {
152 if (!git_parse_int(value
, &version
))
157 list
->version
= version
;
161 if (!strcmp(subkey
, "mode")) {
162 if (!strcmp(value
, "all"))
163 list
->mode
= BUNDLE_MODE_ALL
;
164 else if (!strcmp(value
, "any"))
165 list
->mode
= BUNDLE_MODE_ANY
;
171 if (!strcmp(subkey
, "heuristic")) {
173 for (i
= 0; i
< BUNDLE_HEURISTIC__COUNT
; i
++) {
174 if (heuristics
[i
].heuristic
&&
175 heuristics
[i
].name
&&
176 !strcmp(value
, heuristics
[i
].name
)) {
177 list
->heuristic
= heuristics
[i
].heuristic
;
182 /* Ignore unknown heuristics. */
186 /* Ignore other unknown global keys. */
190 strbuf_add(&id
, subsection
, subsection_len
);
193 * Check for an existing bundle with this <id>, or create one
197 hashmap_entry_init(&lookup
.ent
, strhash(lookup
.id
));
198 if (!(bundle
= hashmap_get_entry(&list
->bundles
, &lookup
, ent
, NULL
))) {
199 CALLOC_ARRAY(bundle
, 1);
200 bundle
->id
= strbuf_detach(&id
, NULL
);
201 hashmap_entry_init(&bundle
->ent
, strhash(bundle
->id
));
202 hashmap_add(&list
->bundles
, &bundle
->ent
);
206 if (!strcmp(subkey
, "uri")) {
209 bundle
->uri
= relative_url(list
->baseURI
, value
, NULL
);
213 if (!strcmp(subkey
, "creationtoken")) {
214 if (sscanf(value
, "%"PRIu64
, &bundle
->creationToken
) != 1)
215 warning(_("could not parse bundle list key %s with value '%s'"),
216 "creationToken", value
);
221 * At this point, we ignore any information that we don't
222 * understand, assuming it to be hints for a heuristic the client
223 * does not currently understand.
228 static int config_to_bundle_list(const char *key
, const char *value
,
229 const struct config_context
*ctx UNUSED
,
232 struct bundle_list
*list
= data
;
233 return bundle_list_update(key
, value
, list
);
236 int bundle_uri_parse_config_format(const char *uri
,
237 const char *filename
,
238 struct bundle_list
*list
)
241 struct config_options opts
= {
242 .error_action
= CONFIG_ERROR_ERROR
,
245 if (!list
->baseURI
) {
246 struct strbuf baseURI
= STRBUF_INIT
;
247 strbuf_addstr(&baseURI
, uri
);
250 * If the URI does not end with a trailing slash, then
251 * remove the filename portion of the path. This is
252 * important for relative URIs.
254 strbuf_strip_file_from_path(&baseURI
);
255 list
->baseURI
= strbuf_detach(&baseURI
, NULL
);
257 result
= git_config_from_file_with_options(config_to_bundle_list
,
259 CONFIG_SCOPE_UNKNOWN
,
262 if (!result
&& list
->mode
== BUNDLE_MODE_NONE
) {
263 warning(_("bundle list at '%s' has no mode"), uri
);
270 static char *find_temp_filename(void)
273 struct strbuf name
= STRBUF_INIT
;
275 * Find a temporary filename that is available. This is briefly
276 * racy, but unlikely to collide.
278 fd
= odb_mkstemp(&name
, "bundles/tmp_uri_XXXXXX");
280 warning(_("failed to create temporary file"));
286 return strbuf_detach(&name
, NULL
);
289 static int download_https_uri_to_file(const char *file
, const char *uri
)
292 struct child_process cp
= CHILD_PROCESS_INIT
;
293 FILE *child_in
= NULL
, *child_out
= NULL
;
294 struct strbuf line
= STRBUF_INIT
;
297 strvec_pushl(&cp
.args
, "git-remote-https", uri
, NULL
);
302 if (start_command(&cp
))
305 child_in
= fdopen(cp
.in
, "w");
311 child_out
= fdopen(cp
.out
, "r");
317 fprintf(child_in
, "capabilities\n");
320 while (!strbuf_getline(&line
, child_out
)) {
323 if (!strcmp(line
.buf
, "get"))
326 strbuf_release(&line
);
329 result
= error(_("insufficient capabilities"));
333 fprintf(child_in
, "get %s %s\n\n", uri
, file
);
338 if (finish_command(&cp
))
345 static int copy_uri_to_file(const char *filename
, const char *uri
)
349 if (starts_with(uri
, "https:") ||
350 starts_with(uri
, "http:"))
351 return download_https_uri_to_file(filename
, uri
);
353 if (skip_prefix(uri
, "file://", &out
))
357 return copy_file(filename
, uri
, 0);
360 static int unbundle_from_file(struct repository
*r
, const char *file
)
364 struct bundle_header header
= BUNDLE_HEADER_INIT
;
365 struct string_list_item
*refname
;
366 struct strbuf bundle_ref
= STRBUF_INIT
;
367 size_t bundle_prefix_len
;
369 if ((bundle_fd
= read_bundle_header(file
, &header
)) < 0)
373 * Skip the reachability walk here, since we will be adding
374 * a reachable ref pointing to the new tips, which will reach
375 * the prerequisite commits.
377 if ((result
= unbundle(r
, &header
, bundle_fd
, NULL
,
378 VERIFY_BUNDLE_QUIET
)))
382 * Convert all refs/heads/ from the bundle into refs/bundles/
383 * in the local repository.
385 strbuf_addstr(&bundle_ref
, "refs/bundles/");
386 bundle_prefix_len
= bundle_ref
.len
;
388 for_each_string_list_item(refname
, &header
.references
) {
389 struct object_id
*oid
= refname
->util
;
390 struct object_id old_oid
;
391 const char *branch_name
;
394 if (!skip_prefix(refname
->string
, "refs/heads/", &branch_name
))
397 strbuf_setlen(&bundle_ref
, bundle_prefix_len
);
398 strbuf_addstr(&bundle_ref
, branch_name
);
400 has_old
= !refs_read_ref(get_main_ref_store(the_repository
),
401 bundle_ref
.buf
, &old_oid
);
402 refs_update_ref(get_main_ref_store(the_repository
),
403 "fetched bundle", bundle_ref
.buf
, oid
,
404 has_old
? &old_oid
: NULL
,
405 REF_SKIP_OID_VERIFICATION
,
406 UPDATE_REFS_MSG_ON_ERR
);
409 bundle_header_release(&header
);
413 struct bundle_list_context
{
414 struct repository
*r
;
415 struct bundle_list
*list
;
416 enum bundle_list_mode mode
;
422 * This early definition is necessary because we use indirect recursion:
424 * While iterating through a bundle list that was downloaded as part
425 * of fetch_bundle_uri_internal(), iterator methods eventually call it
426 * again, but with depth + 1.
428 static int fetch_bundle_uri_internal(struct repository
*r
,
429 struct remote_bundle_info
*bundle
,
431 struct bundle_list
*list
);
433 static int download_bundle_to_file(struct remote_bundle_info
*bundle
, void *data
)
436 struct bundle_list_context
*ctx
= data
;
438 if (ctx
->mode
== BUNDLE_MODE_ANY
&& ctx
->count
)
441 res
= fetch_bundle_uri_internal(ctx
->r
, bundle
, ctx
->depth
+ 1, ctx
->list
);
444 * Only increment count if the download succeeded. If our mode is
445 * BUNDLE_MODE_ANY, then we will want to try other URIs in the
446 * list in case they work instead.
452 * To be opportunistic as possible, we continue iterating and
453 * download as many bundles as we can, so we can apply the ones
454 * that work, even in BUNDLE_MODE_ALL mode.
459 struct bundles_for_sorting
{
460 struct remote_bundle_info
**items
;
465 static int append_bundle(struct remote_bundle_info
*bundle
, void *data
)
467 struct bundles_for_sorting
*list
= data
;
468 list
->items
[list
->nr
++] = bundle
;
473 * For use in QSORT() to get a list sorted by creationToken
474 * in decreasing order.
476 static int compare_creation_token_decreasing(const void *va
, const void *vb
)
478 const struct remote_bundle_info
* const *a
= va
;
479 const struct remote_bundle_info
* const *b
= vb
;
481 if ((*a
)->creationToken
> (*b
)->creationToken
)
483 if ((*a
)->creationToken
< (*b
)->creationToken
)
488 static int fetch_bundles_by_token(struct repository
*r
,
489 struct bundle_list
*list
)
492 int move_direction
= 0;
493 const char *creationTokenStr
;
494 uint64_t maxCreationToken
= 0, newMaxCreationToken
= 0;
495 struct bundle_list_context ctx
= {
500 struct bundles_for_sorting bundles
= {
501 .alloc
= hashmap_get_size(&list
->bundles
),
504 ALLOC_ARRAY(bundles
.items
, bundles
.alloc
);
506 for_all_bundles_in_list(list
, append_bundle
, &bundles
);
513 QSORT(bundles
.items
, bundles
.nr
, compare_creation_token_decreasing
);
516 * If fetch.bundleCreationToken exists, parses to a uint64t, and
517 * is not strictly smaller than the maximum creation token in the
518 * bundle list, then do not download any bundles.
520 if (!repo_config_get_value(r
,
521 "fetch.bundlecreationtoken",
522 &creationTokenStr
) &&
523 sscanf(creationTokenStr
, "%"PRIu64
, &maxCreationToken
) == 1 &&
524 bundles
.items
[0]->creationToken
<= maxCreationToken
) {
530 * Attempt to download and unbundle the minimum number of bundles by
531 * creationToken in decreasing order. If we fail to unbundle (after
532 * a successful download) then move to the next non-downloaded bundle
533 * and attempt downloading. Once we succeed in applying a bundle,
534 * move to the previous unapplied bundle and attempt to unbundle it
537 * In the case of a fresh clone, we will likely download all of the
538 * bundles before successfully unbundling the oldest one, then the
539 * rest of the bundles unbundle successfully in increasing order
542 * If there are existing objects, then this process may terminate
543 * early when all required commits from "new" bundles exist in the
544 * repo's object store.
547 while (cur
>= 0 && cur
< bundles
.nr
) {
548 struct remote_bundle_info
*bundle
= bundles
.items
[cur
];
551 * If we need to dig into bundles below the previous
552 * creation token value, then likely we are in an erroneous
553 * state due to missing or invalid bundles. Halt the process
554 * instead of continuing to download extra data.
556 if (bundle
->creationToken
<= maxCreationToken
)
561 * Not downloaded yet. Try downloading.
563 * Note that bundle->file is non-NULL if a download
564 * was attempted, even if it failed to download.
566 if (fetch_bundle_uri_internal(ctx
.r
, bundle
, ctx
.depth
+ 1, ctx
.list
)) {
567 /* Mark as unbundled so we do not retry. */
568 bundle
->unbundled
= 1;
570 /* Try looking deeper in the list. */
575 /* We expect bundles when using creationTokens. */
576 if (!is_bundle(bundle
->file
, 1)) {
577 warning(_("file downloaded from '%s' is not a bundle"),
583 if (bundle
->file
&& !bundle
->unbundled
) {
585 * This was downloaded, but not successfully
586 * unbundled. Try unbundling again.
588 if (unbundle_from_file(ctx
.r
, bundle
->file
)) {
589 /* Try looking deeper in the list. */
593 * Succeeded in unbundle. Retry bundles
594 * that previously failed to unbundle.
597 bundle
->unbundled
= 1;
599 if (bundle
->creationToken
> newMaxCreationToken
)
600 newMaxCreationToken
= bundle
->creationToken
;
605 * Else case: downloaded and unbundled successfully.
606 * Skip this by moving in the same direction as the
611 /* Move in the specified direction and repeat. */
612 cur
+= move_direction
;
616 * We succeed if the loop terminates because 'cur' drops below
617 * zero. The other case is that we terminate because 'cur'
618 * reaches the end of the list, so we have a failure no matter
619 * which bundles we apply from the list.
622 struct strbuf value
= STRBUF_INIT
;
623 strbuf_addf(&value
, "%"PRIu64
"", newMaxCreationToken
);
624 if (repo_config_set_multivar_gently(ctx
.r
,
625 "fetch.bundleCreationToken",
627 warning(_("failed to store maximum creation token"));
629 strbuf_release(&value
);
636 static int download_bundle_list(struct repository
*r
,
637 struct bundle_list
*local_list
,
638 struct bundle_list
*global_list
,
641 struct bundle_list_context ctx
= {
645 .mode
= local_list
->mode
,
648 return for_all_bundles_in_list(local_list
, download_bundle_to_file
, &ctx
);
651 static int fetch_bundle_list_in_config_format(struct repository
*r
,
652 struct bundle_list
*global_list
,
653 struct remote_bundle_info
*bundle
,
657 struct bundle_list list_from_bundle
;
659 init_bundle_list(&list_from_bundle
);
661 if ((result
= bundle_uri_parse_config_format(bundle
->uri
,
666 if (list_from_bundle
.mode
== BUNDLE_MODE_NONE
) {
667 warning(_("unrecognized bundle mode from URI '%s'"),
674 * If this list uses the creationToken heuristic, then the URIs
675 * it advertises are expected to be bundles, not nested lists.
676 * We can drop 'global_list' and 'depth'.
678 if (list_from_bundle
.heuristic
== BUNDLE_HEURISTIC_CREATIONTOKEN
) {
679 result
= fetch_bundles_by_token(r
, &list_from_bundle
);
680 global_list
->heuristic
= BUNDLE_HEURISTIC_CREATIONTOKEN
;
681 } else if ((result
= download_bundle_list(r
, &list_from_bundle
,
682 global_list
, depth
)))
686 clear_bundle_list(&list_from_bundle
);
691 * This limits the recursion on fetch_bundle_uri_internal() when following
694 static int max_bundle_uri_depth
= 4;
697 * Recursively download all bundles advertised at the given URI
698 * to files. If the file is a bundle, then add it to the given
699 * 'list'. Otherwise, expect a bundle list and recurse on the
700 * URIs in that list according to the list mode (ANY or ALL).
702 static int fetch_bundle_uri_internal(struct repository
*r
,
703 struct remote_bundle_info
*bundle
,
705 struct bundle_list
*list
)
708 struct remote_bundle_info
*bcopy
;
710 if (depth
>= max_bundle_uri_depth
) {
711 warning(_("exceeded bundle URI recursion limit (%d)"),
712 max_bundle_uri_depth
);
717 !(bundle
->file
= find_temp_filename())) {
722 if ((result
= copy_uri_to_file(bundle
->file
, bundle
->uri
))) {
723 warning(_("failed to download bundle from URI '%s'"), bundle
->uri
);
727 if ((result
= !is_bundle(bundle
->file
, 1))) {
728 result
= fetch_bundle_list_in_config_format(
729 r
, list
, bundle
, depth
);
731 warning(_("file at URI '%s' is not a bundle or bundle list"),
736 /* Copy the bundle and insert it into the global list. */
737 CALLOC_ARRAY(bcopy
, 1);
738 bcopy
->id
= xstrdup(bundle
->id
);
739 bcopy
->file
= xstrdup(bundle
->file
);
740 hashmap_entry_init(&bcopy
->ent
, strhash(bcopy
->id
));
741 hashmap_add(&list
->bundles
, &bcopy
->ent
);
744 if (result
&& bundle
->file
)
745 unlink(bundle
->file
);
750 * This loop iterator breaks the loop with nonzero return code on the
751 * first successful unbundling of a bundle.
753 static int attempt_unbundle(struct remote_bundle_info
*info
, void *data
)
755 struct repository
*r
= data
;
757 if (!info
->file
|| info
->unbundled
)
760 if (!unbundle_from_file(r
, info
->file
)) {
768 static int unbundle_all_bundles(struct repository
*r
,
769 struct bundle_list
*list
)
772 * Iterate through all bundles looking for ones that can
773 * successfully unbundle. If any succeed, then perhaps another
774 * will succeed in the next attempt.
776 * Keep in mind that a non-zero result for the loop here means
777 * the loop terminated early on a successful unbundling, which
778 * signals that we can try again.
780 while (for_all_bundles_in_list(list
, attempt_unbundle
, r
)) ;
785 static int unlink_bundle(struct remote_bundle_info
*info
, void *data UNUSED
)
788 unlink_or_warn(info
->file
);
792 int fetch_bundle_uri(struct repository
*r
, const char *uri
,
796 struct bundle_list list
;
797 struct remote_bundle_info bundle
= {
802 init_bundle_list(&list
);
805 * Do not fetch an empty bundle URI. An empty bundle URI
806 * could signal that a configured bundle URI has been disabled.
813 /* If a bundle is added to this global list, then it is required. */
814 list
.mode
= BUNDLE_MODE_ALL
;
816 if ((result
= fetch_bundle_uri_internal(r
, &bundle
, 0, &list
)))
819 result
= unbundle_all_bundles(r
, &list
);
823 *has_heuristic
= (list
.heuristic
!= BUNDLE_HEURISTIC_NONE
);
824 for_all_bundles_in_list(&list
, unlink_bundle
, NULL
);
825 clear_bundle_list(&list
);
826 clear_remote_bundle_info(&bundle
, NULL
);
830 int fetch_bundle_list(struct repository
*r
, struct bundle_list
*list
)
833 struct bundle_list global_list
;
836 * If the creationToken heuristic is used, then the URIs
837 * advertised by 'list' are not nested lists and instead
838 * direct bundles. We do not need to use global_list.
840 if (list
->heuristic
== BUNDLE_HEURISTIC_CREATIONTOKEN
)
841 return fetch_bundles_by_token(r
, list
);
843 init_bundle_list(&global_list
);
845 /* If a bundle is added to this global list, then it is required. */
846 global_list
.mode
= BUNDLE_MODE_ALL
;
848 if ((result
= download_bundle_list(r
, list
, &global_list
, 0)))
851 if (list
->heuristic
== BUNDLE_HEURISTIC_CREATIONTOKEN
)
852 result
= fetch_bundles_by_token(r
, list
);
854 result
= unbundle_all_bundles(r
, &global_list
);
857 for_all_bundles_in_list(&global_list
, unlink_bundle
, NULL
);
858 clear_bundle_list(&global_list
);
866 int bundle_uri_advertise(struct repository
*r
, struct strbuf
*value UNUSED
)
868 static int advertise_bundle_uri
= -1;
870 if (advertise_bundle_uri
!= -1)
873 advertise_bundle_uri
= 0;
874 repo_config_get_maybe_bool(r
, "uploadpack.advertisebundleuris", &advertise_bundle_uri
);
877 return advertise_bundle_uri
;
880 static int config_to_packet_line(const char *key
, const char *value
,
881 const struct config_context
*ctx UNUSED
,
884 struct packet_reader
*writer
= data
;
886 if (starts_with(key
, "bundle."))
887 packet_write_fmt(writer
->fd
, "%s=%s", key
, value
);
892 int bundle_uri_command(struct repository
*r
,
893 struct packet_reader
*request
)
895 struct packet_writer writer
;
896 packet_writer_init(&writer
, 1);
898 while (packet_reader_read(request
) == PACKET_READ_NORMAL
)
899 die(_("bundle-uri: unexpected argument: '%s'"), request
->line
);
900 if (request
->status
!= PACKET_READ_FLUSH
)
901 die(_("bundle-uri: expected flush after arguments"));
904 * Read all "bundle.*" config lines to the client as key=value
907 repo_config(r
, config_to_packet_line
, &writer
);
909 packet_writer_flush(&writer
);
915 * General API for {transport,connect}.c etc.
917 int bundle_uri_parse_line(struct bundle_list
*list
, const char *line
)
921 struct strbuf key
= STRBUF_INIT
;
924 return error(_("bundle-uri: got an empty line"));
926 equals
= strchr(line
, '=');
929 return error(_("bundle-uri: line is not of the form 'key=value'"));
930 if (line
== equals
|| !*(equals
+ 1))
931 return error(_("bundle-uri: line has empty key or value"));
933 strbuf_add(&key
, line
, equals
- line
);
934 result
= bundle_list_update(key
.buf
, equals
+ 1, list
);
935 strbuf_release(&key
);