packed_read_raw_ref(): read the reference from the mmapped buffer
[gitweb.git] / refs / packed-backend.c
index ae276f3445f6533452ddc3ce4808e89ecf912086..be614e79f530f492d9dc7c6bcf9242ff1a1a712f 100644 (file)
@@ -7,6 +7,35 @@
 #include "../iterator.h"
 #include "../lockfile.h"
 
+enum mmap_strategy {
+       /*
+        * Don't use mmap() at all for reading `packed-refs`.
+        */
+       MMAP_NONE,
+
+       /*
+        * Can use mmap() for reading `packed-refs`, but the file must
+        * not remain mmapped. This is the usual option on Windows,
+        * where you cannot rename a new version of a file onto a file
+        * that is currently mmapped.
+        */
+       MMAP_TEMPORARY,
+
+       /*
+        * It is OK to leave the `packed-refs` file mmapped while
+        * arbitrary other code is running.
+        */
+       MMAP_OK
+};
+
+#if defined(NO_MMAP)
+static enum mmap_strategy mmap_strategy = MMAP_NONE;
+#elif defined(MMAP_PREVENTS_DELETE)
+static enum mmap_strategy mmap_strategy = MMAP_TEMPORARY;
+#else
+static enum mmap_strategy mmap_strategy = MMAP_OK;
+#endif
+
 struct packed_ref_store;
 
 struct packed_ref_cache {
@@ -18,6 +47,22 @@ struct packed_ref_cache {
 
        struct ref_cache *cache;
 
+       /* Is the `packed-refs` file currently mmapped? */
+       int mmapped;
+
+       /*
+        * The contents of the `packed-refs` file. If the file was
+        * already sorted, this points at the mmapped contents of the
+        * file. If not, this points at heap-allocated memory
+        * containing the contents, sorted. If there were no contents
+        * (e.g., because the file didn't exist), `buf` and `eof` are
+        * both NULL.
+        */
+       char *buf, *eof;
+
+       /* The size of the header line, if any; otherwise, 0: */
+       size_t header_len;
+
        /*
         * What is the peeled state of this cache? (This is usually
         * determined from the header of the "packed-refs" file.)
@@ -36,30 +81,6 @@ struct packed_ref_cache {
        struct stat_validity validity;
 };
 
-/*
- * Increment the reference count of *packed_refs.
- */
-static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs)
-{
-       packed_refs->referrers++;
-}
-
-/*
- * Decrease the reference count of *packed_refs.  If it goes to zero,
- * free *packed_refs and return true; otherwise return false.
- */
-static int release_packed_ref_cache(struct packed_ref_cache *packed_refs)
-{
-       if (!--packed_refs->referrers) {
-               free_ref_cache(packed_refs->cache);
-               stat_validity_clear(&packed_refs->validity);
-               free(packed_refs);
-               return 1;
-       } else {
-               return 0;
-       }
-}
-
 /*
  * A container for `packed-refs`-related data. It is not (yet) a
  * `ref_store`.
@@ -92,6 +113,51 @@ struct packed_ref_store {
        struct tempfile tempfile;
 };
 
+/*
+ * Increment the reference count of *packed_refs.
+ */
+static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs)
+{
+       packed_refs->referrers++;
+}
+
+/*
+ * If the buffer in `packed_refs` is active, then either munmap the
+ * memory and close the file, or free the memory. Then set the buffer
+ * pointers to NULL.
+ */
+static void release_packed_ref_buffer(struct packed_ref_cache *packed_refs)
+{
+       if (packed_refs->mmapped) {
+               if (munmap(packed_refs->buf,
+                          packed_refs->eof - packed_refs->buf))
+                       die_errno("error ummapping packed-refs file %s",
+                                 packed_refs->refs->path);
+               packed_refs->mmapped = 0;
+       } else {
+               free(packed_refs->buf);
+       }
+       packed_refs->buf = packed_refs->eof = NULL;
+       packed_refs->header_len = 0;
+}
+
+/*
+ * Decrease the reference count of *packed_refs.  If it goes to zero,
+ * free *packed_refs and return true; otherwise return false.
+ */
+static int release_packed_ref_cache(struct packed_ref_cache *packed_refs)
+{
+       if (!--packed_refs->referrers) {
+               free_ref_cache(packed_refs->cache);
+               stat_validity_clear(&packed_refs->validity);
+               release_packed_ref_buffer(packed_refs);
+               free(packed_refs);
+               return 1;
+       } else {
+               return 0;
+       }
+}
+
 struct ref_store *packed_ref_store_create(const char *path,
                                          unsigned int store_flags)
 {
@@ -163,6 +229,460 @@ static NORETURN void die_invalid_line(const char *path,
 
 }
 
+/*
+ * An iterator over a packed-refs file that is currently mmapped.
+ */
+struct mmapped_ref_iterator {
+       struct ref_iterator base;
+
+       struct packed_ref_cache *packed_refs;
+
+       /* The current position in the mmapped file: */
+       const char *pos;
+
+       /* The end of the mmapped file: */
+       const char *eof;
+
+       struct object_id oid, peeled;
+
+       struct strbuf refname_buf;
+};
+
+static int mmapped_ref_iterator_advance(struct ref_iterator *ref_iterator)
+{
+       struct mmapped_ref_iterator *iter =
+               (struct mmapped_ref_iterator *)ref_iterator;
+       const char *p = iter->pos, *eol;
+
+       strbuf_reset(&iter->refname_buf);
+
+       if (iter->pos == iter->eof)
+               return ref_iterator_abort(ref_iterator);
+
+       iter->base.flags = REF_ISPACKED;
+
+       if (iter->eof - p < GIT_SHA1_HEXSZ + 2 ||
+           parse_oid_hex(p, &iter->oid, &p) ||
+           !isspace(*p++))
+               die_invalid_line(iter->packed_refs->refs->path,
+                                iter->pos, iter->eof - iter->pos);
+
+       eol = memchr(p, '\n', iter->eof - p);
+       if (!eol)
+               die_unterminated_line(iter->packed_refs->refs->path,
+                                     iter->pos, iter->eof - iter->pos);
+
+       strbuf_add(&iter->refname_buf, p, eol - p);
+       iter->base.refname = iter->refname_buf.buf;
+
+       if (check_refname_format(iter->base.refname, REFNAME_ALLOW_ONELEVEL)) {
+               if (!refname_is_safe(iter->base.refname))
+                       die("packed refname is dangerous: %s",
+                           iter->base.refname);
+               oidclr(&iter->oid);
+               iter->base.flags |= REF_BAD_NAME | REF_ISBROKEN;
+       }
+       if (iter->packed_refs->peeled == PEELED_FULLY ||
+           (iter->packed_refs->peeled == PEELED_TAGS &&
+            starts_with(iter->base.refname, "refs/tags/")))
+               iter->base.flags |= REF_KNOWS_PEELED;
+
+       iter->pos = eol + 1;
+
+       if (iter->pos < iter->eof && *iter->pos == '^') {
+               p = iter->pos + 1;
+               if (iter->eof - p < GIT_SHA1_HEXSZ + 1 ||
+                   parse_oid_hex(p, &iter->peeled, &p) ||
+                   *p++ != '\n')
+                       die_invalid_line(iter->packed_refs->refs->path,
+                                        iter->pos, iter->eof - iter->pos);
+               iter->pos = p;
+
+               /*
+                * Regardless of what the file header said, we
+                * definitely know the value of *this* reference. But
+                * we suppress it if the reference is broken:
+                */
+               if ((iter->base.flags & REF_ISBROKEN)) {
+                       oidclr(&iter->peeled);
+                       iter->base.flags &= ~REF_KNOWS_PEELED;
+               } else {
+                       iter->base.flags |= REF_KNOWS_PEELED;
+               }
+       } else {
+               oidclr(&iter->peeled);
+       }
+
+       return ITER_OK;
+}
+
+static int mmapped_ref_iterator_peel(struct ref_iterator *ref_iterator,
+                                   struct object_id *peeled)
+{
+       struct mmapped_ref_iterator *iter =
+               (struct mmapped_ref_iterator *)ref_iterator;
+
+       if ((iter->base.flags & REF_KNOWS_PEELED)) {
+               oidcpy(peeled, &iter->peeled);
+               return is_null_oid(&iter->peeled) ? -1 : 0;
+       } else if ((iter->base.flags & (REF_ISBROKEN | REF_ISSYMREF))) {
+               return -1;
+       } else {
+               return !!peel_object(iter->oid.hash, peeled->hash);
+       }
+}
+
+static int mmapped_ref_iterator_abort(struct ref_iterator *ref_iterator)
+{
+       struct mmapped_ref_iterator *iter =
+               (struct mmapped_ref_iterator *)ref_iterator;
+
+       release_packed_ref_cache(iter->packed_refs);
+       strbuf_release(&iter->refname_buf);
+       base_ref_iterator_free(ref_iterator);
+       return ITER_DONE;
+}
+
+static struct ref_iterator_vtable mmapped_ref_iterator_vtable = {
+       mmapped_ref_iterator_advance,
+       mmapped_ref_iterator_peel,
+       mmapped_ref_iterator_abort
+};
+
+struct ref_iterator *mmapped_ref_iterator_begin(
+               struct packed_ref_cache *packed_refs,
+               const char *pos, const char *eof)
+{
+       struct mmapped_ref_iterator *iter = xcalloc(1, sizeof(*iter));
+       struct ref_iterator *ref_iterator = &iter->base;
+
+       if (!packed_refs->buf)
+               return empty_ref_iterator_begin();
+
+       base_ref_iterator_init(ref_iterator, &mmapped_ref_iterator_vtable, 1);
+
+       iter->packed_refs = packed_refs;
+       acquire_packed_ref_cache(iter->packed_refs);
+       iter->pos = pos;
+       iter->eof = eof;
+       strbuf_init(&iter->refname_buf, 0);
+
+       iter->base.oid = &iter->oid;
+
+       return ref_iterator;
+}
+
+struct packed_ref_entry {
+       const char *start;
+       size_t len;
+};
+
+static int cmp_packed_ref_entries(const void *v1, const void *v2)
+{
+       const struct packed_ref_entry *e1 = v1, *e2 = v2;
+       const char *r1 = e1->start + GIT_SHA1_HEXSZ + 1;
+       const char *r2 = e2->start + GIT_SHA1_HEXSZ + 1;
+
+       while (1) {
+               if (*r1 == '\n')
+                       return *r2 == '\n' ? 0 : -1;
+               if (*r1 != *r2) {
+                       if (*r2 == '\n')
+                               return 1;
+                       else
+                               return (unsigned char)*r1 < (unsigned char)*r2 ? -1 : +1;
+               }
+               r1++;
+               r2++;
+       }
+}
+
+/*
+ * Compare a packed-refs record pointed to by `rec` to the specified
+ * NUL-terminated refname.
+ */
+static int cmp_entry_to_refname(const char *rec, const char *refname)
+{
+       const char *r1 = rec + GIT_SHA1_HEXSZ + 1;
+       const char *r2 = refname;
+
+       while (1) {
+               if (*r1 == '\n')
+                       return *r2 ? -1 : 0;
+               if (!*r2)
+                       return 1;
+               if (*r1 != *r2)
+                       return (unsigned char)*r1 < (unsigned char)*r2 ? -1 : +1;
+               r1++;
+               r2++;
+       }
+}
+
+/*
+ * `packed_refs->buf` is not known to be sorted. Check whether it is,
+ * and if not, sort it into new memory and munmap/free the old
+ * storage.
+ */
+static void sort_packed_refs(struct packed_ref_cache *packed_refs)
+{
+       struct packed_ref_entry *entries = NULL;
+       size_t alloc = 0, nr = 0;
+       int sorted = 1;
+       const char *pos, *eof, *eol;
+       size_t len, i;
+       char *new_buffer, *dst;
+
+       pos = packed_refs->buf + packed_refs->header_len;
+       eof = packed_refs->eof;
+       len = eof - pos;
+
+       if (!len)
+               return;
+
+       /*
+        * Initialize entries based on a crude estimate of the number
+        * of references in the file (we'll grow it below if needed):
+        */
+       ALLOC_GROW(entries, len / 80 + 20, alloc);
+
+       while (pos < eof) {
+               eol = memchr(pos, '\n', eof - pos);
+               if (!eol)
+                       /* The safety check should prevent this. */
+                       BUG("unterminated line found in packed-refs");
+               if (eol - pos < GIT_SHA1_HEXSZ + 2)
+                       die_invalid_line(packed_refs->refs->path,
+                                        pos, eof - pos);
+               eol++;
+               if (eol < eof && *eol == '^') {
+                       /*
+                        * Keep any peeled line together with its
+                        * reference:
+                        */
+                       const char *peeled_start = eol;
+
+                       eol = memchr(peeled_start, '\n', eof - peeled_start);
+                       if (!eol)
+                               /* The safety check should prevent this. */
+                               BUG("unterminated peeled line found in packed-refs");
+                       eol++;
+               }
+
+               ALLOC_GROW(entries, nr + 1, alloc);
+               entries[nr].start = pos;
+               entries[nr].len = eol - pos;
+               nr++;
+
+               if (sorted &&
+                   nr > 1 &&
+                   cmp_packed_ref_entries(&entries[nr - 2],
+                                          &entries[nr - 1]) >= 0)
+                       sorted = 0;
+
+               pos = eol;
+       }
+
+       if (sorted)
+               goto cleanup;
+
+       /* We need to sort the memory. First we sort the entries array: */
+       QSORT(entries, nr, cmp_packed_ref_entries);
+
+       /*
+        * Allocate a new chunk of memory, and copy the old memory to
+        * the new in the order indicated by `entries` (not bothering
+        * with the header line):
+        */
+       new_buffer = xmalloc(len);
+       for (dst = new_buffer, i = 0; i < nr; i++) {
+               memcpy(dst, entries[i].start, entries[i].len);
+               dst += entries[i].len;
+       }
+
+       /*
+        * Now munmap the old buffer and use the sorted buffer in its
+        * place:
+        */
+       release_packed_ref_buffer(packed_refs);
+       packed_refs->buf = new_buffer;
+       packed_refs->eof = new_buffer + len;
+       packed_refs->header_len = 0;
+
+cleanup:
+       free(entries);
+}
+
+/*
+ * Return a pointer to the start of the record that contains the
+ * character `*p` (which must be within the buffer). If no other
+ * record start is found, return `buf`.
+ */
+static const char *find_start_of_record(const char *buf, const char *p)
+{
+       while (p > buf && (p[-1] != '\n' || p[0] == '^'))
+               p--;
+       return p;
+}
+
+/*
+ * Return a pointer to the start of the record following the record
+ * that contains `*p`. If none is found before `end`, return `end`.
+ */
+static const char *find_end_of_record(const char *p, const char *end)
+{
+       while (++p < end && (p[-1] != '\n' || p[0] == '^'))
+               ;
+       return p;
+}
+
+/*
+ * We want to be able to compare mmapped reference records quickly,
+ * without totally parsing them. We can do so because the records are
+ * LF-terminated, and the refname should start exactly (GIT_SHA1_HEXSZ
+ * + 1) bytes past the beginning of the record.
+ *
+ * But what if the `packed-refs` file contains garbage? We're willing
+ * to tolerate not detecting the problem, as long as we don't produce
+ * totally garbled output (we can't afford to check the integrity of
+ * the whole file during every Git invocation). But we do want to be
+ * sure that we never read past the end of the buffer in memory and
+ * perform an illegal memory access.
+ *
+ * Guarantee that minimum level of safety by verifying that the last
+ * record in the file is LF-terminated, and that it has at least
+ * (GIT_SHA1_HEXSZ + 1) characters before the LF. Die if either of
+ * these checks fails.
+ */
+static void verify_buffer_safe(struct packed_ref_cache *packed_refs)
+{
+       const char *buf = packed_refs->buf + packed_refs->header_len;
+       const char *eof = packed_refs->eof;
+       const char *last_line;
+
+       if (buf == eof)
+               return;
+
+       last_line = find_start_of_record(buf, eof - 1);
+       if (*(eof - 1) != '\n' || eof - last_line < GIT_SHA1_HEXSZ + 2)
+               die_invalid_line(packed_refs->refs->path,
+                                last_line, eof - last_line);
+}
+
+/*
+ * Depending on `mmap_strategy`, either mmap or read the contents of
+ * the `packed-refs` file into the `packed_refs` instance. Return 1 if
+ * the file existed and was read, or 0 if the file was absent. Die on
+ * errors.
+ */
+static int load_contents(struct packed_ref_cache *packed_refs)
+{
+       int fd;
+       struct stat st;
+       size_t size;
+       ssize_t bytes_read;
+
+       fd = open(packed_refs->refs->path, O_RDONLY);
+       if (fd < 0) {
+               if (errno == ENOENT) {
+                       /*
+                        * This is OK; it just means that no
+                        * "packed-refs" file has been written yet,
+                        * which is equivalent to it being empty,
+                        * which is its state when initialized with
+                        * zeros.
+                        */
+                       return 0;
+               } else {
+                       die_errno("couldn't read %s", packed_refs->refs->path);
+               }
+       }
+
+       stat_validity_update(&packed_refs->validity, fd);
+
+       if (fstat(fd, &st) < 0)
+               die_errno("couldn't stat %s", packed_refs->refs->path);
+       size = xsize_t(st.st_size);
+
+       switch (mmap_strategy) {
+       case MMAP_NONE:
+               packed_refs->buf = xmalloc(size);
+               bytes_read = read_in_full(fd, packed_refs->buf, size);
+               if (bytes_read < 0 || bytes_read != size)
+                       die_errno("couldn't read %s", packed_refs->refs->path);
+               packed_refs->eof = packed_refs->buf + size;
+               packed_refs->mmapped = 0;
+               break;
+       case MMAP_TEMPORARY:
+       case MMAP_OK:
+               packed_refs->buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
+               packed_refs->eof = packed_refs->buf + size;
+               packed_refs->mmapped = 1;
+               break;
+       }
+       close(fd);
+
+       return 1;
+}
+
+/*
+ * Find the place in `cache->buf` where the start of the record for
+ * `refname` starts. If `mustexist` is true and the reference doesn't
+ * exist, then return NULL. If `mustexist` is false and the reference
+ * doesn't exist, then return the point where that reference would be
+ * inserted. In the latter mode, `refname` doesn't have to be a proper
+ * reference name; for example, one could search for "refs/replace/"
+ * to find the start of any replace references.
+ *
+ * The record is sought using a binary search, so `cache->buf` must be
+ * sorted.
+ */
+static const char *find_reference_location(struct packed_ref_cache *cache,
+                                          const char *refname, int mustexist)
+{
+       /*
+        * This is not *quite* a garden-variety binary search, because
+        * the data we're searching is made up of records, and we
+        * always need to find the beginning of a record to do a
+        * comparison. A "record" here is one line for the reference
+        * itself and zero or one peel lines that start with '^'. Our
+        * loop invariant is described in the next two comments.
+        */
+
+       /*
+        * A pointer to the character at the start of a record whose
+        * preceding records all have reference names that come
+        * *before* `refname`.
+        */
+       const char *lo = cache->buf + cache->header_len;
+
+       /*
+        * A pointer to a the first character of a record whose
+        * reference name comes *after* `refname`.
+        */
+       const char *hi = cache->eof;
+
+       while (lo < hi) {
+               const char *mid, *rec;
+               int cmp;
+
+               mid = lo + (hi - lo) / 2;
+               rec = find_start_of_record(lo, mid);
+               cmp = cmp_entry_to_refname(rec, refname);
+               if (cmp < 0) {
+                       lo = find_end_of_record(mid, hi);
+               } else if (cmp > 0) {
+                       hi = rec;
+               } else {
+                       return rec;
+               }
+       }
+
+       if (mustexist)
+               return NULL;
+       else
+               return lo;
+}
+
 /*
  * Read from the `packed-refs` file into a newly-allocated
  * `packed_ref_cache` and return it. The return value will already
@@ -171,19 +691,19 @@ static NORETURN void die_invalid_line(const char *path,
  * A comment line of the form "# pack-refs with: " may contain zero or
  * more traits. We interpret the traits as follows:
  *
- *   No traits:
+ *   Neither `peeled` nor `fully-peeled`:
  *
  *      Probably no references are peeled. But if the file contains a
  *      peeled value for a reference, we will use it.
  *
- *   peeled:
+ *   `peeled`:
  *
  *      References under "refs/tags/", if they *can* be peeled, *are*
  *      peeled in this file. References outside of "refs/tags/" are
  *      probably not peeled even if they could have been, but if we find
  *      a peeled value for such a reference we will use it.
  *
- *   fully-peeled:
+ *   `fully-peeled`:
  *
  *      All references in the file that can be peeled are peeled.
  *      Inversely (and this is more important), any references in the
@@ -191,17 +711,18 @@ static NORETURN void die_invalid_line(const char *path,
  *      trait should typically be written alongside "peeled" for
  *      compatibility with older clients, but we do not require it
  *      (i.e., "peeled" is a no-op if "fully-peeled" is set).
+ *
+ *   `sorted`:
+ *
+ *      The references in this file are known to be sorted by refname.
  */
 static struct packed_ref_cache *read_packed_refs(struct packed_ref_store *refs)
 {
        struct packed_ref_cache *packed_refs = xcalloc(1, sizeof(*packed_refs));
-       int fd;
-       struct stat st;
-       size_t size;
-       char *buf;
-       const char *pos, *eol, *eof;
-       struct strbuf tmp = STRBUF_INIT;
        struct ref_dir *dir;
+       struct ref_iterator *iter;
+       int sorted = 0;
+       int ok;
 
        packed_refs->refs = refs;
        acquire_packed_ref_cache(packed_refs);
@@ -209,43 +730,29 @@ static struct packed_ref_cache *read_packed_refs(struct packed_ref_store *refs)
        packed_refs->cache->root->flag &= ~REF_INCOMPLETE;
        packed_refs->peeled = PEELED_NONE;
 
-       fd = open(refs->path, O_RDONLY);
-       if (fd < 0) {
-               if (errno == ENOENT) {
-                       /*
-                        * This is OK; it just means that no
-                        * "packed-refs" file has been written yet,
-                        * which is equivalent to it being empty.
-                        */
-                       return packed_refs;
-               } else {
-                       die_errno("couldn't read %s", refs->path);
-               }
-       }
-
-       stat_validity_update(&packed_refs->validity, fd);
-
-       if (fstat(fd, &st) < 0)
-               die_errno("couldn't stat %s", refs->path);
-
-       size = xsize_t(st.st_size);
-       buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
-       pos = buf;
-       eof = buf + size;
+       if (!load_contents(packed_refs))
+               return packed_refs;
 
        /* If the file has a header line, process it: */
-       if (pos < eof && *pos == '#') {
+       if (packed_refs->buf < packed_refs->eof && *packed_refs->buf == '#') {
+               struct strbuf tmp = STRBUF_INIT;
                char *p;
+               const char *eol;
                struct string_list traits = STRING_LIST_INIT_NODUP;
 
-               eol = memchr(pos, '\n', eof - pos);
+               eol = memchr(packed_refs->buf, '\n',
+                            packed_refs->eof - packed_refs->buf);
                if (!eol)
-                       die_unterminated_line(refs->path, pos, eof - pos);
+                       die_unterminated_line(refs->path,
+                                             packed_refs->buf,
+                                             packed_refs->eof - packed_refs->buf);
 
-               strbuf_add(&tmp, pos, eol - pos);
+               strbuf_add(&tmp, packed_refs->buf, eol - packed_refs->buf);
 
                if (!skip_prefix(tmp.buf, "# pack-refs with:", (const char **)&p))
-                       die_invalid_line(refs->path, pos, eof - pos);
+                       die_invalid_line(refs->path,
+                                        packed_refs->buf,
+                                        packed_refs->eof - packed_refs->buf);
 
                string_list_split_in_place(&traits, p, ' ', -1);
 
@@ -253,75 +760,63 @@ static struct packed_ref_cache *read_packed_refs(struct packed_ref_store *refs)
                        packed_refs->peeled = PEELED_FULLY;
                else if (unsorted_string_list_has_string(&traits, "peeled"))
                        packed_refs->peeled = PEELED_TAGS;
+
+               sorted = unsorted_string_list_has_string(&traits, "sorted");
+
                /* perhaps other traits later as well */
 
                /* The "+ 1" is for the LF character. */
-               pos = eol + 1;
+               packed_refs->header_len = eol + 1 - packed_refs->buf;
 
                string_list_clear(&traits, 0);
-               strbuf_reset(&tmp);
+               strbuf_release(&tmp);
        }
 
-       dir = get_ref_dir(packed_refs->cache->root);
-       while (pos < eof) {
-               const char *p = pos;
-               struct object_id oid;
-               const char *refname;
-               int flag = REF_ISPACKED;
-               struct ref_entry *entry = NULL;
-
-               if (eof - pos < GIT_SHA1_HEXSZ + 2 ||
-                   parse_oid_hex(p, &oid, &p) ||
-                   !isspace(*p++))
-                       die_invalid_line(refs->path, pos, eof - pos);
-
-               eol = memchr(p, '\n', eof - p);
-               if (!eol)
-                       die_unterminated_line(refs->path, pos, eof - pos);
+       verify_buffer_safe(packed_refs);
 
-               strbuf_add(&tmp, p, eol - p);
-               refname = tmp.buf;
+       if (!sorted) {
+               sort_packed_refs(packed_refs);
 
-               if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
-                       if (!refname_is_safe(refname))
-                               die("packed refname is dangerous: %s", refname);
-                       oidclr(&oid);
-                       flag |= REF_BAD_NAME | REF_ISBROKEN;
-               }
-               if (packed_refs->peeled == PEELED_FULLY ||
-                   (packed_refs->peeled == PEELED_TAGS &&
-                    starts_with(refname, "refs/tags/")))
-                       flag |= REF_KNOWS_PEELED;
-               entry = create_ref_entry(refname, &oid, flag);
-               add_ref_entry(dir, entry);
-
-               pos = eol + 1;
-
-               if (pos < eof && *pos == '^') {
-                       p = pos + 1;
-                       if (eof - p < GIT_SHA1_HEXSZ + 1 ||
-                           parse_oid_hex(p, &entry->u.value.peeled, &p) ||
-                           *p++ != '\n')
-                               die_invalid_line(refs->path, pos, eof - pos);
-
-                       /*
-                        * Regardless of what the file header said,
-                        * we definitely know the value of *this*
-                        * reference:
-                        */
-                       entry->flag |= REF_KNOWS_PEELED;
+               /*
+                * Reordering the records might have moved a short one
+                * to the end of the buffer, so verify the buffer's
+                * safety again:
+                */
+               verify_buffer_safe(packed_refs);
+       }
 
-                       pos = p;
-               }
+       if (mmap_strategy != MMAP_OK && packed_refs->mmapped) {
+               /*
+                * We don't want to leave the file mmapped, so we are
+                * forced to make a copy now:
+                */
+               size_t size = packed_refs->eof -
+                       (packed_refs->buf + packed_refs->header_len);
+               char *buf_copy = xmalloc(size);
+
+               memcpy(buf_copy, packed_refs->buf + packed_refs->header_len, size);
+               release_packed_ref_buffer(packed_refs);
+               packed_refs->buf = buf_copy;
+               packed_refs->eof = buf_copy + size;
+       }
 
-               strbuf_reset(&tmp);
+       dir = get_ref_dir(packed_refs->cache->root);
+       iter = mmapped_ref_iterator_begin(
+                       packed_refs,
+                       packed_refs->buf + packed_refs->header_len,
+                       packed_refs->eof);
+       while ((ok = ref_iterator_advance(iter)) == ITER_OK) {
+               struct ref_entry *entry =
+                       create_ref_entry(iter->refname, iter->oid, iter->flags);
+
+               if ((iter->flags & REF_KNOWS_PEELED))
+                       ref_iterator_peel(iter, &entry->u.value.peeled);
+               add_ref_entry(dir, entry);
        }
 
-       if (munmap(buf, size))
-               die_errno("error ummapping packed-refs file");
-       close(fd);
+       if (ok != ITER_DONE)
+               die("error reading packed-refs file %s", refs->path);
 
-       strbuf_release(&tmp);
        return packed_refs;
 }
 
@@ -381,18 +876,22 @@ static int packed_read_raw_ref(struct ref_store *ref_store,
 {
        struct packed_ref_store *refs =
                packed_downcast(ref_store, REF_STORE_READ, "read_raw_ref");
-
-       struct ref_entry *entry;
+       struct packed_ref_cache *packed_refs = get_packed_ref_cache(refs);
+       const char *rec;
 
        *type = 0;
 
-       entry = get_packed_ref(refs, refname);
-       if (!entry) {
+       rec = find_reference_location(packed_refs, refname, 1);
+
+       if (!rec) {
+               /* refname is not a packed reference. */
                errno = ENOENT;
                return -1;
        }
 
-       hashcpy(sha1, entry->u.value.oid.hash);
+       if (get_sha1_hex(rec, sha1))
+               die_invalid_line(refs->path, rec, packed_refs->eof - rec);
+
        *type = REF_ISPACKED;
        return 0;
 }
@@ -484,6 +983,8 @@ static struct ref_iterator *packed_ref_iterator_begin(
                const char *prefix, unsigned int flags)
 {
        struct packed_ref_store *refs;
+       struct packed_ref_cache *packed_refs;
+       const char *start;
        struct packed_ref_iterator *iter;
        struct ref_iterator *ref_iterator;
        unsigned int required_flags = REF_STORE_READ;
@@ -501,13 +1002,23 @@ static struct ref_iterator *packed_ref_iterator_begin(
         * the packed-ref cache is up to date with what is on disk,
         * and re-reads it if not.
         */
+       iter->cache = packed_refs = get_packed_ref_cache(refs);
+       acquire_packed_ref_cache(packed_refs);
+
+       if (prefix && *prefix)
+               start = find_reference_location(packed_refs, prefix, 0);
+       else
+               start = packed_refs->buf + packed_refs->header_len;
 
-       iter->cache = get_packed_ref_cache(refs);
-       acquire_packed_ref_cache(iter->cache);
-       iter->iter0 = cache_ref_iterator_begin(iter->cache->cache, prefix, 0);
+       iter->iter0 = mmapped_ref_iterator_begin(
+                       packed_refs, start, packed_refs->eof);
 
        iter->flags = flags;
 
+       if (prefix && *prefix)
+               /* Stop iteration after we've gone *past* prefix: */
+               ref_iterator = prefix_ref_iterator_begin(ref_iterator, prefix, 0);
+
        return ref_iterator;
 }
 
@@ -608,7 +1119,7 @@ int packed_refs_is_locked(struct ref_store *ref_store)
  * the colon and the trailing space are required.
  */
 static const char PACKED_REFS_HEADER[] =
-       "# pack-refs with: peeled fully-peeled \n";
+       "# pack-refs with: peeled fully-peeled sorted \n";
 
 static int packed_init_db(struct ref_store *ref_store, struct strbuf *err)
 {
@@ -928,6 +1439,8 @@ static int packed_transaction_finish(struct ref_store *ref_store,
        int ret = TRANSACTION_GENERIC_ERROR;
        char *packed_refs_path;
 
+       clear_packed_ref_cache(refs);
+
        packed_refs_path = get_locked_file_path(&refs->lock);
        if (rename_tempfile(&refs->tempfile, packed_refs_path)) {
                strbuf_addf(err, "error replacing %s: %s",
@@ -935,7 +1448,6 @@ static int packed_transaction_finish(struct ref_store *ref_store,
                goto cleanup;
        }
 
-       clear_packed_ref_cache(refs);
        ret = 0;
 
 cleanup: