blob: 926d00429ed23901c288bc7b620a616ae90c2eff [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * A fast, small, non-recursive O(nlog n) sort for the Linux kernel
3 *
4 * Jan 23 2005 Matt Mackall <mpm@selenic.com>
5 */
6
7#include <linux/kernel.h>
8#include <linux/module.h>
Adrian Bunkecec4cb2005-09-10 00:26:59 -07009#include <linux/sort.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080010#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
Adrian Bunkecec4cb2005-09-10 00:26:59 -070012static void u32_swap(void *a, void *b, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -070013{
14 u32 t = *(u32 *)a;
15 *(u32 *)a = *(u32 *)b;
16 *(u32 *)b = t;
17}
18
Adrian Bunkecec4cb2005-09-10 00:26:59 -070019static void generic_swap(void *a, void *b, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -070020{
21 char t;
22
23 do {
24 t = *(char *)a;
25 *(char *)a++ = *(char *)b;
26 *(char *)b++ = t;
27 } while (--size > 0);
28}
29
Robert P. J. Day72fd4a32007-02-10 01:45:59 -080030/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 * sort - sort an array of elements
32 * @base: pointer to data to sort
33 * @num: number of elements
34 * @size: size of each element
Wu Fengguangb53907c2009-01-07 18:09:11 -080035 * @cmp_func: pointer to comparison function
36 * @swap_func: pointer to swap function or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 *
38 * This function does a heapsort on the given array. You may provide a
Wu Fengguangb53907c2009-01-07 18:09:11 -080039 * swap_func function optimized to your element type.
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 *
41 * Sorting time is O(n log n) both on average and worst-case. While
42 * qsort is about 20% faster on average, it suffers from exploitable
43 * O(n*n) worst-case behavior and extra memory requirements that make
44 * it less suitable for kernel use.
45 */
46
47void sort(void *base, size_t num, size_t size,
Wu Fengguangb53907c2009-01-07 18:09:11 -080048 int (*cmp_func)(const void *, const void *),
49 void (*swap_func)(void *, void *, int size))
Linus Torvalds1da177e2005-04-16 15:20:36 -070050{
51 /* pre-scale counters for performance */
keiosd3717bd2006-10-03 01:13:49 -070052 int i = (num/2 - 1) * size, n = num * size, c, r;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Wu Fengguangb53907c2009-01-07 18:09:11 -080054 if (!swap_func)
55 swap_func = (size == 4 ? u32_swap : generic_swap);
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57 /* heapify */
58 for ( ; i >= 0; i -= size) {
keiosd3717bd2006-10-03 01:13:49 -070059 for (r = i; r * 2 + size < n; r = c) {
60 c = r * 2 + size;
Wu Fengguangb53907c2009-01-07 18:09:11 -080061 if (c < n - size &&
62 cmp_func(base + c, base + c + size) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 c += size;
Wu Fengguangb53907c2009-01-07 18:09:11 -080064 if (cmp_func(base + r, base + c) >= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 break;
Wu Fengguangb53907c2009-01-07 18:09:11 -080066 swap_func(base + r, base + c, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 }
68 }
69
70 /* sort */
Subbaiah Venkata995e4282007-10-16 23:27:06 -070071 for (i = n - size; i > 0; i -= size) {
Wu Fengguangb53907c2009-01-07 18:09:11 -080072 swap_func(base, base + i, size);
keiosd3717bd2006-10-03 01:13:49 -070073 for (r = 0; r * 2 + size < i; r = c) {
74 c = r * 2 + size;
Wu Fengguangb53907c2009-01-07 18:09:11 -080075 if (c < i - size &&
76 cmp_func(base + c, base + c + size) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 c += size;
Wu Fengguangb53907c2009-01-07 18:09:11 -080078 if (cmp_func(base + r, base + c) >= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 break;
Wu Fengguangb53907c2009-01-07 18:09:11 -080080 swap_func(base + r, base + c, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 }
82 }
83}
84
85EXPORT_SYMBOL(sort);
86
87#if 0
88/* a simple boot-time regression test */
89
90int cmpint(const void *a, const void *b)
91{
92 return *(int *)a - *(int *)b;
93}
94
95static int sort_test(void)
96{
Domen Puncerd28c2bc2005-05-05 16:16:19 -070097 int *a, i, r = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99 a = kmalloc(1000 * sizeof(int), GFP_KERNEL);
100 BUG_ON(!a);
101
102 printk("testing sort()\n");
103
104 for (i = 0; i < 1000; i++) {
105 r = (r * 725861) % 6599;
106 a[i] = r;
107 }
108
109 sort(a, 1000, sizeof(int), cmpint, NULL);
110
111 for (i = 0; i < 999; i++)
112 if (a[i] > a[i+1]) {
113 printk("sort() failed!\n");
114 break;
115 }
116
117 kfree(a);
118
119 return 0;
120}
121
122module_init(sort_test);
123#endif