osal_list.h

浏览该文件的文档.

/*
 * Copyright (c) HiSilicon (Shanghai) Technologies Co., Ltd. 2021-2022. All rights reserved.
 * Description: osal list
 *
 * Create: 2021-12-16
 */
 
#ifndef _OSAL_LIST_H
#define _OSAL_LIST_H
 
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif
#endif
 
#ifndef NULL
#define NULL ((void*)0)
#endif
 
#ifndef INLINE__
#ifdef INLINE_TO_FORCEINLINE
#define INLINE__    __inline__ __attribute__((always_inline))
#else
#define INLINE__    __inline
#endif
#endif
 
/*
 * 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.
 */
 
struct osal_list_head {
    struct osal_list_head *next, *prev;
};
#define OSAL_LIST_HEAD_INIT(name) \
    {                             \
        &(name), &(name)          \
    }
 
#define OSAL_LIST_HEAD(name) \
    struct osal_list_head name = OSAL_LIST_HEAD_INIT(name)
 
static INLINE__ void OSAL_INIT_LIST_HEAD(struct osal_list_head *list)
{
    if (list == NULL) {
        return;
    }
    list->next = list;
    list->prev = list;
}
 
/*
 * 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 osal___list_add(struct osal_list_head *_new,
    struct osal_list_head *prev,
    struct osal_list_head *next)
{
    if (_new == NULL || prev == NULL || next == NULL) {
        return;
    }
    next->prev = _new;
    _new->next = next;
    _new->prev = prev;
    prev->next = _new;
}
 
static INLINE__ void osal_list_add(struct osal_list_head *cur, struct osal_list_head *head)
{
    osal___list_add(cur, head, head->next);
}
 
static INLINE__ void osal_list_add_tail(struct osal_list_head *cur, struct osal_list_head *head)
{
    osal___list_add(cur, 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 osal___list_del(struct osal_list_head *prev, struct osal_list_head *next)
{
    if (prev == NULL || next == NULL) {
        return;
    }
 
    next->prev = prev;
    prev->next = next;
}
 
static INLINE__ void osal___list_del_entry(struct osal_list_head *entry)
{
    if (entry == NULL) {
        return;
    }
    osal___list_del(entry->prev, entry->next);
}
 
#define OSAL_LIST_POISON1    0x00100100
#define OSAL_LIST_POISON2    0x00200200
 
static INLINE__ void osal_list_del(struct osal_list_head *entry)
{
    if (entry == NULL) {
        return;
    }
    osal___list_del(entry->prev, entry->next);
    entry->next = (struct osal_list_head *) OSAL_LIST_POISON1;
    entry->prev = (struct osal_list_head *) OSAL_LIST_POISON2;
}
 
static INLINE__ void osal_list_replace(struct osal_list_head *old,
    struct osal_list_head *_new)
{
    _new->next = old->next;
    _new->next->prev = _new;
    _new->prev = old->prev;
    _new->prev->next = _new;
}
 
static INLINE__ void osal_list_replace_init(struct osal_list_head *old,
    struct osal_list_head *_new)
{
    osal_list_replace(old, _new);
    OSAL_INIT_LIST_HEAD(old);
}
 
static INLINE__ void osal_list_del_init(struct osal_list_head *entry)
{
    osal___list_del_entry(entry);
    OSAL_INIT_LIST_HEAD(entry);
}
 
static INLINE__ void osal_list_move(struct osal_list_head *list, struct osal_list_head *head)
{
    osal___list_del_entry(list);
    osal_list_add(list, head);
}
 
static INLINE__ void osal_list_move_tail(struct osal_list_head *list,
    struct osal_list_head *head)
{
    osal___list_del_entry(list);
    osal_list_add_tail(list, head);
}
 
static INLINE__ int osal_list_is_last(const struct osal_list_head *list,
    const struct osal_list_head *head)
{
    if (list == NULL || head == NULL) {
        return -1;
    }
 
    return list->next == head;
}
 
static INLINE__ int osal_list_empty(const struct osal_list_head *head)
{
    if (head == NULL) {
        return -1;
    }
 
    return head->next == head;
}
 
static INLINE__ int osal_list_empty_careful(const struct osal_list_head *head)
{
    struct osal_list_head *next = NULL;
 
    if (head == NULL) {
        return -1;
    }
 
    next = head->next;
 
    return (next == head) && (next == head->prev);
}
 
static INLINE__ void osal_list_rotate_left(struct osal_list_head *head)
{
    struct osal_list_head *first = NULL;
 
    if (osal_list_empty(head) == 0) {
        first = head->next;
        osal_list_move_tail(first, head);
    }
}
 
static INLINE__ int osal_list_is_singular(const struct osal_list_head *head)
{
    return (osal_list_empty(head) == 0) && (head->next == head->prev);
}
 
static INLINE__ void osal___list_cut_position(struct osal_list_head *list,
    struct osal_list_head *head, struct osal_list_head *entry)
{
    struct osal_list_head *new_first = entry->next;
    list->next = head->next;
    list->next->prev = list;
    list->prev = entry;
    entry->next = list;
    head->next = new_first;
    new_first->prev = head;
}
 
static INLINE__ void osal_list_cut_position(struct osal_list_head *list,
    struct osal_list_head *head, struct osal_list_head *entry)
{
    if (osal_list_empty(head) != 0) {
        return;
    }
    if (osal_list_is_singular(head) != 0 &&
        ((head->next != entry) && (head != entry))) {
        return;
    }
    (entry == head) ? OSAL_INIT_LIST_HEAD(list) : osal___list_cut_position(list, head, entry);
}
 
static INLINE__ void osal___list_splice(const struct osal_list_head *list,
    struct osal_list_head *prev,
    struct osal_list_head *next)
{
    struct osal_list_head *first = list->next;
    struct osal_list_head *last = list->prev;
 
    first->prev = prev;
    prev->next = first;
 
    last->next = next;
    next->prev = last;
}
 
static INLINE__ void osal_list_splice(const struct osal_list_head *list,
    struct osal_list_head *head)
{
    if (osal_list_empty(list) == 0) {
        osal___list_splice(list, head, head->next);
    }
}
 
static INLINE__ void osal_list_splice_tail(struct osal_list_head *list,
    struct osal_list_head *head)
{
    if (osal_list_empty(list) == 0) {
        osal___list_splice(list, head->prev, head);
    }
}
 
static INLINE__ void osal_list_splice_init(struct osal_list_head *list,
    struct osal_list_head *head)
{
    if (osal_list_empty(list) == 0) {
        osal___list_splice(list, head, head->next);
        OSAL_INIT_LIST_HEAD(list);
    }
}
 
static INLINE__ void osal_list_splice_tail_init(struct osal_list_head *list,
    struct osal_list_head *head)
{
    if (osal_list_empty(list) == 0) {
        osal___list_splice(list, head->prev, head);
        OSAL_INIT_LIST_HEAD(list);
    }
}
 
#undef osal_offsetof
#ifdef __compiler_offsetof
#define osal_offsetof(TYPE, MEMBER) __compiler_offsetof(TYPE, MEMBER)
#else
#define osal_offsetof(TYPE, MEMBER) ((int)(unsigned long)&((TYPE *)0)->MEMBER)
#endif
 
#define osal_container_of(ptr, type, member) ({          \
    const __typeof__( ((type *)0)->member ) *__mptr = (ptr);    \
    (type *)((char *)__mptr - osal_offsetof(type, member)); })
 
#define osal_list_entry(ptr, type, member) \
    osal_container_of(ptr, type, member)
 
#define osal_list_first_entry(ptr, type, member) \
    osal_list_entry((ptr)->next, type, member)
 
#define osal_list_for_each(pos, head) \
    for ((pos) = (head)->next; (pos) != (head); (pos) = (pos)->next)
 
#define osal___list_for_each(pos, head) \
    for ((pos) = (head)->next; (pos) != (head); (pos) = (pos)->next)
 
#define osal_list_for_each_prev(pos, head) \
    for ((pos) = (head)->prev; (pos) != (head); (pos) = (pos)->prev)
 
#define osal_list_for_each_safe(pos, n, head)              \
    for ((pos) = (head)->next, (n) = (pos)->next; (pos) != (head); \
         (pos) = (n), (n) = (pos)->next)
 
#define osal_list_for_each_prev_safe(pos, n, head) \
    for ((pos) = (head)->prev, (n) = (pos)->prev;        \
         (pos) != (head);                            \
         (pos) = (n), (n) = (pos)->prev)
 
#define osal_list_for_each_entry(pos, head, member)                     \
    for ((pos) = osal_list_entry((head)->next, __typeof__(*pos), member); \
         &pos->member != (head);                                        \
         (pos) = osal_list_entry((pos)->member.next, __typeof__(*pos), member))
 
#define osal_list_for_each_entry_reverse(pos, head, member)            \
    for ((pos) = osal_list_entry((head)->prev, __typeof__(*pos), member); \
         &pos->member != (head);                                        \
         (pos) = osal_list_entry((pos)->member.prev, __typeof__(*pos), member))
 
#define osal_list_prepare_entry(pos, head, member) \
    ((pos) ? : osal_list_entry(head, __typeof__(*pos), member))
 
#define osal_list_for_each_entry_continue(pos, head, member)                \
    for ((pos) = osal_list_entry((pos)->member.next, __typeof__(*pos), member); \
         &pos->member != (head);                                            \
         (pos) = osal_list_entry((pos)->member.next, __typeof__(*pos), member))
 
#define osal_list_for_each_entry_continue_reverse(pos, head, member)        \
    for ((pos) = osal_list_entry((pos)->member.prev, __typeof__(*pos), member); \
         &pos->member != (head);                                            \
         (pos) = osal_list_entry((pos)->member.prev, __typeof__(*pos), member))
 
#define osal_list_for_each_entry_from(pos, head, member) \
    for (; &pos->member != (head);                       \
        (pos) = osal_list_entry((pos)->member.next, __typeof__(*pos), member))
 
#define osal_list_for_each_entry_safe(pos, n, head, member)              \
    for ((pos) = osal_list_entry((head)->next, __typeof__(*pos), member),  \
        (n) = osal_list_entry((pos)->member.next, __typeof__(*pos), member); \
         &pos->member != (head);                                         \
         (pos) = (n), (n) = osal_list_entry((n)->member.next, __typeof__(*n), member))
 
#define osal_list_for_each_entry_safe_continue(pos, n, head, member)        \
    for ((pos) = osal_list_entry((pos)->member.next, __typeof__(*pos), member), \
        (n) = osal_list_entry((pos)->member.next, __typeof__(*pos), member);    \
         &pos->member != (head);                                            \
         (pos) = (n), (n) = osal_list_entry((n)->member.next, __typeof__(*n), member))
 
#define osal_list_for_each_entry_safe_from(pos, n, head, member)          \
    for ((n) = osal_list_entry((pos)->member.next, __typeof__(*pos), member); \
         &pos->member != (head);                                          \
         (pos) = (n), (n) = osal_list_entry((n)->member.next, __typeof__(*n), member))
 
 
#define osal_list_for_each_entry_safe_reverse(pos, n, head, member)      \
    for ((pos) = osal_list_entry((head)->prev, __typeof__(*pos), member),  \
        (n) = osal_list_entry((pos)->member.prev, __typeof__(*pos), member); \
         &pos->member != (head);                                         \
         (pos) = (n), (n) = osal_list_entry((n)->member.prev, __typeof__(*n), member))
 
#define osal_list_safe_reset_next(pos, n, member) \
    (n) = osal_list_entry((pos)->member.next, __typeof__(*pos), member)
 
/*
 * Double linked lists with a single pointer list head.
 * Mostly useful for hash tables where the two pointer list head is
 * too wasteful.
 * You lose the ability to access the tail in O(1).
 */
struct osal_hlist_node {
    struct osal_hlist_node *next, **pprev;
};
struct osal_hlist_head {
    struct osal_hlist_node *first;
};
 
#define OSAL_HLIST_HEAD_INIT \
    {                        \
        .first = NULL   \
    }
#define OSAL_HLIST_HEAD(name) struct osal_hlist_head name = { .first = NULL }
#define INIT_OSAL_HLIST_HEAD(ptr) ((ptr)->first = NULL)
static INLINE__ void INIT_OSAL_HLIST_NODE(struct osal_hlist_node *h)
{
    h->next = NULL;
    h->pprev = NULL;
}
 
static INLINE__ int osal_hlist_unhashed(const struct osal_hlist_node *h)
{
    return !h->pprev;
}
 
static INLINE__ int osal_hlist_empty(const struct osal_hlist_head *h)
{
    return !h->first;
}
 
static INLINE__ void osal___hlist_del(struct osal_hlist_node *n)
{
    struct osal_hlist_node *next = n->next;
    struct osal_hlist_node **pprev = n->pprev;
    *pprev = next;
    if (next != NULL) {
        next->pprev = pprev;
    }
}
 
static INLINE__ void osal_hlist_del(struct osal_hlist_node *n)
{
    osal___hlist_del(n);
    n->next = (struct osal_hlist_node *) OSAL_LIST_POISON1;
    n->pprev = (struct osal_hlist_node **) OSAL_LIST_POISON2;
}
 
static INLINE__ void osal_hlist_del_init(struct osal_hlist_node *n)
{
    if (osal_hlist_unhashed(n) == 0) {
        osal___hlist_del(n);
        INIT_OSAL_HLIST_NODE(n);
    }
}
 
static INLINE__ void osal_hlist_add_head(struct osal_hlist_node *n, struct osal_hlist_head *h)
{
    struct osal_hlist_node *first = h->first;
    n->next = first;
    if (first != NULL) {
        first->pprev = &n->next;
    }
    h->first = n;
    n->pprev = &h->first;
}
 
/* next must be != NULL */
static INLINE__ void osal_hlist_add_before(struct osal_hlist_node *n,
    struct osal_hlist_node *next)
{
    n->pprev = next->pprev;
    n->next = next;
    next->pprev = &n->next;
    *(n->pprev) = n;
}
 
static INLINE__ void osal_hlist_add_after(struct osal_hlist_node *n,
    struct osal_hlist_node *next)
{
    next->next = n->next;
    n->next = next;
    next->pprev = &n->next;
 
    if (next->next) {
        next->next->pprev = &next->next;
    }
}
 
/* after that we'll appear to be on some hlist and hlist_del will work */
static INLINE__ void osal_hlist_add_fake(struct osal_hlist_node *n)
{
    n->pprev = &n->next;
}
 
/*
 * Move a list from one list head to another. Fixup the pprev
 * reference of the first entry if it exists.
 */
static INLINE__ void osal_hlist_move_list(struct osal_hlist_head *old,
    struct osal_hlist_head *cur)
{
    cur->first = old->first;
    if (cur->first) {
        cur->first->pprev = &cur->first;
    }
    old->first = NULL;
}
 
#define osal_hlist_entry(ptr, type, member) osal_container_of(ptr, type, member)
 
#define osal_hlist_for_each(pos, head) \
    for ((pos) = (head)->first; (pos); (pos) = (pos)->next)
 
#define osal_hlist_for_each_safe(pos, n, head) \
    for ((pos) = (head)->first; (pos) && ({ (n) = (pos)->next; 1; });    \
         (pos) = (n))
 
#define osal_hlist_for_each_entry(tpos, pos, head, member) \
    for ((pos) = (head)->first;                              \
         (pos) &&                                            \
         ({ (tpos) = osal_hlist_entry((pos), __typeof__(*tpos), member); 1; });  \
         (pos) = (pos)->next)
 
#define osal_hlist_for_each_entry_continue(tpos, pos, member) \
    for ((pos) = (pos)->next;                                   \
         (pos) &&                                               \
         ({ (tpos) = osal_hlist_entry((pos), __typeof__(*tpos), member); 1; }); \
         (pos) = (pos)->next)
 
#define osal_hlist_for_each_entry_from(tpos, pos, member) \
    for (; (pos) &&                                         \
           ({ (tpos) = osal_hlist_entry((pos), __typeof__(*tpos), member); 1; });  \
         (pos) = (pos)->next)
 
#define osal_hlist_for_each_entry_safe(tpos, pos, n, head, member) \
    for ((pos) = (head)->first;                                      \
         (pos) && ({ (n) = (pos)->next; 1; }) &&                                           \
         ({ (tpos) = osal_hlist_entry((pos), __typeof__(*tpos), member); 1; });          \
         (pos) = (n))
 
#define get_first_item(attached, type, member) \
    ((type *)((char *)((attached)->next) - (unsigned long)(&((type *)0)->member)))
 
#ifdef __cplusplus
#if __cplusplus
}
#endif // __cplusplus end
#endif // __cplusplus end
 
#endif // _OSAL_LIST_H end