builtin/repack.c

   1 #include "builtin.h"
   2 #include "cache.h"
   3 #include "dir.h"
   4 #include "parse-options.h"
   5 #include "run-command.h"
   6 #include "sigchain.h"
   7 #include "strbuf.h"
   8 #include "string-list.h"
   9 #include "argv-array.h"
  10
  11 static int delta_base_offset = 1;
  12 static int pack_kept_objects = -1;
  13 static int write_bitmaps;
  14 static char *packdir, *packtmp;
  15
  16 static const char *const git_repack_usage[] = {
  17         N_("git repack [options]"),
  18         NULL
  19 };
  20
  21 static int repack_config(const char *var, const char *value, void *cb)
  22 {
  23         if (!strcmp(var, "repack.usedeltabaseoffset")) {
  24                 delta_base_offset = git_config_bool(var, value);
  25                 return 0;
  26         }
  27         if (!strcmp(var, "repack.packkeptobjects")) {
  28                 pack_kept_objects = git_config_bool(var, value);
  29                 return 0;
  30         }
  31         if (!strcmp(var, "repack.writebitmaps") ||
  32             !strcmp(var, "pack.writebitmaps")) {
  33                 write_bitmaps = git_config_bool(var, value);
  34                 return 0;
  35         }
  36         return git_default_config(var, value, cb);
  37 }
  38
  39 /*
  40  * Remove temporary $GIT_OBJECT_DIRECTORY/pack/.tmp-$$-pack-* files.
  41  */
  42 static void remove_temporary_files(void)
  43 {
  44         struct strbuf buf = STRBUF_INIT;
  45         size_t dirlen, prefixlen;
  46         DIR *dir;
  47         struct dirent *e;
  48
  49         dir = opendir(packdir);
  50         if (!dir)
  51                 return;
  52
  53         /* Point at the slash at the end of ".../objects/pack/" */
  54         dirlen = strlen(packdir) + 1;
  55         strbuf_addstr(&buf, packtmp);
  56         /* Hold the length of  ".tmp-%d-pack-" */
  57         prefixlen = buf.len - dirlen;
  58
  59         while ((e = readdir(dir))) {
  60                 if (strncmp(e->d_name, buf.buf + dirlen, prefixlen))
  61                         continue;
  62                 strbuf_setlen(&buf, dirlen);
  63                 strbuf_addstr(&buf, e->d_name);
  64                 unlink(buf.buf);
  65         }
  66         closedir(dir);
  67         strbuf_release(&buf);
  68 }
  69
  70 static void remove_pack_on_signal(int signo)
  71 {
  72         remove_temporary_files();
  73         sigchain_pop(signo);
  74         raise(signo);
  75 }
  76
  77 /*
  78  * Adds all packs hex strings to the fname list, which do not
  79  * have a corresponding .keep file.
  80  */
  81 static void get_non_kept_pack_filenames(struct string_list *fname_list)
  82 {
  83         DIR *dir;
  84         struct dirent *e;
  85         char *fname;
  86
  87         if (!(dir = opendir(packdir)))
  88                 return;
  89
  90         while ((e = readdir(dir)) != NULL) {
  91                 size_t len;
  92                 if (!strip_suffix(e->d_name, ".pack", &len))
  93                         continue;
  94
  95                 fname = xmemdupz(e->d_name, len);
  96
  97                 if (!file_exists(mkpath("%s/%s.keep", packdir, fname)))
  98                         string_list_append_nodup(fname_list, fname);
  99                 else
 100                         free(fname);
 101         }
 102         closedir(dir);
 103 }
 104
 105 static void remove_redundant_pack(const char *dir_name, const char *base_name)
 106 {
 107         const char *exts[] = {".pack", ".idx", ".keep", ".bitmap"};
 108         int i;
 109         struct strbuf buf = STRBUF_INIT;
 110         size_t plen;
 111
 112         strbuf_addf(&buf, "%s/%s", dir_name, base_name);
 113         plen = buf.len;
 114
 115         for (i = 0; i < ARRAY_SIZE(exts); i++) {
 116                 strbuf_setlen(&buf, plen);
 117                 strbuf_addstr(&buf, exts[i]);
 118                 unlink(buf.buf);
 119         }
 120         strbuf_release(&buf);
 121 }
 122
 123 #define ALL_INTO_ONE 1
 124 #define LOOSEN_UNREACHABLE 2
 125
 126 int cmd_repack(int argc, const char **argv, const char *prefix)
 127 {
 128         struct {
 129                 const char *name;
 130                 unsigned optional:1;
 131         } exts[] = {
 132                 {".pack"},
 133                 {".idx"},
 134                 {".bitmap", 1},
 135         };
 136         struct child_process cmd;
 137         struct string_list_item *item;
 138         struct argv_array cmd_args = ARGV_ARRAY_INIT;
 139         struct string_list names = STRING_LIST_INIT_DUP;
 140         struct string_list rollback = STRING_LIST_INIT_NODUP;
 141         struct string_list existing_packs = STRING_LIST_INIT_DUP;
 142         struct strbuf line = STRBUF_INIT;
 143         int ext, ret, failed;
 144         FILE *out;
 145
 146         /* variables to be filled by option parsing */
 147         int pack_everything = 0;
 148         int delete_redundant = 0;
 149         const char *unpack_unreachable = NULL;
 150         const char *window = NULL, *window_memory = NULL;
 151         const char *depth = NULL;
 152         const char *max_pack_size = NULL;
 153         int no_reuse_delta = 0, no_reuse_object = 0;
 154         int no_update_server_info = 0;
 155         int quiet = 0;
 156         int local = 0;
 157
 158         struct option builtin_repack_options[] = {
 159                 OPT_BIT('a', NULL, &pack_everything,
 160                                 N_("pack everything in a single pack"), ALL_INTO_ONE),
 161                 OPT_BIT('A', NULL, &pack_everything,
 162                                 N_("same as -a, and turn unreachable objects loose"),
 163                                    LOOSEN_UNREACHABLE | ALL_INTO_ONE),
 164                 OPT_BOOL('d', NULL, &delete_redundant,
 165                                 N_("remove redundant packs, and run git-prune-packed")),
 166                 OPT_BOOL('f', NULL, &no_reuse_delta,
 167                                 N_("pass --no-reuse-delta to git-pack-objects")),
 168                 OPT_BOOL('F', NULL, &no_reuse_object,
 169                                 N_("pass --no-reuse-object to git-pack-objects")),
 170                 OPT_BOOL('n', NULL, &no_update_server_info,
 171                                 N_("do not run git-update-server-info")),
 172                 OPT__QUIET(&quiet, N_("be quiet")),
 173                 OPT_BOOL('l', "local", &local,
 174                                 N_("pass --local to git-pack-objects")),
 175                 OPT_BOOL('b', "write-bitmap-index", &write_bitmaps,
 176                                 N_("write bitmap index")),
 177                 OPT_STRING(0, "unpack-unreachable", &unpack_unreachable, N_("approxidate"),
 178                                 N_("with -A, do not loosen objects older than this")),
 179                 OPT_STRING(0, "window", &window, N_("n"),
 180                                 N_("size of the window used for delta compression")),
 181                 OPT_STRING(0, "window-memory", &window_memory, N_("bytes"),
 182                                 N_("same as the above, but limit memory size instead of entries count")),
 183                 OPT_STRING(0, "depth", &depth, N_("n"),
 184                                 N_("limits the maximum delta depth")),
 185                 OPT_STRING(0, "max-pack-size", &max_pack_size, N_("bytes"),
 186                                 N_("maximum size of each packfile")),
 187                 OPT_BOOL(0, "pack-kept-objects", &pack_kept_objects,
 188                                 N_("repack objects in packs marked with .keep")),
 189                 OPT_END()
 190         };
 191
 192         git_config(repack_config, NULL);
 193
 194         argc = parse_options(argc, argv, prefix, builtin_repack_options,
 195                                 git_repack_usage, 0);
 196
 197         if (pack_kept_objects < 0)
 198                 pack_kept_objects = write_bitmaps;
 199
 200         packdir = mkpathdup("%s/pack", get_object_directory());
 201         packtmp = mkpathdup("%s/.tmp-%d-pack", packdir, (int)getpid());
 202
 203         sigchain_push_common(remove_pack_on_signal);
 204
 205         argv_array_push(&cmd_args, "pack-objects");
 206         argv_array_push(&cmd_args, "--keep-true-parents");
 207         if (!pack_kept_objects)
 208                 argv_array_push(&cmd_args, "--honor-pack-keep");
 209         argv_array_push(&cmd_args, "--non-empty");
 210         argv_array_push(&cmd_args, "--all");
 211         argv_array_push(&cmd_args, "--reflog");
 212         if (window)
 213                 argv_array_pushf(&cmd_args, "--window=%s", window);
 214         if (window_memory)
 215                 argv_array_pushf(&cmd_args, "--window-memory=%s", window_memory);
 216         if (depth)
 217                 argv_array_pushf(&cmd_args, "--depth=%s", depth);
 218         if (max_pack_size)
 219                 argv_array_pushf(&cmd_args, "--max-pack-size=%s", max_pack_size);
 220         if (no_reuse_delta)
 221                 argv_array_pushf(&cmd_args, "--no-reuse-delta");
 222         if (no_reuse_object)
 223                 argv_array_pushf(&cmd_args, "--no-reuse-object");
 224         if (write_bitmaps)
 225                 argv_array_push(&cmd_args, "--write-bitmap-index");
 226
 227         if (pack_everything & ALL_INTO_ONE) {
 228                 get_non_kept_pack_filenames(&existing_packs);
 229
 230                 if (existing_packs.nr && delete_redundant) {
 231                         if (unpack_unreachable)
 232                                 argv_array_pushf(&cmd_args,
 233                                                 "--unpack-unreachable=%s",
 234                                                 unpack_unreachable);
 235                         else if (pack_everything & LOOSEN_UNREACHABLE)
 236                                 argv_array_push(&cmd_args,
 237                                                 "--unpack-unreachable");
 238                 }
 239         } else {
 240                 argv_array_push(&cmd_args, "--unpacked");
 241                 argv_array_push(&cmd_args, "--incremental");
 242         }
 243
 244         if (local)
 245                 argv_array_push(&cmd_args,  "--local");
 246         if (quiet)
 247                 argv_array_push(&cmd_args,  "--quiet");
 248         if (delta_base_offset)
 249                 argv_array_push(&cmd_args,  "--delta-base-offset");
 250
 251         argv_array_push(&cmd_args, packtmp);
 252
 253         memset(&cmd, 0, sizeof(cmd));
 254         cmd.argv = cmd_args.argv;
 255         cmd.git_cmd = 1;
 256         cmd.out = -1;
 257         cmd.no_stdin = 1;
 258
 259         ret = start_command(&cmd);
 260         if (ret)
 261                 return ret;
 262
 263         out = xfdopen(cmd.out, "r");
 264         while (strbuf_getline(&line, out, '\n') != EOF) {
 265                 if (line.len != 40)
 266                         die("repack: Expecting 40 character sha1 lines only from pack-objects.");
 267                 string_list_append(&names, line.buf);
 268         }
 269         fclose(out);
 270         ret = finish_command(&cmd);
 271         if (ret)
 272                 return ret;
 273         argv_array_clear(&cmd_args);
 274
 275         if (!names.nr && !quiet)
 276                 printf("Nothing new to pack.\n");
 277
 278         /*
 279          * Ok we have prepared all new packfiles.
 280          * First see if there are packs of the same name and if so
 281          * if we can move them out of the way (this can happen if we
 282          * repacked immediately after packing fully.
 283          */
 284         failed = 0;
 285         for_each_string_list_item(item, &names) {
 286                 for (ext = 0; ext < ARRAY_SIZE(exts); ext++) {
 287                         char *fname, *fname_old;
 288                         fname = mkpathdup("%s/pack-%s%s", packdir,
 289                                                 item->string, exts[ext].name);
 290                         if (!file_exists(fname)) {
 291                                 free(fname);
 292                                 continue;
 293                         }
 294
 295                         fname_old = mkpath("%s/old-%s%s", packdir,
 296                                                 item->string, exts[ext].name);
 297                         if (file_exists(fname_old))
 298                                 if (unlink(fname_old))
 299                                         failed = 1;
 300
 301                         if (!failed && rename(fname, fname_old)) {
 302                                 free(fname);
 303                                 failed = 1;
 304                                 break;
 305                         } else {
 306                                 string_list_append(&rollback, fname);
 307                         }
 308                 }
 309                 if (failed)
 310                         break;
 311         }
 312         if (failed) {
 313                 struct string_list rollback_failure = STRING_LIST_INIT_DUP;
 314                 for_each_string_list_item(item, &rollback) {
 315                         char *fname, *fname_old;
 316                         fname = mkpathdup("%s/%s", packdir, item->string);
 317                         fname_old = mkpath("%s/old-%s", packdir, item->string);
 318                         if (rename(fname_old, fname))
 319                                 string_list_append(&rollback_failure, fname);
 320                         free(fname);
 321                 }
 322
 323                 if (rollback_failure.nr) {
 324                         int i;
 325                         fprintf(stderr,
 326                                 "WARNING: Some packs in use have been renamed by\n"
 327                                 "WARNING: prefixing old- to their name, in order to\n"
 328                                 "WARNING: replace them with the new version of the\n"
 329                                 "WARNING: file.  But the operation failed, and the\n"
 330                                 "WARNING: attempt to rename them back to their\n"
 331                                 "WARNING: original names also failed.\n"
 332                                 "WARNING: Please rename them in %s manually:\n", packdir);
 333                         for (i = 0; i < rollback_failure.nr; i++)
 334                                 fprintf(stderr, "WARNING:   old-%s -> %s\n",
 335                                         rollback_failure.items[i].string,
 336                                         rollback_failure.items[i].string);
 337                 }
 338                 exit(1);
 339         }
 340
 341         /* Now the ones with the same name are out of the way... */
 342         for_each_string_list_item(item, &names) {
 343                 for (ext = 0; ext < ARRAY_SIZE(exts); ext++) {
 344                         char *fname, *fname_old;
 345                         struct stat statbuffer;
 346                         int exists = 0;
 347                         fname = mkpathdup("%s/pack-%s%s",
 348                                         packdir, item->string, exts[ext].name);
 349                         fname_old = mkpathdup("%s-%s%s",
 350                                         packtmp, item->string, exts[ext].name);
 351                         if (!stat(fname_old, &statbuffer)) {
 352                                 statbuffer.st_mode &= ~(S_IWUSR | S_IWGRP | S_IWOTH);
 353                                 chmod(fname_old, statbuffer.st_mode);
 354                                 exists = 1;
 355                         }
 356                         if (exists || !exts[ext].optional) {
 357                                 if (rename(fname_old, fname))
 358                                         die_errno(_("renaming '%s' failed"), fname_old);
 359                         }
 360                         free(fname);
 361                         free(fname_old);
 362                 }
 363         }
 364
 365         /* Remove the "old-" files */
 366         for_each_string_list_item(item, &names) {
 367                 for (ext = 0; ext < ARRAY_SIZE(exts); ext++) {
 368                         char *fname;
 369                         fname = mkpath("%s/old-%s%s",
 370                                         packdir,
 371                                         item->string,
 372                                         exts[ext].name);
 373                         if (remove_path(fname))
 374                                 warning(_("removing '%s' failed"), fname);
 375                 }
 376         }
 377
 378         /* End of pack replacement. */
 379
 380         if (delete_redundant) {
 381                 sort_string_list(&names);
 382                 for_each_string_list_item(item, &existing_packs) {
 383                         char *sha1;
 384                         size_t len = strlen(item->string);
 385                         if (len < 40)
 386                                 continue;
 387                         sha1 = item->string + len - 40;
 388                         if (!string_list_has_string(&names, sha1))
 389                                 remove_redundant_pack(packdir, item->string);
 390                 }
 391                 argv_array_push(&cmd_args, "prune-packed");
 392                 if (quiet)
 393                         argv_array_push(&cmd_args, "--quiet");
 394
 395                 memset(&cmd, 0, sizeof(cmd));
 396                 cmd.argv = cmd_args.argv;
 397                 cmd.git_cmd = 1;
 398                 run_command(&cmd);
 399                 argv_array_clear(&cmd_args);
 400         }
 401
 402         if (!no_update_server_info) {
 403                 argv_array_push(&cmd_args, "update-server-info");
 404                 memset(&cmd, 0, sizeof(cmd));
 405                 cmd.argv = cmd_args.argv;
 406                 cmd.git_cmd = 1;
 407                 run_command(&cmd);
 408                 argv_array_clear(&cmd_args);
 409         }
 410         remove_temporary_files();
 411         string_list_clear(&names, 0);
 412         string_list_clear(&rollback, 0);
 413         string_list_clear(&existing_packs, 0);
 414         strbuf_release(&line);
 415
 416         return 0;
 417 }