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