mirror of
https://github.com/git/git
synced 2024-08-28 20:20:07 +00:00
![Jonathan Tan](/assets/img/avatar_default.png)
Currently, the packfile negotiation step within a Git fetch cannot be done independent of sending the packfile, even though there is at least one application wherein this is useful. Therefore, make it possible for this negotiation step to be done independently. A subsequent commit will use this for one such application - push negotiation. This feature is for protocol v2 only. (An implementation for protocol v0 would require a separate implementation in the fetch, transport, and transport helper code.) In the protocol, the main hindrance towards independent negotiation is that the server can unilaterally decide to send the packfile. This is solved by a "wait-for-done" argument: the server will then wait for the client to say "done". In practice, the client will never say it; instead it will cease requests once it is satisfied. In the client, the main change lies in the transport and transport helper code. fetch_refs_via_pack() performs everything needed - protocol version and capability checks, and the negotiation itself. There are 2 code paths that do not go through fetch_refs_via_pack() that needed to be individually excluded: the bundle transport (excluded through requiring smart_options, which the bundle transport doesn't support) and transport helpers that do not support takeover. If or when we support independent negotiation for protocol v0, we will need to modify these 2 code paths to support it. But for now, report failure if independent negotiation is requested in these cases. Signed-off-by: Jonathan Tan <jonathantanmy@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
305 lines
9.2 KiB
C
305 lines
9.2 KiB
C
#ifndef TRANSPORT_H
|
|
#define TRANSPORT_H
|
|
|
|
#include "cache.h"
|
|
#include "run-command.h"
|
|
#include "remote.h"
|
|
#include "list-objects-filter-options.h"
|
|
#include "string-list.h"
|
|
|
|
struct git_transport_options {
|
|
unsigned thin : 1;
|
|
unsigned keep : 1;
|
|
unsigned followtags : 1;
|
|
unsigned check_self_contained_and_connected : 1;
|
|
unsigned self_contained_and_connected : 1;
|
|
unsigned update_shallow : 1;
|
|
unsigned reject_shallow : 1;
|
|
unsigned deepen_relative : 1;
|
|
|
|
/* see documentation of corresponding flag in fetch-pack.h */
|
|
unsigned from_promisor : 1;
|
|
|
|
/*
|
|
* If this transport supports connect or stateless-connect,
|
|
* the corresponding field in struct fetch_pack_args is copied
|
|
* here after fetching.
|
|
*
|
|
* See the definition of connectivity_checked in struct
|
|
* fetch_pack_args for more information.
|
|
*/
|
|
unsigned connectivity_checked:1;
|
|
|
|
int depth;
|
|
const char *deepen_since;
|
|
const struct string_list *deepen_not;
|
|
const char *uploadpack;
|
|
const char *receivepack;
|
|
struct push_cas_option *cas;
|
|
struct list_objects_filter_options filter_options;
|
|
|
|
/*
|
|
* This is only used during fetch. See the documentation of
|
|
* negotiation_tips in struct fetch_pack_args.
|
|
*
|
|
* This field is only supported by transports that support connect or
|
|
* stateless_connect. Set this field directly instead of using
|
|
* transport_set_option().
|
|
*/
|
|
struct oid_array *negotiation_tips;
|
|
|
|
/*
|
|
* If allocated, whenever transport_fetch_refs() is called, add known
|
|
* common commits to this oidset instead of fetching any packfiles.
|
|
*/
|
|
struct oidset *acked_commits;
|
|
};
|
|
|
|
enum transport_family {
|
|
TRANSPORT_FAMILY_ALL = 0,
|
|
TRANSPORT_FAMILY_IPV4,
|
|
TRANSPORT_FAMILY_IPV6
|
|
};
|
|
|
|
struct transport {
|
|
const struct transport_vtable *vtable;
|
|
|
|
struct remote *remote;
|
|
const char *url;
|
|
void *data;
|
|
const struct ref *remote_refs;
|
|
|
|
/**
|
|
* Indicates whether we already called get_refs_list(); set by
|
|
* transport.c::transport_get_remote_refs().
|
|
*/
|
|
unsigned got_remote_refs : 1;
|
|
|
|
/*
|
|
* Transports that call take-over destroys the data specific to
|
|
* the transport type while doing so, and cannot be reused.
|
|
*/
|
|
unsigned cannot_reuse : 1;
|
|
|
|
/*
|
|
* A hint from caller that it will be performing a clone, not
|
|
* normal fetch. IOW the repository is guaranteed empty.
|
|
*/
|
|
unsigned cloning : 1;
|
|
|
|
/*
|
|
* Indicates that the transport is connected via a half-duplex
|
|
* connection and should operate in stateless-rpc mode.
|
|
*/
|
|
unsigned stateless_rpc : 1;
|
|
|
|
/*
|
|
* These strings will be passed to the {pre, post}-receive hook,
|
|
* on the remote side, if both sides support the push options capability.
|
|
*/
|
|
const struct string_list *push_options;
|
|
|
|
/*
|
|
* These strings will be passed to the remote side on each command
|
|
* request, if both sides support the server-option capability.
|
|
*/
|
|
const struct string_list *server_options;
|
|
|
|
struct string_list pack_lockfiles;
|
|
|
|
signed verbose : 3;
|
|
/**
|
|
* Transports should not set this directly, and should use this
|
|
* value without having to check isatty(2), -q/--quiet
|
|
* (transport->verbose < 0), etc. - checking has already been done
|
|
* in transport_set_verbosity().
|
|
**/
|
|
unsigned progress : 1;
|
|
/*
|
|
* If transport is at least potentially smart, this points to
|
|
* git_transport_options structure to use in case transport
|
|
* actually turns out to be smart.
|
|
*/
|
|
struct git_transport_options *smart_options;
|
|
|
|
enum transport_family family;
|
|
|
|
const struct git_hash_algo *hash_algo;
|
|
};
|
|
|
|
#define TRANSPORT_PUSH_ALL (1<<0)
|
|
#define TRANSPORT_PUSH_FORCE (1<<1)
|
|
#define TRANSPORT_PUSH_DRY_RUN (1<<2)
|
|
#define TRANSPORT_PUSH_MIRROR (1<<3)
|
|
#define TRANSPORT_PUSH_PORCELAIN (1<<4)
|
|
#define TRANSPORT_PUSH_SET_UPSTREAM (1<<5)
|
|
#define TRANSPORT_RECURSE_SUBMODULES_CHECK (1<<6)
|
|
#define TRANSPORT_PUSH_PRUNE (1<<7)
|
|
#define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND (1<<8)
|
|
#define TRANSPORT_PUSH_NO_HOOK (1<<9)
|
|
#define TRANSPORT_PUSH_FOLLOW_TAGS (1<<10)
|
|
#define TRANSPORT_PUSH_CERT_ALWAYS (1<<11)
|
|
#define TRANSPORT_PUSH_CERT_IF_ASKED (1<<12)
|
|
#define TRANSPORT_PUSH_ATOMIC (1<<13)
|
|
#define TRANSPORT_PUSH_OPTIONS (1<<14)
|
|
#define TRANSPORT_RECURSE_SUBMODULES_ONLY (1<<15)
|
|
#define TRANSPORT_PUSH_FORCE_IF_INCLUDES (1<<16)
|
|
|
|
int transport_summary_width(const struct ref *refs);
|
|
|
|
/* Returns a transport suitable for the url */
|
|
struct transport *transport_get(struct remote *, const char *);
|
|
|
|
/*
|
|
* Check whether a transport is allowed by the environment.
|
|
*
|
|
* Type should generally be the URL scheme, as described in
|
|
* Documentation/git.txt
|
|
*
|
|
* from_user specifies if the transport was given by the user. If unknown pass
|
|
* a -1 to read from the environment to determine if the transport was given by
|
|
* the user.
|
|
*
|
|
*/
|
|
int is_transport_allowed(const char *type, int from_user);
|
|
|
|
/*
|
|
* Check whether a transport is allowed by the environment,
|
|
* and die otherwise.
|
|
*/
|
|
void transport_check_allowed(const char *type);
|
|
|
|
/* Transport options which apply to git:// and scp-style URLs */
|
|
|
|
/* The program to use on the remote side to send a pack */
|
|
#define TRANS_OPT_UPLOADPACK "uploadpack"
|
|
|
|
/* The program to use on the remote side to receive a pack */
|
|
#define TRANS_OPT_RECEIVEPACK "receivepack"
|
|
|
|
/* Transfer the data as a thin pack if not null */
|
|
#define TRANS_OPT_THIN "thin"
|
|
|
|
/* Check the current value of the remote ref */
|
|
#define TRANS_OPT_CAS "cas"
|
|
|
|
/* Keep the pack that was transferred if not null */
|
|
#define TRANS_OPT_KEEP "keep"
|
|
|
|
/* Limit the depth of the fetch if not null */
|
|
#define TRANS_OPT_DEPTH "depth"
|
|
|
|
/* Limit the depth of the fetch based on time if not null */
|
|
#define TRANS_OPT_DEEPEN_SINCE "deepen-since"
|
|
|
|
/* Limit the depth of the fetch based on revs if not null */
|
|
#define TRANS_OPT_DEEPEN_NOT "deepen-not"
|
|
|
|
/* Limit the deepen of the fetch if not null */
|
|
#define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
|
|
|
|
/* Aggressively fetch annotated tags if possible */
|
|
#define TRANS_OPT_FOLLOWTAGS "followtags"
|
|
|
|
/* Reject shallow repo transport */
|
|
#define TRANS_OPT_REJECT_SHALLOW "rejectshallow"
|
|
|
|
/* Accept refs that may update .git/shallow without --depth */
|
|
#define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
|
|
|
|
/* Send push certificates */
|
|
#define TRANS_OPT_PUSH_CERT "pushcert"
|
|
|
|
/* Indicate that these objects are being fetched by a promisor */
|
|
#define TRANS_OPT_FROM_PROMISOR "from-promisor"
|
|
|
|
/* Filter objects for partial clone and fetch */
|
|
#define TRANS_OPT_LIST_OBJECTS_FILTER "filter"
|
|
|
|
/* Request atomic (all-or-nothing) updates when pushing */
|
|
#define TRANS_OPT_ATOMIC "atomic"
|
|
|
|
/* Require remote changes to be integrated locally. */
|
|
#define TRANS_OPT_FORCE_IF_INCLUDES "force-if-includes"
|
|
|
|
/**
|
|
* Returns 0 if the option was used, non-zero otherwise. Prints a
|
|
* message to stderr if the option is not used.
|
|
**/
|
|
int transport_set_option(struct transport *transport, const char *name,
|
|
const char *value);
|
|
void transport_set_verbosity(struct transport *transport, int verbosity,
|
|
int force_progress);
|
|
|
|
#define REJECT_NON_FF_HEAD 0x01
|
|
#define REJECT_NON_FF_OTHER 0x02
|
|
#define REJECT_ALREADY_EXISTS 0x04
|
|
#define REJECT_FETCH_FIRST 0x08
|
|
#define REJECT_NEEDS_FORCE 0x10
|
|
#define REJECT_REF_NEEDS_UPDATE 0x20
|
|
|
|
int transport_push(struct repository *repo,
|
|
struct transport *connection,
|
|
struct refspec *rs, int flags,
|
|
unsigned int * reject_reasons);
|
|
|
|
struct transport_ls_refs_options {
|
|
/*
|
|
* Optionally, a list of ref prefixes can be provided which can be sent
|
|
* to the server (when communicating using protocol v2) to enable it to
|
|
* limit the ref advertisement. Since ref filtering is done on the
|
|
* server's end (and only when using protocol v2),
|
|
* transport_get_remote_refs() could return refs which don't match the
|
|
* provided ref_prefixes.
|
|
*/
|
|
struct strvec ref_prefixes;
|
|
|
|
/*
|
|
* If unborn_head_target is not NULL, and the remote reports HEAD as
|
|
* pointing to an unborn branch, transport_get_remote_refs() stores the
|
|
* unborn branch in unborn_head_target. It should be freed by the
|
|
* caller.
|
|
*/
|
|
char *unborn_head_target;
|
|
};
|
|
#define TRANSPORT_LS_REFS_OPTIONS_INIT { STRVEC_INIT }
|
|
|
|
/*
|
|
* Retrieve refs from a remote.
|
|
*/
|
|
const struct ref *transport_get_remote_refs(struct transport *transport,
|
|
struct transport_ls_refs_options *transport_options);
|
|
|
|
/*
|
|
* Fetch the hash algorithm used by a remote.
|
|
*
|
|
* This can only be called after fetching the remote refs.
|
|
*/
|
|
const struct git_hash_algo *transport_get_hash_algo(struct transport *transport);
|
|
int transport_fetch_refs(struct transport *transport, struct ref *refs);
|
|
void transport_unlock_pack(struct transport *transport);
|
|
int transport_disconnect(struct transport *transport);
|
|
char *transport_anonymize_url(const char *url);
|
|
void transport_take_over(struct transport *transport,
|
|
struct child_process *child);
|
|
|
|
int transport_connect(struct transport *transport, const char *name,
|
|
const char *exec, int fd[2]);
|
|
|
|
/* Transport methods defined outside transport.c */
|
|
int transport_helper_init(struct transport *transport, const char *name);
|
|
int bidirectional_transfer_loop(int input, int output);
|
|
|
|
/* common methods used by transport.c and builtin/send-pack.c */
|
|
void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
|
|
|
|
int transport_refs_pushed(struct ref *ref);
|
|
|
|
void transport_print_push_status(const char *dest, struct ref *refs,
|
|
int verbose, int porcelain, unsigned int *reject_reasons);
|
|
|
|
/* common method used by transport-helper.c and send-pack.c */
|
|
void reject_atomic_push(struct ref *refs, int mirror_mode);
|
|
|
|
#endif
|