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 9/* 10 * How to handle various characters in refnames: 11 * 0: An acceptable character for refs 12 * 1: End-of-component 13 * 2: ., look for a preceding . to reject .. in refs 14 * 3: {, look for a preceding @ to reject @{ in refs 15 * 4: A bad character: ASCII control characters, "~", "^", ":" or SP 16 */ 17static unsigned char refname_disposition[256] = { 18 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 19 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 20 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 2, 1, 21 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4, 22 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 23 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0, 24 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 25 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4 26}; 27 28/* 29 * Used as a flag to ref_transaction_delete when a loose ref is being 30 * pruned. 31 */ 32#define REF_ISPRUNING 0x0100 33/* 34 * Try to read one refname component from the front of refname. 35 * Return the length of the component found, or -1 if the component is 36 * not legal. It is legal if it is something reasonable to have under 37 * ".git/refs/"; We do not like it if: 38 * 39 * - any path component of it begins with ".", or 40 * - it has double dots "..", or 41 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or 42 * - it ends with a "/". 43 * - it ends with ".lock" 44 * - it contains a "\" (backslash) 45 */ 46static int check_refname_component(const char *refname, int flags) 47{ 48 const char *cp; 49 char last = '\0'; 50 51 for (cp = refname; ; cp++) { 52 int ch = *cp & 255; 53 unsigned char disp = refname_disposition[ch]; 54 switch (disp) { 55 case 1: 56 goto out; 57 case 2: 58 if (last == '.') 59 return -1; /* Refname contains "..". */ 60 break; 61 case 3: 62 if (last == '@') 63 return -1; /* Refname contains "@{". */ 64 break; 65 case 4: 66 return -1; 67 } 68 last = ch; 69 } 70out: 71 if (cp == refname) 72 return 0; /* Component has zero length. */ 73 if (refname[0] == '.') 74 return -1; /* Component starts with '.'. */ 75 if (cp - refname >= LOCK_SUFFIX_LEN && 76 !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN)) 77 return -1; /* Refname ends with ".lock". */ 78 return cp - refname; 79} 80 81int check_refname_format(const char *refname, int flags) 82{ 83 int component_len, component_count = 0; 84 85 if (!strcmp(refname, "@")) 86 /* Refname is a single character '@'. */ 87 return -1; 88 89 while (1) { 90 /* We are at the start of a path component. */ 91 component_len = check_refname_component(refname, flags); 92 if (component_len <= 0) { 93 if ((flags & REFNAME_REFSPEC_PATTERN) && 94 refname[0] == '*' && 95 (refname[1] == '\0' || refname[1] == '/')) { 96 /* Accept one wildcard as a full refname component. */ 97 flags &= ~REFNAME_REFSPEC_PATTERN; 98 component_len = 1; 99 } else { 100 return -1; 101 } 102 } 103 component_count++; 104 if (refname[component_len] == '\0') 105 break; 106 /* Skip to next component. */ 107 refname += component_len + 1; 108 } 109 110 if (refname[component_len - 1] == '.') 111 return -1; /* Refname ends with '.'. */ 112 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2) 113 return -1; /* Refname has only one component. */ 114 return 0; 115} 116 117struct ref_entry; 118 119/* 120 * Information used (along with the information in ref_entry) to 121 * describe a single cached reference. This data structure only 122 * occurs embedded in a union in struct ref_entry, and only when 123 * (ref_entry->flag & REF_DIR) is zero. 124 */ 125struct ref_value { 126 /* 127 * The name of the object to which this reference resolves 128 * (which may be a tag object). If REF_ISBROKEN, this is 129 * null. If REF_ISSYMREF, then this is the name of the object 130 * referred to by the last reference in the symlink chain. 131 */ 132 unsigned char sha1[20]; 133 134 /* 135 * If REF_KNOWS_PEELED, then this field holds the peeled value 136 * of this reference, or null if the reference is known not to 137 * be peelable. See the documentation for peel_ref() for an 138 * exact definition of "peelable". 139 */ 140 unsigned char peeled[20]; 141}; 142 143struct ref_cache; 144 145/* 146 * Information used (along with the information in ref_entry) to 147 * describe a level in the hierarchy of references. This data 148 * structure only occurs embedded in a union in struct ref_entry, and 149 * only when (ref_entry.flag & REF_DIR) is set. In that case, 150 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references 151 * in the directory have already been read: 152 * 153 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose 154 * or packed references, already read. 155 * 156 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose 157 * references that hasn't been read yet (nor has any of its 158 * subdirectories). 159 * 160 * Entries within a directory are stored within a growable array of 161 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i < 162 * sorted are sorted by their component name in strcmp() order and the 163 * remaining entries are unsorted. 164 * 165 * Loose references are read lazily, one directory at a time. When a 166 * directory of loose references is read, then all of the references 167 * in that directory are stored, and REF_INCOMPLETE stubs are created 168 * for any subdirectories, but the subdirectories themselves are not 169 * read. The reading is triggered by get_ref_dir(). 170 */ 171struct ref_dir { 172 int nr, alloc; 173 174 /* 175 * Entries with index 0 <= i < sorted are sorted by name. New 176 * entries are appended to the list unsorted, and are sorted 177 * only when required; thus we avoid the need to sort the list 178 * after the addition of every reference. 179 */ 180 int sorted; 181 182 /* A pointer to the ref_cache that contains this ref_dir. */ 183 struct ref_cache *ref_cache; 184 185 struct ref_entry **entries; 186}; 187 188/* 189 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01, 190 * REF_ISPACKED=0x02, REF_ISBROKEN=0x04 and REF_BAD_NAME=0x08 are 191 * public values; see refs.h. 192 */ 193 194/* 195 * The field ref_entry->u.value.peeled of this value entry contains 196 * the correct peeled value for the reference, which might be 197 * null_sha1 if the reference is not a tag or if it is broken. 198 */ 199#define REF_KNOWS_PEELED 0x10 200 201/* ref_entry represents a directory of references */ 202#define REF_DIR 0x20 203 204/* 205 * Entry has not yet been read from disk (used only for REF_DIR 206 * entries representing loose references) 207 */ 208#define REF_INCOMPLETE 0x40 209 210/* 211 * A ref_entry represents either a reference or a "subdirectory" of 212 * references. 213 * 214 * Each directory in the reference namespace is represented by a 215 * ref_entry with (flags & REF_DIR) set and containing a subdir member 216 * that holds the entries in that directory that have been read so 217 * far. If (flags & REF_INCOMPLETE) is set, then the directory and 218 * its subdirectories haven't been read yet. REF_INCOMPLETE is only 219 * used for loose reference directories. 220 * 221 * References are represented by a ref_entry with (flags & REF_DIR) 222 * unset and a value member that describes the reference's value. The 223 * flag member is at the ref_entry level, but it is also needed to 224 * interpret the contents of the value field (in other words, a 225 * ref_value object is not very much use without the enclosing 226 * ref_entry). 227 * 228 * Reference names cannot end with slash and directories' names are 229 * always stored with a trailing slash (except for the top-level 230 * directory, which is always denoted by ""). This has two nice 231 * consequences: (1) when the entries in each subdir are sorted 232 * lexicographically by name (as they usually are), the references in 233 * a whole tree can be generated in lexicographic order by traversing 234 * the tree in left-to-right, depth-first order; (2) the names of 235 * references and subdirectories cannot conflict, and therefore the 236 * presence of an empty subdirectory does not block the creation of a 237 * similarly-named reference. (The fact that reference names with the 238 * same leading components can conflict *with each other* is a 239 * separate issue that is regulated by is_refname_available().) 240 * 241 * Please note that the name field contains the fully-qualified 242 * reference (or subdirectory) name. Space could be saved by only 243 * storing the relative names. But that would require the full names 244 * to be generated on the fly when iterating in do_for_each_ref(), and 245 * would break callback functions, who have always been able to assume 246 * that the name strings that they are passed will not be freed during 247 * the iteration. 248 */ 249struct ref_entry { 250 unsigned char flag; /* ISSYMREF? ISPACKED? */ 251 union { 252 struct ref_value value; /* if not (flags&REF_DIR) */ 253 struct ref_dir subdir; /* if (flags&REF_DIR) */ 254 } u; 255 /* 256 * The full name of the reference (e.g., "refs/heads/master") 257 * or the full name of the directory with a trailing slash 258 * (e.g., "refs/heads/"): 259 */ 260 char name[FLEX_ARRAY]; 261}; 262 263static void read_loose_refs(const char *dirname, struct ref_dir *dir); 264 265static struct ref_dir *get_ref_dir(struct ref_entry *entry) 266{ 267 struct ref_dir *dir; 268 assert(entry->flag & REF_DIR); 269 dir = &entry->u.subdir; 270 if (entry->flag & REF_INCOMPLETE) { 271 read_loose_refs(entry->name, dir); 272 entry->flag &= ~REF_INCOMPLETE; 273 } 274 return dir; 275} 276 277/* 278 * Check if a refname is safe. 279 * For refs that start with "refs/" we consider it safe as long they do 280 * not try to resolve to outside of refs/. 281 * 282 * For all other refs we only consider them safe iff they only contain 283 * upper case characters and '_' (like "HEAD" AND "MERGE_HEAD", and not like 284 * "config"). 285 */ 286static int refname_is_safe(const char *refname) 287{ 288 if (starts_with(refname, "refs/")) { 289 char *buf; 290 int result; 291 292 buf = xmalloc(strlen(refname) + 1); 293 /* 294 * Does the refname try to escape refs/? 295 * For example: refs/foo/../bar is safe but refs/foo/../../bar 296 * is not. 297 */ 298 result = !normalize_path_copy(buf, refname + strlen("refs/")); 299 free(buf); 300 return result; 301 } 302 while (*refname) { 303 if (!isupper(*refname) && *refname != '_') 304 return 0; 305 refname++; 306 } 307 return 1; 308} 309 310static struct ref_entry *create_ref_entry(const char *refname, 311 const unsigned char *sha1, int flag, 312 int check_name) 313{ 314 int len; 315 struct ref_entry *ref; 316 317 if (check_name && 318 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) 319 die("Reference has invalid format: '%s'", refname); 320 if (!check_name && !refname_is_safe(refname)) 321 die("Reference has invalid name: '%s'", refname); 322 len = strlen(refname) + 1; 323 ref = xmalloc(sizeof(struct ref_entry) + len); 324 hashcpy(ref->u.value.sha1, sha1); 325 hashclr(ref->u.value.peeled); 326 memcpy(ref->name, refname, len); 327 ref->flag = flag; 328 return ref; 329} 330 331static void clear_ref_dir(struct ref_dir *dir); 332 333static void free_ref_entry(struct ref_entry *entry) 334{ 335 if (entry->flag & REF_DIR) { 336 /* 337 * Do not use get_ref_dir() here, as that might 338 * trigger the reading of loose refs. 339 */ 340 clear_ref_dir(&entry->u.subdir); 341 } 342 free(entry); 343} 344 345/* 346 * Add a ref_entry to the end of dir (unsorted). Entry is always 347 * stored directly in dir; no recursion into subdirectories is 348 * done. 349 */ 350static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry) 351{ 352 ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc); 353 dir->entries[dir->nr++] = entry; 354 /* optimize for the case that entries are added in order */ 355 if (dir->nr == 1 || 356 (dir->nr == dir->sorted + 1 && 357 strcmp(dir->entries[dir->nr - 2]->name, 358 dir->entries[dir->nr - 1]->name) < 0)) 359 dir->sorted = dir->nr; 360} 361 362/* 363 * Clear and free all entries in dir, recursively. 364 */ 365static void clear_ref_dir(struct ref_dir *dir) 366{ 367 int i; 368 for (i = 0; i < dir->nr; i++) 369 free_ref_entry(dir->entries[i]); 370 free(dir->entries); 371 dir->sorted = dir->nr = dir->alloc = 0; 372 dir->entries = NULL; 373} 374 375/* 376 * Create a struct ref_entry object for the specified dirname. 377 * dirname is the name of the directory with a trailing slash (e.g., 378 * "refs/heads/") or "" for the top-level directory. 379 */ 380static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache, 381 const char *dirname, size_t len, 382 int incomplete) 383{ 384 struct ref_entry *direntry; 385 direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1); 386 memcpy(direntry->name, dirname, len); 387 direntry->name[len] = '\0'; 388 direntry->u.subdir.ref_cache = ref_cache; 389 direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0); 390 return direntry; 391} 392 393static int ref_entry_cmp(const void *a, const void *b) 394{ 395 struct ref_entry *one = *(struct ref_entry **)a; 396 struct ref_entry *two = *(struct ref_entry **)b; 397 return strcmp(one->name, two->name); 398} 399 400static void sort_ref_dir(struct ref_dir *dir); 401 402struct string_slice { 403 size_t len; 404 const char *str; 405}; 406 407static int ref_entry_cmp_sslice(const void *key_, const void *ent_) 408{ 409 const struct string_slice *key = key_; 410 const struct ref_entry *ent = *(const struct ref_entry * const *)ent_; 411 int cmp = strncmp(key->str, ent->name, key->len); 412 if (cmp) 413 return cmp; 414 return '\0' - (unsigned char)ent->name[key->len]; 415} 416 417/* 418 * Return the index of the entry with the given refname from the 419 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if 420 * no such entry is found. dir must already be complete. 421 */ 422static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len) 423{ 424 struct ref_entry **r; 425 struct string_slice key; 426 427 if (refname == NULL || !dir->nr) 428 return -1; 429 430 sort_ref_dir(dir); 431 key.len = len; 432 key.str = refname; 433 r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries), 434 ref_entry_cmp_sslice); 435 436 if (r == NULL) 437 return -1; 438 439 return r - dir->entries; 440} 441 442/* 443 * Search for a directory entry directly within dir (without 444 * recursing). Sort dir if necessary. subdirname must be a directory 445 * name (i.e., end in '/'). If mkdir is set, then create the 446 * directory if it is missing; otherwise, return NULL if the desired 447 * directory cannot be found. dir must already be complete. 448 */ 449static struct ref_dir *search_for_subdir(struct ref_dir *dir, 450 const char *subdirname, size_t len, 451 int mkdir) 452{ 453 int entry_index = search_ref_dir(dir, subdirname, len); 454 struct ref_entry *entry; 455 if (entry_index == -1) { 456 if (!mkdir) 457 return NULL; 458 /* 459 * Since dir is complete, the absence of a subdir 460 * means that the subdir really doesn't exist; 461 * therefore, create an empty record for it but mark 462 * the record complete. 463 */ 464 entry = create_dir_entry(dir->ref_cache, subdirname, len, 0); 465 add_entry_to_dir(dir, entry); 466 } else { 467 entry = dir->entries[entry_index]; 468 } 469 return get_ref_dir(entry); 470} 471 472/* 473 * If refname is a reference name, find the ref_dir within the dir 474 * tree that should hold refname. If refname is a directory name 475 * (i.e., ends in '/'), then return that ref_dir itself. dir must 476 * represent the top-level directory and must already be complete. 477 * Sort ref_dirs and recurse into subdirectories as necessary. If 478 * mkdir is set, then create any missing directories; otherwise, 479 * return NULL if the desired directory cannot be found. 480 */ 481static struct ref_dir *find_containing_dir(struct ref_dir *dir, 482 const char *refname, int mkdir) 483{ 484 const char *slash; 485 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) { 486 size_t dirnamelen = slash - refname + 1; 487 struct ref_dir *subdir; 488 subdir = search_for_subdir(dir, refname, dirnamelen, mkdir); 489 if (!subdir) { 490 dir = NULL; 491 break; 492 } 493 dir = subdir; 494 } 495 496 return dir; 497} 498 499/* 500 * Find the value entry with the given name in dir, sorting ref_dirs 501 * and recursing into subdirectories as necessary. If the name is not 502 * found or it corresponds to a directory entry, return NULL. 503 */ 504static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname) 505{ 506 int entry_index; 507 struct ref_entry *entry; 508 dir = find_containing_dir(dir, refname, 0); 509 if (!dir) 510 return NULL; 511 entry_index = search_ref_dir(dir, refname, strlen(refname)); 512 if (entry_index == -1) 513 return NULL; 514 entry = dir->entries[entry_index]; 515 return (entry->flag & REF_DIR) ? NULL : entry; 516} 517 518/* 519 * Remove the entry with the given name from dir, recursing into 520 * subdirectories as necessary. If refname is the name of a directory 521 * (i.e., ends with '/'), then remove the directory and its contents. 522 * If the removal was successful, return the number of entries 523 * remaining in the directory entry that contained the deleted entry. 524 * If the name was not found, return -1. Please note that this 525 * function only deletes the entry from the cache; it does not delete 526 * it from the filesystem or ensure that other cache entries (which 527 * might be symbolic references to the removed entry) are updated. 528 * Nor does it remove any containing dir entries that might be made 529 * empty by the removal. dir must represent the top-level directory 530 * and must already be complete. 531 */ 532static int remove_entry(struct ref_dir *dir, const char *refname) 533{ 534 int refname_len = strlen(refname); 535 int entry_index; 536 struct ref_entry *entry; 537 int is_dir = refname[refname_len - 1] == '/'; 538 if (is_dir) { 539 /* 540 * refname represents a reference directory. Remove 541 * the trailing slash; otherwise we will get the 542 * directory *representing* refname rather than the 543 * one *containing* it. 544 */ 545 char *dirname = xmemdupz(refname, refname_len - 1); 546 dir = find_containing_dir(dir, dirname, 0); 547 free(dirname); 548 } else { 549 dir = find_containing_dir(dir, refname, 0); 550 } 551 if (!dir) 552 return -1; 553 entry_index = search_ref_dir(dir, refname, refname_len); 554 if (entry_index == -1) 555 return -1; 556 entry = dir->entries[entry_index]; 557 558 memmove(&dir->entries[entry_index], 559 &dir->entries[entry_index + 1], 560 (dir->nr - entry_index - 1) * sizeof(*dir->entries) 561 ); 562 dir->nr--; 563 if (dir->sorted > entry_index) 564 dir->sorted--; 565 free_ref_entry(entry); 566 return dir->nr; 567} 568 569/* 570 * Add a ref_entry to the ref_dir (unsorted), recursing into 571 * subdirectories as necessary. dir must represent the top-level 572 * directory. Return 0 on success. 573 */ 574static int add_ref(struct ref_dir *dir, struct ref_entry *ref) 575{ 576 dir = find_containing_dir(dir, ref->name, 1); 577 if (!dir) 578 return -1; 579 add_entry_to_dir(dir, ref); 580 return 0; 581} 582 583/* 584 * Emit a warning and return true iff ref1 and ref2 have the same name 585 * and the same sha1. Die if they have the same name but different 586 * sha1s. 587 */ 588static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2) 589{ 590 if (strcmp(ref1->name, ref2->name)) 591 return 0; 592 593 /* Duplicate name; make sure that they don't conflict: */ 594 595 if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR)) 596 /* This is impossible by construction */ 597 die("Reference directory conflict: %s", ref1->name); 598 599 if (hashcmp(ref1->u.value.sha1, ref2->u.value.sha1)) 600 die("Duplicated ref, and SHA1s don't match: %s", ref1->name); 601 602 warning("Duplicated ref: %s", ref1->name); 603 return 1; 604} 605 606/* 607 * Sort the entries in dir non-recursively (if they are not already 608 * sorted) and remove any duplicate entries. 609 */ 610static void sort_ref_dir(struct ref_dir *dir) 611{ 612 int i, j; 613 struct ref_entry *last = NULL; 614 615 /* 616 * This check also prevents passing a zero-length array to qsort(), 617 * which is a problem on some platforms. 618 */ 619 if (dir->sorted == dir->nr) 620 return; 621 622 qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp); 623 624 /* Remove any duplicates: */ 625 for (i = 0, j = 0; j < dir->nr; j++) { 626 struct ref_entry *entry = dir->entries[j]; 627 if (last && is_dup_ref(last, entry)) 628 free_ref_entry(entry); 629 else 630 last = dir->entries[i++] = entry; 631 } 632 dir->sorted = dir->nr = i; 633} 634 635/* Include broken references in a do_for_each_ref*() iteration: */ 636#define DO_FOR_EACH_INCLUDE_BROKEN 0x01 637 638/* 639 * Return true iff the reference described by entry can be resolved to 640 * an object in the database. Emit a warning if the referred-to 641 * object does not exist. 642 */ 643static int ref_resolves_to_object(struct ref_entry *entry) 644{ 645 if (entry->flag & REF_ISBROKEN) 646 return 0; 647 if (!has_sha1_file(entry->u.value.sha1)) { 648 error("%s does not point to a valid object!", entry->name); 649 return 0; 650 } 651 return 1; 652} 653 654/* 655 * current_ref is a performance hack: when iterating over references 656 * using the for_each_ref*() functions, current_ref is set to the 657 * current reference's entry before calling the callback function. If 658 * the callback function calls peel_ref(), then peel_ref() first 659 * checks whether the reference to be peeled is the current reference 660 * (it usually is) and if so, returns that reference's peeled version 661 * if it is available. This avoids a refname lookup in a common case. 662 */ 663static struct ref_entry *current_ref; 664 665typedef int each_ref_entry_fn(struct ref_entry *entry, void *cb_data); 666 667struct ref_entry_cb { 668 const char *base; 669 int trim; 670 int flags; 671 each_ref_fn *fn; 672 void *cb_data; 673}; 674 675/* 676 * Handle one reference in a do_for_each_ref*()-style iteration, 677 * calling an each_ref_fn for each entry. 678 */ 679static int do_one_ref(struct ref_entry *entry, void *cb_data) 680{ 681 struct ref_entry_cb *data = cb_data; 682 struct ref_entry *old_current_ref; 683 int retval; 684 685 if (!starts_with(entry->name, data->base)) 686 return 0; 687 688 if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) && 689 !ref_resolves_to_object(entry)) 690 return 0; 691 692 /* Store the old value, in case this is a recursive call: */ 693 old_current_ref = current_ref; 694 current_ref = entry; 695 retval = data->fn(entry->name + data->trim, entry->u.value.sha1, 696 entry->flag, data->cb_data); 697 current_ref = old_current_ref; 698 return retval; 699} 700 701/* 702 * Call fn for each reference in dir that has index in the range 703 * offset <= index < dir->nr. Recurse into subdirectories that are in 704 * that index range, sorting them before iterating. This function 705 * does not sort dir itself; it should be sorted beforehand. fn is 706 * called for all references, including broken ones. 707 */ 708static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset, 709 each_ref_entry_fn fn, void *cb_data) 710{ 711 int i; 712 assert(dir->sorted == dir->nr); 713 for (i = offset; i < dir->nr; i++) { 714 struct ref_entry *entry = dir->entries[i]; 715 int retval; 716 if (entry->flag & REF_DIR) { 717 struct ref_dir *subdir = get_ref_dir(entry); 718 sort_ref_dir(subdir); 719 retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data); 720 } else { 721 retval = fn(entry, cb_data); 722 } 723 if (retval) 724 return retval; 725 } 726 return 0; 727} 728 729/* 730 * Call fn for each reference in the union of dir1 and dir2, in order 731 * by refname. Recurse into subdirectories. If a value entry appears 732 * in both dir1 and dir2, then only process the version that is in 733 * dir2. The input dirs must already be sorted, but subdirs will be 734 * sorted as needed. fn is called for all references, including 735 * broken ones. 736 */ 737static int do_for_each_entry_in_dirs(struct ref_dir *dir1, 738 struct ref_dir *dir2, 739 each_ref_entry_fn fn, void *cb_data) 740{ 741 int retval; 742 int i1 = 0, i2 = 0; 743 744 assert(dir1->sorted == dir1->nr); 745 assert(dir2->sorted == dir2->nr); 746 while (1) { 747 struct ref_entry *e1, *e2; 748 int cmp; 749 if (i1 == dir1->nr) { 750 return do_for_each_entry_in_dir(dir2, i2, fn, cb_data); 751 } 752 if (i2 == dir2->nr) { 753 return do_for_each_entry_in_dir(dir1, i1, fn, cb_data); 754 } 755 e1 = dir1->entries[i1]; 756 e2 = dir2->entries[i2]; 757 cmp = strcmp(e1->name, e2->name); 758 if (cmp == 0) { 759 if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) { 760 /* Both are directories; descend them in parallel. */ 761 struct ref_dir *subdir1 = get_ref_dir(e1); 762 struct ref_dir *subdir2 = get_ref_dir(e2); 763 sort_ref_dir(subdir1); 764 sort_ref_dir(subdir2); 765 retval = do_for_each_entry_in_dirs( 766 subdir1, subdir2, fn, cb_data); 767 i1++; 768 i2++; 769 } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) { 770 /* Both are references; ignore the one from dir1. */ 771 retval = fn(e2, cb_data); 772 i1++; 773 i2++; 774 } else { 775 die("conflict between reference and directory: %s", 776 e1->name); 777 } 778 } else { 779 struct ref_entry *e; 780 if (cmp < 0) { 781 e = e1; 782 i1++; 783 } else { 784 e = e2; 785 i2++; 786 } 787 if (e->flag & REF_DIR) { 788 struct ref_dir *subdir = get_ref_dir(e); 789 sort_ref_dir(subdir); 790 retval = do_for_each_entry_in_dir( 791 subdir, 0, fn, cb_data); 792 } else { 793 retval = fn(e, cb_data); 794 } 795 } 796 if (retval) 797 return retval; 798 } 799} 800 801/* 802 * Load all of the refs from the dir into our in-memory cache. The hard work 803 * of loading loose refs is done by get_ref_dir(), so we just need to recurse 804 * through all of the sub-directories. We do not even need to care about 805 * sorting, as traversal order does not matter to us. 806 */ 807static void prime_ref_dir(struct ref_dir *dir) 808{ 809 int i; 810 for (i = 0; i < dir->nr; i++) { 811 struct ref_entry *entry = dir->entries[i]; 812 if (entry->flag & REF_DIR) 813 prime_ref_dir(get_ref_dir(entry)); 814 } 815} 816 817static int entry_matches(struct ref_entry *entry, const struct string_list *list) 818{ 819 return list && string_list_has_string(list, entry->name); 820} 821 822struct nonmatching_ref_data { 823 const struct string_list *skip; 824 struct ref_entry *found; 825}; 826 827static int nonmatching_ref_fn(struct ref_entry *entry, void *vdata) 828{ 829 struct nonmatching_ref_data *data = vdata; 830 831 if (entry_matches(entry, data->skip)) 832 return 0; 833 834 data->found = entry; 835 return 1; 836} 837 838static void report_refname_conflict(struct ref_entry *entry, 839 const char *refname) 840{ 841 error("'%s' exists; cannot create '%s'", entry->name, refname); 842} 843 844/* 845 * Return true iff a reference named refname could be created without 846 * conflicting with the name of an existing reference in dir. If 847 * skip is non-NULL, ignore potential conflicts with refs in skip 848 * (e.g., because they are scheduled for deletion in the same 849 * operation). 850 * 851 * Two reference names conflict if one of them exactly matches the 852 * leading components of the other; e.g., "foo/bar" conflicts with 853 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or 854 * "foo/barbados". 855 * 856 * skip must be sorted. 857 */ 858static int is_refname_available(const char *refname, 859 const struct string_list *skip, 860 struct ref_dir *dir) 861{ 862 const char *slash; 863 size_t len; 864 int pos; 865 char *dirname; 866 867 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) { 868 /* 869 * We are still at a leading dir of the refname; we are 870 * looking for a conflict with a leaf entry. 871 * 872 * If we find one, we still must make sure it is 873 * not in "skip". 874 */ 875 pos = search_ref_dir(dir, refname, slash - refname); 876 if (pos >= 0) { 877 struct ref_entry *entry = dir->entries[pos]; 878 if (entry_matches(entry, skip)) 879 return 1; 880 report_refname_conflict(entry, refname); 881 return 0; 882 } 883 884 885 /* 886 * Otherwise, we can try to continue our search with 887 * the next component; if we come up empty, we know 888 * there is nothing under this whole prefix. 889 */ 890 pos = search_ref_dir(dir, refname, slash + 1 - refname); 891 if (pos < 0) 892 return 1; 893 894 dir = get_ref_dir(dir->entries[pos]); 895 } 896 897 /* 898 * We are at the leaf of our refname; we want to 899 * make sure there are no directories which match it. 900 */ 901 len = strlen(refname); 902 dirname = xmallocz(len + 1); 903 sprintf(dirname, "%s/", refname); 904 pos = search_ref_dir(dir, dirname, len + 1); 905 free(dirname); 906 907 if (pos >= 0) { 908 /* 909 * We found a directory named "refname". It is a 910 * problem iff it contains any ref that is not 911 * in "skip". 912 */ 913 struct ref_entry *entry = dir->entries[pos]; 914 struct ref_dir *dir = get_ref_dir(entry); 915 struct nonmatching_ref_data data; 916 917 data.skip = skip; 918 sort_ref_dir(dir); 919 if (!do_for_each_entry_in_dir(dir, 0, nonmatching_ref_fn, &data)) 920 return 1; 921 922 report_refname_conflict(data.found, refname); 923 return 0; 924 } 925 926 /* 927 * There is no point in searching for another leaf 928 * node which matches it; such an entry would be the 929 * ref we are looking for, not a conflict. 930 */ 931 return 1; 932} 933 934struct packed_ref_cache { 935 struct ref_entry *root; 936 937 /* 938 * Count of references to the data structure in this instance, 939 * including the pointer from ref_cache::packed if any. The 940 * data will not be freed as long as the reference count is 941 * nonzero. 942 */ 943 unsigned int referrers; 944 945 /* 946 * Iff the packed-refs file associated with this instance is 947 * currently locked for writing, this points at the associated 948 * lock (which is owned by somebody else). The referrer count 949 * is also incremented when the file is locked and decremented 950 * when it is unlocked. 951 */ 952 struct lock_file *lock; 953 954 /* The metadata from when this packed-refs cache was read */ 955 struct stat_validity validity; 956}; 957 958/* 959 * Future: need to be in "struct repository" 960 * when doing a full libification. 961 */ 962static struct ref_cache { 963 struct ref_cache *next; 964 struct ref_entry *loose; 965 struct packed_ref_cache *packed; 966 /* 967 * The submodule name, or "" for the main repo. We allocate 968 * length 1 rather than FLEX_ARRAY so that the main ref_cache 969 * is initialized correctly. 970 */ 971 char name[1]; 972} ref_cache, *submodule_ref_caches; 973 974/* Lock used for the main packed-refs file: */ 975static struct lock_file packlock; 976 977/* 978 * Increment the reference count of *packed_refs. 979 */ 980static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs) 981{ 982 packed_refs->referrers++; 983} 984 985/* 986 * Decrease the reference count of *packed_refs. If it goes to zero, 987 * free *packed_refs and return true; otherwise return false. 988 */ 989static int release_packed_ref_cache(struct packed_ref_cache *packed_refs) 990{ 991 if (!--packed_refs->referrers) { 992 free_ref_entry(packed_refs->root); 993 stat_validity_clear(&packed_refs->validity); 994 free(packed_refs); 995 return 1; 996 } else { 997 return 0; 998 } 999}10001001static void clear_packed_ref_cache(struct ref_cache *refs)1002{1003 if (refs->packed) {1004 struct packed_ref_cache *packed_refs = refs->packed;10051006 if (packed_refs->lock)1007 die("internal error: packed-ref cache cleared while locked");1008 refs->packed = NULL;1009 release_packed_ref_cache(packed_refs);1010 }1011}10121013static void clear_loose_ref_cache(struct ref_cache *refs)1014{1015 if (refs->loose) {1016 free_ref_entry(refs->loose);1017 refs->loose = NULL;1018 }1019}10201021static struct ref_cache *create_ref_cache(const char *submodule)1022{1023 int len;1024 struct ref_cache *refs;1025 if (!submodule)1026 submodule = "";1027 len = strlen(submodule) + 1;1028 refs = xcalloc(1, sizeof(struct ref_cache) + len);1029 memcpy(refs->name, submodule, len);1030 return refs;1031}10321033/*1034 * Return a pointer to a ref_cache for the specified submodule. For1035 * the main repository, use submodule==NULL. The returned structure1036 * will be allocated and initialized but not necessarily populated; it1037 * should not be freed.1038 */1039static struct ref_cache *get_ref_cache(const char *submodule)1040{1041 struct ref_cache *refs;10421043 if (!submodule || !*submodule)1044 return &ref_cache;10451046 for (refs = submodule_ref_caches; refs; refs = refs->next)1047 if (!strcmp(submodule, refs->name))1048 return refs;10491050 refs = create_ref_cache(submodule);1051 refs->next = submodule_ref_caches;1052 submodule_ref_caches = refs;1053 return refs;1054}10551056/* The length of a peeled reference line in packed-refs, including EOL: */1057#define PEELED_LINE_LENGTH 4210581059/*1060 * The packed-refs header line that we write out. Perhaps other1061 * traits will be added later. The trailing space is required.1062 */1063static const char PACKED_REFS_HEADER[] =1064 "# pack-refs with: peeled fully-peeled \n";10651066/*1067 * Parse one line from a packed-refs file. Write the SHA1 to sha1.1068 * Return a pointer to the refname within the line (null-terminated),1069 * or NULL if there was a problem.1070 */1071static const char *parse_ref_line(struct strbuf *line, unsigned char *sha1)1072{1073 const char *ref;10741075 /*1076 * 42: the answer to everything.1077 *1078 * In this case, it happens to be the answer to1079 * 40 (length of sha1 hex representation)1080 * +1 (space in between hex and name)1081 * +1 (newline at the end of the line)1082 */1083 if (line->len <= 42)1084 return NULL;10851086 if (get_sha1_hex(line->buf, sha1) < 0)1087 return NULL;1088 if (!isspace(line->buf[40]))1089 return NULL;10901091 ref = line->buf + 41;1092 if (isspace(*ref))1093 return NULL;10941095 if (line->buf[line->len - 1] != '\n')1096 return NULL;1097 line->buf[--line->len] = 0;10981099 return ref;1100}11011102/*1103 * Read f, which is a packed-refs file, into dir.1104 *1105 * A comment line of the form "# pack-refs with: " may contain zero or1106 * more traits. We interpret the traits as follows:1107 *1108 * No traits:1109 *1110 * Probably no references are peeled. But if the file contains a1111 * peeled value for a reference, we will use it.1112 *1113 * peeled:1114 *1115 * References under "refs/tags/", if they *can* be peeled, *are*1116 * peeled in this file. References outside of "refs/tags/" are1117 * probably not peeled even if they could have been, but if we find1118 * a peeled value for such a reference we will use it.1119 *1120 * fully-peeled:1121 *1122 * All references in the file that can be peeled are peeled.1123 * Inversely (and this is more important), any references in the1124 * file for which no peeled value is recorded is not peelable. This1125 * trait should typically be written alongside "peeled" for1126 * compatibility with older clients, but we do not require it1127 * (i.e., "peeled" is a no-op if "fully-peeled" is set).1128 */1129static void read_packed_refs(FILE *f, struct ref_dir *dir)1130{1131 struct ref_entry *last = NULL;1132 struct strbuf line = STRBUF_INIT;1133 enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;11341135 while (strbuf_getwholeline(&line, f, '\n') != EOF) {1136 unsigned char sha1[20];1137 const char *refname;1138 const char *traits;11391140 if (skip_prefix(line.buf, "# pack-refs with:", &traits)) {1141 if (strstr(traits, " fully-peeled "))1142 peeled = PEELED_FULLY;1143 else if (strstr(traits, " peeled "))1144 peeled = PEELED_TAGS;1145 /* perhaps other traits later as well */1146 continue;1147 }11481149 refname = parse_ref_line(&line, sha1);1150 if (refname) {1151 int flag = REF_ISPACKED;11521153 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {1154 hashclr(sha1);1155 flag |= REF_BAD_NAME | REF_ISBROKEN;1156 }1157 last = create_ref_entry(refname, sha1, flag, 0);1158 if (peeled == PEELED_FULLY ||1159 (peeled == PEELED_TAGS && starts_with(refname, "refs/tags/")))1160 last->flag |= REF_KNOWS_PEELED;1161 add_ref(dir, last);1162 continue;1163 }1164 if (last &&1165 line.buf[0] == '^' &&1166 line.len == PEELED_LINE_LENGTH &&1167 line.buf[PEELED_LINE_LENGTH - 1] == '\n' &&1168 !get_sha1_hex(line.buf + 1, sha1)) {1169 hashcpy(last->u.value.peeled, sha1);1170 /*1171 * Regardless of what the file header said,1172 * we definitely know the value of *this*1173 * reference:1174 */1175 last->flag |= REF_KNOWS_PEELED;1176 }1177 }11781179 strbuf_release(&line);1180}11811182/*1183 * Get the packed_ref_cache for the specified ref_cache, creating it1184 * if necessary.1185 */1186static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs)1187{1188 const char *packed_refs_file;11891190 if (*refs->name)1191 packed_refs_file = git_path_submodule(refs->name, "packed-refs");1192 else1193 packed_refs_file = git_path("packed-refs");11941195 if (refs->packed &&1196 !stat_validity_check(&refs->packed->validity, packed_refs_file))1197 clear_packed_ref_cache(refs);11981199 if (!refs->packed) {1200 FILE *f;12011202 refs->packed = xcalloc(1, sizeof(*refs->packed));1203 acquire_packed_ref_cache(refs->packed);1204 refs->packed->root = create_dir_entry(refs, "", 0, 0);1205 f = fopen(packed_refs_file, "r");1206 if (f) {1207 stat_validity_update(&refs->packed->validity, fileno(f));1208 read_packed_refs(f, get_ref_dir(refs->packed->root));1209 fclose(f);1210 }1211 }1212 return refs->packed;1213}12141215static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_cache)1216{1217 return get_ref_dir(packed_ref_cache->root);1218}12191220static struct ref_dir *get_packed_refs(struct ref_cache *refs)1221{1222 return get_packed_ref_dir(get_packed_ref_cache(refs));1223}12241225void add_packed_ref(const char *refname, const unsigned char *sha1)1226{1227 struct packed_ref_cache *packed_ref_cache =1228 get_packed_ref_cache(&ref_cache);12291230 if (!packed_ref_cache->lock)1231 die("internal error: packed refs not locked");1232 add_ref(get_packed_ref_dir(packed_ref_cache),1233 create_ref_entry(refname, sha1, REF_ISPACKED, 1));1234}12351236/*1237 * Read the loose references from the namespace dirname into dir1238 * (without recursing). dirname must end with '/'. dir must be the1239 * directory entry corresponding to dirname.1240 */1241static void read_loose_refs(const char *dirname, struct ref_dir *dir)1242{1243 struct ref_cache *refs = dir->ref_cache;1244 DIR *d;1245 const char *path;1246 struct dirent *de;1247 int dirnamelen = strlen(dirname);1248 struct strbuf refname;12491250 if (*refs->name)1251 path = git_path_submodule(refs->name, "%s", dirname);1252 else1253 path = git_path("%s", dirname);12541255 d = opendir(path);1256 if (!d)1257 return;12581259 strbuf_init(&refname, dirnamelen + 257);1260 strbuf_add(&refname, dirname, dirnamelen);12611262 while ((de = readdir(d)) != NULL) {1263 unsigned char sha1[20];1264 struct stat st;1265 int flag;1266 const char *refdir;12671268 if (de->d_name[0] == '.')1269 continue;1270 if (ends_with(de->d_name, ".lock"))1271 continue;1272 strbuf_addstr(&refname, de->d_name);1273 refdir = *refs->name1274 ? git_path_submodule(refs->name, "%s", refname.buf)1275 : git_path("%s", refname.buf);1276 if (stat(refdir, &st) < 0) {1277 ; /* silently ignore */1278 } else if (S_ISDIR(st.st_mode)) {1279 strbuf_addch(&refname, '/');1280 add_entry_to_dir(dir,1281 create_dir_entry(refs, refname.buf,1282 refname.len, 1));1283 } else {1284 if (*refs->name) {1285 hashclr(sha1);1286 flag = 0;1287 if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {1288 hashclr(sha1);1289 flag |= REF_ISBROKEN;1290 }1291 } else if (read_ref_full(refname.buf,1292 RESOLVE_REF_READING,1293 sha1, &flag)) {1294 hashclr(sha1);1295 flag |= REF_ISBROKEN;1296 }1297 if (check_refname_format(refname.buf,1298 REFNAME_ALLOW_ONELEVEL)) {1299 hashclr(sha1);1300 flag |= REF_BAD_NAME | REF_ISBROKEN;1301 }1302 add_entry_to_dir(dir,1303 create_ref_entry(refname.buf, sha1, flag, 0));1304 }1305 strbuf_setlen(&refname, dirnamelen);1306 }1307 strbuf_release(&refname);1308 closedir(d);1309}13101311static struct ref_dir *get_loose_refs(struct ref_cache *refs)1312{1313 if (!refs->loose) {1314 /*1315 * Mark the top-level directory complete because we1316 * are about to read the only subdirectory that can1317 * hold references:1318 */1319 refs->loose = create_dir_entry(refs, "", 0, 0);1320 /*1321 * Create an incomplete entry for "refs/":1322 */1323 add_entry_to_dir(get_ref_dir(refs->loose),1324 create_dir_entry(refs, "refs/", 5, 1));1325 }1326 return get_ref_dir(refs->loose);1327}13281329/* We allow "recursive" symbolic refs. Only within reason, though */1330#define MAXDEPTH 51331#define MAXREFLEN (1024)13321333/*1334 * Called by resolve_gitlink_ref_recursive() after it failed to read1335 * from the loose refs in ref_cache refs. Find <refname> in the1336 * packed-refs file for the submodule.1337 */1338static int resolve_gitlink_packed_ref(struct ref_cache *refs,1339 const char *refname, unsigned char *sha1)1340{1341 struct ref_entry *ref;1342 struct ref_dir *dir = get_packed_refs(refs);13431344 ref = find_ref(dir, refname);1345 if (ref == NULL)1346 return -1;13471348 hashcpy(sha1, ref->u.value.sha1);1349 return 0;1350}13511352static int resolve_gitlink_ref_recursive(struct ref_cache *refs,1353 const char *refname, unsigned char *sha1,1354 int recursion)1355{1356 int fd, len;1357 char buffer[128], *p;1358 char *path;13591360 if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)1361 return -1;1362 path = *refs->name1363 ? git_path_submodule(refs->name, "%s", refname)1364 : git_path("%s", refname);1365 fd = open(path, O_RDONLY);1366 if (fd < 0)1367 return resolve_gitlink_packed_ref(refs, refname, sha1);13681369 len = read(fd, buffer, sizeof(buffer)-1);1370 close(fd);1371 if (len < 0)1372 return -1;1373 while (len && isspace(buffer[len-1]))1374 len--;1375 buffer[len] = 0;13761377 /* Was it a detached head or an old-fashioned symlink? */1378 if (!get_sha1_hex(buffer, sha1))1379 return 0;13801381 /* Symref? */1382 if (strncmp(buffer, "ref:", 4))1383 return -1;1384 p = buffer + 4;1385 while (isspace(*p))1386 p++;13871388 return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);1389}13901391int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)1392{1393 int len = strlen(path), retval;1394 char *submodule;1395 struct ref_cache *refs;13961397 while (len && path[len-1] == '/')1398 len--;1399 if (!len)1400 return -1;1401 submodule = xstrndup(path, len);1402 refs = get_ref_cache(submodule);1403 free(submodule);14041405 retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);1406 return retval;1407}14081409/*1410 * Return the ref_entry for the given refname from the packed1411 * references. If it does not exist, return NULL.1412 */1413static struct ref_entry *get_packed_ref(const char *refname)1414{1415 return find_ref(get_packed_refs(&ref_cache), refname);1416}14171418/*1419 * A loose ref file doesn't exist; check for a packed ref. The1420 * options are forwarded from resolve_safe_unsafe().1421 */1422static int resolve_missing_loose_ref(const char *refname,1423 int resolve_flags,1424 unsigned char *sha1,1425 int *flags)1426{1427 struct ref_entry *entry;14281429 /*1430 * The loose reference file does not exist; check for a packed1431 * reference.1432 */1433 entry = get_packed_ref(refname);1434 if (entry) {1435 hashcpy(sha1, entry->u.value.sha1);1436 if (flags)1437 *flags |= REF_ISPACKED;1438 return 0;1439 }1440 /* The reference is not a packed reference, either. */1441 if (resolve_flags & RESOLVE_REF_READING) {1442 errno = ENOENT;1443 return -1;1444 } else {1445 hashclr(sha1);1446 return 0;1447 }1448}14491450/* This function needs to return a meaningful errno on failure */1451const char *resolve_ref_unsafe(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)1452{1453 int depth = MAXDEPTH;1454 ssize_t len;1455 char buffer[256];1456 static char refname_buffer[256];1457 int bad_name = 0;14581459 if (flags)1460 *flags = 0;14611462 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {1463 if (flags)1464 *flags |= REF_BAD_NAME;14651466 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||1467 !refname_is_safe(refname)) {1468 errno = EINVAL;1469 return NULL;1470 }1471 /*1472 * dwim_ref() uses REF_ISBROKEN to distinguish between1473 * missing refs and refs that were present but invalid,1474 * to complain about the latter to stderr.1475 *1476 * We don't know whether the ref exists, so don't set1477 * REF_ISBROKEN yet.1478 */1479 bad_name = 1;1480 }1481 for (;;) {1482 char path[PATH_MAX];1483 struct stat st;1484 char *buf;1485 int fd;14861487 if (--depth < 0) {1488 errno = ELOOP;1489 return NULL;1490 }14911492 git_snpath(path, sizeof(path), "%s", refname);14931494 /*1495 * We might have to loop back here to avoid a race1496 * condition: first we lstat() the file, then we try1497 * to read it as a link or as a file. But if somebody1498 * changes the type of the file (file <-> directory1499 * <-> symlink) between the lstat() and reading, then1500 * we don't want to report that as an error but rather1501 * try again starting with the lstat().1502 */1503 stat_ref:1504 if (lstat(path, &st) < 0) {1505 if (errno != ENOENT)1506 return NULL;1507 if (resolve_missing_loose_ref(refname, resolve_flags,1508 sha1, flags))1509 return NULL;1510 if (bad_name) {1511 hashclr(sha1);1512 if (flags)1513 *flags |= REF_ISBROKEN;1514 }1515 return refname;1516 }15171518 /* Follow "normalized" - ie "refs/.." symlinks by hand */1519 if (S_ISLNK(st.st_mode)) {1520 len = readlink(path, buffer, sizeof(buffer)-1);1521 if (len < 0) {1522 if (errno == ENOENT || errno == EINVAL)1523 /* inconsistent with lstat; retry */1524 goto stat_ref;1525 else1526 return NULL;1527 }1528 buffer[len] = 0;1529 if (starts_with(buffer, "refs/") &&1530 !check_refname_format(buffer, 0)) {1531 strcpy(refname_buffer, buffer);1532 refname = refname_buffer;1533 if (flags)1534 *flags |= REF_ISSYMREF;1535 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {1536 hashclr(sha1);1537 return refname;1538 }1539 continue;1540 }1541 }15421543 /* Is it a directory? */1544 if (S_ISDIR(st.st_mode)) {1545 errno = EISDIR;1546 return NULL;1547 }15481549 /*1550 * Anything else, just open it and try to use it as1551 * a ref1552 */1553 fd = open(path, O_RDONLY);1554 if (fd < 0) {1555 if (errno == ENOENT)1556 /* inconsistent with lstat; retry */1557 goto stat_ref;1558 else1559 return NULL;1560 }1561 len = read_in_full(fd, buffer, sizeof(buffer)-1);1562 if (len < 0) {1563 int save_errno = errno;1564 close(fd);1565 errno = save_errno;1566 return NULL;1567 }1568 close(fd);1569 while (len && isspace(buffer[len-1]))1570 len--;1571 buffer[len] = '\0';15721573 /*1574 * Is it a symbolic ref?1575 */1576 if (!starts_with(buffer, "ref:")) {1577 /*1578 * Please note that FETCH_HEAD has a second1579 * line containing other data.1580 */1581 if (get_sha1_hex(buffer, sha1) ||1582 (buffer[40] != '\0' && !isspace(buffer[40]))) {1583 if (flags)1584 *flags |= REF_ISBROKEN;1585 errno = EINVAL;1586 return NULL;1587 }1588 if (bad_name) {1589 hashclr(sha1);1590 if (flags)1591 *flags |= REF_ISBROKEN;1592 }1593 return refname;1594 }1595 if (flags)1596 *flags |= REF_ISSYMREF;1597 buf = buffer + 4;1598 while (isspace(*buf))1599 buf++;1600 refname = strcpy(refname_buffer, buf);1601 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {1602 hashclr(sha1);1603 return refname;1604 }1605 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {1606 if (flags)1607 *flags |= REF_ISBROKEN;16081609 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||1610 !refname_is_safe(buf)) {1611 errno = EINVAL;1612 return NULL;1613 }1614 bad_name = 1;1615 }1616 }1617}16181619char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags)1620{1621 const char *ret = resolve_ref_unsafe(ref, resolve_flags, sha1, flags);1622 return ret ? xstrdup(ret) : NULL;1623}16241625/* The argument to filter_refs */1626struct ref_filter {1627 const char *pattern;1628 each_ref_fn *fn;1629 void *cb_data;1630};16311632int read_ref_full(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)1633{1634 if (resolve_ref_unsafe(refname, resolve_flags, sha1, flags))1635 return 0;1636 return -1;1637}16381639int read_ref(const char *refname, unsigned char *sha1)1640{1641 return read_ref_full(refname, RESOLVE_REF_READING, sha1, NULL);1642}16431644int ref_exists(const char *refname)1645{1646 unsigned char sha1[20];1647 return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, sha1, NULL);1648}16491650static int filter_refs(const char *refname, const unsigned char *sha1, int flags,1651 void *data)1652{1653 struct ref_filter *filter = (struct ref_filter *)data;1654 if (wildmatch(filter->pattern, refname, 0, NULL))1655 return 0;1656 return filter->fn(refname, sha1, flags, filter->cb_data);1657}16581659enum peel_status {1660 /* object was peeled successfully: */1661 PEEL_PEELED = 0,16621663 /*1664 * object cannot be peeled because the named object (or an1665 * object referred to by a tag in the peel chain), does not1666 * exist.1667 */1668 PEEL_INVALID = -1,16691670 /* object cannot be peeled because it is not a tag: */1671 PEEL_NON_TAG = -2,16721673 /* ref_entry contains no peeled value because it is a symref: */1674 PEEL_IS_SYMREF = -3,16751676 /*1677 * ref_entry cannot be peeled because it is broken (i.e., the1678 * symbolic reference cannot even be resolved to an object1679 * name):1680 */1681 PEEL_BROKEN = -41682};16831684/*1685 * Peel the named object; i.e., if the object is a tag, resolve the1686 * tag recursively until a non-tag is found. If successful, store the1687 * result to sha1 and return PEEL_PEELED. If the object is not a tag1688 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,1689 * and leave sha1 unchanged.1690 */1691static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)1692{1693 struct object *o = lookup_unknown_object(name);16941695 if (o->type == OBJ_NONE) {1696 int type = sha1_object_info(name, NULL);1697 if (type < 0 || !object_as_type(o, type, 0))1698 return PEEL_INVALID;1699 }17001701 if (o->type != OBJ_TAG)1702 return PEEL_NON_TAG;17031704 o = deref_tag_noverify(o);1705 if (!o)1706 return PEEL_INVALID;17071708 hashcpy(sha1, o->sha1);1709 return PEEL_PEELED;1710}17111712/*1713 * Peel the entry (if possible) and return its new peel_status. If1714 * repeel is true, re-peel the entry even if there is an old peeled1715 * value that is already stored in it.1716 *1717 * It is OK to call this function with a packed reference entry that1718 * might be stale and might even refer to an object that has since1719 * been garbage-collected. In such a case, if the entry has1720 * REF_KNOWS_PEELED then leave the status unchanged and return1721 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.1722 */1723static enum peel_status peel_entry(struct ref_entry *entry, int repeel)1724{1725 enum peel_status status;17261727 if (entry->flag & REF_KNOWS_PEELED) {1728 if (repeel) {1729 entry->flag &= ~REF_KNOWS_PEELED;1730 hashclr(entry->u.value.peeled);1731 } else {1732 return is_null_sha1(entry->u.value.peeled) ?1733 PEEL_NON_TAG : PEEL_PEELED;1734 }1735 }1736 if (entry->flag & REF_ISBROKEN)1737 return PEEL_BROKEN;1738 if (entry->flag & REF_ISSYMREF)1739 return PEEL_IS_SYMREF;17401741 status = peel_object(entry->u.value.sha1, entry->u.value.peeled);1742 if (status == PEEL_PEELED || status == PEEL_NON_TAG)1743 entry->flag |= REF_KNOWS_PEELED;1744 return status;1745}17461747int peel_ref(const char *refname, unsigned char *sha1)1748{1749 int flag;1750 unsigned char base[20];17511752 if (current_ref && (current_ref->name == refname1753 || !strcmp(current_ref->name, refname))) {1754 if (peel_entry(current_ref, 0))1755 return -1;1756 hashcpy(sha1, current_ref->u.value.peeled);1757 return 0;1758 }17591760 if (read_ref_full(refname, RESOLVE_REF_READING, base, &flag))1761 return -1;17621763 /*1764 * If the reference is packed, read its ref_entry from the1765 * cache in the hope that we already know its peeled value.1766 * We only try this optimization on packed references because1767 * (a) forcing the filling of the loose reference cache could1768 * be expensive and (b) loose references anyway usually do not1769 * have REF_KNOWS_PEELED.1770 */1771 if (flag & REF_ISPACKED) {1772 struct ref_entry *r = get_packed_ref(refname);1773 if (r) {1774 if (peel_entry(r, 0))1775 return -1;1776 hashcpy(sha1, r->u.value.peeled);1777 return 0;1778 }1779 }17801781 return peel_object(base, sha1);1782}17831784struct warn_if_dangling_data {1785 FILE *fp;1786 const char *refname;1787 const struct string_list *refnames;1788 const char *msg_fmt;1789};17901791static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,1792 int flags, void *cb_data)1793{1794 struct warn_if_dangling_data *d = cb_data;1795 const char *resolves_to;1796 unsigned char junk[20];17971798 if (!(flags & REF_ISSYMREF))1799 return 0;18001801 resolves_to = resolve_ref_unsafe(refname, 0, junk, NULL);1802 if (!resolves_to1803 || (d->refname1804 ? strcmp(resolves_to, d->refname)1805 : !string_list_has_string(d->refnames, resolves_to))) {1806 return 0;1807 }18081809 fprintf(d->fp, d->msg_fmt, refname);1810 fputc('\n', d->fp);1811 return 0;1812}18131814void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)1815{1816 struct warn_if_dangling_data data;18171818 data.fp = fp;1819 data.refname = refname;1820 data.refnames = NULL;1821 data.msg_fmt = msg_fmt;1822 for_each_rawref(warn_if_dangling_symref, &data);1823}18241825void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)1826{1827 struct warn_if_dangling_data data;18281829 data.fp = fp;1830 data.refname = NULL;1831 data.refnames = refnames;1832 data.msg_fmt = msg_fmt;1833 for_each_rawref(warn_if_dangling_symref, &data);1834}18351836/*1837 * Call fn for each reference in the specified ref_cache, omitting1838 * references not in the containing_dir of base. fn is called for all1839 * references, including broken ones. If fn ever returns a non-zero1840 * value, stop the iteration and return that value; otherwise, return1841 * 0.1842 */1843static int do_for_each_entry(struct ref_cache *refs, const char *base,1844 each_ref_entry_fn fn, void *cb_data)1845{1846 struct packed_ref_cache *packed_ref_cache;1847 struct ref_dir *loose_dir;1848 struct ref_dir *packed_dir;1849 int retval = 0;18501851 /*1852 * We must make sure that all loose refs are read before accessing the1853 * packed-refs file; this avoids a race condition in which loose refs1854 * are migrated to the packed-refs file by a simultaneous process, but1855 * our in-memory view is from before the migration. get_packed_ref_cache()1856 * takes care of making sure our view is up to date with what is on1857 * disk.1858 */1859 loose_dir = get_loose_refs(refs);1860 if (base && *base) {1861 loose_dir = find_containing_dir(loose_dir, base, 0);1862 }1863 if (loose_dir)1864 prime_ref_dir(loose_dir);18651866 packed_ref_cache = get_packed_ref_cache(refs);1867 acquire_packed_ref_cache(packed_ref_cache);1868 packed_dir = get_packed_ref_dir(packed_ref_cache);1869 if (base && *base) {1870 packed_dir = find_containing_dir(packed_dir, base, 0);1871 }18721873 if (packed_dir && loose_dir) {1874 sort_ref_dir(packed_dir);1875 sort_ref_dir(loose_dir);1876 retval = do_for_each_entry_in_dirs(1877 packed_dir, loose_dir, fn, cb_data);1878 } else if (packed_dir) {1879 sort_ref_dir(packed_dir);1880 retval = do_for_each_entry_in_dir(1881 packed_dir, 0, fn, cb_data);1882 } else if (loose_dir) {1883 sort_ref_dir(loose_dir);1884 retval = do_for_each_entry_in_dir(1885 loose_dir, 0, fn, cb_data);1886 }18871888 release_packed_ref_cache(packed_ref_cache);1889 return retval;1890}18911892/*1893 * Call fn for each reference in the specified ref_cache for which the1894 * refname begins with base. If trim is non-zero, then trim that many1895 * characters off the beginning of each refname before passing the1896 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include1897 * broken references in the iteration. If fn ever returns a non-zero1898 * value, stop the iteration and return that value; otherwise, return1899 * 0.1900 */1901static int do_for_each_ref(struct ref_cache *refs, const char *base,1902 each_ref_fn fn, int trim, int flags, void *cb_data)1903{1904 struct ref_entry_cb data;1905 data.base = base;1906 data.trim = trim;1907 data.flags = flags;1908 data.fn = fn;1909 data.cb_data = cb_data;19101911 return do_for_each_entry(refs, base, do_one_ref, &data);1912}19131914static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)1915{1916 unsigned char sha1[20];1917 int flag;19181919 if (submodule) {1920 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)1921 return fn("HEAD", sha1, 0, cb_data);19221923 return 0;1924 }19251926 if (!read_ref_full("HEAD", RESOLVE_REF_READING, sha1, &flag))1927 return fn("HEAD", sha1, flag, cb_data);19281929 return 0;1930}19311932int head_ref(each_ref_fn fn, void *cb_data)1933{1934 return do_head_ref(NULL, fn, cb_data);1935}19361937int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)1938{1939 return do_head_ref(submodule, fn, cb_data);1940}19411942int for_each_ref(each_ref_fn fn, void *cb_data)1943{1944 return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);1945}19461947int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)1948{1949 return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);1950}19511952int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)1953{1954 return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);1955}19561957int for_each_ref_in_submodule(const char *submodule, const char *prefix,1958 each_ref_fn fn, void *cb_data)1959{1960 return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);1961}19621963int for_each_tag_ref(each_ref_fn fn, void *cb_data)1964{1965 return for_each_ref_in("refs/tags/", fn, cb_data);1966}19671968int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)1969{1970 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);1971}19721973int for_each_branch_ref(each_ref_fn fn, void *cb_data)1974{1975 return for_each_ref_in("refs/heads/", fn, cb_data);1976}19771978int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)1979{1980 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);1981}19821983int for_each_remote_ref(each_ref_fn fn, void *cb_data)1984{1985 return for_each_ref_in("refs/remotes/", fn, cb_data);1986}19871988int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)1989{1990 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);1991}19921993int for_each_replace_ref(each_ref_fn fn, void *cb_data)1994{1995 return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);1996}19971998int head_ref_namespaced(each_ref_fn fn, void *cb_data)1999{2000 struct strbuf buf = STRBUF_INIT;2001 int ret = 0;2002 unsigned char sha1[20];2003 int flag;20042005 strbuf_addf(&buf, "%sHEAD", get_git_namespace());2006 if (!read_ref_full(buf.buf, RESOLVE_REF_READING, sha1, &flag))2007 ret = fn(buf.buf, sha1, flag, cb_data);2008 strbuf_release(&buf);20092010 return ret;2011}20122013int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)2014{2015 struct strbuf buf = STRBUF_INIT;2016 int ret;2017 strbuf_addf(&buf, "%srefs/", get_git_namespace());2018 ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);2019 strbuf_release(&buf);2020 return ret;2021}20222023int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,2024 const char *prefix, void *cb_data)2025{2026 struct strbuf real_pattern = STRBUF_INIT;2027 struct ref_filter filter;2028 int ret;20292030 if (!prefix && !starts_with(pattern, "refs/"))2031 strbuf_addstr(&real_pattern, "refs/");2032 else if (prefix)2033 strbuf_addstr(&real_pattern, prefix);2034 strbuf_addstr(&real_pattern, pattern);20352036 if (!has_glob_specials(pattern)) {2037 /* Append implied '/' '*' if not present. */2038 if (real_pattern.buf[real_pattern.len - 1] != '/')2039 strbuf_addch(&real_pattern, '/');2040 /* No need to check for '*', there is none. */2041 strbuf_addch(&real_pattern, '*');2042 }20432044 filter.pattern = real_pattern.buf;2045 filter.fn = fn;2046 filter.cb_data = cb_data;2047 ret = for_each_ref(filter_refs, &filter);20482049 strbuf_release(&real_pattern);2050 return ret;2051}20522053int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)2054{2055 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);2056}20572058int for_each_rawref(each_ref_fn fn, void *cb_data)2059{2060 return do_for_each_ref(&ref_cache, "", fn, 0,2061 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);2062}20632064const char *prettify_refname(const char *name)2065{2066 return name + (2067 starts_with(name, "refs/heads/") ? 11 :2068 starts_with(name, "refs/tags/") ? 10 :2069 starts_with(name, "refs/remotes/") ? 13 :2070 0);2071}20722073static const char *ref_rev_parse_rules[] = {2074 "%.*s",2075 "refs/%.*s",2076 "refs/tags/%.*s",2077 "refs/heads/%.*s",2078 "refs/remotes/%.*s",2079 "refs/remotes/%.*s/HEAD",2080 NULL2081};20822083int refname_match(const char *abbrev_name, const char *full_name)2084{2085 const char **p;2086 const int abbrev_name_len = strlen(abbrev_name);20872088 for (p = ref_rev_parse_rules; *p; p++) {2089 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {2090 return 1;2091 }2092 }20932094 return 0;2095}20962097/* This function should make sure errno is meaningful on error */2098static struct ref_lock *verify_lock(struct ref_lock *lock,2099 const unsigned char *old_sha1, int mustexist)2100{2101 if (read_ref_full(lock->ref_name,2102 mustexist ? RESOLVE_REF_READING : 0,2103 lock->old_sha1, NULL)) {2104 int save_errno = errno;2105 error("Can't verify ref %s", lock->ref_name);2106 unlock_ref(lock);2107 errno = save_errno;2108 return NULL;2109 }2110 if (hashcmp(lock->old_sha1, old_sha1)) {2111 error("Ref %s is at %s but expected %s", lock->ref_name,2112 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));2113 unlock_ref(lock);2114 errno = EBUSY;2115 return NULL;2116 }2117 return lock;2118}21192120static int remove_empty_directories(const char *file)2121{2122 /* we want to create a file but there is a directory there;2123 * if that is an empty directory (or a directory that contains2124 * only empty directories), remove them.2125 */2126 struct strbuf path;2127 int result, save_errno;21282129 strbuf_init(&path, 20);2130 strbuf_addstr(&path, file);21312132 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);2133 save_errno = errno;21342135 strbuf_release(&path);2136 errno = save_errno;21372138 return result;2139}21402141/*2142 * *string and *len will only be substituted, and *string returned (for2143 * later free()ing) if the string passed in is a magic short-hand form2144 * to name a branch.2145 */2146static char *substitute_branch_name(const char **string, int *len)2147{2148 struct strbuf buf = STRBUF_INIT;2149 int ret = interpret_branch_name(*string, *len, &buf);21502151 if (ret == *len) {2152 size_t size;2153 *string = strbuf_detach(&buf, &size);2154 *len = size;2155 return (char *)*string;2156 }21572158 return NULL;2159}21602161int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)2162{2163 char *last_branch = substitute_branch_name(&str, &len);2164 const char **p, *r;2165 int refs_found = 0;21662167 *ref = NULL;2168 for (p = ref_rev_parse_rules; *p; p++) {2169 char fullref[PATH_MAX];2170 unsigned char sha1_from_ref[20];2171 unsigned char *this_result;2172 int flag;21732174 this_result = refs_found ? sha1_from_ref : sha1;2175 mksnpath(fullref, sizeof(fullref), *p, len, str);2176 r = resolve_ref_unsafe(fullref, RESOLVE_REF_READING,2177 this_result, &flag);2178 if (r) {2179 if (!refs_found++)2180 *ref = xstrdup(r);2181 if (!warn_ambiguous_refs)2182 break;2183 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {2184 warning("ignoring dangling symref %s.", fullref);2185 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {2186 warning("ignoring broken ref %s.", fullref);2187 }2188 }2189 free(last_branch);2190 return refs_found;2191}21922193int dwim_log(const char *str, int len, unsigned char *sha1, char **log)2194{2195 char *last_branch = substitute_branch_name(&str, &len);2196 const char **p;2197 int logs_found = 0;21982199 *log = NULL;2200 for (p = ref_rev_parse_rules; *p; p++) {2201 unsigned char hash[20];2202 char path[PATH_MAX];2203 const char *ref, *it;22042205 mksnpath(path, sizeof(path), *p, len, str);2206 ref = resolve_ref_unsafe(path, RESOLVE_REF_READING,2207 hash, NULL);2208 if (!ref)2209 continue;2210 if (reflog_exists(path))2211 it = path;2212 else if (strcmp(ref, path) && reflog_exists(ref))2213 it = ref;2214 else2215 continue;2216 if (!logs_found++) {2217 *log = xstrdup(it);2218 hashcpy(sha1, hash);2219 }2220 if (!warn_ambiguous_refs)2221 break;2222 }2223 free(last_branch);2224 return logs_found;2225}22262227/*2228 * Locks a ref returning the lock on success and NULL on failure.2229 * On failure errno is set to something meaningful.2230 */2231static struct ref_lock *lock_ref_sha1_basic(const char *refname,2232 const unsigned char *old_sha1,2233 const struct string_list *skip,2234 int flags, int *type_p)2235{2236 char *ref_file;2237 const char *orig_refname = refname;2238 struct ref_lock *lock;2239 int last_errno = 0;2240 int type, lflags;2241 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));2242 int resolve_flags = 0;2243 int missing = 0;2244 int attempts_remaining = 3;22452246 lock = xcalloc(1, sizeof(struct ref_lock));2247 lock->lock_fd = -1;22482249 if (mustexist)2250 resolve_flags |= RESOLVE_REF_READING;2251 if (flags & REF_DELETING) {2252 resolve_flags |= RESOLVE_REF_ALLOW_BAD_NAME;2253 if (flags & REF_NODEREF)2254 resolve_flags |= RESOLVE_REF_NO_RECURSE;2255 }22562257 refname = resolve_ref_unsafe(refname, resolve_flags,2258 lock->old_sha1, &type);2259 if (!refname && errno == EISDIR) {2260 /* we are trying to lock foo but we used to2261 * have foo/bar which now does not exist;2262 * it is normal for the empty directory 'foo'2263 * to remain.2264 */2265 ref_file = git_path("%s", orig_refname);2266 if (remove_empty_directories(ref_file)) {2267 last_errno = errno;2268 error("there are still refs under '%s'", orig_refname);2269 goto error_return;2270 }2271 refname = resolve_ref_unsafe(orig_refname, resolve_flags,2272 lock->old_sha1, &type);2273 }2274 if (type_p)2275 *type_p = type;2276 if (!refname) {2277 last_errno = errno;2278 error("unable to resolve reference %s: %s",2279 orig_refname, strerror(errno));2280 goto error_return;2281 }2282 missing = is_null_sha1(lock->old_sha1);2283 /* When the ref did not exist and we are creating it,2284 * make sure there is no existing ref that is packed2285 * whose name begins with our refname, nor a ref whose2286 * name is a proper prefix of our refname.2287 */2288 if (missing &&2289 !is_refname_available(refname, skip, get_packed_refs(&ref_cache))) {2290 last_errno = ENOTDIR;2291 goto error_return;2292 }22932294 lock->lk = xcalloc(1, sizeof(struct lock_file));22952296 lflags = 0;2297 if (flags & REF_NODEREF) {2298 refname = orig_refname;2299 lflags |= LOCK_NO_DEREF;2300 }2301 lock->ref_name = xstrdup(refname);2302 lock->orig_ref_name = xstrdup(orig_refname);2303 ref_file = git_path("%s", refname);2304 if (missing)2305 lock->force_write = 1;2306 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))2307 lock->force_write = 1;23082309 retry:2310 switch (safe_create_leading_directories(ref_file)) {2311 case SCLD_OK:2312 break; /* success */2313 case SCLD_VANISHED:2314 if (--attempts_remaining > 0)2315 goto retry;2316 /* fall through */2317 default:2318 last_errno = errno;2319 error("unable to create directory for %s", ref_file);2320 goto error_return;2321 }23222323 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);2324 if (lock->lock_fd < 0) {2325 if (errno == ENOENT && --attempts_remaining > 0)2326 /*2327 * Maybe somebody just deleted one of the2328 * directories leading to ref_file. Try2329 * again:2330 */2331 goto retry;2332 else2333 unable_to_lock_die(ref_file, errno);2334 }2335 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;23362337 error_return:2338 unlock_ref(lock);2339 errno = last_errno;2340 return NULL;2341}23422343struct ref_lock *lock_any_ref_for_update(const char *refname,2344 const unsigned char *old_sha1,2345 int flags, int *type_p)2346{2347 return lock_ref_sha1_basic(refname, old_sha1, NULL, flags, type_p);2348}23492350/*2351 * Write an entry to the packed-refs file for the specified refname.2352 * If peeled is non-NULL, write it as the entry's peeled value.2353 */2354static void write_packed_entry(FILE *fh, char *refname, unsigned char *sha1,2355 unsigned char *peeled)2356{2357 fprintf_or_die(fh, "%s %s\n", sha1_to_hex(sha1), refname);2358 if (peeled)2359 fprintf_or_die(fh, "^%s\n", sha1_to_hex(peeled));2360}23612362/*2363 * An each_ref_entry_fn that writes the entry to a packed-refs file.2364 */2365static int write_packed_entry_fn(struct ref_entry *entry, void *cb_data)2366{2367 enum peel_status peel_status = peel_entry(entry, 0);23682369 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)2370 error("internal error: %s is not a valid packed reference!",2371 entry->name);2372 write_packed_entry(cb_data, entry->name, entry->u.value.sha1,2373 peel_status == PEEL_PEELED ?2374 entry->u.value.peeled : NULL);2375 return 0;2376}23772378/* This should return a meaningful errno on failure */2379int lock_packed_refs(int flags)2380{2381 struct packed_ref_cache *packed_ref_cache;23822383 if (hold_lock_file_for_update(&packlock, git_path("packed-refs"), flags) < 0)2384 return -1;2385 /*2386 * Get the current packed-refs while holding the lock. If the2387 * packed-refs file has been modified since we last read it,2388 * this will automatically invalidate the cache and re-read2389 * the packed-refs file.2390 */2391 packed_ref_cache = get_packed_ref_cache(&ref_cache);2392 packed_ref_cache->lock = &packlock;2393 /* Increment the reference count to prevent it from being freed: */2394 acquire_packed_ref_cache(packed_ref_cache);2395 return 0;2396}23972398/*2399 * Commit the packed refs changes.2400 * On error we must make sure that errno contains a meaningful value.2401 */2402int commit_packed_refs(void)2403{2404 struct packed_ref_cache *packed_ref_cache =2405 get_packed_ref_cache(&ref_cache);2406 int error = 0;2407 int save_errno = 0;2408 FILE *out;24092410 if (!packed_ref_cache->lock)2411 die("internal error: packed-refs not locked");24122413 out = fdopen_lock_file(packed_ref_cache->lock, "w");2414 if (!out)2415 die_errno("unable to fdopen packed-refs descriptor");24162417 fprintf_or_die(out, "%s", PACKED_REFS_HEADER);2418 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),2419 0, write_packed_entry_fn, out);24202421 if (commit_lock_file(packed_ref_cache->lock)) {2422 save_errno = errno;2423 error = -1;2424 }2425 packed_ref_cache->lock = NULL;2426 release_packed_ref_cache(packed_ref_cache);2427 errno = save_errno;2428 return error;2429}24302431void rollback_packed_refs(void)2432{2433 struct packed_ref_cache *packed_ref_cache =2434 get_packed_ref_cache(&ref_cache);24352436 if (!packed_ref_cache->lock)2437 die("internal error: packed-refs not locked");2438 rollback_lock_file(packed_ref_cache->lock);2439 packed_ref_cache->lock = NULL;2440 release_packed_ref_cache(packed_ref_cache);2441 clear_packed_ref_cache(&ref_cache);2442}24432444struct ref_to_prune {2445 struct ref_to_prune *next;2446 unsigned char sha1[20];2447 char name[FLEX_ARRAY];2448};24492450struct pack_refs_cb_data {2451 unsigned int flags;2452 struct ref_dir *packed_refs;2453 struct ref_to_prune *ref_to_prune;2454};24552456/*2457 * An each_ref_entry_fn that is run over loose references only. If2458 * the loose reference can be packed, add an entry in the packed ref2459 * cache. If the reference should be pruned, also add it to2460 * ref_to_prune in the pack_refs_cb_data.2461 */2462static int pack_if_possible_fn(struct ref_entry *entry, void *cb_data)2463{2464 struct pack_refs_cb_data *cb = cb_data;2465 enum peel_status peel_status;2466 struct ref_entry *packed_entry;2467 int is_tag_ref = starts_with(entry->name, "refs/tags/");24682469 /* ALWAYS pack tags */2470 if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)2471 return 0;24722473 /* Do not pack symbolic or broken refs: */2474 if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))2475 return 0;24762477 /* Add a packed ref cache entry equivalent to the loose entry. */2478 peel_status = peel_entry(entry, 1);2479 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)2480 die("internal error peeling reference %s (%s)",2481 entry->name, sha1_to_hex(entry->u.value.sha1));2482 packed_entry = find_ref(cb->packed_refs, entry->name);2483 if (packed_entry) {2484 /* Overwrite existing packed entry with info from loose entry */2485 packed_entry->flag = REF_ISPACKED | REF_KNOWS_PEELED;2486 hashcpy(packed_entry->u.value.sha1, entry->u.value.sha1);2487 } else {2488 packed_entry = create_ref_entry(entry->name, entry->u.value.sha1,2489 REF_ISPACKED | REF_KNOWS_PEELED, 0);2490 add_ref(cb->packed_refs, packed_entry);2491 }2492 hashcpy(packed_entry->u.value.peeled, entry->u.value.peeled);24932494 /* Schedule the loose reference for pruning if requested. */2495 if ((cb->flags & PACK_REFS_PRUNE)) {2496 int namelen = strlen(entry->name) + 1;2497 struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);2498 hashcpy(n->sha1, entry->u.value.sha1);2499 strcpy(n->name, entry->name);2500 n->next = cb->ref_to_prune;2501 cb->ref_to_prune = n;2502 }2503 return 0;2504}25052506/*2507 * Remove empty parents, but spare refs/ and immediate subdirs.2508 * Note: munges *name.2509 */2510static void try_remove_empty_parents(char *name)2511{2512 char *p, *q;2513 int i;2514 p = name;2515 for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */2516 while (*p && *p != '/')2517 p++;2518 /* tolerate duplicate slashes; see check_refname_format() */2519 while (*p == '/')2520 p++;2521 }2522 for (q = p; *q; q++)2523 ;2524 while (1) {2525 while (q > p && *q != '/')2526 q--;2527 while (q > p && *(q-1) == '/')2528 q--;2529 if (q == p)2530 break;2531 *q = '\0';2532 if (rmdir(git_path("%s", name)))2533 break;2534 }2535}25362537/* make sure nobody touched the ref, and unlink */2538static void prune_ref(struct ref_to_prune *r)2539{2540 struct ref_transaction *transaction;2541 struct strbuf err = STRBUF_INIT;25422543 if (check_refname_format(r->name, 0))2544 return;25452546 transaction = ref_transaction_begin(&err);2547 if (!transaction ||2548 ref_transaction_delete(transaction, r->name, r->sha1,2549 REF_ISPRUNING, 1, NULL, &err) ||2550 ref_transaction_commit(transaction, &err)) {2551 ref_transaction_free(transaction);2552 error("%s", err.buf);2553 strbuf_release(&err);2554 return;2555 }2556 ref_transaction_free(transaction);2557 strbuf_release(&err);2558 try_remove_empty_parents(r->name);2559}25602561static void prune_refs(struct ref_to_prune *r)2562{2563 while (r) {2564 prune_ref(r);2565 r = r->next;2566 }2567}25682569int pack_refs(unsigned int flags)2570{2571 struct pack_refs_cb_data cbdata;25722573 memset(&cbdata, 0, sizeof(cbdata));2574 cbdata.flags = flags;25752576 lock_packed_refs(LOCK_DIE_ON_ERROR);2577 cbdata.packed_refs = get_packed_refs(&ref_cache);25782579 do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,2580 pack_if_possible_fn, &cbdata);25812582 if (commit_packed_refs())2583 die_errno("unable to overwrite old ref-pack file");25842585 prune_refs(cbdata.ref_to_prune);2586 return 0;2587}25882589/*2590 * If entry is no longer needed in packed-refs, add it to the string2591 * list pointed to by cb_data. Reasons for deleting entries:2592 *2593 * - Entry is broken.2594 * - Entry is overridden by a loose ref.2595 * - Entry does not point at a valid object.2596 *2597 * In the first and third cases, also emit an error message because these2598 * are indications of repository corruption.2599 */2600static int curate_packed_ref_fn(struct ref_entry *entry, void *cb_data)2601{2602 struct string_list *refs_to_delete = cb_data;26032604 if (entry->flag & REF_ISBROKEN) {2605 /* This shouldn't happen to packed refs. */2606 error("%s is broken!", entry->name);2607 string_list_append(refs_to_delete, entry->name);2608 return 0;2609 }2610 if (!has_sha1_file(entry->u.value.sha1)) {2611 unsigned char sha1[20];2612 int flags;26132614 if (read_ref_full(entry->name, 0, sha1, &flags))2615 /* We should at least have found the packed ref. */2616 die("Internal error");2617 if ((flags & REF_ISSYMREF) || !(flags & REF_ISPACKED)) {2618 /*2619 * This packed reference is overridden by a2620 * loose reference, so it is OK that its value2621 * is no longer valid; for example, it might2622 * refer to an object that has been garbage2623 * collected. For this purpose we don't even2624 * care whether the loose reference itself is2625 * invalid, broken, symbolic, etc. Silently2626 * remove the packed reference.2627 */2628 string_list_append(refs_to_delete, entry->name);2629 return 0;2630 }2631 /*2632 * There is no overriding loose reference, so the fact2633 * that this reference doesn't refer to a valid object2634 * indicates some kind of repository corruption.2635 * Report the problem, then omit the reference from2636 * the output.2637 */2638 error("%s does not point to a valid object!", entry->name);2639 string_list_append(refs_to_delete, entry->name);2640 return 0;2641 }26422643 return 0;2644}26452646int repack_without_refs(const char **refnames, int n, struct strbuf *err)2647{2648 struct ref_dir *packed;2649 struct string_list refs_to_delete = STRING_LIST_INIT_DUP;2650 struct string_list_item *ref_to_delete;2651 int i, ret, removed = 0;26522653 assert(err);26542655 /* Look for a packed ref */2656 for (i = 0; i < n; i++)2657 if (get_packed_ref(refnames[i]))2658 break;26592660 /* Avoid locking if we have nothing to do */2661 if (i == n)2662 return 0; /* no refname exists in packed refs */26632664 if (lock_packed_refs(0)) {2665 unable_to_lock_message(git_path("packed-refs"), errno, err);2666 return -1;2667 }2668 packed = get_packed_refs(&ref_cache);26692670 /* Remove refnames from the cache */2671 for (i = 0; i < n; i++)2672 if (remove_entry(packed, refnames[i]) != -1)2673 removed = 1;2674 if (!removed) {2675 /*2676 * All packed entries disappeared while we were2677 * acquiring the lock.2678 */2679 rollback_packed_refs();2680 return 0;2681 }26822683 /* Remove any other accumulated cruft */2684 do_for_each_entry_in_dir(packed, 0, curate_packed_ref_fn, &refs_to_delete);2685 for_each_string_list_item(ref_to_delete, &refs_to_delete) {2686 if (remove_entry(packed, ref_to_delete->string) == -1)2687 die("internal error");2688 }26892690 /* Write what remains */2691 ret = commit_packed_refs();2692 if (ret)2693 strbuf_addf(err, "unable to overwrite old ref-pack file: %s",2694 strerror(errno));2695 return ret;2696}26972698static int delete_ref_loose(struct ref_lock *lock, int flag, struct strbuf *err)2699{2700 assert(err);27012702 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {2703 /*2704 * loose. The loose file name is the same as the2705 * lockfile name, minus ".lock":2706 */2707 char *loose_filename = get_locked_file_path(lock->lk);2708 int res = unlink_or_msg(loose_filename, err);2709 free(loose_filename);2710 if (res)2711 return 1;2712 }2713 return 0;2714}27152716int delete_ref(const char *refname, const unsigned char *sha1, int delopt)2717{2718 struct ref_transaction *transaction;2719 struct strbuf err = STRBUF_INIT;27202721 transaction = ref_transaction_begin(&err);2722 if (!transaction ||2723 ref_transaction_delete(transaction, refname, sha1, delopt,2724 sha1 && !is_null_sha1(sha1), NULL, &err) ||2725 ref_transaction_commit(transaction, &err)) {2726 error("%s", err.buf);2727 ref_transaction_free(transaction);2728 strbuf_release(&err);2729 return 1;2730 }2731 ref_transaction_free(transaction);2732 strbuf_release(&err);2733 return 0;2734}27352736/*2737 * People using contrib's git-new-workdir have .git/logs/refs ->2738 * /some/other/path/.git/logs/refs, and that may live on another device.2739 *2740 * IOW, to avoid cross device rename errors, the temporary renamed log must2741 * live into logs/refs.2742 */2743#define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"27442745static int rename_tmp_log(const char *newrefname)2746{2747 int attempts_remaining = 4;27482749 retry:2750 switch (safe_create_leading_directories(git_path("logs/%s", newrefname))) {2751 case SCLD_OK:2752 break; /* success */2753 case SCLD_VANISHED:2754 if (--attempts_remaining > 0)2755 goto retry;2756 /* fall through */2757 default:2758 error("unable to create directory for %s", newrefname);2759 return -1;2760 }27612762 if (rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {2763 if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {2764 /*2765 * rename(a, b) when b is an existing2766 * directory ought to result in ISDIR, but2767 * Solaris 5.8 gives ENOTDIR. Sheesh.2768 */2769 if (remove_empty_directories(git_path("logs/%s", newrefname))) {2770 error("Directory not empty: logs/%s", newrefname);2771 return -1;2772 }2773 goto retry;2774 } else if (errno == ENOENT && --attempts_remaining > 0) {2775 /*2776 * Maybe another process just deleted one of2777 * the directories in the path to newrefname.2778 * Try again from the beginning.2779 */2780 goto retry;2781 } else {2782 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",2783 newrefname, strerror(errno));2784 return -1;2785 }2786 }2787 return 0;2788}27892790static int rename_ref_available(const char *oldname, const char *newname)2791{2792 struct string_list skip = STRING_LIST_INIT_NODUP;2793 int ret;27942795 string_list_insert(&skip, oldname);2796 ret = is_refname_available(newname, &skip, get_packed_refs(&ref_cache))2797 && is_refname_available(newname, &skip, get_loose_refs(&ref_cache));2798 string_list_clear(&skip, 0);2799 return ret;2800}28012802static int write_ref_to_lockfile(struct ref_lock *lock, const unsigned char *sha1);2803static int commit_ref_update(struct ref_lock *lock,2804 const unsigned char *sha1, const char *logmsg);28052806int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)2807{2808 unsigned char sha1[20], orig_sha1[20];2809 int flag = 0, logmoved = 0;2810 struct ref_lock *lock;2811 struct stat loginfo;2812 int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);2813 const char *symref = NULL;28142815 if (log && S_ISLNK(loginfo.st_mode))2816 return error("reflog for %s is a symlink", oldrefname);28172818 symref = resolve_ref_unsafe(oldrefname, RESOLVE_REF_READING,2819 orig_sha1, &flag);2820 if (flag & REF_ISSYMREF)2821 return error("refname %s is a symbolic ref, renaming it is not supported",2822 oldrefname);2823 if (!symref)2824 return error("refname %s not found", oldrefname);28252826 if (!rename_ref_available(oldrefname, newrefname))2827 return 1;28282829 if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))2830 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",2831 oldrefname, strerror(errno));28322833 if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {2834 error("unable to delete old %s", oldrefname);2835 goto rollback;2836 }28372838 if (!read_ref_full(newrefname, RESOLVE_REF_READING, sha1, NULL) &&2839 delete_ref(newrefname, sha1, REF_NODEREF)) {2840 if (errno==EISDIR) {2841 if (remove_empty_directories(git_path("%s", newrefname))) {2842 error("Directory not empty: %s", newrefname);2843 goto rollback;2844 }2845 } else {2846 error("unable to delete existing %s", newrefname);2847 goto rollback;2848 }2849 }28502851 if (log && rename_tmp_log(newrefname))2852 goto rollback;28532854 logmoved = log;28552856 lock = lock_ref_sha1_basic(newrefname, NULL, NULL, 0, NULL);2857 if (!lock) {2858 error("unable to lock %s for update", newrefname);2859 goto rollback;2860 }2861 lock->force_write = 1;2862 hashcpy(lock->old_sha1, orig_sha1);28632864 if (write_ref_to_lockfile(lock, orig_sha1) ||2865 commit_ref_update(lock, orig_sha1, logmsg)) {2866 error("unable to write current sha1 into %s", newrefname);2867 goto rollback;2868 }28692870 return 0;28712872 rollback:2873 lock = lock_ref_sha1_basic(oldrefname, NULL, NULL, 0, NULL);2874 if (!lock) {2875 error("unable to lock %s for rollback", oldrefname);2876 goto rollbacklog;2877 }28782879 lock->force_write = 1;2880 flag = log_all_ref_updates;2881 log_all_ref_updates = 0;2882 if (write_ref_to_lockfile(lock, orig_sha1) ||2883 commit_ref_update(lock, orig_sha1, NULL))2884 error("unable to write current sha1 into %s", oldrefname);2885 log_all_ref_updates = flag;28862887 rollbacklog:2888 if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))2889 error("unable to restore logfile %s from %s: %s",2890 oldrefname, newrefname, strerror(errno));2891 if (!logmoved && log &&2892 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))2893 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",2894 oldrefname, strerror(errno));28952896 return 1;2897}28982899int close_ref(struct ref_lock *lock)2900{2901 if (close_lock_file(lock->lk))2902 return -1;2903 lock->lock_fd = -1;2904 return 0;2905}29062907int commit_ref(struct ref_lock *lock)2908{2909 if (commit_lock_file(lock->lk))2910 return -1;2911 lock->lock_fd = -1;2912 return 0;2913}29142915void unlock_ref(struct ref_lock *lock)2916{2917 /* Do not free lock->lk -- atexit() still looks at them */2918 if (lock->lk)2919 rollback_lock_file(lock->lk);2920 free(lock->ref_name);2921 free(lock->orig_ref_name);2922 free(lock);2923}29242925/*2926 * copy the reflog message msg to buf, which has been allocated sufficiently2927 * large, while cleaning up the whitespaces. Especially, convert LF to space,2928 * because reflog file is one line per entry.2929 */2930static int copy_msg(char *buf, const char *msg)2931{2932 char *cp = buf;2933 char c;2934 int wasspace = 1;29352936 *cp++ = '\t';2937 while ((c = *msg++)) {2938 if (wasspace && isspace(c))2939 continue;2940 wasspace = isspace(c);2941 if (wasspace)2942 c = ' ';2943 *cp++ = c;2944 }2945 while (buf < cp && isspace(cp[-1]))2946 cp--;2947 *cp++ = '\n';2948 return cp - buf;2949}29502951/* This function must set a meaningful errno on failure */2952int log_ref_setup(const char *refname, char *logfile, int bufsize)2953{2954 int logfd, oflags = O_APPEND | O_WRONLY;29552956 git_snpath(logfile, bufsize, "logs/%s", refname);2957 if (log_all_ref_updates &&2958 (starts_with(refname, "refs/heads/") ||2959 starts_with(refname, "refs/remotes/") ||2960 starts_with(refname, "refs/notes/") ||2961 !strcmp(refname, "HEAD"))) {2962 if (safe_create_leading_directories(logfile) < 0) {2963 int save_errno = errno;2964 error("unable to create directory for %s", logfile);2965 errno = save_errno;2966 return -1;2967 }2968 oflags |= O_CREAT;2969 }29702971 logfd = open(logfile, oflags, 0666);2972 if (logfd < 0) {2973 if (!(oflags & O_CREAT) && (errno == ENOENT || errno == EISDIR))2974 return 0;29752976 if (errno == EISDIR) {2977 if (remove_empty_directories(logfile)) {2978 int save_errno = errno;2979 error("There are still logs under '%s'",2980 logfile);2981 errno = save_errno;2982 return -1;2983 }2984 logfd = open(logfile, oflags, 0666);2985 }29862987 if (logfd < 0) {2988 int save_errno = errno;2989 error("Unable to append to %s: %s", logfile,2990 strerror(errno));2991 errno = save_errno;2992 return -1;2993 }2994 }29952996 adjust_shared_perm(logfile);2997 close(logfd);2998 return 0;2999}30003001static int log_ref_write(const char *refname, const unsigned char *old_sha1,3002 const unsigned char *new_sha1, const char *msg)3003{3004 int logfd, result, written, oflags = O_APPEND | O_WRONLY;3005 unsigned maxlen, len;3006 int msglen;3007 char log_file[PATH_MAX];3008 char *logrec;3009 const char *committer;30103011 if (log_all_ref_updates < 0)3012 log_all_ref_updates = !is_bare_repository();30133014 result = log_ref_setup(refname, log_file, sizeof(log_file));3015 if (result)3016 return result;30173018 logfd = open(log_file, oflags);3019 if (logfd < 0)3020 return 0;3021 msglen = msg ? strlen(msg) : 0;3022 committer = git_committer_info(0);3023 maxlen = strlen(committer) + msglen + 100;3024 logrec = xmalloc(maxlen);3025 len = sprintf(logrec, "%s %s %s\n",3026 sha1_to_hex(old_sha1),3027 sha1_to_hex(new_sha1),3028 committer);3029 if (msglen)3030 len += copy_msg(logrec + len - 1, msg) - 1;3031 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;3032 free(logrec);3033 if (written != len) {3034 int save_errno = errno;3035 close(logfd);3036 error("Unable to append to %s", log_file);3037 errno = save_errno;3038 return -1;3039 }3040 if (close(logfd)) {3041 int save_errno = errno;3042 error("Unable to append to %s", log_file);3043 errno = save_errno;3044 return -1;3045 }3046 return 0;3047}30483049int is_branch(const char *refname)3050{3051 return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");3052}30533054/*3055 * Write sha1 into the open lockfile, then close the lockfile. On3056 * errors, rollback the lockfile and set errno to reflect the problem.3057 */3058static int write_ref_to_lockfile(struct ref_lock *lock,3059 const unsigned char *sha1)3060{3061 static char term = '\n';3062 struct object *o;30633064 o = parse_object(sha1);3065 if (!o) {3066 error("Trying to write ref %s with nonexistent object %s",3067 lock->ref_name, sha1_to_hex(sha1));3068 unlock_ref(lock);3069 errno = EINVAL;3070 return -1;3071 }3072 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {3073 error("Trying to write non-commit object %s to branch %s",3074 sha1_to_hex(sha1), lock->ref_name);3075 unlock_ref(lock);3076 errno = EINVAL;3077 return -1;3078 }3079 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||3080 write_in_full(lock->lock_fd, &term, 1) != 1 ||3081 close_ref(lock) < 0) {3082 int save_errno = errno;3083 error("Couldn't write %s", lock->lk->filename.buf);3084 unlock_ref(lock);3085 errno = save_errno;3086 return -1;3087 }3088 return 0;3089}30903091/*3092 * Commit a change to a loose reference that has already been written3093 * to the loose reference lockfile. Also update the reflogs if3094 * necessary, using the specified lockmsg (which can be NULL).3095 */3096static int commit_ref_update(struct ref_lock *lock,3097 const unsigned char *sha1, const char *logmsg)3098{3099 clear_loose_ref_cache(&ref_cache);3100 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||3101 (strcmp(lock->ref_name, lock->orig_ref_name) &&3102 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {3103 unlock_ref(lock);3104 return -1;3105 }3106 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {3107 /*3108 * Special hack: If a branch is updated directly and HEAD3109 * points to it (may happen on the remote side of a push3110 * for example) then logically the HEAD reflog should be3111 * updated too.3112 * A generic solution implies reverse symref information,3113 * but finding all symrefs pointing to the given branch3114 * would be rather costly for this rare event (the direct3115 * update of a branch) to be worth it. So let's cheat and3116 * check with HEAD only which should cover 99% of all usage3117 * scenarios (even 100% of the default ones).3118 */3119 unsigned char head_sha1[20];3120 int head_flag;3121 const char *head_ref;3122 head_ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,3123 head_sha1, &head_flag);3124 if (head_ref && (head_flag & REF_ISSYMREF) &&3125 !strcmp(head_ref, lock->ref_name))3126 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);3127 }3128 if (commit_ref(lock)) {3129 error("Couldn't set %s", lock->ref_name);3130 unlock_ref(lock);3131 return -1;3132 }3133 unlock_ref(lock);3134 return 0;3135}31363137/*3138 * Write sha1 as the new value of the reference specified by the3139 * (open) lock. On error, roll back the lockfile and set errno3140 * appropriately.3141 */3142static int write_ref_sha1(struct ref_lock *lock,3143 const unsigned char *sha1, const char *logmsg)3144{3145 if (!lock) {3146 errno = EINVAL;3147 return -1;3148 }3149 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {3150 unlock_ref(lock);3151 return 0;3152 }31533154 if (write_ref_to_lockfile(lock, sha1) ||3155 commit_ref_update(lock, sha1, logmsg))3156 return -1;31573158 return 0;3159}31603161int create_symref(const char *ref_target, const char *refs_heads_master,3162 const char *logmsg)3163{3164 const char *lockpath;3165 char ref[1000];3166 int fd, len, written;3167 char *git_HEAD = git_pathdup("%s", ref_target);3168 unsigned char old_sha1[20], new_sha1[20];31693170 if (logmsg && read_ref(ref_target, old_sha1))3171 hashclr(old_sha1);31723173 if (safe_create_leading_directories(git_HEAD) < 0)3174 return error("unable to create directory for %s", git_HEAD);31753176#ifndef NO_SYMLINK_HEAD3177 if (prefer_symlink_refs) {3178 unlink(git_HEAD);3179 if (!symlink(refs_heads_master, git_HEAD))3180 goto done;3181 fprintf(stderr, "no symlink - falling back to symbolic ref\n");3182 }3183#endif31843185 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);3186 if (sizeof(ref) <= len) {3187 error("refname too long: %s", refs_heads_master);3188 goto error_free_return;3189 }3190 lockpath = mkpath("%s.lock", git_HEAD);3191 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);3192 if (fd < 0) {3193 error("Unable to open %s for writing", lockpath);3194 goto error_free_return;3195 }3196 written = write_in_full(fd, ref, len);3197 if (close(fd) != 0 || written != len) {3198 error("Unable to write to %s", lockpath);3199 goto error_unlink_return;3200 }3201 if (rename(lockpath, git_HEAD) < 0) {3202 error("Unable to create %s", git_HEAD);3203 goto error_unlink_return;3204 }3205 if (adjust_shared_perm(git_HEAD)) {3206 error("Unable to fix permissions on %s", lockpath);3207 error_unlink_return:3208 unlink_or_warn(lockpath);3209 error_free_return:3210 free(git_HEAD);3211 return -1;3212 }32133214#ifndef NO_SYMLINK_HEAD3215 done:3216#endif3217 if (logmsg && !read_ref(refs_heads_master, new_sha1))3218 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);32193220 free(git_HEAD);3221 return 0;3222}32233224struct read_ref_at_cb {3225 const char *refname;3226 unsigned long at_time;3227 int cnt;3228 int reccnt;3229 unsigned char *sha1;3230 int found_it;32313232 unsigned char osha1[20];3233 unsigned char nsha1[20];3234 int tz;3235 unsigned long date;3236 char **msg;3237 unsigned long *cutoff_time;3238 int *cutoff_tz;3239 int *cutoff_cnt;3240};32413242static int read_ref_at_ent(unsigned char *osha1, unsigned char *nsha1,3243 const char *email, unsigned long timestamp, int tz,3244 const char *message, void *cb_data)3245{3246 struct read_ref_at_cb *cb = cb_data;32473248 cb->reccnt++;3249 cb->tz = tz;3250 cb->date = timestamp;32513252 if (timestamp <= cb->at_time || cb->cnt == 0) {3253 if (cb->msg)3254 *cb->msg = xstrdup(message);3255 if (cb->cutoff_time)3256 *cb->cutoff_time = timestamp;3257 if (cb->cutoff_tz)3258 *cb->cutoff_tz = tz;3259 if (cb->cutoff_cnt)3260 *cb->cutoff_cnt = cb->reccnt - 1;3261 /*3262 * we have not yet updated cb->[n|o]sha1 so they still3263 * hold the values for the previous record.3264 */3265 if (!is_null_sha1(cb->osha1)) {3266 hashcpy(cb->sha1, nsha1);3267 if (hashcmp(cb->osha1, nsha1))3268 warning("Log for ref %s has gap after %s.",3269 cb->refname, show_date(cb->date, cb->tz, DATE_RFC2822));3270 }3271 else if (cb->date == cb->at_time)3272 hashcpy(cb->sha1, nsha1);3273 else if (hashcmp(nsha1, cb->sha1))3274 warning("Log for ref %s unexpectedly ended on %s.",3275 cb->refname, show_date(cb->date, cb->tz,3276 DATE_RFC2822));3277 hashcpy(cb->osha1, osha1);3278 hashcpy(cb->nsha1, nsha1);3279 cb->found_it = 1;3280 return 1;3281 }3282 hashcpy(cb->osha1, osha1);3283 hashcpy(cb->nsha1, nsha1);3284 if (cb->cnt > 0)3285 cb->cnt--;3286 return 0;3287}32883289static int read_ref_at_ent_oldest(unsigned char *osha1, unsigned char *nsha1,3290 const char *email, unsigned long timestamp,3291 int tz, const char *message, void *cb_data)3292{3293 struct read_ref_at_cb *cb = cb_data;32943295 if (cb->msg)3296 *cb->msg = xstrdup(message);3297 if (cb->cutoff_time)3298 *cb->cutoff_time = timestamp;3299 if (cb->cutoff_tz)3300 *cb->cutoff_tz = tz;3301 if (cb->cutoff_cnt)3302 *cb->cutoff_cnt = cb->reccnt;3303 hashcpy(cb->sha1, osha1);3304 if (is_null_sha1(cb->sha1))3305 hashcpy(cb->sha1, nsha1);3306 /* We just want the first entry */3307 return 1;3308}33093310int read_ref_at(const char *refname, unsigned int flags, unsigned long at_time, int cnt,3311 unsigned char *sha1, char **msg,3312 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)3313{3314 struct read_ref_at_cb cb;33153316 memset(&cb, 0, sizeof(cb));3317 cb.refname = refname;3318 cb.at_time = at_time;3319 cb.cnt = cnt;3320 cb.msg = msg;3321 cb.cutoff_time = cutoff_time;3322 cb.cutoff_tz = cutoff_tz;3323 cb.cutoff_cnt = cutoff_cnt;3324 cb.sha1 = sha1;33253326 for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);33273328 if (!cb.reccnt) {3329 if (flags & GET_SHA1_QUIETLY)3330 exit(128);3331 else3332 die("Log for %s is empty.", refname);3333 }3334 if (cb.found_it)3335 return 0;33363337 for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);33383339 return 1;3340}33413342int reflog_exists(const char *refname)3343{3344 struct stat st;33453346 return !lstat(git_path("logs/%s", refname), &st) &&3347 S_ISREG(st.st_mode);3348}33493350int delete_reflog(const char *refname)3351{3352 return remove_path(git_path("logs/%s", refname));3353}33543355static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)3356{3357 unsigned char osha1[20], nsha1[20];3358 char *email_end, *message;3359 unsigned long timestamp;3360 int tz;33613362 /* old SP new SP name <email> SP time TAB msg LF */3363 if (sb->len < 83 || sb->buf[sb->len - 1] != '\n' ||3364 get_sha1_hex(sb->buf, osha1) || sb->buf[40] != ' ' ||3365 get_sha1_hex(sb->buf + 41, nsha1) || sb->buf[81] != ' ' ||3366 !(email_end = strchr(sb->buf + 82, '>')) ||3367 email_end[1] != ' ' ||3368 !(timestamp = strtoul(email_end + 2, &message, 10)) ||3369 !message || message[0] != ' ' ||3370 (message[1] != '+' && message[1] != '-') ||3371 !isdigit(message[2]) || !isdigit(message[3]) ||3372 !isdigit(message[4]) || !isdigit(message[5]))3373 return 0; /* corrupt? */3374 email_end[1] = '\0';3375 tz = strtol(message + 1, NULL, 10);3376 if (message[6] != '\t')3377 message += 6;3378 else3379 message += 7;3380 return fn(osha1, nsha1, sb->buf + 82, timestamp, tz, message, cb_data);3381}33823383static char *find_beginning_of_line(char *bob, char *scan)3384{3385 while (bob < scan && *(--scan) != '\n')3386 ; /* keep scanning backwards */3387 /*3388 * Return either beginning of the buffer, or LF at the end of3389 * the previous line.3390 */3391 return scan;3392}33933394int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data)3395{3396 struct strbuf sb = STRBUF_INIT;3397 FILE *logfp;3398 long pos;3399 int ret = 0, at_tail = 1;34003401 logfp = fopen(git_path("logs/%s", refname), "r");3402 if (!logfp)3403 return -1;34043405 /* Jump to the end */3406 if (fseek(logfp, 0, SEEK_END) < 0)3407 return error("cannot seek back reflog for %s: %s",3408 refname, strerror(errno));3409 pos = ftell(logfp);3410 while (!ret && 0 < pos) {3411 int cnt;3412 size_t nread;3413 char buf[BUFSIZ];3414 char *endp, *scanp;34153416 /* Fill next block from the end */3417 cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;3418 if (fseek(logfp, pos - cnt, SEEK_SET))3419 return error("cannot seek back reflog for %s: %s",3420 refname, strerror(errno));3421 nread = fread(buf, cnt, 1, logfp);3422 if (nread != 1)3423 return error("cannot read %d bytes from reflog for %s: %s",3424 cnt, refname, strerror(errno));3425 pos -= cnt;34263427 scanp = endp = buf + cnt;3428 if (at_tail && scanp[-1] == '\n')3429 /* Looking at the final LF at the end of the file */3430 scanp--;3431 at_tail = 0;34323433 while (buf < scanp) {3434 /*3435 * terminating LF of the previous line, or the beginning3436 * of the buffer.3437 */3438 char *bp;34393440 bp = find_beginning_of_line(buf, scanp);34413442 if (*bp == '\n') {3443 /*3444 * The newline is the end of the previous line,3445 * so we know we have complete line starting3446 * at (bp + 1). Prefix it onto any prior data3447 * we collected for the line and process it.3448 */3449 strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));3450 scanp = bp;3451 endp = bp + 1;3452 ret = show_one_reflog_ent(&sb, fn, cb_data);3453 strbuf_reset(&sb);3454 if (ret)3455 break;3456 } else if (!pos) {3457 /*3458 * We are at the start of the buffer, and the3459 * start of the file; there is no previous3460 * line, and we have everything for this one.3461 * Process it, and we can end the loop.3462 */3463 strbuf_splice(&sb, 0, 0, buf, endp - buf);3464 ret = show_one_reflog_ent(&sb, fn, cb_data);3465 strbuf_reset(&sb);3466 break;3467 }34683469 if (bp == buf) {3470 /*3471 * We are at the start of the buffer, and there3472 * is more file to read backwards. Which means3473 * we are in the middle of a line. Note that we3474 * may get here even if *bp was a newline; that3475 * just means we are at the exact end of the3476 * previous line, rather than some spot in the3477 * middle.3478 *3479 * Save away what we have to be combined with3480 * the data from the next read.3481 */3482 strbuf_splice(&sb, 0, 0, buf, endp - buf);3483 break;3484 }3485 }34863487 }3488 if (!ret && sb.len)3489 die("BUG: reverse reflog parser had leftover data");34903491 fclose(logfp);3492 strbuf_release(&sb);3493 return ret;3494}34953496int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)3497{3498 FILE *logfp;3499 struct strbuf sb = STRBUF_INIT;3500 int ret = 0;35013502 logfp = fopen(git_path("logs/%s", refname), "r");3503 if (!logfp)3504 return -1;35053506 while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))3507 ret = show_one_reflog_ent(&sb, fn, cb_data);3508 fclose(logfp);3509 strbuf_release(&sb);3510 return ret;3511}3512/*3513 * Call fn for each reflog in the namespace indicated by name. name3514 * must be empty or end with '/'. Name will be used as a scratch3515 * space, but its contents will be restored before return.3516 */3517static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)3518{3519 DIR *d = opendir(git_path("logs/%s", name->buf));3520 int retval = 0;3521 struct dirent *de;3522 int oldlen = name->len;35233524 if (!d)3525 return name->len ? errno : 0;35263527 while ((de = readdir(d)) != NULL) {3528 struct stat st;35293530 if (de->d_name[0] == '.')3531 continue;3532 if (ends_with(de->d_name, ".lock"))3533 continue;3534 strbuf_addstr(name, de->d_name);3535 if (stat(git_path("logs/%s", name->buf), &st) < 0) {3536 ; /* silently ignore */3537 } else {3538 if (S_ISDIR(st.st_mode)) {3539 strbuf_addch(name, '/');3540 retval = do_for_each_reflog(name, fn, cb_data);3541 } else {3542 unsigned char sha1[20];3543 if (read_ref_full(name->buf, 0, sha1, NULL))3544 retval = error("bad ref for %s", name->buf);3545 else3546 retval = fn(name->buf, sha1, 0, cb_data);3547 }3548 if (retval)3549 break;3550 }3551 strbuf_setlen(name, oldlen);3552 }3553 closedir(d);3554 return retval;3555}35563557int for_each_reflog(each_ref_fn fn, void *cb_data)3558{3559 int retval;3560 struct strbuf name;3561 strbuf_init(&name, PATH_MAX);3562 retval = do_for_each_reflog(&name, fn, cb_data);3563 strbuf_release(&name);3564 return retval;3565}35663567/**3568 * Information needed for a single ref update. Set new_sha1 to the3569 * new value or to zero to delete the ref. To check the old value3570 * while locking the ref, set have_old to 1 and set old_sha1 to the3571 * value or to zero to ensure the ref does not exist before update.3572 */3573struct ref_update {3574 unsigned char new_sha1[20];3575 unsigned char old_sha1[20];3576 int flags; /* REF_NODEREF? */3577 int have_old; /* 1 if old_sha1 is valid, 0 otherwise */3578 struct ref_lock *lock;3579 int type;3580 char *msg;3581 const char refname[FLEX_ARRAY];3582};35833584/*3585 * Transaction states.3586 * OPEN: The transaction is in a valid state and can accept new updates.3587 * An OPEN transaction can be committed.3588 * CLOSED: A closed transaction is no longer active and no other operations3589 * than free can be used on it in this state.3590 * A transaction can either become closed by successfully committing3591 * an active transaction or if there is a failure while building3592 * the transaction thus rendering it failed/inactive.3593 */3594enum ref_transaction_state {3595 REF_TRANSACTION_OPEN = 0,3596 REF_TRANSACTION_CLOSED = 13597};35983599/*3600 * Data structure for holding a reference transaction, which can3601 * consist of checks and updates to multiple references, carried out3602 * as atomically as possible. This structure is opaque to callers.3603 */3604struct ref_transaction {3605 struct ref_update **updates;3606 size_t alloc;3607 size_t nr;3608 enum ref_transaction_state state;3609};36103611struct ref_transaction *ref_transaction_begin(struct strbuf *err)3612{3613 assert(err);36143615 return xcalloc(1, sizeof(struct ref_transaction));3616}36173618void ref_transaction_free(struct ref_transaction *transaction)3619{3620 int i;36213622 if (!transaction)3623 return;36243625 for (i = 0; i < transaction->nr; i++) {3626 free(transaction->updates[i]->msg);3627 free(transaction->updates[i]);3628 }3629 free(transaction->updates);3630 free(transaction);3631}36323633static struct ref_update *add_update(struct ref_transaction *transaction,3634 const char *refname)3635{3636 size_t len = strlen(refname);3637 struct ref_update *update = xcalloc(1, sizeof(*update) + len + 1);36383639 strcpy((char *)update->refname, refname);3640 ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);3641 transaction->updates[transaction->nr++] = update;3642 return update;3643}36443645int ref_transaction_update(struct ref_transaction *transaction,3646 const char *refname,3647 const unsigned char *new_sha1,3648 const unsigned char *old_sha1,3649 int flags, int have_old, const char *msg,3650 struct strbuf *err)3651{3652 struct ref_update *update;36533654 assert(err);36553656 if (transaction->state != REF_TRANSACTION_OPEN)3657 die("BUG: update called for transaction that is not open");36583659 if (have_old && !old_sha1)3660 die("BUG: have_old is true but old_sha1 is NULL");36613662 if (!is_null_sha1(new_sha1) &&3663 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {3664 strbuf_addf(err, "refusing to update ref with bad name %s",3665 refname);3666 return -1;3667 }36683669 update = add_update(transaction, refname);3670 hashcpy(update->new_sha1, new_sha1);3671 update->flags = flags;3672 update->have_old = have_old;3673 if (have_old)3674 hashcpy(update->old_sha1, old_sha1);3675 if (msg)3676 update->msg = xstrdup(msg);3677 return 0;3678}36793680int ref_transaction_create(struct ref_transaction *transaction,3681 const char *refname,3682 const unsigned char *new_sha1,3683 int flags, const char *msg,3684 struct strbuf *err)3685{3686 struct ref_update *update;36873688 assert(err);36893690 if (transaction->state != REF_TRANSACTION_OPEN)3691 die("BUG: create called for transaction that is not open");36923693 if (!new_sha1 || is_null_sha1(new_sha1))3694 die("BUG: create ref with null new_sha1");36953696 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {3697 strbuf_addf(err, "refusing to create ref with bad name %s",3698 refname);3699 return -1;3700 }37013702 update = add_update(transaction, refname);37033704 hashcpy(update->new_sha1, new_sha1);3705 hashclr(update->old_sha1);3706 update->flags = flags;3707 update->have_old = 1;3708 if (msg)3709 update->msg = xstrdup(msg);3710 return 0;3711}37123713int ref_transaction_delete(struct ref_transaction *transaction,3714 const char *refname,3715 const unsigned char *old_sha1,3716 int flags, int have_old, const char *msg,3717 struct strbuf *err)3718{3719 struct ref_update *update;37203721 assert(err);37223723 if (transaction->state != REF_TRANSACTION_OPEN)3724 die("BUG: delete called for transaction that is not open");37253726 if (have_old && !old_sha1)3727 die("BUG: have_old is true but old_sha1 is NULL");37283729 update = add_update(transaction, refname);3730 update->flags = flags;3731 update->have_old = have_old;3732 if (have_old) {3733 assert(!is_null_sha1(old_sha1));3734 hashcpy(update->old_sha1, old_sha1);3735 }3736 if (msg)3737 update->msg = xstrdup(msg);3738 return 0;3739}37403741int update_ref(const char *action, const char *refname,3742 const unsigned char *sha1, const unsigned char *oldval,3743 int flags, enum action_on_err onerr)3744{3745 struct ref_transaction *t;3746 struct strbuf err = STRBUF_INIT;37473748 t = ref_transaction_begin(&err);3749 if (!t ||3750 ref_transaction_update(t, refname, sha1, oldval, flags,3751 !!oldval, action, &err) ||3752 ref_transaction_commit(t, &err)) {3753 const char *str = "update_ref failed for ref '%s': %s";37543755 ref_transaction_free(t);3756 switch (onerr) {3757 case UPDATE_REFS_MSG_ON_ERR:3758 error(str, refname, err.buf);3759 break;3760 case UPDATE_REFS_DIE_ON_ERR:3761 die(str, refname, err.buf);3762 break;3763 case UPDATE_REFS_QUIET_ON_ERR:3764 break;3765 }3766 strbuf_release(&err);3767 return 1;3768 }3769 strbuf_release(&err);3770 ref_transaction_free(t);3771 return 0;3772}37733774static int ref_update_compare(const void *r1, const void *r2)3775{3776 const struct ref_update * const *u1 = r1;3777 const struct ref_update * const *u2 = r2;3778 return strcmp((*u1)->refname, (*u2)->refname);3779}37803781static int ref_update_reject_duplicates(struct ref_update **updates, int n,3782 struct strbuf *err)3783{3784 int i;37853786 assert(err);37873788 for (i = 1; i < n; i++)3789 if (!strcmp(updates[i - 1]->refname, updates[i]->refname)) {3790 strbuf_addf(err,3791 "Multiple updates for ref '%s' not allowed.",3792 updates[i]->refname);3793 return 1;3794 }3795 return 0;3796}37973798int ref_transaction_commit(struct ref_transaction *transaction,3799 struct strbuf *err)3800{3801 int ret = 0, delnum = 0, i;3802 const char **delnames;3803 int n = transaction->nr;3804 struct ref_update **updates = transaction->updates;38053806 assert(err);38073808 if (transaction->state != REF_TRANSACTION_OPEN)3809 die("BUG: commit called for transaction that is not open");38103811 if (!n) {3812 transaction->state = REF_TRANSACTION_CLOSED;3813 return 0;3814 }38153816 /* Allocate work space */3817 delnames = xmalloc(sizeof(*delnames) * n);38183819 /* Copy, sort, and reject duplicate refs */3820 qsort(updates, n, sizeof(*updates), ref_update_compare);3821 if (ref_update_reject_duplicates(updates, n, err)) {3822 ret = TRANSACTION_GENERIC_ERROR;3823 goto cleanup;3824 }38253826 /* Acquire all locks while verifying old values */3827 for (i = 0; i < n; i++) {3828 struct ref_update *update = updates[i];3829 int flags = update->flags;38303831 if (is_null_sha1(update->new_sha1))3832 flags |= REF_DELETING;3833 update->lock = lock_ref_sha1_basic(update->refname,3834 (update->have_old ?3835 update->old_sha1 :3836 NULL),3837 NULL,3838 flags,3839 &update->type);3840 if (!update->lock) {3841 ret = (errno == ENOTDIR)3842 ? TRANSACTION_NAME_CONFLICT3843 : TRANSACTION_GENERIC_ERROR;3844 strbuf_addf(err, "Cannot lock the ref '%s'.",3845 update->refname);3846 goto cleanup;3847 }3848 }38493850 /* Perform updates first so live commits remain referenced */3851 for (i = 0; i < n; i++) {3852 struct ref_update *update = updates[i];38533854 if (!is_null_sha1(update->new_sha1)) {3855 if (write_ref_sha1(update->lock, update->new_sha1,3856 update->msg)) {3857 update->lock = NULL; /* freed by write_ref_sha1 */3858 strbuf_addf(err, "Cannot update the ref '%s'.",3859 update->refname);3860 ret = TRANSACTION_GENERIC_ERROR;3861 goto cleanup;3862 }3863 update->lock = NULL; /* freed by write_ref_sha1 */3864 }3865 }38663867 /* Perform deletes now that updates are safely completed */3868 for (i = 0; i < n; i++) {3869 struct ref_update *update = updates[i];38703871 if (update->lock) {3872 if (delete_ref_loose(update->lock, update->type, err)) {3873 ret = TRANSACTION_GENERIC_ERROR;3874 goto cleanup;3875 }38763877 if (!(update->flags & REF_ISPRUNING))3878 delnames[delnum++] = update->lock->ref_name;3879 }3880 }38813882 if (repack_without_refs(delnames, delnum, err)) {3883 ret = TRANSACTION_GENERIC_ERROR;3884 goto cleanup;3885 }3886 for (i = 0; i < delnum; i++)3887 unlink_or_warn(git_path("logs/%s", delnames[i]));3888 clear_loose_ref_cache(&ref_cache);38893890cleanup:3891 transaction->state = REF_TRANSACTION_CLOSED;38923893 for (i = 0; i < n; i++)3894 if (updates[i]->lock)3895 unlock_ref(updates[i]->lock);3896 free(delnames);3897 return ret;3898}38993900char *shorten_unambiguous_ref(const char *refname, int strict)3901{3902 int i;3903 static char **scanf_fmts;3904 static int nr_rules;3905 char *short_name;39063907 if (!nr_rules) {3908 /*3909 * Pre-generate scanf formats from ref_rev_parse_rules[].3910 * Generate a format suitable for scanf from a3911 * ref_rev_parse_rules rule by interpolating "%s" at the3912 * location of the "%.*s".3913 */3914 size_t total_len = 0;3915 size_t offset = 0;39163917 /* the rule list is NULL terminated, count them first */3918 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)3919 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */3920 total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;39213922 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);39233924 offset = 0;3925 for (i = 0; i < nr_rules; i++) {3926 assert(offset < total_len);3927 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;3928 offset += snprintf(scanf_fmts[i], total_len - offset,3929 ref_rev_parse_rules[i], 2, "%s") + 1;3930 }3931 }39323933 /* bail out if there are no rules */3934 if (!nr_rules)3935 return xstrdup(refname);39363937 /* buffer for scanf result, at most refname must fit */3938 short_name = xstrdup(refname);39393940 /* skip first rule, it will always match */3941 for (i = nr_rules - 1; i > 0 ; --i) {3942 int j;3943 int rules_to_fail = i;3944 int short_name_len;39453946 if (1 != sscanf(refname, scanf_fmts[i], short_name))3947 continue;39483949 short_name_len = strlen(short_name);39503951 /*3952 * in strict mode, all (except the matched one) rules3953 * must fail to resolve to a valid non-ambiguous ref3954 */3955 if (strict)3956 rules_to_fail = nr_rules;39573958 /*3959 * check if the short name resolves to a valid ref,3960 * but use only rules prior to the matched one3961 */3962 for (j = 0; j < rules_to_fail; j++) {3963 const char *rule = ref_rev_parse_rules[j];3964 char refname[PATH_MAX];39653966 /* skip matched rule */3967 if (i == j)3968 continue;39693970 /*3971 * the short name is ambiguous, if it resolves3972 * (with this previous rule) to a valid ref3973 * read_ref() returns 0 on success3974 */3975 mksnpath(refname, sizeof(refname),3976 rule, short_name_len, short_name);3977 if (ref_exists(refname))3978 break;3979 }39803981 /*3982 * short name is non-ambiguous if all previous rules3983 * haven't resolved to a valid ref3984 */3985 if (j == rules_to_fail)3986 return short_name;3987 }39883989 free(short_name);3990 return xstrdup(refname);3991}39923993static struct string_list *hide_refs;39943995int parse_hide_refs_config(const char *var, const char *value, const char *section)3996{3997 if (!strcmp("transfer.hiderefs", var) ||3998 /* NEEDSWORK: use parse_config_key() once both are merged */3999 (starts_with(var, section) && var[strlen(section)] == '.' &&4000 !strcmp(var + strlen(section), ".hiderefs"))) {4001 char *ref;4002 int len;40034004 if (!value)4005 return config_error_nonbool(var);4006 ref = xstrdup(value);4007 len = strlen(ref);4008 while (len && ref[len - 1] == '/')4009 ref[--len] = '\0';4010 if (!hide_refs) {4011 hide_refs = xcalloc(1, sizeof(*hide_refs));4012 hide_refs->strdup_strings = 1;4013 }4014 string_list_append(hide_refs, ref);4015 }4016 return 0;4017}40184019int ref_is_hidden(const char *refname)4020{4021 struct string_list_item *item;40224023 if (!hide_refs)4024 return 0;4025 for_each_string_list_item(item, hide_refs) {4026 int len;4027 if (!starts_with(refname, item->string))4028 continue;4029 len = strlen(item->string);4030 if (!refname[len] || refname[len] == '/')4031 return 1;4032 }4033 return 0;4034}