1#include "cache.h" 2#include "refs.h" 3#include "object.h" 4#include "tag.h" 5#include "dir.h" 6#include "string-list.h" 7 8/* 9 * How to handle various characters in refnames: 10 * 0: An acceptable character for refs 11 * 1: End-of-component 12 * 2: ., look for a preceding . to reject .. in refs 13 * 3: {, look for a preceding @ to reject @{ in refs 14 * 4: A bad character: ASCII control characters, "~", "^", ":" or SP 15 */ 16static unsigned char refname_disposition[256] = { 17 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 18 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 19 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 2, 1, 20 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4, 21 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 22 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0, 23 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 24 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4 25}; 26 27/* 28 * Try to read one refname component from the front of refname. 29 * Return the length of the component found, or -1 if the component is 30 * not legal. It is legal if it is something reasonable to have under 31 * ".git/refs/"; We do not like it if: 32 * 33 * - any path component of it begins with ".", or 34 * - it has double dots "..", or 35 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or 36 * - it ends with a "/". 37 * - it ends with ".lock" 38 * - it contains a "\" (backslash) 39 */ 40static int check_refname_component(const char *refname, int flags) 41{ 42 const char *cp; 43 char last = '\0'; 44 45 for (cp = refname; ; cp++) { 46 int ch = *cp & 255; 47 unsigned char disp = refname_disposition[ch]; 48 switch (disp) { 49 case 1: 50 goto out; 51 case 2: 52 if (last == '.') 53 return -1; /* Refname contains "..". */ 54 break; 55 case 3: 56 if (last == '@') 57 return -1; /* Refname contains "@{". */ 58 break; 59 case 4: 60 return -1; 61 } 62 last = ch; 63 } 64out: 65 if (cp == refname) 66 return 0; /* Component has zero length. */ 67 if (refname[0] == '.') { 68 if (!(flags & REFNAME_DOT_COMPONENT)) 69 return -1; /* Component starts with '.'. */ 70 /* 71 * Even if leading dots are allowed, don't allow "." 72 * as a component (".." is prevented by a rule above). 73 */ 74 if (refname[1] == '\0') 75 return -1; /* Component equals ".". */ 76 } 77 if (cp - refname >= 5 && !memcmp(cp - 5, ".lock", 5)) 78 return -1; /* Refname ends with ".lock". */ 79 return cp - refname; 80} 81 82int check_refname_format(const char *refname, int flags) 83{ 84 int component_len, component_count = 0; 85 86 if (!strcmp(refname, "@")) 87 /* Refname is a single character '@'. */ 88 return -1; 89 90 while (1) { 91 /* We are at the start of a path component. */ 92 component_len = check_refname_component(refname, flags); 93 if (component_len <= 0) { 94 if ((flags & REFNAME_REFSPEC_PATTERN) && 95 refname[0] == '*' && 96 (refname[1] == '\0' || refname[1] == '/')) { 97 /* Accept one wildcard as a full refname component. */ 98 flags &= ~REFNAME_REFSPEC_PATTERN; 99 component_len = 1; 100 } else { 101 return -1; 102 } 103 } 104 component_count++; 105 if (refname[component_len] == '\0') 106 break; 107 /* Skip to next component. */ 108 refname += component_len + 1; 109 } 110 111 if (refname[component_len - 1] == '.') 112 return -1; /* Refname ends with '.'. */ 113 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2) 114 return -1; /* Refname has only one component. */ 115 return 0; 116} 117 118struct ref_entry; 119 120/* 121 * Information used (along with the information in ref_entry) to 122 * describe a single cached reference. This data structure only 123 * occurs embedded in a union in struct ref_entry, and only when 124 * (ref_entry->flag & REF_DIR) is zero. 125 */ 126struct ref_value { 127 /* 128 * The name of the object to which this reference resolves 129 * (which may be a tag object). If REF_ISBROKEN, this is 130 * null. If REF_ISSYMREF, then this is the name of the object 131 * referred to by the last reference in the symlink chain. 132 */ 133 unsigned char sha1[20]; 134 135 /* 136 * If REF_KNOWS_PEELED, then this field holds the peeled value 137 * of this reference, or null if the reference is known not to 138 * be peelable. See the documentation for peel_ref() for an 139 * exact definition of "peelable". 140 */ 141 unsigned char peeled[20]; 142}; 143 144struct ref_cache; 145 146/* 147 * Information used (along with the information in ref_entry) to 148 * describe a level in the hierarchy of references. This data 149 * structure only occurs embedded in a union in struct ref_entry, and 150 * only when (ref_entry.flag & REF_DIR) is set. In that case, 151 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references 152 * in the directory have already been read: 153 * 154 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose 155 * or packed references, already read. 156 * 157 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose 158 * references that hasn't been read yet (nor has any of its 159 * subdirectories). 160 * 161 * Entries within a directory are stored within a growable array of 162 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i < 163 * sorted are sorted by their component name in strcmp() order and the 164 * remaining entries are unsorted. 165 * 166 * Loose references are read lazily, one directory at a time. When a 167 * directory of loose references is read, then all of the references 168 * in that directory are stored, and REF_INCOMPLETE stubs are created 169 * for any subdirectories, but the subdirectories themselves are not 170 * read. The reading is triggered by get_ref_dir(). 171 */ 172struct ref_dir { 173 int nr, alloc; 174 175 /* 176 * Entries with index 0 <= i < sorted are sorted by name. New 177 * entries are appended to the list unsorted, and are sorted 178 * only when required; thus we avoid the need to sort the list 179 * after the addition of every reference. 180 */ 181 int sorted; 182 183 /* A pointer to the ref_cache that contains this ref_dir. */ 184 struct ref_cache *ref_cache; 185 186 struct ref_entry **entries; 187}; 188 189/* 190 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01, 191 * REF_ISPACKED=0x02, and REF_ISBROKEN=0x04 are public values; see 192 * refs.h. 193 */ 194 195/* 196 * The field ref_entry->u.value.peeled of this value entry contains 197 * the correct peeled value for the reference, which might be 198 * null_sha1 if the reference is not a tag or if it is broken. 199 */ 200#define REF_KNOWS_PEELED 0x08 201 202/* ref_entry represents a directory of references */ 203#define REF_DIR 0x10 204 205/* 206 * Entry has not yet been read from disk (used only for REF_DIR 207 * entries representing loose references) 208 */ 209#define REF_INCOMPLETE 0x20 210 211/* 212 * A ref_entry represents either a reference or a "subdirectory" of 213 * references. 214 * 215 * Each directory in the reference namespace is represented by a 216 * ref_entry with (flags & REF_DIR) set and containing a subdir member 217 * that holds the entries in that directory that have been read so 218 * far. If (flags & REF_INCOMPLETE) is set, then the directory and 219 * its subdirectories haven't been read yet. REF_INCOMPLETE is only 220 * used for loose reference directories. 221 * 222 * References are represented by a ref_entry with (flags & REF_DIR) 223 * unset and a value member that describes the reference's value. The 224 * flag member is at the ref_entry level, but it is also needed to 225 * interpret the contents of the value field (in other words, a 226 * ref_value object is not very much use without the enclosing 227 * ref_entry). 228 * 229 * Reference names cannot end with slash and directories' names are 230 * always stored with a trailing slash (except for the top-level 231 * directory, which is always denoted by ""). This has two nice 232 * consequences: (1) when the entries in each subdir are sorted 233 * lexicographically by name (as they usually are), the references in 234 * a whole tree can be generated in lexicographic order by traversing 235 * the tree in left-to-right, depth-first order; (2) the names of 236 * references and subdirectories cannot conflict, and therefore the 237 * presence of an empty subdirectory does not block the creation of a 238 * similarly-named reference. (The fact that reference names with the 239 * same leading components can conflict *with each other* is a 240 * separate issue that is regulated by is_refname_available().) 241 * 242 * Please note that the name field contains the fully-qualified 243 * reference (or subdirectory) name. Space could be saved by only 244 * storing the relative names. But that would require the full names 245 * to be generated on the fly when iterating in do_for_each_ref(), and 246 * would break callback functions, who have always been able to assume 247 * that the name strings that they are passed will not be freed during 248 * the iteration. 249 */ 250struct ref_entry { 251 unsigned char flag; /* ISSYMREF? ISPACKED? */ 252 union { 253 struct ref_value value; /* if not (flags&REF_DIR) */ 254 struct ref_dir subdir; /* if (flags&REF_DIR) */ 255 } u; 256 /* 257 * The full name of the reference (e.g., "refs/heads/master") 258 * or the full name of the directory with a trailing slash 259 * (e.g., "refs/heads/"): 260 */ 261 char name[FLEX_ARRAY]; 262}; 263 264static void read_loose_refs(const char *dirname, struct ref_dir *dir); 265 266static struct ref_dir *get_ref_dir(struct ref_entry *entry) 267{ 268 struct ref_dir *dir; 269 assert(entry->flag & REF_DIR); 270 dir = &entry->u.subdir; 271 if (entry->flag & REF_INCOMPLETE) { 272 read_loose_refs(entry->name, dir); 273 entry->flag &= ~REF_INCOMPLETE; 274 } 275 return dir; 276} 277 278static struct ref_entry *create_ref_entry(const char *refname, 279 const unsigned char *sha1, int flag, 280 int check_name) 281{ 282 int len; 283 struct ref_entry *ref; 284 285 if (check_name && 286 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT)) 287 die("Reference has invalid format: '%s'", refname); 288 len = strlen(refname) + 1; 289 ref = xmalloc(sizeof(struct ref_entry) + len); 290 hashcpy(ref->u.value.sha1, sha1); 291 hashclr(ref->u.value.peeled); 292 memcpy(ref->name, refname, len); 293 ref->flag = flag; 294 return ref; 295} 296 297static void clear_ref_dir(struct ref_dir *dir); 298 299static void free_ref_entry(struct ref_entry *entry) 300{ 301 if (entry->flag & REF_DIR) { 302 /* 303 * Do not use get_ref_dir() here, as that might 304 * trigger the reading of loose refs. 305 */ 306 clear_ref_dir(&entry->u.subdir); 307 } 308 free(entry); 309} 310 311/* 312 * Add a ref_entry to the end of dir (unsorted). Entry is always 313 * stored directly in dir; no recursion into subdirectories is 314 * done. 315 */ 316static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry) 317{ 318 ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc); 319 dir->entries[dir->nr++] = entry; 320 /* optimize for the case that entries are added in order */ 321 if (dir->nr == 1 || 322 (dir->nr == dir->sorted + 1 && 323 strcmp(dir->entries[dir->nr - 2]->name, 324 dir->entries[dir->nr - 1]->name) < 0)) 325 dir->sorted = dir->nr; 326} 327 328/* 329 * Clear and free all entries in dir, recursively. 330 */ 331static void clear_ref_dir(struct ref_dir *dir) 332{ 333 int i; 334 for (i = 0; i < dir->nr; i++) 335 free_ref_entry(dir->entries[i]); 336 free(dir->entries); 337 dir->sorted = dir->nr = dir->alloc = 0; 338 dir->entries = NULL; 339} 340 341/* 342 * Create a struct ref_entry object for the specified dirname. 343 * dirname is the name of the directory with a trailing slash (e.g., 344 * "refs/heads/") or "" for the top-level directory. 345 */ 346static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache, 347 const char *dirname, size_t len, 348 int incomplete) 349{ 350 struct ref_entry *direntry; 351 direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1); 352 memcpy(direntry->name, dirname, len); 353 direntry->name[len] = '\0'; 354 direntry->u.subdir.ref_cache = ref_cache; 355 direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0); 356 return direntry; 357} 358 359static int ref_entry_cmp(const void *a, const void *b) 360{ 361 struct ref_entry *one = *(struct ref_entry **)a; 362 struct ref_entry *two = *(struct ref_entry **)b; 363 return strcmp(one->name, two->name); 364} 365 366static void sort_ref_dir(struct ref_dir *dir); 367 368struct string_slice { 369 size_t len; 370 const char *str; 371}; 372 373static int ref_entry_cmp_sslice(const void *key_, const void *ent_) 374{ 375 const struct string_slice *key = key_; 376 const struct ref_entry *ent = *(const struct ref_entry * const *)ent_; 377 int cmp = strncmp(key->str, ent->name, key->len); 378 if (cmp) 379 return cmp; 380 return '\0' - (unsigned char)ent->name[key->len]; 381} 382 383/* 384 * Return the index of the entry with the given refname from the 385 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if 386 * no such entry is found. dir must already be complete. 387 */ 388static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len) 389{ 390 struct ref_entry **r; 391 struct string_slice key; 392 393 if (refname == NULL || !dir->nr) 394 return -1; 395 396 sort_ref_dir(dir); 397 key.len = len; 398 key.str = refname; 399 r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries), 400 ref_entry_cmp_sslice); 401 402 if (r == NULL) 403 return -1; 404 405 return r - dir->entries; 406} 407 408/* 409 * Search for a directory entry directly within dir (without 410 * recursing). Sort dir if necessary. subdirname must be a directory 411 * name (i.e., end in '/'). If mkdir is set, then create the 412 * directory if it is missing; otherwise, return NULL if the desired 413 * directory cannot be found. dir must already be complete. 414 */ 415static struct ref_dir *search_for_subdir(struct ref_dir *dir, 416 const char *subdirname, size_t len, 417 int mkdir) 418{ 419 int entry_index = search_ref_dir(dir, subdirname, len); 420 struct ref_entry *entry; 421 if (entry_index == -1) { 422 if (!mkdir) 423 return NULL; 424 /* 425 * Since dir is complete, the absence of a subdir 426 * means that the subdir really doesn't exist; 427 * therefore, create an empty record for it but mark 428 * the record complete. 429 */ 430 entry = create_dir_entry(dir->ref_cache, subdirname, len, 0); 431 add_entry_to_dir(dir, entry); 432 } else { 433 entry = dir->entries[entry_index]; 434 } 435 return get_ref_dir(entry); 436} 437 438/* 439 * If refname is a reference name, find the ref_dir within the dir 440 * tree that should hold refname. If refname is a directory name 441 * (i.e., ends in '/'), then return that ref_dir itself. dir must 442 * represent the top-level directory and must already be complete. 443 * Sort ref_dirs and recurse into subdirectories as necessary. If 444 * mkdir is set, then create any missing directories; otherwise, 445 * return NULL if the desired directory cannot be found. 446 */ 447static struct ref_dir *find_containing_dir(struct ref_dir *dir, 448 const char *refname, int mkdir) 449{ 450 const char *slash; 451 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) { 452 size_t dirnamelen = slash - refname + 1; 453 struct ref_dir *subdir; 454 subdir = search_for_subdir(dir, refname, dirnamelen, mkdir); 455 if (!subdir) { 456 dir = NULL; 457 break; 458 } 459 dir = subdir; 460 } 461 462 return dir; 463} 464 465/* 466 * Find the value entry with the given name in dir, sorting ref_dirs 467 * and recursing into subdirectories as necessary. If the name is not 468 * found or it corresponds to a directory entry, return NULL. 469 */ 470static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname) 471{ 472 int entry_index; 473 struct ref_entry *entry; 474 dir = find_containing_dir(dir, refname, 0); 475 if (!dir) 476 return NULL; 477 entry_index = search_ref_dir(dir, refname, strlen(refname)); 478 if (entry_index == -1) 479 return NULL; 480 entry = dir->entries[entry_index]; 481 return (entry->flag & REF_DIR) ? NULL : entry; 482} 483 484/* 485 * Remove the entry with the given name from dir, recursing into 486 * subdirectories as necessary. If refname is the name of a directory 487 * (i.e., ends with '/'), then remove the directory and its contents. 488 * If the removal was successful, return the number of entries 489 * remaining in the directory entry that contained the deleted entry. 490 * If the name was not found, return -1. Please note that this 491 * function only deletes the entry from the cache; it does not delete 492 * it from the filesystem or ensure that other cache entries (which 493 * might be symbolic references to the removed entry) are updated. 494 * Nor does it remove any containing dir entries that might be made 495 * empty by the removal. dir must represent the top-level directory 496 * and must already be complete. 497 */ 498static int remove_entry(struct ref_dir *dir, const char *refname) 499{ 500 int refname_len = strlen(refname); 501 int entry_index; 502 struct ref_entry *entry; 503 int is_dir = refname[refname_len - 1] == '/'; 504 if (is_dir) { 505 /* 506 * refname represents a reference directory. Remove 507 * the trailing slash; otherwise we will get the 508 * directory *representing* refname rather than the 509 * one *containing* it. 510 */ 511 char *dirname = xmemdupz(refname, refname_len - 1); 512 dir = find_containing_dir(dir, dirname, 0); 513 free(dirname); 514 } else { 515 dir = find_containing_dir(dir, refname, 0); 516 } 517 if (!dir) 518 return -1; 519 entry_index = search_ref_dir(dir, refname, refname_len); 520 if (entry_index == -1) 521 return -1; 522 entry = dir->entries[entry_index]; 523 524 memmove(&dir->entries[entry_index], 525 &dir->entries[entry_index + 1], 526 (dir->nr - entry_index - 1) * sizeof(*dir->entries) 527 ); 528 dir->nr--; 529 if (dir->sorted > entry_index) 530 dir->sorted--; 531 free_ref_entry(entry); 532 return dir->nr; 533} 534 535/* 536 * Add a ref_entry to the ref_dir (unsorted), recursing into 537 * subdirectories as necessary. dir must represent the top-level 538 * directory. Return 0 on success. 539 */ 540static int add_ref(struct ref_dir *dir, struct ref_entry *ref) 541{ 542 dir = find_containing_dir(dir, ref->name, 1); 543 if (!dir) 544 return -1; 545 add_entry_to_dir(dir, ref); 546 return 0; 547} 548 549/* 550 * Emit a warning and return true iff ref1 and ref2 have the same name 551 * and the same sha1. Die if they have the same name but different 552 * sha1s. 553 */ 554static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2) 555{ 556 if (strcmp(ref1->name, ref2->name)) 557 return 0; 558 559 /* Duplicate name; make sure that they don't conflict: */ 560 561 if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR)) 562 /* This is impossible by construction */ 563 die("Reference directory conflict: %s", ref1->name); 564 565 if (hashcmp(ref1->u.value.sha1, ref2->u.value.sha1)) 566 die("Duplicated ref, and SHA1s don't match: %s", ref1->name); 567 568 warning("Duplicated ref: %s", ref1->name); 569 return 1; 570} 571 572/* 573 * Sort the entries in dir non-recursively (if they are not already 574 * sorted) and remove any duplicate entries. 575 */ 576static void sort_ref_dir(struct ref_dir *dir) 577{ 578 int i, j; 579 struct ref_entry *last = NULL; 580 581 /* 582 * This check also prevents passing a zero-length array to qsort(), 583 * which is a problem on some platforms. 584 */ 585 if (dir->sorted == dir->nr) 586 return; 587 588 qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp); 589 590 /* Remove any duplicates: */ 591 for (i = 0, j = 0; j < dir->nr; j++) { 592 struct ref_entry *entry = dir->entries[j]; 593 if (last && is_dup_ref(last, entry)) 594 free_ref_entry(entry); 595 else 596 last = dir->entries[i++] = entry; 597 } 598 dir->sorted = dir->nr = i; 599} 600 601/* Include broken references in a do_for_each_ref*() iteration: */ 602#define DO_FOR_EACH_INCLUDE_BROKEN 0x01 603 604/* 605 * Return true iff the reference described by entry can be resolved to 606 * an object in the database. Emit a warning if the referred-to 607 * object does not exist. 608 */ 609static int ref_resolves_to_object(struct ref_entry *entry) 610{ 611 if (entry->flag & REF_ISBROKEN) 612 return 0; 613 if (!has_sha1_file(entry->u.value.sha1)) { 614 error("%s does not point to a valid object!", entry->name); 615 return 0; 616 } 617 return 1; 618} 619 620/* 621 * current_ref is a performance hack: when iterating over references 622 * using the for_each_ref*() functions, current_ref is set to the 623 * current reference's entry before calling the callback function. If 624 * the callback function calls peel_ref(), then peel_ref() first 625 * checks whether the reference to be peeled is the current reference 626 * (it usually is) and if so, returns that reference's peeled version 627 * if it is available. This avoids a refname lookup in a common case. 628 */ 629static struct ref_entry *current_ref; 630 631typedef int each_ref_entry_fn(struct ref_entry *entry, void *cb_data); 632 633struct ref_entry_cb { 634 const char *base; 635 int trim; 636 int flags; 637 each_ref_fn *fn; 638 void *cb_data; 639}; 640 641/* 642 * Handle one reference in a do_for_each_ref*()-style iteration, 643 * calling an each_ref_fn for each entry. 644 */ 645static int do_one_ref(struct ref_entry *entry, void *cb_data) 646{ 647 struct ref_entry_cb *data = cb_data; 648 struct ref_entry *old_current_ref; 649 int retval; 650 651 if (!starts_with(entry->name, data->base)) 652 return 0; 653 654 if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) && 655 !ref_resolves_to_object(entry)) 656 return 0; 657 658 /* Store the old value, in case this is a recursive call: */ 659 old_current_ref = current_ref; 660 current_ref = entry; 661 retval = data->fn(entry->name + data->trim, entry->u.value.sha1, 662 entry->flag, data->cb_data); 663 current_ref = old_current_ref; 664 return retval; 665} 666 667/* 668 * Call fn for each reference in dir that has index in the range 669 * offset <= index < dir->nr. Recurse into subdirectories that are in 670 * that index range, sorting them before iterating. This function 671 * does not sort dir itself; it should be sorted beforehand. fn is 672 * called for all references, including broken ones. 673 */ 674static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset, 675 each_ref_entry_fn fn, void *cb_data) 676{ 677 int i; 678 assert(dir->sorted == dir->nr); 679 for (i = offset; i < dir->nr; i++) { 680 struct ref_entry *entry = dir->entries[i]; 681 int retval; 682 if (entry->flag & REF_DIR) { 683 struct ref_dir *subdir = get_ref_dir(entry); 684 sort_ref_dir(subdir); 685 retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data); 686 } else { 687 retval = fn(entry, cb_data); 688 } 689 if (retval) 690 return retval; 691 } 692 return 0; 693} 694 695/* 696 * Call fn for each reference in the union of dir1 and dir2, in order 697 * by refname. Recurse into subdirectories. If a value entry appears 698 * in both dir1 and dir2, then only process the version that is in 699 * dir2. The input dirs must already be sorted, but subdirs will be 700 * sorted as needed. fn is called for all references, including 701 * broken ones. 702 */ 703static int do_for_each_entry_in_dirs(struct ref_dir *dir1, 704 struct ref_dir *dir2, 705 each_ref_entry_fn fn, void *cb_data) 706{ 707 int retval; 708 int i1 = 0, i2 = 0; 709 710 assert(dir1->sorted == dir1->nr); 711 assert(dir2->sorted == dir2->nr); 712 while (1) { 713 struct ref_entry *e1, *e2; 714 int cmp; 715 if (i1 == dir1->nr) { 716 return do_for_each_entry_in_dir(dir2, i2, fn, cb_data); 717 } 718 if (i2 == dir2->nr) { 719 return do_for_each_entry_in_dir(dir1, i1, fn, cb_data); 720 } 721 e1 = dir1->entries[i1]; 722 e2 = dir2->entries[i2]; 723 cmp = strcmp(e1->name, e2->name); 724 if (cmp == 0) { 725 if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) { 726 /* Both are directories; descend them in parallel. */ 727 struct ref_dir *subdir1 = get_ref_dir(e1); 728 struct ref_dir *subdir2 = get_ref_dir(e2); 729 sort_ref_dir(subdir1); 730 sort_ref_dir(subdir2); 731 retval = do_for_each_entry_in_dirs( 732 subdir1, subdir2, fn, cb_data); 733 i1++; 734 i2++; 735 } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) { 736 /* Both are references; ignore the one from dir1. */ 737 retval = fn(e2, cb_data); 738 i1++; 739 i2++; 740 } else { 741 die("conflict between reference and directory: %s", 742 e1->name); 743 } 744 } else { 745 struct ref_entry *e; 746 if (cmp < 0) { 747 e = e1; 748 i1++; 749 } else { 750 e = e2; 751 i2++; 752 } 753 if (e->flag & REF_DIR) { 754 struct ref_dir *subdir = get_ref_dir(e); 755 sort_ref_dir(subdir); 756 retval = do_for_each_entry_in_dir( 757 subdir, 0, fn, cb_data); 758 } else { 759 retval = fn(e, cb_data); 760 } 761 } 762 if (retval) 763 return retval; 764 } 765} 766 767/* 768 * Load all of the refs from the dir into our in-memory cache. The hard work 769 * of loading loose refs is done by get_ref_dir(), so we just need to recurse 770 * through all of the sub-directories. We do not even need to care about 771 * sorting, as traversal order does not matter to us. 772 */ 773static void prime_ref_dir(struct ref_dir *dir) 774{ 775 int i; 776 for (i = 0; i < dir->nr; i++) { 777 struct ref_entry *entry = dir->entries[i]; 778 if (entry->flag & REF_DIR) 779 prime_ref_dir(get_ref_dir(entry)); 780 } 781} 782/* 783 * Return true iff refname1 and refname2 conflict with each other. 784 * Two reference names conflict if one of them exactly matches the 785 * leading components of the other; e.g., "foo/bar" conflicts with 786 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or 787 * "foo/barbados". 788 */ 789static int names_conflict(const char *refname1, const char *refname2) 790{ 791 for (; *refname1 && *refname1 == *refname2; refname1++, refname2++) 792 ; 793 return (*refname1 == '\0' && *refname2 == '/') 794 || (*refname1 == '/' && *refname2 == '\0'); 795} 796 797struct name_conflict_cb { 798 const char *refname; 799 const char *oldrefname; 800 const char *conflicting_refname; 801}; 802 803static int name_conflict_fn(struct ref_entry *entry, void *cb_data) 804{ 805 struct name_conflict_cb *data = (struct name_conflict_cb *)cb_data; 806 if (data->oldrefname && !strcmp(data->oldrefname, entry->name)) 807 return 0; 808 if (names_conflict(data->refname, entry->name)) { 809 data->conflicting_refname = entry->name; 810 return 1; 811 } 812 return 0; 813} 814 815/* 816 * Return true iff a reference named refname could be created without 817 * conflicting with the name of an existing reference in dir. If 818 * oldrefname is non-NULL, ignore potential conflicts with oldrefname 819 * (e.g., because oldrefname is scheduled for deletion in the same 820 * operation). 821 */ 822static int is_refname_available(const char *refname, const char *oldrefname, 823 struct ref_dir *dir) 824{ 825 struct name_conflict_cb data; 826 data.refname = refname; 827 data.oldrefname = oldrefname; 828 data.conflicting_refname = NULL; 829 830 sort_ref_dir(dir); 831 if (do_for_each_entry_in_dir(dir, 0, name_conflict_fn, &data)) { 832 error("'%s' exists; cannot create '%s'", 833 data.conflicting_refname, refname); 834 return 0; 835 } 836 return 1; 837} 838 839struct packed_ref_cache { 840 struct ref_entry *root; 841 842 /* 843 * Count of references to the data structure in this instance, 844 * including the pointer from ref_cache::packed if any. The 845 * data will not be freed as long as the reference count is 846 * nonzero. 847 */ 848 unsigned int referrers; 849 850 /* 851 * Iff the packed-refs file associated with this instance is 852 * currently locked for writing, this points at the associated 853 * lock (which is owned by somebody else). The referrer count 854 * is also incremented when the file is locked and decremented 855 * when it is unlocked. 856 */ 857 struct lock_file *lock; 858 859 /* The metadata from when this packed-refs cache was read */ 860 struct stat_validity validity; 861}; 862 863/* 864 * Future: need to be in "struct repository" 865 * when doing a full libification. 866 */ 867static struct ref_cache { 868 struct ref_cache *next; 869 struct ref_entry *loose; 870 struct packed_ref_cache *packed; 871 /* 872 * The submodule name, or "" for the main repo. We allocate 873 * length 1 rather than FLEX_ARRAY so that the main ref_cache 874 * is initialized correctly. 875 */ 876 char name[1]; 877} ref_cache, *submodule_ref_caches; 878 879/* Lock used for the main packed-refs file: */ 880static struct lock_file packlock; 881 882/* 883 * Increment the reference count of *packed_refs. 884 */ 885static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs) 886{ 887 packed_refs->referrers++; 888} 889 890/* 891 * Decrease the reference count of *packed_refs. If it goes to zero, 892 * free *packed_refs and return true; otherwise return false. 893 */ 894static int release_packed_ref_cache(struct packed_ref_cache *packed_refs) 895{ 896 if (!--packed_refs->referrers) { 897 free_ref_entry(packed_refs->root); 898 stat_validity_clear(&packed_refs->validity); 899 free(packed_refs); 900 return 1; 901 } else { 902 return 0; 903 } 904} 905 906static void clear_packed_ref_cache(struct ref_cache *refs) 907{ 908 if (refs->packed) { 909 struct packed_ref_cache *packed_refs = refs->packed; 910 911 if (packed_refs->lock) 912 die("internal error: packed-ref cache cleared while locked"); 913 refs->packed = NULL; 914 release_packed_ref_cache(packed_refs); 915 } 916} 917 918static void clear_loose_ref_cache(struct ref_cache *refs) 919{ 920 if (refs->loose) { 921 free_ref_entry(refs->loose); 922 refs->loose = NULL; 923 } 924} 925 926static struct ref_cache *create_ref_cache(const char *submodule) 927{ 928 int len; 929 struct ref_cache *refs; 930 if (!submodule) 931 submodule = ""; 932 len = strlen(submodule) + 1; 933 refs = xcalloc(1, sizeof(struct ref_cache) + len); 934 memcpy(refs->name, submodule, len); 935 return refs; 936} 937 938/* 939 * Return a pointer to a ref_cache for the specified submodule. For 940 * the main repository, use submodule==NULL. The returned structure 941 * will be allocated and initialized but not necessarily populated; it 942 * should not be freed. 943 */ 944static struct ref_cache *get_ref_cache(const char *submodule) 945{ 946 struct ref_cache *refs; 947 948 if (!submodule || !*submodule) 949 return &ref_cache; 950 951 for (refs = submodule_ref_caches; refs; refs = refs->next) 952 if (!strcmp(submodule, refs->name)) 953 return refs; 954 955 refs = create_ref_cache(submodule); 956 refs->next = submodule_ref_caches; 957 submodule_ref_caches = refs; 958 return refs; 959} 960 961/* The length of a peeled reference line in packed-refs, including EOL: */ 962#define PEELED_LINE_LENGTH 42 963 964/* 965 * The packed-refs header line that we write out. Perhaps other 966 * traits will be added later. The trailing space is required. 967 */ 968static const char PACKED_REFS_HEADER[] = 969 "# pack-refs with: peeled fully-peeled \n"; 970 971/* 972 * Parse one line from a packed-refs file. Write the SHA1 to sha1. 973 * Return a pointer to the refname within the line (null-terminated), 974 * or NULL if there was a problem. 975 */ 976static const char *parse_ref_line(struct strbuf *line, unsigned char *sha1) 977{ 978 const char *ref; 979 980 /* 981 * 42: the answer to everything. 982 * 983 * In this case, it happens to be the answer to 984 * 40 (length of sha1 hex representation) 985 * +1 (space in between hex and name) 986 * +1 (newline at the end of the line) 987 */ 988 if (line->len <= 42) 989 return NULL; 990 991 if (get_sha1_hex(line->buf, sha1) < 0) 992 return NULL; 993 if (!isspace(line->buf[40])) 994 return NULL; 995 996 ref = line->buf + 41; 997 if (isspace(*ref)) 998 return NULL; 9991000 if (line->buf[line->len - 1] != '\n')1001 return NULL;1002 line->buf[--line->len] = 0;10031004 return ref;1005}10061007/*1008 * Read f, which is a packed-refs file, into dir.1009 *1010 * A comment line of the form "# pack-refs with: " may contain zero or1011 * more traits. We interpret the traits as follows:1012 *1013 * No traits:1014 *1015 * Probably no references are peeled. But if the file contains a1016 * peeled value for a reference, we will use it.1017 *1018 * peeled:1019 *1020 * References under "refs/tags/", if they *can* be peeled, *are*1021 * peeled in this file. References outside of "refs/tags/" are1022 * probably not peeled even if they could have been, but if we find1023 * a peeled value for such a reference we will use it.1024 *1025 * fully-peeled:1026 *1027 * All references in the file that can be peeled are peeled.1028 * Inversely (and this is more important), any references in the1029 * file for which no peeled value is recorded is not peelable. This1030 * trait should typically be written alongside "peeled" for1031 * compatibility with older clients, but we do not require it1032 * (i.e., "peeled" is a no-op if "fully-peeled" is set).1033 */1034static void read_packed_refs(FILE *f, struct ref_dir *dir)1035{1036 struct ref_entry *last = NULL;1037 struct strbuf line = STRBUF_INIT;1038 enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;10391040 while (strbuf_getwholeline(&line, f, '\n') != EOF) {1041 unsigned char sha1[20];1042 const char *refname;1043 static const char header[] = "# pack-refs with:";10441045 if (!strncmp(line.buf, header, sizeof(header)-1)) {1046 const char *traits = line.buf + sizeof(header) - 1;1047 if (strstr(traits, " fully-peeled "))1048 peeled = PEELED_FULLY;1049 else if (strstr(traits, " peeled "))1050 peeled = PEELED_TAGS;1051 /* perhaps other traits later as well */1052 continue;1053 }10541055 refname = parse_ref_line(&line, sha1);1056 if (refname) {1057 last = create_ref_entry(refname, sha1, REF_ISPACKED, 1);1058 if (peeled == PEELED_FULLY ||1059 (peeled == PEELED_TAGS && starts_with(refname, "refs/tags/")))1060 last->flag |= REF_KNOWS_PEELED;1061 add_ref(dir, last);1062 continue;1063 }1064 if (last &&1065 line.buf[0] == '^' &&1066 line.len == PEELED_LINE_LENGTH &&1067 line.buf[PEELED_LINE_LENGTH - 1] == '\n' &&1068 !get_sha1_hex(line.buf + 1, sha1)) {1069 hashcpy(last->u.value.peeled, sha1);1070 /*1071 * Regardless of what the file header said,1072 * we definitely know the value of *this*1073 * reference:1074 */1075 last->flag |= REF_KNOWS_PEELED;1076 }1077 }10781079 strbuf_release(&line);1080}10811082/*1083 * Get the packed_ref_cache for the specified ref_cache, creating it1084 * if necessary.1085 */1086static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs)1087{1088 const char *packed_refs_file;10891090 if (*refs->name)1091 packed_refs_file = git_path_submodule(refs->name, "packed-refs");1092 else1093 packed_refs_file = git_path("packed-refs");10941095 if (refs->packed &&1096 !stat_validity_check(&refs->packed->validity, packed_refs_file))1097 clear_packed_ref_cache(refs);10981099 if (!refs->packed) {1100 FILE *f;11011102 refs->packed = xcalloc(1, sizeof(*refs->packed));1103 acquire_packed_ref_cache(refs->packed);1104 refs->packed->root = create_dir_entry(refs, "", 0, 0);1105 f = fopen(packed_refs_file, "r");1106 if (f) {1107 stat_validity_update(&refs->packed->validity, fileno(f));1108 read_packed_refs(f, get_ref_dir(refs->packed->root));1109 fclose(f);1110 }1111 }1112 return refs->packed;1113}11141115static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_cache)1116{1117 return get_ref_dir(packed_ref_cache->root);1118}11191120static struct ref_dir *get_packed_refs(struct ref_cache *refs)1121{1122 return get_packed_ref_dir(get_packed_ref_cache(refs));1123}11241125void add_packed_ref(const char *refname, const unsigned char *sha1)1126{1127 struct packed_ref_cache *packed_ref_cache =1128 get_packed_ref_cache(&ref_cache);11291130 if (!packed_ref_cache->lock)1131 die("internal error: packed refs not locked");1132 add_ref(get_packed_ref_dir(packed_ref_cache),1133 create_ref_entry(refname, sha1, REF_ISPACKED, 1));1134}11351136/*1137 * Read the loose references from the namespace dirname into dir1138 * (without recursing). dirname must end with '/'. dir must be the1139 * directory entry corresponding to dirname.1140 */1141static void read_loose_refs(const char *dirname, struct ref_dir *dir)1142{1143 struct ref_cache *refs = dir->ref_cache;1144 DIR *d;1145 const char *path;1146 struct dirent *de;1147 int dirnamelen = strlen(dirname);1148 struct strbuf refname;11491150 if (*refs->name)1151 path = git_path_submodule(refs->name, "%s", dirname);1152 else1153 path = git_path("%s", dirname);11541155 d = opendir(path);1156 if (!d)1157 return;11581159 strbuf_init(&refname, dirnamelen + 257);1160 strbuf_add(&refname, dirname, dirnamelen);11611162 while ((de = readdir(d)) != NULL) {1163 unsigned char sha1[20];1164 struct stat st;1165 int flag;1166 const char *refdir;11671168 if (de->d_name[0] == '.')1169 continue;1170 if (ends_with(de->d_name, ".lock"))1171 continue;1172 strbuf_addstr(&refname, de->d_name);1173 refdir = *refs->name1174 ? git_path_submodule(refs->name, "%s", refname.buf)1175 : git_path("%s", refname.buf);1176 if (stat(refdir, &st) < 0) {1177 ; /* silently ignore */1178 } else if (S_ISDIR(st.st_mode)) {1179 strbuf_addch(&refname, '/');1180 add_entry_to_dir(dir,1181 create_dir_entry(refs, refname.buf,1182 refname.len, 1));1183 } else {1184 if (*refs->name) {1185 hashclr(sha1);1186 flag = 0;1187 if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {1188 hashclr(sha1);1189 flag |= REF_ISBROKEN;1190 }1191 } else if (read_ref_full(refname.buf, sha1, 1, &flag)) {1192 hashclr(sha1);1193 flag |= REF_ISBROKEN;1194 }1195 add_entry_to_dir(dir,1196 create_ref_entry(refname.buf, sha1, flag, 1));1197 }1198 strbuf_setlen(&refname, dirnamelen);1199 }1200 strbuf_release(&refname);1201 closedir(d);1202}12031204static struct ref_dir *get_loose_refs(struct ref_cache *refs)1205{1206 if (!refs->loose) {1207 /*1208 * Mark the top-level directory complete because we1209 * are about to read the only subdirectory that can1210 * hold references:1211 */1212 refs->loose = create_dir_entry(refs, "", 0, 0);1213 /*1214 * Create an incomplete entry for "refs/":1215 */1216 add_entry_to_dir(get_ref_dir(refs->loose),1217 create_dir_entry(refs, "refs/", 5, 1));1218 }1219 return get_ref_dir(refs->loose);1220}12211222/* We allow "recursive" symbolic refs. Only within reason, though */1223#define MAXDEPTH 51224#define MAXREFLEN (1024)12251226/*1227 * Called by resolve_gitlink_ref_recursive() after it failed to read1228 * from the loose refs in ref_cache refs. Find <refname> in the1229 * packed-refs file for the submodule.1230 */1231static int resolve_gitlink_packed_ref(struct ref_cache *refs,1232 const char *refname, unsigned char *sha1)1233{1234 struct ref_entry *ref;1235 struct ref_dir *dir = get_packed_refs(refs);12361237 ref = find_ref(dir, refname);1238 if (ref == NULL)1239 return -1;12401241 hashcpy(sha1, ref->u.value.sha1);1242 return 0;1243}12441245static int resolve_gitlink_ref_recursive(struct ref_cache *refs,1246 const char *refname, unsigned char *sha1,1247 int recursion)1248{1249 int fd, len;1250 char buffer[128], *p;1251 char *path;12521253 if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)1254 return -1;1255 path = *refs->name1256 ? git_path_submodule(refs->name, "%s", refname)1257 : git_path("%s", refname);1258 fd = open(path, O_RDONLY);1259 if (fd < 0)1260 return resolve_gitlink_packed_ref(refs, refname, sha1);12611262 len = read(fd, buffer, sizeof(buffer)-1);1263 close(fd);1264 if (len < 0)1265 return -1;1266 while (len && isspace(buffer[len-1]))1267 len--;1268 buffer[len] = 0;12691270 /* Was it a detached head or an old-fashioned symlink? */1271 if (!get_sha1_hex(buffer, sha1))1272 return 0;12731274 /* Symref? */1275 if (strncmp(buffer, "ref:", 4))1276 return -1;1277 p = buffer + 4;1278 while (isspace(*p))1279 p++;12801281 return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);1282}12831284int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)1285{1286 int len = strlen(path), retval;1287 char *submodule;1288 struct ref_cache *refs;12891290 while (len && path[len-1] == '/')1291 len--;1292 if (!len)1293 return -1;1294 submodule = xstrndup(path, len);1295 refs = get_ref_cache(submodule);1296 free(submodule);12971298 retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);1299 return retval;1300}13011302/*1303 * Return the ref_entry for the given refname from the packed1304 * references. If it does not exist, return NULL.1305 */1306static struct ref_entry *get_packed_ref(const char *refname)1307{1308 return find_ref(get_packed_refs(&ref_cache), refname);1309}13101311/*1312 * A loose ref file doesn't exist; check for a packed ref. The1313 * options are forwarded from resolve_safe_unsafe().1314 */1315static const char *handle_missing_loose_ref(const char *refname,1316 unsigned char *sha1,1317 int reading,1318 int *flag)1319{1320 struct ref_entry *entry;13211322 /*1323 * The loose reference file does not exist; check for a packed1324 * reference.1325 */1326 entry = get_packed_ref(refname);1327 if (entry) {1328 hashcpy(sha1, entry->u.value.sha1);1329 if (flag)1330 *flag |= REF_ISPACKED;1331 return refname;1332 }1333 /* The reference is not a packed reference, either. */1334 if (reading) {1335 return NULL;1336 } else {1337 hashclr(sha1);1338 return refname;1339 }1340}13411342/* This function needs to return a meaningful errno on failure */1343const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)1344{1345 int depth = MAXDEPTH;1346 ssize_t len;1347 char buffer[256];1348 static char refname_buffer[256];13491350 if (flag)1351 *flag = 0;13521353 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {1354 errno = EINVAL;1355 return NULL;1356 }13571358 for (;;) {1359 char path[PATH_MAX];1360 struct stat st;1361 char *buf;1362 int fd;13631364 if (--depth < 0) {1365 errno = ELOOP;1366 return NULL;1367 }13681369 git_snpath(path, sizeof(path), "%s", refname);13701371 /*1372 * We might have to loop back here to avoid a race1373 * condition: first we lstat() the file, then we try1374 * to read it as a link or as a file. But if somebody1375 * changes the type of the file (file <-> directory1376 * <-> symlink) between the lstat() and reading, then1377 * we don't want to report that as an error but rather1378 * try again starting with the lstat().1379 */1380 stat_ref:1381 if (lstat(path, &st) < 0) {1382 if (errno == ENOENT)1383 return handle_missing_loose_ref(refname, sha1,1384 reading, flag);1385 else1386 return NULL;1387 }13881389 /* Follow "normalized" - ie "refs/.." symlinks by hand */1390 if (S_ISLNK(st.st_mode)) {1391 len = readlink(path, buffer, sizeof(buffer)-1);1392 if (len < 0) {1393 if (errno == ENOENT || errno == EINVAL)1394 /* inconsistent with lstat; retry */1395 goto stat_ref;1396 else1397 return NULL;1398 }1399 buffer[len] = 0;1400 if (starts_with(buffer, "refs/") &&1401 !check_refname_format(buffer, 0)) {1402 strcpy(refname_buffer, buffer);1403 refname = refname_buffer;1404 if (flag)1405 *flag |= REF_ISSYMREF;1406 continue;1407 }1408 }14091410 /* Is it a directory? */1411 if (S_ISDIR(st.st_mode)) {1412 errno = EISDIR;1413 return NULL;1414 }14151416 /*1417 * Anything else, just open it and try to use it as1418 * a ref1419 */1420 fd = open(path, O_RDONLY);1421 if (fd < 0) {1422 if (errno == ENOENT)1423 /* inconsistent with lstat; retry */1424 goto stat_ref;1425 else1426 return NULL;1427 }1428 len = read_in_full(fd, buffer, sizeof(buffer)-1);1429 if (len < 0) {1430 int save_errno = errno;1431 close(fd);1432 errno = save_errno;1433 return NULL;1434 }1435 close(fd);1436 while (len && isspace(buffer[len-1]))1437 len--;1438 buffer[len] = '\0';14391440 /*1441 * Is it a symbolic ref?1442 */1443 if (!starts_with(buffer, "ref:")) {1444 /*1445 * Please note that FETCH_HEAD has a second1446 * line containing other data.1447 */1448 if (get_sha1_hex(buffer, sha1) ||1449 (buffer[40] != '\0' && !isspace(buffer[40]))) {1450 if (flag)1451 *flag |= REF_ISBROKEN;1452 errno = EINVAL;1453 return NULL;1454 }1455 return refname;1456 }1457 if (flag)1458 *flag |= REF_ISSYMREF;1459 buf = buffer + 4;1460 while (isspace(*buf))1461 buf++;1462 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {1463 if (flag)1464 *flag |= REF_ISBROKEN;1465 errno = EINVAL;1466 return NULL;1467 }1468 refname = strcpy(refname_buffer, buf);1469 }1470}14711472char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)1473{1474 const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);1475 return ret ? xstrdup(ret) : NULL;1476}14771478/* The argument to filter_refs */1479struct ref_filter {1480 const char *pattern;1481 each_ref_fn *fn;1482 void *cb_data;1483};14841485int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)1486{1487 if (resolve_ref_unsafe(refname, sha1, reading, flags))1488 return 0;1489 return -1;1490}14911492int read_ref(const char *refname, unsigned char *sha1)1493{1494 return read_ref_full(refname, sha1, 1, NULL);1495}14961497int ref_exists(const char *refname)1498{1499 unsigned char sha1[20];1500 return !!resolve_ref_unsafe(refname, sha1, 1, NULL);1501}15021503static int filter_refs(const char *refname, const unsigned char *sha1, int flags,1504 void *data)1505{1506 struct ref_filter *filter = (struct ref_filter *)data;1507 if (wildmatch(filter->pattern, refname, 0, NULL))1508 return 0;1509 return filter->fn(refname, sha1, flags, filter->cb_data);1510}15111512enum peel_status {1513 /* object was peeled successfully: */1514 PEEL_PEELED = 0,15151516 /*1517 * object cannot be peeled because the named object (or an1518 * object referred to by a tag in the peel chain), does not1519 * exist.1520 */1521 PEEL_INVALID = -1,15221523 /* object cannot be peeled because it is not a tag: */1524 PEEL_NON_TAG = -2,15251526 /* ref_entry contains no peeled value because it is a symref: */1527 PEEL_IS_SYMREF = -3,15281529 /*1530 * ref_entry cannot be peeled because it is broken (i.e., the1531 * symbolic reference cannot even be resolved to an object1532 * name):1533 */1534 PEEL_BROKEN = -41535};15361537/*1538 * Peel the named object; i.e., if the object is a tag, resolve the1539 * tag recursively until a non-tag is found. If successful, store the1540 * result to sha1 and return PEEL_PEELED. If the object is not a tag1541 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,1542 * and leave sha1 unchanged.1543 */1544static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)1545{1546 struct object *o = lookup_unknown_object(name);15471548 if (o->type == OBJ_NONE) {1549 int type = sha1_object_info(name, NULL);1550 if (type < 0 || !object_as_type(o, type, 0))1551 return PEEL_INVALID;1552 }15531554 if (o->type != OBJ_TAG)1555 return PEEL_NON_TAG;15561557 o = deref_tag_noverify(o);1558 if (!o)1559 return PEEL_INVALID;15601561 hashcpy(sha1, o->sha1);1562 return PEEL_PEELED;1563}15641565/*1566 * Peel the entry (if possible) and return its new peel_status. If1567 * repeel is true, re-peel the entry even if there is an old peeled1568 * value that is already stored in it.1569 *1570 * It is OK to call this function with a packed reference entry that1571 * might be stale and might even refer to an object that has since1572 * been garbage-collected. In such a case, if the entry has1573 * REF_KNOWS_PEELED then leave the status unchanged and return1574 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.1575 */1576static enum peel_status peel_entry(struct ref_entry *entry, int repeel)1577{1578 enum peel_status status;15791580 if (entry->flag & REF_KNOWS_PEELED) {1581 if (repeel) {1582 entry->flag &= ~REF_KNOWS_PEELED;1583 hashclr(entry->u.value.peeled);1584 } else {1585 return is_null_sha1(entry->u.value.peeled) ?1586 PEEL_NON_TAG : PEEL_PEELED;1587 }1588 }1589 if (entry->flag & REF_ISBROKEN)1590 return PEEL_BROKEN;1591 if (entry->flag & REF_ISSYMREF)1592 return PEEL_IS_SYMREF;15931594 status = peel_object(entry->u.value.sha1, entry->u.value.peeled);1595 if (status == PEEL_PEELED || status == PEEL_NON_TAG)1596 entry->flag |= REF_KNOWS_PEELED;1597 return status;1598}15991600int peel_ref(const char *refname, unsigned char *sha1)1601{1602 int flag;1603 unsigned char base[20];16041605 if (current_ref && (current_ref->name == refname1606 || !strcmp(current_ref->name, refname))) {1607 if (peel_entry(current_ref, 0))1608 return -1;1609 hashcpy(sha1, current_ref->u.value.peeled);1610 return 0;1611 }16121613 if (read_ref_full(refname, base, 1, &flag))1614 return -1;16151616 /*1617 * If the reference is packed, read its ref_entry from the1618 * cache in the hope that we already know its peeled value.1619 * We only try this optimization on packed references because1620 * (a) forcing the filling of the loose reference cache could1621 * be expensive and (b) loose references anyway usually do not1622 * have REF_KNOWS_PEELED.1623 */1624 if (flag & REF_ISPACKED) {1625 struct ref_entry *r = get_packed_ref(refname);1626 if (r) {1627 if (peel_entry(r, 0))1628 return -1;1629 hashcpy(sha1, r->u.value.peeled);1630 return 0;1631 }1632 }16331634 return peel_object(base, sha1);1635}16361637struct warn_if_dangling_data {1638 FILE *fp;1639 const char *refname;1640 const struct string_list *refnames;1641 const char *msg_fmt;1642};16431644static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,1645 int flags, void *cb_data)1646{1647 struct warn_if_dangling_data *d = cb_data;1648 const char *resolves_to;1649 unsigned char junk[20];16501651 if (!(flags & REF_ISSYMREF))1652 return 0;16531654 resolves_to = resolve_ref_unsafe(refname, junk, 0, NULL);1655 if (!resolves_to1656 || (d->refname1657 ? strcmp(resolves_to, d->refname)1658 : !string_list_has_string(d->refnames, resolves_to))) {1659 return 0;1660 }16611662 fprintf(d->fp, d->msg_fmt, refname);1663 fputc('\n', d->fp);1664 return 0;1665}16661667void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)1668{1669 struct warn_if_dangling_data data;16701671 data.fp = fp;1672 data.refname = refname;1673 data.refnames = NULL;1674 data.msg_fmt = msg_fmt;1675 for_each_rawref(warn_if_dangling_symref, &data);1676}16771678void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)1679{1680 struct warn_if_dangling_data data;16811682 data.fp = fp;1683 data.refname = NULL;1684 data.refnames = refnames;1685 data.msg_fmt = msg_fmt;1686 for_each_rawref(warn_if_dangling_symref, &data);1687}16881689/*1690 * Call fn for each reference in the specified ref_cache, omitting1691 * references not in the containing_dir of base. fn is called for all1692 * references, including broken ones. If fn ever returns a non-zero1693 * value, stop the iteration and return that value; otherwise, return1694 * 0.1695 */1696static int do_for_each_entry(struct ref_cache *refs, const char *base,1697 each_ref_entry_fn fn, void *cb_data)1698{1699 struct packed_ref_cache *packed_ref_cache;1700 struct ref_dir *loose_dir;1701 struct ref_dir *packed_dir;1702 int retval = 0;17031704 /*1705 * We must make sure that all loose refs are read before accessing the1706 * packed-refs file; this avoids a race condition in which loose refs1707 * are migrated to the packed-refs file by a simultaneous process, but1708 * our in-memory view is from before the migration. get_packed_ref_cache()1709 * takes care of making sure our view is up to date with what is on1710 * disk.1711 */1712 loose_dir = get_loose_refs(refs);1713 if (base && *base) {1714 loose_dir = find_containing_dir(loose_dir, base, 0);1715 }1716 if (loose_dir)1717 prime_ref_dir(loose_dir);17181719 packed_ref_cache = get_packed_ref_cache(refs);1720 acquire_packed_ref_cache(packed_ref_cache);1721 packed_dir = get_packed_ref_dir(packed_ref_cache);1722 if (base && *base) {1723 packed_dir = find_containing_dir(packed_dir, base, 0);1724 }17251726 if (packed_dir && loose_dir) {1727 sort_ref_dir(packed_dir);1728 sort_ref_dir(loose_dir);1729 retval = do_for_each_entry_in_dirs(1730 packed_dir, loose_dir, fn, cb_data);1731 } else if (packed_dir) {1732 sort_ref_dir(packed_dir);1733 retval = do_for_each_entry_in_dir(1734 packed_dir, 0, fn, cb_data);1735 } else if (loose_dir) {1736 sort_ref_dir(loose_dir);1737 retval = do_for_each_entry_in_dir(1738 loose_dir, 0, fn, cb_data);1739 }17401741 release_packed_ref_cache(packed_ref_cache);1742 return retval;1743}17441745/*1746 * Call fn for each reference in the specified ref_cache for which the1747 * refname begins with base. If trim is non-zero, then trim that many1748 * characters off the beginning of each refname before passing the1749 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include1750 * broken references in the iteration. If fn ever returns a non-zero1751 * value, stop the iteration and return that value; otherwise, return1752 * 0.1753 */1754static int do_for_each_ref(struct ref_cache *refs, const char *base,1755 each_ref_fn fn, int trim, int flags, void *cb_data)1756{1757 struct ref_entry_cb data;1758 data.base = base;1759 data.trim = trim;1760 data.flags = flags;1761 data.fn = fn;1762 data.cb_data = cb_data;17631764 return do_for_each_entry(refs, base, do_one_ref, &data);1765}17661767static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)1768{1769 unsigned char sha1[20];1770 int flag;17711772 if (submodule) {1773 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)1774 return fn("HEAD", sha1, 0, cb_data);17751776 return 0;1777 }17781779 if (!read_ref_full("HEAD", sha1, 1, &flag))1780 return fn("HEAD", sha1, flag, cb_data);17811782 return 0;1783}17841785int head_ref(each_ref_fn fn, void *cb_data)1786{1787 return do_head_ref(NULL, fn, cb_data);1788}17891790int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)1791{1792 return do_head_ref(submodule, fn, cb_data);1793}17941795int for_each_ref(each_ref_fn fn, void *cb_data)1796{1797 return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);1798}17991800int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)1801{1802 return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);1803}18041805int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)1806{1807 return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);1808}18091810int for_each_ref_in_submodule(const char *submodule, const char *prefix,1811 each_ref_fn fn, void *cb_data)1812{1813 return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);1814}18151816int for_each_tag_ref(each_ref_fn fn, void *cb_data)1817{1818 return for_each_ref_in("refs/tags/", fn, cb_data);1819}18201821int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)1822{1823 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);1824}18251826int for_each_branch_ref(each_ref_fn fn, void *cb_data)1827{1828 return for_each_ref_in("refs/heads/", fn, cb_data);1829}18301831int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)1832{1833 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);1834}18351836int for_each_remote_ref(each_ref_fn fn, void *cb_data)1837{1838 return for_each_ref_in("refs/remotes/", fn, cb_data);1839}18401841int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)1842{1843 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);1844}18451846int for_each_replace_ref(each_ref_fn fn, void *cb_data)1847{1848 return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);1849}18501851int head_ref_namespaced(each_ref_fn fn, void *cb_data)1852{1853 struct strbuf buf = STRBUF_INIT;1854 int ret = 0;1855 unsigned char sha1[20];1856 int flag;18571858 strbuf_addf(&buf, "%sHEAD", get_git_namespace());1859 if (!read_ref_full(buf.buf, sha1, 1, &flag))1860 ret = fn(buf.buf, sha1, flag, cb_data);1861 strbuf_release(&buf);18621863 return ret;1864}18651866int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)1867{1868 struct strbuf buf = STRBUF_INIT;1869 int ret;1870 strbuf_addf(&buf, "%srefs/", get_git_namespace());1871 ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);1872 strbuf_release(&buf);1873 return ret;1874}18751876int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,1877 const char *prefix, void *cb_data)1878{1879 struct strbuf real_pattern = STRBUF_INIT;1880 struct ref_filter filter;1881 int ret;18821883 if (!prefix && !starts_with(pattern, "refs/"))1884 strbuf_addstr(&real_pattern, "refs/");1885 else if (prefix)1886 strbuf_addstr(&real_pattern, prefix);1887 strbuf_addstr(&real_pattern, pattern);18881889 if (!has_glob_specials(pattern)) {1890 /* Append implied '/' '*' if not present. */1891 if (real_pattern.buf[real_pattern.len - 1] != '/')1892 strbuf_addch(&real_pattern, '/');1893 /* No need to check for '*', there is none. */1894 strbuf_addch(&real_pattern, '*');1895 }18961897 filter.pattern = real_pattern.buf;1898 filter.fn = fn;1899 filter.cb_data = cb_data;1900 ret = for_each_ref(filter_refs, &filter);19011902 strbuf_release(&real_pattern);1903 return ret;1904}19051906int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)1907{1908 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);1909}19101911int for_each_rawref(each_ref_fn fn, void *cb_data)1912{1913 return do_for_each_ref(&ref_cache, "", fn, 0,1914 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);1915}19161917const char *prettify_refname(const char *name)1918{1919 return name + (1920 starts_with(name, "refs/heads/") ? 11 :1921 starts_with(name, "refs/tags/") ? 10 :1922 starts_with(name, "refs/remotes/") ? 13 :1923 0);1924}19251926static const char *ref_rev_parse_rules[] = {1927 "%.*s",1928 "refs/%.*s",1929 "refs/tags/%.*s",1930 "refs/heads/%.*s",1931 "refs/remotes/%.*s",1932 "refs/remotes/%.*s/HEAD",1933 NULL1934};19351936int refname_match(const char *abbrev_name, const char *full_name)1937{1938 const char **p;1939 const int abbrev_name_len = strlen(abbrev_name);19401941 for (p = ref_rev_parse_rules; *p; p++) {1942 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {1943 return 1;1944 }1945 }19461947 return 0;1948}19491950/* This function should make sure errno is meaningful on error */1951static struct ref_lock *verify_lock(struct ref_lock *lock,1952 const unsigned char *old_sha1, int mustexist)1953{1954 if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {1955 int save_errno = errno;1956 error("Can't verify ref %s", lock->ref_name);1957 unlock_ref(lock);1958 errno = save_errno;1959 return NULL;1960 }1961 if (hashcmp(lock->old_sha1, old_sha1)) {1962 error("Ref %s is at %s but expected %s", lock->ref_name,1963 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));1964 unlock_ref(lock);1965 errno = EBUSY;1966 return NULL;1967 }1968 return lock;1969}19701971static int remove_empty_directories(const char *file)1972{1973 /* we want to create a file but there is a directory there;1974 * if that is an empty directory (or a directory that contains1975 * only empty directories), remove them.1976 */1977 struct strbuf path;1978 int result, save_errno;19791980 strbuf_init(&path, 20);1981 strbuf_addstr(&path, file);19821983 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);1984 save_errno = errno;19851986 strbuf_release(&path);1987 errno = save_errno;19881989 return result;1990}19911992/*1993 * *string and *len will only be substituted, and *string returned (for1994 * later free()ing) if the string passed in is a magic short-hand form1995 * to name a branch.1996 */1997static char *substitute_branch_name(const char **string, int *len)1998{1999 struct strbuf buf = STRBUF_INIT;2000 int ret = interpret_branch_name(*string, *len, &buf);20012002 if (ret == *len) {2003 size_t size;2004 *string = strbuf_detach(&buf, &size);2005 *len = size;2006 return (char *)*string;2007 }20082009 return NULL;2010}20112012int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)2013{2014 char *last_branch = substitute_branch_name(&str, &len);2015 const char **p, *r;2016 int refs_found = 0;20172018 *ref = NULL;2019 for (p = ref_rev_parse_rules; *p; p++) {2020 char fullref[PATH_MAX];2021 unsigned char sha1_from_ref[20];2022 unsigned char *this_result;2023 int flag;20242025 this_result = refs_found ? sha1_from_ref : sha1;2026 mksnpath(fullref, sizeof(fullref), *p, len, str);2027 r = resolve_ref_unsafe(fullref, this_result, 1, &flag);2028 if (r) {2029 if (!refs_found++)2030 *ref = xstrdup(r);2031 if (!warn_ambiguous_refs)2032 break;2033 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {2034 warning("ignoring dangling symref %s.", fullref);2035 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {2036 warning("ignoring broken ref %s.", fullref);2037 }2038 }2039 free(last_branch);2040 return refs_found;2041}20422043int dwim_log(const char *str, int len, unsigned char *sha1, char **log)2044{2045 char *last_branch = substitute_branch_name(&str, &len);2046 const char **p;2047 int logs_found = 0;20482049 *log = NULL;2050 for (p = ref_rev_parse_rules; *p; p++) {2051 unsigned char hash[20];2052 char path[PATH_MAX];2053 const char *ref, *it;20542055 mksnpath(path, sizeof(path), *p, len, str);2056 ref = resolve_ref_unsafe(path, hash, 1, NULL);2057 if (!ref)2058 continue;2059 if (reflog_exists(path))2060 it = path;2061 else if (strcmp(ref, path) && reflog_exists(ref))2062 it = ref;2063 else2064 continue;2065 if (!logs_found++) {2066 *log = xstrdup(it);2067 hashcpy(sha1, hash);2068 }2069 if (!warn_ambiguous_refs)2070 break;2071 }2072 free(last_branch);2073 return logs_found;2074}20752076/* This function should make sure errno is meaningful on error */2077static struct ref_lock *lock_ref_sha1_basic(const char *refname,2078 const unsigned char *old_sha1,2079 int flags, int *type_p)2080{2081 char *ref_file;2082 const char *orig_refname = refname;2083 struct ref_lock *lock;2084 int last_errno = 0;2085 int type, lflags;2086 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));2087 int missing = 0;2088 int attempts_remaining = 3;20892090 lock = xcalloc(1, sizeof(struct ref_lock));2091 lock->lock_fd = -1;20922093 refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);2094 if (!refname && errno == EISDIR) {2095 /* we are trying to lock foo but we used to2096 * have foo/bar which now does not exist;2097 * it is normal for the empty directory 'foo'2098 * to remain.2099 */2100 ref_file = git_path("%s", orig_refname);2101 if (remove_empty_directories(ref_file)) {2102 last_errno = errno;2103 error("there are still refs under '%s'", orig_refname);2104 goto error_return;2105 }2106 refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);2107 }2108 if (type_p)2109 *type_p = type;2110 if (!refname) {2111 last_errno = errno;2112 error("unable to resolve reference %s: %s",2113 orig_refname, strerror(errno));2114 goto error_return;2115 }2116 missing = is_null_sha1(lock->old_sha1);2117 /* When the ref did not exist and we are creating it,2118 * make sure there is no existing ref that is packed2119 * whose name begins with our refname, nor a ref whose2120 * name is a proper prefix of our refname.2121 */2122 if (missing &&2123 !is_refname_available(refname, NULL, get_packed_refs(&ref_cache))) {2124 last_errno = ENOTDIR;2125 goto error_return;2126 }21272128 lock->lk = xcalloc(1, sizeof(struct lock_file));21292130 lflags = 0;2131 if (flags & REF_NODEREF) {2132 refname = orig_refname;2133 lflags |= LOCK_NODEREF;2134 }2135 lock->ref_name = xstrdup(refname);2136 lock->orig_ref_name = xstrdup(orig_refname);2137 ref_file = git_path("%s", refname);2138 if (missing)2139 lock->force_write = 1;2140 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))2141 lock->force_write = 1;21422143 retry:2144 switch (safe_create_leading_directories(ref_file)) {2145 case SCLD_OK:2146 break; /* success */2147 case SCLD_VANISHED:2148 if (--attempts_remaining > 0)2149 goto retry;2150 /* fall through */2151 default:2152 last_errno = errno;2153 error("unable to create directory for %s", ref_file);2154 goto error_return;2155 }21562157 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);2158 if (lock->lock_fd < 0) {2159 if (errno == ENOENT && --attempts_remaining > 0)2160 /*2161 * Maybe somebody just deleted one of the2162 * directories leading to ref_file. Try2163 * again:2164 */2165 goto retry;2166 else2167 unable_to_lock_index_die(ref_file, errno);2168 }2169 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;21702171 error_return:2172 unlock_ref(lock);2173 errno = last_errno;2174 return NULL;2175}21762177struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)2178{2179 char refpath[PATH_MAX];2180 if (check_refname_format(refname, 0))2181 return NULL;2182 strcpy(refpath, mkpath("refs/%s", refname));2183 return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);2184}21852186struct ref_lock *lock_any_ref_for_update(const char *refname,2187 const unsigned char *old_sha1,2188 int flags, int *type_p)2189{2190 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))2191 return NULL;2192 return lock_ref_sha1_basic(refname, old_sha1, flags, type_p);2193}21942195/*2196 * Write an entry to the packed-refs file for the specified refname.2197 * If peeled is non-NULL, write it as the entry's peeled value.2198 */2199static void write_packed_entry(int fd, char *refname, unsigned char *sha1,2200 unsigned char *peeled)2201{2202 char line[PATH_MAX + 100];2203 int len;22042205 len = snprintf(line, sizeof(line), "%s %s\n",2206 sha1_to_hex(sha1), refname);2207 /* this should not happen but just being defensive */2208 if (len > sizeof(line))2209 die("too long a refname '%s'", refname);2210 write_or_die(fd, line, len);22112212 if (peeled) {2213 if (snprintf(line, sizeof(line), "^%s\n",2214 sha1_to_hex(peeled)) != PEELED_LINE_LENGTH)2215 die("internal error");2216 write_or_die(fd, line, PEELED_LINE_LENGTH);2217 }2218}22192220/*2221 * An each_ref_entry_fn that writes the entry to a packed-refs file.2222 */2223static int write_packed_entry_fn(struct ref_entry *entry, void *cb_data)2224{2225 int *fd = cb_data;2226 enum peel_status peel_status = peel_entry(entry, 0);22272228 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)2229 error("internal error: %s is not a valid packed reference!",2230 entry->name);2231 write_packed_entry(*fd, entry->name, entry->u.value.sha1,2232 peel_status == PEEL_PEELED ?2233 entry->u.value.peeled : NULL);2234 return 0;2235}22362237/* This should return a meaningful errno on failure */2238int lock_packed_refs(int flags)2239{2240 struct packed_ref_cache *packed_ref_cache;22412242 if (hold_lock_file_for_update(&packlock, git_path("packed-refs"), flags) < 0)2243 return -1;2244 /*2245 * Get the current packed-refs while holding the lock. If the2246 * packed-refs file has been modified since we last read it,2247 * this will automatically invalidate the cache and re-read2248 * the packed-refs file.2249 */2250 packed_ref_cache = get_packed_ref_cache(&ref_cache);2251 packed_ref_cache->lock = &packlock;2252 /* Increment the reference count to prevent it from being freed: */2253 acquire_packed_ref_cache(packed_ref_cache);2254 return 0;2255}22562257/*2258 * Commit the packed refs changes.2259 * On error we must make sure that errno contains a meaningful value.2260 */2261int commit_packed_refs(void)2262{2263 struct packed_ref_cache *packed_ref_cache =2264 get_packed_ref_cache(&ref_cache);2265 int error = 0;2266 int save_errno = 0;22672268 if (!packed_ref_cache->lock)2269 die("internal error: packed-refs not locked");2270 write_or_die(packed_ref_cache->lock->fd,2271 PACKED_REFS_HEADER, strlen(PACKED_REFS_HEADER));22722273 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),2274 0, write_packed_entry_fn,2275 &packed_ref_cache->lock->fd);2276 if (commit_lock_file(packed_ref_cache->lock)) {2277 save_errno = errno;2278 error = -1;2279 }2280 packed_ref_cache->lock = NULL;2281 release_packed_ref_cache(packed_ref_cache);2282 errno = save_errno;2283 return error;2284}22852286void rollback_packed_refs(void)2287{2288 struct packed_ref_cache *packed_ref_cache =2289 get_packed_ref_cache(&ref_cache);22902291 if (!packed_ref_cache->lock)2292 die("internal error: packed-refs not locked");2293 rollback_lock_file(packed_ref_cache->lock);2294 packed_ref_cache->lock = NULL;2295 release_packed_ref_cache(packed_ref_cache);2296 clear_packed_ref_cache(&ref_cache);2297}22982299struct ref_to_prune {2300 struct ref_to_prune *next;2301 unsigned char sha1[20];2302 char name[FLEX_ARRAY];2303};23042305struct pack_refs_cb_data {2306 unsigned int flags;2307 struct ref_dir *packed_refs;2308 struct ref_to_prune *ref_to_prune;2309};23102311/*2312 * An each_ref_entry_fn that is run over loose references only. If2313 * the loose reference can be packed, add an entry in the packed ref2314 * cache. If the reference should be pruned, also add it to2315 * ref_to_prune in the pack_refs_cb_data.2316 */2317static int pack_if_possible_fn(struct ref_entry *entry, void *cb_data)2318{2319 struct pack_refs_cb_data *cb = cb_data;2320 enum peel_status peel_status;2321 struct ref_entry *packed_entry;2322 int is_tag_ref = starts_with(entry->name, "refs/tags/");23232324 /* ALWAYS pack tags */2325 if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)2326 return 0;23272328 /* Do not pack symbolic or broken refs: */2329 if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))2330 return 0;23312332 /* Add a packed ref cache entry equivalent to the loose entry. */2333 peel_status = peel_entry(entry, 1);2334 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)2335 die("internal error peeling reference %s (%s)",2336 entry->name, sha1_to_hex(entry->u.value.sha1));2337 packed_entry = find_ref(cb->packed_refs, entry->name);2338 if (packed_entry) {2339 /* Overwrite existing packed entry with info from loose entry */2340 packed_entry->flag = REF_ISPACKED | REF_KNOWS_PEELED;2341 hashcpy(packed_entry->u.value.sha1, entry->u.value.sha1);2342 } else {2343 packed_entry = create_ref_entry(entry->name, entry->u.value.sha1,2344 REF_ISPACKED | REF_KNOWS_PEELED, 0);2345 add_ref(cb->packed_refs, packed_entry);2346 }2347 hashcpy(packed_entry->u.value.peeled, entry->u.value.peeled);23482349 /* Schedule the loose reference for pruning if requested. */2350 if ((cb->flags & PACK_REFS_PRUNE)) {2351 int namelen = strlen(entry->name) + 1;2352 struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);2353 hashcpy(n->sha1, entry->u.value.sha1);2354 strcpy(n->name, entry->name);2355 n->next = cb->ref_to_prune;2356 cb->ref_to_prune = n;2357 }2358 return 0;2359}23602361/*2362 * Remove empty parents, but spare refs/ and immediate subdirs.2363 * Note: munges *name.2364 */2365static void try_remove_empty_parents(char *name)2366{2367 char *p, *q;2368 int i;2369 p = name;2370 for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */2371 while (*p && *p != '/')2372 p++;2373 /* tolerate duplicate slashes; see check_refname_format() */2374 while (*p == '/')2375 p++;2376 }2377 for (q = p; *q; q++)2378 ;2379 while (1) {2380 while (q > p && *q != '/')2381 q--;2382 while (q > p && *(q-1) == '/')2383 q--;2384 if (q == p)2385 break;2386 *q = '\0';2387 if (rmdir(git_path("%s", name)))2388 break;2389 }2390}23912392/* make sure nobody touched the ref, and unlink */2393static void prune_ref(struct ref_to_prune *r)2394{2395 struct ref_lock *lock = lock_any_ref_for_update(r->name, r->sha1,2396 0, NULL);23972398 if (lock) {2399 unlink_or_warn(git_path("%s", r->name));2400 unlock_ref(lock);2401 try_remove_empty_parents(r->name);2402 }2403}24042405static void prune_refs(struct ref_to_prune *r)2406{2407 while (r) {2408 prune_ref(r);2409 r = r->next;2410 }2411}24122413int pack_refs(unsigned int flags)2414{2415 struct pack_refs_cb_data cbdata;24162417 memset(&cbdata, 0, sizeof(cbdata));2418 cbdata.flags = flags;24192420 lock_packed_refs(LOCK_DIE_ON_ERROR);2421 cbdata.packed_refs = get_packed_refs(&ref_cache);24222423 do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,2424 pack_if_possible_fn, &cbdata);24252426 if (commit_packed_refs())2427 die_errno("unable to overwrite old ref-pack file");24282429 prune_refs(cbdata.ref_to_prune);2430 return 0;2431}24322433/*2434 * If entry is no longer needed in packed-refs, add it to the string2435 * list pointed to by cb_data. Reasons for deleting entries:2436 *2437 * - Entry is broken.2438 * - Entry is overridden by a loose ref.2439 * - Entry does not point at a valid object.2440 *2441 * In the first and third cases, also emit an error message because these2442 * are indications of repository corruption.2443 */2444static int curate_packed_ref_fn(struct ref_entry *entry, void *cb_data)2445{2446 struct string_list *refs_to_delete = cb_data;24472448 if (entry->flag & REF_ISBROKEN) {2449 /* This shouldn't happen to packed refs. */2450 error("%s is broken!", entry->name);2451 string_list_append(refs_to_delete, entry->name);2452 return 0;2453 }2454 if (!has_sha1_file(entry->u.value.sha1)) {2455 unsigned char sha1[20];2456 int flags;24572458 if (read_ref_full(entry->name, sha1, 0, &flags))2459 /* We should at least have found the packed ref. */2460 die("Internal error");2461 if ((flags & REF_ISSYMREF) || !(flags & REF_ISPACKED)) {2462 /*2463 * This packed reference is overridden by a2464 * loose reference, so it is OK that its value2465 * is no longer valid; for example, it might2466 * refer to an object that has been garbage2467 * collected. For this purpose we don't even2468 * care whether the loose reference itself is2469 * invalid, broken, symbolic, etc. Silently2470 * remove the packed reference.2471 */2472 string_list_append(refs_to_delete, entry->name);2473 return 0;2474 }2475 /*2476 * There is no overriding loose reference, so the fact2477 * that this reference doesn't refer to a valid object2478 * indicates some kind of repository corruption.2479 * Report the problem, then omit the reference from2480 * the output.2481 */2482 error("%s does not point to a valid object!", entry->name);2483 string_list_append(refs_to_delete, entry->name);2484 return 0;2485 }24862487 return 0;2488}24892490int repack_without_refs(const char **refnames, int n, struct strbuf *err)2491{2492 struct ref_dir *packed;2493 struct string_list refs_to_delete = STRING_LIST_INIT_DUP;2494 struct string_list_item *ref_to_delete;2495 int i, ret, removed = 0;24962497 /* Look for a packed ref */2498 for (i = 0; i < n; i++)2499 if (get_packed_ref(refnames[i]))2500 break;25012502 /* Avoid locking if we have nothing to do */2503 if (i == n)2504 return 0; /* no refname exists in packed refs */25052506 if (lock_packed_refs(0)) {2507 if (err) {2508 unable_to_lock_message(git_path("packed-refs"), errno,2509 err);2510 return -1;2511 }2512 unable_to_lock_error(git_path("packed-refs"), errno);2513 return error("cannot delete '%s' from packed refs", refnames[i]);2514 }2515 packed = get_packed_refs(&ref_cache);25162517 /* Remove refnames from the cache */2518 for (i = 0; i < n; i++)2519 if (remove_entry(packed, refnames[i]) != -1)2520 removed = 1;2521 if (!removed) {2522 /*2523 * All packed entries disappeared while we were2524 * acquiring the lock.2525 */2526 rollback_packed_refs();2527 return 0;2528 }25292530 /* Remove any other accumulated cruft */2531 do_for_each_entry_in_dir(packed, 0, curate_packed_ref_fn, &refs_to_delete);2532 for_each_string_list_item(ref_to_delete, &refs_to_delete) {2533 if (remove_entry(packed, ref_to_delete->string) == -1)2534 die("internal error");2535 }25362537 /* Write what remains */2538 ret = commit_packed_refs();2539 if (ret && err)2540 strbuf_addf(err, "unable to overwrite old ref-pack file: %s",2541 strerror(errno));2542 return ret;2543}25442545static int repack_without_ref(const char *refname)2546{2547 return repack_without_refs(&refname, 1, NULL);2548}25492550static int delete_ref_loose(struct ref_lock *lock, int flag)2551{2552 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {2553 /* loose */2554 int err, i = strlen(lock->lk->filename) - 5; /* .lock */25552556 lock->lk->filename[i] = 0;2557 err = unlink_or_warn(lock->lk->filename);2558 lock->lk->filename[i] = '.';2559 if (err && errno != ENOENT)2560 return 1;2561 }2562 return 0;2563}25642565int delete_ref(const char *refname, const unsigned char *sha1, int delopt)2566{2567 struct ref_lock *lock;2568 int ret = 0, flag = 0;25692570 lock = lock_ref_sha1_basic(refname, sha1, delopt, &flag);2571 if (!lock)2572 return 1;2573 ret |= delete_ref_loose(lock, flag);25742575 /* removing the loose one could have resurrected an earlier2576 * packed one. Also, if it was not loose we need to repack2577 * without it.2578 */2579 ret |= repack_without_ref(lock->ref_name);25802581 unlink_or_warn(git_path("logs/%s", lock->ref_name));2582 clear_loose_ref_cache(&ref_cache);2583 unlock_ref(lock);2584 return ret;2585}25862587/*2588 * People using contrib's git-new-workdir have .git/logs/refs ->2589 * /some/other/path/.git/logs/refs, and that may live on another device.2590 *2591 * IOW, to avoid cross device rename errors, the temporary renamed log must2592 * live into logs/refs.2593 */2594#define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"25952596static int rename_tmp_log(const char *newrefname)2597{2598 int attempts_remaining = 4;25992600 retry:2601 switch (safe_create_leading_directories(git_path("logs/%s", newrefname))) {2602 case SCLD_OK:2603 break; /* success */2604 case SCLD_VANISHED:2605 if (--attempts_remaining > 0)2606 goto retry;2607 /* fall through */2608 default:2609 error("unable to create directory for %s", newrefname);2610 return -1;2611 }26122613 if (rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {2614 if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {2615 /*2616 * rename(a, b) when b is an existing2617 * directory ought to result in ISDIR, but2618 * Solaris 5.8 gives ENOTDIR. Sheesh.2619 */2620 if (remove_empty_directories(git_path("logs/%s", newrefname))) {2621 error("Directory not empty: logs/%s", newrefname);2622 return -1;2623 }2624 goto retry;2625 } else if (errno == ENOENT && --attempts_remaining > 0) {2626 /*2627 * Maybe another process just deleted one of2628 * the directories in the path to newrefname.2629 * Try again from the beginning.2630 */2631 goto retry;2632 } else {2633 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",2634 newrefname, strerror(errno));2635 return -1;2636 }2637 }2638 return 0;2639}26402641int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)2642{2643 unsigned char sha1[20], orig_sha1[20];2644 int flag = 0, logmoved = 0;2645 struct ref_lock *lock;2646 struct stat loginfo;2647 int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);2648 const char *symref = NULL;26492650 if (log && S_ISLNK(loginfo.st_mode))2651 return error("reflog for %s is a symlink", oldrefname);26522653 symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);2654 if (flag & REF_ISSYMREF)2655 return error("refname %s is a symbolic ref, renaming it is not supported",2656 oldrefname);2657 if (!symref)2658 return error("refname %s not found", oldrefname);26592660 if (!is_refname_available(newrefname, oldrefname, get_packed_refs(&ref_cache)))2661 return 1;26622663 if (!is_refname_available(newrefname, oldrefname, get_loose_refs(&ref_cache)))2664 return 1;26652666 if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))2667 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",2668 oldrefname, strerror(errno));26692670 if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {2671 error("unable to delete old %s", oldrefname);2672 goto rollback;2673 }26742675 if (!read_ref_full(newrefname, sha1, 1, &flag) &&2676 delete_ref(newrefname, sha1, REF_NODEREF)) {2677 if (errno==EISDIR) {2678 if (remove_empty_directories(git_path("%s", newrefname))) {2679 error("Directory not empty: %s", newrefname);2680 goto rollback;2681 }2682 } else {2683 error("unable to delete existing %s", newrefname);2684 goto rollback;2685 }2686 }26872688 if (log && rename_tmp_log(newrefname))2689 goto rollback;26902691 logmoved = log;26922693 lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);2694 if (!lock) {2695 error("unable to lock %s for update", newrefname);2696 goto rollback;2697 }2698 lock->force_write = 1;2699 hashcpy(lock->old_sha1, orig_sha1);2700 if (write_ref_sha1(lock, orig_sha1, logmsg)) {2701 error("unable to write current sha1 into %s", newrefname);2702 goto rollback;2703 }27042705 return 0;27062707 rollback:2708 lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);2709 if (!lock) {2710 error("unable to lock %s for rollback", oldrefname);2711 goto rollbacklog;2712 }27132714 lock->force_write = 1;2715 flag = log_all_ref_updates;2716 log_all_ref_updates = 0;2717 if (write_ref_sha1(lock, orig_sha1, NULL))2718 error("unable to write current sha1 into %s", oldrefname);2719 log_all_ref_updates = flag;27202721 rollbacklog:2722 if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))2723 error("unable to restore logfile %s from %s: %s",2724 oldrefname, newrefname, strerror(errno));2725 if (!logmoved && log &&2726 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))2727 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",2728 oldrefname, strerror(errno));27292730 return 1;2731}27322733int close_ref(struct ref_lock *lock)2734{2735 if (close_lock_file(lock->lk))2736 return -1;2737 lock->lock_fd = -1;2738 return 0;2739}27402741int commit_ref(struct ref_lock *lock)2742{2743 if (commit_lock_file(lock->lk))2744 return -1;2745 lock->lock_fd = -1;2746 return 0;2747}27482749void unlock_ref(struct ref_lock *lock)2750{2751 /* Do not free lock->lk -- atexit() still looks at them */2752 if (lock->lk)2753 rollback_lock_file(lock->lk);2754 free(lock->ref_name);2755 free(lock->orig_ref_name);2756 free(lock);2757}27582759/*2760 * copy the reflog message msg to buf, which has been allocated sufficiently2761 * large, while cleaning up the whitespaces. Especially, convert LF to space,2762 * because reflog file is one line per entry.2763 */2764static int copy_msg(char *buf, const char *msg)2765{2766 char *cp = buf;2767 char c;2768 int wasspace = 1;27692770 *cp++ = '\t';2771 while ((c = *msg++)) {2772 if (wasspace && isspace(c))2773 continue;2774 wasspace = isspace(c);2775 if (wasspace)2776 c = ' ';2777 *cp++ = c;2778 }2779 while (buf < cp && isspace(cp[-1]))2780 cp--;2781 *cp++ = '\n';2782 return cp - buf;2783}27842785/* This function must set a meaningful errno on failure */2786int log_ref_setup(const char *refname, char *logfile, int bufsize)2787{2788 int logfd, oflags = O_APPEND | O_WRONLY;27892790 git_snpath(logfile, bufsize, "logs/%s", refname);2791 if (log_all_ref_updates &&2792 (starts_with(refname, "refs/heads/") ||2793 starts_with(refname, "refs/remotes/") ||2794 starts_with(refname, "refs/notes/") ||2795 !strcmp(refname, "HEAD"))) {2796 if (safe_create_leading_directories(logfile) < 0) {2797 int save_errno = errno;2798 error("unable to create directory for %s", logfile);2799 errno = save_errno;2800 return -1;2801 }2802 oflags |= O_CREAT;2803 }28042805 logfd = open(logfile, oflags, 0666);2806 if (logfd < 0) {2807 if (!(oflags & O_CREAT) && errno == ENOENT)2808 return 0;28092810 if ((oflags & O_CREAT) && errno == EISDIR) {2811 if (remove_empty_directories(logfile)) {2812 int save_errno = errno;2813 error("There are still logs under '%s'",2814 logfile);2815 errno = save_errno;2816 return -1;2817 }2818 logfd = open(logfile, oflags, 0666);2819 }28202821 if (logfd < 0) {2822 int save_errno = errno;2823 error("Unable to append to %s: %s", logfile,2824 strerror(errno));2825 errno = save_errno;2826 return -1;2827 }2828 }28292830 adjust_shared_perm(logfile);2831 close(logfd);2832 return 0;2833}28342835static int log_ref_write(const char *refname, const unsigned char *old_sha1,2836 const unsigned char *new_sha1, const char *msg)2837{2838 int logfd, result, written, oflags = O_APPEND | O_WRONLY;2839 unsigned maxlen, len;2840 int msglen;2841 char log_file[PATH_MAX];2842 char *logrec;2843 const char *committer;28442845 if (log_all_ref_updates < 0)2846 log_all_ref_updates = !is_bare_repository();28472848 result = log_ref_setup(refname, log_file, sizeof(log_file));2849 if (result)2850 return result;28512852 logfd = open(log_file, oflags);2853 if (logfd < 0)2854 return 0;2855 msglen = msg ? strlen(msg) : 0;2856 committer = git_committer_info(0);2857 maxlen = strlen(committer) + msglen + 100;2858 logrec = xmalloc(maxlen);2859 len = sprintf(logrec, "%s %s %s\n",2860 sha1_to_hex(old_sha1),2861 sha1_to_hex(new_sha1),2862 committer);2863 if (msglen)2864 len += copy_msg(logrec + len - 1, msg) - 1;2865 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;2866 free(logrec);2867 if (written != len) {2868 int save_errno = errno;2869 close(logfd);2870 error("Unable to append to %s", log_file);2871 errno = save_errno;2872 return -1;2873 }2874 if (close(logfd)) {2875 int save_errno = errno;2876 error("Unable to append to %s", log_file);2877 errno = save_errno;2878 return -1;2879 }2880 return 0;2881}28822883int is_branch(const char *refname)2884{2885 return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");2886}28872888/* This function must return a meaningful errno */2889int write_ref_sha1(struct ref_lock *lock,2890 const unsigned char *sha1, const char *logmsg)2891{2892 static char term = '\n';2893 struct object *o;28942895 if (!lock) {2896 errno = EINVAL;2897 return -1;2898 }2899 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {2900 unlock_ref(lock);2901 return 0;2902 }2903 o = parse_object(sha1);2904 if (!o) {2905 error("Trying to write ref %s with nonexistent object %s",2906 lock->ref_name, sha1_to_hex(sha1));2907 unlock_ref(lock);2908 errno = EINVAL;2909 return -1;2910 }2911 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {2912 error("Trying to write non-commit object %s to branch %s",2913 sha1_to_hex(sha1), lock->ref_name);2914 unlock_ref(lock);2915 errno = EINVAL;2916 return -1;2917 }2918 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||2919 write_in_full(lock->lock_fd, &term, 1) != 1 ||2920 close_ref(lock) < 0) {2921 int save_errno = errno;2922 error("Couldn't write %s", lock->lk->filename);2923 unlock_ref(lock);2924 errno = save_errno;2925 return -1;2926 }2927 clear_loose_ref_cache(&ref_cache);2928 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||2929 (strcmp(lock->ref_name, lock->orig_ref_name) &&2930 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {2931 unlock_ref(lock);2932 return -1;2933 }2934 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {2935 /*2936 * Special hack: If a branch is updated directly and HEAD2937 * points to it (may happen on the remote side of a push2938 * for example) then logically the HEAD reflog should be2939 * updated too.2940 * A generic solution implies reverse symref information,2941 * but finding all symrefs pointing to the given branch2942 * would be rather costly for this rare event (the direct2943 * update of a branch) to be worth it. So let's cheat and2944 * check with HEAD only which should cover 99% of all usage2945 * scenarios (even 100% of the default ones).2946 */2947 unsigned char head_sha1[20];2948 int head_flag;2949 const char *head_ref;2950 head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);2951 if (head_ref && (head_flag & REF_ISSYMREF) &&2952 !strcmp(head_ref, lock->ref_name))2953 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);2954 }2955 if (commit_ref(lock)) {2956 error("Couldn't set %s", lock->ref_name);2957 unlock_ref(lock);2958 return -1;2959 }2960 unlock_ref(lock);2961 return 0;2962}29632964int create_symref(const char *ref_target, const char *refs_heads_master,2965 const char *logmsg)2966{2967 const char *lockpath;2968 char ref[1000];2969 int fd, len, written;2970 char *git_HEAD = git_pathdup("%s", ref_target);2971 unsigned char old_sha1[20], new_sha1[20];29722973 if (logmsg && read_ref(ref_target, old_sha1))2974 hashclr(old_sha1);29752976 if (safe_create_leading_directories(git_HEAD) < 0)2977 return error("unable to create directory for %s", git_HEAD);29782979#ifndef NO_SYMLINK_HEAD2980 if (prefer_symlink_refs) {2981 unlink(git_HEAD);2982 if (!symlink(refs_heads_master, git_HEAD))2983 goto done;2984 fprintf(stderr, "no symlink - falling back to symbolic ref\n");2985 }2986#endif29872988 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);2989 if (sizeof(ref) <= len) {2990 error("refname too long: %s", refs_heads_master);2991 goto error_free_return;2992 }2993 lockpath = mkpath("%s.lock", git_HEAD);2994 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);2995 if (fd < 0) {2996 error("Unable to open %s for writing", lockpath);2997 goto error_free_return;2998 }2999 written = write_in_full(fd, ref, len);3000 if (close(fd) != 0 || written != len) {3001 error("Unable to write to %s", lockpath);3002 goto error_unlink_return;3003 }3004 if (rename(lockpath, git_HEAD) < 0) {3005 error("Unable to create %s", git_HEAD);3006 goto error_unlink_return;3007 }3008 if (adjust_shared_perm(git_HEAD)) {3009 error("Unable to fix permissions on %s", lockpath);3010 error_unlink_return:3011 unlink_or_warn(lockpath);3012 error_free_return:3013 free(git_HEAD);3014 return -1;3015 }30163017#ifndef NO_SYMLINK_HEAD3018 done:3019#endif3020 if (logmsg && !read_ref(refs_heads_master, new_sha1))3021 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);30223023 free(git_HEAD);3024 return 0;3025}30263027struct read_ref_at_cb {3028 const char *refname;3029 unsigned long at_time;3030 int cnt;3031 int reccnt;3032 unsigned char *sha1;3033 int found_it;30343035 unsigned char osha1[20];3036 unsigned char nsha1[20];3037 int tz;3038 unsigned long date;3039 char **msg;3040 unsigned long *cutoff_time;3041 int *cutoff_tz;3042 int *cutoff_cnt;3043};30443045static int read_ref_at_ent(unsigned char *osha1, unsigned char *nsha1,3046 const char *email, unsigned long timestamp, int tz,3047 const char *message, void *cb_data)3048{3049 struct read_ref_at_cb *cb = cb_data;30503051 cb->reccnt++;3052 cb->tz = tz;3053 cb->date = timestamp;30543055 if (timestamp <= cb->at_time || cb->cnt == 0) {3056 if (cb->msg)3057 *cb->msg = xstrdup(message);3058 if (cb->cutoff_time)3059 *cb->cutoff_time = timestamp;3060 if (cb->cutoff_tz)3061 *cb->cutoff_tz = tz;3062 if (cb->cutoff_cnt)3063 *cb->cutoff_cnt = cb->reccnt - 1;3064 /*3065 * we have not yet updated cb->[n|o]sha1 so they still3066 * hold the values for the previous record.3067 */3068 if (!is_null_sha1(cb->osha1)) {3069 hashcpy(cb->sha1, nsha1);3070 if (hashcmp(cb->osha1, nsha1))3071 warning("Log for ref %s has gap after %s.",3072 cb->refname, show_date(cb->date, cb->tz, DATE_RFC2822));3073 }3074 else if (cb->date == cb->at_time)3075 hashcpy(cb->sha1, nsha1);3076 else if (hashcmp(nsha1, cb->sha1))3077 warning("Log for ref %s unexpectedly ended on %s.",3078 cb->refname, show_date(cb->date, cb->tz,3079 DATE_RFC2822));3080 hashcpy(cb->osha1, osha1);3081 hashcpy(cb->nsha1, nsha1);3082 cb->found_it = 1;3083 return 1;3084 }3085 hashcpy(cb->osha1, osha1);3086 hashcpy(cb->nsha1, nsha1);3087 if (cb->cnt > 0)3088 cb->cnt--;3089 return 0;3090}30913092static int read_ref_at_ent_oldest(unsigned char *osha1, unsigned char *nsha1,3093 const char *email, unsigned long timestamp,3094 int tz, const char *message, void *cb_data)3095{3096 struct read_ref_at_cb *cb = cb_data;30973098 if (cb->msg)3099 *cb->msg = xstrdup(message);3100 if (cb->cutoff_time)3101 *cb->cutoff_time = timestamp;3102 if (cb->cutoff_tz)3103 *cb->cutoff_tz = tz;3104 if (cb->cutoff_cnt)3105 *cb->cutoff_cnt = cb->reccnt;3106 hashcpy(cb->sha1, osha1);3107 if (is_null_sha1(cb->sha1))3108 hashcpy(cb->sha1, nsha1);3109 /* We just want the first entry */3110 return 1;3111}31123113int read_ref_at(const char *refname, unsigned long at_time, int cnt,3114 unsigned char *sha1, char **msg,3115 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)3116{3117 struct read_ref_at_cb cb;31183119 memset(&cb, 0, sizeof(cb));3120 cb.refname = refname;3121 cb.at_time = at_time;3122 cb.cnt = cnt;3123 cb.msg = msg;3124 cb.cutoff_time = cutoff_time;3125 cb.cutoff_tz = cutoff_tz;3126 cb.cutoff_cnt = cutoff_cnt;3127 cb.sha1 = sha1;31283129 for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);31303131 if (!cb.reccnt)3132 die("Log for %s is empty.", refname);3133 if (cb.found_it)3134 return 0;31353136 for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);31373138 return 1;3139}31403141int reflog_exists(const char *refname)3142{3143 struct stat st;31443145 return !lstat(git_path("logs/%s", refname), &st) &&3146 S_ISREG(st.st_mode);3147}31483149int delete_reflog(const char *refname)3150{3151 return remove_path(git_path("logs/%s", refname));3152}31533154static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)3155{3156 unsigned char osha1[20], nsha1[20];3157 char *email_end, *message;3158 unsigned long timestamp;3159 int tz;31603161 /* old SP new SP name <email> SP time TAB msg LF */3162 if (sb->len < 83 || sb->buf[sb->len - 1] != '\n' ||3163 get_sha1_hex(sb->buf, osha1) || sb->buf[40] != ' ' ||3164 get_sha1_hex(sb->buf + 41, nsha1) || sb->buf[81] != ' ' ||3165 !(email_end = strchr(sb->buf + 82, '>')) ||3166 email_end[1] != ' ' ||3167 !(timestamp = strtoul(email_end + 2, &message, 10)) ||3168 !message || message[0] != ' ' ||3169 (message[1] != '+' && message[1] != '-') ||3170 !isdigit(message[2]) || !isdigit(message[3]) ||3171 !isdigit(message[4]) || !isdigit(message[5]))3172 return 0; /* corrupt? */3173 email_end[1] = '\0';3174 tz = strtol(message + 1, NULL, 10);3175 if (message[6] != '\t')3176 message += 6;3177 else3178 message += 7;3179 return fn(osha1, nsha1, sb->buf + 82, timestamp, tz, message, cb_data);3180}31813182static char *find_beginning_of_line(char *bob, char *scan)3183{3184 while (bob < scan && *(--scan) != '\n')3185 ; /* keep scanning backwards */3186 /*3187 * Return either beginning of the buffer, or LF at the end of3188 * the previous line.3189 */3190 return scan;3191}31923193int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data)3194{3195 struct strbuf sb = STRBUF_INIT;3196 FILE *logfp;3197 long pos;3198 int ret = 0, at_tail = 1;31993200 logfp = fopen(git_path("logs/%s", refname), "r");3201 if (!logfp)3202 return -1;32033204 /* Jump to the end */3205 if (fseek(logfp, 0, SEEK_END) < 0)3206 return error("cannot seek back reflog for %s: %s",3207 refname, strerror(errno));3208 pos = ftell(logfp);3209 while (!ret && 0 < pos) {3210 int cnt;3211 size_t nread;3212 char buf[BUFSIZ];3213 char *endp, *scanp;32143215 /* Fill next block from the end */3216 cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;3217 if (fseek(logfp, pos - cnt, SEEK_SET))3218 return error("cannot seek back reflog for %s: %s",3219 refname, strerror(errno));3220 nread = fread(buf, cnt, 1, logfp);3221 if (nread != 1)3222 return error("cannot read %d bytes from reflog for %s: %s",3223 cnt, refname, strerror(errno));3224 pos -= cnt;32253226 scanp = endp = buf + cnt;3227 if (at_tail && scanp[-1] == '\n')3228 /* Looking at the final LF at the end of the file */3229 scanp--;3230 at_tail = 0;32313232 while (buf < scanp) {3233 /*3234 * terminating LF of the previous line, or the beginning3235 * of the buffer.3236 */3237 char *bp;32383239 bp = find_beginning_of_line(buf, scanp);32403241 if (*bp != '\n') {3242 strbuf_splice(&sb, 0, 0, buf, endp - buf);3243 if (pos)3244 break; /* need to fill another block */3245 scanp = buf - 1; /* leave loop */3246 } else {3247 /*3248 * (bp + 1) thru endp is the beginning of the3249 * current line we have in sb3250 */3251 strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));3252 scanp = bp;3253 endp = bp + 1;3254 }3255 ret = show_one_reflog_ent(&sb, fn, cb_data);3256 strbuf_reset(&sb);3257 if (ret)3258 break;3259 }32603261 }3262 if (!ret && sb.len)3263 ret = show_one_reflog_ent(&sb, fn, cb_data);32643265 fclose(logfp);3266 strbuf_release(&sb);3267 return ret;3268}32693270int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)3271{3272 FILE *logfp;3273 struct strbuf sb = STRBUF_INIT;3274 int ret = 0;32753276 logfp = fopen(git_path("logs/%s", refname), "r");3277 if (!logfp)3278 return -1;32793280 while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))3281 ret = show_one_reflog_ent(&sb, fn, cb_data);3282 fclose(logfp);3283 strbuf_release(&sb);3284 return ret;3285}3286/*3287 * Call fn for each reflog in the namespace indicated by name. name3288 * must be empty or end with '/'. Name will be used as a scratch3289 * space, but its contents will be restored before return.3290 */3291static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)3292{3293 DIR *d = opendir(git_path("logs/%s", name->buf));3294 int retval = 0;3295 struct dirent *de;3296 int oldlen = name->len;32973298 if (!d)3299 return name->len ? errno : 0;33003301 while ((de = readdir(d)) != NULL) {3302 struct stat st;33033304 if (de->d_name[0] == '.')3305 continue;3306 if (ends_with(de->d_name, ".lock"))3307 continue;3308 strbuf_addstr(name, de->d_name);3309 if (stat(git_path("logs/%s", name->buf), &st) < 0) {3310 ; /* silently ignore */3311 } else {3312 if (S_ISDIR(st.st_mode)) {3313 strbuf_addch(name, '/');3314 retval = do_for_each_reflog(name, fn, cb_data);3315 } else {3316 unsigned char sha1[20];3317 if (read_ref_full(name->buf, sha1, 0, NULL))3318 retval = error("bad ref for %s", name->buf);3319 else3320 retval = fn(name->buf, sha1, 0, cb_data);3321 }3322 if (retval)3323 break;3324 }3325 strbuf_setlen(name, oldlen);3326 }3327 closedir(d);3328 return retval;3329}33303331int for_each_reflog(each_ref_fn fn, void *cb_data)3332{3333 int retval;3334 struct strbuf name;3335 strbuf_init(&name, PATH_MAX);3336 retval = do_for_each_reflog(&name, fn, cb_data);3337 strbuf_release(&name);3338 return retval;3339}33403341static struct ref_lock *update_ref_lock(const char *refname,3342 const unsigned char *oldval,3343 int flags, int *type_p,3344 enum action_on_err onerr)3345{3346 struct ref_lock *lock;3347 lock = lock_any_ref_for_update(refname, oldval, flags, type_p);3348 if (!lock) {3349 const char *str = "Cannot lock the ref '%s'.";3350 switch (onerr) {3351 case UPDATE_REFS_MSG_ON_ERR: error(str, refname); break;3352 case UPDATE_REFS_DIE_ON_ERR: die(str, refname); break;3353 case UPDATE_REFS_QUIET_ON_ERR: break;3354 }3355 }3356 return lock;3357}33583359static int update_ref_write(const char *action, const char *refname,3360 const unsigned char *sha1, struct ref_lock *lock,3361 struct strbuf *err, enum action_on_err onerr)3362{3363 if (write_ref_sha1(lock, sha1, action) < 0) {3364 const char *str = "Cannot update the ref '%s'.";3365 if (err)3366 strbuf_addf(err, str, refname);33673368 switch (onerr) {3369 case UPDATE_REFS_MSG_ON_ERR: error(str, refname); break;3370 case UPDATE_REFS_DIE_ON_ERR: die(str, refname); break;3371 case UPDATE_REFS_QUIET_ON_ERR: break;3372 }3373 return 1;3374 }3375 return 0;3376}33773378/**3379 * Information needed for a single ref update. Set new_sha1 to the3380 * new value or to zero to delete the ref. To check the old value3381 * while locking the ref, set have_old to 1 and set old_sha1 to the3382 * value or to zero to ensure the ref does not exist before update.3383 */3384struct ref_update {3385 unsigned char new_sha1[20];3386 unsigned char old_sha1[20];3387 int flags; /* REF_NODEREF? */3388 int have_old; /* 1 if old_sha1 is valid, 0 otherwise */3389 struct ref_lock *lock;3390 int type;3391 const char refname[FLEX_ARRAY];3392};33933394/*3395 * Data structure for holding a reference transaction, which can3396 * consist of checks and updates to multiple references, carried out3397 * as atomically as possible. This structure is opaque to callers.3398 */3399struct ref_transaction {3400 struct ref_update **updates;3401 size_t alloc;3402 size_t nr;3403};34043405struct ref_transaction *ref_transaction_begin(void)3406{3407 return xcalloc(1, sizeof(struct ref_transaction));3408}34093410void ref_transaction_free(struct ref_transaction *transaction)3411{3412 int i;34133414 if (!transaction)3415 return;34163417 for (i = 0; i < transaction->nr; i++)3418 free(transaction->updates[i]);34193420 free(transaction->updates);3421 free(transaction);3422}34233424static struct ref_update *add_update(struct ref_transaction *transaction,3425 const char *refname)3426{3427 size_t len = strlen(refname);3428 struct ref_update *update = xcalloc(1, sizeof(*update) + len + 1);34293430 strcpy((char *)update->refname, refname);3431 ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);3432 transaction->updates[transaction->nr++] = update;3433 return update;3434}34353436int ref_transaction_update(struct ref_transaction *transaction,3437 const char *refname,3438 const unsigned char *new_sha1,3439 const unsigned char *old_sha1,3440 int flags, int have_old,3441 struct strbuf *err)3442{3443 struct ref_update *update;34443445 if (have_old && !old_sha1)3446 die("BUG: have_old is true but old_sha1 is NULL");34473448 update = add_update(transaction, refname);3449 hashcpy(update->new_sha1, new_sha1);3450 update->flags = flags;3451 update->have_old = have_old;3452 if (have_old)3453 hashcpy(update->old_sha1, old_sha1);3454 return 0;3455}34563457void ref_transaction_create(struct ref_transaction *transaction,3458 const char *refname,3459 const unsigned char *new_sha1,3460 int flags)3461{3462 struct ref_update *update = add_update(transaction, refname);34633464 assert(!is_null_sha1(new_sha1));3465 hashcpy(update->new_sha1, new_sha1);3466 hashclr(update->old_sha1);3467 update->flags = flags;3468 update->have_old = 1;3469}34703471void ref_transaction_delete(struct ref_transaction *transaction,3472 const char *refname,3473 const unsigned char *old_sha1,3474 int flags, int have_old)3475{3476 struct ref_update *update = add_update(transaction, refname);34773478 update->flags = flags;3479 update->have_old = have_old;3480 if (have_old) {3481 assert(!is_null_sha1(old_sha1));3482 hashcpy(update->old_sha1, old_sha1);3483 }3484}34853486int update_ref(const char *action, const char *refname,3487 const unsigned char *sha1, const unsigned char *oldval,3488 int flags, enum action_on_err onerr)3489{3490 struct ref_lock *lock;3491 lock = update_ref_lock(refname, oldval, flags, NULL, onerr);3492 if (!lock)3493 return 1;3494 return update_ref_write(action, refname, sha1, lock, NULL, onerr);3495}34963497static int ref_update_compare(const void *r1, const void *r2)3498{3499 const struct ref_update * const *u1 = r1;3500 const struct ref_update * const *u2 = r2;3501 return strcmp((*u1)->refname, (*u2)->refname);3502}35033504static int ref_update_reject_duplicates(struct ref_update **updates, int n,3505 struct strbuf *err)3506{3507 int i;3508 for (i = 1; i < n; i++)3509 if (!strcmp(updates[i - 1]->refname, updates[i]->refname)) {3510 const char *str =3511 "Multiple updates for ref '%s' not allowed.";3512 if (err)3513 strbuf_addf(err, str, updates[i]->refname);35143515 return 1;3516 }3517 return 0;3518}35193520int ref_transaction_commit(struct ref_transaction *transaction,3521 const char *msg, struct strbuf *err)3522{3523 int ret = 0, delnum = 0, i;3524 const char **delnames;3525 int n = transaction->nr;3526 struct ref_update **updates = transaction->updates;35273528 if (!n)3529 return 0;35303531 /* Allocate work space */3532 delnames = xmalloc(sizeof(*delnames) * n);35333534 /* Copy, sort, and reject duplicate refs */3535 qsort(updates, n, sizeof(*updates), ref_update_compare);3536 ret = ref_update_reject_duplicates(updates, n, err);3537 if (ret)3538 goto cleanup;35393540 /* Acquire all locks while verifying old values */3541 for (i = 0; i < n; i++) {3542 struct ref_update *update = updates[i];35433544 update->lock = update_ref_lock(update->refname,3545 (update->have_old ?3546 update->old_sha1 : NULL),3547 update->flags,3548 &update->type,3549 UPDATE_REFS_QUIET_ON_ERR);3550 if (!update->lock) {3551 if (err)3552 strbuf_addf(err, "Cannot lock the ref '%s'.",3553 update->refname);3554 ret = 1;3555 goto cleanup;3556 }3557 }35583559 /* Perform updates first so live commits remain referenced */3560 for (i = 0; i < n; i++) {3561 struct ref_update *update = updates[i];35623563 if (!is_null_sha1(update->new_sha1)) {3564 ret = update_ref_write(msg,3565 update->refname,3566 update->new_sha1,3567 update->lock, err,3568 UPDATE_REFS_QUIET_ON_ERR);3569 update->lock = NULL; /* freed by update_ref_write */3570 if (ret)3571 goto cleanup;3572 }3573 }35743575 /* Perform deletes now that updates are safely completed */3576 for (i = 0; i < n; i++) {3577 struct ref_update *update = updates[i];35783579 if (update->lock) {3580 delnames[delnum++] = update->lock->ref_name;3581 ret |= delete_ref_loose(update->lock, update->type);3582 }3583 }35843585 ret |= repack_without_refs(delnames, delnum, err);3586 for (i = 0; i < delnum; i++)3587 unlink_or_warn(git_path("logs/%s", delnames[i]));3588 clear_loose_ref_cache(&ref_cache);35893590cleanup:3591 for (i = 0; i < n; i++)3592 if (updates[i]->lock)3593 unlock_ref(updates[i]->lock);3594 free(delnames);3595 return ret;3596}35973598char *shorten_unambiguous_ref(const char *refname, int strict)3599{3600 int i;3601 static char **scanf_fmts;3602 static int nr_rules;3603 char *short_name;36043605 if (!nr_rules) {3606 /*3607 * Pre-generate scanf formats from ref_rev_parse_rules[].3608 * Generate a format suitable for scanf from a3609 * ref_rev_parse_rules rule by interpolating "%s" at the3610 * location of the "%.*s".3611 */3612 size_t total_len = 0;3613 size_t offset = 0;36143615 /* the rule list is NULL terminated, count them first */3616 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)3617 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */3618 total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;36193620 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);36213622 offset = 0;3623 for (i = 0; i < nr_rules; i++) {3624 assert(offset < total_len);3625 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;3626 offset += snprintf(scanf_fmts[i], total_len - offset,3627 ref_rev_parse_rules[i], 2, "%s") + 1;3628 }3629 }36303631 /* bail out if there are no rules */3632 if (!nr_rules)3633 return xstrdup(refname);36343635 /* buffer for scanf result, at most refname must fit */3636 short_name = xstrdup(refname);36373638 /* skip first rule, it will always match */3639 for (i = nr_rules - 1; i > 0 ; --i) {3640 int j;3641 int rules_to_fail = i;3642 int short_name_len;36433644 if (1 != sscanf(refname, scanf_fmts[i], short_name))3645 continue;36463647 short_name_len = strlen(short_name);36483649 /*3650 * in strict mode, all (except the matched one) rules3651 * must fail to resolve to a valid non-ambiguous ref3652 */3653 if (strict)3654 rules_to_fail = nr_rules;36553656 /*3657 * check if the short name resolves to a valid ref,3658 * but use only rules prior to the matched one3659 */3660 for (j = 0; j < rules_to_fail; j++) {3661 const char *rule = ref_rev_parse_rules[j];3662 char refname[PATH_MAX];36633664 /* skip matched rule */3665 if (i == j)3666 continue;36673668 /*3669 * the short name is ambiguous, if it resolves3670 * (with this previous rule) to a valid ref3671 * read_ref() returns 0 on success3672 */3673 mksnpath(refname, sizeof(refname),3674 rule, short_name_len, short_name);3675 if (ref_exists(refname))3676 break;3677 }36783679 /*3680 * short name is non-ambiguous if all previous rules3681 * haven't resolved to a valid ref3682 */3683 if (j == rules_to_fail)3684 return short_name;3685 }36863687 free(short_name);3688 return xstrdup(refname);3689}36903691static struct string_list *hide_refs;36923693int parse_hide_refs_config(const char *var, const char *value, const char *section)3694{3695 if (!strcmp("transfer.hiderefs", var) ||3696 /* NEEDSWORK: use parse_config_key() once both are merged */3697 (starts_with(var, section) && var[strlen(section)] == '.' &&3698 !strcmp(var + strlen(section), ".hiderefs"))) {3699 char *ref;3700 int len;37013702 if (!value)3703 return config_error_nonbool(var);3704 ref = xstrdup(value);3705 len = strlen(ref);3706 while (len && ref[len - 1] == '/')3707 ref[--len] = '\0';3708 if (!hide_refs) {3709 hide_refs = xcalloc(1, sizeof(*hide_refs));3710 hide_refs->strdup_strings = 1;3711 }3712 string_list_append(hide_refs, ref);3713 }3714 return 0;3715}37163717int ref_is_hidden(const char *refname)3718{3719 struct string_list_item *item;37203721 if (!hide_refs)3722 return 0;3723 for_each_string_list_item(item, hide_refs) {3724 int len;3725 if (!starts_with(refname, item->string))3726 continue;3727 len = strlen(item->string);3728 if (!refname[len] || refname[len] == '/')3729 return 1;3730 }3731 return 0;3732}