builtin/commit-graph.c

   1 #include "builtin.h"
   2 #include "config.h"
   3 #include "dir.h"
   4 #include "environment.h"
   5 #include "gettext.h"
   6 #include "hex.h"
   7 #include "lockfile.h"
   8 #include "parse-options.h"
   9 #include "repository.h"
  10 #include "commit-graph.h"
  11 #include "object-store.h"
  12 #include "progress.h"
  13 #include "replace-object.h"
  14 #include "tag.h"
  15
  16 #define BUILTIN_COMMIT_GRAPH_VERIFY_USAGE \
  17         N_("git commit-graph verify [--object-dir <dir>] [--shallow] [--[no-]progress]")
  18
  19 #define BUILTIN_COMMIT_GRAPH_WRITE_USAGE \
  20         N_("git commit-graph write [--object-dir <dir>] [--append]\n" \
  21            "                       [--split[=<strategy>]] [--reachable | --stdin-packs | --stdin-commits]\n" \
  22            "                       [--changed-paths] [--[no-]max-new-filters <n>] [--[no-]progress]\n" \
  23            "                       <split options>")
  24
  25 static const char * builtin_commit_graph_verify_usage[] = {
  26         BUILTIN_COMMIT_GRAPH_VERIFY_USAGE,
  27         NULL
  28 };
  29
  30 static const char * builtin_commit_graph_write_usage[] = {
  31         BUILTIN_COMMIT_GRAPH_WRITE_USAGE,
  32         NULL
  33 };
  34
  35 static char const * const builtin_commit_graph_usage[] = {
  36         BUILTIN_COMMIT_GRAPH_VERIFY_USAGE,
  37         BUILTIN_COMMIT_GRAPH_WRITE_USAGE,
  38         NULL,
  39 };
  40
  41 static struct opts_commit_graph {
  42         const char *obj_dir;
  43         int reachable;
  44         int stdin_packs;
  45         int stdin_commits;
  46         int append;
  47         int split;
  48         int shallow;
  49         int progress;
  50         int enable_changed_paths;
  51 } opts;
  52
  53 static struct option common_opts[] = {
  54         OPT_STRING(0, "object-dir", &opts.obj_dir,
  55                    N_("dir"),
  56                    N_("the object directory to store the graph")),
  57         OPT_END()
  58 };
  59
  60 static struct option *add_common_options(struct option *to)
  61 {
  62         return parse_options_concat(common_opts, to);
  63 }
  64
  65 static int graph_verify(int argc, const char **argv, const char *prefix)
  66 {
  67         struct commit_graph *graph = NULL;
  68         struct object_directory *odb = NULL;
  69         char *graph_name;
  70         int open_ok;
  71         int fd;
  72         struct stat st;
  73         int flags = 0;
  74         int ret;
  75
  76         static struct option builtin_commit_graph_verify_options[] = {
  77                 OPT_BOOL(0, "shallow", &opts.shallow,
  78                          N_("if the commit-graph is split, only verify the tip file")),
  79                 OPT_BOOL(0, "progress", &opts.progress,
  80                          N_("force progress reporting")),
  81                 OPT_END(),
  82         };
  83         struct option *options = add_common_options(builtin_commit_graph_verify_options);
  84
  85         trace2_cmd_mode("verify");
  86
  87         opts.progress = isatty(2);
  88         argc = parse_options(argc, argv, prefix,
  89                              options,
  90                              builtin_commit_graph_verify_usage, 0);
  91         if (argc)
  92                 usage_with_options(builtin_commit_graph_verify_usage, options);
  93
  94         if (!opts.obj_dir)
  95                 opts.obj_dir = get_object_directory();
  96         if (opts.shallow)
  97                 flags |= COMMIT_GRAPH_VERIFY_SHALLOW;
  98         if (opts.progress)
  99                 flags |= COMMIT_GRAPH_WRITE_PROGRESS;
 100
 101         odb = find_odb(the_repository, opts.obj_dir);
 102         graph_name = get_commit_graph_filename(odb);
 103         open_ok = open_commit_graph(graph_name, &fd, &st);
 104         if (!open_ok && errno != ENOENT)
 105                 die_errno(_("Could not open commit-graph '%s'"), graph_name);
 106
 107         FREE_AND_NULL(graph_name);
 108         FREE_AND_NULL(options);
 109
 110         if (open_ok)
 111                 graph = load_commit_graph_one_fd_st(the_repository, fd, &st, odb);
 112         else
 113                 graph = read_commit_graph_one(the_repository, odb);
 114
 115         /* Return failure if open_ok predicted success */
 116         if (!graph)
 117                 return !!open_ok;
 118
 119         ret = verify_commit_graph(the_repository, graph, flags);
 120         free_commit_graph(graph);
 121         return ret;
 122 }
 123
 124 extern int read_replace_refs;
 125 static struct commit_graph_opts write_opts;
 126
 127 static int write_option_parse_split(const struct option *opt, const char *arg,
 128                                     int unset)
 129 {
 130         enum commit_graph_split_flags *flags = opt->value;
 131
 132         BUG_ON_OPT_NEG(unset);
 133
 134         opts.split = 1;
 135         if (!arg)
 136                 return 0;
 137
 138         if (!strcmp(arg, "no-merge"))
 139                 *flags = COMMIT_GRAPH_SPLIT_MERGE_PROHIBITED;
 140         else if (!strcmp(arg, "replace"))
 141                 *flags = COMMIT_GRAPH_SPLIT_REPLACE;
 142         else
 143                 die(_("unrecognized --split argument, %s"), arg);
 144
 145         return 0;
 146 }
 147
 148 static int read_one_commit(struct oidset *commits, struct progress *progress,
 149                            const char *hash)
 150 {
 151         struct object *result;
 152         struct object_id oid;
 153         const char *end;
 154
 155         if (parse_oid_hex(hash, &oid, &end))
 156                 return error(_("unexpected non-hex object ID: %s"), hash);
 157
 158         result = deref_tag(the_repository, parse_object(the_repository, &oid),
 159                            NULL, 0);
 160         if (!result)
 161                 return error(_("invalid object: %s"), hash);
 162         else if (object_as_type(result, OBJ_COMMIT, 1))
 163                 oidset_insert(commits, &result->oid);
 164
 165         display_progress(progress, oidset_size(commits));
 166
 167         return 0;
 168 }
 169
 170 static int write_option_max_new_filters(const struct option *opt,
 171                                         const char *arg,
 172                                         int unset)
 173 {
 174         int *to = opt->value;
 175         if (unset)
 176                 *to = -1;
 177         else {
 178                 const char *s;
 179                 *to = strtol(arg, (char **)&s, 10);
 180                 if (*s)
 181                         return error(_("option `%s' expects a numerical value"),
 182                                      "max-new-filters");
 183         }
 184         return 0;
 185 }
 186
 187 static int git_commit_graph_write_config(const char *var, const char *value,
 188                                          void *cb UNUSED)
 189 {
 190         if (!strcmp(var, "commitgraph.maxnewfilters"))
 191                 write_opts.max_new_filters = git_config_int(var, value);
 192         /*
 193          * No need to fall-back to 'git_default_config', since this was already
 194          * called in 'cmd_commit_graph()'.
 195          */
 196         return 0;
 197 }
 198
 199 static int graph_write(int argc, const char **argv, const char *prefix)
 200 {
 201         struct string_list pack_indexes = STRING_LIST_INIT_DUP;
 202         struct strbuf buf = STRBUF_INIT;
 203         struct oidset commits = OIDSET_INIT;
 204         struct object_directory *odb = NULL;
 205         int result = 0;
 206         enum commit_graph_write_flags flags = 0;
 207         struct progress *progress = NULL;
 208
 209         static struct option builtin_commit_graph_write_options[] = {
 210                 OPT_BOOL(0, "reachable", &opts.reachable,
 211                         N_("start walk at all refs")),
 212                 OPT_BOOL(0, "stdin-packs", &opts.stdin_packs,
 213                         N_("scan pack-indexes listed by stdin for commits")),
 214                 OPT_BOOL(0, "stdin-commits", &opts.stdin_commits,
 215                         N_("start walk at commits listed by stdin")),
 216                 OPT_BOOL(0, "append", &opts.append,
 217                         N_("include all commits already in the commit-graph file")),
 218                 OPT_BOOL(0, "changed-paths", &opts.enable_changed_paths,
 219                         N_("enable computation for changed paths")),
 220                 OPT_CALLBACK_F(0, "split", &write_opts.split_flags, NULL,
 221                         N_("allow writing an incremental commit-graph file"),
 222                         PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
 223                         write_option_parse_split),
 224                 OPT_INTEGER(0, "max-commits", &write_opts.max_commits,
 225                         N_("maximum number of commits in a non-base split commit-graph")),
 226                 OPT_INTEGER(0, "size-multiple", &write_opts.size_multiple,
 227                         N_("maximum ratio between two levels of a split commit-graph")),
 228                 OPT_EXPIRY_DATE(0, "expire-time", &write_opts.expire_time,
 229                         N_("only expire files older than a given date-time")),
 230                 OPT_CALLBACK_F(0, "max-new-filters", &write_opts.max_new_filters,
 231                         NULL, N_("maximum number of changed-path Bloom filters to compute"),
 232                         0, write_option_max_new_filters),
 233                 OPT_BOOL(0, "progress", &opts.progress,
 234                          N_("force progress reporting")),
 235                 OPT_END(),
 236         };
 237         struct option *options = add_common_options(builtin_commit_graph_write_options);
 238
 239         opts.progress = isatty(2);
 240         opts.enable_changed_paths = -1;
 241         write_opts.size_multiple = 2;
 242         write_opts.max_commits = 0;
 243         write_opts.expire_time = 0;
 244         write_opts.max_new_filters = -1;
 245
 246         trace2_cmd_mode("write");
 247
 248         git_config(git_commit_graph_write_config, &opts);
 249
 250         argc = parse_options(argc, argv, prefix,
 251                              options,
 252                              builtin_commit_graph_write_usage, 0);
 253         if (argc)
 254                 usage_with_options(builtin_commit_graph_write_usage, options);
 255
 256         if (opts.reachable + opts.stdin_packs + opts.stdin_commits > 1)
 257                 die(_("use at most one of --reachable, --stdin-commits, or --stdin-packs"));
 258         if (!opts.obj_dir)
 259                 opts.obj_dir = get_object_directory();
 260         if (opts.append)
 261                 flags |= COMMIT_GRAPH_WRITE_APPEND;
 262         if (opts.split)
 263                 flags |= COMMIT_GRAPH_WRITE_SPLIT;
 264         if (opts.progress)
 265                 flags |= COMMIT_GRAPH_WRITE_PROGRESS;
 266         if (!opts.enable_changed_paths)
 267                 flags |= COMMIT_GRAPH_NO_WRITE_BLOOM_FILTERS;
 268         if (opts.enable_changed_paths == 1 ||
 269             git_env_bool(GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS, 0))
 270                 flags |= COMMIT_GRAPH_WRITE_BLOOM_FILTERS;
 271
 272         odb = find_odb(the_repository, opts.obj_dir);
 273
 274         if (opts.reachable) {
 275                 if (write_commit_graph_reachable(odb, flags, &write_opts))
 276                         result = 1;
 277                 goto cleanup;
 278         }
 279
 280         if (opts.stdin_packs) {
 281                 while (strbuf_getline(&buf, stdin) != EOF)
 282                         string_list_append_nodup(&pack_indexes,
 283                                                  strbuf_detach(&buf, NULL));
 284         } else if (opts.stdin_commits) {
 285                 oidset_init(&commits, 0);
 286                 if (opts.progress)
 287                         progress = start_delayed_progress(
 288                                 _("Collecting commits from input"), 0);
 289
 290                 while (strbuf_getline(&buf, stdin) != EOF) {
 291                         if (read_one_commit(&commits, progress, buf.buf)) {
 292                                 result = 1;
 293                                 goto cleanup;
 294                         }
 295                 }
 296
 297                 stop_progress(&progress);
 298         }
 299
 300         if (write_commit_graph(odb,
 301                                opts.stdin_packs ? &pack_indexes : NULL,
 302                                opts.stdin_commits ? &commits : NULL,
 303                                flags,
 304                                &write_opts))
 305                 result = 1;
 306
 307 cleanup:
 308         FREE_AND_NULL(options);
 309         string_list_clear(&pack_indexes, 0);
 310         strbuf_release(&buf);
 311         return result;
 312 }
 313
 314 int cmd_commit_graph(int argc, const char **argv, const char *prefix)
 315 {
 316         parse_opt_subcommand_fn *fn = NULL;
 317         struct option builtin_commit_graph_options[] = {
 318                 OPT_SUBCOMMAND("verify", &fn, graph_verify),
 319                 OPT_SUBCOMMAND("write", &fn, graph_write),
 320                 OPT_END(),
 321         };
 322         struct option *options = parse_options_concat(builtin_commit_graph_options, common_opts);
 323
 324         git_config(git_default_config, NULL);
 325
 326         read_replace_refs = 0;
 327         save_commit_buffer = 0;
 328
 329         argc = parse_options(argc, argv, prefix, options,
 330                              builtin_commit_graph_usage, 0);
 331         FREE_AND_NULL(options);
 332
 333         return fn(argc, argv, prefix);
 334 }