Blame lib/list_sort.c

Packit 99347c
// SPDX-License-Identifier: GPL-2.0
Packit 99347c
/* Copied from the Linux kernel lib/list_sort.c file */
Packit 99347c
#include <stdlib.h>
Packit 99347c
#include <string.h>			/* memset */
Packit 99347c
#include <libipset/list_sort.h>
Packit 99347c
Packit 99347c
#define MAX_LIST_LENGTH_BITS 20
Packit 99347c
Packit 99347c
/*
Packit 99347c
 * Returns a list organized in an intermediate format suited
Packit 99347c
 * to chaining of merge() calls: null-terminated, no reserved or
Packit 99347c
 * sentinel head node, "prev" links not maintained.
Packit 99347c
 */
Packit 99347c
static struct list_head *merge(void *priv,
Packit 99347c
				int (*cmp)(void *priv, struct list_head *a,
Packit 99347c
					struct list_head *b),
Packit 99347c
				struct list_head *a, struct list_head *b)
Packit 99347c
{
Packit 99347c
	struct list_head head, *tail = &head;
Packit 99347c
Packit 99347c
	while (a && b) {
Packit 99347c
		/* if equal, take 'a' -- important for sort stability */
Packit 99347c
		if ((*cmp)(priv, a, b) <= 0) {
Packit 99347c
			tail->next = a;
Packit 99347c
			a = a->next;
Packit 99347c
		} else {
Packit 99347c
			tail->next = b;
Packit 99347c
			b = b->next;
Packit 99347c
		}
Packit 99347c
		tail = tail->next;
Packit 99347c
	}
Packit 99347c
	tail->next = a?:b;
Packit 99347c
	return head.next;
Packit 99347c
}
Packit 99347c
Packit 99347c
/*
Packit 99347c
 * Combine final list merge with restoration of standard doubly-linked
Packit 99347c
 * list structure.  This approach duplicates code from merge(), but
Packit 99347c
 * runs faster than the tidier alternatives of either a separate final
Packit 99347c
 * prev-link restoration pass, or maintaining the prev links
Packit 99347c
 * throughout.
Packit 99347c
 */
Packit 99347c
static void merge_and_restore_back_links(void *priv,
Packit 99347c
				int (*cmp)(void *priv, struct list_head *a,
Packit 99347c
					struct list_head *b),
Packit 99347c
				struct list_head *head,
Packit 99347c
				struct list_head *a, struct list_head *b)
Packit 99347c
{
Packit 99347c
	struct list_head *tail = head;
Packit 99347c
	int count = 0;
Packit 99347c
Packit 99347c
	while (a && b) {
Packit 99347c
		/* if equal, take 'a' -- important for sort stability */
Packit 99347c
		if ((*cmp)(priv, a, b) <= 0) {
Packit 99347c
			tail->next = a;
Packit 99347c
			a->prev = tail;
Packit 99347c
			a = a->next;
Packit 99347c
		} else {
Packit 99347c
			tail->next = b;
Packit 99347c
			b->prev = tail;
Packit 99347c
			b = b->next;
Packit 99347c
		}
Packit 99347c
		tail = tail->next;
Packit 99347c
	}
Packit 99347c
	tail->next = a ? : b;
Packit 99347c
Packit 99347c
	do {
Packit 99347c
		/*
Packit 99347c
		 * In worst cases this loop may run many iterations.
Packit 99347c
		 * Continue callbacks to the client even though no
Packit 99347c
		 * element comparison is needed, so the client's cmp()
Packit 99347c
		 * routine can invoke cond_resched() periodically.
Packit 99347c
		 */
Packit 99347c
		if (unlikely(!(++count)))
Packit 99347c
			(*cmp)(priv, tail->next, tail->next);
Packit 99347c
Packit 99347c
		tail->next->prev = tail;
Packit 99347c
		tail = tail->next;
Packit 99347c
	} while (tail->next);
Packit 99347c
Packit 99347c
	tail->next = head;
Packit 99347c
	head->prev = tail;
Packit 99347c
}
Packit 99347c
Packit 99347c
/**
Packit 99347c
 * list_sort - sort a list
Packit 99347c
 * @priv: private data, opaque to list_sort(), passed to @cmp
Packit 99347c
 * @head: the list to sort
Packit 99347c
 * @cmp: the elements comparison function
Packit 99347c
 *
Packit 99347c
 * This function implements "merge sort", which has O(nlog(n))
Packit 99347c
 * complexity.
Packit 99347c
 *
Packit 99347c
 * The comparison function @cmp must return a negative value if @a
Packit 99347c
 * should sort before @b, and a positive value if @a should sort after
Packit 99347c
 * @b. If @a and @b are equivalent, and their original relative
Packit 99347c
 * ordering is to be preserved, @cmp must return 0.
Packit 99347c
 */
Packit 99347c
void list_sort(void *priv, struct list_head *head,
Packit 99347c
		int (*cmp)(void *priv, struct list_head *a,
Packit 99347c
			struct list_head *b))
Packit 99347c
{
Packit 99347c
	struct list_head *part[MAX_LIST_LENGTH_BITS+1]; /* sorted partial lists
Packit 99347c
						-- last slot is a sentinel */
Packit 99347c
	int lev;  /* index into part[] */
Packit 99347c
	int max_lev = 0;
Packit 99347c
	struct list_head *list;
Packit 99347c
Packit 99347c
	if (list_empty(head))
Packit 99347c
		return;
Packit 99347c
Packit 99347c
	memset(part, 0, sizeof(part));
Packit 99347c
Packit 99347c
	head->prev->next = NULL;
Packit 99347c
	list = head->next;
Packit 99347c
Packit 99347c
	while (list) {
Packit 99347c
		struct list_head *cur = list;
Packit 99347c
		list = list->next;
Packit 99347c
		cur->next = NULL;
Packit 99347c
Packit 99347c
		for (lev = 0; part[lev]; lev++) {
Packit 99347c
			cur = merge(priv, cmp, part[lev], cur);
Packit 99347c
			part[lev] = NULL;
Packit 99347c
		}
Packit 99347c
		if (lev > max_lev) {
Packit 99347c
			if (unlikely(lev >= MAX_LIST_LENGTH_BITS)) {
Packit 99347c
				// printk_once(KERN_DEBUG "list too long for efficiency\n");
Packit 99347c
				lev--;
Packit 99347c
			}
Packit 99347c
			max_lev = lev;
Packit 99347c
		}
Packit 99347c
		part[lev] = cur;
Packit 99347c
	}
Packit 99347c
Packit 99347c
	for (lev = 0; lev < max_lev; lev++)
Packit 99347c
		if (part[lev])
Packit 99347c
			list = merge(priv, cmp, part[lev], list);
Packit 99347c
Packit 99347c
	merge_and_restore_back_links(priv, cmp, head, part[max_lev], list);
Packit 99347c
}