builtin/commit-graph.c

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