drvmgr_list.h

Go to the documentation of this file.

/* Linked list help functions used by driver manager.
 *
 * COPYRIGHT (c) 2009 Cobham Gaisler AB.
 *
 * The license and distribution terms for this file may be
 * found in the file LICENSE in this distribution or at
 * http://www.rtems.org/license/LICENSE.
 */

/*
 * Help functions for the Driver Manager. Implements a singly linked list
 * with head and tail pointers for fast insertions/deletions to head and
 * tail in list.
 */

#ifndef _DRVIVER_MANAGER_LIST_H_
#define _DRVIVER_MANAGER_LIST_H_

#ifdef __cplusplus
extern "C" {
#endif

struct drvmgr_list {
        void    *head;  
        void    *tail;  
        int     ofs;    
};

/* Static initialization of list */
#define LIST_INITIALIZER(type, field) {NULL, NULL, offsetof(type, field)}

/* Return the first element in list */
#define LIST_HEAD(list, type) ((type *)(list)->head)

/* Return the last element in list */
#define LIST_TAIL(list, type) ((type *)(list)->tail)

/* Get the next pointer of an entry */
#define LIST_FIELD(list, entry) (*(void **)((char *)(entry) + (list)->ofs))

/* Return the next emlement in list */
#define LIST_NEXT(list, entry, type) ((type *)(LIST_FIELD(list, entry)))

/* Iterate through all entries in list */
#define LIST_FOR_EACH(list, entry, type) \
        for (entry = LIST_HEAD(list, type); \
             entry; \
             entry = LIST_NEXT(list, entry, type))

extern void drvmgr_list_init(struct drvmgr_list *list, int offset);

extern void drvmgr_list_empty(struct drvmgr_list *list);

extern void drvmgr_list_add_head(struct drvmgr_list *list, void *entry);

extern void drvmgr_list_add_tail(struct drvmgr_list *list, void *entry);

extern void drvmgr_list_remove_head(struct drvmgr_list *list);

extern void drvmgr_list_remove(struct drvmgr_list *list, void *entry);

#ifdef __cplusplus
}
#endif

#endif