transport.h

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