builtin/repack.c

   1 #include "builtin.h"
   2 #include "cache.h"
   3 #include "config.h"
   4 #include "dir.h"
   5 #include "parse-options.h"
   6 #include "run-command.h"
   7 #include "sigchain.h"
   8 #include "strbuf.h"
   9 #include "string-list.h"
  10 #include "argv-array.h"
  11 #include "midx.h"
  12 #include "packfile.h"
  13 #include "object-store.h"
  14 #include "promisor-remote.h"
  15
  16 static int delta_base_offset = 1;
  17 static int pack_kept_objects = -1;
  18 static int write_bitmaps = -1;
  19 static int use_delta_islands;
  20 static char *packdir, *packtmp;
  21
  22 static const char *const git_repack_usage[] = {
  23         N_("git repack [<options>]"),
  24         NULL
  25 };
  26
  27 static const char incremental_bitmap_conflict_error[] = N_(
  28 "Incremental repacks are incompatible with bitmap indexes.  Use\n"
  29 "--no-write-bitmap-index or disable the pack.writebitmaps configuration."
  30 );
  31
  32
  33 static int repack_config(const char *var, const char *value, void *cb)
  34 {
  35         if (!strcmp(var, "repack.usedeltabaseoffset")) {
  36                 delta_base_offset = git_config_bool(var, value);
  37                 return 0;
  38         }
  39         if (!strcmp(var, "repack.packkeptobjects")) {
  40                 pack_kept_objects = git_config_bool(var, value);
  41                 return 0;
  42         }
  43         if (!strcmp(var, "repack.writebitmaps") ||
  44             !strcmp(var, "pack.writebitmaps")) {
  45                 write_bitmaps = git_config_bool(var, value);
  46                 return 0;
  47         }
  48         if (!strcmp(var, "repack.usedeltaislands")) {
  49                 use_delta_islands = git_config_bool(var, value);
  50                 return 0;
  51         }
  52         return git_default_config(var, value, cb);
  53 }
  54
  55 /*
  56  * Remove temporary $GIT_OBJECT_DIRECTORY/pack/.tmp-$$-pack-* files.
  57  */
  58 static void remove_temporary_files(void)
  59 {
  60         struct strbuf buf = STRBUF_INIT;
  61         size_t dirlen, prefixlen;
  62         DIR *dir;
  63         struct dirent *e;
  64
  65         dir = opendir(packdir);
  66         if (!dir)
  67                 return;
  68
  69         /* Point at the slash at the end of ".../objects/pack/" */
  70         dirlen = strlen(packdir) + 1;
  71         strbuf_addstr(&buf, packtmp);
  72         /* Hold the length of  ".tmp-%d-pack-" */
  73         prefixlen = buf.len - dirlen;
  74
  75         while ((e = readdir(dir))) {
  76                 if (strncmp(e->d_name, buf.buf + dirlen, prefixlen))
  77                         continue;
  78                 strbuf_setlen(&buf, dirlen);
  79                 strbuf_addstr(&buf, e->d_name);
  80                 unlink(buf.buf);
  81         }
  82         closedir(dir);
  83         strbuf_release(&buf);
  84 }
  85
  86 static void remove_pack_on_signal(int signo)
  87 {
  88         remove_temporary_files();
  89         sigchain_pop(signo);
  90         raise(signo);
  91 }
  92
  93 /*
  94  * Adds all packs hex strings to the fname list, which do not
  95  * have a corresponding .keep file. These packs are not to
  96  * be kept if we are going to pack everything into one file.
  97  */
  98 static void get_non_kept_pack_filenames(struct string_list *fname_list,
  99                                         const struct string_list *extra_keep)
 100 {
 101         DIR *dir;
 102         struct dirent *e;
 103         char *fname;
 104
 105         if (!(dir = opendir(packdir)))
 106                 return;
 107
 108         while ((e = readdir(dir)) != NULL) {
 109                 size_t len;
 110                 int i;
 111
 112                 for (i = 0; i < extra_keep->nr; i++)
 113                         if (!fspathcmp(e->d_name, extra_keep->items[i].string))
 114                                 break;
 115                 if (extra_keep->nr > 0 && i < extra_keep->nr)
 116                         continue;
 117
 118                 if (!strip_suffix(e->d_name, ".pack", &len))
 119                         continue;
 120
 121                 fname = xmemdupz(e->d_name, len);
 122
 123                 if (!file_exists(mkpath("%s/%s.keep", packdir, fname)))
 124                         string_list_append_nodup(fname_list, fname);
 125                 else
 126                         free(fname);
 127         }
 128         closedir(dir);
 129 }
 130
 131 static void remove_redundant_pack(const char *dir_name, const char *base_name)
 132 {
 133         struct strbuf buf = STRBUF_INIT;
 134         strbuf_addf(&buf, "%s/%s.pack", dir_name, base_name);
 135         unlink_pack_path(buf.buf, 1);
 136         strbuf_release(&buf);
 137 }
 138
 139 struct pack_objects_args {
 140         const char *window;
 141         const char *window_memory;
 142         const char *depth;
 143         const char *threads;
 144         const char *max_pack_size;
 145         int no_reuse_delta;
 146         int no_reuse_object;
 147         int quiet;
 148         int local;
 149 };
 150
 151 static void prepare_pack_objects(struct child_process *cmd,
 152                                  const struct pack_objects_args *args)
 153 {
 154         argv_array_push(&cmd->args, "pack-objects");
 155         if (args->window)
 156                 argv_array_pushf(&cmd->args, "--window=%s", args->window);
 157         if (args->window_memory)
 158                 argv_array_pushf(&cmd->args, "--window-memory=%s", args->window_memory);
 159         if (args->depth)
 160                 argv_array_pushf(&cmd->args, "--depth=%s", args->depth);
 161         if (args->threads)
 162                 argv_array_pushf(&cmd->args, "--threads=%s", args->threads);
 163         if (args->max_pack_size)
 164                 argv_array_pushf(&cmd->args, "--max-pack-size=%s", args->max_pack_size);
 165         if (args->no_reuse_delta)
 166                 argv_array_pushf(&cmd->args, "--no-reuse-delta");
 167         if (args->no_reuse_object)
 168                 argv_array_pushf(&cmd->args, "--no-reuse-object");
 169         if (args->local)
 170                 argv_array_push(&cmd->args,  "--local");
 171         if (args->quiet)
 172                 argv_array_push(&cmd->args,  "--quiet");
 173         if (delta_base_offset)
 174                 argv_array_push(&cmd->args,  "--delta-base-offset");
 175         argv_array_push(&cmd->args, packtmp);
 176         cmd->git_cmd = 1;
 177         cmd->out = -1;
 178 }
 179
 180 /*
 181  * Write oid to the given struct child_process's stdin, starting it first if
 182  * necessary.
 183  */
 184 static int write_oid(const struct object_id *oid, struct packed_git *pack,
 185                      uint32_t pos, void *data)
 186 {
 187         struct child_process *cmd = data;
 188
 189         if (cmd->in == -1) {
 190                 if (start_command(cmd))
 191                         die(_("could not start pack-objects to repack promisor objects"));
 192         }
 193
 194         xwrite(cmd->in, oid_to_hex(oid), the_hash_algo->hexsz);
 195         xwrite(cmd->in, "\n", 1);
 196         return 0;
 197 }
 198
 199 static void repack_promisor_objects(const struct pack_objects_args *args,
 200                                     struct string_list *names)
 201 {
 202         struct child_process cmd = CHILD_PROCESS_INIT;
 203         FILE *out;
 204         struct strbuf line = STRBUF_INIT;
 205
 206         prepare_pack_objects(&cmd, args);
 207         cmd.in = -1;
 208
 209         /*
 210          * NEEDSWORK: Giving pack-objects only the OIDs without any ordering
 211          * hints may result in suboptimal deltas in the resulting pack. See if
 212          * the OIDs can be sent with fake paths such that pack-objects can use a
 213          * {type -> existing pack order} ordering when computing deltas instead
 214          * of a {type -> size} ordering, which may produce better deltas.
 215          */
 216         for_each_packed_object(write_oid, &cmd,
 217                                FOR_EACH_OBJECT_PROMISOR_ONLY);
 218
 219         if (cmd.in == -1)
 220                 /* No packed objects; cmd was never started */
 221                 return;
 222
 223         close(cmd.in);
 224
 225         out = xfdopen(cmd.out, "r");
 226         while (strbuf_getline_lf(&line, out) != EOF) {
 227                 char *promisor_name;
 228                 int fd;
 229                 if (line.len != the_hash_algo->hexsz)
 230                         die(_("repack: Expecting full hex object ID lines only from pack-objects."));
 231                 string_list_append(names, line.buf);
 232
 233                 /*
 234                  * pack-objects creates the .pack and .idx files, but not the
 235                  * .promisor file. Create the .promisor file, which is empty.
 236                  */
 237                 promisor_name = mkpathdup("%s-%s.promisor", packtmp,
 238                                           line.buf);
 239                 fd = open(promisor_name, O_CREAT|O_EXCL|O_WRONLY, 0600);
 240                 if (fd < 0)
 241                         die_errno(_("unable to create '%s'"), promisor_name);
 242                 close(fd);
 243                 free(promisor_name);
 244         }
 245         fclose(out);
 246         if (finish_command(&cmd))
 247                 die(_("could not finish pack-objects to repack promisor objects"));
 248 }
 249
 250 #define ALL_INTO_ONE 1
 251 #define LOOSEN_UNREACHABLE 2
 252
 253 int cmd_repack(int argc, const char **argv, const char *prefix)
 254 {
 255         struct {
 256                 const char *name;
 257                 unsigned optional:1;
 258         } exts[] = {
 259                 {".pack"},
 260                 {".idx"},
 261                 {".bitmap", 1},
 262                 {".promisor", 1},
 263         };
 264         struct child_process cmd = CHILD_PROCESS_INIT;
 265         struct string_list_item *item;
 266         struct string_list names = STRING_LIST_INIT_DUP;
 267         struct string_list rollback = STRING_LIST_INIT_NODUP;
 268         struct string_list existing_packs = STRING_LIST_INIT_DUP;
 269         struct strbuf line = STRBUF_INIT;
 270         int i, ext, ret, failed;
 271         FILE *out;
 272
 273         /* variables to be filled by option parsing */
 274         int pack_everything = 0;
 275         int delete_redundant = 0;
 276         const char *unpack_unreachable = NULL;
 277         int keep_unreachable = 0;
 278         struct string_list keep_pack_list = STRING_LIST_INIT_NODUP;
 279         int no_update_server_info = 0;
 280         int midx_cleared = 0;
 281         struct pack_objects_args po_args = {NULL};
 282
 283         struct option builtin_repack_options[] = {
 284                 OPT_BIT('a', NULL, &pack_everything,
 285                                 N_("pack everything in a single pack"), ALL_INTO_ONE),
 286                 OPT_BIT('A', NULL, &pack_everything,
 287                                 N_("same as -a, and turn unreachable objects loose"),
 288                                    LOOSEN_UNREACHABLE | ALL_INTO_ONE),
 289                 OPT_BOOL('d', NULL, &delete_redundant,
 290                                 N_("remove redundant packs, and run git-prune-packed")),
 291                 OPT_BOOL('f', NULL, &po_args.no_reuse_delta,
 292                                 N_("pass --no-reuse-delta to git-pack-objects")),
 293                 OPT_BOOL('F', NULL, &po_args.no_reuse_object,
 294                                 N_("pass --no-reuse-object to git-pack-objects")),
 295                 OPT_BOOL('n', NULL, &no_update_server_info,
 296                                 N_("do not run git-update-server-info")),
 297                 OPT__QUIET(&po_args.quiet, N_("be quiet")),
 298                 OPT_BOOL('l', "local", &po_args.local,
 299                                 N_("pass --local to git-pack-objects")),
 300                 OPT_BOOL('b', "write-bitmap-index", &write_bitmaps,
 301                                 N_("write bitmap index")),
 302                 OPT_BOOL('i', "delta-islands", &use_delta_islands,
 303                                 N_("pass --delta-islands to git-pack-objects")),
 304                 OPT_STRING(0, "unpack-unreachable", &unpack_unreachable, N_("approxidate"),
 305                                 N_("with -A, do not loosen objects older than this")),
 306                 OPT_BOOL('k', "keep-unreachable", &keep_unreachable,
 307                                 N_("with -a, repack unreachable objects")),
 308                 OPT_STRING(0, "window", &po_args.window, N_("n"),
 309                                 N_("size of the window used for delta compression")),
 310                 OPT_STRING(0, "window-memory", &po_args.window_memory, N_("bytes"),
 311                                 N_("same as the above, but limit memory size instead of entries count")),
 312                 OPT_STRING(0, "depth", &po_args.depth, N_("n"),
 313                                 N_("limits the maximum delta depth")),
 314                 OPT_STRING(0, "threads", &po_args.threads, N_("n"),
 315                                 N_("limits the maximum number of threads")),
 316                 OPT_STRING(0, "max-pack-size", &po_args.max_pack_size, N_("bytes"),
 317                                 N_("maximum size of each packfile")),
 318                 OPT_BOOL(0, "pack-kept-objects", &pack_kept_objects,
 319                                 N_("repack objects in packs marked with .keep")),
 320                 OPT_STRING_LIST(0, "keep-pack", &keep_pack_list, N_("name"),
 321                                 N_("do not repack this pack")),
 322                 OPT_END()
 323         };
 324
 325         git_config(repack_config, NULL);
 326
 327         argc = parse_options(argc, argv, prefix, builtin_repack_options,
 328                                 git_repack_usage, 0);
 329
 330         if (delete_redundant && repository_format_precious_objects)
 331                 die(_("cannot delete packs in a precious-objects repo"));
 332
 333         if (keep_unreachable &&
 334             (unpack_unreachable || (pack_everything & LOOSEN_UNREACHABLE)))
 335                 die(_("--keep-unreachable and -A are incompatible"));
 336
 337         if (write_bitmaps < 0) {
 338                 if (!(pack_everything & ALL_INTO_ONE) ||
 339                     !is_bare_repository())
 340                         write_bitmaps = 0;
 341         }
 342         if (pack_kept_objects < 0)
 343                 pack_kept_objects = write_bitmaps > 0;
 344
 345         if (write_bitmaps && !(pack_everything & ALL_INTO_ONE))
 346                 die(_(incremental_bitmap_conflict_error));
 347
 348         packdir = mkpathdup("%s/pack", get_object_directory());
 349         packtmp = mkpathdup("%s/.tmp-%d-pack", packdir, (int)getpid());
 350
 351         sigchain_push_common(remove_pack_on_signal);
 352
 353         prepare_pack_objects(&cmd, &po_args);
 354
 355         argv_array_push(&cmd.args, "--keep-true-parents");
 356         if (!pack_kept_objects)
 357                 argv_array_push(&cmd.args, "--honor-pack-keep");
 358         for (i = 0; i < keep_pack_list.nr; i++)
 359                 argv_array_pushf(&cmd.args, "--keep-pack=%s",
 360                                  keep_pack_list.items[i].string);
 361         argv_array_push(&cmd.args, "--non-empty");
 362         argv_array_push(&cmd.args, "--all");
 363         argv_array_push(&cmd.args, "--reflog");
 364         argv_array_push(&cmd.args, "--indexed-objects");
 365         if (has_promisor_remote())
 366                 argv_array_push(&cmd.args, "--exclude-promisor-objects");
 367         if (write_bitmaps > 0)
 368                 argv_array_push(&cmd.args, "--write-bitmap-index");
 369         else if (write_bitmaps < 0)
 370                 argv_array_push(&cmd.args, "--write-bitmap-index-quiet");
 371         if (use_delta_islands)
 372                 argv_array_push(&cmd.args, "--delta-islands");
 373
 374         if (pack_everything & ALL_INTO_ONE) {
 375                 get_non_kept_pack_filenames(&existing_packs, &keep_pack_list);
 376
 377                 repack_promisor_objects(&po_args, &names);
 378
 379                 if (existing_packs.nr && delete_redundant) {
 380                         if (unpack_unreachable) {
 381                                 argv_array_pushf(&cmd.args,
 382                                                 "--unpack-unreachable=%s",
 383                                                 unpack_unreachable);
 384                                 argv_array_push(&cmd.env_array, "GIT_REF_PARANOIA=1");
 385                         } else if (pack_everything & LOOSEN_UNREACHABLE) {
 386                                 argv_array_push(&cmd.args,
 387                                                 "--unpack-unreachable");
 388                         } else if (keep_unreachable) {
 389                                 argv_array_push(&cmd.args, "--keep-unreachable");
 390                                 argv_array_push(&cmd.args, "--pack-loose-unreachable");
 391                         } else {
 392                                 argv_array_push(&cmd.env_array, "GIT_REF_PARANOIA=1");
 393                         }
 394                 }
 395         } else {
 396                 argv_array_push(&cmd.args, "--unpacked");
 397                 argv_array_push(&cmd.args, "--incremental");
 398         }
 399
 400         cmd.no_stdin = 1;
 401
 402         ret = start_command(&cmd);
 403         if (ret)
 404                 return ret;
 405
 406         out = xfdopen(cmd.out, "r");
 407         while (strbuf_getline_lf(&line, out) != EOF) {
 408                 if (line.len != the_hash_algo->hexsz)
 409                         die(_("repack: Expecting full hex object ID lines only from pack-objects."));
 410                 string_list_append(&names, line.buf);
 411         }
 412         fclose(out);
 413         ret = finish_command(&cmd);
 414         if (ret)
 415                 return ret;
 416
 417         if (!names.nr && !po_args.quiet)
 418                 printf_ln(_("Nothing new to pack."));
 419
 420         close_object_store(the_repository->objects);
 421
 422         /*
 423          * Ok we have prepared all new packfiles.
 424          * First see if there are packs of the same name and if so
 425          * if we can move them out of the way (this can happen if we
 426          * repacked immediately after packing fully.
 427          */
 428         failed = 0;
 429         for_each_string_list_item(item, &names) {
 430                 for (ext = 0; ext < ARRAY_SIZE(exts); ext++) {
 431                         char *fname, *fname_old;
 432
 433                         if (!midx_cleared) {
 434                                 clear_midx_file(the_repository);
 435                                 midx_cleared = 1;
 436                         }
 437
 438                         fname = mkpathdup("%s/pack-%s%s", packdir,
 439                                                 item->string, exts[ext].name);
 440                         if (!file_exists(fname)) {
 441                                 free(fname);
 442                                 continue;
 443                         }
 444
 445                         fname_old = mkpathdup("%s/old-%s%s", packdir,
 446                                                 item->string, exts[ext].name);
 447                         if (file_exists(fname_old))
 448                                 if (unlink(fname_old))
 449                                         failed = 1;
 450
 451                         if (!failed && rename(fname, fname_old)) {
 452                                 free(fname);
 453                                 free(fname_old);
 454                                 failed = 1;
 455                                 break;
 456                         } else {
 457                                 string_list_append(&rollback, fname);
 458                                 free(fname_old);
 459                         }
 460                 }
 461                 if (failed)
 462                         break;
 463         }
 464         if (failed) {
 465                 struct string_list rollback_failure = STRING_LIST_INIT_DUP;
 466                 for_each_string_list_item(item, &rollback) {
 467                         char *fname, *fname_old;
 468                         fname = mkpathdup("%s/%s", packdir, item->string);
 469                         fname_old = mkpathdup("%s/old-%s", packdir, item->string);
 470                         if (rename(fname_old, fname))
 471                                 string_list_append(&rollback_failure, fname);
 472                         free(fname);
 473                         free(fname_old);
 474                 }
 475
 476                 if (rollback_failure.nr) {
 477                         int i;
 478                         fprintf(stderr,
 479                                 _("WARNING: Some packs in use have been renamed by\n"
 480                                   "WARNING: prefixing old- to their name, in order to\n"
 481                                   "WARNING: replace them with the new version of the\n"
 482                                   "WARNING: file.  But the operation failed, and the\n"
 483                                   "WARNING: attempt to rename them back to their\n"
 484                                   "WARNING: original names also failed.\n"
 485                                   "WARNING: Please rename them in %s manually:\n"), packdir);
 486                         for (i = 0; i < rollback_failure.nr; i++)
 487                                 fprintf(stderr, "WARNING:   old-%s -> %s\n",
 488                                         rollback_failure.items[i].string,
 489                                         rollback_failure.items[i].string);
 490                 }
 491                 exit(1);
 492         }
 493
 494         /* Now the ones with the same name are out of the way... */
 495         for_each_string_list_item(item, &names) {
 496                 for (ext = 0; ext < ARRAY_SIZE(exts); ext++) {
 497                         char *fname, *fname_old;
 498                         struct stat statbuffer;
 499                         int exists = 0;
 500                         fname = mkpathdup("%s/pack-%s%s",
 501                                         packdir, item->string, exts[ext].name);
 502                         fname_old = mkpathdup("%s-%s%s",
 503                                         packtmp, item->string, exts[ext].name);
 504                         if (!stat(fname_old, &statbuffer)) {
 505                                 statbuffer.st_mode &= ~(S_IWUSR | S_IWGRP | S_IWOTH);
 506                                 chmod(fname_old, statbuffer.st_mode);
 507                                 exists = 1;
 508                         }
 509                         if (exists || !exts[ext].optional) {
 510                                 if (rename(fname_old, fname))
 511                                         die_errno(_("renaming '%s' failed"), fname_old);
 512                         }
 513                         free(fname);
 514                         free(fname_old);
 515                 }
 516         }
 517
 518         /* Remove the "old-" files */
 519         for_each_string_list_item(item, &names) {
 520                 for (ext = 0; ext < ARRAY_SIZE(exts); ext++) {
 521                         char *fname;
 522                         fname = mkpathdup("%s/old-%s%s",
 523                                           packdir,
 524                                           item->string,
 525                                           exts[ext].name);
 526                         if (remove_path(fname))
 527                                 warning(_("failed to remove '%s'"), fname);
 528                         free(fname);
 529                 }
 530         }
 531
 532         /* End of pack replacement. */
 533
 534         reprepare_packed_git(the_repository);
 535
 536         if (delete_redundant) {
 537                 const int hexsz = the_hash_algo->hexsz;
 538                 int opts = 0;
 539                 string_list_sort(&names);
 540                 for_each_string_list_item(item, &existing_packs) {
 541                         char *sha1;
 542                         size_t len = strlen(item->string);
 543                         if (len < hexsz)
 544                                 continue;
 545                         sha1 = item->string + len - hexsz;
 546                         if (!string_list_has_string(&names, sha1))
 547                                 remove_redundant_pack(packdir, item->string);
 548                 }
 549                 if (!po_args.quiet && isatty(2))
 550                         opts |= PRUNE_PACKED_VERBOSE;
 551                 prune_packed_objects(opts);
 552
 553                 if (!keep_unreachable &&
 554                     (!(pack_everything & LOOSEN_UNREACHABLE) ||
 555                      unpack_unreachable) &&
 556                     is_repository_shallow(the_repository))
 557                         prune_shallow(PRUNE_QUICK);
 558         }
 559
 560         if (!no_update_server_info)
 561                 update_server_info(0);
 562         remove_temporary_files();
 563
 564         if (git_env_bool(GIT_TEST_MULTI_PACK_INDEX, 0))
 565                 write_midx_file(get_object_directory());
 566
 567         string_list_clear(&names, 0);
 568         string_list_clear(&rollback, 0);
 569         string_list_clear(&existing_packs, 0);
 570         strbuf_release(&line);
 571
 572         return 0;
 573 }