slist.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_SYS_SLIST_H_
#define ZEPHYR_INCLUDE_SYS_SLIST_H_
 
#include <stddef.h>
#include <stdbool.h>
#include "list_gen.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
struct _snode {
        struct _snode *next;
};
 
typedef struct _snode sys_snode_t;
 
struct _slist {
        sys_snode_t *head;
        sys_snode_t *tail;
};
 
typedef struct _slist sys_slist_t;
 
#define SYS_SLIST_FOR_EACH_NODE(__sl, __sn)                             \
        Z_GENLIST_FOR_EACH_NODE(slist, __sl, __sn)
 
#define SYS_SLIST_ITERATE_FROM_NODE(__sl, __sn)                         \
        Z_GENLIST_ITERATE_FROM_NODE(slist, __sl, __sn)
 
#define SYS_SLIST_FOR_EACH_NODE_SAFE(__sl, __sn, __sns)                 \
        Z_GENLIST_FOR_EACH_NODE_SAFE(slist, __sl, __sn, __sns)
 
/*
 * @brief Provide the primitive to resolve the container of a list node
 * Note: it is safe to use with NULL pointer nodes
 *
 * @param __ln A pointer on a sys_node_t to get its container
 * @param __cn Container struct type pointer
 * @param __n The field name of sys_node_t within the container struct
 */
#define SYS_SLIST_CONTAINER(__ln, __cn, __n) \
        Z_GENLIST_CONTAINER(__ln, __cn, __n)
 
/*
 * @brief Provide the primitive to peek container of the list head
 *
 * @param __sl A pointer on a sys_slist_t to peek
 * @param __cn Container struct type pointer
 * @param __n The field name of sys_node_t within the container struct
 */
#define SYS_SLIST_PEEK_HEAD_CONTAINER(__sl, __cn, __n) \
        Z_GENLIST_PEEK_HEAD_CONTAINER(slist, __sl, __cn, __n)
 
/*
 * @brief Provide the primitive to peek container of the list tail
 *
 * @param __sl A pointer on a sys_slist_t to peek
 * @param __cn Container struct type pointer
 * @param __n The field name of sys_node_t within the container struct
 */
#define SYS_SLIST_PEEK_TAIL_CONTAINER(__sl, __cn, __n) \
        Z_GENLIST_PEEK_TAIL_CONTAINER(slist, __sl, __cn, __n)
 
/*
 * @brief Provide the primitive to peek the next container
 *
 * @param __cn Container struct type pointer
 * @param __n The field name of sys_node_t within the container struct
 */
#define SYS_SLIST_PEEK_NEXT_CONTAINER(__cn, __n) \
        Z_GENLIST_PEEK_NEXT_CONTAINER(slist, __cn, __n)
 
#define SYS_SLIST_FOR_EACH_CONTAINER(__sl, __cn, __n)                   \
        Z_GENLIST_FOR_EACH_CONTAINER(slist, __sl, __cn, __n)
 
#define SYS_SLIST_FOR_EACH_CONTAINER_SAFE(__sl, __cn, __cns, __n)       \
        Z_GENLIST_FOR_EACH_CONTAINER_SAFE(slist, __sl, __cn, __cns, __n)
 
 
/*
 * Required function definitions for the list_gen.h interface
 *
 * These are the only functions that do not treat the list/node pointers
 * as completely opaque types.
 */
 
static inline void sys_slist_init(sys_slist_t *list)
{
        list->head = NULL;
        list->tail = NULL;
}
 
#define SYS_SLIST_STATIC_INIT(ptr_to_list) {NULL, NULL}
 
static inline sys_snode_t *z_snode_next_peek(sys_snode_t *node)
{
        return node->next;
}
 
static inline void z_snode_next_set(sys_snode_t *parent, sys_snode_t *child)
{
        parent->next = child;
}
 
static inline void z_slist_head_set(sys_slist_t *list, sys_snode_t *node)
{
        list->head = node;
}
 
static inline void z_slist_tail_set(sys_slist_t *list, sys_snode_t *node)
{
        list->tail = node;
}
 
static inline sys_snode_t *sys_slist_peek_head(sys_slist_t *list)
{
        return list->head;
}
 
static inline sys_snode_t *sys_slist_peek_tail(sys_slist_t *list)
{
        return list->tail;
}
 
/*
 * Derived, generated APIs
 */
 
static inline bool sys_slist_is_empty(sys_slist_t *list);
 
Z_GENLIST_IS_EMPTY(slist)
 
 
static inline sys_snode_t *sys_slist_peek_next_no_check(sys_snode_t *node);
 
Z_GENLIST_PEEK_NEXT_NO_CHECK(slist, snode)
 
 
static inline sys_snode_t *sys_slist_peek_next(sys_snode_t *node);
 
Z_GENLIST_PEEK_NEXT(slist, snode)
 
 
static inline void sys_slist_prepend(sys_slist_t *list,
                                     sys_snode_t *node);
 
Z_GENLIST_PREPEND(slist, snode)
 
 
static inline void sys_slist_append(sys_slist_t *list,
                                    sys_snode_t *node);
 
Z_GENLIST_APPEND(slist, snode)
 
 
static inline void sys_slist_append_list(sys_slist_t *list,
                                         void *head, void *tail);
 
Z_GENLIST_APPEND_LIST(slist, snode)
 
 
static inline void sys_slist_merge_slist(sys_slist_t *list,
                                         sys_slist_t *list_to_append);
 
Z_GENLIST_MERGE_LIST(slist, snode)
 
 
static inline void sys_slist_insert(sys_slist_t *list,
                                    sys_snode_t *prev,
                                    sys_snode_t *node);
 
Z_GENLIST_INSERT(slist, snode)
 
 
static inline sys_snode_t *sys_slist_get_not_empty(sys_slist_t *list);
 
Z_GENLIST_GET_NOT_EMPTY(slist, snode)
 
 
static inline sys_snode_t *sys_slist_get(sys_slist_t *list);
 
Z_GENLIST_GET(slist, snode)
 
 
static inline void sys_slist_remove(sys_slist_t *list,
                                    sys_snode_t *prev_node,
                                    sys_snode_t *node);
 
Z_GENLIST_REMOVE(slist, snode)
 
 
static inline bool sys_slist_find_and_remove(sys_slist_t *list,
                                             sys_snode_t *node);
 
Z_GENLIST_FIND_AND_REMOVE(slist, snode)
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_SYS_SLIST_H_ */