fetch-pack.h

   1 #ifndef FETCH_PACK_H
   2 #define FETCH_PACK_H
   3
   4 #include "string-list.h"
   5 #include "protocol.h"
   6 #include "list-objects-filter-options.h"
   7 #include "oidset.h"
   8
   9 struct oid_array;
  10
  11 struct fetch_pack_args {
  12         const char *uploadpack;
  13         int unpacklimit;
  14         int depth;
  15         const char *deepen_since;
  16         const struct string_list *deepen_not;
  17         struct list_objects_filter_options filter_options;
  18         const struct string_list *server_options;
  19
  20         /*
  21          * If not NULL, during packfile negotiation, fetch-pack will send "have"
  22          * lines only with these tips and their ancestors.
  23          */
  24         const struct oid_array *negotiation_tips;
  25
  26         unsigned deepen_relative:1;
  27         unsigned quiet:1;
  28         unsigned keep_pack:1;
  29         unsigned lock_pack:1;
  30         unsigned use_thin_pack:1;
  31         unsigned fetch_all:1;
  32         unsigned stdin_refs:1;
  33         unsigned diag_url:1;
  34         unsigned verbose:1;
  35         unsigned no_progress:1;
  36         unsigned include_tag:1;
  37         unsigned stateless_rpc:1;
  38         unsigned check_self_contained_and_connected:1;
  39         unsigned self_contained_and_connected:1;
  40         unsigned cloning:1;
  41         unsigned update_shallow:1;
  42         unsigned reject_shallow_remote:1;
  43         unsigned deepen:1;
  44         unsigned refetch:1;
  45
  46         /*
  47          * Indicate that the remote of this request is a promisor remote. The
  48          * pack received does not need all referred-to objects to be present in
  49          * the local object store, and fetch-pack will store the pack received
  50          * together with a ".promisor" file indicating that the aforementioned
  51          * pack is a promisor pack.
  52          */
  53         unsigned from_promisor:1;
  54
  55         /*
  56          * Because fetch_pack() overwrites the shallow file upon a
  57          * successful deepening non-clone fetch, if this struct
  58          * specifies such a fetch, fetch_pack() needs to perform a
  59          * connectivity check before deciding if a fetch is successful
  60          * (and overwriting the shallow file). fetch_pack() sets this
  61          * field to 1 if such a connectivity check was performed.
  62          *
  63          * This is different from check_self_contained_and_connected
  64          * in that the former allows existing objects in the
  65          * repository to satisfy connectivity needs, whereas the
  66          * latter doesn't.
  67          */
  68         unsigned connectivity_checked:1;
  69 };
  70
  71 /*
  72  * sought represents remote references that should be updated from.
  73  * On return, the names that were found on the remote will have been
  74  * marked as such.
  75  */
  76 struct ref *fetch_pack(struct fetch_pack_args *args,
  77                        int fd[],
  78                        const struct ref *ref,
  79                        struct ref **sought,
  80                        int nr_sought,
  81                        struct oid_array *shallow,
  82                        struct string_list *pack_lockfiles,
  83                        enum protocol_version version);
  84
  85 /*
  86  * Execute the --negotiate-only mode of "git fetch", adding all known common
  87  * commits to acked_commits.
  88  *
  89  * In the capability advertisement that has happened prior to invoking this
  90  * function, the "wait-for-done" capability must be present.
  91  */
  92 void negotiate_using_fetch(const struct oid_array *negotiation_tips,
  93                            const struct string_list *server_options,
  94                            int stateless_rpc,
  95                            int fd[],
  96                            struct oidset *acked_commits);
  97
  98 /*
  99  * Print an appropriate error message for each sought ref that wasn't
 100  * matched.  Return 0 if all sought refs were matched, otherwise 1.
 101  */
 102 int report_unmatched_refs(struct ref **sought, int nr_sought);
 103
 104 /*
 105  * Return true if checks for broken objects in received pack are required.
 106  */
 107 int fetch_pack_fsck_objects(void);
 108
 109 #endif