builtin/commit-graph.c

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