tree-walk.c

   1 #include "cache.h"
   2 #include "tree-walk.h"
   3 #include "unpack-trees.h"
   4 #include "dir.h"
   5 #include "tree.h"
   6
   7 static const char *get_mode(const char *str, unsigned int *modep)
   8 {
   9         unsigned char c;
  10         unsigned int mode = 0;
  11
  12         if (*str == ' ')
  13                 return NULL;
  14
  15         while ((c = *str++) != ' ') {
  16                 if (c < '0' || c > '7')
  17                         return NULL;
  18                 mode = (mode << 3) + (c - '0');
  19         }
  20         *modep = mode;
  21         return str;
  22 }
  23
  24 static void decode_tree_entry(struct tree_desc *desc, const char *buf, unsigned long size)
  25 {
  26         const char *path;
  27         unsigned int mode, len;
  28
  29         if (size < 24 || buf[size - 21])
  30                 die("corrupt tree file");
  31
  32         path = get_mode(buf, &mode);
  33         if (!path || !*path)
  34                 die("corrupt tree file");
  35         len = strlen(path) + 1;
  36
  37         /* Initialize the descriptor entry */
  38         desc->entry.path = path;
  39         desc->entry.mode = mode;
  40         desc->entry.sha1 = (const unsigned char *)(path + len);
  41 }
  42
  43 void init_tree_desc(struct tree_desc *desc, const void *buffer, unsigned long size)
  44 {
  45         desc->buffer = buffer;
  46         desc->size = size;
  47         if (size)
  48                 decode_tree_entry(desc, buffer, size);
  49 }
  50
  51 void *fill_tree_descriptor(struct tree_desc *desc, const unsigned char *sha1)
  52 {
  53         unsigned long size = 0;
  54         void *buf = NULL;
  55
  56         if (sha1) {
  57                 buf = read_object_with_reference(sha1, tree_type, &size, NULL);
  58                 if (!buf)
  59                         die("unable to read tree %s", sha1_to_hex(sha1));
  60         }
  61         init_tree_desc(desc, buf, size);
  62         return buf;
  63 }
  64
  65 static void entry_clear(struct name_entry *a)
  66 {
  67         memset(a, 0, sizeof(*a));
  68 }
  69
  70 static void entry_extract(struct tree_desc *t, struct name_entry *a)
  71 {
  72         *a = t->entry;
  73 }
  74
  75 void update_tree_entry(struct tree_desc *desc)
  76 {
  77         const void *buf = desc->buffer;
  78         const unsigned char *end = desc->entry.sha1 + 20;
  79         unsigned long size = desc->size;
  80         unsigned long len = end - (const unsigned char *)buf;
  81
  82         if (size < len)
  83                 die("corrupt tree file");
  84         buf = end;
  85         size -= len;
  86         desc->buffer = buf;
  87         desc->size = size;
  88         if (size)
  89                 decode_tree_entry(desc, buf, size);
  90 }
  91
  92 int tree_entry(struct tree_desc *desc, struct name_entry *entry)
  93 {
  94         if (!desc->size)
  95                 return 0;
  96
  97         *entry = desc->entry;
  98         update_tree_entry(desc);
  99         return 1;
 100 }
 101
 102 void setup_traverse_info(struct traverse_info *info, const char *base)
 103 {
 104         int pathlen = strlen(base);
 105         static struct traverse_info dummy;
 106
 107         memset(info, 0, sizeof(*info));
 108         if (pathlen && base[pathlen-1] == '/')
 109                 pathlen--;
 110         info->pathlen = pathlen ? pathlen + 1 : 0;
 111         info->name.path = base;
 112         info->name.sha1 = (void *)(base + pathlen + 1);
 113         if (pathlen)
 114                 info->prev = &dummy;
 115 }
 116
 117 char *make_traverse_path(char *path, const struct traverse_info *info, const struct name_entry *n)
 118 {
 119         int len = tree_entry_len(n->path, n->sha1);
 120         int pathlen = info->pathlen;
 121
 122         path[pathlen + len] = 0;
 123         for (;;) {
 124                 memcpy(path + pathlen, n->path, len);
 125                 if (!pathlen)
 126                         break;
 127                 path[--pathlen] = '/';
 128                 n = &info->name;
 129                 len = tree_entry_len(n->path, n->sha1);
 130                 info = info->prev;
 131                 pathlen -= len;
 132         }
 133         return path;
 134 }
 135
 136 struct tree_desc_skip {
 137         struct tree_desc_skip *prev;
 138         const void *ptr;
 139 };
 140
 141 struct tree_desc_x {
 142         struct tree_desc d;
 143         struct tree_desc_skip *skip;
 144 };
 145
 146 static int name_compare(const char *a, int a_len,
 147                         const char *b, int b_len)
 148 {
 149         int len = (a_len < b_len) ? a_len : b_len;
 150         int cmp = memcmp(a, b, len);
 151         if (cmp)
 152                 return cmp;
 153         return (a_len - b_len);
 154 }
 155
 156 static int check_entry_match(const char *a, int a_len, const char *b, int b_len)
 157 {
 158         /*
 159          * The caller wants to pick *a* from a tree or nothing.
 160          * We are looking at *b* in a tree.
 161          *
 162          * (0) If a and b are the same name, we are trivially happy.
 163          *
 164          * There are three possibilities where *a* could be hiding
 165          * behind *b*.
 166          *
 167          * (1) *a* == "t",   *b* == "ab"  i.e. *b* sorts earlier than *a* no
 168          *                                matter what.
 169          * (2) *a* == "t",   *b* == "t-2" and "t" is a subtree in the tree;
 170          * (3) *a* == "t-2", *b* == "t"   and "t-2" is a blob in the tree.
 171          *
 172          * Otherwise we know *a* won't appear in the tree without
 173          * scanning further.
 174          */
 175
 176         int cmp = name_compare(a, a_len, b, b_len);
 177
 178         /* Most common case first -- reading sync'd trees */
 179         if (!cmp)
 180                 return cmp;
 181
 182         if (0 < cmp) {
 183                 /* a comes after b; it does not matter if it is case (3)
 184                 if (b_len < a_len && !memcmp(a, b, b_len) && a[b_len] < '/')
 185                         return 1;
 186                 */
 187                 return 1; /* keep looking */
 188         }
 189
 190         /* b comes after a; are we looking at case (2)? */
 191         if (a_len < b_len && !memcmp(a, b, a_len) && b[a_len] < '/')
 192                 return 1; /* keep looking */
 193
 194         return -1; /* a cannot appear in the tree */
 195 }
 196
 197 /*
 198  * From the extended tree_desc, extract the first name entry, while
 199  * paying attention to the candidate "first" name.  Most importantly,
 200  * when looking for an entry, if there are entries that sorts earlier
 201  * in the tree object representation than that name, skip them and
 202  * process the named entry first.  We will remember that we haven't
 203  * processed the first entry yet, and in the later call skip the
 204  * entry we processed early when update_extended_entry() is called.
 205  *
 206  * E.g. if the underlying tree object has these entries:
 207  *
 208  *    blob    "t-1"
 209  *    blob    "t-2"
 210  *    tree    "t"
 211  *    blob    "t=1"
 212  *
 213  * and the "first" asks for "t", remember that we still need to
 214  * process "t-1" and "t-2" but extract "t".  After processing the
 215  * entry "t" from this call, the caller will let us know by calling
 216  * update_extended_entry() that we can remember "t" has been processed
 217  * already.
 218  */
 219
 220 static void extended_entry_extract(struct tree_desc_x *t,
 221                                    struct name_entry *a,
 222                                    const char *first,
 223                                    int first_len)
 224 {
 225         const char *path;
 226         int len;
 227         struct tree_desc probe;
 228         struct tree_desc_skip *skip;
 229
 230         /*
 231          * Extract the first entry from the tree_desc, but skip the
 232          * ones that we already returned in earlier rounds.
 233          */
 234         while (1) {
 235                 if (!t->d.size) {
 236                         entry_clear(a);
 237                         break; /* not found */
 238                 }
 239                 entry_extract(&t->d, a);
 240                 for (skip = t->skip; skip; skip = skip->prev)
 241                         if (a->path == skip->ptr)
 242                                 break; /* found */
 243                 if (!skip)
 244                         break;
 245                 /* We have processed this entry already. */
 246                 update_tree_entry(&t->d);
 247         }
 248
 249         if (!first || !a->path)
 250                 return;
 251
 252         /*
 253          * The caller wants "first" from this tree, or nothing.
 254          */
 255         path = a->path;
 256         len = tree_entry_len(a->path, a->sha1);
 257         switch (check_entry_match(first, first_len, path, len)) {
 258         case -1:
 259                 entry_clear(a);
 260         case 0:
 261                 return;
 262         default:
 263                 break;
 264         }
 265
 266         /*
 267          * We need to look-ahead -- we suspect that a subtree whose
 268          * name is "first" may be hiding behind the current entry "path".
 269          */
 270         probe = t->d;
 271         while (probe.size) {
 272                 entry_extract(&probe, a);
 273                 path = a->path;
 274                 len = tree_entry_len(a->path, a->sha1);
 275                 switch (check_entry_match(first, first_len, path, len)) {
 276                 case -1:
 277                         entry_clear(a);
 278                 case 0:
 279                         return;
 280                 default:
 281                         update_tree_entry(&probe);
 282                         break;
 283                 }
 284                 /* keep looking */
 285         }
 286         entry_clear(a);
 287 }
 288
 289 static void update_extended_entry(struct tree_desc_x *t, struct name_entry *a)
 290 {
 291         if (t->d.entry.path == a->path) {
 292                 update_tree_entry(&t->d);
 293         } else {
 294                 /* we have returned this entry early */
 295                 struct tree_desc_skip *skip = xmalloc(sizeof(*skip));
 296                 skip->ptr = a->path;
 297                 skip->prev = t->skip;
 298                 t->skip = skip;
 299         }
 300 }
 301
 302 static void free_extended_entry(struct tree_desc_x *t)
 303 {
 304         struct tree_desc_skip *p, *s;
 305
 306         for (s = t->skip; s; s = p) {
 307                 p = s->prev;
 308                 free(s);
 309         }
 310 }
 311
 312 static inline int prune_traversal(struct name_entry *e,
 313                                   struct traverse_info *info,
 314                                   struct strbuf *base,
 315                                   int still_interesting)
 316 {
 317         if (!info->pathspec || still_interesting == 2)
 318                 return 2;
 319         if (still_interesting < 0)
 320                 return still_interesting;
 321         return tree_entry_interesting(e, base, 0, info->pathspec);
 322 }
 323
 324 int traverse_trees(int n, struct tree_desc *t, struct traverse_info *info)
 325 {
 326         int ret = 0;
 327         int error = 0;
 328         struct name_entry *entry = xmalloc(n*sizeof(*entry));
 329         int i;
 330         struct tree_desc_x *tx = xcalloc(n, sizeof(*tx));
 331         struct strbuf base = STRBUF_INIT;
 332         int interesting = 1;
 333
 334         for (i = 0; i < n; i++)
 335                 tx[i].d = t[i];
 336
 337         if (info->prev) {
 338                 strbuf_grow(&base, info->pathlen);
 339                 make_traverse_path(base.buf, info->prev, &info->name);
 340                 base.buf[info->pathlen-1] = '/';
 341                 strbuf_setlen(&base, info->pathlen);
 342         }
 343         for (;;) {
 344                 unsigned long mask, dirmask;
 345                 const char *first = NULL;
 346                 int first_len = 0;
 347                 struct name_entry *e;
 348                 int len;
 349
 350                 for (i = 0; i < n; i++) {
 351                         e = entry + i;
 352                         extended_entry_extract(tx + i, e, NULL, 0);
 353                 }
 354
 355                 /*
 356                  * A tree may have "t-2" at the current location even
 357                  * though it may have "t" that is a subtree behind it,
 358                  * and another tree may return "t".  We want to grab
 359                  * all "t" from all trees to match in such a case.
 360                  */
 361                 for (i = 0; i < n; i++) {
 362                         e = entry + i;
 363                         if (!e->path)
 364                                 continue;
 365                         len = tree_entry_len(e->path, e->sha1);
 366                         if (!first) {
 367                                 first = e->path;
 368                                 first_len = len;
 369                                 continue;
 370                         }
 371                         if (name_compare(e->path, len, first, first_len) < 0) {
 372                                 first = e->path;
 373                                 first_len = len;
 374                         }
 375                 }
 376
 377                 if (first) {
 378                         for (i = 0; i < n; i++) {
 379                                 e = entry + i;
 380                                 extended_entry_extract(tx + i, e, first, first_len);
 381                                 /* Cull the ones that are not the earliest */
 382                                 if (!e->path)
 383                                         continue;
 384                                 len = tree_entry_len(e->path, e->sha1);
 385                                 if (name_compare(e->path, len, first, first_len))
 386                                         entry_clear(e);
 387                         }
 388                 }
 389
 390                 /* Now we have in entry[i] the earliest name from the trees */
 391                 mask = 0;
 392                 dirmask = 0;
 393                 for (i = 0; i < n; i++) {
 394                         if (!entry[i].path)
 395                                 continue;
 396                         mask |= 1ul << i;
 397                         if (S_ISDIR(entry[i].mode))
 398                                 dirmask |= 1ul << i;
 399                         e = &entry[i];
 400                 }
 401                 if (!mask)
 402                         break;
 403                 interesting = prune_traversal(e, info, &base, interesting);
 404                 if (interesting < 0)
 405                         break;
 406                 if (interesting) {
 407                         ret = info->fn(n, mask, dirmask, entry, info);
 408                         if (ret < 0) {
 409                                 error = ret;
 410                                 if (!info->show_all_errors)
 411                                         break;
 412                         }
 413                         mask &= ret;
 414                 }
 415                 ret = 0;
 416                 for (i = 0; i < n; i++)
 417                         if (mask & (1ul << i))
 418                                 update_extended_entry(tx + i, entry + i);
 419         }
 420         free(entry);
 421         for (i = 0; i < n; i++)
 422                 free_extended_entry(tx + i);
 423         free(tx);
 424         strbuf_release(&base);
 425         return error;
 426 }
 427
 428 static int find_tree_entry(struct tree_desc *t, const char *name, unsigned char *result, unsigned *mode)
 429 {
 430         int namelen = strlen(name);
 431         while (t->size) {
 432                 const char *entry;
 433                 const unsigned char *sha1;
 434                 int entrylen, cmp;
 435
 436                 sha1 = tree_entry_extract(t, &entry, mode);
 437                 update_tree_entry(t);
 438                 entrylen = tree_entry_len(entry, sha1);
 439                 if (entrylen > namelen)
 440                         continue;
 441                 cmp = memcmp(name, entry, entrylen);
 442                 if (cmp > 0)
 443                         continue;
 444                 if (cmp < 0)
 445                         break;
 446                 if (entrylen == namelen) {
 447                         hashcpy(result, sha1);
 448                         return 0;
 449                 }
 450                 if (name[entrylen] != '/')
 451                         continue;
 452                 if (!S_ISDIR(*mode))
 453                         break;
 454                 if (++entrylen == namelen) {
 455                         hashcpy(result, sha1);
 456                         return 0;
 457                 }
 458                 return get_tree_entry(sha1, name + entrylen, result, mode);
 459         }
 460         return -1;
 461 }
 462
 463 int get_tree_entry(const unsigned char *tree_sha1, const char *name, unsigned char *sha1, unsigned *mode)
 464 {
 465         int retval;
 466         void *tree;
 467         unsigned long size;
 468         struct tree_desc t;
 469         unsigned char root[20];
 470
 471         tree = read_object_with_reference(tree_sha1, tree_type, &size, root);
 472         if (!tree)
 473                 return -1;
 474
 475         if (name[0] == '\0') {
 476                 hashcpy(sha1, root);
 477                 free(tree);
 478                 return 0;
 479         }
 480
 481         init_tree_desc(&t, tree, size);
 482         retval = find_tree_entry(&t, name, sha1, mode);
 483         free(tree);
 484         return retval;
 485 }
 486
 487 static int match_entry(const struct name_entry *entry, int pathlen,
 488                        const char *match, int matchlen,
 489                        int *never_interesting)
 490 {
 491         int m = -1; /* signals that we haven't called strncmp() */
 492
 493         if (*never_interesting) {
 494                 /*
 495                  * We have not seen any match that sorts later
 496                  * than the current path.
 497                  */
 498
 499                 /*
 500                  * Does match sort strictly earlier than path
 501                  * with their common parts?
 502                  */
 503                 m = strncmp(match, entry->path,
 504                             (matchlen < pathlen) ? matchlen : pathlen);
 505                 if (m < 0)
 506                         return 0;
 507
 508                 /*
 509                  * If we come here even once, that means there is at
 510                  * least one pathspec that would sort equal to or
 511                  * later than the path we are currently looking at.
 512                  * In other words, if we have never reached this point
 513                  * after iterating all pathspecs, it means all
 514                  * pathspecs are either outside of base, or inside the
 515                  * base but sorts strictly earlier than the current
 516                  * one.  In either case, they will never match the
 517                  * subsequent entries.  In such a case, we initialized
 518                  * the variable to -1 and that is what will be
 519                  * returned, allowing the caller to terminate early.
 520                  */
 521                 *never_interesting = 0;
 522         }
 523
 524         if (pathlen > matchlen)
 525                 return 0;
 526
 527         if (matchlen > pathlen) {
 528                 if (match[pathlen] != '/')
 529                         return 0;
 530                 if (!S_ISDIR(entry->mode))
 531                         return 0;
 532         }
 533
 534         if (m == -1)
 535                 /*
 536                  * we cheated and did not do strncmp(), so we do
 537                  * that here.
 538                  */
 539                 m = strncmp(match, entry->path, pathlen);
 540
 541         /*
 542          * If common part matched earlier then it is a hit,
 543          * because we rejected the case where path is not a
 544          * leading directory and is shorter than match.
 545          */
 546         if (!m)
 547                 return 1;
 548
 549         return 0;
 550 }
 551
 552 static int match_dir_prefix(const char *base, int baselen,
 553                             const char *match, int matchlen)
 554 {
 555         if (strncmp(base, match, matchlen))
 556                 return 0;
 557
 558         /*
 559          * If the base is a subdirectory of a path which
 560          * was specified, all of them are interesting.
 561          */
 562         if (!matchlen ||
 563             base[matchlen] == '/' ||
 564             match[matchlen - 1] == '/')
 565                 return 1;
 566
 567         /* Just a random prefix match */
 568         return 0;
 569 }
 570
 571 /*
 572  * Is a tree entry interesting given the pathspec we have?
 573  *
 574  * Pre-condition: either baselen == base_offset (i.e. empty path)
 575  * or base[baselen-1] == '/' (i.e. with trailing slash).
 576  *
 577  * Return:
 578  *  - 2 for "yes, and all subsequent entries will be"
 579  *  - 1 for yes
 580  *  - zero for no
 581  *  - negative for "no, and no subsequent entries will be either"
 582  */
 583 int tree_entry_interesting(const struct name_entry *entry,
 584                            struct strbuf *base, int base_offset,
 585                            const struct pathspec *ps)
 586 {
 587         int i;
 588         int pathlen, baselen = base->len - base_offset;
 589         int never_interesting = ps->has_wildcard ? 0 : -1;
 590
 591         if (!ps->nr) {
 592                 if (!ps->recursive || ps->max_depth == -1)
 593                         return 2;
 594                 return !!within_depth(base->buf + base_offset, baselen,
 595                                       !!S_ISDIR(entry->mode),
 596                                       ps->max_depth);
 597         }
 598
 599         pathlen = tree_entry_len(entry->path, entry->sha1);
 600
 601         for (i = ps->nr - 1; i >= 0; i--) {
 602                 const struct pathspec_item *item = ps->items+i;
 603                 const char *match = item->match;
 604                 const char *base_str = base->buf + base_offset;
 605                 int matchlen = item->len;
 606
 607                 if (baselen >= matchlen) {
 608                         /* If it doesn't match, move along... */
 609                         if (!match_dir_prefix(base_str, baselen, match, matchlen))
 610                                 goto match_wildcards;
 611
 612                         if (!ps->recursive || ps->max_depth == -1)
 613                                 return 2;
 614
 615                         return !!within_depth(base_str + matchlen + 1,
 616                                               baselen - matchlen - 1,
 617                                               !!S_ISDIR(entry->mode),
 618                                               ps->max_depth);
 619                 }
 620
 621                 /* Does the base match? */
 622                 if (!strncmp(base_str, match, baselen)) {
 623                         if (match_entry(entry, pathlen,
 624                                         match + baselen, matchlen - baselen,
 625                                         &never_interesting))
 626                                 return 1;
 627
 628                         if (ps->items[i].use_wildcard) {
 629                                 if (!fnmatch(match + baselen, entry->path, 0))
 630                                         return 1;
 631
 632                                 /*
 633                                  * Match all directories. We'll try to
 634                                  * match files later on.
 635                                  */
 636                                 if (ps->recursive && S_ISDIR(entry->mode))
 637                                         return 1;
 638                         }
 639
 640                         continue;
 641                 }
 642
 643 match_wildcards:
 644                 if (!ps->items[i].use_wildcard)
 645                         continue;
 646
 647                 /*
 648                  * Concatenate base and entry->path into one and do
 649                  * fnmatch() on it.
 650                  */
 651
 652                 strbuf_add(base, entry->path, pathlen);
 653
 654                 if (!fnmatch(match, base->buf + base_offset, 0)) {
 655                         strbuf_setlen(base, base_offset + baselen);
 656                         return 1;
 657                 }
 658                 strbuf_setlen(base, base_offset + baselen);
 659
 660                 /*
 661                  * Match all directories. We'll try to match files
 662                  * later on.
 663                  */
 664                 if (ps->recursive && S_ISDIR(entry->mode))
 665                         return 1;
 666         }
 667         return never_interesting; /* No matches */
 668 }