1#ifndef TRANSPORT_H 2#define TRANSPORT_H 3 4#include"cache.h" 5#include"remote.h" 6 7struct git_transport_options { 8unsigned thin :1; 9unsigned keep :1; 10unsigned followtags :1; 11int depth; 12const char*uploadpack; 13const char*receivepack; 14}; 15 16struct transport { 17struct remote *remote; 18const char*url; 19void*data; 20const struct ref *remote_refs; 21 22/** 23 * Indicates whether we already called get_refs_list(); set by 24 * transport.c::transport_get_remote_refs(). 25 */ 26unsigned got_remote_refs :1; 27 28/** 29 * Returns 0 if successful, positive if the option is not 30 * recognized or is inapplicable, and negative if the option 31 * is applicable but the value is invalid. 32 **/ 33int(*set_option)(struct transport *connection,const char*name, 34const char*value); 35 36/** 37 * Returns a list of the remote side's refs. In order to allow 38 * the transport to try to share connections, for_push is a 39 * hint as to whether the ultimate operation is a push or a fetch. 40 * 41 * If the transport is able to determine the remote hash for 42 * the ref without a huge amount of effort, it should store it 43 * in the ref's old_sha1 field; otherwise it should be all 0. 44 **/ 45struct ref *(*get_refs_list)(struct transport *transport,int for_push); 46 47/** 48 * Fetch the objects for the given refs. Note that this gets 49 * an array, and should ignore the list structure. 50 * 51 * If the transport did not get hashes for refs in 52 * get_refs_list(), it should set the old_sha1 fields in the 53 * provided refs now. 54 **/ 55int(*fetch)(struct transport *transport,int refs_nr,struct ref **refs); 56 57/** 58 * Push the objects and refs. Send the necessary objects, and 59 * then, for any refs where peer_ref is set and 60 * peer_ref->new_sha1 is different from old_sha1, tell the 61 * remote side to update each ref in the list from old_sha1 to 62 * peer_ref->new_sha1. 63 * 64 * Where possible, set the status for each ref appropriately. 65 * 66 * The transport must modify new_sha1 in the ref to the new 67 * value if the remote accepted the change. Note that this 68 * could be a different value from peer_ref->new_sha1 if the 69 * process involved generating new commits. 70 **/ 71int(*push_refs)(struct transport *transport,struct ref *refs,int flags); 72int(*push)(struct transport *connection,int refspec_nr,const char**refspec,int flags); 73int(*connect)(struct transport *connection,const char*name, 74const char*executable,int fd[2]); 75 76/** get_refs_list(), fetch(), and push_refs() can keep 77 * resources (such as a connection) reserved for futher 78 * use. disconnect() releases these resources. 79 **/ 80int(*disconnect)(struct transport *connection); 81char*pack_lockfile; 82signed verbose :3; 83/** 84 * Transports should not set this directly, and should use this 85 * value without having to check isatty(2), -q/--quiet 86 * (transport->verbose < 0), etc. - checking has already been done 87 * in transport_set_verbosity(). 88 **/ 89unsigned progress :1; 90/* 91 * If transport is at least potentially smart, this points to 92 * git_transport_options structure to use in case transport 93 * actually turns out to be smart. 94 */ 95struct git_transport_options *smart_options; 96}; 97 98#define TRANSPORT_PUSH_ALL 1 99#define TRANSPORT_PUSH_FORCE 2 100#define TRANSPORT_PUSH_DRY_RUN 4 101#define TRANSPORT_PUSH_MIRROR 8 102#define TRANSPORT_PUSH_PORCELAIN 16 103#define TRANSPORT_PUSH_SET_UPSTREAM 32 104#define TRANSPORT_RECURSE_SUBMODULES_CHECK 64 105#define TRANSPORT_PUSH_PRUNE 128 106#define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND 256 107#define TRANSPORT_PUSH_FOLLOW_TAGS 1024 108 109#define TRANSPORT_SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3) 110#define TRANSPORT_SUMMARY(x) (int)(TRANSPORT_SUMMARY_WIDTH + strlen(x) - gettext_width(x)), (x) 111 112/* Returns a transport suitable for the url */ 113struct transport *transport_get(struct remote *,const char*); 114 115/* Transport options which apply to git:// and scp-style URLs */ 116 117/* The program to use on the remote side to send a pack */ 118#define TRANS_OPT_UPLOADPACK"uploadpack" 119 120/* The program to use on the remote side to receive a pack */ 121#define TRANS_OPT_RECEIVEPACK"receivepack" 122 123/* Transfer the data as a thin pack if not null */ 124#define TRANS_OPT_THIN"thin" 125 126/* Keep the pack that was transferred if not null */ 127#define TRANS_OPT_KEEP"keep" 128 129/* Limit the depth of the fetch if not null */ 130#define TRANS_OPT_DEPTH"depth" 131 132/* Aggressively fetch annotated tags if possible */ 133#define TRANS_OPT_FOLLOWTAGS"followtags" 134 135/** 136 * Returns 0 if the option was used, non-zero otherwise. Prints a 137 * message to stderr if the option is not used. 138 **/ 139inttransport_set_option(struct transport *transport,const char*name, 140const char*value); 141voidtransport_set_verbosity(struct transport *transport,int verbosity, 142int force_progress); 143 144#define NON_FF_HEAD 1 145#define NON_FF_OTHER 2 146inttransport_push(struct transport *connection, 147int refspec_nr,const char**refspec,int flags, 148int* nonfastforward); 149 150const struct ref *transport_get_remote_refs(struct transport *transport); 151 152inttransport_fetch_refs(struct transport *transport,struct ref *refs); 153voidtransport_unlock_pack(struct transport *transport); 154inttransport_disconnect(struct transport *transport); 155char*transport_anonymize_url(const char*url); 156voidtransport_take_over(struct transport *transport, 157struct child_process *child); 158 159inttransport_connect(struct transport *transport,const char*name, 160const char*exec,int fd[2]); 161 162/* Transport methods defined outside transport.c */ 163inttransport_helper_init(struct transport *transport,const char*name); 164intbidirectional_transfer_loop(int input,int output); 165 166/* common methods used by transport.c and builtin-send-pack.c */ 167voidtransport_verify_remote_names(int nr_heads,const char**heads); 168 169voidtransport_update_tracking_ref(struct remote *remote,struct ref *ref,int verbose); 170 171inttransport_refs_pushed(struct ref *ref); 172 173voidtransport_print_push_status(const char*dest,struct ref *refs, 174int verbose,int porcelain,int*nonfastforward); 175 176typedefvoidalternate_ref_fn(const struct ref *,void*); 177externvoidfor_each_alternate_ref(alternate_ref_fn,void*); 178 179struct send_pack_args; 180externintsend_pack(struct send_pack_args *args, 181int fd[],struct child_process *conn, 182struct ref *remote_refs, 183struct extra_have_objects *extra_have); 184#endif