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