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