transport.h

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