builtin/unpack-objects.c

   1 #include "builtin.h"
   2 #include "cache.h"
   3 #include "config.h"
   4 #include "object-store.h"
   5 #include "object.h"
   6 #include "delta.h"
   7 #include "pack.h"
   8 #include "blob.h"
   9 #include "commit.h"
  10 #include "tag.h"
  11 #include "tree.h"
  12 #include "tree-walk.h"
  13 #include "progress.h"
  14 #include "decorate.h"
  15 #include "fsck.h"
  16
  17 static int dry_run, quiet, recover, has_errors, strict;
  18 static const char unpack_usage[] = "git unpack-objects [-n] [-q] [-r] [--strict]";
  19
  20 /* We always read in 4kB chunks. */
  21 static unsigned char buffer[4096];
  22 static unsigned int offset, len;
  23 static off_t consumed_bytes;
  24 static off_t max_input_size;
  25 static git_hash_ctx ctx;
  26 static struct fsck_options fsck_options = FSCK_OPTIONS_STRICT;
  27 static struct progress *progress;
  28
  29 /*
  30  * When running under --strict mode, objects whose reachability are
  31  * suspect are kept in core without getting written in the object
  32  * store.
  33  */
  34 struct obj_buffer {
  35         char *buffer;
  36         unsigned long size;
  37 };
  38
  39 static struct decoration obj_decorate;
  40
  41 static struct obj_buffer *lookup_object_buffer(struct object *base)
  42 {
  43         return lookup_decoration(&obj_decorate, base);
  44 }
  45
  46 static void add_object_buffer(struct object *object, char *buffer, unsigned long size)
  47 {
  48         struct obj_buffer *obj;
  49         obj = xcalloc(1, sizeof(struct obj_buffer));
  50         obj->buffer = buffer;
  51         obj->size = size;
  52         if (add_decoration(&obj_decorate, object, obj))
  53                 die("object %s tried to add buffer twice!", oid_to_hex(&object->oid));
  54 }
  55
  56 /*
  57  * Make sure at least "min" bytes are available in the buffer, and
  58  * return the pointer to the buffer.
  59  */
  60 static void *fill(int min)
  61 {
  62         if (min <= len)
  63                 return buffer + offset;
  64         if (min > sizeof(buffer))
  65                 die("cannot fill %d bytes", min);
  66         if (offset) {
  67                 the_hash_algo->update_fn(&ctx, buffer, offset);
  68                 memmove(buffer, buffer + offset, len);
  69                 offset = 0;
  70         }
  71         do {
  72                 ssize_t ret = xread(0, buffer + len, sizeof(buffer) - len);
  73                 if (ret <= 0) {
  74                         if (!ret)
  75                                 die("early EOF");
  76                         die_errno("read error on input");
  77                 }
  78                 len += ret;
  79         } while (len < min);
  80         return buffer;
  81 }
  82
  83 static void use(int bytes)
  84 {
  85         if (bytes > len)
  86                 die("used more bytes than were available");
  87         len -= bytes;
  88         offset += bytes;
  89
  90         /* make sure off_t is sufficiently large not to wrap */
  91         if (signed_add_overflows(consumed_bytes, bytes))
  92                 die("pack too large for current definition of off_t");
  93         consumed_bytes += bytes;
  94         if (max_input_size && consumed_bytes > max_input_size)
  95                 die(_("pack exceeds maximum allowed size"));
  96         display_throughput(progress, consumed_bytes);
  97 }
  98
  99 static void *get_data(unsigned long size)
 100 {
 101         git_zstream stream;
 102         void *buf = xmallocz(size);
 103
 104         memset(&stream, 0, sizeof(stream));
 105
 106         stream.next_out = buf;
 107         stream.avail_out = size;
 108         stream.next_in = fill(1);
 109         stream.avail_in = len;
 110         git_inflate_init(&stream);
 111
 112         for (;;) {
 113                 int ret = git_inflate(&stream, 0);
 114                 use(len - stream.avail_in);
 115                 if (stream.total_out == size && ret == Z_STREAM_END)
 116                         break;
 117                 if (ret != Z_OK) {
 118                         error("inflate returned %d", ret);
 119                         FREE_AND_NULL(buf);
 120                         if (!recover)
 121                                 exit(1);
 122                         has_errors = 1;
 123                         break;
 124                 }
 125                 stream.next_in = fill(1);
 126                 stream.avail_in = len;
 127         }
 128         git_inflate_end(&stream);
 129         return buf;
 130 }
 131
 132 struct delta_info {
 133         struct object_id base_oid;
 134         unsigned nr;
 135         off_t base_offset;
 136         unsigned long size;
 137         void *delta;
 138         struct delta_info *next;
 139 };
 140
 141 static struct delta_info *delta_list;
 142
 143 static void add_delta_to_list(unsigned nr, const struct object_id *base_oid,
 144                               off_t base_offset,
 145                               void *delta, unsigned long size)
 146 {
 147         struct delta_info *info = xmalloc(sizeof(*info));
 148
 149         oidcpy(&info->base_oid, base_oid);
 150         info->base_offset = base_offset;
 151         info->size = size;
 152         info->delta = delta;
 153         info->nr = nr;
 154         info->next = delta_list;
 155         delta_list = info;
 156 }
 157
 158 struct obj_info {
 159         off_t offset;
 160         struct object_id oid;
 161         struct object *obj;
 162 };
 163
 164 /* Remember to update object flag allocation in object.h */
 165 #define FLAG_OPEN (1u<<20)
 166 #define FLAG_WRITTEN (1u<<21)
 167
 168 static struct obj_info *obj_list;
 169 static unsigned nr_objects;
 170
 171 /*
 172  * Called only from check_object() after it verified this object
 173  * is Ok.
 174  */
 175 static void write_cached_object(struct object *obj, struct obj_buffer *obj_buf)
 176 {
 177         struct object_id oid;
 178
 179         if (write_object_file(obj_buf->buffer, obj_buf->size,
 180                               type_name(obj->type), &oid) < 0)
 181                 die("failed to write object %s", oid_to_hex(&obj->oid));
 182         obj->flags |= FLAG_WRITTEN;
 183 }
 184
 185 /*
 186  * At the very end of the processing, write_rest() scans the objects
 187  * that have reachability requirements and calls this function.
 188  * Verify its reachability and validity recursively and write it out.
 189  */
 190 static int check_object(struct object *obj, int type, void *data, struct fsck_options *options)
 191 {
 192         struct obj_buffer *obj_buf;
 193
 194         if (!obj)
 195                 return 1;
 196
 197         if (obj->flags & FLAG_WRITTEN)
 198                 return 0;
 199
 200         if (type != OBJ_ANY && obj->type != type)
 201                 die("object type mismatch");
 202
 203         if (!(obj->flags & FLAG_OPEN)) {
 204                 unsigned long size;
 205                 int type = oid_object_info(the_repository, &obj->oid, &size);
 206                 if (type != obj->type || type <= 0)
 207                         die("object of unexpected type");
 208                 obj->flags |= FLAG_WRITTEN;
 209                 return 0;
 210         }
 211
 212         obj_buf = lookup_object_buffer(obj);
 213         if (!obj_buf)
 214                 die("Whoops! Cannot find object '%s'", oid_to_hex(&obj->oid));
 215         if (fsck_object(obj, obj_buf->buffer, obj_buf->size, &fsck_options))
 216                 die("fsck error in packed object");
 217         fsck_options.walk = check_object;
 218         if (fsck_walk(obj, NULL, &fsck_options))
 219                 die("Error on reachable objects of %s", oid_to_hex(&obj->oid));
 220         write_cached_object(obj, obj_buf);
 221         return 0;
 222 }
 223
 224 static void write_rest(void)
 225 {
 226         unsigned i;
 227         for (i = 0; i < nr_objects; i++) {
 228                 if (obj_list[i].obj)
 229                         check_object(obj_list[i].obj, OBJ_ANY, NULL, NULL);
 230         }
 231 }
 232
 233 static void added_object(unsigned nr, enum object_type type,
 234                          void *data, unsigned long size);
 235
 236 /*
 237  * Write out nr-th object from the list, now we know the contents
 238  * of it.  Under --strict, this buffers structured objects in-core,
 239  * to be checked at the end.
 240  */
 241 static void write_object(unsigned nr, enum object_type type,
 242                          void *buf, unsigned long size)
 243 {
 244         if (!strict) {
 245                 if (write_object_file(buf, size, type_name(type),
 246                                       &obj_list[nr].oid) < 0)
 247                         die("failed to write object");
 248                 added_object(nr, type, buf, size);
 249                 free(buf);
 250                 obj_list[nr].obj = NULL;
 251         } else if (type == OBJ_BLOB) {
 252                 struct blob *blob;
 253                 if (write_object_file(buf, size, type_name(type),
 254                                       &obj_list[nr].oid) < 0)
 255                         die("failed to write object");
 256                 added_object(nr, type, buf, size);
 257                 free(buf);
 258
 259                 blob = lookup_blob(the_repository, &obj_list[nr].oid);
 260                 if (blob)
 261                         blob->object.flags |= FLAG_WRITTEN;
 262                 else
 263                         die("invalid blob object");
 264                 obj_list[nr].obj = NULL;
 265         } else {
 266                 struct object *obj;
 267                 int eaten;
 268                 hash_object_file(buf, size, type_name(type), &obj_list[nr].oid);
 269                 added_object(nr, type, buf, size);
 270                 obj = parse_object_buffer(the_repository, &obj_list[nr].oid,
 271                                           type, size, buf,
 272                                           &eaten);
 273                 if (!obj)
 274                         die("invalid %s", type_name(type));
 275                 add_object_buffer(obj, buf, size);
 276                 obj->flags |= FLAG_OPEN;
 277                 obj_list[nr].obj = obj;
 278         }
 279 }
 280
 281 static void resolve_delta(unsigned nr, enum object_type type,
 282                           void *base, unsigned long base_size,
 283                           void *delta, unsigned long delta_size)
 284 {
 285         void *result;
 286         unsigned long result_size;
 287
 288         result = patch_delta(base, base_size,
 289                              delta, delta_size,
 290                              &result_size);
 291         if (!result)
 292                 die("failed to apply delta");
 293         free(delta);
 294         write_object(nr, type, result, result_size);
 295 }
 296
 297 /*
 298  * We now know the contents of an object (which is nr-th in the pack);
 299  * resolve all the deltified objects that are based on it.
 300  */
 301 static void added_object(unsigned nr, enum object_type type,
 302                          void *data, unsigned long size)
 303 {
 304         struct delta_info **p = &delta_list;
 305         struct delta_info *info;
 306
 307         while ((info = *p) != NULL) {
 308                 if (oideq(&info->base_oid, &obj_list[nr].oid) ||
 309                     info->base_offset == obj_list[nr].offset) {
 310                         *p = info->next;
 311                         p = &delta_list;
 312                         resolve_delta(info->nr, type, data, size,
 313                                       info->delta, info->size);
 314                         free(info);
 315                         continue;
 316                 }
 317                 p = &info->next;
 318         }
 319 }
 320
 321 static void unpack_non_delta_entry(enum object_type type, unsigned long size,
 322                                    unsigned nr)
 323 {
 324         void *buf = get_data(size);
 325
 326         if (!dry_run && buf)
 327                 write_object(nr, type, buf, size);
 328         else
 329                 free(buf);
 330 }
 331
 332 static int resolve_against_held(unsigned nr, const struct object_id *base,
 333                                 void *delta_data, unsigned long delta_size)
 334 {
 335         struct object *obj;
 336         struct obj_buffer *obj_buffer;
 337         obj = lookup_object(the_repository, base);
 338         if (!obj)
 339                 return 0;
 340         obj_buffer = lookup_object_buffer(obj);
 341         if (!obj_buffer)
 342                 return 0;
 343         resolve_delta(nr, obj->type, obj_buffer->buffer,
 344                       obj_buffer->size, delta_data, delta_size);
 345         return 1;
 346 }
 347
 348 static void unpack_delta_entry(enum object_type type, unsigned long delta_size,
 349                                unsigned nr)
 350 {
 351         void *delta_data, *base;
 352         unsigned long base_size;
 353         struct object_id base_oid;
 354
 355         if (type == OBJ_REF_DELTA) {
 356                 hashcpy(base_oid.hash, fill(the_hash_algo->rawsz));
 357                 use(the_hash_algo->rawsz);
 358                 delta_data = get_data(delta_size);
 359                 if (dry_run || !delta_data) {
 360                         free(delta_data);
 361                         return;
 362                 }
 363                 if (has_object_file(&base_oid))
 364                         ; /* Ok we have this one */
 365                 else if (resolve_against_held(nr, &base_oid,
 366                                               delta_data, delta_size))
 367                         return; /* we are done */
 368                 else {
 369                         /* cannot resolve yet --- queue it */
 370                         oidclr(&obj_list[nr].oid);
 371                         add_delta_to_list(nr, &base_oid, 0, delta_data, delta_size);
 372                         return;
 373                 }
 374         } else {
 375                 unsigned base_found = 0;
 376                 unsigned char *pack, c;
 377                 off_t base_offset;
 378                 unsigned lo, mid, hi;
 379
 380                 pack = fill(1);
 381                 c = *pack;
 382                 use(1);
 383                 base_offset = c & 127;
 384                 while (c & 128) {
 385                         base_offset += 1;
 386                         if (!base_offset || MSB(base_offset, 7))
 387                                 die("offset value overflow for delta base object");
 388                         pack = fill(1);
 389                         c = *pack;
 390                         use(1);
 391                         base_offset = (base_offset << 7) + (c & 127);
 392                 }
 393                 base_offset = obj_list[nr].offset - base_offset;
 394                 if (base_offset <= 0 || base_offset >= obj_list[nr].offset)
 395                         die("offset value out of bound for delta base object");
 396
 397                 delta_data = get_data(delta_size);
 398                 if (dry_run || !delta_data) {
 399                         free(delta_data);
 400                         return;
 401                 }
 402                 lo = 0;
 403                 hi = nr;
 404                 while (lo < hi) {
 405                         mid = lo + (hi - lo) / 2;
 406                         if (base_offset < obj_list[mid].offset) {
 407                                 hi = mid;
 408                         } else if (base_offset > obj_list[mid].offset) {
 409                                 lo = mid + 1;
 410                         } else {
 411                                 oidcpy(&base_oid, &obj_list[mid].oid);
 412                                 base_found = !is_null_oid(&base_oid);
 413                                 break;
 414                         }
 415                 }
 416                 if (!base_found) {
 417                         /*
 418                          * The delta base object is itself a delta that
 419                          * has not been resolved yet.
 420                          */
 421                         oidclr(&obj_list[nr].oid);
 422                         add_delta_to_list(nr, &null_oid, base_offset, delta_data, delta_size);
 423                         return;
 424                 }
 425         }
 426
 427         if (resolve_against_held(nr, &base_oid, delta_data, delta_size))
 428                 return;
 429
 430         base = read_object_file(&base_oid, &type, &base_size);
 431         if (!base) {
 432                 error("failed to read delta-pack base object %s",
 433                       oid_to_hex(&base_oid));
 434                 if (!recover)
 435                         exit(1);
 436                 has_errors = 1;
 437                 return;
 438         }
 439         resolve_delta(nr, type, base, base_size, delta_data, delta_size);
 440         free(base);
 441 }
 442
 443 static void unpack_one(unsigned nr)
 444 {
 445         unsigned shift;
 446         unsigned char *pack;
 447         unsigned long size, c;
 448         enum object_type type;
 449
 450         obj_list[nr].offset = consumed_bytes;
 451
 452         pack = fill(1);
 453         c = *pack;
 454         use(1);
 455         type = (c >> 4) & 7;
 456         size = (c & 15);
 457         shift = 4;
 458         while (c & 0x80) {
 459                 pack = fill(1);
 460                 c = *pack;
 461                 use(1);
 462                 size += (c & 0x7f) << shift;
 463                 shift += 7;
 464         }
 465
 466         switch (type) {
 467         case OBJ_COMMIT:
 468         case OBJ_TREE:
 469         case OBJ_BLOB:
 470         case OBJ_TAG:
 471                 unpack_non_delta_entry(type, size, nr);
 472                 return;
 473         case OBJ_REF_DELTA:
 474         case OBJ_OFS_DELTA:
 475                 unpack_delta_entry(type, size, nr);
 476                 return;
 477         default:
 478                 error("bad object type %d", type);
 479                 has_errors = 1;
 480                 if (recover)
 481                         return;
 482                 exit(1);
 483         }
 484 }
 485
 486 static void unpack_all(void)
 487 {
 488         int i;
 489         struct pack_header *hdr = fill(sizeof(struct pack_header));
 490
 491         nr_objects = ntohl(hdr->hdr_entries);
 492
 493         if (ntohl(hdr->hdr_signature) != PACK_SIGNATURE)
 494                 die("bad pack file");
 495         if (!pack_version_ok(hdr->hdr_version))
 496                 die("unknown pack file version %"PRIu32,
 497                         ntohl(hdr->hdr_version));
 498         use(sizeof(struct pack_header));
 499
 500         if (!quiet)
 501                 progress = start_progress(_("Unpacking objects"), nr_objects);
 502         obj_list = xcalloc(nr_objects, sizeof(*obj_list));
 503         for (i = 0; i < nr_objects; i++) {
 504                 unpack_one(i);
 505                 display_progress(progress, i + 1);
 506         }
 507         stop_progress(&progress);
 508
 509         if (delta_list)
 510                 die("unresolved deltas left after unpacking");
 511 }
 512
 513 int cmd_unpack_objects(int argc, const char **argv, const char *prefix)
 514 {
 515         int i;
 516         struct object_id oid;
 517
 518         read_replace_refs = 0;
 519
 520         git_config(git_default_config, NULL);
 521
 522         quiet = !isatty(2);
 523
 524         for (i = 1 ; i < argc; i++) {
 525                 const char *arg = argv[i];
 526
 527                 if (*arg == '-') {
 528                         if (!strcmp(arg, "-n")) {
 529                                 dry_run = 1;
 530                                 continue;
 531                         }
 532                         if (!strcmp(arg, "-q")) {
 533                                 quiet = 1;
 534                                 continue;
 535                         }
 536                         if (!strcmp(arg, "-r")) {
 537                                 recover = 1;
 538                                 continue;
 539                         }
 540                         if (!strcmp(arg, "--strict")) {
 541                                 strict = 1;
 542                                 continue;
 543                         }
 544                         if (skip_prefix(arg, "--strict=", &arg)) {
 545                                 strict = 1;
 546                                 fsck_set_msg_types(&fsck_options, arg);
 547                                 continue;
 548                         }
 549                         if (starts_with(arg, "--pack_header=")) {
 550                                 struct pack_header *hdr;
 551                                 char *c;
 552
 553                                 hdr = (struct pack_header *)buffer;
 554                                 hdr->hdr_signature = htonl(PACK_SIGNATURE);
 555                                 hdr->hdr_version = htonl(strtoul(arg + 14, &c, 10));
 556                                 if (*c != ',')
 557                                         die("bad %s", arg);
 558                                 hdr->hdr_entries = htonl(strtoul(c + 1, &c, 10));
 559                                 if (*c)
 560                                         die("bad %s", arg);
 561                                 len = sizeof(*hdr);
 562                                 continue;
 563                         }
 564                         if (skip_prefix(arg, "--max-input-size=", &arg)) {
 565                                 max_input_size = strtoumax(arg, NULL, 10);
 566                                 continue;
 567                         }
 568                         usage(unpack_usage);
 569                 }
 570
 571                 /* We don't take any non-flag arguments now.. Maybe some day */
 572                 usage(unpack_usage);
 573         }
 574         the_hash_algo->init_fn(&ctx);
 575         unpack_all();
 576         the_hash_algo->update_fn(&ctx, buffer, offset);
 577         the_hash_algo->final_fn(oid.hash, &ctx);
 578         if (strict) {
 579                 write_rest();
 580                 if (fsck_finish(&fsck_options))
 581                         die(_("fsck error in pack objects"));
 582         }
 583         if (!hasheq(fill(the_hash_algo->rawsz), oid.hash))
 584                 die("final sha1 did not match");
 585         use(the_hash_algo->rawsz);
 586
 587         /* Write the last part of the buffer to stdout */
 588         while (len) {
 589                 int ret = xwrite(1, buffer + offset, len);
 590                 if (ret <= 0)
 591                         break;
 592                 len -= ret;
 593                 offset += ret;
 594         }
 595
 596         /* All done */
 597         return has_errors;
 598 }