1#include "cache.h" 2#include "lockfile.h" 3#include "refs.h" 4#include "object.h" 5#include "tag.h" 6#include "dir.h" 7#include "string-list.h" 8 9struct ref_lock { 10 char *ref_name; 11 char *orig_ref_name; 12 struct lock_file *lk; 13 unsigned char old_sha1[20]; 14}; 15 16/* 17 * How to handle various characters in refnames: 18 * 0: An acceptable character for refs 19 * 1: End-of-component 20 * 2: ., look for a preceding . to reject .. in refs 21 * 3: {, look for a preceding @ to reject @{ in refs 22 * 4: A bad character: ASCII control characters, "~", "^", ":" or SP 23 */ 24static unsigned char refname_disposition[256] = { 25 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 26 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 27 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 2, 1, 28 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4, 29 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 30 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0, 31 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 32 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4 33}; 34 35/* 36 * Flag passed to lock_ref_sha1_basic() telling it to tolerate broken 37 * refs (i.e., because the reference is about to be deleted anyway). 38 */ 39#define REF_DELETING 0x02 40 41/* 42 * Used as a flag in ref_update::flags when a loose ref is being 43 * pruned. 44 */ 45#define REF_ISPRUNING 0x04 46 47/* 48 * Used as a flag in ref_update::flags when the reference should be 49 * updated to new_sha1. 50 */ 51#define REF_HAVE_NEW 0x08 52 53/* 54 * Used as a flag in ref_update::flags when old_sha1 should be 55 * checked. 56 */ 57#define REF_HAVE_OLD 0x10 58 59/* 60 * Used as a flag in ref_update::flags when the lockfile needs to be 61 * committed. 62 */ 63#define REF_NEEDS_COMMIT 0x20 64 65/* 66 * Try to read one refname component from the front of refname. 67 * Return the length of the component found, or -1 if the component is 68 * not legal. It is legal if it is something reasonable to have under 69 * ".git/refs/"; We do not like it if: 70 * 71 * - any path component of it begins with ".", or 72 * - it has double dots "..", or 73 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or 74 * - it ends with a "/". 75 * - it ends with ".lock" 76 * - it contains a "\" (backslash) 77 */ 78static int check_refname_component(const char *refname, int flags) 79{ 80 const char *cp; 81 char last = '\0'; 82 83 for (cp = refname; ; cp++) { 84 int ch = *cp & 255; 85 unsigned char disp = refname_disposition[ch]; 86 switch (disp) { 87 case 1: 88 goto out; 89 case 2: 90 if (last == '.') 91 return -1; /* Refname contains "..". */ 92 break; 93 case 3: 94 if (last == '@') 95 return -1; /* Refname contains "@{". */ 96 break; 97 case 4: 98 return -1; 99 } 100 last = ch; 101 } 102out: 103 if (cp == refname) 104 return 0; /* Component has zero length. */ 105 if (refname[0] == '.') 106 return -1; /* Component starts with '.'. */ 107 if (cp - refname >= LOCK_SUFFIX_LEN && 108 !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN)) 109 return -1; /* Refname ends with ".lock". */ 110 return cp - refname; 111} 112 113int check_refname_format(const char *refname, int flags) 114{ 115 int component_len, component_count = 0; 116 117 if (!strcmp(refname, "@")) 118 /* Refname is a single character '@'. */ 119 return -1; 120 121 while (1) { 122 /* We are at the start of a path component. */ 123 component_len = check_refname_component(refname, flags); 124 if (component_len <= 0) { 125 if ((flags & REFNAME_REFSPEC_PATTERN) && 126 refname[0] == '*' && 127 (refname[1] == '\0' || refname[1] == '/')) { 128 /* Accept one wildcard as a full refname component. */ 129 flags &= ~REFNAME_REFSPEC_PATTERN; 130 component_len = 1; 131 } else { 132 return -1; 133 } 134 } 135 component_count++; 136 if (refname[component_len] == '\0') 137 break; 138 /* Skip to next component. */ 139 refname += component_len + 1; 140 } 141 142 if (refname[component_len - 1] == '.') 143 return -1; /* Refname ends with '.'. */ 144 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2) 145 return -1; /* Refname has only one component. */ 146 return 0; 147} 148 149struct ref_entry; 150 151/* 152 * Information used (along with the information in ref_entry) to 153 * describe a single cached reference. This data structure only 154 * occurs embedded in a union in struct ref_entry, and only when 155 * (ref_entry->flag & REF_DIR) is zero. 156 */ 157struct ref_value { 158 /* 159 * The name of the object to which this reference resolves 160 * (which may be a tag object). If REF_ISBROKEN, this is 161 * null. If REF_ISSYMREF, then this is the name of the object 162 * referred to by the last reference in the symlink chain. 163 */ 164 struct object_id oid; 165 166 /* 167 * If REF_KNOWS_PEELED, then this field holds the peeled value 168 * of this reference, or null if the reference is known not to 169 * be peelable. See the documentation for peel_ref() for an 170 * exact definition of "peelable". 171 */ 172 struct object_id peeled; 173}; 174 175struct ref_cache; 176 177/* 178 * Information used (along with the information in ref_entry) to 179 * describe a level in the hierarchy of references. This data 180 * structure only occurs embedded in a union in struct ref_entry, and 181 * only when (ref_entry.flag & REF_DIR) is set. In that case, 182 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references 183 * in the directory have already been read: 184 * 185 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose 186 * or packed references, already read. 187 * 188 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose 189 * references that hasn't been read yet (nor has any of its 190 * subdirectories). 191 * 192 * Entries within a directory are stored within a growable array of 193 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i < 194 * sorted are sorted by their component name in strcmp() order and the 195 * remaining entries are unsorted. 196 * 197 * Loose references are read lazily, one directory at a time. When a 198 * directory of loose references is read, then all of the references 199 * in that directory are stored, and REF_INCOMPLETE stubs are created 200 * for any subdirectories, but the subdirectories themselves are not 201 * read. The reading is triggered by get_ref_dir(). 202 */ 203struct ref_dir { 204 int nr, alloc; 205 206 /* 207 * Entries with index 0 <= i < sorted are sorted by name. New 208 * entries are appended to the list unsorted, and are sorted 209 * only when required; thus we avoid the need to sort the list 210 * after the addition of every reference. 211 */ 212 int sorted; 213 214 /* A pointer to the ref_cache that contains this ref_dir. */ 215 struct ref_cache *ref_cache; 216 217 struct ref_entry **entries; 218}; 219 220/* 221 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01, 222 * REF_ISPACKED=0x02, REF_ISBROKEN=0x04 and REF_BAD_NAME=0x08 are 223 * public values; see refs.h. 224 */ 225 226/* 227 * The field ref_entry->u.value.peeled of this value entry contains 228 * the correct peeled value for the reference, which might be 229 * null_sha1 if the reference is not a tag or if it is broken. 230 */ 231#define REF_KNOWS_PEELED 0x10 232 233/* ref_entry represents a directory of references */ 234#define REF_DIR 0x20 235 236/* 237 * Entry has not yet been read from disk (used only for REF_DIR 238 * entries representing loose references) 239 */ 240#define REF_INCOMPLETE 0x40 241 242/* 243 * A ref_entry represents either a reference or a "subdirectory" of 244 * references. 245 * 246 * Each directory in the reference namespace is represented by a 247 * ref_entry with (flags & REF_DIR) set and containing a subdir member 248 * that holds the entries in that directory that have been read so 249 * far. If (flags & REF_INCOMPLETE) is set, then the directory and 250 * its subdirectories haven't been read yet. REF_INCOMPLETE is only 251 * used for loose reference directories. 252 * 253 * References are represented by a ref_entry with (flags & REF_DIR) 254 * unset and a value member that describes the reference's value. The 255 * flag member is at the ref_entry level, but it is also needed to 256 * interpret the contents of the value field (in other words, a 257 * ref_value object is not very much use without the enclosing 258 * ref_entry). 259 * 260 * Reference names cannot end with slash and directories' names are 261 * always stored with a trailing slash (except for the top-level 262 * directory, which is always denoted by ""). This has two nice 263 * consequences: (1) when the entries in each subdir are sorted 264 * lexicographically by name (as they usually are), the references in 265 * a whole tree can be generated in lexicographic order by traversing 266 * the tree in left-to-right, depth-first order; (2) the names of 267 * references and subdirectories cannot conflict, and therefore the 268 * presence of an empty subdirectory does not block the creation of a 269 * similarly-named reference. (The fact that reference names with the 270 * same leading components can conflict *with each other* is a 271 * separate issue that is regulated by verify_refname_available().) 272 * 273 * Please note that the name field contains the fully-qualified 274 * reference (or subdirectory) name. Space could be saved by only 275 * storing the relative names. But that would require the full names 276 * to be generated on the fly when iterating in do_for_each_ref(), and 277 * would break callback functions, who have always been able to assume 278 * that the name strings that they are passed will not be freed during 279 * the iteration. 280 */ 281struct ref_entry { 282 unsigned char flag; /* ISSYMREF? ISPACKED? */ 283 union { 284 struct ref_value value; /* if not (flags&REF_DIR) */ 285 struct ref_dir subdir; /* if (flags&REF_DIR) */ 286 } u; 287 /* 288 * The full name of the reference (e.g., "refs/heads/master") 289 * or the full name of the directory with a trailing slash 290 * (e.g., "refs/heads/"): 291 */ 292 char name[FLEX_ARRAY]; 293}; 294 295static void read_loose_refs(const char *dirname, struct ref_dir *dir); 296 297static struct ref_dir *get_ref_dir(struct ref_entry *entry) 298{ 299 struct ref_dir *dir; 300 assert(entry->flag & REF_DIR); 301 dir = &entry->u.subdir; 302 if (entry->flag & REF_INCOMPLETE) { 303 read_loose_refs(entry->name, dir); 304 entry->flag &= ~REF_INCOMPLETE; 305 } 306 return dir; 307} 308 309/* 310 * Check if a refname is safe. 311 * For refs that start with "refs/" we consider it safe as long they do 312 * not try to resolve to outside of refs/. 313 * 314 * For all other refs we only consider them safe iff they only contain 315 * upper case characters and '_' (like "HEAD" AND "MERGE_HEAD", and not like 316 * "config"). 317 */ 318static int refname_is_safe(const char *refname) 319{ 320 if (starts_with(refname, "refs/")) { 321 char *buf; 322 int result; 323 324 buf = xmalloc(strlen(refname) + 1); 325 /* 326 * Does the refname try to escape refs/? 327 * For example: refs/foo/../bar is safe but refs/foo/../../bar 328 * is not. 329 */ 330 result = !normalize_path_copy(buf, refname + strlen("refs/")); 331 free(buf); 332 return result; 333 } 334 while (*refname) { 335 if (!isupper(*refname) && *refname != '_') 336 return 0; 337 refname++; 338 } 339 return 1; 340} 341 342static struct ref_entry *create_ref_entry(const char *refname, 343 const unsigned char *sha1, int flag, 344 int check_name) 345{ 346 int len; 347 struct ref_entry *ref; 348 349 if (check_name && 350 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) 351 die("Reference has invalid format: '%s'", refname); 352 len = strlen(refname) + 1; 353 ref = xmalloc(sizeof(struct ref_entry) + len); 354 hashcpy(ref->u.value.oid.hash, sha1); 355 oidclr(&ref->u.value.peeled); 356 memcpy(ref->name, refname, len); 357 ref->flag = flag; 358 return ref; 359} 360 361static void clear_ref_dir(struct ref_dir *dir); 362 363static void free_ref_entry(struct ref_entry *entry) 364{ 365 if (entry->flag & REF_DIR) { 366 /* 367 * Do not use get_ref_dir() here, as that might 368 * trigger the reading of loose refs. 369 */ 370 clear_ref_dir(&entry->u.subdir); 371 } 372 free(entry); 373} 374 375/* 376 * Add a ref_entry to the end of dir (unsorted). Entry is always 377 * stored directly in dir; no recursion into subdirectories is 378 * done. 379 */ 380static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry) 381{ 382 ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc); 383 dir->entries[dir->nr++] = entry; 384 /* optimize for the case that entries are added in order */ 385 if (dir->nr == 1 || 386 (dir->nr == dir->sorted + 1 && 387 strcmp(dir->entries[dir->nr - 2]->name, 388 dir->entries[dir->nr - 1]->name) < 0)) 389 dir->sorted = dir->nr; 390} 391 392/* 393 * Clear and free all entries in dir, recursively. 394 */ 395static void clear_ref_dir(struct ref_dir *dir) 396{ 397 int i; 398 for (i = 0; i < dir->nr; i++) 399 free_ref_entry(dir->entries[i]); 400 free(dir->entries); 401 dir->sorted = dir->nr = dir->alloc = 0; 402 dir->entries = NULL; 403} 404 405/* 406 * Create a struct ref_entry object for the specified dirname. 407 * dirname is the name of the directory with a trailing slash (e.g., 408 * "refs/heads/") or "" for the top-level directory. 409 */ 410static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache, 411 const char *dirname, size_t len, 412 int incomplete) 413{ 414 struct ref_entry *direntry; 415 direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1); 416 memcpy(direntry->name, dirname, len); 417 direntry->name[len] = '\0'; 418 direntry->u.subdir.ref_cache = ref_cache; 419 direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0); 420 return direntry; 421} 422 423static int ref_entry_cmp(const void *a, const void *b) 424{ 425 struct ref_entry *one = *(struct ref_entry **)a; 426 struct ref_entry *two = *(struct ref_entry **)b; 427 return strcmp(one->name, two->name); 428} 429 430static void sort_ref_dir(struct ref_dir *dir); 431 432struct string_slice { 433 size_t len; 434 const char *str; 435}; 436 437static int ref_entry_cmp_sslice(const void *key_, const void *ent_) 438{ 439 const struct string_slice *key = key_; 440 const struct ref_entry *ent = *(const struct ref_entry * const *)ent_; 441 int cmp = strncmp(key->str, ent->name, key->len); 442 if (cmp) 443 return cmp; 444 return '\0' - (unsigned char)ent->name[key->len]; 445} 446 447/* 448 * Return the index of the entry with the given refname from the 449 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if 450 * no such entry is found. dir must already be complete. 451 */ 452static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len) 453{ 454 struct ref_entry **r; 455 struct string_slice key; 456 457 if (refname == NULL || !dir->nr) 458 return -1; 459 460 sort_ref_dir(dir); 461 key.len = len; 462 key.str = refname; 463 r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries), 464 ref_entry_cmp_sslice); 465 466 if (r == NULL) 467 return -1; 468 469 return r - dir->entries; 470} 471 472/* 473 * Search for a directory entry directly within dir (without 474 * recursing). Sort dir if necessary. subdirname must be a directory 475 * name (i.e., end in '/'). If mkdir is set, then create the 476 * directory if it is missing; otherwise, return NULL if the desired 477 * directory cannot be found. dir must already be complete. 478 */ 479static struct ref_dir *search_for_subdir(struct ref_dir *dir, 480 const char *subdirname, size_t len, 481 int mkdir) 482{ 483 int entry_index = search_ref_dir(dir, subdirname, len); 484 struct ref_entry *entry; 485 if (entry_index == -1) { 486 if (!mkdir) 487 return NULL; 488 /* 489 * Since dir is complete, the absence of a subdir 490 * means that the subdir really doesn't exist; 491 * therefore, create an empty record for it but mark 492 * the record complete. 493 */ 494 entry = create_dir_entry(dir->ref_cache, subdirname, len, 0); 495 add_entry_to_dir(dir, entry); 496 } else { 497 entry = dir->entries[entry_index]; 498 } 499 return get_ref_dir(entry); 500} 501 502/* 503 * If refname is a reference name, find the ref_dir within the dir 504 * tree that should hold refname. If refname is a directory name 505 * (i.e., ends in '/'), then return that ref_dir itself. dir must 506 * represent the top-level directory and must already be complete. 507 * Sort ref_dirs and recurse into subdirectories as necessary. If 508 * mkdir is set, then create any missing directories; otherwise, 509 * return NULL if the desired directory cannot be found. 510 */ 511static struct ref_dir *find_containing_dir(struct ref_dir *dir, 512 const char *refname, int mkdir) 513{ 514 const char *slash; 515 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) { 516 size_t dirnamelen = slash - refname + 1; 517 struct ref_dir *subdir; 518 subdir = search_for_subdir(dir, refname, dirnamelen, mkdir); 519 if (!subdir) { 520 dir = NULL; 521 break; 522 } 523 dir = subdir; 524 } 525 526 return dir; 527} 528 529/* 530 * Find the value entry with the given name in dir, sorting ref_dirs 531 * and recursing into subdirectories as necessary. If the name is not 532 * found or it corresponds to a directory entry, return NULL. 533 */ 534static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname) 535{ 536 int entry_index; 537 struct ref_entry *entry; 538 dir = find_containing_dir(dir, refname, 0); 539 if (!dir) 540 return NULL; 541 entry_index = search_ref_dir(dir, refname, strlen(refname)); 542 if (entry_index == -1) 543 return NULL; 544 entry = dir->entries[entry_index]; 545 return (entry->flag & REF_DIR) ? NULL : entry; 546} 547 548/* 549 * Remove the entry with the given name from dir, recursing into 550 * subdirectories as necessary. If refname is the name of a directory 551 * (i.e., ends with '/'), then remove the directory and its contents. 552 * If the removal was successful, return the number of entries 553 * remaining in the directory entry that contained the deleted entry. 554 * If the name was not found, return -1. Please note that this 555 * function only deletes the entry from the cache; it does not delete 556 * it from the filesystem or ensure that other cache entries (which 557 * might be symbolic references to the removed entry) are updated. 558 * Nor does it remove any containing dir entries that might be made 559 * empty by the removal. dir must represent the top-level directory 560 * and must already be complete. 561 */ 562static int remove_entry(struct ref_dir *dir, const char *refname) 563{ 564 int refname_len = strlen(refname); 565 int entry_index; 566 struct ref_entry *entry; 567 int is_dir = refname[refname_len - 1] == '/'; 568 if (is_dir) { 569 /* 570 * refname represents a reference directory. Remove 571 * the trailing slash; otherwise we will get the 572 * directory *representing* refname rather than the 573 * one *containing* it. 574 */ 575 char *dirname = xmemdupz(refname, refname_len - 1); 576 dir = find_containing_dir(dir, dirname, 0); 577 free(dirname); 578 } else { 579 dir = find_containing_dir(dir, refname, 0); 580 } 581 if (!dir) 582 return -1; 583 entry_index = search_ref_dir(dir, refname, refname_len); 584 if (entry_index == -1) 585 return -1; 586 entry = dir->entries[entry_index]; 587 588 memmove(&dir->entries[entry_index], 589 &dir->entries[entry_index + 1], 590 (dir->nr - entry_index - 1) * sizeof(*dir->entries) 591 ); 592 dir->nr--; 593 if (dir->sorted > entry_index) 594 dir->sorted--; 595 free_ref_entry(entry); 596 return dir->nr; 597} 598 599/* 600 * Add a ref_entry to the ref_dir (unsorted), recursing into 601 * subdirectories as necessary. dir must represent the top-level 602 * directory. Return 0 on success. 603 */ 604static int add_ref(struct ref_dir *dir, struct ref_entry *ref) 605{ 606 dir = find_containing_dir(dir, ref->name, 1); 607 if (!dir) 608 return -1; 609 add_entry_to_dir(dir, ref); 610 return 0; 611} 612 613/* 614 * Emit a warning and return true iff ref1 and ref2 have the same name 615 * and the same sha1. Die if they have the same name but different 616 * sha1s. 617 */ 618static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2) 619{ 620 if (strcmp(ref1->name, ref2->name)) 621 return 0; 622 623 /* Duplicate name; make sure that they don't conflict: */ 624 625 if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR)) 626 /* This is impossible by construction */ 627 die("Reference directory conflict: %s", ref1->name); 628 629 if (oidcmp(&ref1->u.value.oid, &ref2->u.value.oid)) 630 die("Duplicated ref, and SHA1s don't match: %s", ref1->name); 631 632 warning("Duplicated ref: %s", ref1->name); 633 return 1; 634} 635 636/* 637 * Sort the entries in dir non-recursively (if they are not already 638 * sorted) and remove any duplicate entries. 639 */ 640static void sort_ref_dir(struct ref_dir *dir) 641{ 642 int i, j; 643 struct ref_entry *last = NULL; 644 645 /* 646 * This check also prevents passing a zero-length array to qsort(), 647 * which is a problem on some platforms. 648 */ 649 if (dir->sorted == dir->nr) 650 return; 651 652 qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp); 653 654 /* Remove any duplicates: */ 655 for (i = 0, j = 0; j < dir->nr; j++) { 656 struct ref_entry *entry = dir->entries[j]; 657 if (last && is_dup_ref(last, entry)) 658 free_ref_entry(entry); 659 else 660 last = dir->entries[i++] = entry; 661 } 662 dir->sorted = dir->nr = i; 663} 664 665/* Include broken references in a do_for_each_ref*() iteration: */ 666#define DO_FOR_EACH_INCLUDE_BROKEN 0x01 667 668/* 669 * Return true iff the reference described by entry can be resolved to 670 * an object in the database. Emit a warning if the referred-to 671 * object does not exist. 672 */ 673static int ref_resolves_to_object(struct ref_entry *entry) 674{ 675 if (entry->flag & REF_ISBROKEN) 676 return 0; 677 if (!has_sha1_file(entry->u.value.oid.hash)) { 678 error("%s does not point to a valid object!", entry->name); 679 return 0; 680 } 681 return 1; 682} 683 684/* 685 * current_ref is a performance hack: when iterating over references 686 * using the for_each_ref*() functions, current_ref is set to the 687 * current reference's entry before calling the callback function. If 688 * the callback function calls peel_ref(), then peel_ref() first 689 * checks whether the reference to be peeled is the current reference 690 * (it usually is) and if so, returns that reference's peeled version 691 * if it is available. This avoids a refname lookup in a common case. 692 */ 693static struct ref_entry *current_ref; 694 695typedef int each_ref_entry_fn(struct ref_entry *entry, void *cb_data); 696 697struct ref_entry_cb { 698 const char *base; 699 int trim; 700 int flags; 701 each_ref_fn *fn; 702 void *cb_data; 703}; 704 705/* 706 * Handle one reference in a do_for_each_ref*()-style iteration, 707 * calling an each_ref_fn for each entry. 708 */ 709static int do_one_ref(struct ref_entry *entry, void *cb_data) 710{ 711 struct ref_entry_cb *data = cb_data; 712 struct ref_entry *old_current_ref; 713 int retval; 714 715 if (!starts_with(entry->name, data->base)) 716 return 0; 717 718 if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) && 719 !ref_resolves_to_object(entry)) 720 return 0; 721 722 /* Store the old value, in case this is a recursive call: */ 723 old_current_ref = current_ref; 724 current_ref = entry; 725 retval = data->fn(entry->name + data->trim, &entry->u.value.oid, 726 entry->flag, data->cb_data); 727 current_ref = old_current_ref; 728 return retval; 729} 730 731/* 732 * Call fn for each reference in dir that has index in the range 733 * offset <= index < dir->nr. Recurse into subdirectories that are in 734 * that index range, sorting them before iterating. This function 735 * does not sort dir itself; it should be sorted beforehand. fn is 736 * called for all references, including broken ones. 737 */ 738static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset, 739 each_ref_entry_fn fn, void *cb_data) 740{ 741 int i; 742 assert(dir->sorted == dir->nr); 743 for (i = offset; i < dir->nr; i++) { 744 struct ref_entry *entry = dir->entries[i]; 745 int retval; 746 if (entry->flag & REF_DIR) { 747 struct ref_dir *subdir = get_ref_dir(entry); 748 sort_ref_dir(subdir); 749 retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data); 750 } else { 751 retval = fn(entry, cb_data); 752 } 753 if (retval) 754 return retval; 755 } 756 return 0; 757} 758 759/* 760 * Call fn for each reference in the union of dir1 and dir2, in order 761 * by refname. Recurse into subdirectories. If a value entry appears 762 * in both dir1 and dir2, then only process the version that is in 763 * dir2. The input dirs must already be sorted, but subdirs will be 764 * sorted as needed. fn is called for all references, including 765 * broken ones. 766 */ 767static int do_for_each_entry_in_dirs(struct ref_dir *dir1, 768 struct ref_dir *dir2, 769 each_ref_entry_fn fn, void *cb_data) 770{ 771 int retval; 772 int i1 = 0, i2 = 0; 773 774 assert(dir1->sorted == dir1->nr); 775 assert(dir2->sorted == dir2->nr); 776 while (1) { 777 struct ref_entry *e1, *e2; 778 int cmp; 779 if (i1 == dir1->nr) { 780 return do_for_each_entry_in_dir(dir2, i2, fn, cb_data); 781 } 782 if (i2 == dir2->nr) { 783 return do_for_each_entry_in_dir(dir1, i1, fn, cb_data); 784 } 785 e1 = dir1->entries[i1]; 786 e2 = dir2->entries[i2]; 787 cmp = strcmp(e1->name, e2->name); 788 if (cmp == 0) { 789 if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) { 790 /* Both are directories; descend them in parallel. */ 791 struct ref_dir *subdir1 = get_ref_dir(e1); 792 struct ref_dir *subdir2 = get_ref_dir(e2); 793 sort_ref_dir(subdir1); 794 sort_ref_dir(subdir2); 795 retval = do_for_each_entry_in_dirs( 796 subdir1, subdir2, fn, cb_data); 797 i1++; 798 i2++; 799 } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) { 800 /* Both are references; ignore the one from dir1. */ 801 retval = fn(e2, cb_data); 802 i1++; 803 i2++; 804 } else { 805 die("conflict between reference and directory: %s", 806 e1->name); 807 } 808 } else { 809 struct ref_entry *e; 810 if (cmp < 0) { 811 e = e1; 812 i1++; 813 } else { 814 e = e2; 815 i2++; 816 } 817 if (e->flag & REF_DIR) { 818 struct ref_dir *subdir = get_ref_dir(e); 819 sort_ref_dir(subdir); 820 retval = do_for_each_entry_in_dir( 821 subdir, 0, fn, cb_data); 822 } else { 823 retval = fn(e, cb_data); 824 } 825 } 826 if (retval) 827 return retval; 828 } 829} 830 831/* 832 * Load all of the refs from the dir into our in-memory cache. The hard work 833 * of loading loose refs is done by get_ref_dir(), so we just need to recurse 834 * through all of the sub-directories. We do not even need to care about 835 * sorting, as traversal order does not matter to us. 836 */ 837static void prime_ref_dir(struct ref_dir *dir) 838{ 839 int i; 840 for (i = 0; i < dir->nr; i++) { 841 struct ref_entry *entry = dir->entries[i]; 842 if (entry->flag & REF_DIR) 843 prime_ref_dir(get_ref_dir(entry)); 844 } 845} 846 847struct nonmatching_ref_data { 848 const struct string_list *skip; 849 const char *conflicting_refname; 850}; 851 852static int nonmatching_ref_fn(struct ref_entry *entry, void *vdata) 853{ 854 struct nonmatching_ref_data *data = vdata; 855 856 if (data->skip && string_list_has_string(data->skip, entry->name)) 857 return 0; 858 859 data->conflicting_refname = entry->name; 860 return 1; 861} 862 863/* 864 * Return 0 if a reference named refname could be created without 865 * conflicting with the name of an existing reference in dir. 866 * Otherwise, return a negative value and write an explanation to err. 867 * If extras is non-NULL, it is a list of additional refnames with 868 * which refname is not allowed to conflict. If skip is non-NULL, 869 * ignore potential conflicts with refs in skip (e.g., because they 870 * are scheduled for deletion in the same operation). Behavior is 871 * undefined if the same name is listed in both extras and skip. 872 * 873 * Two reference names conflict if one of them exactly matches the 874 * leading components of the other; e.g., "refs/foo/bar" conflicts 875 * with both "refs/foo" and with "refs/foo/bar/baz" but not with 876 * "refs/foo/bar" or "refs/foo/barbados". 877 * 878 * extras and skip must be sorted. 879 */ 880static int verify_refname_available(const char *refname, 881 const struct string_list *extras, 882 const struct string_list *skip, 883 struct ref_dir *dir, 884 struct strbuf *err) 885{ 886 const char *slash; 887 int pos; 888 struct strbuf dirname = STRBUF_INIT; 889 int ret = -1; 890 891 /* 892 * For the sake of comments in this function, suppose that 893 * refname is "refs/foo/bar". 894 */ 895 896 assert(err); 897 898 strbuf_grow(&dirname, strlen(refname) + 1); 899 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) { 900 /* Expand dirname to the new prefix, not including the trailing slash: */ 901 strbuf_add(&dirname, refname + dirname.len, slash - refname - dirname.len); 902 903 /* 904 * We are still at a leading dir of the refname (e.g., 905 * "refs/foo"; if there is a reference with that name, 906 * it is a conflict, *unless* it is in skip. 907 */ 908 if (dir) { 909 pos = search_ref_dir(dir, dirname.buf, dirname.len); 910 if (pos >= 0 && 911 (!skip || !string_list_has_string(skip, dirname.buf))) { 912 /* 913 * We found a reference whose name is 914 * a proper prefix of refname; e.g., 915 * "refs/foo", and is not in skip. 916 */ 917 strbuf_addf(err, "'%s' exists; cannot create '%s'", 918 dirname.buf, refname); 919 goto cleanup; 920 } 921 } 922 923 if (extras && string_list_has_string(extras, dirname.buf) && 924 (!skip || !string_list_has_string(skip, dirname.buf))) { 925 strbuf_addf(err, "cannot process '%s' and '%s' at the same time", 926 refname, dirname.buf); 927 goto cleanup; 928 } 929 930 /* 931 * Otherwise, we can try to continue our search with 932 * the next component. So try to look up the 933 * directory, e.g., "refs/foo/". If we come up empty, 934 * we know there is nothing under this whole prefix, 935 * but even in that case we still have to continue the 936 * search for conflicts with extras. 937 */ 938 strbuf_addch(&dirname, '/'); 939 if (dir) { 940 pos = search_ref_dir(dir, dirname.buf, dirname.len); 941 if (pos < 0) { 942 /* 943 * There was no directory "refs/foo/", 944 * so there is nothing under this 945 * whole prefix. So there is no need 946 * to continue looking for conflicting 947 * references. But we need to continue 948 * looking for conflicting extras. 949 */ 950 dir = NULL; 951 } else { 952 dir = get_ref_dir(dir->entries[pos]); 953 } 954 } 955 } 956 957 /* 958 * We are at the leaf of our refname (e.g., "refs/foo/bar"). 959 * There is no point in searching for a reference with that 960 * name, because a refname isn't considered to conflict with 961 * itself. But we still need to check for references whose 962 * names are in the "refs/foo/bar/" namespace, because they 963 * *do* conflict. 964 */ 965 strbuf_addstr(&dirname, refname + dirname.len); 966 strbuf_addch(&dirname, '/'); 967 968 if (dir) { 969 pos = search_ref_dir(dir, dirname.buf, dirname.len); 970 971 if (pos >= 0) { 972 /* 973 * We found a directory named "$refname/" 974 * (e.g., "refs/foo/bar/"). It is a problem 975 * iff it contains any ref that is not in 976 * "skip". 977 */ 978 struct nonmatching_ref_data data; 979 980 data.skip = skip; 981 data.conflicting_refname = NULL; 982 dir = get_ref_dir(dir->entries[pos]); 983 sort_ref_dir(dir); 984 if (do_for_each_entry_in_dir(dir, 0, nonmatching_ref_fn, &data)) { 985 strbuf_addf(err, "'%s' exists; cannot create '%s'", 986 data.conflicting_refname, refname); 987 goto cleanup; 988 } 989 } 990 } 991 992 if (extras) { 993 /* 994 * Check for entries in extras that start with 995 * "$refname/". We do that by looking for the place 996 * where "$refname/" would be inserted in extras. If 997 * there is an entry at that position that starts with 998 * "$refname/" and is not in skip, then we have a 999 * conflict.1000 */1001 for (pos = string_list_find_insert_index(extras, dirname.buf, 0);1002 pos < extras->nr; pos++) {1003 const char *extra_refname = extras->items[pos].string;10041005 if (!starts_with(extra_refname, dirname.buf))1006 break;10071008 if (!skip || !string_list_has_string(skip, extra_refname)) {1009 strbuf_addf(err, "cannot process '%s' and '%s' at the same time",1010 refname, extra_refname);1011 goto cleanup;1012 }1013 }1014 }10151016 /* No conflicts were found */1017 ret = 0;10181019cleanup:1020 strbuf_release(&dirname);1021 return ret;1022}10231024struct packed_ref_cache {1025 struct ref_entry *root;10261027 /*1028 * Count of references to the data structure in this instance,1029 * including the pointer from ref_cache::packed if any. The1030 * data will not be freed as long as the reference count is1031 * nonzero.1032 */1033 unsigned int referrers;10341035 /*1036 * Iff the packed-refs file associated with this instance is1037 * currently locked for writing, this points at the associated1038 * lock (which is owned by somebody else). The referrer count1039 * is also incremented when the file is locked and decremented1040 * when it is unlocked.1041 */1042 struct lock_file *lock;10431044 /* The metadata from when this packed-refs cache was read */1045 struct stat_validity validity;1046};10471048/*1049 * Future: need to be in "struct repository"1050 * when doing a full libification.1051 */1052static struct ref_cache {1053 struct ref_cache *next;1054 struct ref_entry *loose;1055 struct packed_ref_cache *packed;1056 /*1057 * The submodule name, or "" for the main repo. We allocate1058 * length 1 rather than FLEX_ARRAY so that the main ref_cache1059 * is initialized correctly.1060 */1061 char name[1];1062} ref_cache, *submodule_ref_caches;10631064/* Lock used for the main packed-refs file: */1065static struct lock_file packlock;10661067/*1068 * Increment the reference count of *packed_refs.1069 */1070static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs)1071{1072 packed_refs->referrers++;1073}10741075/*1076 * Decrease the reference count of *packed_refs. If it goes to zero,1077 * free *packed_refs and return true; otherwise return false.1078 */1079static int release_packed_ref_cache(struct packed_ref_cache *packed_refs)1080{1081 if (!--packed_refs->referrers) {1082 free_ref_entry(packed_refs->root);1083 stat_validity_clear(&packed_refs->validity);1084 free(packed_refs);1085 return 1;1086 } else {1087 return 0;1088 }1089}10901091static void clear_packed_ref_cache(struct ref_cache *refs)1092{1093 if (refs->packed) {1094 struct packed_ref_cache *packed_refs = refs->packed;10951096 if (packed_refs->lock)1097 die("internal error: packed-ref cache cleared while locked");1098 refs->packed = NULL;1099 release_packed_ref_cache(packed_refs);1100 }1101}11021103static void clear_loose_ref_cache(struct ref_cache *refs)1104{1105 if (refs->loose) {1106 free_ref_entry(refs->loose);1107 refs->loose = NULL;1108 }1109}11101111static struct ref_cache *create_ref_cache(const char *submodule)1112{1113 int len;1114 struct ref_cache *refs;1115 if (!submodule)1116 submodule = "";1117 len = strlen(submodule) + 1;1118 refs = xcalloc(1, sizeof(struct ref_cache) + len);1119 memcpy(refs->name, submodule, len);1120 return refs;1121}11221123/*1124 * Return a pointer to a ref_cache for the specified submodule. For1125 * the main repository, use submodule==NULL. The returned structure1126 * will be allocated and initialized but not necessarily populated; it1127 * should not be freed.1128 */1129static struct ref_cache *get_ref_cache(const char *submodule)1130{1131 struct ref_cache *refs;11321133 if (!submodule || !*submodule)1134 return &ref_cache;11351136 for (refs = submodule_ref_caches; refs; refs = refs->next)1137 if (!strcmp(submodule, refs->name))1138 return refs;11391140 refs = create_ref_cache(submodule);1141 refs->next = submodule_ref_caches;1142 submodule_ref_caches = refs;1143 return refs;1144}11451146/* The length of a peeled reference line in packed-refs, including EOL: */1147#define PEELED_LINE_LENGTH 4211481149/*1150 * The packed-refs header line that we write out. Perhaps other1151 * traits will be added later. The trailing space is required.1152 */1153static const char PACKED_REFS_HEADER[] =1154 "# pack-refs with: peeled fully-peeled \n";11551156/*1157 * Parse one line from a packed-refs file. Write the SHA1 to sha1.1158 * Return a pointer to the refname within the line (null-terminated),1159 * or NULL if there was a problem.1160 */1161static const char *parse_ref_line(struct strbuf *line, unsigned char *sha1)1162{1163 const char *ref;11641165 /*1166 * 42: the answer to everything.1167 *1168 * In this case, it happens to be the answer to1169 * 40 (length of sha1 hex representation)1170 * +1 (space in between hex and name)1171 * +1 (newline at the end of the line)1172 */1173 if (line->len <= 42)1174 return NULL;11751176 if (get_sha1_hex(line->buf, sha1) < 0)1177 return NULL;1178 if (!isspace(line->buf[40]))1179 return NULL;11801181 ref = line->buf + 41;1182 if (isspace(*ref))1183 return NULL;11841185 if (line->buf[line->len - 1] != '\n')1186 return NULL;1187 line->buf[--line->len] = 0;11881189 return ref;1190}11911192/*1193 * Read f, which is a packed-refs file, into dir.1194 *1195 * A comment line of the form "# pack-refs with: " may contain zero or1196 * more traits. We interpret the traits as follows:1197 *1198 * No traits:1199 *1200 * Probably no references are peeled. But if the file contains a1201 * peeled value for a reference, we will use it.1202 *1203 * peeled:1204 *1205 * References under "refs/tags/", if they *can* be peeled, *are*1206 * peeled in this file. References outside of "refs/tags/" are1207 * probably not peeled even if they could have been, but if we find1208 * a peeled value for such a reference we will use it.1209 *1210 * fully-peeled:1211 *1212 * All references in the file that can be peeled are peeled.1213 * Inversely (and this is more important), any references in the1214 * file for which no peeled value is recorded is not peelable. This1215 * trait should typically be written alongside "peeled" for1216 * compatibility with older clients, but we do not require it1217 * (i.e., "peeled" is a no-op if "fully-peeled" is set).1218 */1219static void read_packed_refs(FILE *f, struct ref_dir *dir)1220{1221 struct ref_entry *last = NULL;1222 struct strbuf line = STRBUF_INIT;1223 enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;12241225 while (strbuf_getwholeline(&line, f, '\n') != EOF) {1226 unsigned char sha1[20];1227 const char *refname;1228 const char *traits;12291230 if (skip_prefix(line.buf, "# pack-refs with:", &traits)) {1231 if (strstr(traits, " fully-peeled "))1232 peeled = PEELED_FULLY;1233 else if (strstr(traits, " peeled "))1234 peeled = PEELED_TAGS;1235 /* perhaps other traits later as well */1236 continue;1237 }12381239 refname = parse_ref_line(&line, sha1);1240 if (refname) {1241 int flag = REF_ISPACKED;12421243 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {1244 if (!refname_is_safe(refname))1245 die("packed refname is dangerous: %s", refname);1246 hashclr(sha1);1247 flag |= REF_BAD_NAME | REF_ISBROKEN;1248 }1249 last = create_ref_entry(refname, sha1, flag, 0);1250 if (peeled == PEELED_FULLY ||1251 (peeled == PEELED_TAGS && starts_with(refname, "refs/tags/")))1252 last->flag |= REF_KNOWS_PEELED;1253 add_ref(dir, last);1254 continue;1255 }1256 if (last &&1257 line.buf[0] == '^' &&1258 line.len == PEELED_LINE_LENGTH &&1259 line.buf[PEELED_LINE_LENGTH - 1] == '\n' &&1260 !get_sha1_hex(line.buf + 1, sha1)) {1261 hashcpy(last->u.value.peeled.hash, sha1);1262 /*1263 * Regardless of what the file header said,1264 * we definitely know the value of *this*1265 * reference:1266 */1267 last->flag |= REF_KNOWS_PEELED;1268 }1269 }12701271 strbuf_release(&line);1272}12731274/*1275 * Get the packed_ref_cache for the specified ref_cache, creating it1276 * if necessary.1277 */1278static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs)1279{1280 const char *packed_refs_file;12811282 if (*refs->name)1283 packed_refs_file = git_path_submodule(refs->name, "packed-refs");1284 else1285 packed_refs_file = git_path("packed-refs");12861287 if (refs->packed &&1288 !stat_validity_check(&refs->packed->validity, packed_refs_file))1289 clear_packed_ref_cache(refs);12901291 if (!refs->packed) {1292 FILE *f;12931294 refs->packed = xcalloc(1, sizeof(*refs->packed));1295 acquire_packed_ref_cache(refs->packed);1296 refs->packed->root = create_dir_entry(refs, "", 0, 0);1297 f = fopen(packed_refs_file, "r");1298 if (f) {1299 stat_validity_update(&refs->packed->validity, fileno(f));1300 read_packed_refs(f, get_ref_dir(refs->packed->root));1301 fclose(f);1302 }1303 }1304 return refs->packed;1305}13061307static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_cache)1308{1309 return get_ref_dir(packed_ref_cache->root);1310}13111312static struct ref_dir *get_packed_refs(struct ref_cache *refs)1313{1314 return get_packed_ref_dir(get_packed_ref_cache(refs));1315}13161317void add_packed_ref(const char *refname, const unsigned char *sha1)1318{1319 struct packed_ref_cache *packed_ref_cache =1320 get_packed_ref_cache(&ref_cache);13211322 if (!packed_ref_cache->lock)1323 die("internal error: packed refs not locked");1324 add_ref(get_packed_ref_dir(packed_ref_cache),1325 create_ref_entry(refname, sha1, REF_ISPACKED, 1));1326}13271328/*1329 * Read the loose references from the namespace dirname into dir1330 * (without recursing). dirname must end with '/'. dir must be the1331 * directory entry corresponding to dirname.1332 */1333static void read_loose_refs(const char *dirname, struct ref_dir *dir)1334{1335 struct ref_cache *refs = dir->ref_cache;1336 DIR *d;1337 const char *path;1338 struct dirent *de;1339 int dirnamelen = strlen(dirname);1340 struct strbuf refname;13411342 if (*refs->name)1343 path = git_path_submodule(refs->name, "%s", dirname);1344 else1345 path = git_path("%s", dirname);13461347 d = opendir(path);1348 if (!d)1349 return;13501351 strbuf_init(&refname, dirnamelen + 257);1352 strbuf_add(&refname, dirname, dirnamelen);13531354 while ((de = readdir(d)) != NULL) {1355 unsigned char sha1[20];1356 struct stat st;1357 int flag;1358 const char *refdir;13591360 if (de->d_name[0] == '.')1361 continue;1362 if (ends_with(de->d_name, ".lock"))1363 continue;1364 strbuf_addstr(&refname, de->d_name);1365 refdir = *refs->name1366 ? git_path_submodule(refs->name, "%s", refname.buf)1367 : git_path("%s", refname.buf);1368 if (stat(refdir, &st) < 0) {1369 ; /* silently ignore */1370 } else if (S_ISDIR(st.st_mode)) {1371 strbuf_addch(&refname, '/');1372 add_entry_to_dir(dir,1373 create_dir_entry(refs, refname.buf,1374 refname.len, 1));1375 } else {1376 if (*refs->name) {1377 hashclr(sha1);1378 flag = 0;1379 if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {1380 hashclr(sha1);1381 flag |= REF_ISBROKEN;1382 }1383 } else if (read_ref_full(refname.buf,1384 RESOLVE_REF_READING,1385 sha1, &flag)) {1386 hashclr(sha1);1387 flag |= REF_ISBROKEN;1388 }1389 if (check_refname_format(refname.buf,1390 REFNAME_ALLOW_ONELEVEL)) {1391 if (!refname_is_safe(refname.buf))1392 die("loose refname is dangerous: %s", refname.buf);1393 hashclr(sha1);1394 flag |= REF_BAD_NAME | REF_ISBROKEN;1395 }1396 add_entry_to_dir(dir,1397 create_ref_entry(refname.buf, sha1, flag, 0));1398 }1399 strbuf_setlen(&refname, dirnamelen);1400 }1401 strbuf_release(&refname);1402 closedir(d);1403}14041405static struct ref_dir *get_loose_refs(struct ref_cache *refs)1406{1407 if (!refs->loose) {1408 /*1409 * Mark the top-level directory complete because we1410 * are about to read the only subdirectory that can1411 * hold references:1412 */1413 refs->loose = create_dir_entry(refs, "", 0, 0);1414 /*1415 * Create an incomplete entry for "refs/":1416 */1417 add_entry_to_dir(get_ref_dir(refs->loose),1418 create_dir_entry(refs, "refs/", 5, 1));1419 }1420 return get_ref_dir(refs->loose);1421}14221423/* We allow "recursive" symbolic refs. Only within reason, though */1424#define MAXDEPTH 51425#define MAXREFLEN (1024)14261427/*1428 * Called by resolve_gitlink_ref_recursive() after it failed to read1429 * from the loose refs in ref_cache refs. Find <refname> in the1430 * packed-refs file for the submodule.1431 */1432static int resolve_gitlink_packed_ref(struct ref_cache *refs,1433 const char *refname, unsigned char *sha1)1434{1435 struct ref_entry *ref;1436 struct ref_dir *dir = get_packed_refs(refs);14371438 ref = find_ref(dir, refname);1439 if (ref == NULL)1440 return -1;14411442 hashcpy(sha1, ref->u.value.oid.hash);1443 return 0;1444}14451446static int resolve_gitlink_ref_recursive(struct ref_cache *refs,1447 const char *refname, unsigned char *sha1,1448 int recursion)1449{1450 int fd, len;1451 char buffer[128], *p;1452 const char *path;14531454 if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)1455 return -1;1456 path = *refs->name1457 ? git_path_submodule(refs->name, "%s", refname)1458 : git_path("%s", refname);1459 fd = open(path, O_RDONLY);1460 if (fd < 0)1461 return resolve_gitlink_packed_ref(refs, refname, sha1);14621463 len = read(fd, buffer, sizeof(buffer)-1);1464 close(fd);1465 if (len < 0)1466 return -1;1467 while (len && isspace(buffer[len-1]))1468 len--;1469 buffer[len] = 0;14701471 /* Was it a detached head or an old-fashioned symlink? */1472 if (!get_sha1_hex(buffer, sha1))1473 return 0;14741475 /* Symref? */1476 if (strncmp(buffer, "ref:", 4))1477 return -1;1478 p = buffer + 4;1479 while (isspace(*p))1480 p++;14811482 return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);1483}14841485int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)1486{1487 int len = strlen(path), retval;1488 char *submodule;1489 struct ref_cache *refs;14901491 while (len && path[len-1] == '/')1492 len--;1493 if (!len)1494 return -1;1495 submodule = xstrndup(path, len);1496 refs = get_ref_cache(submodule);1497 free(submodule);14981499 retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);1500 return retval;1501}15021503/*1504 * Return the ref_entry for the given refname from the packed1505 * references. If it does not exist, return NULL.1506 */1507static struct ref_entry *get_packed_ref(const char *refname)1508{1509 return find_ref(get_packed_refs(&ref_cache), refname);1510}15111512/*1513 * A loose ref file doesn't exist; check for a packed ref. The1514 * options are forwarded from resolve_safe_unsafe().1515 */1516static int resolve_missing_loose_ref(const char *refname,1517 int resolve_flags,1518 unsigned char *sha1,1519 int *flags)1520{1521 struct ref_entry *entry;15221523 /*1524 * The loose reference file does not exist; check for a packed1525 * reference.1526 */1527 entry = get_packed_ref(refname);1528 if (entry) {1529 hashcpy(sha1, entry->u.value.oid.hash);1530 if (flags)1531 *flags |= REF_ISPACKED;1532 return 0;1533 }1534 /* The reference is not a packed reference, either. */1535 if (resolve_flags & RESOLVE_REF_READING) {1536 errno = ENOENT;1537 return -1;1538 } else {1539 hashclr(sha1);1540 return 0;1541 }1542}15431544/* This function needs to return a meaningful errno on failure */1545static const char *resolve_ref_unsafe_1(const char *refname,1546 int resolve_flags,1547 unsigned char *sha1,1548 int *flags,1549 struct strbuf *sb_path)1550{1551 int depth = MAXDEPTH;1552 ssize_t len;1553 char buffer[256];1554 static char refname_buffer[256];1555 int bad_name = 0;15561557 if (flags)1558 *flags = 0;15591560 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {1561 if (flags)1562 *flags |= REF_BAD_NAME;15631564 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||1565 !refname_is_safe(refname)) {1566 errno = EINVAL;1567 return NULL;1568 }1569 /*1570 * dwim_ref() uses REF_ISBROKEN to distinguish between1571 * missing refs and refs that were present but invalid,1572 * to complain about the latter to stderr.1573 *1574 * We don't know whether the ref exists, so don't set1575 * REF_ISBROKEN yet.1576 */1577 bad_name = 1;1578 }1579 for (;;) {1580 const char *path;1581 struct stat st;1582 char *buf;1583 int fd;15841585 if (--depth < 0) {1586 errno = ELOOP;1587 return NULL;1588 }15891590 strbuf_reset(sb_path);1591 strbuf_git_path(sb_path, "%s", refname);1592 path = sb_path->buf;15931594 /*1595 * We might have to loop back here to avoid a race1596 * condition: first we lstat() the file, then we try1597 * to read it as a link or as a file. But if somebody1598 * changes the type of the file (file <-> directory1599 * <-> symlink) between the lstat() and reading, then1600 * we don't want to report that as an error but rather1601 * try again starting with the lstat().1602 */1603 stat_ref:1604 if (lstat(path, &st) < 0) {1605 if (errno != ENOENT)1606 return NULL;1607 if (resolve_missing_loose_ref(refname, resolve_flags,1608 sha1, flags))1609 return NULL;1610 if (bad_name) {1611 hashclr(sha1);1612 if (flags)1613 *flags |= REF_ISBROKEN;1614 }1615 return refname;1616 }16171618 /* Follow "normalized" - ie "refs/.." symlinks by hand */1619 if (S_ISLNK(st.st_mode)) {1620 len = readlink(path, buffer, sizeof(buffer)-1);1621 if (len < 0) {1622 if (errno == ENOENT || errno == EINVAL)1623 /* inconsistent with lstat; retry */1624 goto stat_ref;1625 else1626 return NULL;1627 }1628 buffer[len] = 0;1629 if (starts_with(buffer, "refs/") &&1630 !check_refname_format(buffer, 0)) {1631 strcpy(refname_buffer, buffer);1632 refname = refname_buffer;1633 if (flags)1634 *flags |= REF_ISSYMREF;1635 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {1636 hashclr(sha1);1637 return refname;1638 }1639 continue;1640 }1641 }16421643 /* Is it a directory? */1644 if (S_ISDIR(st.st_mode)) {1645 errno = EISDIR;1646 return NULL;1647 }16481649 /*1650 * Anything else, just open it and try to use it as1651 * a ref1652 */1653 fd = open(path, O_RDONLY);1654 if (fd < 0) {1655 if (errno == ENOENT)1656 /* inconsistent with lstat; retry */1657 goto stat_ref;1658 else1659 return NULL;1660 }1661 len = read_in_full(fd, buffer, sizeof(buffer)-1);1662 if (len < 0) {1663 int save_errno = errno;1664 close(fd);1665 errno = save_errno;1666 return NULL;1667 }1668 close(fd);1669 while (len && isspace(buffer[len-1]))1670 len--;1671 buffer[len] = '\0';16721673 /*1674 * Is it a symbolic ref?1675 */1676 if (!starts_with(buffer, "ref:")) {1677 /*1678 * Please note that FETCH_HEAD has a second1679 * line containing other data.1680 */1681 if (get_sha1_hex(buffer, sha1) ||1682 (buffer[40] != '\0' && !isspace(buffer[40]))) {1683 if (flags)1684 *flags |= REF_ISBROKEN;1685 errno = EINVAL;1686 return NULL;1687 }1688 if (bad_name) {1689 hashclr(sha1);1690 if (flags)1691 *flags |= REF_ISBROKEN;1692 }1693 return refname;1694 }1695 if (flags)1696 *flags |= REF_ISSYMREF;1697 buf = buffer + 4;1698 while (isspace(*buf))1699 buf++;1700 refname = strcpy(refname_buffer, buf);1701 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {1702 hashclr(sha1);1703 return refname;1704 }1705 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {1706 if (flags)1707 *flags |= REF_ISBROKEN;17081709 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||1710 !refname_is_safe(buf)) {1711 errno = EINVAL;1712 return NULL;1713 }1714 bad_name = 1;1715 }1716 }1717}17181719const char *resolve_ref_unsafe(const char *refname, int resolve_flags,1720 unsigned char *sha1, int *flags)1721{1722 struct strbuf sb_path = STRBUF_INIT;1723 const char *ret = resolve_ref_unsafe_1(refname, resolve_flags,1724 sha1, flags, &sb_path);1725 strbuf_release(&sb_path);1726 return ret;1727}17281729char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags)1730{1731 return xstrdup_or_null(resolve_ref_unsafe(ref, resolve_flags, sha1, flags));1732}17331734/* The argument to filter_refs */1735struct ref_filter {1736 const char *pattern;1737 each_ref_fn *fn;1738 void *cb_data;1739};17401741int read_ref_full(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)1742{1743 if (resolve_ref_unsafe(refname, resolve_flags, sha1, flags))1744 return 0;1745 return -1;1746}17471748int read_ref(const char *refname, unsigned char *sha1)1749{1750 return read_ref_full(refname, RESOLVE_REF_READING, sha1, NULL);1751}17521753int ref_exists(const char *refname)1754{1755 unsigned char sha1[20];1756 return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, sha1, NULL);1757}17581759static int filter_refs(const char *refname, const struct object_id *oid,1760 int flags, void *data)1761{1762 struct ref_filter *filter = (struct ref_filter *)data;17631764 if (wildmatch(filter->pattern, refname, 0, NULL))1765 return 0;1766 return filter->fn(refname, oid, flags, filter->cb_data);1767}17681769enum peel_status {1770 /* object was peeled successfully: */1771 PEEL_PEELED = 0,17721773 /*1774 * object cannot be peeled because the named object (or an1775 * object referred to by a tag in the peel chain), does not1776 * exist.1777 */1778 PEEL_INVALID = -1,17791780 /* object cannot be peeled because it is not a tag: */1781 PEEL_NON_TAG = -2,17821783 /* ref_entry contains no peeled value because it is a symref: */1784 PEEL_IS_SYMREF = -3,17851786 /*1787 * ref_entry cannot be peeled because it is broken (i.e., the1788 * symbolic reference cannot even be resolved to an object1789 * name):1790 */1791 PEEL_BROKEN = -41792};17931794/*1795 * Peel the named object; i.e., if the object is a tag, resolve the1796 * tag recursively until a non-tag is found. If successful, store the1797 * result to sha1 and return PEEL_PEELED. If the object is not a tag1798 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,1799 * and leave sha1 unchanged.1800 */1801static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)1802{1803 struct object *o = lookup_unknown_object(name);18041805 if (o->type == OBJ_NONE) {1806 int type = sha1_object_info(name, NULL);1807 if (type < 0 || !object_as_type(o, type, 0))1808 return PEEL_INVALID;1809 }18101811 if (o->type != OBJ_TAG)1812 return PEEL_NON_TAG;18131814 o = deref_tag_noverify(o);1815 if (!o)1816 return PEEL_INVALID;18171818 hashcpy(sha1, o->sha1);1819 return PEEL_PEELED;1820}18211822/*1823 * Peel the entry (if possible) and return its new peel_status. If1824 * repeel is true, re-peel the entry even if there is an old peeled1825 * value that is already stored in it.1826 *1827 * It is OK to call this function with a packed reference entry that1828 * might be stale and might even refer to an object that has since1829 * been garbage-collected. In such a case, if the entry has1830 * REF_KNOWS_PEELED then leave the status unchanged and return1831 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.1832 */1833static enum peel_status peel_entry(struct ref_entry *entry, int repeel)1834{1835 enum peel_status status;18361837 if (entry->flag & REF_KNOWS_PEELED) {1838 if (repeel) {1839 entry->flag &= ~REF_KNOWS_PEELED;1840 oidclr(&entry->u.value.peeled);1841 } else {1842 return is_null_oid(&entry->u.value.peeled) ?1843 PEEL_NON_TAG : PEEL_PEELED;1844 }1845 }1846 if (entry->flag & REF_ISBROKEN)1847 return PEEL_BROKEN;1848 if (entry->flag & REF_ISSYMREF)1849 return PEEL_IS_SYMREF;18501851 status = peel_object(entry->u.value.oid.hash, entry->u.value.peeled.hash);1852 if (status == PEEL_PEELED || status == PEEL_NON_TAG)1853 entry->flag |= REF_KNOWS_PEELED;1854 return status;1855}18561857int peel_ref(const char *refname, unsigned char *sha1)1858{1859 int flag;1860 unsigned char base[20];18611862 if (current_ref && (current_ref->name == refname1863 || !strcmp(current_ref->name, refname))) {1864 if (peel_entry(current_ref, 0))1865 return -1;1866 hashcpy(sha1, current_ref->u.value.peeled.hash);1867 return 0;1868 }18691870 if (read_ref_full(refname, RESOLVE_REF_READING, base, &flag))1871 return -1;18721873 /*1874 * If the reference is packed, read its ref_entry from the1875 * cache in the hope that we already know its peeled value.1876 * We only try this optimization on packed references because1877 * (a) forcing the filling of the loose reference cache could1878 * be expensive and (b) loose references anyway usually do not1879 * have REF_KNOWS_PEELED.1880 */1881 if (flag & REF_ISPACKED) {1882 struct ref_entry *r = get_packed_ref(refname);1883 if (r) {1884 if (peel_entry(r, 0))1885 return -1;1886 hashcpy(sha1, r->u.value.peeled.hash);1887 return 0;1888 }1889 }18901891 return peel_object(base, sha1);1892}18931894struct warn_if_dangling_data {1895 FILE *fp;1896 const char *refname;1897 const struct string_list *refnames;1898 const char *msg_fmt;1899};19001901static int warn_if_dangling_symref(const char *refname, const struct object_id *oid,1902 int flags, void *cb_data)1903{1904 struct warn_if_dangling_data *d = cb_data;1905 const char *resolves_to;1906 unsigned char junk[20];19071908 if (!(flags & REF_ISSYMREF))1909 return 0;19101911 resolves_to = resolve_ref_unsafe(refname, 0, junk, NULL);1912 if (!resolves_to1913 || (d->refname1914 ? strcmp(resolves_to, d->refname)1915 : !string_list_has_string(d->refnames, resolves_to))) {1916 return 0;1917 }19181919 fprintf(d->fp, d->msg_fmt, refname);1920 fputc('\n', d->fp);1921 return 0;1922}19231924void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)1925{1926 struct warn_if_dangling_data data;19271928 data.fp = fp;1929 data.refname = refname;1930 data.refnames = NULL;1931 data.msg_fmt = msg_fmt;1932 for_each_rawref(warn_if_dangling_symref, &data);1933}19341935void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)1936{1937 struct warn_if_dangling_data data;19381939 data.fp = fp;1940 data.refname = NULL;1941 data.refnames = refnames;1942 data.msg_fmt = msg_fmt;1943 for_each_rawref(warn_if_dangling_symref, &data);1944}19451946/*1947 * Call fn for each reference in the specified ref_cache, omitting1948 * references not in the containing_dir of base. fn is called for all1949 * references, including broken ones. If fn ever returns a non-zero1950 * value, stop the iteration and return that value; otherwise, return1951 * 0.1952 */1953static int do_for_each_entry(struct ref_cache *refs, const char *base,1954 each_ref_entry_fn fn, void *cb_data)1955{1956 struct packed_ref_cache *packed_ref_cache;1957 struct ref_dir *loose_dir;1958 struct ref_dir *packed_dir;1959 int retval = 0;19601961 /*1962 * We must make sure that all loose refs are read before accessing the1963 * packed-refs file; this avoids a race condition in which loose refs1964 * are migrated to the packed-refs file by a simultaneous process, but1965 * our in-memory view is from before the migration. get_packed_ref_cache()1966 * takes care of making sure our view is up to date with what is on1967 * disk.1968 */1969 loose_dir = get_loose_refs(refs);1970 if (base && *base) {1971 loose_dir = find_containing_dir(loose_dir, base, 0);1972 }1973 if (loose_dir)1974 prime_ref_dir(loose_dir);19751976 packed_ref_cache = get_packed_ref_cache(refs);1977 acquire_packed_ref_cache(packed_ref_cache);1978 packed_dir = get_packed_ref_dir(packed_ref_cache);1979 if (base && *base) {1980 packed_dir = find_containing_dir(packed_dir, base, 0);1981 }19821983 if (packed_dir && loose_dir) {1984 sort_ref_dir(packed_dir);1985 sort_ref_dir(loose_dir);1986 retval = do_for_each_entry_in_dirs(1987 packed_dir, loose_dir, fn, cb_data);1988 } else if (packed_dir) {1989 sort_ref_dir(packed_dir);1990 retval = do_for_each_entry_in_dir(1991 packed_dir, 0, fn, cb_data);1992 } else if (loose_dir) {1993 sort_ref_dir(loose_dir);1994 retval = do_for_each_entry_in_dir(1995 loose_dir, 0, fn, cb_data);1996 }19971998 release_packed_ref_cache(packed_ref_cache);1999 return retval;2000}20012002/*2003 * Call fn for each reference in the specified ref_cache for which the2004 * refname begins with base. If trim is non-zero, then trim that many2005 * characters off the beginning of each refname before passing the2006 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include2007 * broken references in the iteration. If fn ever returns a non-zero2008 * value, stop the iteration and return that value; otherwise, return2009 * 0.2010 */2011static int do_for_each_ref(struct ref_cache *refs, const char *base,2012 each_ref_fn fn, int trim, int flags, void *cb_data)2013{2014 struct ref_entry_cb data;2015 data.base = base;2016 data.trim = trim;2017 data.flags = flags;2018 data.fn = fn;2019 data.cb_data = cb_data;20202021 if (ref_paranoia < 0)2022 ref_paranoia = git_env_bool("GIT_REF_PARANOIA", 0);2023 if (ref_paranoia)2024 data.flags |= DO_FOR_EACH_INCLUDE_BROKEN;20252026 return do_for_each_entry(refs, base, do_one_ref, &data);2027}20282029static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)2030{2031 struct object_id oid;2032 int flag;20332034 if (submodule) {2035 if (resolve_gitlink_ref(submodule, "HEAD", oid.hash) == 0)2036 return fn("HEAD", &oid, 0, cb_data);20372038 return 0;2039 }20402041 if (!read_ref_full("HEAD", RESOLVE_REF_READING, oid.hash, &flag))2042 return fn("HEAD", &oid, flag, cb_data);20432044 return 0;2045}20462047int head_ref(each_ref_fn fn, void *cb_data)2048{2049 return do_head_ref(NULL, fn, cb_data);2050}20512052int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)2053{2054 return do_head_ref(submodule, fn, cb_data);2055}20562057int for_each_ref(each_ref_fn fn, void *cb_data)2058{2059 return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);2060}20612062int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)2063{2064 return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);2065}20662067int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)2068{2069 return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);2070}20712072int for_each_ref_in_submodule(const char *submodule, const char *prefix,2073 each_ref_fn fn, void *cb_data)2074{2075 return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);2076}20772078int for_each_tag_ref(each_ref_fn fn, void *cb_data)2079{2080 return for_each_ref_in("refs/tags/", fn, cb_data);2081}20822083int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)2084{2085 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);2086}20872088int for_each_branch_ref(each_ref_fn fn, void *cb_data)2089{2090 return for_each_ref_in("refs/heads/", fn, cb_data);2091}20922093int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)2094{2095 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);2096}20972098int for_each_remote_ref(each_ref_fn fn, void *cb_data)2099{2100 return for_each_ref_in("refs/remotes/", fn, cb_data);2101}21022103int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)2104{2105 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);2106}21072108int for_each_replace_ref(each_ref_fn fn, void *cb_data)2109{2110 return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);2111}21122113int head_ref_namespaced(each_ref_fn fn, void *cb_data)2114{2115 struct strbuf buf = STRBUF_INIT;2116 int ret = 0;2117 struct object_id oid;2118 int flag;21192120 strbuf_addf(&buf, "%sHEAD", get_git_namespace());2121 if (!read_ref_full(buf.buf, RESOLVE_REF_READING, oid.hash, &flag))2122 ret = fn(buf.buf, &oid, flag, cb_data);2123 strbuf_release(&buf);21242125 return ret;2126}21272128int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)2129{2130 struct strbuf buf = STRBUF_INIT;2131 int ret;2132 strbuf_addf(&buf, "%srefs/", get_git_namespace());2133 ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);2134 strbuf_release(&buf);2135 return ret;2136}21372138int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,2139 const char *prefix, void *cb_data)2140{2141 struct strbuf real_pattern = STRBUF_INIT;2142 struct ref_filter filter;2143 int ret;21442145 if (!prefix && !starts_with(pattern, "refs/"))2146 strbuf_addstr(&real_pattern, "refs/");2147 else if (prefix)2148 strbuf_addstr(&real_pattern, prefix);2149 strbuf_addstr(&real_pattern, pattern);21502151 if (!has_glob_specials(pattern)) {2152 /* Append implied '/' '*' if not present. */2153 if (real_pattern.buf[real_pattern.len - 1] != '/')2154 strbuf_addch(&real_pattern, '/');2155 /* No need to check for '*', there is none. */2156 strbuf_addch(&real_pattern, '*');2157 }21582159 filter.pattern = real_pattern.buf;2160 filter.fn = fn;2161 filter.cb_data = cb_data;2162 ret = for_each_ref(filter_refs, &filter);21632164 strbuf_release(&real_pattern);2165 return ret;2166}21672168int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)2169{2170 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);2171}21722173int for_each_rawref(each_ref_fn fn, void *cb_data)2174{2175 return do_for_each_ref(&ref_cache, "", fn, 0,2176 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);2177}21782179int each_ref_fn_adapter(const char *refname,2180 const struct object_id *oid, int flags, void *cb_data)2181{2182 struct each_ref_fn_sha1_adapter *cb = cb_data;21832184 return cb->original_fn(refname, oid->hash, flags, cb->original_cb_data);2185}21862187const char *prettify_refname(const char *name)2188{2189 return name + (2190 starts_with(name, "refs/heads/") ? 11 :2191 starts_with(name, "refs/tags/") ? 10 :2192 starts_with(name, "refs/remotes/") ? 13 :2193 0);2194}21952196static const char *ref_rev_parse_rules[] = {2197 "%.*s",2198 "refs/%.*s",2199 "refs/tags/%.*s",2200 "refs/heads/%.*s",2201 "refs/remotes/%.*s",2202 "refs/remotes/%.*s/HEAD",2203 NULL2204};22052206int refname_match(const char *abbrev_name, const char *full_name)2207{2208 const char **p;2209 const int abbrev_name_len = strlen(abbrev_name);22102211 for (p = ref_rev_parse_rules; *p; p++) {2212 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {2213 return 1;2214 }2215 }22162217 return 0;2218}22192220static void unlock_ref(struct ref_lock *lock)2221{2222 /* Do not free lock->lk -- atexit() still looks at them */2223 if (lock->lk)2224 rollback_lock_file(lock->lk);2225 free(lock->ref_name);2226 free(lock->orig_ref_name);2227 free(lock);2228}22292230/* This function should make sure errno is meaningful on error */2231static struct ref_lock *verify_lock(struct ref_lock *lock,2232 const unsigned char *old_sha1, int mustexist)2233{2234 if (read_ref_full(lock->ref_name,2235 mustexist ? RESOLVE_REF_READING : 0,2236 lock->old_sha1, NULL)) {2237 int save_errno = errno;2238 error("Can't verify ref %s", lock->ref_name);2239 unlock_ref(lock);2240 errno = save_errno;2241 return NULL;2242 }2243 if (hashcmp(lock->old_sha1, old_sha1)) {2244 error("Ref %s is at %s but expected %s", lock->ref_name,2245 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));2246 unlock_ref(lock);2247 errno = EBUSY;2248 return NULL;2249 }2250 return lock;2251}22522253static int remove_empty_directories(const char *file)2254{2255 /* we want to create a file but there is a directory there;2256 * if that is an empty directory (or a directory that contains2257 * only empty directories), remove them.2258 */2259 struct strbuf path;2260 int result, save_errno;22612262 strbuf_init(&path, 20);2263 strbuf_addstr(&path, file);22642265 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);2266 save_errno = errno;22672268 strbuf_release(&path);2269 errno = save_errno;22702271 return result;2272}22732274/*2275 * *string and *len will only be substituted, and *string returned (for2276 * later free()ing) if the string passed in is a magic short-hand form2277 * to name a branch.2278 */2279static char *substitute_branch_name(const char **string, int *len)2280{2281 struct strbuf buf = STRBUF_INIT;2282 int ret = interpret_branch_name(*string, *len, &buf);22832284 if (ret == *len) {2285 size_t size;2286 *string = strbuf_detach(&buf, &size);2287 *len = size;2288 return (char *)*string;2289 }22902291 return NULL;2292}22932294int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)2295{2296 char *last_branch = substitute_branch_name(&str, &len);2297 const char **p, *r;2298 int refs_found = 0;22992300 *ref = NULL;2301 for (p = ref_rev_parse_rules; *p; p++) {2302 char fullref[PATH_MAX];2303 unsigned char sha1_from_ref[20];2304 unsigned char *this_result;2305 int flag;23062307 this_result = refs_found ? sha1_from_ref : sha1;2308 mksnpath(fullref, sizeof(fullref), *p, len, str);2309 r = resolve_ref_unsafe(fullref, RESOLVE_REF_READING,2310 this_result, &flag);2311 if (r) {2312 if (!refs_found++)2313 *ref = xstrdup(r);2314 if (!warn_ambiguous_refs)2315 break;2316 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {2317 warning("ignoring dangling symref %s.", fullref);2318 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {2319 warning("ignoring broken ref %s.", fullref);2320 }2321 }2322 free(last_branch);2323 return refs_found;2324}23252326int dwim_log(const char *str, int len, unsigned char *sha1, char **log)2327{2328 char *last_branch = substitute_branch_name(&str, &len);2329 const char **p;2330 int logs_found = 0;23312332 *log = NULL;2333 for (p = ref_rev_parse_rules; *p; p++) {2334 unsigned char hash[20];2335 char path[PATH_MAX];2336 const char *ref, *it;23372338 mksnpath(path, sizeof(path), *p, len, str);2339 ref = resolve_ref_unsafe(path, RESOLVE_REF_READING,2340 hash, NULL);2341 if (!ref)2342 continue;2343 if (reflog_exists(path))2344 it = path;2345 else if (strcmp(ref, path) && reflog_exists(ref))2346 it = ref;2347 else2348 continue;2349 if (!logs_found++) {2350 *log = xstrdup(it);2351 hashcpy(sha1, hash);2352 }2353 if (!warn_ambiguous_refs)2354 break;2355 }2356 free(last_branch);2357 return logs_found;2358}23592360/*2361 * Locks a ref returning the lock on success and NULL on failure.2362 * On failure errno is set to something meaningful.2363 */2364static struct ref_lock *lock_ref_sha1_basic(const char *refname,2365 const unsigned char *old_sha1,2366 const struct string_list *extras,2367 const struct string_list *skip,2368 unsigned int flags, int *type_p,2369 struct strbuf *err)2370{2371 const char *ref_file;2372 const char *orig_refname = refname;2373 struct ref_lock *lock;2374 int last_errno = 0;2375 int type, lflags;2376 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));2377 int resolve_flags = 0;2378 int attempts_remaining = 3;23792380 assert(err);23812382 lock = xcalloc(1, sizeof(struct ref_lock));23832384 if (mustexist)2385 resolve_flags |= RESOLVE_REF_READING;2386 if (flags & REF_DELETING) {2387 resolve_flags |= RESOLVE_REF_ALLOW_BAD_NAME;2388 if (flags & REF_NODEREF)2389 resolve_flags |= RESOLVE_REF_NO_RECURSE;2390 }23912392 refname = resolve_ref_unsafe(refname, resolve_flags,2393 lock->old_sha1, &type);2394 if (!refname && errno == EISDIR) {2395 /* we are trying to lock foo but we used to2396 * have foo/bar which now does not exist;2397 * it is normal for the empty directory 'foo'2398 * to remain.2399 */2400 ref_file = git_path("%s", orig_refname);2401 if (remove_empty_directories(ref_file)) {2402 last_errno = errno;24032404 if (!verify_refname_available(orig_refname, extras, skip,2405 get_loose_refs(&ref_cache), err))2406 strbuf_addf(err, "there are still refs under '%s'",2407 orig_refname);24082409 goto error_return;2410 }2411 refname = resolve_ref_unsafe(orig_refname, resolve_flags,2412 lock->old_sha1, &type);2413 }2414 if (type_p)2415 *type_p = type;2416 if (!refname) {2417 last_errno = errno;2418 if (last_errno != ENOTDIR ||2419 !verify_refname_available(orig_refname, extras, skip,2420 get_loose_refs(&ref_cache), err))2421 strbuf_addf(err, "unable to resolve reference %s: %s",2422 orig_refname, strerror(last_errno));24232424 goto error_return;2425 }2426 /*2427 * If the ref did not exist and we are creating it, make sure2428 * there is no existing packed ref whose name begins with our2429 * refname, nor a packed ref whose name is a proper prefix of2430 * our refname.2431 */2432 if (is_null_sha1(lock->old_sha1) &&2433 verify_refname_available(refname, extras, skip,2434 get_packed_refs(&ref_cache), err)) {2435 last_errno = ENOTDIR;2436 goto error_return;2437 }24382439 lock->lk = xcalloc(1, sizeof(struct lock_file));24402441 lflags = 0;2442 if (flags & REF_NODEREF) {2443 refname = orig_refname;2444 lflags |= LOCK_NO_DEREF;2445 }2446 lock->ref_name = xstrdup(refname);2447 lock->orig_ref_name = xstrdup(orig_refname);2448 ref_file = git_path("%s", refname);24492450 retry:2451 switch (safe_create_leading_directories_const(ref_file)) {2452 case SCLD_OK:2453 break; /* success */2454 case SCLD_VANISHED:2455 if (--attempts_remaining > 0)2456 goto retry;2457 /* fall through */2458 default:2459 last_errno = errno;2460 strbuf_addf(err, "unable to create directory for %s", ref_file);2461 goto error_return;2462 }24632464 if (hold_lock_file_for_update(lock->lk, ref_file, lflags) < 0) {2465 last_errno = errno;2466 if (errno == ENOENT && --attempts_remaining > 0)2467 /*2468 * Maybe somebody just deleted one of the2469 * directories leading to ref_file. Try2470 * again:2471 */2472 goto retry;2473 else {2474 unable_to_lock_message(ref_file, errno, err);2475 goto error_return;2476 }2477 }2478 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;24792480 error_return:2481 unlock_ref(lock);2482 errno = last_errno;2483 return NULL;2484}24852486/*2487 * Write an entry to the packed-refs file for the specified refname.2488 * If peeled is non-NULL, write it as the entry's peeled value.2489 */2490static void write_packed_entry(FILE *fh, char *refname, unsigned char *sha1,2491 unsigned char *peeled)2492{2493 fprintf_or_die(fh, "%s %s\n", sha1_to_hex(sha1), refname);2494 if (peeled)2495 fprintf_or_die(fh, "^%s\n", sha1_to_hex(peeled));2496}24972498/*2499 * An each_ref_entry_fn that writes the entry to a packed-refs file.2500 */2501static int write_packed_entry_fn(struct ref_entry *entry, void *cb_data)2502{2503 enum peel_status peel_status = peel_entry(entry, 0);25042505 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)2506 error("internal error: %s is not a valid packed reference!",2507 entry->name);2508 write_packed_entry(cb_data, entry->name, entry->u.value.oid.hash,2509 peel_status == PEEL_PEELED ?2510 entry->u.value.peeled.hash : NULL);2511 return 0;2512}25132514/* This should return a meaningful errno on failure */2515int lock_packed_refs(int flags)2516{2517 static int timeout_configured = 0;2518 static int timeout_value = 1000;25192520 struct packed_ref_cache *packed_ref_cache;25212522 if (!timeout_configured) {2523 git_config_get_int("core.packedrefstimeout", &timeout_value);2524 timeout_configured = 1;2525 }25262527 if (hold_lock_file_for_update_timeout(2528 &packlock, git_path("packed-refs"),2529 flags, timeout_value) < 0)2530 return -1;2531 /*2532 * Get the current packed-refs while holding the lock. If the2533 * packed-refs file has been modified since we last read it,2534 * this will automatically invalidate the cache and re-read2535 * the packed-refs file.2536 */2537 packed_ref_cache = get_packed_ref_cache(&ref_cache);2538 packed_ref_cache->lock = &packlock;2539 /* Increment the reference count to prevent it from being freed: */2540 acquire_packed_ref_cache(packed_ref_cache);2541 return 0;2542}25432544/*2545 * Commit the packed refs changes.2546 * On error we must make sure that errno contains a meaningful value.2547 */2548int commit_packed_refs(void)2549{2550 struct packed_ref_cache *packed_ref_cache =2551 get_packed_ref_cache(&ref_cache);2552 int error = 0;2553 int save_errno = 0;2554 FILE *out;25552556 if (!packed_ref_cache->lock)2557 die("internal error: packed-refs not locked");25582559 out = fdopen_lock_file(packed_ref_cache->lock, "w");2560 if (!out)2561 die_errno("unable to fdopen packed-refs descriptor");25622563 fprintf_or_die(out, "%s", PACKED_REFS_HEADER);2564 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),2565 0, write_packed_entry_fn, out);25662567 if (commit_lock_file(packed_ref_cache->lock)) {2568 save_errno = errno;2569 error = -1;2570 }2571 packed_ref_cache->lock = NULL;2572 release_packed_ref_cache(packed_ref_cache);2573 errno = save_errno;2574 return error;2575}25762577void rollback_packed_refs(void)2578{2579 struct packed_ref_cache *packed_ref_cache =2580 get_packed_ref_cache(&ref_cache);25812582 if (!packed_ref_cache->lock)2583 die("internal error: packed-refs not locked");2584 rollback_lock_file(packed_ref_cache->lock);2585 packed_ref_cache->lock = NULL;2586 release_packed_ref_cache(packed_ref_cache);2587 clear_packed_ref_cache(&ref_cache);2588}25892590struct ref_to_prune {2591 struct ref_to_prune *next;2592 unsigned char sha1[20];2593 char name[FLEX_ARRAY];2594};25952596struct pack_refs_cb_data {2597 unsigned int flags;2598 struct ref_dir *packed_refs;2599 struct ref_to_prune *ref_to_prune;2600};26012602/*2603 * An each_ref_entry_fn that is run over loose references only. If2604 * the loose reference can be packed, add an entry in the packed ref2605 * cache. If the reference should be pruned, also add it to2606 * ref_to_prune in the pack_refs_cb_data.2607 */2608static int pack_if_possible_fn(struct ref_entry *entry, void *cb_data)2609{2610 struct pack_refs_cb_data *cb = cb_data;2611 enum peel_status peel_status;2612 struct ref_entry *packed_entry;2613 int is_tag_ref = starts_with(entry->name, "refs/tags/");26142615 /* ALWAYS pack tags */2616 if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)2617 return 0;26182619 /* Do not pack symbolic or broken refs: */2620 if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))2621 return 0;26222623 /* Add a packed ref cache entry equivalent to the loose entry. */2624 peel_status = peel_entry(entry, 1);2625 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)2626 die("internal error peeling reference %s (%s)",2627 entry->name, oid_to_hex(&entry->u.value.oid));2628 packed_entry = find_ref(cb->packed_refs, entry->name);2629 if (packed_entry) {2630 /* Overwrite existing packed entry with info from loose entry */2631 packed_entry->flag = REF_ISPACKED | REF_KNOWS_PEELED;2632 oidcpy(&packed_entry->u.value.oid, &entry->u.value.oid);2633 } else {2634 packed_entry = create_ref_entry(entry->name, entry->u.value.oid.hash,2635 REF_ISPACKED | REF_KNOWS_PEELED, 0);2636 add_ref(cb->packed_refs, packed_entry);2637 }2638 oidcpy(&packed_entry->u.value.peeled, &entry->u.value.peeled);26392640 /* Schedule the loose reference for pruning if requested. */2641 if ((cb->flags & PACK_REFS_PRUNE)) {2642 int namelen = strlen(entry->name) + 1;2643 struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);2644 hashcpy(n->sha1, entry->u.value.oid.hash);2645 strcpy(n->name, entry->name);2646 n->next = cb->ref_to_prune;2647 cb->ref_to_prune = n;2648 }2649 return 0;2650}26512652/*2653 * Remove empty parents, but spare refs/ and immediate subdirs.2654 * Note: munges *name.2655 */2656static void try_remove_empty_parents(char *name)2657{2658 char *p, *q;2659 int i;2660 p = name;2661 for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */2662 while (*p && *p != '/')2663 p++;2664 /* tolerate duplicate slashes; see check_refname_format() */2665 while (*p == '/')2666 p++;2667 }2668 for (q = p; *q; q++)2669 ;2670 while (1) {2671 while (q > p && *q != '/')2672 q--;2673 while (q > p && *(q-1) == '/')2674 q--;2675 if (q == p)2676 break;2677 *q = '\0';2678 if (rmdir(git_path("%s", name)))2679 break;2680 }2681}26822683/* make sure nobody touched the ref, and unlink */2684static void prune_ref(struct ref_to_prune *r)2685{2686 struct ref_transaction *transaction;2687 struct strbuf err = STRBUF_INIT;26882689 if (check_refname_format(r->name, 0))2690 return;26912692 transaction = ref_transaction_begin(&err);2693 if (!transaction ||2694 ref_transaction_delete(transaction, r->name, r->sha1,2695 REF_ISPRUNING, NULL, &err) ||2696 ref_transaction_commit(transaction, &err)) {2697 ref_transaction_free(transaction);2698 error("%s", err.buf);2699 strbuf_release(&err);2700 return;2701 }2702 ref_transaction_free(transaction);2703 strbuf_release(&err);2704 try_remove_empty_parents(r->name);2705}27062707static void prune_refs(struct ref_to_prune *r)2708{2709 while (r) {2710 prune_ref(r);2711 r = r->next;2712 }2713}27142715int pack_refs(unsigned int flags)2716{2717 struct pack_refs_cb_data cbdata;27182719 memset(&cbdata, 0, sizeof(cbdata));2720 cbdata.flags = flags;27212722 lock_packed_refs(LOCK_DIE_ON_ERROR);2723 cbdata.packed_refs = get_packed_refs(&ref_cache);27242725 do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,2726 pack_if_possible_fn, &cbdata);27272728 if (commit_packed_refs())2729 die_errno("unable to overwrite old ref-pack file");27302731 prune_refs(cbdata.ref_to_prune);2732 return 0;2733}27342735int repack_without_refs(struct string_list *refnames, struct strbuf *err)2736{2737 struct ref_dir *packed;2738 struct string_list_item *refname;2739 int ret, needs_repacking = 0, removed = 0;27402741 assert(err);27422743 /* Look for a packed ref */2744 for_each_string_list_item(refname, refnames) {2745 if (get_packed_ref(refname->string)) {2746 needs_repacking = 1;2747 break;2748 }2749 }27502751 /* Avoid locking if we have nothing to do */2752 if (!needs_repacking)2753 return 0; /* no refname exists in packed refs */27542755 if (lock_packed_refs(0)) {2756 unable_to_lock_message(git_path("packed-refs"), errno, err);2757 return -1;2758 }2759 packed = get_packed_refs(&ref_cache);27602761 /* Remove refnames from the cache */2762 for_each_string_list_item(refname, refnames)2763 if (remove_entry(packed, refname->string) != -1)2764 removed = 1;2765 if (!removed) {2766 /*2767 * All packed entries disappeared while we were2768 * acquiring the lock.2769 */2770 rollback_packed_refs();2771 return 0;2772 }27732774 /* Write what remains */2775 ret = commit_packed_refs();2776 if (ret)2777 strbuf_addf(err, "unable to overwrite old ref-pack file: %s",2778 strerror(errno));2779 return ret;2780}27812782static int delete_ref_loose(struct ref_lock *lock, int flag, struct strbuf *err)2783{2784 assert(err);27852786 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {2787 /*2788 * loose. The loose file name is the same as the2789 * lockfile name, minus ".lock":2790 */2791 char *loose_filename = get_locked_file_path(lock->lk);2792 int res = unlink_or_msg(loose_filename, err);2793 free(loose_filename);2794 if (res)2795 return 1;2796 }2797 return 0;2798}27992800int delete_ref(const char *refname, const unsigned char *sha1, unsigned int flags)2801{2802 struct ref_transaction *transaction;2803 struct strbuf err = STRBUF_INIT;28042805 transaction = ref_transaction_begin(&err);2806 if (!transaction ||2807 ref_transaction_delete(transaction, refname,2808 (sha1 && !is_null_sha1(sha1)) ? sha1 : NULL,2809 flags, NULL, &err) ||2810 ref_transaction_commit(transaction, &err)) {2811 error("%s", err.buf);2812 ref_transaction_free(transaction);2813 strbuf_release(&err);2814 return 1;2815 }2816 ref_transaction_free(transaction);2817 strbuf_release(&err);2818 return 0;2819}28202821/*2822 * People using contrib's git-new-workdir have .git/logs/refs ->2823 * /some/other/path/.git/logs/refs, and that may live on another device.2824 *2825 * IOW, to avoid cross device rename errors, the temporary renamed log must2826 * live into logs/refs.2827 */2828#define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"28292830static int rename_tmp_log(const char *newrefname)2831{2832 int attempts_remaining = 4;28332834 retry:2835 switch (safe_create_leading_directories_const(git_path("logs/%s", newrefname))) {2836 case SCLD_OK:2837 break; /* success */2838 case SCLD_VANISHED:2839 if (--attempts_remaining > 0)2840 goto retry;2841 /* fall through */2842 default:2843 error("unable to create directory for %s", newrefname);2844 return -1;2845 }28462847 if (rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {2848 if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {2849 /*2850 * rename(a, b) when b is an existing2851 * directory ought to result in ISDIR, but2852 * Solaris 5.8 gives ENOTDIR. Sheesh.2853 */2854 if (remove_empty_directories(git_path("logs/%s", newrefname))) {2855 error("Directory not empty: logs/%s", newrefname);2856 return -1;2857 }2858 goto retry;2859 } else if (errno == ENOENT && --attempts_remaining > 0) {2860 /*2861 * Maybe another process just deleted one of2862 * the directories in the path to newrefname.2863 * Try again from the beginning.2864 */2865 goto retry;2866 } else {2867 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",2868 newrefname, strerror(errno));2869 return -1;2870 }2871 }2872 return 0;2873}28742875static int rename_ref_available(const char *oldname, const char *newname)2876{2877 struct string_list skip = STRING_LIST_INIT_NODUP;2878 struct strbuf err = STRBUF_INIT;2879 int ret;28802881 string_list_insert(&skip, oldname);2882 ret = !verify_refname_available(newname, NULL, &skip,2883 get_packed_refs(&ref_cache), &err)2884 && !verify_refname_available(newname, NULL, &skip,2885 get_loose_refs(&ref_cache), &err);2886 if (!ret)2887 error("%s", err.buf);28882889 string_list_clear(&skip, 0);2890 strbuf_release(&err);2891 return ret;2892}28932894static int write_ref_to_lockfile(struct ref_lock *lock, const unsigned char *sha1);2895static int commit_ref_update(struct ref_lock *lock,2896 const unsigned char *sha1, const char *logmsg);28972898int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)2899{2900 unsigned char sha1[20], orig_sha1[20];2901 int flag = 0, logmoved = 0;2902 struct ref_lock *lock;2903 struct stat loginfo;2904 int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);2905 const char *symref = NULL;2906 struct strbuf err = STRBUF_INIT;29072908 if (log && S_ISLNK(loginfo.st_mode))2909 return error("reflog for %s is a symlink", oldrefname);29102911 symref = resolve_ref_unsafe(oldrefname, RESOLVE_REF_READING,2912 orig_sha1, &flag);2913 if (flag & REF_ISSYMREF)2914 return error("refname %s is a symbolic ref, renaming it is not supported",2915 oldrefname);2916 if (!symref)2917 return error("refname %s not found", oldrefname);29182919 if (!rename_ref_available(oldrefname, newrefname))2920 return 1;29212922 if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))2923 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",2924 oldrefname, strerror(errno));29252926 if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {2927 error("unable to delete old %s", oldrefname);2928 goto rollback;2929 }29302931 if (!read_ref_full(newrefname, RESOLVE_REF_READING, sha1, NULL) &&2932 delete_ref(newrefname, sha1, REF_NODEREF)) {2933 if (errno==EISDIR) {2934 if (remove_empty_directories(git_path("%s", newrefname))) {2935 error("Directory not empty: %s", newrefname);2936 goto rollback;2937 }2938 } else {2939 error("unable to delete existing %s", newrefname);2940 goto rollback;2941 }2942 }29432944 if (log && rename_tmp_log(newrefname))2945 goto rollback;29462947 logmoved = log;29482949 lock = lock_ref_sha1_basic(newrefname, NULL, NULL, NULL, 0, NULL, &err);2950 if (!lock) {2951 error("unable to rename '%s' to '%s': %s", oldrefname, newrefname, err.buf);2952 strbuf_release(&err);2953 goto rollback;2954 }2955 hashcpy(lock->old_sha1, orig_sha1);29562957 if (write_ref_to_lockfile(lock, orig_sha1) ||2958 commit_ref_update(lock, orig_sha1, logmsg)) {2959 error("unable to write current sha1 into %s", newrefname);2960 goto rollback;2961 }29622963 return 0;29642965 rollback:2966 lock = lock_ref_sha1_basic(oldrefname, NULL, NULL, NULL, 0, NULL, &err);2967 if (!lock) {2968 error("unable to lock %s for rollback: %s", oldrefname, err.buf);2969 strbuf_release(&err);2970 goto rollbacklog;2971 }29722973 flag = log_all_ref_updates;2974 log_all_ref_updates = 0;2975 if (write_ref_to_lockfile(lock, orig_sha1) ||2976 commit_ref_update(lock, orig_sha1, NULL))2977 error("unable to write current sha1 into %s", oldrefname);2978 log_all_ref_updates = flag;29792980 rollbacklog:2981 if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))2982 error("unable to restore logfile %s from %s: %s",2983 oldrefname, newrefname, strerror(errno));2984 if (!logmoved && log &&2985 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))2986 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",2987 oldrefname, strerror(errno));29882989 return 1;2990}29912992static int close_ref(struct ref_lock *lock)2993{2994 if (close_lock_file(lock->lk))2995 return -1;2996 return 0;2997}29982999static int commit_ref(struct ref_lock *lock)3000{3001 if (commit_lock_file(lock->lk))3002 return -1;3003 return 0;3004}30053006/*3007 * copy the reflog message msg to buf, which has been allocated sufficiently3008 * large, while cleaning up the whitespaces. Especially, convert LF to space,3009 * because reflog file is one line per entry.3010 */3011static int copy_msg(char *buf, const char *msg)3012{3013 char *cp = buf;3014 char c;3015 int wasspace = 1;30163017 *cp++ = '\t';3018 while ((c = *msg++)) {3019 if (wasspace && isspace(c))3020 continue;3021 wasspace = isspace(c);3022 if (wasspace)3023 c = ' ';3024 *cp++ = c;3025 }3026 while (buf < cp && isspace(cp[-1]))3027 cp--;3028 *cp++ = '\n';3029 return cp - buf;3030}30313032/* This function must set a meaningful errno on failure */3033int log_ref_setup(const char *refname, struct strbuf *sb_logfile)3034{3035 int logfd, oflags = O_APPEND | O_WRONLY;3036 char *logfile;30373038 strbuf_git_path(sb_logfile, "logs/%s", refname);3039 logfile = sb_logfile->buf;3040 /* make sure the rest of the function can't change "logfile" */3041 sb_logfile = NULL;3042 if (log_all_ref_updates &&3043 (starts_with(refname, "refs/heads/") ||3044 starts_with(refname, "refs/remotes/") ||3045 starts_with(refname, "refs/notes/") ||3046 !strcmp(refname, "HEAD"))) {3047 if (safe_create_leading_directories(logfile) < 0) {3048 int save_errno = errno;3049 error("unable to create directory for %s", logfile);3050 errno = save_errno;3051 return -1;3052 }3053 oflags |= O_CREAT;3054 }30553056 logfd = open(logfile, oflags, 0666);3057 if (logfd < 0) {3058 if (!(oflags & O_CREAT) && (errno == ENOENT || errno == EISDIR))3059 return 0;30603061 if (errno == EISDIR) {3062 if (remove_empty_directories(logfile)) {3063 int save_errno = errno;3064 error("There are still logs under '%s'",3065 logfile);3066 errno = save_errno;3067 return -1;3068 }3069 logfd = open(logfile, oflags, 0666);3070 }30713072 if (logfd < 0) {3073 int save_errno = errno;3074 error("Unable to append to %s: %s", logfile,3075 strerror(errno));3076 errno = save_errno;3077 return -1;3078 }3079 }30803081 adjust_shared_perm(logfile);3082 close(logfd);3083 return 0;3084}30853086static int log_ref_write_fd(int fd, const unsigned char *old_sha1,3087 const unsigned char *new_sha1,3088 const char *committer, const char *msg)3089{3090 int msglen, written;3091 unsigned maxlen, len;3092 char *logrec;30933094 msglen = msg ? strlen(msg) : 0;3095 maxlen = strlen(committer) + msglen + 100;3096 logrec = xmalloc(maxlen);3097 len = sprintf(logrec, "%s %s %s\n",3098 sha1_to_hex(old_sha1),3099 sha1_to_hex(new_sha1),3100 committer);3101 if (msglen)3102 len += copy_msg(logrec + len - 1, msg) - 1;31033104 written = len <= maxlen ? write_in_full(fd, logrec, len) : -1;3105 free(logrec);3106 if (written != len)3107 return -1;31083109 return 0;3110}31113112static int log_ref_write_1(const char *refname, const unsigned char *old_sha1,3113 const unsigned char *new_sha1, const char *msg,3114 struct strbuf *sb_log_file)3115{3116 int logfd, result, oflags = O_APPEND | O_WRONLY;3117 char *log_file;31183119 if (log_all_ref_updates < 0)3120 log_all_ref_updates = !is_bare_repository();31213122 result = log_ref_setup(refname, sb_log_file);3123 if (result)3124 return result;3125 log_file = sb_log_file->buf;3126 /* make sure the rest of the function can't change "log_file" */3127 sb_log_file = NULL;31283129 logfd = open(log_file, oflags);3130 if (logfd < 0)3131 return 0;3132 result = log_ref_write_fd(logfd, old_sha1, new_sha1,3133 git_committer_info(0), msg);3134 if (result) {3135 int save_errno = errno;3136 close(logfd);3137 error("Unable to append to %s", log_file);3138 errno = save_errno;3139 return -1;3140 }3141 if (close(logfd)) {3142 int save_errno = errno;3143 error("Unable to append to %s", log_file);3144 errno = save_errno;3145 return -1;3146 }3147 return 0;3148}31493150static int log_ref_write(const char *refname, const unsigned char *old_sha1,3151 const unsigned char *new_sha1, const char *msg)3152{3153 struct strbuf sb = STRBUF_INIT;3154 int ret = log_ref_write_1(refname, old_sha1, new_sha1, msg, &sb);3155 strbuf_release(&sb);3156 return ret;3157}31583159int is_branch(const char *refname)3160{3161 return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");3162}31633164/*3165 * Write sha1 into the open lockfile, then close the lockfile. On3166 * errors, rollback the lockfile and set errno to reflect the problem.3167 */3168static int write_ref_to_lockfile(struct ref_lock *lock,3169 const unsigned char *sha1)3170{3171 static char term = '\n';3172 struct object *o;31733174 o = parse_object(sha1);3175 if (!o) {3176 error("Trying to write ref %s with nonexistent object %s",3177 lock->ref_name, sha1_to_hex(sha1));3178 unlock_ref(lock);3179 errno = EINVAL;3180 return -1;3181 }3182 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {3183 error("Trying to write non-commit object %s to branch %s",3184 sha1_to_hex(sha1), lock->ref_name);3185 unlock_ref(lock);3186 errno = EINVAL;3187 return -1;3188 }3189 if (write_in_full(lock->lk->fd, sha1_to_hex(sha1), 40) != 40 ||3190 write_in_full(lock->lk->fd, &term, 1) != 1 ||3191 close_ref(lock) < 0) {3192 int save_errno = errno;3193 error("Couldn't write %s", lock->lk->filename.buf);3194 unlock_ref(lock);3195 errno = save_errno;3196 return -1;3197 }3198 return 0;3199}32003201/*3202 * Commit a change to a loose reference that has already been written3203 * to the loose reference lockfile. Also update the reflogs if3204 * necessary, using the specified lockmsg (which can be NULL).3205 */3206static int commit_ref_update(struct ref_lock *lock,3207 const unsigned char *sha1, const char *logmsg)3208{3209 clear_loose_ref_cache(&ref_cache);3210 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||3211 (strcmp(lock->ref_name, lock->orig_ref_name) &&3212 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {3213 unlock_ref(lock);3214 return -1;3215 }3216 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {3217 /*3218 * Special hack: If a branch is updated directly and HEAD3219 * points to it (may happen on the remote side of a push3220 * for example) then logically the HEAD reflog should be3221 * updated too.3222 * A generic solution implies reverse symref information,3223 * but finding all symrefs pointing to the given branch3224 * would be rather costly for this rare event (the direct3225 * update of a branch) to be worth it. So let's cheat and3226 * check with HEAD only which should cover 99% of all usage3227 * scenarios (even 100% of the default ones).3228 */3229 unsigned char head_sha1[20];3230 int head_flag;3231 const char *head_ref;3232 head_ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,3233 head_sha1, &head_flag);3234 if (head_ref && (head_flag & REF_ISSYMREF) &&3235 !strcmp(head_ref, lock->ref_name))3236 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);3237 }3238 if (commit_ref(lock)) {3239 error("Couldn't set %s", lock->ref_name);3240 unlock_ref(lock);3241 return -1;3242 }3243 unlock_ref(lock);3244 return 0;3245}32463247int create_symref(const char *ref_target, const char *refs_heads_master,3248 const char *logmsg)3249{3250 const char *lockpath;3251 char ref[1000];3252 int fd, len, written;3253 char *git_HEAD = git_pathdup("%s", ref_target);3254 unsigned char old_sha1[20], new_sha1[20];32553256 if (logmsg && read_ref(ref_target, old_sha1))3257 hashclr(old_sha1);32583259 if (safe_create_leading_directories(git_HEAD) < 0)3260 return error("unable to create directory for %s", git_HEAD);32613262#ifndef NO_SYMLINK_HEAD3263 if (prefer_symlink_refs) {3264 unlink(git_HEAD);3265 if (!symlink(refs_heads_master, git_HEAD))3266 goto done;3267 fprintf(stderr, "no symlink - falling back to symbolic ref\n");3268 }3269#endif32703271 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);3272 if (sizeof(ref) <= len) {3273 error("refname too long: %s", refs_heads_master);3274 goto error_free_return;3275 }3276 lockpath = mkpath("%s.lock", git_HEAD);3277 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);3278 if (fd < 0) {3279 error("Unable to open %s for writing", lockpath);3280 goto error_free_return;3281 }3282 written = write_in_full(fd, ref, len);3283 if (close(fd) != 0 || written != len) {3284 error("Unable to write to %s", lockpath);3285 goto error_unlink_return;3286 }3287 if (rename(lockpath, git_HEAD) < 0) {3288 error("Unable to create %s", git_HEAD);3289 goto error_unlink_return;3290 }3291 if (adjust_shared_perm(git_HEAD)) {3292 error("Unable to fix permissions on %s", lockpath);3293 error_unlink_return:3294 unlink_or_warn(lockpath);3295 error_free_return:3296 free(git_HEAD);3297 return -1;3298 }32993300#ifndef NO_SYMLINK_HEAD3301 done:3302#endif3303 if (logmsg && !read_ref(refs_heads_master, new_sha1))3304 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);33053306 free(git_HEAD);3307 return 0;3308}33093310struct read_ref_at_cb {3311 const char *refname;3312 unsigned long at_time;3313 int cnt;3314 int reccnt;3315 unsigned char *sha1;3316 int found_it;33173318 unsigned char osha1[20];3319 unsigned char nsha1[20];3320 int tz;3321 unsigned long date;3322 char **msg;3323 unsigned long *cutoff_time;3324 int *cutoff_tz;3325 int *cutoff_cnt;3326};33273328static int read_ref_at_ent(unsigned char *osha1, unsigned char *nsha1,3329 const char *email, unsigned long timestamp, int tz,3330 const char *message, void *cb_data)3331{3332 struct read_ref_at_cb *cb = cb_data;33333334 cb->reccnt++;3335 cb->tz = tz;3336 cb->date = timestamp;33373338 if (timestamp <= cb->at_time || cb->cnt == 0) {3339 if (cb->msg)3340 *cb->msg = xstrdup(message);3341 if (cb->cutoff_time)3342 *cb->cutoff_time = timestamp;3343 if (cb->cutoff_tz)3344 *cb->cutoff_tz = tz;3345 if (cb->cutoff_cnt)3346 *cb->cutoff_cnt = cb->reccnt - 1;3347 /*3348 * we have not yet updated cb->[n|o]sha1 so they still3349 * hold the values for the previous record.3350 */3351 if (!is_null_sha1(cb->osha1)) {3352 hashcpy(cb->sha1, nsha1);3353 if (hashcmp(cb->osha1, nsha1))3354 warning("Log for ref %s has gap after %s.",3355 cb->refname, show_date(cb->date, cb->tz, DATE_RFC2822));3356 }3357 else if (cb->date == cb->at_time)3358 hashcpy(cb->sha1, nsha1);3359 else if (hashcmp(nsha1, cb->sha1))3360 warning("Log for ref %s unexpectedly ended on %s.",3361 cb->refname, show_date(cb->date, cb->tz,3362 DATE_RFC2822));3363 hashcpy(cb->osha1, osha1);3364 hashcpy(cb->nsha1, nsha1);3365 cb->found_it = 1;3366 return 1;3367 }3368 hashcpy(cb->osha1, osha1);3369 hashcpy(cb->nsha1, nsha1);3370 if (cb->cnt > 0)3371 cb->cnt--;3372 return 0;3373}33743375static int read_ref_at_ent_oldest(unsigned char *osha1, unsigned char *nsha1,3376 const char *email, unsigned long timestamp,3377 int tz, const char *message, void *cb_data)3378{3379 struct read_ref_at_cb *cb = cb_data;33803381 if (cb->msg)3382 *cb->msg = xstrdup(message);3383 if (cb->cutoff_time)3384 *cb->cutoff_time = timestamp;3385 if (cb->cutoff_tz)3386 *cb->cutoff_tz = tz;3387 if (cb->cutoff_cnt)3388 *cb->cutoff_cnt = cb->reccnt;3389 hashcpy(cb->sha1, osha1);3390 if (is_null_sha1(cb->sha1))3391 hashcpy(cb->sha1, nsha1);3392 /* We just want the first entry */3393 return 1;3394}33953396int read_ref_at(const char *refname, unsigned int flags, unsigned long at_time, int cnt,3397 unsigned char *sha1, char **msg,3398 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)3399{3400 struct read_ref_at_cb cb;34013402 memset(&cb, 0, sizeof(cb));3403 cb.refname = refname;3404 cb.at_time = at_time;3405 cb.cnt = cnt;3406 cb.msg = msg;3407 cb.cutoff_time = cutoff_time;3408 cb.cutoff_tz = cutoff_tz;3409 cb.cutoff_cnt = cutoff_cnt;3410 cb.sha1 = sha1;34113412 for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);34133414 if (!cb.reccnt) {3415 if (flags & GET_SHA1_QUIETLY)3416 exit(128);3417 else3418 die("Log for %s is empty.", refname);3419 }3420 if (cb.found_it)3421 return 0;34223423 for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);34243425 return 1;3426}34273428int reflog_exists(const char *refname)3429{3430 struct stat st;34313432 return !lstat(git_path("logs/%s", refname), &st) &&3433 S_ISREG(st.st_mode);3434}34353436int delete_reflog(const char *refname)3437{3438 return remove_path(git_path("logs/%s", refname));3439}34403441static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)3442{3443 unsigned char osha1[20], nsha1[20];3444 char *email_end, *message;3445 unsigned long timestamp;3446 int tz;34473448 /* old SP new SP name <email> SP time TAB msg LF */3449 if (sb->len < 83 || sb->buf[sb->len - 1] != '\n' ||3450 get_sha1_hex(sb->buf, osha1) || sb->buf[40] != ' ' ||3451 get_sha1_hex(sb->buf + 41, nsha1) || sb->buf[81] != ' ' ||3452 !(email_end = strchr(sb->buf + 82, '>')) ||3453 email_end[1] != ' ' ||3454 !(timestamp = strtoul(email_end + 2, &message, 10)) ||3455 !message || message[0] != ' ' ||3456 (message[1] != '+' && message[1] != '-') ||3457 !isdigit(message[2]) || !isdigit(message[3]) ||3458 !isdigit(message[4]) || !isdigit(message[5]))3459 return 0; /* corrupt? */3460 email_end[1] = '\0';3461 tz = strtol(message + 1, NULL, 10);3462 if (message[6] != '\t')3463 message += 6;3464 else3465 message += 7;3466 return fn(osha1, nsha1, sb->buf + 82, timestamp, tz, message, cb_data);3467}34683469static char *find_beginning_of_line(char *bob, char *scan)3470{3471 while (bob < scan && *(--scan) != '\n')3472 ; /* keep scanning backwards */3473 /*3474 * Return either beginning of the buffer, or LF at the end of3475 * the previous line.3476 */3477 return scan;3478}34793480int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data)3481{3482 struct strbuf sb = STRBUF_INIT;3483 FILE *logfp;3484 long pos;3485 int ret = 0, at_tail = 1;34863487 logfp = fopen(git_path("logs/%s", refname), "r");3488 if (!logfp)3489 return -1;34903491 /* Jump to the end */3492 if (fseek(logfp, 0, SEEK_END) < 0)3493 return error("cannot seek back reflog for %s: %s",3494 refname, strerror(errno));3495 pos = ftell(logfp);3496 while (!ret && 0 < pos) {3497 int cnt;3498 size_t nread;3499 char buf[BUFSIZ];3500 char *endp, *scanp;35013502 /* Fill next block from the end */3503 cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;3504 if (fseek(logfp, pos - cnt, SEEK_SET))3505 return error("cannot seek back reflog for %s: %s",3506 refname, strerror(errno));3507 nread = fread(buf, cnt, 1, logfp);3508 if (nread != 1)3509 return error("cannot read %d bytes from reflog for %s: %s",3510 cnt, refname, strerror(errno));3511 pos -= cnt;35123513 scanp = endp = buf + cnt;3514 if (at_tail && scanp[-1] == '\n')3515 /* Looking at the final LF at the end of the file */3516 scanp--;3517 at_tail = 0;35183519 while (buf < scanp) {3520 /*3521 * terminating LF of the previous line, or the beginning3522 * of the buffer.3523 */3524 char *bp;35253526 bp = find_beginning_of_line(buf, scanp);35273528 if (*bp == '\n') {3529 /*3530 * The newline is the end of the previous line,3531 * so we know we have complete line starting3532 * at (bp + 1). Prefix it onto any prior data3533 * we collected for the line and process it.3534 */3535 strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));3536 scanp = bp;3537 endp = bp + 1;3538 ret = show_one_reflog_ent(&sb, fn, cb_data);3539 strbuf_reset(&sb);3540 if (ret)3541 break;3542 } else if (!pos) {3543 /*3544 * We are at the start of the buffer, and the3545 * start of the file; there is no previous3546 * line, and we have everything for this one.3547 * Process it, and we can end the loop.3548 */3549 strbuf_splice(&sb, 0, 0, buf, endp - buf);3550 ret = show_one_reflog_ent(&sb, fn, cb_data);3551 strbuf_reset(&sb);3552 break;3553 }35543555 if (bp == buf) {3556 /*3557 * We are at the start of the buffer, and there3558 * is more file to read backwards. Which means3559 * we are in the middle of a line. Note that we3560 * may get here even if *bp was a newline; that3561 * just means we are at the exact end of the3562 * previous line, rather than some spot in the3563 * middle.3564 *3565 * Save away what we have to be combined with3566 * the data from the next read.3567 */3568 strbuf_splice(&sb, 0, 0, buf, endp - buf);3569 break;3570 }3571 }35723573 }3574 if (!ret && sb.len)3575 die("BUG: reverse reflog parser had leftover data");35763577 fclose(logfp);3578 strbuf_release(&sb);3579 return ret;3580}35813582int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)3583{3584 FILE *logfp;3585 struct strbuf sb = STRBUF_INIT;3586 int ret = 0;35873588 logfp = fopen(git_path("logs/%s", refname), "r");3589 if (!logfp)3590 return -1;35913592 while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))3593 ret = show_one_reflog_ent(&sb, fn, cb_data);3594 fclose(logfp);3595 strbuf_release(&sb);3596 return ret;3597}3598/*3599 * Call fn for each reflog in the namespace indicated by name. name3600 * must be empty or end with '/'. Name will be used as a scratch3601 * space, but its contents will be restored before return.3602 */3603static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)3604{3605 DIR *d = opendir(git_path("logs/%s", name->buf));3606 int retval = 0;3607 struct dirent *de;3608 int oldlen = name->len;36093610 if (!d)3611 return name->len ? errno : 0;36123613 while ((de = readdir(d)) != NULL) {3614 struct stat st;36153616 if (de->d_name[0] == '.')3617 continue;3618 if (ends_with(de->d_name, ".lock"))3619 continue;3620 strbuf_addstr(name, de->d_name);3621 if (stat(git_path("logs/%s", name->buf), &st) < 0) {3622 ; /* silently ignore */3623 } else {3624 if (S_ISDIR(st.st_mode)) {3625 strbuf_addch(name, '/');3626 retval = do_for_each_reflog(name, fn, cb_data);3627 } else {3628 struct object_id oid;36293630 if (read_ref_full(name->buf, 0, oid.hash, NULL))3631 retval = error("bad ref for %s", name->buf);3632 else3633 retval = fn(name->buf, &oid, 0, cb_data);3634 }3635 if (retval)3636 break;3637 }3638 strbuf_setlen(name, oldlen);3639 }3640 closedir(d);3641 return retval;3642}36433644int for_each_reflog(each_ref_fn fn, void *cb_data)3645{3646 int retval;3647 struct strbuf name;3648 strbuf_init(&name, PATH_MAX);3649 retval = do_for_each_reflog(&name, fn, cb_data);3650 strbuf_release(&name);3651 return retval;3652}36533654/**3655 * Information needed for a single ref update. Set new_sha1 to the new3656 * value or to null_sha1 to delete the ref. To check the old value3657 * while the ref is locked, set (flags & REF_HAVE_OLD) and set3658 * old_sha1 to the old value, or to null_sha1 to ensure the ref does3659 * not exist before update.3660 */3661struct ref_update {3662 /*3663 * If (flags & REF_HAVE_NEW), set the reference to this value:3664 */3665 unsigned char new_sha1[20];3666 /*3667 * If (flags & REF_HAVE_OLD), check that the reference3668 * previously had this value:3669 */3670 unsigned char old_sha1[20];3671 /*3672 * One or more of REF_HAVE_NEW, REF_HAVE_OLD, REF_NODEREF,3673 * REF_DELETING, and REF_ISPRUNING:3674 */3675 unsigned int flags;3676 struct ref_lock *lock;3677 int type;3678 char *msg;3679 const char refname[FLEX_ARRAY];3680};36813682/*3683 * Transaction states.3684 * OPEN: The transaction is in a valid state and can accept new updates.3685 * An OPEN transaction can be committed.3686 * CLOSED: A closed transaction is no longer active and no other operations3687 * than free can be used on it in this state.3688 * A transaction can either become closed by successfully committing3689 * an active transaction or if there is a failure while building3690 * the transaction thus rendering it failed/inactive.3691 */3692enum ref_transaction_state {3693 REF_TRANSACTION_OPEN = 0,3694 REF_TRANSACTION_CLOSED = 13695};36963697/*3698 * Data structure for holding a reference transaction, which can3699 * consist of checks and updates to multiple references, carried out3700 * as atomically as possible. This structure is opaque to callers.3701 */3702struct ref_transaction {3703 struct ref_update **updates;3704 size_t alloc;3705 size_t nr;3706 enum ref_transaction_state state;3707};37083709struct ref_transaction *ref_transaction_begin(struct strbuf *err)3710{3711 assert(err);37123713 return xcalloc(1, sizeof(struct ref_transaction));3714}37153716void ref_transaction_free(struct ref_transaction *transaction)3717{3718 int i;37193720 if (!transaction)3721 return;37223723 for (i = 0; i < transaction->nr; i++) {3724 free(transaction->updates[i]->msg);3725 free(transaction->updates[i]);3726 }3727 free(transaction->updates);3728 free(transaction);3729}37303731static struct ref_update *add_update(struct ref_transaction *transaction,3732 const char *refname)3733{3734 size_t len = strlen(refname);3735 struct ref_update *update = xcalloc(1, sizeof(*update) + len + 1);37363737 strcpy((char *)update->refname, refname);3738 ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);3739 transaction->updates[transaction->nr++] = update;3740 return update;3741}37423743int ref_transaction_update(struct ref_transaction *transaction,3744 const char *refname,3745 const unsigned char *new_sha1,3746 const unsigned char *old_sha1,3747 unsigned int flags, const char *msg,3748 struct strbuf *err)3749{3750 struct ref_update *update;37513752 assert(err);37533754 if (transaction->state != REF_TRANSACTION_OPEN)3755 die("BUG: update called for transaction that is not open");37563757 if (new_sha1 && !is_null_sha1(new_sha1) &&3758 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {3759 strbuf_addf(err, "refusing to update ref with bad name %s",3760 refname);3761 return -1;3762 }37633764 update = add_update(transaction, refname);3765 if (new_sha1) {3766 hashcpy(update->new_sha1, new_sha1);3767 flags |= REF_HAVE_NEW;3768 }3769 if (old_sha1) {3770 hashcpy(update->old_sha1, old_sha1);3771 flags |= REF_HAVE_OLD;3772 }3773 update->flags = flags;3774 if (msg)3775 update->msg = xstrdup(msg);3776 return 0;3777}37783779int ref_transaction_create(struct ref_transaction *transaction,3780 const char *refname,3781 const unsigned char *new_sha1,3782 unsigned int flags, const char *msg,3783 struct strbuf *err)3784{3785 if (!new_sha1 || is_null_sha1(new_sha1))3786 die("BUG: create called without valid new_sha1");3787 return ref_transaction_update(transaction, refname, new_sha1,3788 null_sha1, flags, msg, err);3789}37903791int ref_transaction_delete(struct ref_transaction *transaction,3792 const char *refname,3793 const unsigned char *old_sha1,3794 unsigned int flags, const char *msg,3795 struct strbuf *err)3796{3797 if (old_sha1 && is_null_sha1(old_sha1))3798 die("BUG: delete called with old_sha1 set to zeros");3799 return ref_transaction_update(transaction, refname,3800 null_sha1, old_sha1,3801 flags, msg, err);3802}38033804int ref_transaction_verify(struct ref_transaction *transaction,3805 const char *refname,3806 const unsigned char *old_sha1,3807 unsigned int flags,3808 struct strbuf *err)3809{3810 if (!old_sha1)3811 die("BUG: verify called with old_sha1 set to NULL");3812 return ref_transaction_update(transaction, refname,3813 NULL, old_sha1,3814 flags, NULL, err);3815}38163817int update_ref(const char *msg, const char *refname,3818 const unsigned char *new_sha1, const unsigned char *old_sha1,3819 unsigned int flags, enum action_on_err onerr)3820{3821 struct ref_transaction *t;3822 struct strbuf err = STRBUF_INIT;38233824 t = ref_transaction_begin(&err);3825 if (!t ||3826 ref_transaction_update(t, refname, new_sha1, old_sha1,3827 flags, msg, &err) ||3828 ref_transaction_commit(t, &err)) {3829 const char *str = "update_ref failed for ref '%s': %s";38303831 ref_transaction_free(t);3832 switch (onerr) {3833 case UPDATE_REFS_MSG_ON_ERR:3834 error(str, refname, err.buf);3835 break;3836 case UPDATE_REFS_DIE_ON_ERR:3837 die(str, refname, err.buf);3838 break;3839 case UPDATE_REFS_QUIET_ON_ERR:3840 break;3841 }3842 strbuf_release(&err);3843 return 1;3844 }3845 strbuf_release(&err);3846 ref_transaction_free(t);3847 return 0;3848}38493850static int ref_update_reject_duplicates(struct string_list *refnames,3851 struct strbuf *err)3852{3853 int i, n = refnames->nr;38543855 assert(err);38563857 for (i = 1; i < n; i++)3858 if (!strcmp(refnames->items[i - 1].string, refnames->items[i].string)) {3859 strbuf_addf(err,3860 "Multiple updates for ref '%s' not allowed.",3861 refnames->items[i].string);3862 return 1;3863 }3864 return 0;3865}38663867int ref_transaction_commit(struct ref_transaction *transaction,3868 struct strbuf *err)3869{3870 int ret = 0, i;3871 int n = transaction->nr;3872 struct ref_update **updates = transaction->updates;3873 struct string_list refs_to_delete = STRING_LIST_INIT_NODUP;3874 struct string_list_item *ref_to_delete;3875 struct string_list affected_refnames = STRING_LIST_INIT_NODUP;38763877 assert(err);38783879 if (transaction->state != REF_TRANSACTION_OPEN)3880 die("BUG: commit called for transaction that is not open");38813882 if (!n) {3883 transaction->state = REF_TRANSACTION_CLOSED;3884 return 0;3885 }38863887 /* Fail if a refname appears more than once in the transaction: */3888 for (i = 0; i < n; i++)3889 string_list_append(&affected_refnames, updates[i]->refname);3890 string_list_sort(&affected_refnames);3891 if (ref_update_reject_duplicates(&affected_refnames, err)) {3892 ret = TRANSACTION_GENERIC_ERROR;3893 goto cleanup;3894 }38953896 /*3897 * Acquire all locks, verify old values if provided, check3898 * that new values are valid, and write new values to the3899 * lockfiles, ready to be activated. Only keep one lockfile3900 * open at a time to avoid running out of file descriptors.3901 */3902 for (i = 0; i < n; i++) {3903 struct ref_update *update = updates[i];39043905 if ((update->flags & REF_HAVE_NEW) &&3906 is_null_sha1(update->new_sha1))3907 update->flags |= REF_DELETING;3908 update->lock = lock_ref_sha1_basic(3909 update->refname,3910 ((update->flags & REF_HAVE_OLD) ?3911 update->old_sha1 : NULL),3912 &affected_refnames, NULL,3913 update->flags,3914 &update->type,3915 err);3916 if (!update->lock) {3917 char *reason;39183919 ret = (errno == ENOTDIR)3920 ? TRANSACTION_NAME_CONFLICT3921 : TRANSACTION_GENERIC_ERROR;3922 reason = strbuf_detach(err, NULL);3923 strbuf_addf(err, "Cannot lock ref '%s': %s",3924 update->refname, reason);3925 free(reason);3926 goto cleanup;3927 }3928 if ((update->flags & REF_HAVE_NEW) &&3929 !(update->flags & REF_DELETING)) {3930 int overwriting_symref = ((update->type & REF_ISSYMREF) &&3931 (update->flags & REF_NODEREF));39323933 if (!overwriting_symref &&3934 !hashcmp(update->lock->old_sha1, update->new_sha1)) {3935 /*3936 * The reference already has the desired3937 * value, so we don't need to write it.3938 */3939 } else if (write_ref_to_lockfile(update->lock,3940 update->new_sha1)) {3941 /*3942 * The lock was freed upon failure of3943 * write_ref_to_lockfile():3944 */3945 update->lock = NULL;3946 strbuf_addf(err, "Cannot update the ref '%s'.",3947 update->refname);3948 ret = TRANSACTION_GENERIC_ERROR;3949 goto cleanup;3950 } else {3951 update->flags |= REF_NEEDS_COMMIT;3952 }3953 }3954 if (!(update->flags & REF_NEEDS_COMMIT)) {3955 /*3956 * We didn't have to write anything to the lockfile.3957 * Close it to free up the file descriptor:3958 */3959 if (close_ref(update->lock)) {3960 strbuf_addf(err, "Couldn't close %s.lock",3961 update->refname);3962 goto cleanup;3963 }3964 }3965 }39663967 /* Perform updates first so live commits remain referenced */3968 for (i = 0; i < n; i++) {3969 struct ref_update *update = updates[i];39703971 if (update->flags & REF_NEEDS_COMMIT) {3972 if (commit_ref_update(update->lock,3973 update->new_sha1, update->msg)) {3974 /* freed by commit_ref_update(): */3975 update->lock = NULL;3976 strbuf_addf(err, "Cannot update the ref '%s'.",3977 update->refname);3978 ret = TRANSACTION_GENERIC_ERROR;3979 goto cleanup;3980 } else {3981 /* freed by commit_ref_update(): */3982 update->lock = NULL;3983 }3984 }3985 }39863987 /* Perform deletes now that updates are safely completed */3988 for (i = 0; i < n; i++) {3989 struct ref_update *update = updates[i];39903991 if (update->flags & REF_DELETING) {3992 if (delete_ref_loose(update->lock, update->type, err)) {3993 ret = TRANSACTION_GENERIC_ERROR;3994 goto cleanup;3995 }39963997 if (!(update->flags & REF_ISPRUNING))3998 string_list_append(&refs_to_delete,3999 update->lock->ref_name);4000 }4001 }40024003 if (repack_without_refs(&refs_to_delete, err)) {4004 ret = TRANSACTION_GENERIC_ERROR;4005 goto cleanup;4006 }4007 for_each_string_list_item(ref_to_delete, &refs_to_delete)4008 unlink_or_warn(git_path("logs/%s", ref_to_delete->string));4009 clear_loose_ref_cache(&ref_cache);40104011cleanup:4012 transaction->state = REF_TRANSACTION_CLOSED;40134014 for (i = 0; i < n; i++)4015 if (updates[i]->lock)4016 unlock_ref(updates[i]->lock);4017 string_list_clear(&refs_to_delete, 0);4018 string_list_clear(&affected_refnames, 0);4019 return ret;4020}40214022char *shorten_unambiguous_ref(const char *refname, int strict)4023{4024 int i;4025 static char **scanf_fmts;4026 static int nr_rules;4027 char *short_name;40284029 if (!nr_rules) {4030 /*4031 * Pre-generate scanf formats from ref_rev_parse_rules[].4032 * Generate a format suitable for scanf from a4033 * ref_rev_parse_rules rule by interpolating "%s" at the4034 * location of the "%.*s".4035 */4036 size_t total_len = 0;4037 size_t offset = 0;40384039 /* the rule list is NULL terminated, count them first */4040 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)4041 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */4042 total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;40434044 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);40454046 offset = 0;4047 for (i = 0; i < nr_rules; i++) {4048 assert(offset < total_len);4049 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;4050 offset += snprintf(scanf_fmts[i], total_len - offset,4051 ref_rev_parse_rules[i], 2, "%s") + 1;4052 }4053 }40544055 /* bail out if there are no rules */4056 if (!nr_rules)4057 return xstrdup(refname);40584059 /* buffer for scanf result, at most refname must fit */4060 short_name = xstrdup(refname);40614062 /* skip first rule, it will always match */4063 for (i = nr_rules - 1; i > 0 ; --i) {4064 int j;4065 int rules_to_fail = i;4066 int short_name_len;40674068 if (1 != sscanf(refname, scanf_fmts[i], short_name))4069 continue;40704071 short_name_len = strlen(short_name);40724073 /*4074 * in strict mode, all (except the matched one) rules4075 * must fail to resolve to a valid non-ambiguous ref4076 */4077 if (strict)4078 rules_to_fail = nr_rules;40794080 /*4081 * check if the short name resolves to a valid ref,4082 * but use only rules prior to the matched one4083 */4084 for (j = 0; j < rules_to_fail; j++) {4085 const char *rule = ref_rev_parse_rules[j];4086 char refname[PATH_MAX];40874088 /* skip matched rule */4089 if (i == j)4090 continue;40914092 /*4093 * the short name is ambiguous, if it resolves4094 * (with this previous rule) to a valid ref4095 * read_ref() returns 0 on success4096 */4097 mksnpath(refname, sizeof(refname),4098 rule, short_name_len, short_name);4099 if (ref_exists(refname))4100 break;4101 }41024103 /*4104 * short name is non-ambiguous if all previous rules4105 * haven't resolved to a valid ref4106 */4107 if (j == rules_to_fail)4108 return short_name;4109 }41104111 free(short_name);4112 return xstrdup(refname);4113}41144115static struct string_list *hide_refs;41164117int parse_hide_refs_config(const char *var, const char *value, const char *section)4118{4119 if (!strcmp("transfer.hiderefs", var) ||4120 /* NEEDSWORK: use parse_config_key() once both are merged */4121 (starts_with(var, section) && var[strlen(section)] == '.' &&4122 !strcmp(var + strlen(section), ".hiderefs"))) {4123 char *ref;4124 int len;41254126 if (!value)4127 return config_error_nonbool(var);4128 ref = xstrdup(value);4129 len = strlen(ref);4130 while (len && ref[len - 1] == '/')4131 ref[--len] = '\0';4132 if (!hide_refs) {4133 hide_refs = xcalloc(1, sizeof(*hide_refs));4134 hide_refs->strdup_strings = 1;4135 }4136 string_list_append(hide_refs, ref);4137 }4138 return 0;4139}41404141int ref_is_hidden(const char *refname)4142{4143 struct string_list_item *item;41444145 if (!hide_refs)4146 return 0;4147 for_each_string_list_item(item, hide_refs) {4148 int len;4149 if (!starts_with(refname, item->string))4150 continue;4151 len = strlen(item->string);4152 if (!refname[len] || refname[len] == '/')4153 return 1;4154 }4155 return 0;4156}41574158struct expire_reflog_cb {4159 unsigned int flags;4160 reflog_expiry_should_prune_fn *should_prune_fn;4161 void *policy_cb;4162 FILE *newlog;4163 unsigned char last_kept_sha1[20];4164};41654166static int expire_reflog_ent(unsigned char *osha1, unsigned char *nsha1,4167 const char *email, unsigned long timestamp, int tz,4168 const char *message, void *cb_data)4169{4170 struct expire_reflog_cb *cb = cb_data;4171 struct expire_reflog_policy_cb *policy_cb = cb->policy_cb;41724173 if (cb->flags & EXPIRE_REFLOGS_REWRITE)4174 osha1 = cb->last_kept_sha1;41754176 if ((*cb->should_prune_fn)(osha1, nsha1, email, timestamp, tz,4177 message, policy_cb)) {4178 if (!cb->newlog)4179 printf("would prune %s", message);4180 else if (cb->flags & EXPIRE_REFLOGS_VERBOSE)4181 printf("prune %s", message);4182 } else {4183 if (cb->newlog) {4184 fprintf(cb->newlog, "%s %s %s %lu %+05d\t%s",4185 sha1_to_hex(osha1), sha1_to_hex(nsha1),4186 email, timestamp, tz, message);4187 hashcpy(cb->last_kept_sha1, nsha1);4188 }4189 if (cb->flags & EXPIRE_REFLOGS_VERBOSE)4190 printf("keep %s", message);4191 }4192 return 0;4193}41944195int reflog_expire(const char *refname, const unsigned char *sha1,4196 unsigned int flags,4197 reflog_expiry_prepare_fn prepare_fn,4198 reflog_expiry_should_prune_fn should_prune_fn,4199 reflog_expiry_cleanup_fn cleanup_fn,4200 void *policy_cb_data)4201{4202 static struct lock_file reflog_lock;4203 struct expire_reflog_cb cb;4204 struct ref_lock *lock;4205 char *log_file;4206 int status = 0;4207 int type;4208 struct strbuf err = STRBUF_INIT;42094210 memset(&cb, 0, sizeof(cb));4211 cb.flags = flags;4212 cb.policy_cb = policy_cb_data;4213 cb.should_prune_fn = should_prune_fn;42144215 /*4216 * The reflog file is locked by holding the lock on the4217 * reference itself, plus we might need to update the4218 * reference if --updateref was specified:4219 */4220 lock = lock_ref_sha1_basic(refname, sha1, NULL, NULL, 0, &type, &err);4221 if (!lock) {4222 error("cannot lock ref '%s': %s", refname, err.buf);4223 strbuf_release(&err);4224 return -1;4225 }4226 if (!reflog_exists(refname)) {4227 unlock_ref(lock);4228 return 0;4229 }42304231 log_file = git_pathdup("logs/%s", refname);4232 if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {4233 /*4234 * Even though holding $GIT_DIR/logs/$reflog.lock has4235 * no locking implications, we use the lock_file4236 * machinery here anyway because it does a lot of the4237 * work we need, including cleaning up if the program4238 * exits unexpectedly.4239 */4240 if (hold_lock_file_for_update(&reflog_lock, log_file, 0) < 0) {4241 struct strbuf err = STRBUF_INIT;4242 unable_to_lock_message(log_file, errno, &err);4243 error("%s", err.buf);4244 strbuf_release(&err);4245 goto failure;4246 }4247 cb.newlog = fdopen_lock_file(&reflog_lock, "w");4248 if (!cb.newlog) {4249 error("cannot fdopen %s (%s)",4250 reflog_lock.filename.buf, strerror(errno));4251 goto failure;4252 }4253 }42544255 (*prepare_fn)(refname, sha1, cb.policy_cb);4256 for_each_reflog_ent(refname, expire_reflog_ent, &cb);4257 (*cleanup_fn)(cb.policy_cb);42584259 if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {4260 /*4261 * It doesn't make sense to adjust a reference pointed4262 * to by a symbolic ref based on expiring entries in4263 * the symbolic reference's reflog. Nor can we update4264 * a reference if there are no remaining reflog4265 * entries.4266 */4267 int update = (flags & EXPIRE_REFLOGS_UPDATE_REF) &&4268 !(type & REF_ISSYMREF) &&4269 !is_null_sha1(cb.last_kept_sha1);42704271 if (close_lock_file(&reflog_lock)) {4272 status |= error("couldn't write %s: %s", log_file,4273 strerror(errno));4274 } else if (update &&4275 (write_in_full(lock->lk->fd,4276 sha1_to_hex(cb.last_kept_sha1), 40) != 40 ||4277 write_str_in_full(lock->lk->fd, "\n") != 1 ||4278 close_ref(lock) < 0)) {4279 status |= error("couldn't write %s",4280 lock->lk->filename.buf);4281 rollback_lock_file(&reflog_lock);4282 } else if (commit_lock_file(&reflog_lock)) {4283 status |= error("unable to commit reflog '%s' (%s)",4284 log_file, strerror(errno));4285 } else if (update && commit_ref(lock)) {4286 status |= error("couldn't set %s", lock->ref_name);4287 }4288 }4289 free(log_file);4290 unlock_ref(lock);4291 return status;42924293 failure:4294 rollback_lock_file(&reflog_lock);4295 free(log_file);4296 unlock_ref(lock);4297 return -1;4298}