ns_list.h File Reference

Linked list support library. More...

Go to the source code of this file.

Detailed Description

Linked list support library.

The ns_list.h file provides a doubly-linked list/queue, providing O(1) performance for all insertion/removal operations, and access to either end of the list.

Memory footprint is two pointers for the list head, and two pointers in each list entry. It is similar in concept to BSD's TAILQ.

Although the API is symmetrical and O(1) in both directions, due to internal pointer design, it is *slightly* more efficient to insert at the end when used as a queue, and to iterate forwards rather than backwards.

Example of an entry type that can be stored to this list. ~~~ typedef struct example_entry { uint8_t *data; uint32_t data_count; ns_list_link_t link; } example_entry_t;

static NS_LIST_HEAD(example_entry_t, link) my_list; ns_list_init(&my_list); ~~~ OR ~~~ NS_LIST_HEAD(example_entry_t, link) my_list = NS_LIST_INIT(my_list); ~~~ OR ~~~ static NS_LIST_DEFINE(my_list, example_entry_t, link); ~~~ OR ~~~ typedef NS_LIST_HEAD(example_entry_t, link) example_list_t; example_list_t NS_LIST_NAME_INIT(my_list); ~~~ NOTE: the link field SHALL NOT be accessed by the user.

An entry can exist on multiple lists by having multiple link fields.

All the list operations are implemented as macros, most of which are backed by optionally-inline functions. The macros do not evaluate any arguments more than once, unless documented.

In macro documentation, `list_t` refers to a list type defined using NS_LIST_HEAD(), and `entry_t` to the entry type that was passed to it.

Definition in file ns_list.h.

Typedef Documentation