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