git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCHv3 10/10] pack-revindex: radix-sort the revindex

From
Brandon Casey <drafnel@gmail.com>
Date
Jul 11, 2013, 21:12 UTC
Message-ID
<CA+sFfMeTBb6Eu6cQ4LHrTxLwA-pL573ey2SMCb16TzBP00WrqQ@mail.gmail.com>
In-Reply-To
<20130711121600.GA18710@sigill.intra.peff.net>
On Thu, Jul 11, 2013 at 5:16 AM, Jeff King <peff@peff.net> wrote:
>   Here's an update of the radix-sort patch. It fixes the "unsigned" issue
>   Brandon pointed out, along with a few other comment/naming/style fixes.
>   I also updated the commit message with more explanation of the
>   timings.
Very nice.
For what it's worth:
Reviewed-by: Brandon Casey <drafnel@gmail.com>
<remainder retained for reference (or whatever Jonathan usually says)>
Show 293 quoted lines
>   The interdiff is:
>
>   diff --git a/pack-revindex.c b/pack-revindex.c
>   index 9365bc2..b4d2b35 100644
>   --- a/pack-revindex.c
>   +++ b/pack-revindex.c
>   @@ -61,6 +61,10 @@ static void init_pack_revindex(void)
>
>    /*
>     * This is a least-significant-digit radix sort.
>   + *
>   + * It sorts each of the "n" items in "entries" by its offset field. The "max"
>   + * parameter must be at least as large as the largest offset in the array,
>   + * and lets us quit the sort early.
>     */
>    static void sort_revindex(struct revindex_entry *entries, unsigned n, off_t max)
>    {
>   @@ -78,18 +82,25 @@ static void sort_revindex(struct revindex_entry *entries, unsigned n, off_t max)
>    #define BUCKET_FOR(a, i, bits) (((a)[(i)].offset >> (bits)) & (BUCKETS-1))
>
>         /*
>   -      * We need O(n) temporary storage, so we sort back and forth between
>   -      * the real array and our tmp storage. To keep them straight, we always
>   -      * sort from "a" into buckets in "b".
>   +      * We need O(n) temporary storage. Rather than do an extra copy of the
>   +      * partial results into "entries", we sort back and forth between the
>   +      * real array and temporary storage. In each iteration of the loop, we
>   +      * keep track of them with alias pointers, always sorting from "from"
>   +      * to "to".
>          */
>   -     struct revindex_entry *tmp = xcalloc(n, sizeof(*tmp));
>   -     struct revindex_entry *a = entries, *b = tmp;
>   -     int bits = 0;
>   +     struct revindex_entry *tmp = xmalloc(n * sizeof(*tmp));
>   +     struct revindex_entry *from = entries, *to = tmp;
>   +     int bits;
>         unsigned *pos = xmalloc(BUCKETS * sizeof(*pos));
>
>   -     while (max >> bits) {
>   +     /*
>   +      * If (max >> bits) is zero, then we know that the radix digit we are
>   +      * on (and any higher) will be zero for all entries, and our loop will
>   +      * be a no-op, as everybody lands in the same zero-th bucket.
>   +      */
>   +     for (bits = 0; max >> bits; bits += DIGIT_SIZE) {
>                 struct revindex_entry *swap;
>   -             int i;
>   +             unsigned i;
>
>                 memset(pos, 0, BUCKETS * sizeof(*pos));
>
>   @@ -102,7 +113,7 @@ static void sort_revindex(struct revindex_entry *entries, unsigned n, off_t max)
>                  * previous bucket to get the true index.
>                  */
>                 for (i = 0; i < n; i++)
>   -                     pos[BUCKET_FOR(a, i, bits)]++;
>   +                     pos[BUCKET_FOR(from, i, bits)]++;
>                 for (i = 1; i < BUCKETS; i++)
>                         pos[i] += pos[i-1];
>
>   @@ -112,32 +123,37 @@ static void sort_revindex(struct revindex_entry *entries, unsigned n, off_t max)
>                  * to avoid using an extra index to count up. And since we are
>                  * going backwards there, we must also go backwards through the
>                  * array itself, to keep the sort stable.
>   +              *
>   +              * Note that we use an unsigned iterator to make sure we can
>   +              * handle 2^32-1 objects, even on a 32-bit system. But this
>   +              * means we cannot use the more obvious "i >= 0" loop condition
>   +              * for counting backwards, and must instead check for
>   +              * wrap-around with UINT_MAX.
>                  */
>   -             for (i = n - 1; i >= 0; i--)
>   -                     b[--pos[BUCKET_FOR(a, i, bits)]] = a[i];
>   +             for (i = n - 1; i != UINT_MAX; i--)
>   +                     to[--pos[BUCKET_FOR(from, i, bits)]] = from[i];
>
>                 /*
>   -              * Now "b" contains the most sorted list, so we swap "a" and
>   -              * "b" for the next iteration.
>   +              * Now "to" contains the most sorted list, so we swap "from" and
>   +              * "to" for the next iteration.
>                  */
>   -             swap = a;
>   -             a = b;
>   -             b = swap;
>   -
>   -             /* And bump our bits for the next round. */
>   -             bits += DIGIT_SIZE;
>   +             swap = from;
>   +             from = to;
>   +             to = swap;
>         }
>
>         /*
>          * If we ended with our data in the original array, great. If not,
>          * we have to move it back from the temporary storage.
>          */
>   -     if (a != entries)
>   +     if (from != entries)
>                 memcpy(entries, tmp, n * sizeof(*entries));
>         free(tmp);
>         free(pos);
>
>    #undef BUCKET_FOR
>   +#undef BUCKETS
>   +#undef DIGIT_SIZE
>    }
>
>    /*
>
> -- >8 --
> Subject: [PATCH] pack-revindex: radix-sort the revindex
>
> The pack revindex stores the offsets of the objects in the
> pack in sorted order, allowing us to easily find the on-disk
> size of each object. To compute it, we populate an array
> with the offsets from the sha1-sorted idx file, and then use
> qsort to order it by offsets.
>
> That does O(n log n) offset comparisons, and profiling shows
> that we spend most of our time in cmp_offset. However, since
> we are sorting on a simple off_t, we can use numeric sorts
> that perform better. A radix sort can run in O(k*n), where k
> is the number of "digits" in our number. For a 64-bit off_t,
> using 16-bit "digits" gives us k=4.
>
> On the linux.git repo, with about 3M objects to sort, this
> yields a 400% speedup. Here are the best-of-five numbers for
> running
>
>   echo HEAD | git cat-file --batch-check="%(objectsize:disk)
>
> on a fully packed repository, which is dominated by time
> spent building the pack revindex:
>
>           before     after
>   real    0m0.834s   0m0.204s
>   user    0m0.788s   0m0.164s
>   sys     0m0.040s   0m0.036s
>
> This matches our algorithmic expectations. log(3M) is ~21.5,
> so a traditional sort is ~21.5n. Our radix sort runs in k*n,
> where k is the number of radix digits. In the worst case,
> this is k=4 for a 64-bit off_t, but we can quit early when
> the largest value to be sorted is smaller. For any
> repository under 4G, k=2. Our algorithm makes two passes
> over the list per radix digit, so we end up with 4n. That
> should yield ~5.3x speedup. We see 4x here; the difference
> is probably due to the extra bucket book-keeping the radix
> sort has to do.
>
> On a smaller repo, the difference is less impressive, as
> log(n) is smaller. For git.git, with 173K objects (but still
> k=2), we see a 2.7x improvement:
>
>           before     after
>   real    0m0.046s   0m0.017s
>   user    0m0.036s   0m0.012s
>   sys     0m0.008s   0m0.000s
>
> On even tinier repos (e.g., a few hundred objects), the
> speedup goes away entirely, as the small advantage of the
> radix sort gets erased by the book-keeping costs (and at
> those sizes, the cost to generate the the rev-index gets
> lost in the noise anyway).
>
> Signed-off-by: Jeff King <peff@peff.net>
> ---
>  pack-revindex.c | 100 +++++++++++++++++++++++++++++++++++++++++++++++++++++---
>  1 file changed, 95 insertions(+), 5 deletions(-)
>
> diff --git a/pack-revindex.c b/pack-revindex.c
> index 1aa9754..b4d2b35 100644
> --- a/pack-revindex.c
> +++ b/pack-revindex.c
> @@ -59,11 +59,101 @@ static int cmp_offset(const void *a_, const void *b_)
>         /* revindex elements are lazily initialized */
>  }
>
> -static int cmp_offset(const void *a_, const void *b_)
> +/*
> + * This is a least-significant-digit radix sort.
> + *
> + * It sorts each of the "n" items in "entries" by its offset field. The "max"
> + * parameter must be at least as large as the largest offset in the array,
> + * and lets us quit the sort early.
> + */
> +static void sort_revindex(struct revindex_entry *entries, unsigned n, off_t max)
>  {
> -       const struct revindex_entry *a = a_;
> -       const struct revindex_entry *b = b_;
> -       return (a->offset < b->offset) ? -1 : (a->offset > b->offset) ? 1 : 0;
> +       /*
> +        * We use a "digit" size of 16 bits. That keeps our memory
> +        * usage reasonable, and we can generally (for a 4G or smaller
> +        * packfile) quit after two rounds of radix-sorting.
> +        */
> +#define DIGIT_SIZE (16)
> +#define BUCKETS (1 << DIGIT_SIZE)
> +       /*
> +        * We want to know the bucket that a[i] will go into when we are using
> +        * the digit that is N bits from the (least significant) end.
> +        */
> +#define BUCKET_FOR(a, i, bits) (((a)[(i)].offset >> (bits)) & (BUCKETS-1))
> +
> +       /*
> +        * We need O(n) temporary storage. Rather than do an extra copy of the
> +        * partial results into "entries", we sort back and forth between the
> +        * real array and temporary storage. In each iteration of the loop, we
> +        * keep track of them with alias pointers, always sorting from "from"
> +        * to "to".
> +        */
> +       struct revindex_entry *tmp = xmalloc(n * sizeof(*tmp));
> +       struct revindex_entry *from = entries, *to = tmp;
> +       int bits;
> +       unsigned *pos = xmalloc(BUCKETS * sizeof(*pos));
> +
> +       /*
> +        * If (max >> bits) is zero, then we know that the radix digit we are
> +        * on (and any higher) will be zero for all entries, and our loop will
> +        * be a no-op, as everybody lands in the same zero-th bucket.
> +        */
> +       for (bits = 0; max >> bits; bits += DIGIT_SIZE) {
> +               struct revindex_entry *swap;
> +               unsigned i;
> +
> +               memset(pos, 0, BUCKETS * sizeof(*pos));
> +
> +               /*
> +                * We want pos[i] to store the index of the last element that
> +                * will go in bucket "i" (actually one past the last element).
> +                * To do this, we first count the items that will go in each
> +                * bucket, which gives us a relative offset from the last
> +                * bucket. We can then cumulatively add the index from the
> +                * previous bucket to get the true index.
> +                */
> +               for (i = 0; i < n; i++)
> +                       pos[BUCKET_FOR(from, i, bits)]++;
> +               for (i = 1; i < BUCKETS; i++)
> +                       pos[i] += pos[i-1];
> +
> +               /*
> +                * Now we can drop the elements into their correct buckets (in
> +                * our temporary array).  We iterate the pos counter backwards
> +                * to avoid using an extra index to count up. And since we are
> +                * going backwards there, we must also go backwards through the
> +                * array itself, to keep the sort stable.
> +                *
> +                * Note that we use an unsigned iterator to make sure we can
> +                * handle 2^32-1 objects, even on a 32-bit system. But this
> +                * means we cannot use the more obvious "i >= 0" loop condition
> +                * for counting backwards, and must instead check for
> +                * wrap-around with UINT_MAX.
> +                */
> +               for (i = n - 1; i != UINT_MAX; i--)
> +                       to[--pos[BUCKET_FOR(from, i, bits)]] = from[i];
> +
> +               /*
> +                * Now "to" contains the most sorted list, so we swap "from" and
> +                * "to" for the next iteration.
> +                */
> +               swap = from;
> +               from = to;
> +               to = swap;
> +       }
> +
> +       /*
> +        * If we ended with our data in the original array, great. If not,
> +        * we have to move it back from the temporary storage.
> +        */
> +       if (from != entries)
> +               memcpy(entries, tmp, n * sizeof(*entries));
> +       free(tmp);
> +       free(pos);
> +
> +#undef BUCKET_FOR
> +#undef BUCKETS
> +#undef DIGIT_SIZE
>  }
>
>  /*
> @@ -108,7 +198,7 @@ static void create_pack_revindex(struct pack_revindex *rix)
>          */
>         rix->revindex[num_ent].offset = p->pack_size - 20;
>         rix->revindex[num_ent].nr = -1;
> -       qsort(rix->revindex, num_ent, sizeof(*rix->revindex), cmp_offset);
> +       sort_revindex(rix->revindex, num_ent, p->pack_size);
>  }
>
>  struct revindex_entry *find_pack_revindex(struct packed_git *p, off_t ofs)
> --
> 1.8.3.rc3.24.gec82cb9
>
Previous: Jeff King
Message 52 of 52 in “cat-file --batch-disk-sizes”
  1. 0/4 cat-file --batch-disk-sizesJeff King, Jul 7, 2013
  2. 1/4 zero-initialize object_info structsJeff King, Jul 7, 2013
  3. Junio C HamanoJul 7, 2013
  4. 2/4 teach sha1_object_info_extended a "disk_size" queryJeff King, Jul 7, 2013
  5. 3/4 cat-file: add --batch-disk-sizes optionJeff King, Jul 7, 2013
  6. Junio C HamanoJul 7, 2013
  7. Jeff KingJul 7, 2013
  8. Duy NguyenJul 8, 2013
  9. Ramkumar RamachandraJul 8, 2013
  10. Duy NguyenJul 8, 2013
  11. Ramkumar RamachandraJul 8, 2013
  12. Duy NguyenJul 9, 2013
  13. Ramkumar RamachandraJul 9, 2013
  14. Jeff KingJul 10, 2013
  15. Junio C HamanoJul 8, 2013
  16. Jeff KingJul 10, 2013
  17. Junio C HamanoJul 11, 2013
  18. brian m. carlsonJul 7, 2013
  19. Jeff KingJul 10, 2013
  20. 4/4 pack-revindex: radix-sort the revindexJeff King, Jul 7, 2013
  21. Shawn PearceJul 7, 2013
  22. Jeff KingJul 8, 2013
  23. Shawn PearceJul 8, 2013
  24. Brandon CaseyJul 8, 2013
  25. Brandon CaseyJul 8, 2013
  26. Jeff KingJul 10, 2013
  27. Jeff KingJul 10, 2013
  28. 00/10 cat-file formats/on-disk sizesJeff King, Jul 10, 2013
  29. 01/10 zero-initialize object_info structsJeff King, Jul 10, 2013
  30. 02/10 teach sha1_object_info_extended a "disk_size" queryJeff King, Jul 10, 2013
  31. 03/10 t1006: modernize output comparisonsJeff King, Jul 10, 2013
  32. 04/10 cat-file: teach --batch to stream blob objectsJeff King, Jul 10, 2013
  33. 05/10 cat-file: refactor --batch option parsingJeff King, Jul 10, 2013
  34. 06/10 cat-file: add --batch-check=<format>Jeff King, Jul 10, 2013
  35. Eric SunshineJul 10, 2013
  36. Ramkumar RamachandraJul 10, 2013
  37. Jeff KingJul 11, 2013
  38. 07/10 cat-file: add %(objectsize:disk) format atomJeff King, Jul 10, 2013
  39. 08/10 cat-file: split --batch input lines on whitespaceJeff King, Jul 10, 2013
  40. Ramkumar RamachandraJul 10, 2013
  41. Jeff KingJul 11, 2013
  42. Junio C HamanoJul 11, 2013
  43. 08/10 cat-file: split --batch input lines on whitespaceJeff King, Jul 11, 2013
  44. 09/10 pack-revindex: use unsigned to store number of objectsJeff King, Jul 10, 2013
  45. 10/10 pack-revindex: radix-sort the revindexJeff King, Jul 10, 2013
  46. Jeff KingJul 10, 2013
  47. Ramkumar RamachandraJul 10, 2013
  48. Jeff KingJul 11, 2013
  49. Brandon CaseyJul 10, 2013
  50. Jeff KingJul 11, 2013
  51. 10/10 pack-revindex: radix-sort the revindexJeff King, Jul 11, 2013
  52. Brandon CaseyJul 11, 2013

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.