RTEMS
5.0.0
|
Chain API. More...
Files | |
file | chainappendnotify.c |
rtems_chain_append_with_notification() implementation. | |
file | chaingetnotify.c |
rtems_chain_get_with_notification() implementation. | |
file | chaingetwait.c |
rtems_chain_get_with_wait() implementation. | |
file | chainprependnotify.c |
rtems_chain_prepend_with_notification() implementation. | |
Macros | |
#define | RTEMS_CHAIN_INITIALIZER_EMPTY(name) CHAIN_INITIALIZER_EMPTY( name ) |
Chain initializer for an empty chain with designator name. | |
#define | RTEMS_CHAIN_INITIALIZER_ONE_NODE(node) CHAIN_INITIALIZER_ONE_NODE( node ) |
Chain initializer for a chain with one node. More... | |
#define | RTEMS_CHAIN_NODE_INITIALIZER_ONE_NODE_CHAIN(chain) CHAIN_NODE_INITIALIZER_ONE_NODE_CHAIN( chain ) |
Chain node initializer for a chain containing exactly this node. More... | |
#define | RTEMS_CHAIN_DEFINE_EMPTY(name) rtems_chain_control name = RTEMS_CHAIN_INITIALIZER_EMPTY( name ) |
Chain definition for an empty chain with designator name. | |
Typedefs | |
typedef Chain_Node | rtems_chain_node |
typedef Chain_Control | rtems_chain_control |
Chain API.
#define RTEMS_CHAIN_INITIALIZER_ONE_NODE | ( | node | ) | CHAIN_INITIALIZER_ONE_NODE( node ) |
Chain initializer for a chain with one node.
#define RTEMS_CHAIN_NODE_INITIALIZER_ONE_NODE_CHAIN | ( | chain | ) | CHAIN_NODE_INITIALIZER_ONE_NODE_CHAIN( chain ) |
Chain node initializer for a chain containing exactly this node.
void rtems_chain_append | ( | rtems_chain_control * | the_chain, |
rtems_chain_node * | the_node | ||
) |
Append a node on the end of a chain.
This routine appends the_node onto the end of the_chain.
NOTE: It disables interrupts to ensure the atomicity of the append operation.
RTEMS_INLINE_ROUTINE void rtems_chain_append_unprotected | ( | rtems_chain_control * | the_chain, |
rtems_chain_node * | the_node | ||
) |
Append a node on the end of a chain (unprotected).
This routine appends the_node onto the end of the_chain.
NOTE: It does NOT disable interrupts to ensure the atomicity of the append operation.
bool rtems_chain_append_with_empty_check | ( | rtems_chain_control * | chain, |
rtems_chain_node * | node | ||
) |
Checks if the chain is empty and appends the node.
Interrupts are disabled to ensure the atomicity of the operation.
true | The chain was empty before the append. |
false | The chain contained at least one node before the append. |
rtems_status_code rtems_chain_append_with_notification | ( | rtems_chain_control * | chain, |
rtems_chain_node * | node, | ||
rtems_id | task, | ||
rtems_event_set | events | ||
) |
Appends the node to the chain and sends the events to the task if the chain was empty before the append.
RTEMS_SUCCESSFUL | Successful operation. |
RTEMS_INVALID_ID | No such task. |
RTEMS_INLINE_ROUTINE bool rtems_chain_are_nodes_equal | ( | const rtems_chain_node * | left, |
const rtems_chain_node * | right | ||
) |
Are Two nodes equal.
This function returns true if left and right are equal, and false otherwise.
[in] | left | is the node on the left hand side of the comparison. |
[in] | right | is the node on the left hand side of the comparison. |
true | left is equal to right. |
false | left is not equal to right |
void rtems_chain_extract | ( | rtems_chain_node * | the_node | ) |
Extract the specified node from a chain.
This routine extracts the_node from the chain on which it resides. It disables interrupts to ensure the atomicity of the extract operation.
RTEMS_INLINE_ROUTINE void rtems_chain_extract_unprotected | ( | rtems_chain_node * | the_node | ) |
Extract the specified node from a chain (unprotected).
This routine extracts the_node from the chain on which it resides.
NOTE: It does NOT disable interrupts to ensure the atomicity of the append operation.
RTEMS_INLINE_ROUTINE rtems_chain_node* rtems_chain_first | ( | const rtems_chain_control * | the_chain | ) |
Return pointer to Chain's First node after the permanent head.
This function returns a pointer to the first node on the chain after the head.
[in] | the_chain | is the chain to be operated upon. |
rtems_chain_node* rtems_chain_get | ( | rtems_chain_control * | the_chain | ) |
Obtain the first node on a chain.
This function removes the first node from the_chain and returns a pointer to that node. If the_chain is empty, then NULL is returned.
NOTE: It disables interrupts to ensure the atomicity of the get operation.
bool rtems_chain_get_with_empty_check | ( | rtems_chain_control * | chain, |
rtems_chain_node ** | node | ||
) |
Tries to get the first node and check if the chain is empty afterwards.
This function removes the first node from the chain and returns a pointer to that node in node. If the chain is empty, then NULL
is returned.
Interrupts are disabled to ensure the atomicity of the operation.
true | The chain is empty after the node removal. |
false | The chain contained at least one node after the node removal. |
rtems_status_code rtems_chain_get_with_notification | ( | rtems_chain_control * | chain, |
rtems_id | task, | ||
rtems_event_set | events, | ||
rtems_chain_node ** | node | ||
) |
Gets the first node of the chain and sends the events to the task if the chain is empty after the get.
RTEMS_SUCCESSFUL | Successful operation. |
RTEMS_INVALID_ID | No such task. |
rtems_status_code rtems_chain_get_with_wait | ( | rtems_chain_control * | chain, |
rtems_event_set | events, | ||
rtems_interval | timeout, | ||
rtems_chain_node ** | node | ||
) |
Gets the first node of the chain and sends the events to the task if the chain is empty afterwards.
RTEMS_SUCCESSFUL | Successful operation. |
RTEMS_TIMEOUT | Timeout. |
RTEMS_INLINE_ROUTINE bool rtems_chain_has_only_one_node | ( | const rtems_chain_control * | the_chain | ) |
Does this chain have only one node.
This function returns true if there is only one node on the_chain and false otherwise.
[in] | the_chain | is the chain to be operated upon. |
true | The chain has only one node. |
false | The chain has more than one nodes. |
RTEMS_INLINE_ROUTINE rtems_chain_node* rtems_chain_head | ( | rtems_chain_control * | the_chain | ) |
Return pointer to Chain Head.
This function returns a pointer to the first node on the chain.
[in] | the_chain | is the chain to be operated upon. |
RTEMS_INLINE_ROUTINE const rtems_chain_node* rtems_chain_immutable_first | ( | const rtems_chain_control * | the_chain | ) |
Return pointer to immutable Chain's First node.
This function returns a pointer to the first node on the chain after the head.
[in] | the_chain | is the chain to be operated upon. |
RTEMS_INLINE_ROUTINE const rtems_chain_node* rtems_chain_immutable_head | ( | const rtems_chain_control * | the_chain | ) |
Return pointer to immutable Chain Head.
This function returns a pointer to the head node on the chain.
[in] | the_chain | is the chain to be operated upon. |
RTEMS_INLINE_ROUTINE const rtems_chain_node* rtems_chain_immutable_last | ( | const rtems_chain_control * | the_chain | ) |
Return pointer to immutable Chain's Last node.
This function returns a pointer to the last node on the chain just before the tail.
[in] | the_chain | is the chain to be operated upon. |
RTEMS_INLINE_ROUTINE const rtems_chain_node* rtems_chain_immutable_next | ( | const rtems_chain_node * | the_node | ) |
Return pointer the immutable next node from this node.
This function returns a pointer to the next node after this node.
[in] | the_node | is the node to be operated upon. |
RTEMS_INLINE_ROUTINE const rtems_chain_node* rtems_chain_immutable_previous | ( | const rtems_chain_node * | the_node | ) |
Return pointer the immutable previous node from this node.
This function returns a pointer to the previous node on this chain.
[in] | the_node | is the node to be operated upon. |
RTEMS_INLINE_ROUTINE const rtems_chain_node* rtems_chain_immutable_tail | ( | const rtems_chain_control * | the_chain | ) |
Return pointer to immutable Chain Tail.
This function returns a pointer to the tail node on the chain.
[in] | the_chain | is the chain to be operated upon. |
RTEMS_INLINE_ROUTINE void rtems_chain_initialize | ( | rtems_chain_control * | the_chain, |
void * | starting_address, | ||
size_t | number_nodes, | ||
size_t | node_size | ||
) |
Initialize a chain Header.
This routine initializes the_chain structure to manage the contiguous array of number_nodes nodes which starts at starting_address. Each node is of node_size bytes.
[in] | the_chain | specifies the chain to initialize |
[in] | starting_address | is the starting address of the array of elements |
[in] | number_nodes | is the number of nodes that will be in the chain |
[in] | node_size | is the size of each node |
RTEMS_INLINE_ROUTINE void rtems_chain_initialize_empty | ( | rtems_chain_control * | the_chain | ) |
Initialize this chain as empty.
This routine initializes the specified chain to contain zero nodes.
[in] | the_chain | is the chain to be initialized. |
RTEMS_INLINE_ROUTINE void rtems_chain_initialize_node | ( | rtems_chain_node * | node | ) |
Initializes a chain node.
In debug configurations, the node is set off chain. In all other configurations, this function does nothing.
[in] | the_node | The chain node to initialize. |
void rtems_chain_insert | ( | rtems_chain_node * | after_node, |
rtems_chain_node * | the_node | ||
) |
Insert a node on a chain.
This routine inserts the_node on a chain immediately following after_node.
NOTE: It disables interrupts to ensure the atomicity of the extract operation.
RTEMS_INLINE_ROUTINE bool rtems_chain_is_empty | ( | const rtems_chain_control * | the_chain | ) |
Is the chain empty.
This function returns true if there a no nodes on the_chain and false otherwise.
[in] | the_chain | is the chain to be operated upon. |
true | The chain is empty. |
false | The chain is not empty. |
RTEMS_INLINE_ROUTINE bool rtems_chain_is_first | ( | const rtems_chain_node * | the_node | ) |
Is this the first node on the chain.
This function returns true if the_node is the first node on a chain and false otherwise.
[in] | the_node | is the node the caller wants to know if it is the first node on a chain. |
true | the_node is the first node on a chain. |
false | the_node is not the first node on a chain. |
RTEMS_INLINE_ROUTINE bool rtems_chain_is_head | ( | const rtems_chain_control * | the_chain, |
const rtems_chain_node * | the_node | ||
) |
Is this node the chain head.
This function returns true if the_node is the head of the_chain and false otherwise.
[in] | the_chain | is the chain to be operated upon. |
[in] | the_node | is the node to check for being the Chain Head. |
true | the_node is the head of the_chain. |
false | the_node is not the head of the_chain. |
RTEMS_INLINE_ROUTINE bool rtems_chain_is_last | ( | const rtems_chain_node * | the_node | ) |
Is this the last node on the chain.
This function returns true if the_node is the last node on a chain and false otherwise.
[in] | the_node | is the node to check as the last node. |
true | the_node is the last node on a chain. |
false | the_node is not the last node on a chain |
RTEMS_INLINE_ROUTINE bool rtems_chain_is_node_off_chain | ( | const rtems_chain_node * | node | ) |
Is the node off chain.
This function returns true if the node is not on a chain. A node is off chain if the next and previous fields are set to NULL.
[in] | node | is the node off chain. |
true | The node is off chain. |
false | The node is not off chain. |
RTEMS_INLINE_ROUTINE bool rtems_chain_is_null_node | ( | const rtems_chain_node * | the_node | ) |
Is the chain node pointer NULL.
This function returns true if the_node is NULL and false otherwise.
[in] | the_node | is the node pointer to check. |
true | The chain node pointer is NULL. |
false | The chain node pointer is not NULL. |
RTEMS_INLINE_ROUTINE bool rtems_chain_is_tail | ( | const rtems_chain_control * | the_chain, |
const rtems_chain_node * | the_node | ||
) |
Is this node the chain tail.
This function returns true if the_node is the tail of the_chain and false otherwise.
[in] | the_chain | is the chain to be operated upon. |
[in] | the_node | is the node to check for being the Chain Tail. |
true | the_node is the tail of the_chain. |
false | the_node is not the tail of the_chain. |
RTEMS_INLINE_ROUTINE rtems_chain_node* rtems_chain_last | ( | const rtems_chain_control * | the_chain | ) |
Return pointer to Chain's Last node before the permanent tail.
This function returns a pointer to the last node on the chain just before the tail.
[in] | the_chain | is the chain to be operated upon. |
RTEMS_INLINE_ROUTINE rtems_chain_node* rtems_chain_next | ( | const rtems_chain_node * | the_node | ) |
Return pointer the next node from this node.
This function returns a pointer to the next node after this node.
[in] | the_node | is the node to be operated upon. |
RTEMS_INLINE_ROUTINE size_t rtems_chain_node_count_unprotected | ( | const rtems_chain_control * | chain | ) |
Returns the node count of the chain.
[in] | chain | The chain. |
void rtems_chain_prepend | ( | rtems_chain_control * | the_chain, |
rtems_chain_node * | the_node | ||
) |
Prepend a node.
This routine prepends the_node onto the front of the_chain.
[in] | the_chain | is the chain to be operated upon. |
[in] | the_node | is the node to be prepended. |
NOTE: It disables interrupts to ensure the atomicity of the prepend operation.
RTEMS_INLINE_ROUTINE void rtems_chain_prepend_unprotected | ( | rtems_chain_control * | the_chain, |
rtems_chain_node * | the_node | ||
) |
Prepend a node (unprotected).
This routine prepends the_node onto the front of the_chain.
[in] | the_chain | is the chain to be operated upon. |
[in] | the_node | is the node to be prepended. |
NOTE: It does NOT disable interrupts to ensure the atomicity of the prepend operation.
bool rtems_chain_prepend_with_empty_check | ( | rtems_chain_control * | chain, |
rtems_chain_node * | node | ||
) |
Checks if the chain is empty and prepends the node.
Interrupts are disabled to ensure the atomicity of the operation.
true | The chain was empty before the prepend. |
false | The chain contained at least one node before the prepend. |
rtems_status_code rtems_chain_prepend_with_notification | ( | rtems_chain_control * | chain, |
rtems_chain_node * | node, | ||
rtems_id | task, | ||
rtems_event_set | events | ||
) |
Prepends the node to the chain and sends the events to the task if the chain was empty before the prepend.
RTEMS_SUCCESSFUL | Successful operation. |
RTEMS_INVALID_ID | No such task. |
RTEMS_INLINE_ROUTINE rtems_chain_node* rtems_chain_previous | ( | const rtems_chain_node * | the_node | ) |
Return pointer the previous node from this node.
This function returns a pointer to the previous node on this chain.
[in] | the_node | is the node to be operated upon. |
RTEMS_INLINE_ROUTINE void rtems_chain_set_off_chain | ( | rtems_chain_node * | node | ) |
Set off chain.
This function sets the next and previous fields of the node to NULL indicating the node is not part of a chain.
[in] | node | the node set to off chain. |
RTEMS_INLINE_ROUTINE rtems_chain_node* rtems_chain_tail | ( | rtems_chain_control * | the_chain | ) |
Return pointer to Chain Tail.
This function returns a pointer to the tail node on the chain.
[in] | the_chain | is the chain to be operated upon. |