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