/* A simple unit testing framework for C
 *
 * This is a simple testing framework.
 * Look at test_this_framework.h for an example test definition.
 *
 * $Author: $
 * $Revision: $
 */
#ifndef  _CUTER_PRIV_H
#define  _CUTER_PRIV_H

#include <stdio.h>
#include <string.h>
#include <stddef.h>
#include <CUTer.h>

/*** LINKED CUTER_LIST IMPLEMENTATION FROM LINUX KERNEL ***/

/* From Linux Kernel 2.6.20. Modified to remove 
 * rcu and prefetching.
 * - redpig@dataspill.org
 */

#ifndef container_of
#define container_of(ptr, type, member) ({                      \
        const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
        (type *)( (char *)__mptr - offsetof(type,member) );})
#endif

/*
 * These are non-NULL pointers that will result in page faults
 * under normal circumstances, used to verify that nobody uses
 * non-initialized list entries.
 */
#define CUTER_LIST_POISON1  ((void *) 0x00100100)
#define CUTER_LIST_POISON2  ((void *) 0x00200200)

/*
 * Simple doubly linked list implementation.
 *
 * Some of the internal functions ("__xxx") are useful when
 * manipulating whole lists rather than single entries, as
 * sometimes we already know the next/prev entries and we can
 * generate better code by using them directly rather than
 * using the generic single-entry routines.
 */

#define CUTER_LIST_HEAD_INIT(name) { &(name), &(name) }

#define CUTER_LIST_HEAD(name) \
	struct cuter_list_head name = CUTER_LIST_HEAD_INIT(name)

#define INIT_CUTER_LIST_HEAD(ptr) do { \
	(ptr)->next = (ptr); (ptr)->prev = (ptr); \
} while (0)

/*
 * Insert a new entry between two known consecutive entries.
 *
 * This is only for internal list manipulation where we know
 * the prev/next entries already!
 */
static inline void __cuter_list_add(struct cuter_list_head *new,
			      struct cuter_list_head *prev,
			      struct cuter_list_head *next)
{
	next->prev = new;
	new->next = next;
	new->prev = prev;
	prev->next = new;
}

/**
 * cuter_list_add - add a new entry
 * @new: new entry to be added
 * @head: list head to add it after
 *
 * Insert a new entry after the specified head.
 * This is good for implementing stacks.
 */
static inline void cuter_list_add(struct cuter_list_head *new, struct cuter_list_head *head)
{
	__cuter_list_add(new, head, head->next);
}

/**
 * cuter_list_add_tail - add a new entry
 * @new: new entry to be added
 * @head: list head to add it before
 *
 * Insert a new entry before the specified head.
 * This is useful for implementing queues.
 */
static inline void cuter_list_add_tail(struct cuter_list_head *new, struct cuter_list_head *head)
{
	__cuter_list_add(new, head->prev, head);
}

/*
 * Delete a list entry by making the prev/next entries
 * point to each other.
 *
 * This is only for internal list manipulation where we know
 * the prev/next entries already!
 */
static inline void __cuter_list_del(struct cuter_list_head * prev, struct cuter_list_head * next)
{
	next->prev = prev;
	prev->next = next;
}

/**
 * cuter_list_del - deletes entry from list.
 * @entry: the element to delete from the list.
 * Note: cuter_list_empty on entry does not return true after this, the entry is
 * in an undefined state.
 */
static inline void cuter_list_del(struct cuter_list_head *entry)
{
	__cuter_list_del(entry->prev, entry->next);
	entry->next = CUTER_LIST_POISON1;
	entry->prev = CUTER_LIST_POISON2;
}

/**
 * cuter_list_del_init - deletes entry from list and reinitialize it.
 * @entry: the element to delete from the list.
 */
static inline void cuter_list_del_init(struct cuter_list_head *entry)
{
	__cuter_list_del(entry->prev, entry->next);
	INIT_CUTER_LIST_HEAD(entry);
}

/**
 * cuter_list_move - delete from one list and add as another's head
 * @list: the entry to move
 * @head: the head that will precede our entry
 */
static inline void cuter_list_move(struct cuter_list_head *list, struct cuter_list_head *head)
{
        __cuter_list_del(list->prev, list->next);
        cuter_list_add(list, head);
}

/**
 * cuter_list_move_tail - delete from one list and add as another's tail
 * @list: the entry to move
 * @head: the head that will follow our entry
 */
static inline void cuter_list_move_tail(struct cuter_list_head *list,
				  struct cuter_list_head *head)
{
        __cuter_list_del(list->prev, list->next);
        cuter_list_add_tail(list, head);
}

/**
 * cuter_list_empty - tests whether a list is empty
 * @head: the list to test.
 */
static inline int cuter_list_empty(const struct cuter_list_head *head)
{
	return head->next == head;
}

/**
 * cuter_list_empty_careful - tests whether a list is
 * empty _and_ checks that no other CPU might be
 * in the process of still modifying either member
 *
 * NOTE: using cuter_list_empty_careful() without synchronization
 * can only be safe if the only activity that can happen
 * to the list entry is cuter_list_del_init(). Eg. it cannot be used
 * if another CPU could re-list_add() it.
 *
 * @head: the list to test.
 */
static inline int cuter_list_empty_careful(const struct cuter_list_head *head)
{
	struct cuter_list_head *next = head->next;
	return (next == head) && (next == head->prev);
}

static inline void __cuter_list_splice(struct cuter_list_head *list,
				 struct cuter_list_head *head)
{
	struct cuter_list_head *first = list->next;
	struct cuter_list_head *last = list->prev;
	struct cuter_list_head *at = head->next;

	first->prev = head;
	head->next = first;

	last->next = at;
	at->prev = last;
}

/**
 * cuter_list_splice - join two lists
 * @list: the new list to add.
 * @head: the place to add it in the first list.
 */
static inline void cuter_list_splice(struct cuter_list_head *list, struct cuter_list_head *head)
{
	if (!cuter_list_empty(list))
		__cuter_list_splice(list, head);
}

/**
 * cuter_list_splice_init - join two lists and reinitialise the emptied list.
 * @list: the new list to add.
 * @head: the place to add it in the first list.
 *
 * The list at @list is reinitialised
 */
static inline void cuter_list_splice_init(struct cuter_list_head *list,
				    struct cuter_list_head *head)
{
	if (!cuter_list_empty(list)) {
		__cuter_list_splice(list, head);
		INIT_CUTER_LIST_HEAD(list);
	}
}

/**
 * cuter_list_entry - get the struct for this entry
 * @ptr:	the &struct cuter_list_head pointer.
 * @type:	the type of the struct this is embedded in.
 * @member:	the name of the cuter_list_struct within the struct.
 */
#define cuter_list_entry(ptr, type, member) \
	container_of(ptr, type, member)

/**
 * cuter_list_for_each	-	iterate over a list
 * @pos:	the &struct cuter_list_head to use as a loop counter.
 * @head:	the head for your list.
 */
#define cuter_list_for_each(pos, head) \
	for (pos = (head)->next; pos != (head); \
        	pos = pos->next)

/**
 * __cuter_list_for_each	-	iterate over a list
 * @pos:	the &struct cuter_list_head to use as a loop counter.
 * @head:	the head for your list.
 *
 * This variant differs from cuter_list_for_each() in that it's the
 * simplest possible list iteration code, no prefetching is done.
 * Use this for code that knows the list to be very short (empty
 * or 1 entry) most of the time.
 */
#define __cuter_list_for_each(pos, head) \
	for (pos = (head)->next; pos != (head); pos = pos->next)

/**
 * cuter_list_for_each_prev	-	iterate over a list backwards
 * @pos:	the &struct cuter_list_head to use as a loop counter.
 * @head:	the head for your list.
 */
#define cuter_list_for_each_prev(pos, head) \
	for (pos = (head)->prev; pos != (head); \
        	pos = pos->prev)

/**
 * cuter_list_for_each_safe	-	iterate over a list safe against removal of list entry
 * @pos:	the &struct cuter_list_head to use as a loop counter.
 * @n:		another &struct cuter_list_head to use as temporary storage
 * @head:	the head for your list.
 */
#define cuter_list_for_each_safe(pos, n, head) \
	for (pos = (head)->next, n = pos->next; pos != (head); \
		pos = n, n = pos->next)

/**
 * cuter_list_for_each_entry	-	iterate over list of given type
 * @pos:	the type * to use as a loop counter.
 * @head:	the head for your list.
 * @member:	the name of the cuter_list_struct within the struct.
 */
#define cuter_list_for_each_entry(pos, head, member)				\
	for (pos = cuter_list_entry((head)->next, typeof(*pos), member);	\
	     &pos->member != (head); 	\
	     pos = cuter_list_entry(pos->member.next, typeof(*pos), member))

/**
 * cuter_list_for_each_entry_reverse - iterate backwards over list of given type.
 * @pos:	the type * to use as a loop counter.
 * @head:	the head for your list.
 * @member:	the name of the cuter_list_struct within the struct.
 */
#define cuter_list_for_each_entry_reverse(pos, head, member)			\
	for (pos = cuter_list_entry((head)->prev, typeof(*pos), member);	\
	     &pos->member != (head); 	\
	     pos = cuter_list_entry(pos->member.prev, typeof(*pos), member))

/**
 * cuter_list_prepare_entry - prepare a pos entry for use as a start point in
 *			list_for_each_entry_continue
 * @pos:	the type * to use as a start point
 * @head:	the head of the list
 * @member:	the name of the cuter_list_struct within the struct.
 */
#define cuter_list_prepare_entry(pos, head, member) \
	((pos) ? : cuter_list_entry(head, typeof(*pos), member))

/**
 * cuter_list_for_each_entry_continue -	iterate over list of given type
 *			continuing after existing point
 * @pos:	the type * to use as a loop counter.
 * @head:	the head for your list.
 * @member:	the name of the cuter_list_struct within the struct.
 */
#define cuter_list_for_each_entry_continue(pos, head, member) 		\
	for (pos = cuter_list_entry(pos->member.next, typeof(*pos), member);	\
	     &pos->member != (head);	\
	     pos = cuter_list_entry(pos->member.next, typeof(*pos), member))

/**
 * cuter_list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
 * @pos:	the type * to use as a loop counter.
 * @n:		another type * to use as temporary storage
 * @head:	the head for your list.
 * @member:	the name of the cuter_list_struct within the struct.
 */
#define cuter_list_for_each_entry_safe(pos, n, head, member)			\
	for (pos = cuter_list_entry((head)->next, typeof(*pos), member),	\
		n = cuter_list_entry(pos->member.next, typeof(*pos), member);	\
	     &pos->member != (head); 					\
	     pos = n, n = cuter_list_entry(n->member.next, typeof(*n), member))

/**
 * cuter_list_for_each_entry_safe_continue -	iterate over list of given type
 *			continuing after existing point safe against removal of list entry
 * @pos:	the type * to use as a loop counter.
 * @n:		another type * to use as temporary storage
 * @head:	the head for your list.
 * @member:	the name of the cuter_list_struct within the struct.
 */
#define cuter_list_for_each_entry_safe_continue(pos, n, head, member) 		\
	for (pos = cuter_list_entry(pos->member.next, typeof(*pos), member), 		\
		n = cuter_list_entry(pos->member.next, typeof(*pos), member);		\
	     &pos->member != (head);						\
	     pos = n, n = cuter_list_entry(n->member.next, typeof(*n), member))

#endif  /* _CUTER_PRIV_H */