builtin / repack.con commit standardize usage info string format (9c9b4f2)
   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
  11static int delta_base_offset = 1;
  12static int pack_kept_objects = -1;
  13static int write_bitmaps;
  14static char *packdir, *packtmp;
  15
  16static const char *const git_repack_usage[] = {
  17        N_("git repack [<options>]"),
  18        NULL
  19};
  20
  21static 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 */
  42static 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
  70static 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 */
  81static 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
 105static 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
 126int 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 = CHILD_PROCESS_INIT;
 137        struct string_list_item *item;
 138        struct string_list names = STRING_LIST_INIT_DUP;
 139        struct string_list rollback = STRING_LIST_INIT_NODUP;
 140        struct string_list existing_packs = STRING_LIST_INIT_DUP;
 141        struct strbuf line = STRBUF_INIT;
 142        int ext, ret, failed;
 143        FILE *out;
 144
 145        /* variables to be filled by option parsing */
 146        int pack_everything = 0;
 147        int delete_redundant = 0;
 148        const char *unpack_unreachable = NULL;
 149        const char *window = NULL, *window_memory = NULL;
 150        const char *depth = NULL;
 151        const char *max_pack_size = NULL;
 152        int no_reuse_delta = 0, no_reuse_object = 0;
 153        int no_update_server_info = 0;
 154        int quiet = 0;
 155        int local = 0;
 156
 157        struct option builtin_repack_options[] = {
 158                OPT_BIT('a', NULL, &pack_everything,
 159                                N_("pack everything in a single pack"), ALL_INTO_ONE),
 160                OPT_BIT('A', NULL, &pack_everything,
 161                                N_("same as -a, and turn unreachable objects loose"),
 162                                   LOOSEN_UNREACHABLE | ALL_INTO_ONE),
 163                OPT_BOOL('d', NULL, &delete_redundant,
 164                                N_("remove redundant packs, and run git-prune-packed")),
 165                OPT_BOOL('f', NULL, &no_reuse_delta,
 166                                N_("pass --no-reuse-delta to git-pack-objects")),
 167                OPT_BOOL('F', NULL, &no_reuse_object,
 168                                N_("pass --no-reuse-object to git-pack-objects")),
 169                OPT_BOOL('n', NULL, &no_update_server_info,
 170                                N_("do not run git-update-server-info")),
 171                OPT__QUIET(&quiet, N_("be quiet")),
 172                OPT_BOOL('l', "local", &local,
 173                                N_("pass --local to git-pack-objects")),
 174                OPT_BOOL('b', "write-bitmap-index", &write_bitmaps,
 175                                N_("write bitmap index")),
 176                OPT_STRING(0, "unpack-unreachable", &unpack_unreachable, N_("approxidate"),
 177                                N_("with -A, do not loosen objects older than this")),
 178                OPT_STRING(0, "window", &window, N_("n"),
 179                                N_("size of the window used for delta compression")),
 180                OPT_STRING(0, "window-memory", &window_memory, N_("bytes"),
 181                                N_("same as the above, but limit memory size instead of entries count")),
 182                OPT_STRING(0, "depth", &depth, N_("n"),
 183                                N_("limits the maximum delta depth")),
 184                OPT_STRING(0, "max-pack-size", &max_pack_size, N_("bytes"),
 185                                N_("maximum size of each packfile")),
 186                OPT_BOOL(0, "pack-kept-objects", &pack_kept_objects,
 187                                N_("repack objects in packs marked with .keep")),
 188                OPT_END()
 189        };
 190
 191        git_config(repack_config, NULL);
 192
 193        argc = parse_options(argc, argv, prefix, builtin_repack_options,
 194                                git_repack_usage, 0);
 195
 196        if (pack_kept_objects < 0)
 197                pack_kept_objects = write_bitmaps;
 198
 199        packdir = mkpathdup("%s/pack", get_object_directory());
 200        packtmp = mkpathdup("%s/.tmp-%d-pack", packdir, (int)getpid());
 201
 202        sigchain_push_common(remove_pack_on_signal);
 203
 204        argv_array_push(&cmd.args, "pack-objects");
 205        argv_array_push(&cmd.args, "--keep-true-parents");
 206        if (!pack_kept_objects)
 207                argv_array_push(&cmd.args, "--honor-pack-keep");
 208        argv_array_push(&cmd.args, "--non-empty");
 209        argv_array_push(&cmd.args, "--all");
 210        argv_array_push(&cmd.args, "--reflog");
 211        argv_array_push(&cmd.args, "--indexed-objects");
 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        cmd.git_cmd = 1;
 254        cmd.out = -1;
 255        cmd.no_stdin = 1;
 256
 257        ret = start_command(&cmd);
 258        if (ret)
 259                return ret;
 260
 261        out = xfdopen(cmd.out, "r");
 262        while (strbuf_getline(&line, out, '\n') != EOF) {
 263                if (line.len != 40)
 264                        die("repack: Expecting 40 character sha1 lines only from pack-objects.");
 265                string_list_append(&names, line.buf);
 266        }
 267        fclose(out);
 268        ret = finish_command(&cmd);
 269        if (ret)
 270                return ret;
 271
 272        if (!names.nr && !quiet)
 273                printf("Nothing new to pack.\n");
 274
 275        /*
 276         * Ok we have prepared all new packfiles.
 277         * First see if there are packs of the same name and if so
 278         * if we can move them out of the way (this can happen if we
 279         * repacked immediately after packing fully.
 280         */
 281        failed = 0;
 282        for_each_string_list_item(item, &names) {
 283                for (ext = 0; ext < ARRAY_SIZE(exts); ext++) {
 284                        char *fname, *fname_old;
 285                        fname = mkpathdup("%s/pack-%s%s", packdir,
 286                                                item->string, exts[ext].name);
 287                        if (!file_exists(fname)) {
 288                                free(fname);
 289                                continue;
 290                        }
 291
 292                        fname_old = mkpath("%s/old-%s%s", packdir,
 293                                                item->string, exts[ext].name);
 294                        if (file_exists(fname_old))
 295                                if (unlink(fname_old))
 296                                        failed = 1;
 297
 298                        if (!failed && rename(fname, fname_old)) {
 299                                free(fname);
 300                                failed = 1;
 301                                break;
 302                        } else {
 303                                string_list_append(&rollback, fname);
 304                        }
 305                }
 306                if (failed)
 307                        break;
 308        }
 309        if (failed) {
 310                struct string_list rollback_failure = STRING_LIST_INIT_DUP;
 311                for_each_string_list_item(item, &rollback) {
 312                        char *fname, *fname_old;
 313                        fname = mkpathdup("%s/%s", packdir, item->string);
 314                        fname_old = mkpath("%s/old-%s", packdir, item->string);
 315                        if (rename(fname_old, fname))
 316                                string_list_append(&rollback_failure, fname);
 317                        free(fname);
 318                }
 319
 320                if (rollback_failure.nr) {
 321                        int i;
 322                        fprintf(stderr,
 323                                "WARNING: Some packs in use have been renamed by\n"
 324                                "WARNING: prefixing old- to their name, in order to\n"
 325                                "WARNING: replace them with the new version of the\n"
 326                                "WARNING: file.  But the operation failed, and the\n"
 327                                "WARNING: attempt to rename them back to their\n"
 328                                "WARNING: original names also failed.\n"
 329                                "WARNING: Please rename them in %s manually:\n", packdir);
 330                        for (i = 0; i < rollback_failure.nr; i++)
 331                                fprintf(stderr, "WARNING:   old-%s -> %s\n",
 332                                        rollback_failure.items[i].string,
 333                                        rollback_failure.items[i].string);
 334                }
 335                exit(1);
 336        }
 337
 338        /* Now the ones with the same name are out of the way... */
 339        for_each_string_list_item(item, &names) {
 340                for (ext = 0; ext < ARRAY_SIZE(exts); ext++) {
 341                        char *fname, *fname_old;
 342                        struct stat statbuffer;
 343                        int exists = 0;
 344                        fname = mkpathdup("%s/pack-%s%s",
 345                                        packdir, item->string, exts[ext].name);
 346                        fname_old = mkpathdup("%s-%s%s",
 347                                        packtmp, item->string, exts[ext].name);
 348                        if (!stat(fname_old, &statbuffer)) {
 349                                statbuffer.st_mode &= ~(S_IWUSR | S_IWGRP | S_IWOTH);
 350                                chmod(fname_old, statbuffer.st_mode);
 351                                exists = 1;
 352                        }
 353                        if (exists || !exts[ext].optional) {
 354                                if (rename(fname_old, fname))
 355                                        die_errno(_("renaming '%s' failed"), fname_old);
 356                        }
 357                        free(fname);
 358                        free(fname_old);
 359                }
 360        }
 361
 362        /* Remove the "old-" files */
 363        for_each_string_list_item(item, &names) {
 364                for (ext = 0; ext < ARRAY_SIZE(exts); ext++) {
 365                        char *fname;
 366                        fname = mkpath("%s/old-%s%s",
 367                                        packdir,
 368                                        item->string,
 369                                        exts[ext].name);
 370                        if (remove_path(fname))
 371                                warning(_("removing '%s' failed"), fname);
 372                }
 373        }
 374
 375        /* End of pack replacement. */
 376
 377        if (delete_redundant) {
 378                int opts = 0;
 379                string_list_sort(&names);
 380                for_each_string_list_item(item, &existing_packs) {
 381                        char *sha1;
 382                        size_t len = strlen(item->string);
 383                        if (len < 40)
 384                                continue;
 385                        sha1 = item->string + len - 40;
 386                        if (!string_list_has_string(&names, sha1))
 387                                remove_redundant_pack(packdir, item->string);
 388                }
 389                if (!quiet && isatty(2))
 390                        opts |= PRUNE_PACKED_VERBOSE;
 391                prune_packed_objects(opts);
 392        }
 393
 394        if (!no_update_server_info)
 395                update_server_info(0);
 396        remove_temporary_files();
 397        string_list_clear(&names, 0);
 398        string_list_clear(&rollback, 0);
 399        string_list_clear(&existing_packs, 0);
 400        strbuf_release(&line);
 401
 402        return 0;
 403}