git/promisor-remote.h
Christian Couder d92ba46d5a promisor-remote: keep advertised filter in memory
Currently, advertised filters are only kept in memory temporarily
during parsing, or persisted to disk if `promisor.storeFields`
contains 'partialCloneFilter'.

In a following commit though, we will add a `--filter=auto` option.
This option will enable the client to use the filters that the server
is suggesting for the promisor remotes the client accepts.

To use them even if `promisor.storeFields` is not configured, these
filters should be stored somewhere for the current session.

Let's add an `advertised_filter` field to `struct promisor_remote`
for that purpose.

To ensure that the filters are available in all cases,
filter_promisor_remote() captures them into a temporary list and
applies them to the `promisor_remote` structs after the potential
configuration reload.

Then the accepted remotes are marked as `accepted` in the repository
state. This ensures that subsequent calls to look up accepted remotes
(like in the filter construction below) actually find them.

In a following commit, we will add a `--filter=auto` option that will
enable a client to use the filters suggested by the server for the
promisor remotes the client accepted.

To enable the client to construct a filter spec based on these filters,
let's add a `promisor_remote_construct_filter(repo)` function.

This function:

- iterates over all accepted promisor remotes in the repository,
- collects the filters advertised for them (using `advertised_filter`
  which a previous commit added to `struct promisor_remote`), and
- generates a single filter spec for them (using the
  `list_objects_filter_combine()` function added by a previous commit).

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2025-12-23 22:43:06 +09:00

77 lines
2.4 KiB
C

#ifndef PROMISOR_REMOTE_H
#define PROMISOR_REMOTE_H
#include "repository.h"
struct object_id;
/*
* Promisor remote linked list
*
* Information in its fields come from remote.XXX config entries or
* from extensions.partialclone, except for 'accepted' which comes
* from protocol v2 capabilities exchange.
*/
struct promisor_remote {
struct promisor_remote *next;
char *partial_clone_filter;
char *advertised_filter;
unsigned int accepted : 1;
const char name[FLEX_ARRAY];
};
void repo_promisor_remote_reinit(struct repository *r);
void promisor_remote_clear(struct promisor_remote_config *config);
struct promisor_remote *repo_promisor_remote_find(struct repository *r, const char *remote_name);
int repo_has_promisor_remote(struct repository *r);
/*
* Fetches all requested objects from all promisor remotes, trying them one at
* a time until all objects are fetched.
*
* If oid_nr is 0, this function returns immediately.
*/
void promisor_remote_get_direct(struct repository *repo,
const struct object_id *oids,
int oid_nr);
/*
* Prepare a "promisor-remote" advertisement by a server.
* Check the value of "promisor.advertise" and maybe the configured
* promisor remotes, if any, to prepare information to send in an
* advertisement.
* Return value is NULL if no promisor remote advertisement should be
* made. Otherwise it contains the names and urls of the advertised
* promisor remotes separated by ';'. See gitprotocol-v2(5).
*/
char *promisor_remote_info(struct repository *repo);
/*
* Prepare a reply to a "promisor-remote" advertisement from a server.
* Check the value of "promisor.acceptfromserver" and maybe the
* configured promisor remotes, if any, to prepare the reply.
* Return value is NULL if no promisor remote from the server
* is accepted. Otherwise it contains the names of the accepted promisor
* remotes separated by ';'. See gitprotocol-v2(5).
*/
char *promisor_remote_reply(const char *info);
/*
* Set the 'accepted' flag for some promisor remotes. Useful on the
* server side when some promisor remotes have been accepted by the
* client.
*/
void mark_promisor_remotes_as_accepted(struct repository *repo, const char *remotes);
/*
* Has any promisor remote been accepted by the client?
*/
int repo_has_accepted_promisor_remote(struct repository *r);
/*
* Use the filters from the accepted remotes to create a filter.
*/
char *promisor_remote_construct_filter(struct repository *repo);
#endif /* PROMISOR_REMOTE_H */