Changeset d7a94693 in rtems

Timestamp:

07/21/14 16:16:47 (9 years ago)

Author:

Sebastian Huber <sebastian.huber@…>

Branches:

4.11, 5, master

Children:

8abbbdde

Parents:

6b0a7efc

git-author:

Sebastian Huber <sebastian.huber@…> (07/21/14 16:16:47)

git-committer:

Sebastian Huber <sebastian.huber@…> (07/22/14 10:31:39)

Message:

rbtree: Remove superfluous NULL pointer checks

Files:

• cpukit/score/include/rtems/score/rbtree.h (modified) (2 diffs)
• cpukit/score/src/rbtree.c (modified) (1 diff)
• cpukit/score/src/rbtreeextract.c (modified) (3 diffs)
• cpukit/score/src/rbtreeinsert.c (modified) (2 diffs)
• testsuites/sptests/sprbtree01/init.c (modified) (1 diff)

cpukit/score/include/rtems/score/rbtree.h

@@ -230 +230 @@
  *   otherwise.
  *
- *  @retval 0 Successfully inserted.
- *  @retval -1 NULL @a the_node.
- *  @retval RBTree_Node* if one with equal value to @a the_node 's key exists
- *          in an unique @a the_rbtree.
+ * @retval NULL Successfully inserted.
+ * @retval existing_node This is a unique insert and there exists a node with
+ *   an equal key in the tree already.
  */
 RBTree_Node *_RBTree_Insert(
@@ -482 +481 @@
 
 /**
- * @brief Get the first node.
- *
- * This function removes the minimum or maximum node from the_rbtree and
- * returns a pointer to that node.
- *
- * @param[in] the_rbtree is the rbtree to attempt to get the min node from.
- * @param[in] dir specifies whether to get minimum (0) or maximum (1)
- *
- * @return This method returns the min or max node on the rbtree, or NULL.
- *
- * @note This routine may return NULL if the RBTree is empty.
+ * @brief Gets a node with an extremal key value.
+ *
+ * This function extracts a node with the minimum or maximum key value from
+ * tree and returns a pointer to that node if it exists.  In case multiple
+ * nodes with an extremal key value exist, then they are extracted in FIFO
+ * order.
+ *
+ * @param[in] the_rbtree The red-black tree control.
+ * @param[in] dir Specifies whether to get a node with the minimum (RBT_LEFT)
+ *   or maximum (RBT_RIGHT) key value.
+ *
+ * @retval NULL The tree is empty.
+ * @retval extremal_node A node with the minimal or maximal key value on the
+ *   tree.
  */
 RTEMS_INLINE_ROUTINE RBTree_Node *_RBTree_Get(
-    RBTree_Control *the_rbtree,
-    RBTree_Direction dir
-    )
-{
-  RBTree_Node *the_node = the_rbtree->first[dir];
-  _RBTree_Extract(the_rbtree, the_node);
+  RBTree_Control *the_rbtree,
+  RBTree_Direction dir
+)
+{
+  RBTree_Node *the_node = the_rbtree->first[ dir ];
+
+  if ( the_node != NULL ) {
+    _RBTree_Extract( the_rbtree, the_node );
+  }
+
   return the_node;
 }

cpukit/score/src/rbtree.c

@@ -35 +35 @@
   RBTree_Node *next;
 
-  /* TODO: Error message? */
-  if ( !the_rbtree )
-    return;
-
   /* could do sanity checks here */
   _RBTree_Initialize_empty( the_rbtree );

cpukit/score/src/rbtreeextract.c

@@ -12 +12 @@
 
 #include <rtems/score/rbtreeimpl.h>
-#include <rtems/score/isr.h>
 
 /** @brief  Validate and fix-up tree properties after deleting a node
@@ -92 +91 @@
 }
 
-/** @brief Extract a Node (unprotected)
- *
- *  This routine extracts (removes) @a the_node from @a the_rbtree.
- *
- *  @note It does NOT disable interrupts to ensure the atomicity
- *        of the extract operation.
- */
 void _RBTree_Extract(
   RBTree_Control *the_rbtree,
@@ -108 +100 @@
   RBTree_Direction dir;
 
-  if ( !the_node )
-    return;
-
   /* check if min needs to be updated */
   if ( the_node == the_rbtree->first[ RBT_LEFT ] ) {

cpukit/score/src/rbtreeinsert.c

@@ -12 +12 @@
 
 #include <rtems/score/rbtreeimpl.h>
-#include <rtems/score/isr.h>
 
 /** @brief Validate and fix-up tree properties for a new insert/colored node
@@ -68 +67 @@
 )
 {
-  if ( !the_node )
-    return (RBTree_Node *) -1;
-
   RBTree_Node *iter_node = the_rbtree->root;
 

testsuites/sptests/sprbtree01/init.c

@@ -150 +150 @@
   rb_insert_unique( &rbtree1, &node2.Node );
 
-  p = rb_insert_unique( &rbtree1, NULL );
-  if (p != (void *)(-1))
-    puts( "INIT - FAILED NULL NODE INSERT" );
 
   _RBTree_Rotate(NULL, RBT_LEFT);