Merge pull request #11061 from jywangx/fix_for_issue#11058

opal/list: Fix the bug in function opal_list_insert

Author: bosilca

contrib/check_unnecessary_headers.sh

@@ -89,7 +89,7 @@ SEARCH_HEADER[2]="opal/class/opal_bitmap.h opal_bitmap_t opal_bitmap_set_max_siz
 SEARCH_HEADER[3]="opal/class/opal_free_list.h opal_free_list_t opal_free_list_item_t opal_free_list_init opal_free_list_grow OPAL_FREE_LIST_GET OPAL_FREE_LIST_WAIT OPAL_FREE_LIST_RETURN"
 SEARCH_HEADER[4]="opal/class/opal_graph.h opal_graph_vertex_t opal_graph_edge_t opal_adjacency_list_t opal_graph_t opal_graph_copy_vertex_data opal_graph_free_vertex_data opal_graph_alloc_vertex_data vertex_distance_from_t opal_graph_add_vertex opal_graph_remove_vertex opal_graph_add_edge opal_graph_remove_edge opal_graph_adjacent opal_graph_get_order opal_graph_get_size opal_graph_find_vertex opal_graph_get_graph_vertices opal_graph_get_adjacent_vertices opal_graph_duplicate opal_graph_spf opal_graph_dijkstra opal_graph_print"
 SEARCH_HEADER[5]="opal/class/opal_hash_table.h opal_hash_table_t opal_hash_table_init opal_hash_table_get_size opal_hash_table_remove_all opal_hash_table_get_value_uint32 opal_hash_table_set_value_uint32 opal_hash_table_remove_value_uint32 opal_hash_table_get_value_uint64 opal_hash_table_set_value_uint64 opal_hash_table_remove_value_uint64 opal_hash_table_get_value_ptr opal_hash_table_set_value_ptr opal_hash_table_remove_value_ptr opal_hash_table_get_first_key_uint32 opal_hash_table_get_next_key_uint32 opal_hash_table_get_first_key_uint64 opal_hash_table_get_next_key_uint64"
-SEARCH_HEADER[6]="opal/class/opal_list.h opal_list_t opal_list_item_t opal_list_get_next opal_list_get_prev opal_list_is_empty opal_list_get_first opal_list_get_last opal_list_get_begin opal_list_get_end opal_list_get_size opal_list_remove_item opal_list_append opal_list_prepend opal_list_remove_first opal_list_remove_last opal_list_insert_pos opal_list_insert opal_list_join opal_list_splice opal_list_sort opal_list_item_compare_fn_t"
+SEARCH_HEADER[6]="opal/class/opal_list.h opal_list_t opal_list_item_t opal_list_get_next opal_list_get_prev opal_list_is_empty opal_list_get_first opal_list_get_last opal_list_get_begin opal_list_get_end opal_list_get_size opal_list_remove_item opal_list_append opal_list_prepend opal_list_remove_first opal_list_remove_last opal_list_insert_pos opal_list_join opal_list_splice opal_list_sort opal_list_item_compare_fn_t"
 SEARCH_HEADER[7]="opal/class/opal_object.h opal_object_t opal_class_t opal_construct_t opal_destruct_t OPAL_OBJ_STATIC_INIT OBJ_CLASS OBJ_CLASS_INSTANCE OBJ_CLASS_DECLARATION OBJ_NEW OBJ_RETAIN OBJ_RELEASE OBJ_CONSTRUCT OBJ_DESTRUCT opal_class_initialize opal_class_finalize opal_obj_run_constructors opal_obj_run_destructors opal_obj_new opal_obj_update"
 SEARCH_HEADER[8]="opal/class/opal_pointer_array.h opal_pointer_array_t opal_pointer_array_init opal_pointer_array_add opal_pointer_array_set_item opal_pointer_array_get_item opal_pointer_array_get_size opal_pointer_array_set_size opal_pointer_array_test_and_set_item opal_pointer_array_remove_all"
 SEARCH_HEADER[9]="opal/class/opal_value_array.h opal_value_array_t opal_value_array_init opal_value_array_reserve opal_value_array_get_size opal_value_array_set_size OPAL_VALUE_ARRAY_GET_ITEM opal_value_array_get_item OPAL_VALUE_ARRAY_SET_ITEM opal_value_array_set_item opal_value_array_append_item opal_value_array_remove_item OPAL_VALUE_ARRAY_GET_BASE"

opal/class/opal_list.c

@@ -93,54 +93,6 @@ static void opal_list_destruct(opal_list_t *list)
     opal_list_construct(list);
 }
 
-/*
- * Insert an item at a specific place in a list
- */
-bool opal_list_insert(opal_list_t *list, opal_list_item_t *item, long long idx)
-{
-    /* Adds item to list at index and retains item. */
-    int i;
-    volatile opal_list_item_t *ptr, *next;
-
-    if (idx >= (long long) list->opal_list_length) {
-        return false;
-    }
-
-    if (0 == idx) {
-        opal_list_prepend(list, item);
-    } else {
-#if OPAL_ENABLE_DEBUG
-        /* Spot check: ensure that this item is previously on no
-           lists */
-
-        assert(0 == item->opal_list_item_refcount);
-#endif
-        /* pointer to element 0 */
-        ptr = list->opal_list_sentinel.opal_list_next;
-        for (i = 0; i < idx - 1; i++) {
-            ptr = ptr->opal_list_next;
-        }
-
-        next = ptr->opal_list_next;
-        item->opal_list_next = next;
-        item->opal_list_prev = ptr;
-        next->opal_list_prev = item;
-        ptr->opal_list_next = item;
-
-#if OPAL_ENABLE_DEBUG
-        /* Spot check: ensure this item is only on the list that we
-           just inserted it into */
-
-        opal_atomic_add(&(item->opal_list_item_refcount), 1);
-        assert(1 == item->opal_list_item_refcount);
-        item->opal_list_item_belong_to = list;
-#endif
-    }
-
-    list->opal_list_length++;
-    return true;
-}
-
 static void opal_list_transfer(opal_list_item_t *pos, opal_list_item_t *begin,
                                opal_list_item_t *end)
 {

opal/class/opal_list.h

@@ -783,26 +783,6 @@ static inline void opal_list_insert_pos(opal_list_t *list, opal_list_item_t *pos
 #endif
 }
 
-/**
- * Add an item to the list at a specific index location in the list.
- *
- * @param list The list container
- * @param item The item to insert
- * @param index Location to add the item
- *
- * @returns true if insertion succeeded; otherwise false
- *
- * This is potentially an O(N) operation to traverse down to the
- * correct location in the list and add an item.
- *
- * Example: if idx = 2 and list = item1->item2->item3->item4, then
- * after insert, list = item1->item2->item->item3->item4.
- *
- * If index is greater than the length of the list, no action is
- * performed and false is returned.
- */
-OPAL_DECLSPEC bool opal_list_insert(opal_list_t *list, opal_list_item_t *item, long long idx);
-
 /**
  * Join a list into another list
  *

test/class/opal_list.c

@@ -276,40 +276,6 @@ int main(int argc, char **argv)
         test_failure(" error in opal_list_remove - list size changed incorrectly");
     }
 
-    /* test the insert function */
-    i = opal_list_insert(&list, (opal_list_item_t *) (elements + indx), indx);
-    if (1 == i) {
-        test_success();
-    } else {
-        test_failure(" error in opal_list_remove_item \n");
-    }
-
-    i = 0;
-    for (ele = (test_data_t *) opal_list_get_first(&list);
-         ele != (test_data_t *) opal_list_get_end(&list);
-         ele = (test_data_t *) ((opal_list_item_t *) ele)->opal_list_next) {
-        i++;
-    }
-    if (size_elements == i) {
-        test_success();
-    } else {
-        test_failure(" error in opal_list_insert - incorrect list length");
-    }
-    i = 0;
-    error_cnt = 0;
-    for (ele = (test_data_t *) opal_list_get_first(&list);
-         ele != (test_data_t *) opal_list_get_end(&list);
-         ele = (test_data_t *) ((opal_list_item_t *) ele)->opal_list_next) {
-        if (ele->data != i)
-            error_cnt++;
-        i++;
-    }
-    if (0 == error_cnt) {
-        test_success();
-    } else {
-        test_failure(" error in list order - opal_list_remove_item ");
-    }
-
     /* test the splice and join functions  */
     list_size = opal_list_get_size(&list);
     for (i = 0, item = opal_list_get_first(&list); i < list_size / 2;