transport.h

   1 #ifndef TRANSPORT_H
   2 #define TRANSPORT_H
   3
   4 #include "run-command.h"
   5 #include "remote.h"
   6 #include "list-objects-filter-options.h"
   7 #include "string-list.h"
   8
   9 struct git_transport_options {
  10         unsigned thin : 1;
  11         unsigned keep : 1;
  12         unsigned followtags : 1;
  13         unsigned check_self_contained_and_connected : 1;
  14         unsigned self_contained_and_connected : 1;
  15         unsigned update_shallow : 1;
  16         unsigned reject_shallow : 1;
  17         unsigned deepen_relative : 1;
  18         unsigned refetch : 1;
  19
  20         /* see documentation of corresponding flag in fetch-pack.h */
  21         unsigned from_promisor : 1;
  22
  23         /*
  24          * If this transport supports connect or stateless-connect,
  25          * the corresponding field in struct fetch_pack_args is copied
  26          * here after fetching.
  27          *
  28          * See the definition of connectivity_checked in struct
  29          * fetch_pack_args for more information.
  30          */
  31         unsigned connectivity_checked:1;
  32
  33         int depth;
  34         const char *deepen_since;
  35         const struct string_list *deepen_not;
  36         const char *uploadpack;
  37         const char *receivepack;
  38         struct push_cas_option *cas;
  39         struct list_objects_filter_options filter_options;
  40
  41         /*
  42          * This is only used during fetch. See the documentation of
  43          * negotiation_tips in struct fetch_pack_args.
  44          *
  45          * This field is only supported by transports that support connect or
  46          * stateless_connect. Set this field directly instead of using
  47          * transport_set_option().
  48          */
  49         struct oid_array *negotiation_tips;
  50
  51         /*
  52          * If allocated, whenever transport_fetch_refs() is called, add known
  53          * common commits to this oidset instead of fetching any packfiles.
  54          */
  55         struct oidset *acked_commits;
  56 };
  57
  58 enum transport_family {
  59         TRANSPORT_FAMILY_ALL = 0,
  60         TRANSPORT_FAMILY_IPV4,
  61         TRANSPORT_FAMILY_IPV6
  62 };
  63
  64 struct bundle_list;
  65 struct transport {
  66         const struct transport_vtable *vtable;
  67
  68         struct remote *remote;
  69         const char *url;
  70         void *data;
  71         const struct ref *remote_refs;
  72
  73         /**
  74          * Indicates whether we already called get_refs_list(); set by
  75          * transport.c::transport_get_remote_refs().
  76          */
  77         unsigned got_remote_refs : 1;
  78
  79         /**
  80          * Indicates whether we already called get_bundle_uri_list(); set by
  81          * transport.c::transport_get_remote_bundle_uri().
  82          */
  83         unsigned got_remote_bundle_uri : 1;
  84
  85         /*
  86          * The results of "command=bundle-uri", if both sides support
  87          * the "bundle-uri" capability.
  88          */
  89         struct bundle_list *bundles;
  90
  91         /*
  92          * Transports that call take-over destroys the data specific to
  93          * the transport type while doing so, and cannot be reused.
  94          */
  95         unsigned cannot_reuse : 1;
  96
  97         /*
  98          * A hint from caller that it will be performing a clone, not
  99          * normal fetch. IOW the repository is guaranteed empty.
 100          */
 101         unsigned cloning : 1;
 102
 103         /*
 104          * Indicates that the transport is connected via a half-duplex
 105          * connection and should operate in stateless-rpc mode.
 106          */
 107         unsigned stateless_rpc : 1;
 108
 109         /*
 110          * These strings will be passed to the {pre, post}-receive hook,
 111          * on the remote side, if both sides support the push options capability.
 112          */
 113         const struct string_list *push_options;
 114
 115         /*
 116          * These strings will be passed to the remote side on each command
 117          * request, if both sides support the server-option capability.
 118          */
 119         const struct string_list *server_options;
 120
 121         struct string_list pack_lockfiles;
 122
 123         signed verbose : 3;
 124         /**
 125          * Transports should not set this directly, and should use this
 126          * value without having to check isatty(2), -q/--quiet
 127          * (transport->verbose < 0), etc. - checking has already been done
 128          * in transport_set_verbosity().
 129          **/
 130         unsigned progress : 1;
 131         /*
 132          * If transport is at least potentially smart, this points to
 133          * git_transport_options structure to use in case transport
 134          * actually turns out to be smart.
 135          */
 136         struct git_transport_options *smart_options;
 137
 138         enum transport_family family;
 139
 140         const struct git_hash_algo *hash_algo;
 141 };
 142
 143 #define TRANSPORT_PUSH_ALL                      (1<<0)
 144 #define TRANSPORT_PUSH_FORCE                    (1<<1)
 145 #define TRANSPORT_PUSH_DRY_RUN                  (1<<2)
 146 #define TRANSPORT_PUSH_MIRROR                   (1<<3)
 147 #define TRANSPORT_PUSH_PORCELAIN                (1<<4)
 148 #define TRANSPORT_PUSH_SET_UPSTREAM             (1<<5)
 149 #define TRANSPORT_RECURSE_SUBMODULES_CHECK      (1<<6)
 150 #define TRANSPORT_PUSH_PRUNE                    (1<<7)
 151 #define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND  (1<<8)
 152 #define TRANSPORT_PUSH_NO_HOOK                  (1<<9)
 153 #define TRANSPORT_PUSH_FOLLOW_TAGS              (1<<10)
 154 #define TRANSPORT_PUSH_CERT_ALWAYS              (1<<11)
 155 #define TRANSPORT_PUSH_CERT_IF_ASKED            (1<<12)
 156 #define TRANSPORT_PUSH_ATOMIC                   (1<<13)
 157 #define TRANSPORT_PUSH_OPTIONS                  (1<<14)
 158 #define TRANSPORT_RECURSE_SUBMODULES_ONLY       (1<<15)
 159 #define TRANSPORT_PUSH_FORCE_IF_INCLUDES        (1<<16)
 160 #define TRANSPORT_PUSH_AUTO_UPSTREAM            (1<<17)
 161
 162 int transport_summary_width(const struct ref *refs);
 163
 164 /* Returns a transport suitable for the url */
 165 struct transport *transport_get(struct remote *, const char *);
 166
 167 /*
 168  * Check whether a transport is allowed by the environment.
 169  *
 170  * Type should generally be the URL scheme, as described in
 171  * Documentation/git.txt
 172  *
 173  * from_user specifies if the transport was given by the user.  If unknown pass
 174  * a -1 to read from the environment to determine if the transport was given by
 175  * the user.
 176  *
 177  */
 178 int is_transport_allowed(const char *type, int from_user);
 179
 180 /*
 181  * Check whether a transport is allowed by the environment,
 182  * and die otherwise.
 183  */
 184 void transport_check_allowed(const char *type);
 185
 186 /* Transport options which apply to git:// and scp-style URLs */
 187
 188 /* The program to use on the remote side to send a pack */
 189 #define TRANS_OPT_UPLOADPACK "uploadpack"
 190
 191 /* The program to use on the remote side to receive a pack */
 192 #define TRANS_OPT_RECEIVEPACK "receivepack"
 193
 194 /* Transfer the data as a thin pack if not null */
 195 #define TRANS_OPT_THIN "thin"
 196
 197 /* Check the current value of the remote ref */
 198 #define TRANS_OPT_CAS "cas"
 199
 200 /* Keep the pack that was transferred if not null */
 201 #define TRANS_OPT_KEEP "keep"
 202
 203 /* Limit the depth of the fetch if not null */
 204 #define TRANS_OPT_DEPTH "depth"
 205
 206 /* Limit the depth of the fetch based on time if not null */
 207 #define TRANS_OPT_DEEPEN_SINCE "deepen-since"
 208
 209 /* Limit the depth of the fetch based on revs if not null */
 210 #define TRANS_OPT_DEEPEN_NOT "deepen-not"
 211
 212 /* Limit the deepen of the fetch if not null */
 213 #define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
 214
 215 /* Aggressively fetch annotated tags if possible */
 216 #define TRANS_OPT_FOLLOWTAGS "followtags"
 217
 218 /* Reject shallow repo transport */
 219 #define TRANS_OPT_REJECT_SHALLOW "rejectshallow"
 220
 221 /* Accept refs that may update .git/shallow without --depth */
 222 #define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
 223
 224 /* Send push certificates */
 225 #define TRANS_OPT_PUSH_CERT "pushcert"
 226
 227 /* Indicate that these objects are being fetched by a promisor */
 228 #define TRANS_OPT_FROM_PROMISOR "from-promisor"
 229
 230 /* Filter objects for partial clone and fetch */
 231 #define TRANS_OPT_LIST_OBJECTS_FILTER "filter"
 232
 233 /* Refetch all objects without negotiating */
 234 #define TRANS_OPT_REFETCH "refetch"
 235
 236 /* Request atomic (all-or-nothing) updates when pushing */
 237 #define TRANS_OPT_ATOMIC "atomic"
 238
 239 /* Require remote changes to be integrated locally. */
 240 #define TRANS_OPT_FORCE_IF_INCLUDES "force-if-includes"
 241
 242 /**
 243  * Returns 0 if the option was used, non-zero otherwise. Prints a
 244  * message to stderr if the option is not used.
 245  **/
 246 int transport_set_option(struct transport *transport, const char *name,
 247                          const char *value);
 248 void transport_set_verbosity(struct transport *transport, int verbosity,
 249         int force_progress);
 250
 251 #define REJECT_NON_FF_HEAD      0x01
 252 #define REJECT_NON_FF_OTHER     0x02
 253 #define REJECT_ALREADY_EXISTS   0x04
 254 #define REJECT_FETCH_FIRST      0x08
 255 #define REJECT_NEEDS_FORCE      0x10
 256 #define REJECT_REF_NEEDS_UPDATE 0x20
 257
 258 int transport_push(struct repository *repo,
 259                    struct transport *connection,
 260                    struct refspec *rs, int flags,
 261                    unsigned int * reject_reasons);
 262
 263 struct transport_ls_refs_options {
 264         /*
 265          * Optionally, a list of ref prefixes can be provided which can be sent
 266          * to the server (when communicating using protocol v2) to enable it to
 267          * limit the ref advertisement.  Since ref filtering is done on the
 268          * server's end (and only when using protocol v2),
 269          * transport_get_remote_refs() could return refs which don't match the
 270          * provided ref_prefixes.
 271          */
 272         struct strvec ref_prefixes;
 273
 274         /*
 275          * If unborn_head_target is not NULL, and the remote reports HEAD as
 276          * pointing to an unborn branch, transport_get_remote_refs() stores the
 277          * unborn branch in unborn_head_target.
 278          */
 279         const char *unborn_head_target;
 280 };
 281 #define TRANSPORT_LS_REFS_OPTIONS_INIT { \
 282         .ref_prefixes = STRVEC_INIT, \
 283 }
 284
 285 /**
 286  * Release the "struct transport_ls_refs_options".
 287  */
 288 void transport_ls_refs_options_release(struct transport_ls_refs_options *opts);
 289
 290 /*
 291  * Retrieve refs from a remote.
 292  */
 293 const struct ref *transport_get_remote_refs(struct transport *transport,
 294                                             struct transport_ls_refs_options *transport_options);
 295
 296 /**
 297  * Retrieve bundle URI(s) from a remote. Populates "struct
 298  * transport"'s "bundle_uri" and "got_remote_bundle_uri".
 299  */
 300 int transport_get_remote_bundle_uri(struct transport *transport);
 301
 302 /*
 303  * Fetch the hash algorithm used by a remote.
 304  *
 305  * This can only be called after fetching the remote refs.
 306  */
 307 const struct git_hash_algo *transport_get_hash_algo(struct transport *transport);
 308 int transport_fetch_refs(struct transport *transport, struct ref *refs);
 309
 310 /*
 311  * If this flag is set, unlocking will avoid to call non-async-signal-safe
 312  * functions. This will necessarily leave behind some data structures which
 313  * cannot be cleaned up.
 314  */
 315 #define TRANSPORT_UNLOCK_PACK_IN_SIGNAL_HANDLER (1 << 0)
 316
 317 /*
 318  * Unlock all packfiles locked by the transport.
 319  */
 320 void transport_unlock_pack(struct transport *transport, unsigned int flags);
 321
 322 int transport_disconnect(struct transport *transport);
 323 char *transport_anonymize_url(const char *url);
 324 void transport_take_over(struct transport *transport,
 325                          struct child_process *child);
 326
 327 int transport_connect(struct transport *transport, const char *name,
 328                       const char *exec, int fd[2]);
 329
 330 /* Transport methods defined outside transport.c */
 331 int transport_helper_init(struct transport *transport, const char *name);
 332 int bidirectional_transfer_loop(int input, int output);
 333
 334 /* common methods used by transport.c and builtin/send-pack.c */
 335 void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
 336
 337 int transport_refs_pushed(struct ref *ref);
 338
 339 void transport_print_push_status(const char *dest, struct ref *refs,
 340                   int verbose, int porcelain, unsigned int *reject_reasons);
 341
 342 /* common method used by transport-helper.c and send-pack.c */
 343 void reject_atomic_push(struct ref *refs, int mirror_mode);
 344
 345 /* common method to parse push-option or server-option from config */
 346 int parse_transport_option(const char *var, const char *value,
 347                            struct string_list *transport_options);
 348
 349 #endif