diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2013-11-19 16:21:54 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2013-11-21 12:58:46 +0100 |
commit | 4ea97d2449e783cce95fb62c7a424c94531ac46c (patch) | |
tree | 012663e79bbbe0fddd665bc5ef993d30b3272df9 /cpukit/sapi/include | |
parent | score/rbtree: Delete protected operations (diff) | |
download | rtems-4ea97d2449e783cce95fb62c7a424c94531ac46c.tar.bz2 |
score/rbtree: Remove "unprotected" from API
Diffstat (limited to 'cpukit/sapi/include')
-rw-r--r-- | cpukit/sapi/include/rtems/rbtree.h | 60 |
1 files changed, 38 insertions, 22 deletions
diff --git a/cpukit/sapi/include/rtems/rbtree.h b/cpukit/sapi/include/rtems/rbtree.h index 5cbdab46c2..b7872564bb 100644 --- a/cpukit/sapi/include/rtems/rbtree.h +++ b/cpukit/sapi/include/rtems/rbtree.h @@ -27,6 +27,20 @@ extern "C" { #endif /** + * @defgroup ClassicRBTrees Red-Black Trees + * + * @ingroup ClassicRTEMS + * + * @brief A Red-Black Tree container. + * + * The red-black tree container offers no internal protection against + * concurrent access. The user must ensure that at most one thread at once can + * access a red-black tree instance. + * + * @{ + */ + +/** * @typedef rtems_rbtree_node * * A node that can be manipulated in the rbtree. @@ -299,45 +313,45 @@ RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_root( } /** - * @copydoc _RBTree_Find_unprotected() + * @copydoc _RBTree_Find() */ -RTEMS_INLINE_ROUTINE rtems_rbtree_node* rtems_rbtree_find_unprotected( +RTEMS_INLINE_ROUTINE rtems_rbtree_node* rtems_rbtree_find( const rtems_rbtree_control *the_rbtree, const rtems_rbtree_node *the_node ) { - return _RBTree_Find_unprotected( the_rbtree, the_node ); + return _RBTree_Find( the_rbtree, the_node ); } /** - * @copydoc _RBTree_Predecessor_unprotected() + * @copydoc _RBTree_Predecessor() */ -RTEMS_INLINE_ROUTINE rtems_rbtree_node* rtems_rbtree_predecessor_unprotected( +RTEMS_INLINE_ROUTINE rtems_rbtree_node* rtems_rbtree_predecessor( const rtems_rbtree_node *node ) { - return _RBTree_Predecessor_unprotected( node ); + return _RBTree_Predecessor( node ); } /** - * @copydoc _RBTree_Successor_unprotected() + * @copydoc _RBTree_Successor() */ -RTEMS_INLINE_ROUTINE rtems_rbtree_node* rtems_rbtree_successor_unprotected( +RTEMS_INLINE_ROUTINE rtems_rbtree_node* rtems_rbtree_successor( const rtems_rbtree_node *node ) { - return _RBTree_Successor_unprotected( node ); + return _RBTree_Successor( node ); } /** - * @copydoc _RBTree_Extract_unprotected() + * @copydoc _RBTree_Extract() */ -RTEMS_INLINE_ROUTINE void rtems_rbtree_extract_unprotected( +RTEMS_INLINE_ROUTINE void rtems_rbtree_extract( rtems_rbtree_control *the_rbtree, rtems_rbtree_node *the_node ) { - _RBTree_Extract_unprotected( the_rbtree, the_node ); + _RBTree_Extract( the_rbtree, the_node ); } /** @@ -347,11 +361,11 @@ RTEMS_INLINE_ROUTINE void rtems_rbtree_extract_unprotected( * a pointer to that node. If @a the_rbtree is empty, then NULL is returned. */ -RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_min_unprotected( +RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_min( rtems_rbtree_control *the_rbtree ) { - return _RBTree_Get_unprotected( the_rbtree, RBT_LEFT ); + return _RBTree_Get( the_rbtree, RBT_LEFT ); } /** @@ -361,11 +375,11 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_min_unprotected( * a pointer to that node. If @a the_rbtree is empty, then NULL is returned. */ -RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_max_unprotected( +RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_max( rtems_rbtree_control *the_rbtree ) { - return _RBTree_Get_unprotected( the_rbtree, RBT_RIGHT ); + return _RBTree_Get( the_rbtree, RBT_RIGHT ); } /** @@ -397,24 +411,24 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_peek_max( } /** - * @copydoc _RBTree_Find_header_unprotected() + * @copydoc _RBTree_Find_header() */ -RTEMS_INLINE_ROUTINE rtems_rbtree_control *rtems_rbtree_find_header_unprotected( +RTEMS_INLINE_ROUTINE rtems_rbtree_control *rtems_rbtree_find_header( rtems_rbtree_node *the_node ) { - return _RBTree_Find_header_unprotected( the_node ); + return _RBTree_Find_header( the_node ); } /** - * @copydoc _RBTree_Insert_unprotected() + * @copydoc _RBTree_Insert() */ -RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_insert_unprotected( +RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_insert( rtems_rbtree_control *the_rbtree, rtems_rbtree_node *the_node ) { - return _RBTree_Insert_unprotected( the_rbtree, the_node ); + return _RBTree_Insert( the_rbtree, the_node ); } /** @@ -427,6 +441,8 @@ RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_unique( return _RBTree_Is_unique(the_rbtree); } +/** @} */ + #ifdef __cplusplus } #endif |