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 int lock_fd; 15}; 16 17/* 18 * How to handle various characters in refnames: 19 * 0: An acceptable character for refs 20 * 1: End-of-component 21 * 2: ., look for a preceding . to reject .. in refs 22 * 3: {, look for a preceding @ to reject @{ in refs 23 * 4: A bad character: ASCII control characters, "~", "^", ":" or SP 24 */ 25static unsigned char refname_disposition[256] = { 26 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 27 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 28 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 2, 1, 29 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4, 30 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 31 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0, 32 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 33 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4 34}; 35 36/* 37 * Flag passed to lock_ref_sha1_basic() telling it to tolerate broken 38 * refs (i.e., because the reference is about to be deleted anyway). 39 */ 40#define REF_DELETING 0x02 41 42/* 43 * Used as a flag in ref_update::flags when a loose ref is being 44 * pruned. 45 */ 46#define REF_ISPRUNING 0x04 47 48/* 49 * Used as a flag in ref_update::flags when the reference should be 50 * updated to new_sha1. 51 */ 52#define REF_HAVE_NEW 0x08 53 54/* 55 * Used as a flag in ref_update::flags when old_sha1 should be 56 * checked. 57 */ 58#define REF_HAVE_OLD 0x10 59 60/* 61 * Try to read one refname component from the front of refname. 62 * Return the length of the component found, or -1 if the component is 63 * not legal. It is legal if it is something reasonable to have under 64 * ".git/refs/"; We do not like it if: 65 * 66 * - any path component of it begins with ".", or 67 * - it has double dots "..", or 68 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or 69 * - it ends with a "/". 70 * - it ends with ".lock" 71 * - it contains a "\" (backslash) 72 */ 73static int check_refname_component(const char *refname, int flags) 74{ 75 const char *cp; 76 char last = '\0'; 77 78 for (cp = refname; ; cp++) { 79 int ch = *cp & 255; 80 unsigned char disp = refname_disposition[ch]; 81 switch (disp) { 82 case 1: 83 goto out; 84 case 2: 85 if (last == '.') 86 return -1; /* Refname contains "..". */ 87 break; 88 case 3: 89 if (last == '@') 90 return -1; /* Refname contains "@{". */ 91 break; 92 case 4: 93 return -1; 94 } 95 last = ch; 96 } 97out: 98 if (cp == refname) 99 return 0; /* Component has zero length. */ 100 if (refname[0] == '.') 101 return -1; /* Component starts with '.'. */ 102 if (cp - refname >= LOCK_SUFFIX_LEN && 103 !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN)) 104 return -1; /* Refname ends with ".lock". */ 105 return cp - refname; 106} 107 108int check_refname_format(const char *refname, int flags) 109{ 110 int component_len, component_count = 0; 111 112 if (!strcmp(refname, "@")) 113 /* Refname is a single character '@'. */ 114 return -1; 115 116 while (1) { 117 /* We are at the start of a path component. */ 118 component_len = check_refname_component(refname, flags); 119 if (component_len <= 0) { 120 if ((flags & REFNAME_REFSPEC_PATTERN) && 121 refname[0] == '*' && 122 (refname[1] == '\0' || refname[1] == '/')) { 123 /* Accept one wildcard as a full refname component. */ 124 flags &= ~REFNAME_REFSPEC_PATTERN; 125 component_len = 1; 126 } else { 127 return -1; 128 } 129 } 130 component_count++; 131 if (refname[component_len] == '\0') 132 break; 133 /* Skip to next component. */ 134 refname += component_len + 1; 135 } 136 137 if (refname[component_len - 1] == '.') 138 return -1; /* Refname ends with '.'. */ 139 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2) 140 return -1; /* Refname has only one component. */ 141 return 0; 142} 143 144struct ref_entry; 145 146/* 147 * Information used (along with the information in ref_entry) to 148 * describe a single cached reference. This data structure only 149 * occurs embedded in a union in struct ref_entry, and only when 150 * (ref_entry->flag & REF_DIR) is zero. 151 */ 152struct ref_value { 153 /* 154 * The name of the object to which this reference resolves 155 * (which may be a tag object). If REF_ISBROKEN, this is 156 * null. If REF_ISSYMREF, then this is the name of the object 157 * referred to by the last reference in the symlink chain. 158 */ 159 unsigned char sha1[20]; 160 161 /* 162 * If REF_KNOWS_PEELED, then this field holds the peeled value 163 * of this reference, or null if the reference is known not to 164 * be peelable. See the documentation for peel_ref() for an 165 * exact definition of "peelable". 166 */ 167 unsigned char peeled[20]; 168}; 169 170struct ref_cache; 171 172/* 173 * Information used (along with the information in ref_entry) to 174 * describe a level in the hierarchy of references. This data 175 * structure only occurs embedded in a union in struct ref_entry, and 176 * only when (ref_entry.flag & REF_DIR) is set. In that case, 177 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references 178 * in the directory have already been read: 179 * 180 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose 181 * or packed references, already read. 182 * 183 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose 184 * references that hasn't been read yet (nor has any of its 185 * subdirectories). 186 * 187 * Entries within a directory are stored within a growable array of 188 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i < 189 * sorted are sorted by their component name in strcmp() order and the 190 * remaining entries are unsorted. 191 * 192 * Loose references are read lazily, one directory at a time. When a 193 * directory of loose references is read, then all of the references 194 * in that directory are stored, and REF_INCOMPLETE stubs are created 195 * for any subdirectories, but the subdirectories themselves are not 196 * read. The reading is triggered by get_ref_dir(). 197 */ 198struct ref_dir { 199 int nr, alloc; 200 201 /* 202 * Entries with index 0 <= i < sorted are sorted by name. New 203 * entries are appended to the list unsorted, and are sorted 204 * only when required; thus we avoid the need to sort the list 205 * after the addition of every reference. 206 */ 207 int sorted; 208 209 /* A pointer to the ref_cache that contains this ref_dir. */ 210 struct ref_cache *ref_cache; 211 212 struct ref_entry **entries; 213}; 214 215/* 216 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01, 217 * REF_ISPACKED=0x02, REF_ISBROKEN=0x04 and REF_BAD_NAME=0x08 are 218 * public values; see refs.h. 219 */ 220 221/* 222 * The field ref_entry->u.value.peeled of this value entry contains 223 * the correct peeled value for the reference, which might be 224 * null_sha1 if the reference is not a tag or if it is broken. 225 */ 226#define REF_KNOWS_PEELED 0x10 227 228/* ref_entry represents a directory of references */ 229#define REF_DIR 0x20 230 231/* 232 * Entry has not yet been read from disk (used only for REF_DIR 233 * entries representing loose references) 234 */ 235#define REF_INCOMPLETE 0x40 236 237/* 238 * A ref_entry represents either a reference or a "subdirectory" of 239 * references. 240 * 241 * Each directory in the reference namespace is represented by a 242 * ref_entry with (flags & REF_DIR) set and containing a subdir member 243 * that holds the entries in that directory that have been read so 244 * far. If (flags & REF_INCOMPLETE) is set, then the directory and 245 * its subdirectories haven't been read yet. REF_INCOMPLETE is only 246 * used for loose reference directories. 247 * 248 * References are represented by a ref_entry with (flags & REF_DIR) 249 * unset and a value member that describes the reference's value. The 250 * flag member is at the ref_entry level, but it is also needed to 251 * interpret the contents of the value field (in other words, a 252 * ref_value object is not very much use without the enclosing 253 * ref_entry). 254 * 255 * Reference names cannot end with slash and directories' names are 256 * always stored with a trailing slash (except for the top-level 257 * directory, which is always denoted by ""). This has two nice 258 * consequences: (1) when the entries in each subdir are sorted 259 * lexicographically by name (as they usually are), the references in 260 * a whole tree can be generated in lexicographic order by traversing 261 * the tree in left-to-right, depth-first order; (2) the names of 262 * references and subdirectories cannot conflict, and therefore the 263 * presence of an empty subdirectory does not block the creation of a 264 * similarly-named reference. (The fact that reference names with the 265 * same leading components can conflict *with each other* is a 266 * separate issue that is regulated by is_refname_available().) 267 * 268 * Please note that the name field contains the fully-qualified 269 * reference (or subdirectory) name. Space could be saved by only 270 * storing the relative names. But that would require the full names 271 * to be generated on the fly when iterating in do_for_each_ref(), and 272 * would break callback functions, who have always been able to assume 273 * that the name strings that they are passed will not be freed during 274 * the iteration. 275 */ 276struct ref_entry { 277 unsigned char flag; /* ISSYMREF? ISPACKED? */ 278 union { 279 struct ref_value value; /* if not (flags&REF_DIR) */ 280 struct ref_dir subdir; /* if (flags&REF_DIR) */ 281 } u; 282 /* 283 * The full name of the reference (e.g., "refs/heads/master") 284 * or the full name of the directory with a trailing slash 285 * (e.g., "refs/heads/"): 286 */ 287 char name[FLEX_ARRAY]; 288}; 289 290static void read_loose_refs(const char *dirname, struct ref_dir *dir); 291 292static struct ref_dir *get_ref_dir(struct ref_entry *entry) 293{ 294 struct ref_dir *dir; 295 assert(entry->flag & REF_DIR); 296 dir = &entry->u.subdir; 297 if (entry->flag & REF_INCOMPLETE) { 298 read_loose_refs(entry->name, dir); 299 entry->flag &= ~REF_INCOMPLETE; 300 } 301 return dir; 302} 303 304/* 305 * Check if a refname is safe. 306 * For refs that start with "refs/" we consider it safe as long they do 307 * not try to resolve to outside of refs/. 308 * 309 * For all other refs we only consider them safe iff they only contain 310 * upper case characters and '_' (like "HEAD" AND "MERGE_HEAD", and not like 311 * "config"). 312 */ 313static int refname_is_safe(const char *refname) 314{ 315 if (starts_with(refname, "refs/")) { 316 char *buf; 317 int result; 318 319 buf = xmalloc(strlen(refname) + 1); 320 /* 321 * Does the refname try to escape refs/? 322 * For example: refs/foo/../bar is safe but refs/foo/../../bar 323 * is not. 324 */ 325 result = !normalize_path_copy(buf, refname + strlen("refs/")); 326 free(buf); 327 return result; 328 } 329 while (*refname) { 330 if (!isupper(*refname) && *refname != '_') 331 return 0; 332 refname++; 333 } 334 return 1; 335} 336 337static struct ref_entry *create_ref_entry(const char *refname, 338 const unsigned char *sha1, int flag, 339 int check_name) 340{ 341 int len; 342 struct ref_entry *ref; 343 344 if (check_name && 345 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) 346 die("Reference has invalid format: '%s'", refname); 347 if (!check_name && !refname_is_safe(refname)) 348 die("Reference has invalid name: '%s'", refname); 349 len = strlen(refname) + 1; 350 ref = xmalloc(sizeof(struct ref_entry) + len); 351 hashcpy(ref->u.value.sha1, sha1); 352 hashclr(ref->u.value.peeled); 353 memcpy(ref->name, refname, len); 354 ref->flag = flag; 355 return ref; 356} 357 358static void clear_ref_dir(struct ref_dir *dir); 359 360static void free_ref_entry(struct ref_entry *entry) 361{ 362 if (entry->flag & REF_DIR) { 363 /* 364 * Do not use get_ref_dir() here, as that might 365 * trigger the reading of loose refs. 366 */ 367 clear_ref_dir(&entry->u.subdir); 368 } 369 free(entry); 370} 371 372/* 373 * Add a ref_entry to the end of dir (unsorted). Entry is always 374 * stored directly in dir; no recursion into subdirectories is 375 * done. 376 */ 377static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry) 378{ 379 ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc); 380 dir->entries[dir->nr++] = entry; 381 /* optimize for the case that entries are added in order */ 382 if (dir->nr == 1 || 383 (dir->nr == dir->sorted + 1 && 384 strcmp(dir->entries[dir->nr - 2]->name, 385 dir->entries[dir->nr - 1]->name) < 0)) 386 dir->sorted = dir->nr; 387} 388 389/* 390 * Clear and free all entries in dir, recursively. 391 */ 392static void clear_ref_dir(struct ref_dir *dir) 393{ 394 int i; 395 for (i = 0; i < dir->nr; i++) 396 free_ref_entry(dir->entries[i]); 397 free(dir->entries); 398 dir->sorted = dir->nr = dir->alloc = 0; 399 dir->entries = NULL; 400} 401 402/* 403 * Create a struct ref_entry object for the specified dirname. 404 * dirname is the name of the directory with a trailing slash (e.g., 405 * "refs/heads/") or "" for the top-level directory. 406 */ 407static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache, 408 const char *dirname, size_t len, 409 int incomplete) 410{ 411 struct ref_entry *direntry; 412 direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1); 413 memcpy(direntry->name, dirname, len); 414 direntry->name[len] = '\0'; 415 direntry->u.subdir.ref_cache = ref_cache; 416 direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0); 417 return direntry; 418} 419 420static int ref_entry_cmp(const void *a, const void *b) 421{ 422 struct ref_entry *one = *(struct ref_entry **)a; 423 struct ref_entry *two = *(struct ref_entry **)b; 424 return strcmp(one->name, two->name); 425} 426 427static void sort_ref_dir(struct ref_dir *dir); 428 429struct string_slice { 430 size_t len; 431 const char *str; 432}; 433 434static int ref_entry_cmp_sslice(const void *key_, const void *ent_) 435{ 436 const struct string_slice *key = key_; 437 const struct ref_entry *ent = *(const struct ref_entry * const *)ent_; 438 int cmp = strncmp(key->str, ent->name, key->len); 439 if (cmp) 440 return cmp; 441 return '\0' - (unsigned char)ent->name[key->len]; 442} 443 444/* 445 * Return the index of the entry with the given refname from the 446 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if 447 * no such entry is found. dir must already be complete. 448 */ 449static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len) 450{ 451 struct ref_entry **r; 452 struct string_slice key; 453 454 if (refname == NULL || !dir->nr) 455 return -1; 456 457 sort_ref_dir(dir); 458 key.len = len; 459 key.str = refname; 460 r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries), 461 ref_entry_cmp_sslice); 462 463 if (r == NULL) 464 return -1; 465 466 return r - dir->entries; 467} 468 469/* 470 * Search for a directory entry directly within dir (without 471 * recursing). Sort dir if necessary. subdirname must be a directory 472 * name (i.e., end in '/'). If mkdir is set, then create the 473 * directory if it is missing; otherwise, return NULL if the desired 474 * directory cannot be found. dir must already be complete. 475 */ 476static struct ref_dir *search_for_subdir(struct ref_dir *dir, 477 const char *subdirname, size_t len, 478 int mkdir) 479{ 480 int entry_index = search_ref_dir(dir, subdirname, len); 481 struct ref_entry *entry; 482 if (entry_index == -1) { 483 if (!mkdir) 484 return NULL; 485 /* 486 * Since dir is complete, the absence of a subdir 487 * means that the subdir really doesn't exist; 488 * therefore, create an empty record for it but mark 489 * the record complete. 490 */ 491 entry = create_dir_entry(dir->ref_cache, subdirname, len, 0); 492 add_entry_to_dir(dir, entry); 493 } else { 494 entry = dir->entries[entry_index]; 495 } 496 return get_ref_dir(entry); 497} 498 499/* 500 * If refname is a reference name, find the ref_dir within the dir 501 * tree that should hold refname. If refname is a directory name 502 * (i.e., ends in '/'), then return that ref_dir itself. dir must 503 * represent the top-level directory and must already be complete. 504 * Sort ref_dirs and recurse into subdirectories as necessary. If 505 * mkdir is set, then create any missing directories; otherwise, 506 * return NULL if the desired directory cannot be found. 507 */ 508static struct ref_dir *find_containing_dir(struct ref_dir *dir, 509 const char *refname, int mkdir) 510{ 511 const char *slash; 512 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) { 513 size_t dirnamelen = slash - refname + 1; 514 struct ref_dir *subdir; 515 subdir = search_for_subdir(dir, refname, dirnamelen, mkdir); 516 if (!subdir) { 517 dir = NULL; 518 break; 519 } 520 dir = subdir; 521 } 522 523 return dir; 524} 525 526/* 527 * Find the value entry with the given name in dir, sorting ref_dirs 528 * and recursing into subdirectories as necessary. If the name is not 529 * found or it corresponds to a directory entry, return NULL. 530 */ 531static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname) 532{ 533 int entry_index; 534 struct ref_entry *entry; 535 dir = find_containing_dir(dir, refname, 0); 536 if (!dir) 537 return NULL; 538 entry_index = search_ref_dir(dir, refname, strlen(refname)); 539 if (entry_index == -1) 540 return NULL; 541 entry = dir->entries[entry_index]; 542 return (entry->flag & REF_DIR) ? NULL : entry; 543} 544 545/* 546 * Remove the entry with the given name from dir, recursing into 547 * subdirectories as necessary. If refname is the name of a directory 548 * (i.e., ends with '/'), then remove the directory and its contents. 549 * If the removal was successful, return the number of entries 550 * remaining in the directory entry that contained the deleted entry. 551 * If the name was not found, return -1. Please note that this 552 * function only deletes the entry from the cache; it does not delete 553 * it from the filesystem or ensure that other cache entries (which 554 * might be symbolic references to the removed entry) are updated. 555 * Nor does it remove any containing dir entries that might be made 556 * empty by the removal. dir must represent the top-level directory 557 * and must already be complete. 558 */ 559static int remove_entry(struct ref_dir *dir, const char *refname) 560{ 561 int refname_len = strlen(refname); 562 int entry_index; 563 struct ref_entry *entry; 564 int is_dir = refname[refname_len - 1] == '/'; 565 if (is_dir) { 566 /* 567 * refname represents a reference directory. Remove 568 * the trailing slash; otherwise we will get the 569 * directory *representing* refname rather than the 570 * one *containing* it. 571 */ 572 char *dirname = xmemdupz(refname, refname_len - 1); 573 dir = find_containing_dir(dir, dirname, 0); 574 free(dirname); 575 } else { 576 dir = find_containing_dir(dir, refname, 0); 577 } 578 if (!dir) 579 return -1; 580 entry_index = search_ref_dir(dir, refname, refname_len); 581 if (entry_index == -1) 582 return -1; 583 entry = dir->entries[entry_index]; 584 585 memmove(&dir->entries[entry_index], 586 &dir->entries[entry_index + 1], 587 (dir->nr - entry_index - 1) * sizeof(*dir->entries) 588 ); 589 dir->nr--; 590 if (dir->sorted > entry_index) 591 dir->sorted--; 592 free_ref_entry(entry); 593 return dir->nr; 594} 595 596/* 597 * Add a ref_entry to the ref_dir (unsorted), recursing into 598 * subdirectories as necessary. dir must represent the top-level 599 * directory. Return 0 on success. 600 */ 601static int add_ref(struct ref_dir *dir, struct ref_entry *ref) 602{ 603 dir = find_containing_dir(dir, ref->name, 1); 604 if (!dir) 605 return -1; 606 add_entry_to_dir(dir, ref); 607 return 0; 608} 609 610/* 611 * Emit a warning and return true iff ref1 and ref2 have the same name 612 * and the same sha1. Die if they have the same name but different 613 * sha1s. 614 */ 615static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2) 616{ 617 if (strcmp(ref1->name, ref2->name)) 618 return 0; 619 620 /* Duplicate name; make sure that they don't conflict: */ 621 622 if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR)) 623 /* This is impossible by construction */ 624 die("Reference directory conflict: %s", ref1->name); 625 626 if (hashcmp(ref1->u.value.sha1, ref2->u.value.sha1)) 627 die("Duplicated ref, and SHA1s don't match: %s", ref1->name); 628 629 warning("Duplicated ref: %s", ref1->name); 630 return 1; 631} 632 633/* 634 * Sort the entries in dir non-recursively (if they are not already 635 * sorted) and remove any duplicate entries. 636 */ 637static void sort_ref_dir(struct ref_dir *dir) 638{ 639 int i, j; 640 struct ref_entry *last = NULL; 641 642 /* 643 * This check also prevents passing a zero-length array to qsort(), 644 * which is a problem on some platforms. 645 */ 646 if (dir->sorted == dir->nr) 647 return; 648 649 qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp); 650 651 /* Remove any duplicates: */ 652 for (i = 0, j = 0; j < dir->nr; j++) { 653 struct ref_entry *entry = dir->entries[j]; 654 if (last && is_dup_ref(last, entry)) 655 free_ref_entry(entry); 656 else 657 last = dir->entries[i++] = entry; 658 } 659 dir->sorted = dir->nr = i; 660} 661 662/* Include broken references in a do_for_each_ref*() iteration: */ 663#define DO_FOR_EACH_INCLUDE_BROKEN 0x01 664 665/* 666 * Return true iff the reference described by entry can be resolved to 667 * an object in the database. Emit a warning if the referred-to 668 * object does not exist. 669 */ 670static int ref_resolves_to_object(struct ref_entry *entry) 671{ 672 if (entry->flag & REF_ISBROKEN) 673 return 0; 674 if (!has_sha1_file(entry->u.value.sha1)) { 675 error("%s does not point to a valid object!", entry->name); 676 return 0; 677 } 678 return 1; 679} 680 681/* 682 * current_ref is a performance hack: when iterating over references 683 * using the for_each_ref*() functions, current_ref is set to the 684 * current reference's entry before calling the callback function. If 685 * the callback function calls peel_ref(), then peel_ref() first 686 * checks whether the reference to be peeled is the current reference 687 * (it usually is) and if so, returns that reference's peeled version 688 * if it is available. This avoids a refname lookup in a common case. 689 */ 690static struct ref_entry *current_ref; 691 692typedef int each_ref_entry_fn(struct ref_entry *entry, void *cb_data); 693 694struct ref_entry_cb { 695 const char *base; 696 int trim; 697 int flags; 698 each_ref_fn *fn; 699 void *cb_data; 700}; 701 702/* 703 * Handle one reference in a do_for_each_ref*()-style iteration, 704 * calling an each_ref_fn for each entry. 705 */ 706static int do_one_ref(struct ref_entry *entry, void *cb_data) 707{ 708 struct ref_entry_cb *data = cb_data; 709 struct ref_entry *old_current_ref; 710 int retval; 711 712 if (!starts_with(entry->name, data->base)) 713 return 0; 714 715 if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) && 716 !ref_resolves_to_object(entry)) 717 return 0; 718 719 /* Store the old value, in case this is a recursive call: */ 720 old_current_ref = current_ref; 721 current_ref = entry; 722 retval = data->fn(entry->name + data->trim, entry->u.value.sha1, 723 entry->flag, data->cb_data); 724 current_ref = old_current_ref; 725 return retval; 726} 727 728/* 729 * Call fn for each reference in dir that has index in the range 730 * offset <= index < dir->nr. Recurse into subdirectories that are in 731 * that index range, sorting them before iterating. This function 732 * does not sort dir itself; it should be sorted beforehand. fn is 733 * called for all references, including broken ones. 734 */ 735static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset, 736 each_ref_entry_fn fn, void *cb_data) 737{ 738 int i; 739 assert(dir->sorted == dir->nr); 740 for (i = offset; i < dir->nr; i++) { 741 struct ref_entry *entry = dir->entries[i]; 742 int retval; 743 if (entry->flag & REF_DIR) { 744 struct ref_dir *subdir = get_ref_dir(entry); 745 sort_ref_dir(subdir); 746 retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data); 747 } else { 748 retval = fn(entry, cb_data); 749 } 750 if (retval) 751 return retval; 752 } 753 return 0; 754} 755 756/* 757 * Call fn for each reference in the union of dir1 and dir2, in order 758 * by refname. Recurse into subdirectories. If a value entry appears 759 * in both dir1 and dir2, then only process the version that is in 760 * dir2. The input dirs must already be sorted, but subdirs will be 761 * sorted as needed. fn is called for all references, including 762 * broken ones. 763 */ 764static int do_for_each_entry_in_dirs(struct ref_dir *dir1, 765 struct ref_dir *dir2, 766 each_ref_entry_fn fn, void *cb_data) 767{ 768 int retval; 769 int i1 = 0, i2 = 0; 770 771 assert(dir1->sorted == dir1->nr); 772 assert(dir2->sorted == dir2->nr); 773 while (1) { 774 struct ref_entry *e1, *e2; 775 int cmp; 776 if (i1 == dir1->nr) { 777 return do_for_each_entry_in_dir(dir2, i2, fn, cb_data); 778 } 779 if (i2 == dir2->nr) { 780 return do_for_each_entry_in_dir(dir1, i1, fn, cb_data); 781 } 782 e1 = dir1->entries[i1]; 783 e2 = dir2->entries[i2]; 784 cmp = strcmp(e1->name, e2->name); 785 if (cmp == 0) { 786 if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) { 787 /* Both are directories; descend them in parallel. */ 788 struct ref_dir *subdir1 = get_ref_dir(e1); 789 struct ref_dir *subdir2 = get_ref_dir(e2); 790 sort_ref_dir(subdir1); 791 sort_ref_dir(subdir2); 792 retval = do_for_each_entry_in_dirs( 793 subdir1, subdir2, fn, cb_data); 794 i1++; 795 i2++; 796 } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) { 797 /* Both are references; ignore the one from dir1. */ 798 retval = fn(e2, cb_data); 799 i1++; 800 i2++; 801 } else { 802 die("conflict between reference and directory: %s", 803 e1->name); 804 } 805 } else { 806 struct ref_entry *e; 807 if (cmp < 0) { 808 e = e1; 809 i1++; 810 } else { 811 e = e2; 812 i2++; 813 } 814 if (e->flag & REF_DIR) { 815 struct ref_dir *subdir = get_ref_dir(e); 816 sort_ref_dir(subdir); 817 retval = do_for_each_entry_in_dir( 818 subdir, 0, fn, cb_data); 819 } else { 820 retval = fn(e, cb_data); 821 } 822 } 823 if (retval) 824 return retval; 825 } 826} 827 828/* 829 * Load all of the refs from the dir into our in-memory cache. The hard work 830 * of loading loose refs is done by get_ref_dir(), so we just need to recurse 831 * through all of the sub-directories. We do not even need to care about 832 * sorting, as traversal order does not matter to us. 833 */ 834static void prime_ref_dir(struct ref_dir *dir) 835{ 836 int i; 837 for (i = 0; i < dir->nr; i++) { 838 struct ref_entry *entry = dir->entries[i]; 839 if (entry->flag & REF_DIR) 840 prime_ref_dir(get_ref_dir(entry)); 841 } 842} 843 844struct nonmatching_ref_data { 845 const struct string_list *skip; 846 const char *conflicting_refname; 847}; 848 849static int nonmatching_ref_fn(struct ref_entry *entry, void *vdata) 850{ 851 struct nonmatching_ref_data *data = vdata; 852 853 if (data->skip && string_list_has_string(data->skip, entry->name)) 854 return 0; 855 856 data->conflicting_refname = entry->name; 857 return 1; 858} 859 860/* 861 * Return true iff a reference named refname could be created without 862 * conflicting with the name of an existing reference in dir. If 863 * skip is non-NULL, ignore potential conflicts with refs in skip 864 * (e.g., because they are scheduled for deletion in the same 865 * operation). 866 * 867 * Two reference names conflict if one of them exactly matches the 868 * leading components of the other; e.g., "refs/foo/bar" conflicts 869 * with both "refs/foo" and with "refs/foo/bar/baz" but not with 870 * "refs/foo/bar" or "refs/foo/barbados". 871 * 872 * skip must be sorted. 873 */ 874static int is_refname_available(const char *refname, 875 const struct string_list *skip, 876 struct ref_dir *dir) 877{ 878 const char *slash; 879 int pos; 880 struct strbuf dirname = STRBUF_INIT; 881 882 /* 883 * For the sake of comments in this function, suppose that 884 * refname is "refs/foo/bar". 885 */ 886 887 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) { 888 /* 889 * We are still at a leading dir of the refname (e.g., 890 * "refs/foo"; if there is a reference with that name, 891 * it is a conflict, *unless* it is in skip. 892 */ 893 pos = search_ref_dir(dir, refname, slash - refname); 894 if (pos >= 0) { 895 /* 896 * We found a reference whose name is a proper 897 * prefix of refname; e.g., "refs/foo". 898 */ 899 struct ref_entry *entry = dir->entries[pos]; 900 if (skip && string_list_has_string(skip, entry->name)) { 901 /* 902 * The reference we just found, e.g., 903 * "refs/foo", is also in skip, so it 904 * is not considered a conflict. 905 * Moreover, the fact that "refs/foo" 906 * exists means that there cannot be 907 * any references anywhere under the 908 * "refs/foo/" namespace (because they 909 * would have conflicted with 910 * "refs/foo"). So we can stop looking 911 * now and return true. 912 */ 913 return 1; 914 } 915 error("'%s' exists; cannot create '%s'", entry->name, refname); 916 return 0; 917 } 918 919 920 /* 921 * Otherwise, we can try to continue our search with 922 * the next component. So try to look up the 923 * directory, e.g., "refs/foo/". 924 */ 925 pos = search_ref_dir(dir, refname, slash + 1 - refname); 926 if (pos < 0) { 927 /* 928 * There was no directory "refs/foo/", so 929 * there is nothing under this whole prefix, 930 * and we are OK. 931 */ 932 return 1; 933 } 934 935 dir = get_ref_dir(dir->entries[pos]); 936 } 937 938 /* 939 * We are at the leaf of our refname (e.g., "refs/foo/bar"). 940 * There is no point in searching for a reference with that 941 * name, because a refname isn't considered to conflict with 942 * itself. But we still need to check for references whose 943 * names are in the "refs/foo/bar/" namespace, because they 944 * *do* conflict. 945 */ 946 strbuf_addstr(&dirname, refname); 947 strbuf_addch(&dirname, '/'); 948 pos = search_ref_dir(dir, dirname.buf, dirname.len); 949 strbuf_release(&dirname); 950 951 if (pos >= 0) { 952 /* 953 * We found a directory named "$refname/" (e.g., 954 * "refs/foo/bar/"). It is a problem iff it contains 955 * any ref that is not in "skip". 956 */ 957 struct nonmatching_ref_data data; 958 struct ref_entry *entry = dir->entries[pos]; 959 960 dir = get_ref_dir(entry); 961 data.skip = skip; 962 sort_ref_dir(dir); 963 if (!do_for_each_entry_in_dir(dir, 0, nonmatching_ref_fn, &data)) 964 return 1; 965 966 error("'%s' exists; cannot create '%s'", 967 data.conflicting_refname, refname); 968 return 0; 969 } 970 971 return 1; 972} 973 974struct packed_ref_cache { 975 struct ref_entry *root; 976 977 /* 978 * Count of references to the data structure in this instance, 979 * including the pointer from ref_cache::packed if any. The 980 * data will not be freed as long as the reference count is 981 * nonzero. 982 */ 983 unsigned int referrers; 984 985 /* 986 * Iff the packed-refs file associated with this instance is 987 * currently locked for writing, this points at the associated 988 * lock (which is owned by somebody else). The referrer count 989 * is also incremented when the file is locked and decremented 990 * when it is unlocked. 991 */ 992 struct lock_file *lock; 993 994 /* The metadata from when this packed-refs cache was read */ 995 struct stat_validity validity; 996}; 997 998/* 999 * Future: need to be in "struct repository"1000 * when doing a full libification.1001 */1002static struct ref_cache {1003 struct ref_cache *next;1004 struct ref_entry *loose;1005 struct packed_ref_cache *packed;1006 /*1007 * The submodule name, or "" for the main repo. We allocate1008 * length 1 rather than FLEX_ARRAY so that the main ref_cache1009 * is initialized correctly.1010 */1011 char name[1];1012} ref_cache, *submodule_ref_caches;10131014/* Lock used for the main packed-refs file: */1015static struct lock_file packlock;10161017/*1018 * Increment the reference count of *packed_refs.1019 */1020static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs)1021{1022 packed_refs->referrers++;1023}10241025/*1026 * Decrease the reference count of *packed_refs. If it goes to zero,1027 * free *packed_refs and return true; otherwise return false.1028 */1029static int release_packed_ref_cache(struct packed_ref_cache *packed_refs)1030{1031 if (!--packed_refs->referrers) {1032 free_ref_entry(packed_refs->root);1033 stat_validity_clear(&packed_refs->validity);1034 free(packed_refs);1035 return 1;1036 } else {1037 return 0;1038 }1039}10401041static void clear_packed_ref_cache(struct ref_cache *refs)1042{1043 if (refs->packed) {1044 struct packed_ref_cache *packed_refs = refs->packed;10451046 if (packed_refs->lock)1047 die("internal error: packed-ref cache cleared while locked");1048 refs->packed = NULL;1049 release_packed_ref_cache(packed_refs);1050 }1051}10521053static void clear_loose_ref_cache(struct ref_cache *refs)1054{1055 if (refs->loose) {1056 free_ref_entry(refs->loose);1057 refs->loose = NULL;1058 }1059}10601061static struct ref_cache *create_ref_cache(const char *submodule)1062{1063 int len;1064 struct ref_cache *refs;1065 if (!submodule)1066 submodule = "";1067 len = strlen(submodule) + 1;1068 refs = xcalloc(1, sizeof(struct ref_cache) + len);1069 memcpy(refs->name, submodule, len);1070 return refs;1071}10721073/*1074 * Return a pointer to a ref_cache for the specified submodule. For1075 * the main repository, use submodule==NULL. The returned structure1076 * will be allocated and initialized but not necessarily populated; it1077 * should not be freed.1078 */1079static struct ref_cache *get_ref_cache(const char *submodule)1080{1081 struct ref_cache *refs;10821083 if (!submodule || !*submodule)1084 return &ref_cache;10851086 for (refs = submodule_ref_caches; refs; refs = refs->next)1087 if (!strcmp(submodule, refs->name))1088 return refs;10891090 refs = create_ref_cache(submodule);1091 refs->next = submodule_ref_caches;1092 submodule_ref_caches = refs;1093 return refs;1094}10951096/* The length of a peeled reference line in packed-refs, including EOL: */1097#define PEELED_LINE_LENGTH 4210981099/*1100 * The packed-refs header line that we write out. Perhaps other1101 * traits will be added later. The trailing space is required.1102 */1103static const char PACKED_REFS_HEADER[] =1104 "# pack-refs with: peeled fully-peeled \n";11051106/*1107 * Parse one line from a packed-refs file. Write the SHA1 to sha1.1108 * Return a pointer to the refname within the line (null-terminated),1109 * or NULL if there was a problem.1110 */1111static const char *parse_ref_line(struct strbuf *line, unsigned char *sha1)1112{1113 const char *ref;11141115 /*1116 * 42: the answer to everything.1117 *1118 * In this case, it happens to be the answer to1119 * 40 (length of sha1 hex representation)1120 * +1 (space in between hex and name)1121 * +1 (newline at the end of the line)1122 */1123 if (line->len <= 42)1124 return NULL;11251126 if (get_sha1_hex(line->buf, sha1) < 0)1127 return NULL;1128 if (!isspace(line->buf[40]))1129 return NULL;11301131 ref = line->buf + 41;1132 if (isspace(*ref))1133 return NULL;11341135 if (line->buf[line->len - 1] != '\n')1136 return NULL;1137 line->buf[--line->len] = 0;11381139 return ref;1140}11411142/*1143 * Read f, which is a packed-refs file, into dir.1144 *1145 * A comment line of the form "# pack-refs with: " may contain zero or1146 * more traits. We interpret the traits as follows:1147 *1148 * No traits:1149 *1150 * Probably no references are peeled. But if the file contains a1151 * peeled value for a reference, we will use it.1152 *1153 * peeled:1154 *1155 * References under "refs/tags/", if they *can* be peeled, *are*1156 * peeled in this file. References outside of "refs/tags/" are1157 * probably not peeled even if they could have been, but if we find1158 * a peeled value for such a reference we will use it.1159 *1160 * fully-peeled:1161 *1162 * All references in the file that can be peeled are peeled.1163 * Inversely (and this is more important), any references in the1164 * file for which no peeled value is recorded is not peelable. This1165 * trait should typically be written alongside "peeled" for1166 * compatibility with older clients, but we do not require it1167 * (i.e., "peeled" is a no-op if "fully-peeled" is set).1168 */1169static void read_packed_refs(FILE *f, struct ref_dir *dir)1170{1171 struct ref_entry *last = NULL;1172 struct strbuf line = STRBUF_INIT;1173 enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;11741175 while (strbuf_getwholeline(&line, f, '\n') != EOF) {1176 unsigned char sha1[20];1177 const char *refname;1178 const char *traits;11791180 if (skip_prefix(line.buf, "# pack-refs with:", &traits)) {1181 if (strstr(traits, " fully-peeled "))1182 peeled = PEELED_FULLY;1183 else if (strstr(traits, " peeled "))1184 peeled = PEELED_TAGS;1185 /* perhaps other traits later as well */1186 continue;1187 }11881189 refname = parse_ref_line(&line, sha1);1190 if (refname) {1191 int flag = REF_ISPACKED;11921193 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {1194 hashclr(sha1);1195 flag |= REF_BAD_NAME | REF_ISBROKEN;1196 }1197 last = create_ref_entry(refname, sha1, flag, 0);1198 if (peeled == PEELED_FULLY ||1199 (peeled == PEELED_TAGS && starts_with(refname, "refs/tags/")))1200 last->flag |= REF_KNOWS_PEELED;1201 add_ref(dir, last);1202 continue;1203 }1204 if (last &&1205 line.buf[0] == '^' &&1206 line.len == PEELED_LINE_LENGTH &&1207 line.buf[PEELED_LINE_LENGTH - 1] == '\n' &&1208 !get_sha1_hex(line.buf + 1, sha1)) {1209 hashcpy(last->u.value.peeled, sha1);1210 /*1211 * Regardless of what the file header said,1212 * we definitely know the value of *this*1213 * reference:1214 */1215 last->flag |= REF_KNOWS_PEELED;1216 }1217 }12181219 strbuf_release(&line);1220}12211222/*1223 * Get the packed_ref_cache for the specified ref_cache, creating it1224 * if necessary.1225 */1226static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs)1227{1228 const char *packed_refs_file;12291230 if (*refs->name)1231 packed_refs_file = git_path_submodule(refs->name, "packed-refs");1232 else1233 packed_refs_file = git_path("packed-refs");12341235 if (refs->packed &&1236 !stat_validity_check(&refs->packed->validity, packed_refs_file))1237 clear_packed_ref_cache(refs);12381239 if (!refs->packed) {1240 FILE *f;12411242 refs->packed = xcalloc(1, sizeof(*refs->packed));1243 acquire_packed_ref_cache(refs->packed);1244 refs->packed->root = create_dir_entry(refs, "", 0, 0);1245 f = fopen(packed_refs_file, "r");1246 if (f) {1247 stat_validity_update(&refs->packed->validity, fileno(f));1248 read_packed_refs(f, get_ref_dir(refs->packed->root));1249 fclose(f);1250 }1251 }1252 return refs->packed;1253}12541255static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_cache)1256{1257 return get_ref_dir(packed_ref_cache->root);1258}12591260static struct ref_dir *get_packed_refs(struct ref_cache *refs)1261{1262 return get_packed_ref_dir(get_packed_ref_cache(refs));1263}12641265void add_packed_ref(const char *refname, const unsigned char *sha1)1266{1267 struct packed_ref_cache *packed_ref_cache =1268 get_packed_ref_cache(&ref_cache);12691270 if (!packed_ref_cache->lock)1271 die("internal error: packed refs not locked");1272 add_ref(get_packed_ref_dir(packed_ref_cache),1273 create_ref_entry(refname, sha1, REF_ISPACKED, 1));1274}12751276/*1277 * Read the loose references from the namespace dirname into dir1278 * (without recursing). dirname must end with '/'. dir must be the1279 * directory entry corresponding to dirname.1280 */1281static void read_loose_refs(const char *dirname, struct ref_dir *dir)1282{1283 struct ref_cache *refs = dir->ref_cache;1284 DIR *d;1285 const char *path;1286 struct dirent *de;1287 int dirnamelen = strlen(dirname);1288 struct strbuf refname;12891290 if (*refs->name)1291 path = git_path_submodule(refs->name, "%s", dirname);1292 else1293 path = git_path("%s", dirname);12941295 d = opendir(path);1296 if (!d)1297 return;12981299 strbuf_init(&refname, dirnamelen + 257);1300 strbuf_add(&refname, dirname, dirnamelen);13011302 while ((de = readdir(d)) != NULL) {1303 unsigned char sha1[20];1304 struct stat st;1305 int flag;1306 const char *refdir;13071308 if (de->d_name[0] == '.')1309 continue;1310 if (ends_with(de->d_name, ".lock"))1311 continue;1312 strbuf_addstr(&refname, de->d_name);1313 refdir = *refs->name1314 ? git_path_submodule(refs->name, "%s", refname.buf)1315 : git_path("%s", refname.buf);1316 if (stat(refdir, &st) < 0) {1317 ; /* silently ignore */1318 } else if (S_ISDIR(st.st_mode)) {1319 strbuf_addch(&refname, '/');1320 add_entry_to_dir(dir,1321 create_dir_entry(refs, refname.buf,1322 refname.len, 1));1323 } else {1324 if (*refs->name) {1325 hashclr(sha1);1326 flag = 0;1327 if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {1328 hashclr(sha1);1329 flag |= REF_ISBROKEN;1330 }1331 } else if (read_ref_full(refname.buf,1332 RESOLVE_REF_READING,1333 sha1, &flag)) {1334 hashclr(sha1);1335 flag |= REF_ISBROKEN;1336 }1337 if (check_refname_format(refname.buf,1338 REFNAME_ALLOW_ONELEVEL)) {1339 hashclr(sha1);1340 flag |= REF_BAD_NAME | REF_ISBROKEN;1341 }1342 add_entry_to_dir(dir,1343 create_ref_entry(refname.buf, sha1, flag, 0));1344 }1345 strbuf_setlen(&refname, dirnamelen);1346 }1347 strbuf_release(&refname);1348 closedir(d);1349}13501351static struct ref_dir *get_loose_refs(struct ref_cache *refs)1352{1353 if (!refs->loose) {1354 /*1355 * Mark the top-level directory complete because we1356 * are about to read the only subdirectory that can1357 * hold references:1358 */1359 refs->loose = create_dir_entry(refs, "", 0, 0);1360 /*1361 * Create an incomplete entry for "refs/":1362 */1363 add_entry_to_dir(get_ref_dir(refs->loose),1364 create_dir_entry(refs, "refs/", 5, 1));1365 }1366 return get_ref_dir(refs->loose);1367}13681369/* We allow "recursive" symbolic refs. Only within reason, though */1370#define MAXDEPTH 51371#define MAXREFLEN (1024)13721373/*1374 * Called by resolve_gitlink_ref_recursive() after it failed to read1375 * from the loose refs in ref_cache refs. Find <refname> in the1376 * packed-refs file for the submodule.1377 */1378static int resolve_gitlink_packed_ref(struct ref_cache *refs,1379 const char *refname, unsigned char *sha1)1380{1381 struct ref_entry *ref;1382 struct ref_dir *dir = get_packed_refs(refs);13831384 ref = find_ref(dir, refname);1385 if (ref == NULL)1386 return -1;13871388 hashcpy(sha1, ref->u.value.sha1);1389 return 0;1390}13911392static int resolve_gitlink_ref_recursive(struct ref_cache *refs,1393 const char *refname, unsigned char *sha1,1394 int recursion)1395{1396 int fd, len;1397 char buffer[128], *p;1398 char *path;13991400 if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)1401 return -1;1402 path = *refs->name1403 ? git_path_submodule(refs->name, "%s", refname)1404 : git_path("%s", refname);1405 fd = open(path, O_RDONLY);1406 if (fd < 0)1407 return resolve_gitlink_packed_ref(refs, refname, sha1);14081409 len = read(fd, buffer, sizeof(buffer)-1);1410 close(fd);1411 if (len < 0)1412 return -1;1413 while (len && isspace(buffer[len-1]))1414 len--;1415 buffer[len] = 0;14161417 /* Was it a detached head or an old-fashioned symlink? */1418 if (!get_sha1_hex(buffer, sha1))1419 return 0;14201421 /* Symref? */1422 if (strncmp(buffer, "ref:", 4))1423 return -1;1424 p = buffer + 4;1425 while (isspace(*p))1426 p++;14271428 return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);1429}14301431int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)1432{1433 int len = strlen(path), retval;1434 char *submodule;1435 struct ref_cache *refs;14361437 while (len && path[len-1] == '/')1438 len--;1439 if (!len)1440 return -1;1441 submodule = xstrndup(path, len);1442 refs = get_ref_cache(submodule);1443 free(submodule);14441445 retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);1446 return retval;1447}14481449/*1450 * Return the ref_entry for the given refname from the packed1451 * references. If it does not exist, return NULL.1452 */1453static struct ref_entry *get_packed_ref(const char *refname)1454{1455 return find_ref(get_packed_refs(&ref_cache), refname);1456}14571458/*1459 * A loose ref file doesn't exist; check for a packed ref. The1460 * options are forwarded from resolve_safe_unsafe().1461 */1462static int resolve_missing_loose_ref(const char *refname,1463 int resolve_flags,1464 unsigned char *sha1,1465 int *flags)1466{1467 struct ref_entry *entry;14681469 /*1470 * The loose reference file does not exist; check for a packed1471 * reference.1472 */1473 entry = get_packed_ref(refname);1474 if (entry) {1475 hashcpy(sha1, entry->u.value.sha1);1476 if (flags)1477 *flags |= REF_ISPACKED;1478 return 0;1479 }1480 /* The reference is not a packed reference, either. */1481 if (resolve_flags & RESOLVE_REF_READING) {1482 errno = ENOENT;1483 return -1;1484 } else {1485 hashclr(sha1);1486 return 0;1487 }1488}14891490/* This function needs to return a meaningful errno on failure */1491const char *resolve_ref_unsafe(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)1492{1493 int depth = MAXDEPTH;1494 ssize_t len;1495 char buffer[256];1496 static char refname_buffer[256];1497 int bad_name = 0;14981499 if (flags)1500 *flags = 0;15011502 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {1503 if (flags)1504 *flags |= REF_BAD_NAME;15051506 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||1507 !refname_is_safe(refname)) {1508 errno = EINVAL;1509 return NULL;1510 }1511 /*1512 * dwim_ref() uses REF_ISBROKEN to distinguish between1513 * missing refs and refs that were present but invalid,1514 * to complain about the latter to stderr.1515 *1516 * We don't know whether the ref exists, so don't set1517 * REF_ISBROKEN yet.1518 */1519 bad_name = 1;1520 }1521 for (;;) {1522 char path[PATH_MAX];1523 struct stat st;1524 char *buf;1525 int fd;15261527 if (--depth < 0) {1528 errno = ELOOP;1529 return NULL;1530 }15311532 git_snpath(path, sizeof(path), "%s", refname);15331534 /*1535 * We might have to loop back here to avoid a race1536 * condition: first we lstat() the file, then we try1537 * to read it as a link or as a file. But if somebody1538 * changes the type of the file (file <-> directory1539 * <-> symlink) between the lstat() and reading, then1540 * we don't want to report that as an error but rather1541 * try again starting with the lstat().1542 */1543 stat_ref:1544 if (lstat(path, &st) < 0) {1545 if (errno != ENOENT)1546 return NULL;1547 if (resolve_missing_loose_ref(refname, resolve_flags,1548 sha1, flags))1549 return NULL;1550 if (bad_name) {1551 hashclr(sha1);1552 if (flags)1553 *flags |= REF_ISBROKEN;1554 }1555 return refname;1556 }15571558 /* Follow "normalized" - ie "refs/.." symlinks by hand */1559 if (S_ISLNK(st.st_mode)) {1560 len = readlink(path, buffer, sizeof(buffer)-1);1561 if (len < 0) {1562 if (errno == ENOENT || errno == EINVAL)1563 /* inconsistent with lstat; retry */1564 goto stat_ref;1565 else1566 return NULL;1567 }1568 buffer[len] = 0;1569 if (starts_with(buffer, "refs/") &&1570 !check_refname_format(buffer, 0)) {1571 strcpy(refname_buffer, buffer);1572 refname = refname_buffer;1573 if (flags)1574 *flags |= REF_ISSYMREF;1575 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {1576 hashclr(sha1);1577 return refname;1578 }1579 continue;1580 }1581 }15821583 /* Is it a directory? */1584 if (S_ISDIR(st.st_mode)) {1585 errno = EISDIR;1586 return NULL;1587 }15881589 /*1590 * Anything else, just open it and try to use it as1591 * a ref1592 */1593 fd = open(path, O_RDONLY);1594 if (fd < 0) {1595 if (errno == ENOENT)1596 /* inconsistent with lstat; retry */1597 goto stat_ref;1598 else1599 return NULL;1600 }1601 len = read_in_full(fd, buffer, sizeof(buffer)-1);1602 if (len < 0) {1603 int save_errno = errno;1604 close(fd);1605 errno = save_errno;1606 return NULL;1607 }1608 close(fd);1609 while (len && isspace(buffer[len-1]))1610 len--;1611 buffer[len] = '\0';16121613 /*1614 * Is it a symbolic ref?1615 */1616 if (!starts_with(buffer, "ref:")) {1617 /*1618 * Please note that FETCH_HEAD has a second1619 * line containing other data.1620 */1621 if (get_sha1_hex(buffer, sha1) ||1622 (buffer[40] != '\0' && !isspace(buffer[40]))) {1623 if (flags)1624 *flags |= REF_ISBROKEN;1625 errno = EINVAL;1626 return NULL;1627 }1628 if (bad_name) {1629 hashclr(sha1);1630 if (flags)1631 *flags |= REF_ISBROKEN;1632 }1633 return refname;1634 }1635 if (flags)1636 *flags |= REF_ISSYMREF;1637 buf = buffer + 4;1638 while (isspace(*buf))1639 buf++;1640 refname = strcpy(refname_buffer, buf);1641 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {1642 hashclr(sha1);1643 return refname;1644 }1645 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {1646 if (flags)1647 *flags |= REF_ISBROKEN;16481649 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||1650 !refname_is_safe(buf)) {1651 errno = EINVAL;1652 return NULL;1653 }1654 bad_name = 1;1655 }1656 }1657}16581659char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags)1660{1661 return xstrdup_or_null(resolve_ref_unsafe(ref, resolve_flags, sha1, flags));1662}16631664/* The argument to filter_refs */1665struct ref_filter {1666 const char *pattern;1667 each_ref_fn *fn;1668 void *cb_data;1669};16701671int read_ref_full(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)1672{1673 if (resolve_ref_unsafe(refname, resolve_flags, sha1, flags))1674 return 0;1675 return -1;1676}16771678int read_ref(const char *refname, unsigned char *sha1)1679{1680 return read_ref_full(refname, RESOLVE_REF_READING, sha1, NULL);1681}16821683int ref_exists(const char *refname)1684{1685 unsigned char sha1[20];1686 return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, sha1, NULL);1687}16881689static int filter_refs(const char *refname, const unsigned char *sha1, int flags,1690 void *data)1691{1692 struct ref_filter *filter = (struct ref_filter *)data;1693 if (wildmatch(filter->pattern, refname, 0, NULL))1694 return 0;1695 return filter->fn(refname, sha1, flags, filter->cb_data);1696}16971698enum peel_status {1699 /* object was peeled successfully: */1700 PEEL_PEELED = 0,17011702 /*1703 * object cannot be peeled because the named object (or an1704 * object referred to by a tag in the peel chain), does not1705 * exist.1706 */1707 PEEL_INVALID = -1,17081709 /* object cannot be peeled because it is not a tag: */1710 PEEL_NON_TAG = -2,17111712 /* ref_entry contains no peeled value because it is a symref: */1713 PEEL_IS_SYMREF = -3,17141715 /*1716 * ref_entry cannot be peeled because it is broken (i.e., the1717 * symbolic reference cannot even be resolved to an object1718 * name):1719 */1720 PEEL_BROKEN = -41721};17221723/*1724 * Peel the named object; i.e., if the object is a tag, resolve the1725 * tag recursively until a non-tag is found. If successful, store the1726 * result to sha1 and return PEEL_PEELED. If the object is not a tag1727 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,1728 * and leave sha1 unchanged.1729 */1730static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)1731{1732 struct object *o = lookup_unknown_object(name);17331734 if (o->type == OBJ_NONE) {1735 int type = sha1_object_info(name, NULL);1736 if (type < 0 || !object_as_type(o, type, 0))1737 return PEEL_INVALID;1738 }17391740 if (o->type != OBJ_TAG)1741 return PEEL_NON_TAG;17421743 o = deref_tag_noverify(o);1744 if (!o)1745 return PEEL_INVALID;17461747 hashcpy(sha1, o->sha1);1748 return PEEL_PEELED;1749}17501751/*1752 * Peel the entry (if possible) and return its new peel_status. If1753 * repeel is true, re-peel the entry even if there is an old peeled1754 * value that is already stored in it.1755 *1756 * It is OK to call this function with a packed reference entry that1757 * might be stale and might even refer to an object that has since1758 * been garbage-collected. In such a case, if the entry has1759 * REF_KNOWS_PEELED then leave the status unchanged and return1760 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.1761 */1762static enum peel_status peel_entry(struct ref_entry *entry, int repeel)1763{1764 enum peel_status status;17651766 if (entry->flag & REF_KNOWS_PEELED) {1767 if (repeel) {1768 entry->flag &= ~REF_KNOWS_PEELED;1769 hashclr(entry->u.value.peeled);1770 } else {1771 return is_null_sha1(entry->u.value.peeled) ?1772 PEEL_NON_TAG : PEEL_PEELED;1773 }1774 }1775 if (entry->flag & REF_ISBROKEN)1776 return PEEL_BROKEN;1777 if (entry->flag & REF_ISSYMREF)1778 return PEEL_IS_SYMREF;17791780 status = peel_object(entry->u.value.sha1, entry->u.value.peeled);1781 if (status == PEEL_PEELED || status == PEEL_NON_TAG)1782 entry->flag |= REF_KNOWS_PEELED;1783 return status;1784}17851786int peel_ref(const char *refname, unsigned char *sha1)1787{1788 int flag;1789 unsigned char base[20];17901791 if (current_ref && (current_ref->name == refname1792 || !strcmp(current_ref->name, refname))) {1793 if (peel_entry(current_ref, 0))1794 return -1;1795 hashcpy(sha1, current_ref->u.value.peeled);1796 return 0;1797 }17981799 if (read_ref_full(refname, RESOLVE_REF_READING, base, &flag))1800 return -1;18011802 /*1803 * If the reference is packed, read its ref_entry from the1804 * cache in the hope that we already know its peeled value.1805 * We only try this optimization on packed references because1806 * (a) forcing the filling of the loose reference cache could1807 * be expensive and (b) loose references anyway usually do not1808 * have REF_KNOWS_PEELED.1809 */1810 if (flag & REF_ISPACKED) {1811 struct ref_entry *r = get_packed_ref(refname);1812 if (r) {1813 if (peel_entry(r, 0))1814 return -1;1815 hashcpy(sha1, r->u.value.peeled);1816 return 0;1817 }1818 }18191820 return peel_object(base, sha1);1821}18221823struct warn_if_dangling_data {1824 FILE *fp;1825 const char *refname;1826 const struct string_list *refnames;1827 const char *msg_fmt;1828};18291830static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,1831 int flags, void *cb_data)1832{1833 struct warn_if_dangling_data *d = cb_data;1834 const char *resolves_to;1835 unsigned char junk[20];18361837 if (!(flags & REF_ISSYMREF))1838 return 0;18391840 resolves_to = resolve_ref_unsafe(refname, 0, junk, NULL);1841 if (!resolves_to1842 || (d->refname1843 ? strcmp(resolves_to, d->refname)1844 : !string_list_has_string(d->refnames, resolves_to))) {1845 return 0;1846 }18471848 fprintf(d->fp, d->msg_fmt, refname);1849 fputc('\n', d->fp);1850 return 0;1851}18521853void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)1854{1855 struct warn_if_dangling_data data;18561857 data.fp = fp;1858 data.refname = refname;1859 data.refnames = NULL;1860 data.msg_fmt = msg_fmt;1861 for_each_rawref(warn_if_dangling_symref, &data);1862}18631864void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)1865{1866 struct warn_if_dangling_data data;18671868 data.fp = fp;1869 data.refname = NULL;1870 data.refnames = refnames;1871 data.msg_fmt = msg_fmt;1872 for_each_rawref(warn_if_dangling_symref, &data);1873}18741875/*1876 * Call fn for each reference in the specified ref_cache, omitting1877 * references not in the containing_dir of base. fn is called for all1878 * references, including broken ones. If fn ever returns a non-zero1879 * value, stop the iteration and return that value; otherwise, return1880 * 0.1881 */1882static int do_for_each_entry(struct ref_cache *refs, const char *base,1883 each_ref_entry_fn fn, void *cb_data)1884{1885 struct packed_ref_cache *packed_ref_cache;1886 struct ref_dir *loose_dir;1887 struct ref_dir *packed_dir;1888 int retval = 0;18891890 /*1891 * We must make sure that all loose refs are read before accessing the1892 * packed-refs file; this avoids a race condition in which loose refs1893 * are migrated to the packed-refs file by a simultaneous process, but1894 * our in-memory view is from before the migration. get_packed_ref_cache()1895 * takes care of making sure our view is up to date with what is on1896 * disk.1897 */1898 loose_dir = get_loose_refs(refs);1899 if (base && *base) {1900 loose_dir = find_containing_dir(loose_dir, base, 0);1901 }1902 if (loose_dir)1903 prime_ref_dir(loose_dir);19041905 packed_ref_cache = get_packed_ref_cache(refs);1906 acquire_packed_ref_cache(packed_ref_cache);1907 packed_dir = get_packed_ref_dir(packed_ref_cache);1908 if (base && *base) {1909 packed_dir = find_containing_dir(packed_dir, base, 0);1910 }19111912 if (packed_dir && loose_dir) {1913 sort_ref_dir(packed_dir);1914 sort_ref_dir(loose_dir);1915 retval = do_for_each_entry_in_dirs(1916 packed_dir, loose_dir, fn, cb_data);1917 } else if (packed_dir) {1918 sort_ref_dir(packed_dir);1919 retval = do_for_each_entry_in_dir(1920 packed_dir, 0, fn, cb_data);1921 } else if (loose_dir) {1922 sort_ref_dir(loose_dir);1923 retval = do_for_each_entry_in_dir(1924 loose_dir, 0, fn, cb_data);1925 }19261927 release_packed_ref_cache(packed_ref_cache);1928 return retval;1929}19301931/*1932 * Call fn for each reference in the specified ref_cache for which the1933 * refname begins with base. If trim is non-zero, then trim that many1934 * characters off the beginning of each refname before passing the1935 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include1936 * broken references in the iteration. If fn ever returns a non-zero1937 * value, stop the iteration and return that value; otherwise, return1938 * 0.1939 */1940static int do_for_each_ref(struct ref_cache *refs, const char *base,1941 each_ref_fn fn, int trim, int flags, void *cb_data)1942{1943 struct ref_entry_cb data;1944 data.base = base;1945 data.trim = trim;1946 data.flags = flags;1947 data.fn = fn;1948 data.cb_data = cb_data;19491950 if (ref_paranoia < 0)1951 ref_paranoia = git_env_bool("GIT_REF_PARANOIA", 0);1952 if (ref_paranoia)1953 data.flags |= DO_FOR_EACH_INCLUDE_BROKEN;19541955 return do_for_each_entry(refs, base, do_one_ref, &data);1956}19571958static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)1959{1960 unsigned char sha1[20];1961 int flag;19621963 if (submodule) {1964 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)1965 return fn("HEAD", sha1, 0, cb_data);19661967 return 0;1968 }19691970 if (!read_ref_full("HEAD", RESOLVE_REF_READING, sha1, &flag))1971 return fn("HEAD", sha1, flag, cb_data);19721973 return 0;1974}19751976int head_ref(each_ref_fn fn, void *cb_data)1977{1978 return do_head_ref(NULL, fn, cb_data);1979}19801981int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)1982{1983 return do_head_ref(submodule, fn, cb_data);1984}19851986int for_each_ref(each_ref_fn fn, void *cb_data)1987{1988 return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);1989}19901991int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)1992{1993 return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);1994}19951996int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)1997{1998 return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);1999}20002001int for_each_ref_in_submodule(const char *submodule, const char *prefix,2002 each_ref_fn fn, void *cb_data)2003{2004 return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);2005}20062007int for_each_tag_ref(each_ref_fn fn, void *cb_data)2008{2009 return for_each_ref_in("refs/tags/", fn, cb_data);2010}20112012int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)2013{2014 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);2015}20162017int for_each_branch_ref(each_ref_fn fn, void *cb_data)2018{2019 return for_each_ref_in("refs/heads/", fn, cb_data);2020}20212022int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)2023{2024 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);2025}20262027int for_each_remote_ref(each_ref_fn fn, void *cb_data)2028{2029 return for_each_ref_in("refs/remotes/", fn, cb_data);2030}20312032int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)2033{2034 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);2035}20362037int for_each_replace_ref(each_ref_fn fn, void *cb_data)2038{2039 return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);2040}20412042int head_ref_namespaced(each_ref_fn fn, void *cb_data)2043{2044 struct strbuf buf = STRBUF_INIT;2045 int ret = 0;2046 unsigned char sha1[20];2047 int flag;20482049 strbuf_addf(&buf, "%sHEAD", get_git_namespace());2050 if (!read_ref_full(buf.buf, RESOLVE_REF_READING, sha1, &flag))2051 ret = fn(buf.buf, sha1, flag, cb_data);2052 strbuf_release(&buf);20532054 return ret;2055}20562057int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)2058{2059 struct strbuf buf = STRBUF_INIT;2060 int ret;2061 strbuf_addf(&buf, "%srefs/", get_git_namespace());2062 ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);2063 strbuf_release(&buf);2064 return ret;2065}20662067int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,2068 const char *prefix, void *cb_data)2069{2070 struct strbuf real_pattern = STRBUF_INIT;2071 struct ref_filter filter;2072 int ret;20732074 if (!prefix && !starts_with(pattern, "refs/"))2075 strbuf_addstr(&real_pattern, "refs/");2076 else if (prefix)2077 strbuf_addstr(&real_pattern, prefix);2078 strbuf_addstr(&real_pattern, pattern);20792080 if (!has_glob_specials(pattern)) {2081 /* Append implied '/' '*' if not present. */2082 if (real_pattern.buf[real_pattern.len - 1] != '/')2083 strbuf_addch(&real_pattern, '/');2084 /* No need to check for '*', there is none. */2085 strbuf_addch(&real_pattern, '*');2086 }20872088 filter.pattern = real_pattern.buf;2089 filter.fn = fn;2090 filter.cb_data = cb_data;2091 ret = for_each_ref(filter_refs, &filter);20922093 strbuf_release(&real_pattern);2094 return ret;2095}20962097int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)2098{2099 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);2100}21012102int for_each_rawref(each_ref_fn fn, void *cb_data)2103{2104 return do_for_each_ref(&ref_cache, "", fn, 0,2105 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);2106}21072108const char *prettify_refname(const char *name)2109{2110 return name + (2111 starts_with(name, "refs/heads/") ? 11 :2112 starts_with(name, "refs/tags/") ? 10 :2113 starts_with(name, "refs/remotes/") ? 13 :2114 0);2115}21162117static const char *ref_rev_parse_rules[] = {2118 "%.*s",2119 "refs/%.*s",2120 "refs/tags/%.*s",2121 "refs/heads/%.*s",2122 "refs/remotes/%.*s",2123 "refs/remotes/%.*s/HEAD",2124 NULL2125};21262127int refname_match(const char *abbrev_name, const char *full_name)2128{2129 const char **p;2130 const int abbrev_name_len = strlen(abbrev_name);21312132 for (p = ref_rev_parse_rules; *p; p++) {2133 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {2134 return 1;2135 }2136 }21372138 return 0;2139}21402141static void unlock_ref(struct ref_lock *lock)2142{2143 /* Do not free lock->lk -- atexit() still looks at them */2144 if (lock->lk)2145 rollback_lock_file(lock->lk);2146 free(lock->ref_name);2147 free(lock->orig_ref_name);2148 free(lock);2149}21502151/* This function should make sure errno is meaningful on error */2152static struct ref_lock *verify_lock(struct ref_lock *lock,2153 const unsigned char *old_sha1, int mustexist)2154{2155 if (read_ref_full(lock->ref_name,2156 mustexist ? RESOLVE_REF_READING : 0,2157 lock->old_sha1, NULL)) {2158 int save_errno = errno;2159 error("Can't verify ref %s", lock->ref_name);2160 unlock_ref(lock);2161 errno = save_errno;2162 return NULL;2163 }2164 if (hashcmp(lock->old_sha1, old_sha1)) {2165 error("Ref %s is at %s but expected %s", lock->ref_name,2166 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));2167 unlock_ref(lock);2168 errno = EBUSY;2169 return NULL;2170 }2171 return lock;2172}21732174static int remove_empty_directories(const char *file)2175{2176 /* we want to create a file but there is a directory there;2177 * if that is an empty directory (or a directory that contains2178 * only empty directories), remove them.2179 */2180 struct strbuf path;2181 int result, save_errno;21822183 strbuf_init(&path, 20);2184 strbuf_addstr(&path, file);21852186 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);2187 save_errno = errno;21882189 strbuf_release(&path);2190 errno = save_errno;21912192 return result;2193}21942195/*2196 * *string and *len will only be substituted, and *string returned (for2197 * later free()ing) if the string passed in is a magic short-hand form2198 * to name a branch.2199 */2200static char *substitute_branch_name(const char **string, int *len)2201{2202 struct strbuf buf = STRBUF_INIT;2203 int ret = interpret_branch_name(*string, *len, &buf);22042205 if (ret == *len) {2206 size_t size;2207 *string = strbuf_detach(&buf, &size);2208 *len = size;2209 return (char *)*string;2210 }22112212 return NULL;2213}22142215int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)2216{2217 char *last_branch = substitute_branch_name(&str, &len);2218 const char **p, *r;2219 int refs_found = 0;22202221 *ref = NULL;2222 for (p = ref_rev_parse_rules; *p; p++) {2223 char fullref[PATH_MAX];2224 unsigned char sha1_from_ref[20];2225 unsigned char *this_result;2226 int flag;22272228 this_result = refs_found ? sha1_from_ref : sha1;2229 mksnpath(fullref, sizeof(fullref), *p, len, str);2230 r = resolve_ref_unsafe(fullref, RESOLVE_REF_READING,2231 this_result, &flag);2232 if (r) {2233 if (!refs_found++)2234 *ref = xstrdup(r);2235 if (!warn_ambiguous_refs)2236 break;2237 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {2238 warning("ignoring dangling symref %s.", fullref);2239 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {2240 warning("ignoring broken ref %s.", fullref);2241 }2242 }2243 free(last_branch);2244 return refs_found;2245}22462247int dwim_log(const char *str, int len, unsigned char *sha1, char **log)2248{2249 char *last_branch = substitute_branch_name(&str, &len);2250 const char **p;2251 int logs_found = 0;22522253 *log = NULL;2254 for (p = ref_rev_parse_rules; *p; p++) {2255 unsigned char hash[20];2256 char path[PATH_MAX];2257 const char *ref, *it;22582259 mksnpath(path, sizeof(path), *p, len, str);2260 ref = resolve_ref_unsafe(path, RESOLVE_REF_READING,2261 hash, NULL);2262 if (!ref)2263 continue;2264 if (reflog_exists(path))2265 it = path;2266 else if (strcmp(ref, path) && reflog_exists(ref))2267 it = ref;2268 else2269 continue;2270 if (!logs_found++) {2271 *log = xstrdup(it);2272 hashcpy(sha1, hash);2273 }2274 if (!warn_ambiguous_refs)2275 break;2276 }2277 free(last_branch);2278 return logs_found;2279}22802281/*2282 * Locks a ref returning the lock on success and NULL on failure.2283 * On failure errno is set to something meaningful.2284 */2285static struct ref_lock *lock_ref_sha1_basic(const char *refname,2286 const unsigned char *old_sha1,2287 const struct string_list *skip,2288 unsigned int flags, int *type_p)2289{2290 char *ref_file;2291 const char *orig_refname = refname;2292 struct ref_lock *lock;2293 int last_errno = 0;2294 int type, lflags;2295 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));2296 int resolve_flags = 0;2297 int attempts_remaining = 3;22982299 lock = xcalloc(1, sizeof(struct ref_lock));2300 lock->lock_fd = -1;23012302 if (mustexist)2303 resolve_flags |= RESOLVE_REF_READING;2304 if (flags & REF_DELETING) {2305 resolve_flags |= RESOLVE_REF_ALLOW_BAD_NAME;2306 if (flags & REF_NODEREF)2307 resolve_flags |= RESOLVE_REF_NO_RECURSE;2308 }23092310 refname = resolve_ref_unsafe(refname, resolve_flags,2311 lock->old_sha1, &type);2312 if (!refname && errno == EISDIR) {2313 /* we are trying to lock foo but we used to2314 * have foo/bar which now does not exist;2315 * it is normal for the empty directory 'foo'2316 * to remain.2317 */2318 ref_file = git_path("%s", orig_refname);2319 if (remove_empty_directories(ref_file)) {2320 last_errno = errno;2321 error("there are still refs under '%s'", orig_refname);2322 goto error_return;2323 }2324 refname = resolve_ref_unsafe(orig_refname, resolve_flags,2325 lock->old_sha1, &type);2326 }2327 if (type_p)2328 *type_p = type;2329 if (!refname) {2330 last_errno = errno;2331 error("unable to resolve reference %s: %s",2332 orig_refname, strerror(errno));2333 goto error_return;2334 }2335 /*2336 * If the ref did not exist and we are creating it, make sure2337 * there is no existing packed ref whose name begins with our2338 * refname, nor a packed ref whose name is a proper prefix of2339 * our refname.2340 */2341 if (is_null_sha1(lock->old_sha1) &&2342 !is_refname_available(refname, skip, get_packed_refs(&ref_cache))) {2343 last_errno = ENOTDIR;2344 goto error_return;2345 }23462347 lock->lk = xcalloc(1, sizeof(struct lock_file));23482349 lflags = 0;2350 if (flags & REF_NODEREF) {2351 refname = orig_refname;2352 lflags |= LOCK_NO_DEREF;2353 }2354 lock->ref_name = xstrdup(refname);2355 lock->orig_ref_name = xstrdup(orig_refname);2356 ref_file = git_path("%s", refname);23572358 retry:2359 switch (safe_create_leading_directories(ref_file)) {2360 case SCLD_OK:2361 break; /* success */2362 case SCLD_VANISHED:2363 if (--attempts_remaining > 0)2364 goto retry;2365 /* fall through */2366 default:2367 last_errno = errno;2368 error("unable to create directory for %s", ref_file);2369 goto error_return;2370 }23712372 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);2373 if (lock->lock_fd < 0) {2374 last_errno = errno;2375 if (errno == ENOENT && --attempts_remaining > 0)2376 /*2377 * Maybe somebody just deleted one of the2378 * directories leading to ref_file. Try2379 * again:2380 */2381 goto retry;2382 else {2383 struct strbuf err = STRBUF_INIT;2384 unable_to_lock_message(ref_file, errno, &err);2385 error("%s", err.buf);2386 strbuf_release(&err);2387 goto error_return;2388 }2389 }2390 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;23912392 error_return:2393 unlock_ref(lock);2394 errno = last_errno;2395 return NULL;2396}23972398/*2399 * Write an entry to the packed-refs file for the specified refname.2400 * If peeled is non-NULL, write it as the entry's peeled value.2401 */2402static void write_packed_entry(FILE *fh, char *refname, unsigned char *sha1,2403 unsigned char *peeled)2404{2405 fprintf_or_die(fh, "%s %s\n", sha1_to_hex(sha1), refname);2406 if (peeled)2407 fprintf_or_die(fh, "^%s\n", sha1_to_hex(peeled));2408}24092410/*2411 * An each_ref_entry_fn that writes the entry to a packed-refs file.2412 */2413static int write_packed_entry_fn(struct ref_entry *entry, void *cb_data)2414{2415 enum peel_status peel_status = peel_entry(entry, 0);24162417 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)2418 error("internal error: %s is not a valid packed reference!",2419 entry->name);2420 write_packed_entry(cb_data, entry->name, entry->u.value.sha1,2421 peel_status == PEEL_PEELED ?2422 entry->u.value.peeled : NULL);2423 return 0;2424}24252426/* This should return a meaningful errno on failure */2427int lock_packed_refs(int flags)2428{2429 struct packed_ref_cache *packed_ref_cache;24302431 if (hold_lock_file_for_update(&packlock, git_path("packed-refs"), flags) < 0)2432 return -1;2433 /*2434 * Get the current packed-refs while holding the lock. If the2435 * packed-refs file has been modified since we last read it,2436 * this will automatically invalidate the cache and re-read2437 * the packed-refs file.2438 */2439 packed_ref_cache = get_packed_ref_cache(&ref_cache);2440 packed_ref_cache->lock = &packlock;2441 /* Increment the reference count to prevent it from being freed: */2442 acquire_packed_ref_cache(packed_ref_cache);2443 return 0;2444}24452446/*2447 * Commit the packed refs changes.2448 * On error we must make sure that errno contains a meaningful value.2449 */2450int commit_packed_refs(void)2451{2452 struct packed_ref_cache *packed_ref_cache =2453 get_packed_ref_cache(&ref_cache);2454 int error = 0;2455 int save_errno = 0;2456 FILE *out;24572458 if (!packed_ref_cache->lock)2459 die("internal error: packed-refs not locked");24602461 out = fdopen_lock_file(packed_ref_cache->lock, "w");2462 if (!out)2463 die_errno("unable to fdopen packed-refs descriptor");24642465 fprintf_or_die(out, "%s", PACKED_REFS_HEADER);2466 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),2467 0, write_packed_entry_fn, out);24682469 if (commit_lock_file(packed_ref_cache->lock)) {2470 save_errno = errno;2471 error = -1;2472 }2473 packed_ref_cache->lock = NULL;2474 release_packed_ref_cache(packed_ref_cache);2475 errno = save_errno;2476 return error;2477}24782479void rollback_packed_refs(void)2480{2481 struct packed_ref_cache *packed_ref_cache =2482 get_packed_ref_cache(&ref_cache);24832484 if (!packed_ref_cache->lock)2485 die("internal error: packed-refs not locked");2486 rollback_lock_file(packed_ref_cache->lock);2487 packed_ref_cache->lock = NULL;2488 release_packed_ref_cache(packed_ref_cache);2489 clear_packed_ref_cache(&ref_cache);2490}24912492struct ref_to_prune {2493 struct ref_to_prune *next;2494 unsigned char sha1[20];2495 char name[FLEX_ARRAY];2496};24972498struct pack_refs_cb_data {2499 unsigned int flags;2500 struct ref_dir *packed_refs;2501 struct ref_to_prune *ref_to_prune;2502};25032504/*2505 * An each_ref_entry_fn that is run over loose references only. If2506 * the loose reference can be packed, add an entry in the packed ref2507 * cache. If the reference should be pruned, also add it to2508 * ref_to_prune in the pack_refs_cb_data.2509 */2510static int pack_if_possible_fn(struct ref_entry *entry, void *cb_data)2511{2512 struct pack_refs_cb_data *cb = cb_data;2513 enum peel_status peel_status;2514 struct ref_entry *packed_entry;2515 int is_tag_ref = starts_with(entry->name, "refs/tags/");25162517 /* ALWAYS pack tags */2518 if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)2519 return 0;25202521 /* Do not pack symbolic or broken refs: */2522 if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))2523 return 0;25242525 /* Add a packed ref cache entry equivalent to the loose entry. */2526 peel_status = peel_entry(entry, 1);2527 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)2528 die("internal error peeling reference %s (%s)",2529 entry->name, sha1_to_hex(entry->u.value.sha1));2530 packed_entry = find_ref(cb->packed_refs, entry->name);2531 if (packed_entry) {2532 /* Overwrite existing packed entry with info from loose entry */2533 packed_entry->flag = REF_ISPACKED | REF_KNOWS_PEELED;2534 hashcpy(packed_entry->u.value.sha1, entry->u.value.sha1);2535 } else {2536 packed_entry = create_ref_entry(entry->name, entry->u.value.sha1,2537 REF_ISPACKED | REF_KNOWS_PEELED, 0);2538 add_ref(cb->packed_refs, packed_entry);2539 }2540 hashcpy(packed_entry->u.value.peeled, entry->u.value.peeled);25412542 /* Schedule the loose reference for pruning if requested. */2543 if ((cb->flags & PACK_REFS_PRUNE)) {2544 int namelen = strlen(entry->name) + 1;2545 struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);2546 hashcpy(n->sha1, entry->u.value.sha1);2547 strcpy(n->name, entry->name);2548 n->next = cb->ref_to_prune;2549 cb->ref_to_prune = n;2550 }2551 return 0;2552}25532554/*2555 * Remove empty parents, but spare refs/ and immediate subdirs.2556 * Note: munges *name.2557 */2558static void try_remove_empty_parents(char *name)2559{2560 char *p, *q;2561 int i;2562 p = name;2563 for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */2564 while (*p && *p != '/')2565 p++;2566 /* tolerate duplicate slashes; see check_refname_format() */2567 while (*p == '/')2568 p++;2569 }2570 for (q = p; *q; q++)2571 ;2572 while (1) {2573 while (q > p && *q != '/')2574 q--;2575 while (q > p && *(q-1) == '/')2576 q--;2577 if (q == p)2578 break;2579 *q = '\0';2580 if (rmdir(git_path("%s", name)))2581 break;2582 }2583}25842585/* make sure nobody touched the ref, and unlink */2586static void prune_ref(struct ref_to_prune *r)2587{2588 struct ref_transaction *transaction;2589 struct strbuf err = STRBUF_INIT;25902591 if (check_refname_format(r->name, 0))2592 return;25932594 transaction = ref_transaction_begin(&err);2595 if (!transaction ||2596 ref_transaction_delete(transaction, r->name, r->sha1,2597 REF_ISPRUNING, NULL, &err) ||2598 ref_transaction_commit(transaction, &err)) {2599 ref_transaction_free(transaction);2600 error("%s", err.buf);2601 strbuf_release(&err);2602 return;2603 }2604 ref_transaction_free(transaction);2605 strbuf_release(&err);2606 try_remove_empty_parents(r->name);2607}26082609static void prune_refs(struct ref_to_prune *r)2610{2611 while (r) {2612 prune_ref(r);2613 r = r->next;2614 }2615}26162617int pack_refs(unsigned int flags)2618{2619 struct pack_refs_cb_data cbdata;26202621 memset(&cbdata, 0, sizeof(cbdata));2622 cbdata.flags = flags;26232624 lock_packed_refs(LOCK_DIE_ON_ERROR);2625 cbdata.packed_refs = get_packed_refs(&ref_cache);26262627 do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,2628 pack_if_possible_fn, &cbdata);26292630 if (commit_packed_refs())2631 die_errno("unable to overwrite old ref-pack file");26322633 prune_refs(cbdata.ref_to_prune);2634 return 0;2635}26362637int repack_without_refs(struct string_list *refnames, struct strbuf *err)2638{2639 struct ref_dir *packed;2640 struct string_list_item *refname;2641 int ret, needs_repacking = 0, removed = 0;26422643 assert(err);26442645 /* Look for a packed ref */2646 for_each_string_list_item(refname, refnames) {2647 if (get_packed_ref(refname->string)) {2648 needs_repacking = 1;2649 break;2650 }2651 }26522653 /* Avoid locking if we have nothing to do */2654 if (!needs_repacking)2655 return 0; /* no refname exists in packed refs */26562657 if (lock_packed_refs(0)) {2658 unable_to_lock_message(git_path("packed-refs"), errno, err);2659 return -1;2660 }2661 packed = get_packed_refs(&ref_cache);26622663 /* Remove refnames from the cache */2664 for_each_string_list_item(refname, refnames)2665 if (remove_entry(packed, refname->string) != -1)2666 removed = 1;2667 if (!removed) {2668 /*2669 * All packed entries disappeared while we were2670 * acquiring the lock.2671 */2672 rollback_packed_refs();2673 return 0;2674 }26752676 /* Write what remains */2677 ret = commit_packed_refs();2678 if (ret)2679 strbuf_addf(err, "unable to overwrite old ref-pack file: %s",2680 strerror(errno));2681 return ret;2682}26832684static int delete_ref_loose(struct ref_lock *lock, int flag, struct strbuf *err)2685{2686 assert(err);26872688 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {2689 /*2690 * loose. The loose file name is the same as the2691 * lockfile name, minus ".lock":2692 */2693 char *loose_filename = get_locked_file_path(lock->lk);2694 int res = unlink_or_msg(loose_filename, err);2695 free(loose_filename);2696 if (res)2697 return 1;2698 }2699 return 0;2700}27012702int delete_ref(const char *refname, const unsigned char *sha1, unsigned int flags)2703{2704 struct ref_transaction *transaction;2705 struct strbuf err = STRBUF_INIT;27062707 transaction = ref_transaction_begin(&err);2708 if (!transaction ||2709 ref_transaction_delete(transaction, refname,2710 (sha1 && !is_null_sha1(sha1)) ? sha1 : NULL,2711 flags, NULL, &err) ||2712 ref_transaction_commit(transaction, &err)) {2713 error("%s", err.buf);2714 ref_transaction_free(transaction);2715 strbuf_release(&err);2716 return 1;2717 }2718 ref_transaction_free(transaction);2719 strbuf_release(&err);2720 return 0;2721}27222723/*2724 * People using contrib's git-new-workdir have .git/logs/refs ->2725 * /some/other/path/.git/logs/refs, and that may live on another device.2726 *2727 * IOW, to avoid cross device rename errors, the temporary renamed log must2728 * live into logs/refs.2729 */2730#define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"27312732static int rename_tmp_log(const char *newrefname)2733{2734 int attempts_remaining = 4;27352736 retry:2737 switch (safe_create_leading_directories(git_path("logs/%s", newrefname))) {2738 case SCLD_OK:2739 break; /* success */2740 case SCLD_VANISHED:2741 if (--attempts_remaining > 0)2742 goto retry;2743 /* fall through */2744 default:2745 error("unable to create directory for %s", newrefname);2746 return -1;2747 }27482749 if (rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {2750 if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {2751 /*2752 * rename(a, b) when b is an existing2753 * directory ought to result in ISDIR, but2754 * Solaris 5.8 gives ENOTDIR. Sheesh.2755 */2756 if (remove_empty_directories(git_path("logs/%s", newrefname))) {2757 error("Directory not empty: logs/%s", newrefname);2758 return -1;2759 }2760 goto retry;2761 } else if (errno == ENOENT && --attempts_remaining > 0) {2762 /*2763 * Maybe another process just deleted one of2764 * the directories in the path to newrefname.2765 * Try again from the beginning.2766 */2767 goto retry;2768 } else {2769 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",2770 newrefname, strerror(errno));2771 return -1;2772 }2773 }2774 return 0;2775}27762777static int rename_ref_available(const char *oldname, const char *newname)2778{2779 struct string_list skip = STRING_LIST_INIT_NODUP;2780 int ret;27812782 string_list_insert(&skip, oldname);2783 ret = is_refname_available(newname, &skip, get_packed_refs(&ref_cache))2784 && is_refname_available(newname, &skip, get_loose_refs(&ref_cache));2785 string_list_clear(&skip, 0);2786 return ret;2787}27882789static int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1,2790 const char *logmsg);27912792int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)2793{2794 unsigned char sha1[20], orig_sha1[20];2795 int flag = 0, logmoved = 0;2796 struct ref_lock *lock;2797 struct stat loginfo;2798 int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);2799 const char *symref = NULL;28002801 if (log && S_ISLNK(loginfo.st_mode))2802 return error("reflog for %s is a symlink", oldrefname);28032804 symref = resolve_ref_unsafe(oldrefname, RESOLVE_REF_READING,2805 orig_sha1, &flag);2806 if (flag & REF_ISSYMREF)2807 return error("refname %s is a symbolic ref, renaming it is not supported",2808 oldrefname);2809 if (!symref)2810 return error("refname %s not found", oldrefname);28112812 if (!rename_ref_available(oldrefname, newrefname))2813 return 1;28142815 if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))2816 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",2817 oldrefname, strerror(errno));28182819 if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {2820 error("unable to delete old %s", oldrefname);2821 goto rollback;2822 }28232824 if (!read_ref_full(newrefname, RESOLVE_REF_READING, sha1, NULL) &&2825 delete_ref(newrefname, sha1, REF_NODEREF)) {2826 if (errno==EISDIR) {2827 if (remove_empty_directories(git_path("%s", newrefname))) {2828 error("Directory not empty: %s", newrefname);2829 goto rollback;2830 }2831 } else {2832 error("unable to delete existing %s", newrefname);2833 goto rollback;2834 }2835 }28362837 if (log && rename_tmp_log(newrefname))2838 goto rollback;28392840 logmoved = log;28412842 lock = lock_ref_sha1_basic(newrefname, NULL, NULL, 0, NULL);2843 if (!lock) {2844 error("unable to lock %s for update", newrefname);2845 goto rollback;2846 }2847 hashcpy(lock->old_sha1, orig_sha1);2848 if (write_ref_sha1(lock, orig_sha1, logmsg)) {2849 error("unable to write current sha1 into %s", newrefname);2850 goto rollback;2851 }28522853 return 0;28542855 rollback:2856 lock = lock_ref_sha1_basic(oldrefname, NULL, NULL, 0, NULL);2857 if (!lock) {2858 error("unable to lock %s for rollback", oldrefname);2859 goto rollbacklog;2860 }28612862 flag = log_all_ref_updates;2863 log_all_ref_updates = 0;2864 if (write_ref_sha1(lock, orig_sha1, NULL))2865 error("unable to write current sha1 into %s", oldrefname);2866 log_all_ref_updates = flag;28672868 rollbacklog:2869 if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))2870 error("unable to restore logfile %s from %s: %s",2871 oldrefname, newrefname, strerror(errno));2872 if (!logmoved && log &&2873 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))2874 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",2875 oldrefname, strerror(errno));28762877 return 1;2878}28792880static int close_ref(struct ref_lock *lock)2881{2882 if (close_lock_file(lock->lk))2883 return -1;2884 lock->lock_fd = -1;2885 return 0;2886}28872888static int commit_ref(struct ref_lock *lock)2889{2890 if (commit_lock_file(lock->lk))2891 return -1;2892 lock->lock_fd = -1;2893 return 0;2894}28952896/*2897 * copy the reflog message msg to buf, which has been allocated sufficiently2898 * large, while cleaning up the whitespaces. Especially, convert LF to space,2899 * because reflog file is one line per entry.2900 */2901static int copy_msg(char *buf, const char *msg)2902{2903 char *cp = buf;2904 char c;2905 int wasspace = 1;29062907 *cp++ = '\t';2908 while ((c = *msg++)) {2909 if (wasspace && isspace(c))2910 continue;2911 wasspace = isspace(c);2912 if (wasspace)2913 c = ' ';2914 *cp++ = c;2915 }2916 while (buf < cp && isspace(cp[-1]))2917 cp--;2918 *cp++ = '\n';2919 return cp - buf;2920}29212922/* This function must set a meaningful errno on failure */2923int log_ref_setup(const char *refname, char *logfile, int bufsize)2924{2925 int logfd, oflags = O_APPEND | O_WRONLY;29262927 git_snpath(logfile, bufsize, "logs/%s", refname);2928 if (log_all_ref_updates &&2929 (starts_with(refname, "refs/heads/") ||2930 starts_with(refname, "refs/remotes/") ||2931 starts_with(refname, "refs/notes/") ||2932 !strcmp(refname, "HEAD"))) {2933 if (safe_create_leading_directories(logfile) < 0) {2934 int save_errno = errno;2935 error("unable to create directory for %s", logfile);2936 errno = save_errno;2937 return -1;2938 }2939 oflags |= O_CREAT;2940 }29412942 logfd = open(logfile, oflags, 0666);2943 if (logfd < 0) {2944 if (!(oflags & O_CREAT) && (errno == ENOENT || errno == EISDIR))2945 return 0;29462947 if (errno == EISDIR) {2948 if (remove_empty_directories(logfile)) {2949 int save_errno = errno;2950 error("There are still logs under '%s'",2951 logfile);2952 errno = save_errno;2953 return -1;2954 }2955 logfd = open(logfile, oflags, 0666);2956 }29572958 if (logfd < 0) {2959 int save_errno = errno;2960 error("Unable to append to %s: %s", logfile,2961 strerror(errno));2962 errno = save_errno;2963 return -1;2964 }2965 }29662967 adjust_shared_perm(logfile);2968 close(logfd);2969 return 0;2970}29712972static int log_ref_write_fd(int fd, const unsigned char *old_sha1,2973 const unsigned char *new_sha1,2974 const char *committer, const char *msg)2975{2976 int msglen, written;2977 unsigned maxlen, len;2978 char *logrec;29792980 msglen = msg ? strlen(msg) : 0;2981 maxlen = strlen(committer) + msglen + 100;2982 logrec = xmalloc(maxlen);2983 len = sprintf(logrec, "%s %s %s\n",2984 sha1_to_hex(old_sha1),2985 sha1_to_hex(new_sha1),2986 committer);2987 if (msglen)2988 len += copy_msg(logrec + len - 1, msg) - 1;29892990 written = len <= maxlen ? write_in_full(fd, logrec, len) : -1;2991 free(logrec);2992 if (written != len)2993 return -1;29942995 return 0;2996}29972998static int log_ref_write(const char *refname, const unsigned char *old_sha1,2999 const unsigned char *new_sha1, const char *msg)3000{3001 int logfd, result, oflags = O_APPEND | O_WRONLY;3002 char log_file[PATH_MAX];30033004 if (log_all_ref_updates < 0)3005 log_all_ref_updates = !is_bare_repository();30063007 result = log_ref_setup(refname, log_file, sizeof(log_file));3008 if (result)3009 return result;30103011 logfd = open(log_file, oflags);3012 if (logfd < 0)3013 return 0;3014 result = log_ref_write_fd(logfd, old_sha1, new_sha1,3015 git_committer_info(0), msg);3016 if (result) {3017 int save_errno = errno;3018 close(logfd);3019 error("Unable to append to %s", log_file);3020 errno = save_errno;3021 return -1;3022 }3023 if (close(logfd)) {3024 int save_errno = errno;3025 error("Unable to append to %s", log_file);3026 errno = save_errno;3027 return -1;3028 }3029 return 0;3030}30313032int is_branch(const char *refname)3033{3034 return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");3035}30363037/*3038 * Write sha1 into the ref specified by the lock. Make sure that errno3039 * is sane on error.3040 */3041static int write_ref_sha1(struct ref_lock *lock,3042 const unsigned char *sha1, const char *logmsg)3043{3044 static char term = '\n';3045 struct object *o;30463047 o = parse_object(sha1);3048 if (!o) {3049 error("Trying to write ref %s with nonexistent object %s",3050 lock->ref_name, sha1_to_hex(sha1));3051 unlock_ref(lock);3052 errno = EINVAL;3053 return -1;3054 }3055 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {3056 error("Trying to write non-commit object %s to branch %s",3057 sha1_to_hex(sha1), lock->ref_name);3058 unlock_ref(lock);3059 errno = EINVAL;3060 return -1;3061 }3062 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||3063 write_in_full(lock->lock_fd, &term, 1) != 1 ||3064 close_ref(lock) < 0) {3065 int save_errno = errno;3066 error("Couldn't write %s", lock->lk->filename.buf);3067 unlock_ref(lock);3068 errno = save_errno;3069 return -1;3070 }3071 clear_loose_ref_cache(&ref_cache);3072 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||3073 (strcmp(lock->ref_name, lock->orig_ref_name) &&3074 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {3075 unlock_ref(lock);3076 return -1;3077 }3078 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {3079 /*3080 * Special hack: If a branch is updated directly and HEAD3081 * points to it (may happen on the remote side of a push3082 * for example) then logically the HEAD reflog should be3083 * updated too.3084 * A generic solution implies reverse symref information,3085 * but finding all symrefs pointing to the given branch3086 * would be rather costly for this rare event (the direct3087 * update of a branch) to be worth it. So let's cheat and3088 * check with HEAD only which should cover 99% of all usage3089 * scenarios (even 100% of the default ones).3090 */3091 unsigned char head_sha1[20];3092 int head_flag;3093 const char *head_ref;3094 head_ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,3095 head_sha1, &head_flag);3096 if (head_ref && (head_flag & REF_ISSYMREF) &&3097 !strcmp(head_ref, lock->ref_name))3098 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);3099 }3100 if (commit_ref(lock)) {3101 error("Couldn't set %s", lock->ref_name);3102 unlock_ref(lock);3103 return -1;3104 }3105 unlock_ref(lock);3106 return 0;3107}31083109int create_symref(const char *ref_target, const char *refs_heads_master,3110 const char *logmsg)3111{3112 const char *lockpath;3113 char ref[1000];3114 int fd, len, written;3115 char *git_HEAD = git_pathdup("%s", ref_target);3116 unsigned char old_sha1[20], new_sha1[20];31173118 if (logmsg && read_ref(ref_target, old_sha1))3119 hashclr(old_sha1);31203121 if (safe_create_leading_directories(git_HEAD) < 0)3122 return error("unable to create directory for %s", git_HEAD);31233124#ifndef NO_SYMLINK_HEAD3125 if (prefer_symlink_refs) {3126 unlink(git_HEAD);3127 if (!symlink(refs_heads_master, git_HEAD))3128 goto done;3129 fprintf(stderr, "no symlink - falling back to symbolic ref\n");3130 }3131#endif31323133 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);3134 if (sizeof(ref) <= len) {3135 error("refname too long: %s", refs_heads_master);3136 goto error_free_return;3137 }3138 lockpath = mkpath("%s.lock", git_HEAD);3139 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);3140 if (fd < 0) {3141 error("Unable to open %s for writing", lockpath);3142 goto error_free_return;3143 }3144 written = write_in_full(fd, ref, len);3145 if (close(fd) != 0 || written != len) {3146 error("Unable to write to %s", lockpath);3147 goto error_unlink_return;3148 }3149 if (rename(lockpath, git_HEAD) < 0) {3150 error("Unable to create %s", git_HEAD);3151 goto error_unlink_return;3152 }3153 if (adjust_shared_perm(git_HEAD)) {3154 error("Unable to fix permissions on %s", lockpath);3155 error_unlink_return:3156 unlink_or_warn(lockpath);3157 error_free_return:3158 free(git_HEAD);3159 return -1;3160 }31613162#ifndef NO_SYMLINK_HEAD3163 done:3164#endif3165 if (logmsg && !read_ref(refs_heads_master, new_sha1))3166 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);31673168 free(git_HEAD);3169 return 0;3170}31713172struct read_ref_at_cb {3173 const char *refname;3174 unsigned long at_time;3175 int cnt;3176 int reccnt;3177 unsigned char *sha1;3178 int found_it;31793180 unsigned char osha1[20];3181 unsigned char nsha1[20];3182 int tz;3183 unsigned long date;3184 char **msg;3185 unsigned long *cutoff_time;3186 int *cutoff_tz;3187 int *cutoff_cnt;3188};31893190static int read_ref_at_ent(unsigned char *osha1, unsigned char *nsha1,3191 const char *email, unsigned long timestamp, int tz,3192 const char *message, void *cb_data)3193{3194 struct read_ref_at_cb *cb = cb_data;31953196 cb->reccnt++;3197 cb->tz = tz;3198 cb->date = timestamp;31993200 if (timestamp <= cb->at_time || cb->cnt == 0) {3201 if (cb->msg)3202 *cb->msg = xstrdup(message);3203 if (cb->cutoff_time)3204 *cb->cutoff_time = timestamp;3205 if (cb->cutoff_tz)3206 *cb->cutoff_tz = tz;3207 if (cb->cutoff_cnt)3208 *cb->cutoff_cnt = cb->reccnt - 1;3209 /*3210 * we have not yet updated cb->[n|o]sha1 so they still3211 * hold the values for the previous record.3212 */3213 if (!is_null_sha1(cb->osha1)) {3214 hashcpy(cb->sha1, nsha1);3215 if (hashcmp(cb->osha1, nsha1))3216 warning("Log for ref %s has gap after %s.",3217 cb->refname, show_date(cb->date, cb->tz, DATE_RFC2822));3218 }3219 else if (cb->date == cb->at_time)3220 hashcpy(cb->sha1, nsha1);3221 else if (hashcmp(nsha1, cb->sha1))3222 warning("Log for ref %s unexpectedly ended on %s.",3223 cb->refname, show_date(cb->date, cb->tz,3224 DATE_RFC2822));3225 hashcpy(cb->osha1, osha1);3226 hashcpy(cb->nsha1, nsha1);3227 cb->found_it = 1;3228 return 1;3229 }3230 hashcpy(cb->osha1, osha1);3231 hashcpy(cb->nsha1, nsha1);3232 if (cb->cnt > 0)3233 cb->cnt--;3234 return 0;3235}32363237static int read_ref_at_ent_oldest(unsigned char *osha1, unsigned char *nsha1,3238 const char *email, unsigned long timestamp,3239 int tz, const char *message, void *cb_data)3240{3241 struct read_ref_at_cb *cb = cb_data;32423243 if (cb->msg)3244 *cb->msg = xstrdup(message);3245 if (cb->cutoff_time)3246 *cb->cutoff_time = timestamp;3247 if (cb->cutoff_tz)3248 *cb->cutoff_tz = tz;3249 if (cb->cutoff_cnt)3250 *cb->cutoff_cnt = cb->reccnt;3251 hashcpy(cb->sha1, osha1);3252 if (is_null_sha1(cb->sha1))3253 hashcpy(cb->sha1, nsha1);3254 /* We just want the first entry */3255 return 1;3256}32573258int read_ref_at(const char *refname, unsigned int flags, unsigned long at_time, int cnt,3259 unsigned char *sha1, char **msg,3260 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)3261{3262 struct read_ref_at_cb cb;32633264 memset(&cb, 0, sizeof(cb));3265 cb.refname = refname;3266 cb.at_time = at_time;3267 cb.cnt = cnt;3268 cb.msg = msg;3269 cb.cutoff_time = cutoff_time;3270 cb.cutoff_tz = cutoff_tz;3271 cb.cutoff_cnt = cutoff_cnt;3272 cb.sha1 = sha1;32733274 for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);32753276 if (!cb.reccnt) {3277 if (flags & GET_SHA1_QUIETLY)3278 exit(128);3279 else3280 die("Log for %s is empty.", refname);3281 }3282 if (cb.found_it)3283 return 0;32843285 for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);32863287 return 1;3288}32893290int reflog_exists(const char *refname)3291{3292 struct stat st;32933294 return !lstat(git_path("logs/%s", refname), &st) &&3295 S_ISREG(st.st_mode);3296}32973298int delete_reflog(const char *refname)3299{3300 return remove_path(git_path("logs/%s", refname));3301}33023303static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)3304{3305 unsigned char osha1[20], nsha1[20];3306 char *email_end, *message;3307 unsigned long timestamp;3308 int tz;33093310 /* old SP new SP name <email> SP time TAB msg LF */3311 if (sb->len < 83 || sb->buf[sb->len - 1] != '\n' ||3312 get_sha1_hex(sb->buf, osha1) || sb->buf[40] != ' ' ||3313 get_sha1_hex(sb->buf + 41, nsha1) || sb->buf[81] != ' ' ||3314 !(email_end = strchr(sb->buf + 82, '>')) ||3315 email_end[1] != ' ' ||3316 !(timestamp = strtoul(email_end + 2, &message, 10)) ||3317 !message || message[0] != ' ' ||3318 (message[1] != '+' && message[1] != '-') ||3319 !isdigit(message[2]) || !isdigit(message[3]) ||3320 !isdigit(message[4]) || !isdigit(message[5]))3321 return 0; /* corrupt? */3322 email_end[1] = '\0';3323 tz = strtol(message + 1, NULL, 10);3324 if (message[6] != '\t')3325 message += 6;3326 else3327 message += 7;3328 return fn(osha1, nsha1, sb->buf + 82, timestamp, tz, message, cb_data);3329}33303331static char *find_beginning_of_line(char *bob, char *scan)3332{3333 while (bob < scan && *(--scan) != '\n')3334 ; /* keep scanning backwards */3335 /*3336 * Return either beginning of the buffer, or LF at the end of3337 * the previous line.3338 */3339 return scan;3340}33413342int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data)3343{3344 struct strbuf sb = STRBUF_INIT;3345 FILE *logfp;3346 long pos;3347 int ret = 0, at_tail = 1;33483349 logfp = fopen(git_path("logs/%s", refname), "r");3350 if (!logfp)3351 return -1;33523353 /* Jump to the end */3354 if (fseek(logfp, 0, SEEK_END) < 0)3355 return error("cannot seek back reflog for %s: %s",3356 refname, strerror(errno));3357 pos = ftell(logfp);3358 while (!ret && 0 < pos) {3359 int cnt;3360 size_t nread;3361 char buf[BUFSIZ];3362 char *endp, *scanp;33633364 /* Fill next block from the end */3365 cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;3366 if (fseek(logfp, pos - cnt, SEEK_SET))3367 return error("cannot seek back reflog for %s: %s",3368 refname, strerror(errno));3369 nread = fread(buf, cnt, 1, logfp);3370 if (nread != 1)3371 return error("cannot read %d bytes from reflog for %s: %s",3372 cnt, refname, strerror(errno));3373 pos -= cnt;33743375 scanp = endp = buf + cnt;3376 if (at_tail && scanp[-1] == '\n')3377 /* Looking at the final LF at the end of the file */3378 scanp--;3379 at_tail = 0;33803381 while (buf < scanp) {3382 /*3383 * terminating LF of the previous line, or the beginning3384 * of the buffer.3385 */3386 char *bp;33873388 bp = find_beginning_of_line(buf, scanp);33893390 if (*bp == '\n') {3391 /*3392 * The newline is the end of the previous line,3393 * so we know we have complete line starting3394 * at (bp + 1). Prefix it onto any prior data3395 * we collected for the line and process it.3396 */3397 strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));3398 scanp = bp;3399 endp = bp + 1;3400 ret = show_one_reflog_ent(&sb, fn, cb_data);3401 strbuf_reset(&sb);3402 if (ret)3403 break;3404 } else if (!pos) {3405 /*3406 * We are at the start of the buffer, and the3407 * start of the file; there is no previous3408 * line, and we have everything for this one.3409 * Process it, and we can end the loop.3410 */3411 strbuf_splice(&sb, 0, 0, buf, endp - buf);3412 ret = show_one_reflog_ent(&sb, fn, cb_data);3413 strbuf_reset(&sb);3414 break;3415 }34163417 if (bp == buf) {3418 /*3419 * We are at the start of the buffer, and there3420 * is more file to read backwards. Which means3421 * we are in the middle of a line. Note that we3422 * may get here even if *bp was a newline; that3423 * just means we are at the exact end of the3424 * previous line, rather than some spot in the3425 * middle.3426 *3427 * Save away what we have to be combined with3428 * the data from the next read.3429 */3430 strbuf_splice(&sb, 0, 0, buf, endp - buf);3431 break;3432 }3433 }34343435 }3436 if (!ret && sb.len)3437 die("BUG: reverse reflog parser had leftover data");34383439 fclose(logfp);3440 strbuf_release(&sb);3441 return ret;3442}34433444int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)3445{3446 FILE *logfp;3447 struct strbuf sb = STRBUF_INIT;3448 int ret = 0;34493450 logfp = fopen(git_path("logs/%s", refname), "r");3451 if (!logfp)3452 return -1;34533454 while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))3455 ret = show_one_reflog_ent(&sb, fn, cb_data);3456 fclose(logfp);3457 strbuf_release(&sb);3458 return ret;3459}3460/*3461 * Call fn for each reflog in the namespace indicated by name. name3462 * must be empty or end with '/'. Name will be used as a scratch3463 * space, but its contents will be restored before return.3464 */3465static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)3466{3467 DIR *d = opendir(git_path("logs/%s", name->buf));3468 int retval = 0;3469 struct dirent *de;3470 int oldlen = name->len;34713472 if (!d)3473 return name->len ? errno : 0;34743475 while ((de = readdir(d)) != NULL) {3476 struct stat st;34773478 if (de->d_name[0] == '.')3479 continue;3480 if (ends_with(de->d_name, ".lock"))3481 continue;3482 strbuf_addstr(name, de->d_name);3483 if (stat(git_path("logs/%s", name->buf), &st) < 0) {3484 ; /* silently ignore */3485 } else {3486 if (S_ISDIR(st.st_mode)) {3487 strbuf_addch(name, '/');3488 retval = do_for_each_reflog(name, fn, cb_data);3489 } else {3490 unsigned char sha1[20];3491 if (read_ref_full(name->buf, 0, sha1, NULL))3492 retval = error("bad ref for %s", name->buf);3493 else3494 retval = fn(name->buf, sha1, 0, cb_data);3495 }3496 if (retval)3497 break;3498 }3499 strbuf_setlen(name, oldlen);3500 }3501 closedir(d);3502 return retval;3503}35043505int for_each_reflog(each_ref_fn fn, void *cb_data)3506{3507 int retval;3508 struct strbuf name;3509 strbuf_init(&name, PATH_MAX);3510 retval = do_for_each_reflog(&name, fn, cb_data);3511 strbuf_release(&name);3512 return retval;3513}35143515/**3516 * Information needed for a single ref update. Set new_sha1 to the new3517 * value or to null_sha1 to delete the ref. To check the old value3518 * while the ref is locked, set (flags & REF_HAVE_OLD) and set3519 * old_sha1 to the old value, or to null_sha1 to ensure the ref does3520 * not exist before update.3521 */3522struct ref_update {3523 /*3524 * If (flags & REF_HAVE_NEW), set the reference to this value:3525 */3526 unsigned char new_sha1[20];3527 /*3528 * If (flags & REF_HAVE_OLD), check that the reference3529 * previously had this value:3530 */3531 unsigned char old_sha1[20];3532 /*3533 * One or more of REF_HAVE_NEW, REF_HAVE_OLD, REF_NODEREF,3534 * REF_DELETING, and REF_ISPRUNING:3535 */3536 unsigned int flags;3537 struct ref_lock *lock;3538 int type;3539 char *msg;3540 const char refname[FLEX_ARRAY];3541};35423543/*3544 * Transaction states.3545 * OPEN: The transaction is in a valid state and can accept new updates.3546 * An OPEN transaction can be committed.3547 * CLOSED: A closed transaction is no longer active and no other operations3548 * than free can be used on it in this state.3549 * A transaction can either become closed by successfully committing3550 * an active transaction or if there is a failure while building3551 * the transaction thus rendering it failed/inactive.3552 */3553enum ref_transaction_state {3554 REF_TRANSACTION_OPEN = 0,3555 REF_TRANSACTION_CLOSED = 13556};35573558/*3559 * Data structure for holding a reference transaction, which can3560 * consist of checks and updates to multiple references, carried out3561 * as atomically as possible. This structure is opaque to callers.3562 */3563struct ref_transaction {3564 struct ref_update **updates;3565 size_t alloc;3566 size_t nr;3567 enum ref_transaction_state state;3568};35693570struct ref_transaction *ref_transaction_begin(struct strbuf *err)3571{3572 assert(err);35733574 return xcalloc(1, sizeof(struct ref_transaction));3575}35763577void ref_transaction_free(struct ref_transaction *transaction)3578{3579 int i;35803581 if (!transaction)3582 return;35833584 for (i = 0; i < transaction->nr; i++) {3585 free(transaction->updates[i]->msg);3586 free(transaction->updates[i]);3587 }3588 free(transaction->updates);3589 free(transaction);3590}35913592static struct ref_update *add_update(struct ref_transaction *transaction,3593 const char *refname)3594{3595 size_t len = strlen(refname);3596 struct ref_update *update = xcalloc(1, sizeof(*update) + len + 1);35973598 strcpy((char *)update->refname, refname);3599 ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);3600 transaction->updates[transaction->nr++] = update;3601 return update;3602}36033604int ref_transaction_update(struct ref_transaction *transaction,3605 const char *refname,3606 const unsigned char *new_sha1,3607 const unsigned char *old_sha1,3608 unsigned int flags, const char *msg,3609 struct strbuf *err)3610{3611 struct ref_update *update;36123613 assert(err);36143615 if (transaction->state != REF_TRANSACTION_OPEN)3616 die("BUG: update called for transaction that is not open");36173618 if (new_sha1 && !is_null_sha1(new_sha1) &&3619 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {3620 strbuf_addf(err, "refusing to update ref with bad name %s",3621 refname);3622 return -1;3623 }36243625 update = add_update(transaction, refname);3626 if (new_sha1) {3627 hashcpy(update->new_sha1, new_sha1);3628 flags |= REF_HAVE_NEW;3629 }3630 if (old_sha1) {3631 hashcpy(update->old_sha1, old_sha1);3632 flags |= REF_HAVE_OLD;3633 }3634 update->flags = flags;3635 if (msg)3636 update->msg = xstrdup(msg);3637 return 0;3638}36393640int ref_transaction_create(struct ref_transaction *transaction,3641 const char *refname,3642 const unsigned char *new_sha1,3643 unsigned int flags, const char *msg,3644 struct strbuf *err)3645{3646 if (!new_sha1 || is_null_sha1(new_sha1))3647 die("BUG: create called without valid new_sha1");3648 return ref_transaction_update(transaction, refname, new_sha1,3649 null_sha1, flags, msg, err);3650}36513652int ref_transaction_delete(struct ref_transaction *transaction,3653 const char *refname,3654 const unsigned char *old_sha1,3655 unsigned int flags, const char *msg,3656 struct strbuf *err)3657{3658 if (old_sha1 && is_null_sha1(old_sha1))3659 die("BUG: delete called with old_sha1 set to zeros");3660 return ref_transaction_update(transaction, refname,3661 null_sha1, old_sha1,3662 flags, msg, err);3663}36643665int ref_transaction_verify(struct ref_transaction *transaction,3666 const char *refname,3667 const unsigned char *old_sha1,3668 unsigned int flags,3669 struct strbuf *err)3670{3671 if (!old_sha1)3672 die("BUG: verify called with old_sha1 set to NULL");3673 return ref_transaction_update(transaction, refname,3674 NULL, old_sha1,3675 flags, NULL, err);3676}36773678int update_ref(const char *msg, const char *refname,3679 const unsigned char *new_sha1, const unsigned char *old_sha1,3680 unsigned int flags, enum action_on_err onerr)3681{3682 struct ref_transaction *t;3683 struct strbuf err = STRBUF_INIT;36843685 t = ref_transaction_begin(&err);3686 if (!t ||3687 ref_transaction_update(t, refname, new_sha1, old_sha1,3688 flags, msg, &err) ||3689 ref_transaction_commit(t, &err)) {3690 const char *str = "update_ref failed for ref '%s': %s";36913692 ref_transaction_free(t);3693 switch (onerr) {3694 case UPDATE_REFS_MSG_ON_ERR:3695 error(str, refname, err.buf);3696 break;3697 case UPDATE_REFS_DIE_ON_ERR:3698 die(str, refname, err.buf);3699 break;3700 case UPDATE_REFS_QUIET_ON_ERR:3701 break;3702 }3703 strbuf_release(&err);3704 return 1;3705 }3706 strbuf_release(&err);3707 ref_transaction_free(t);3708 return 0;3709}37103711static int ref_update_compare(const void *r1, const void *r2)3712{3713 const struct ref_update * const *u1 = r1;3714 const struct ref_update * const *u2 = r2;3715 return strcmp((*u1)->refname, (*u2)->refname);3716}37173718static int ref_update_reject_duplicates(struct ref_update **updates, int n,3719 struct strbuf *err)3720{3721 int i;37223723 assert(err);37243725 for (i = 1; i < n; i++)3726 if (!strcmp(updates[i - 1]->refname, updates[i]->refname)) {3727 strbuf_addf(err,3728 "Multiple updates for ref '%s' not allowed.",3729 updates[i]->refname);3730 return 1;3731 }3732 return 0;3733}37343735int ref_transaction_commit(struct ref_transaction *transaction,3736 struct strbuf *err)3737{3738 int ret = 0, i;3739 int n = transaction->nr;3740 struct ref_update **updates = transaction->updates;3741 struct string_list refs_to_delete = STRING_LIST_INIT_NODUP;3742 struct string_list_item *ref_to_delete;37433744 assert(err);37453746 if (transaction->state != REF_TRANSACTION_OPEN)3747 die("BUG: commit called for transaction that is not open");37483749 if (!n) {3750 transaction->state = REF_TRANSACTION_CLOSED;3751 return 0;3752 }37533754 /* Copy, sort, and reject duplicate refs */3755 qsort(updates, n, sizeof(*updates), ref_update_compare);3756 if (ref_update_reject_duplicates(updates, n, err)) {3757 ret = TRANSACTION_GENERIC_ERROR;3758 goto cleanup;3759 }37603761 /* Acquire all locks while verifying old values */3762 for (i = 0; i < n; i++) {3763 struct ref_update *update = updates[i];3764 unsigned int flags = update->flags;37653766 if ((flags & REF_HAVE_NEW) && is_null_sha1(update->new_sha1))3767 flags |= REF_DELETING;3768 update->lock = lock_ref_sha1_basic(3769 update->refname,3770 ((update->flags & REF_HAVE_OLD) ?3771 update->old_sha1 : NULL),3772 NULL,3773 flags,3774 &update->type);3775 if (!update->lock) {3776 ret = (errno == ENOTDIR)3777 ? TRANSACTION_NAME_CONFLICT3778 : TRANSACTION_GENERIC_ERROR;3779 strbuf_addf(err, "Cannot lock the ref '%s'.",3780 update->refname);3781 goto cleanup;3782 }3783 }37843785 /* Perform updates first so live commits remain referenced */3786 for (i = 0; i < n; i++) {3787 struct ref_update *update = updates[i];3788 int flags = update->flags;37893790 if ((flags & REF_HAVE_NEW) && !is_null_sha1(update->new_sha1)) {3791 int overwriting_symref = ((update->type & REF_ISSYMREF) &&3792 (update->flags & REF_NODEREF));37933794 if (!overwriting_symref3795 && !hashcmp(update->lock->old_sha1, update->new_sha1)) {3796 /*3797 * The reference already has the desired3798 * value, so we don't need to write it.3799 */3800 unlock_ref(update->lock);3801 update->lock = NULL;3802 } else if (write_ref_sha1(update->lock, update->new_sha1,3803 update->msg)) {3804 update->lock = NULL; /* freed by write_ref_sha1 */3805 strbuf_addf(err, "Cannot update the ref '%s'.",3806 update->refname);3807 ret = TRANSACTION_GENERIC_ERROR;3808 goto cleanup;3809 } else {3810 /* freed by write_ref_sha1(): */3811 update->lock = NULL;3812 }3813 }3814 }38153816 /* Perform deletes now that updates are safely completed */3817 for (i = 0; i < n; i++) {3818 struct ref_update *update = updates[i];3819 int flags = update->flags;38203821 if ((flags & REF_HAVE_NEW) && is_null_sha1(update->new_sha1)) {3822 if (delete_ref_loose(update->lock, update->type, err)) {3823 ret = TRANSACTION_GENERIC_ERROR;3824 goto cleanup;3825 }38263827 if (!(flags & REF_ISPRUNING))3828 string_list_append(&refs_to_delete,3829 update->lock->ref_name);3830 }3831 }38323833 if (repack_without_refs(&refs_to_delete, err)) {3834 ret = TRANSACTION_GENERIC_ERROR;3835 goto cleanup;3836 }3837 for_each_string_list_item(ref_to_delete, &refs_to_delete)3838 unlink_or_warn(git_path("logs/%s", ref_to_delete->string));3839 clear_loose_ref_cache(&ref_cache);38403841cleanup:3842 transaction->state = REF_TRANSACTION_CLOSED;38433844 for (i = 0; i < n; i++)3845 if (updates[i]->lock)3846 unlock_ref(updates[i]->lock);3847 string_list_clear(&refs_to_delete, 0);3848 return ret;3849}38503851char *shorten_unambiguous_ref(const char *refname, int strict)3852{3853 int i;3854 static char **scanf_fmts;3855 static int nr_rules;3856 char *short_name;38573858 if (!nr_rules) {3859 /*3860 * Pre-generate scanf formats from ref_rev_parse_rules[].3861 * Generate a format suitable for scanf from a3862 * ref_rev_parse_rules rule by interpolating "%s" at the3863 * location of the "%.*s".3864 */3865 size_t total_len = 0;3866 size_t offset = 0;38673868 /* the rule list is NULL terminated, count them first */3869 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)3870 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */3871 total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;38723873 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);38743875 offset = 0;3876 for (i = 0; i < nr_rules; i++) {3877 assert(offset < total_len);3878 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;3879 offset += snprintf(scanf_fmts[i], total_len - offset,3880 ref_rev_parse_rules[i], 2, "%s") + 1;3881 }3882 }38833884 /* bail out if there are no rules */3885 if (!nr_rules)3886 return xstrdup(refname);38873888 /* buffer for scanf result, at most refname must fit */3889 short_name = xstrdup(refname);38903891 /* skip first rule, it will always match */3892 for (i = nr_rules - 1; i > 0 ; --i) {3893 int j;3894 int rules_to_fail = i;3895 int short_name_len;38963897 if (1 != sscanf(refname, scanf_fmts[i], short_name))3898 continue;38993900 short_name_len = strlen(short_name);39013902 /*3903 * in strict mode, all (except the matched one) rules3904 * must fail to resolve to a valid non-ambiguous ref3905 */3906 if (strict)3907 rules_to_fail = nr_rules;39083909 /*3910 * check if the short name resolves to a valid ref,3911 * but use only rules prior to the matched one3912 */3913 for (j = 0; j < rules_to_fail; j++) {3914 const char *rule = ref_rev_parse_rules[j];3915 char refname[PATH_MAX];39163917 /* skip matched rule */3918 if (i == j)3919 continue;39203921 /*3922 * the short name is ambiguous, if it resolves3923 * (with this previous rule) to a valid ref3924 * read_ref() returns 0 on success3925 */3926 mksnpath(refname, sizeof(refname),3927 rule, short_name_len, short_name);3928 if (ref_exists(refname))3929 break;3930 }39313932 /*3933 * short name is non-ambiguous if all previous rules3934 * haven't resolved to a valid ref3935 */3936 if (j == rules_to_fail)3937 return short_name;3938 }39393940 free(short_name);3941 return xstrdup(refname);3942}39433944static struct string_list *hide_refs;39453946int parse_hide_refs_config(const char *var, const char *value, const char *section)3947{3948 if (!strcmp("transfer.hiderefs", var) ||3949 /* NEEDSWORK: use parse_config_key() once both are merged */3950 (starts_with(var, section) && var[strlen(section)] == '.' &&3951 !strcmp(var + strlen(section), ".hiderefs"))) {3952 char *ref;3953 int len;39543955 if (!value)3956 return config_error_nonbool(var);3957 ref = xstrdup(value);3958 len = strlen(ref);3959 while (len && ref[len - 1] == '/')3960 ref[--len] = '\0';3961 if (!hide_refs) {3962 hide_refs = xcalloc(1, sizeof(*hide_refs));3963 hide_refs->strdup_strings = 1;3964 }3965 string_list_append(hide_refs, ref);3966 }3967 return 0;3968}39693970int ref_is_hidden(const char *refname)3971{3972 struct string_list_item *item;39733974 if (!hide_refs)3975 return 0;3976 for_each_string_list_item(item, hide_refs) {3977 int len;3978 if (!starts_with(refname, item->string))3979 continue;3980 len = strlen(item->string);3981 if (!refname[len] || refname[len] == '/')3982 return 1;3983 }3984 return 0;3985}39863987struct expire_reflog_cb {3988 unsigned int flags;3989 reflog_expiry_should_prune_fn *should_prune_fn;3990 void *policy_cb;3991 FILE *newlog;3992 unsigned char last_kept_sha1[20];3993};39943995static int expire_reflog_ent(unsigned char *osha1, unsigned char *nsha1,3996 const char *email, unsigned long timestamp, int tz,3997 const char *message, void *cb_data)3998{3999 struct expire_reflog_cb *cb = cb_data;4000 struct expire_reflog_policy_cb *policy_cb = cb->policy_cb;40014002 if (cb->flags & EXPIRE_REFLOGS_REWRITE)4003 osha1 = cb->last_kept_sha1;40044005 if ((*cb->should_prune_fn)(osha1, nsha1, email, timestamp, tz,4006 message, policy_cb)) {4007 if (!cb->newlog)4008 printf("would prune %s", message);4009 else if (cb->flags & EXPIRE_REFLOGS_VERBOSE)4010 printf("prune %s", message);4011 } else {4012 if (cb->newlog) {4013 fprintf(cb->newlog, "%s %s %s %lu %+05d\t%s",4014 sha1_to_hex(osha1), sha1_to_hex(nsha1),4015 email, timestamp, tz, message);4016 hashcpy(cb->last_kept_sha1, nsha1);4017 }4018 if (cb->flags & EXPIRE_REFLOGS_VERBOSE)4019 printf("keep %s", message);4020 }4021 return 0;4022}40234024int reflog_expire(const char *refname, const unsigned char *sha1,4025 unsigned int flags,4026 reflog_expiry_prepare_fn prepare_fn,4027 reflog_expiry_should_prune_fn should_prune_fn,4028 reflog_expiry_cleanup_fn cleanup_fn,4029 void *policy_cb_data)4030{4031 static struct lock_file reflog_lock;4032 struct expire_reflog_cb cb;4033 struct ref_lock *lock;4034 char *log_file;4035 int status = 0;4036 int type;40374038 memset(&cb, 0, sizeof(cb));4039 cb.flags = flags;4040 cb.policy_cb = policy_cb_data;4041 cb.should_prune_fn = should_prune_fn;40424043 /*4044 * The reflog file is locked by holding the lock on the4045 * reference itself, plus we might need to update the4046 * reference if --updateref was specified:4047 */4048 lock = lock_ref_sha1_basic(refname, sha1, NULL, 0, &type);4049 if (!lock)4050 return error("cannot lock ref '%s'", refname);4051 if (!reflog_exists(refname)) {4052 unlock_ref(lock);4053 return 0;4054 }40554056 log_file = git_pathdup("logs/%s", refname);4057 if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {4058 /*4059 * Even though holding $GIT_DIR/logs/$reflog.lock has4060 * no locking implications, we use the lock_file4061 * machinery here anyway because it does a lot of the4062 * work we need, including cleaning up if the program4063 * exits unexpectedly.4064 */4065 if (hold_lock_file_for_update(&reflog_lock, log_file, 0) < 0) {4066 struct strbuf err = STRBUF_INIT;4067 unable_to_lock_message(log_file, errno, &err);4068 error("%s", err.buf);4069 strbuf_release(&err);4070 goto failure;4071 }4072 cb.newlog = fdopen_lock_file(&reflog_lock, "w");4073 if (!cb.newlog) {4074 error("cannot fdopen %s (%s)",4075 reflog_lock.filename.buf, strerror(errno));4076 goto failure;4077 }4078 }40794080 (*prepare_fn)(refname, sha1, cb.policy_cb);4081 for_each_reflog_ent(refname, expire_reflog_ent, &cb);4082 (*cleanup_fn)(cb.policy_cb);40834084 if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {4085 /*4086 * It doesn't make sense to adjust a reference pointed4087 * to by a symbolic ref based on expiring entries in4088 * the symbolic reference's reflog. Nor can we update4089 * a reference if there are no remaining reflog4090 * entries.4091 */4092 int update = (flags & EXPIRE_REFLOGS_UPDATE_REF) &&4093 !(type & REF_ISSYMREF) &&4094 !is_null_sha1(cb.last_kept_sha1);40954096 if (close_lock_file(&reflog_lock)) {4097 status |= error("couldn't write %s: %s", log_file,4098 strerror(errno));4099 } else if (update &&4100 (write_in_full(lock->lock_fd,4101 sha1_to_hex(cb.last_kept_sha1), 40) != 40 ||4102 write_str_in_full(lock->lock_fd, "\n") != 1 ||4103 close_ref(lock) < 0)) {4104 status |= error("couldn't write %s",4105 lock->lk->filename.buf);4106 rollback_lock_file(&reflog_lock);4107 } else if (commit_lock_file(&reflog_lock)) {4108 status |= error("unable to commit reflog '%s' (%s)",4109 log_file, strerror(errno));4110 } else if (update && commit_ref(lock)) {4111 status |= error("couldn't set %s", lock->ref_name);4112 }4113 }4114 free(log_file);4115 unlock_ref(lock);4116 return status;41174118 failure:4119 rollback_lock_file(&reflog_lock);4120 free(log_file);4121 unlock_ref(lock);4122 return -1;4123}