Files
git/fetch-negotiator.h
Derrick Stolee 22b2f3d2a3 negotiator: add have_sent() interface
In a future change, we will introduce a capability to choose specific commit
OIDs as 'have's in fetch negotiation, with the ability to have the
negotiator choose more 'have's to increase coverage beyond that required
core set. The negotiator works to avoid emitting 'have's that can reach each
other, but that logic is hidden beneath the negotiator's iterator function
pointer ('next'). We need a way to communicate to the negotiator that we
have picked a 'have' so it could incorporate that into its logic.

Add a have_sent() method to the fetch_negotiator interface. This is the
signal that allows the negotiator to track the commit as already shown and
can perform the proper bookkeeping to avoid emitting those objects or
anything they can reach.

For our non-trivial negotiators, it is sufficient to mark these commits as
common, so the implementation is quite simple. This logic will be exercised
in the next change.

Reviewed-by: Matthew John Cheetham <mjcheetham@outlook.com>
Signed-off-by: Derrick Stolee <stolee@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2026-05-20 11:33:24 +09:00

77 lines
2.2 KiB
C

#ifndef FETCH_NEGOTIATOR_H
#define FETCH_NEGOTIATOR_H
struct commit;
struct repository;
/*
* An object that supplies the information needed to negotiate the contents of
* the to-be-sent packfile during a fetch.
*
* To set up the negotiator, call fetch_negotiator_init(), then known_common()
* (0 or more times), then add_tip() (0 or more times).
*
* Then, when "have" lines are required, call next(). Call ack() to report what
* the server tells us.
*
* Once negotiation is done, call release(). The negotiator then cannot be used
* (unless reinitialized with fetch_negotiator_init()).
*/
struct fetch_negotiator {
/*
* Before negotiation starts, indicate that the server is known to have
* this commit.
*/
void (*known_common)(struct fetch_negotiator *, struct commit *);
/*
* Once this function is invoked, known_common() cannot be invoked any
* more.
*
* Indicate that this commit and all its ancestors are to be checked
* for commonality with the server.
*/
void (*add_tip)(struct fetch_negotiator *, struct commit *);
/*
* Once this function is invoked, known_common() and add_tip() cannot
* be invoked any more.
*
* Return the next commit that the client should send as a "have" line.
*/
const struct object_id *(*next)(struct fetch_negotiator *);
/*
* Inform the negotiator that the server has the given commit. This
* method must only be called on commits returned by next().
*/
int (*ack)(struct fetch_negotiator *, struct commit *);
/*
* Inform the negotiator that this commit has already been sent as
* a "have" line outside of the negotiator's control. The negotiator
* should avoid outputting it from next() and may use it to optimize
* further negotiation (e.g., by treating it and its ancestors as
* common).
*/
void (*have_sent)(struct fetch_negotiator *, struct commit *);
void (*release)(struct fetch_negotiator *);
/* internal use */
void *data;
};
/*
* Initialize a negotiator based on the repository settings.
*/
void fetch_negotiator_init(struct repository *r,
struct fetch_negotiator *negotiator);
/*
* Initialize a noop negotiator.
*/
void fetch_negotiator_init_noop(struct fetch_negotiator *negotiator);
#endif