WT-3184 bug fix: special case searching an index that has a custom collator. (#3303)

In this case, we must use the entire (raw) key to duplicate the position, instead of truncating to the visible part.

5 files changed, 181 insertions, 5 deletions

diff --git a/src/cursor/cur_index.c b/src/cursor/cur_index.c
index 13180efdea4..6fc01c0421f 100644
--- a/src/cursor/cur_index.c
+++ b/src/cursor/cur_index.c
@@ -245,7 +245,8 @@ __curindex_search(WT_CURSOR *cursor)
 	 * Custom collators expect to see complete keys, pass an item containing
 	 * all the visible fields so it unpacks correctly.
 	 */
-	if (cindex->index->collator != NULL)
+	if (cindex->index->collator != NULL &&
+	    !F_ISSET(cursor, WT_CURSTD_RAW_SEARCH))
 		WT_ERR(__wt_struct_repack(session, child->key_format,
 		    cindex->iface.key_format, &child->key, &found_key));
 	else
diff --git a/src/cursor/cur_std.c b/src/cursor/cur_std.c
index 7ace6d49cf0..99a9e373354 100644
--- a/src/cursor/cur_std.c
+++ b/src/cursor/cur_std.c
@@ -633,6 +633,7 @@ __wt_cursor_reconfigure(WT_CURSOR *cursor, const char *config)
 int
 __wt_cursor_dup_position(WT_CURSOR *to_dup, WT_CURSOR *cursor)
 {
+	WT_DECL_RET;
 	WT_ITEM key;
 
 	/*
@@ -662,9 +663,11 @@ __wt_cursor_dup_position(WT_CURSOR *to_dup, WT_CURSOR *cursor)
 	 * cursors cannot reference application memory after cursor operations
 	 * and that requirement will save the day.
 	 */
-	WT_RET(cursor->search(cursor));
+	F_SET(cursor, WT_CURSTD_RAW_SEARCH);
+	ret = cursor->search(cursor);
+	F_CLR(cursor, WT_CURSTD_RAW_SEARCH);
 
-	return (0);
+	return (ret);
 }
 
 /*
diff --git a/src/include/wiredtiger.in b/src/include/wiredtiger.in
index d1e3d383396..c148e759299 100644
--- a/src/include/wiredtiger.in
+++ b/src/include/wiredtiger.in
@@ -576,8 +576,9 @@ struct __wt_cursor {
 #define	WT_CURSTD_OPEN		0x00200
 #define	WT_CURSTD_OVERWRITE	0x00400
 #define	WT_CURSTD_RAW		0x00800
-#define	WT_CURSTD_VALUE_EXT	0x01000	/* Value points out of the tree. */
-#define	WT_CURSTD_VALUE_INT	0x02000	/* Value points into the tree. */
+#define	WT_CURSTD_RAW_SEARCH	0x01000
+#define	WT_CURSTD_VALUE_EXT	0x02000	/* Value points out of the tree. */
+#define	WT_CURSTD_VALUE_INT	0x04000	/* Value points into the tree. */
 #define	WT_CURSTD_VALUE_SET	(WT_CURSTD_VALUE_EXT | WT_CURSTD_VALUE_INT)
 	uint32_t flags;
 #endif
diff --git a/test/csuite/Makefile.am b/test/csuite/Makefile.am
index 0158d0c96d1..e2b72532703 100644
--- a/test/csuite/Makefile.am
+++ b/test/csuite/Makefile.am
@@ -49,6 +49,9 @@ noinst_PROGRAMS += test_wt3120_filesys
 test_wt3135_search_near_collator_SOURCES = wt3135_search_near_collator/main.c
 noinst_PROGRAMS += test_wt3135_search_near_collator
 
+test_wt3184_dup_index_collator_SOURCES = wt3184_dup_index_collator/main.c
+noinst_PROGRAMS += test_wt3184_dup_index_collator
+
 # Run this during a "make check" smoke test.
 TESTS = $(noinst_PROGRAMS)
 LOG_COMPILER = $(TEST_WRAPPER)
diff --git a/test/csuite/wt3184_dup_index_collator/main.c b/test/csuite/wt3184_dup_index_collator/main.c
new file mode 100644
index 00000000000..bcefd2f1a3b
--- /dev/null
+++ b/test/csuite/wt3184_dup_index_collator/main.c
@@ -0,0 +1,168 @@
+/*-
+ * Public Domain 2014-2016 MongoDB, Inc.
+ * Public Domain 2008-2014 WiredTiger, Inc.
+ *
+ * This is free and unencumbered software released into the public domain.
+ *
+ * Anyone is free to copy, modify, publish, use, compile, sell, or
+ * distribute this software, either in source code form or as a compiled
+ * binary, for any purpose, commercial or non-commercial, and by any
+ * means.
+ *
+ * In jurisdictions that recognize copyright laws, the author or authors
+ * of this software dedicate any and all copyright interest in the
+ * software to the public domain. We make this dedication for the benefit
+ * of the public at large and to the detriment of our heirs and
+ * successors. We intend this dedication to be an overt act of
+ * relinquishment in perpetuity of all present and future rights to this
+ * software under copyright law.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+#include "test_util.h"
+
+/*
+ * JIRA ticket reference: WT-3184
+ * Test case description: Each set of data is ordered and contains
+ * five elements (0-4).  We insert elements 1 and 3, and then do
+ * search_near and search for each element.  For each set of data, we perform
+ * these tests first using a custom collator, and second using a custom collator
+ * and extractor. In each case there are index keys having variable length.
+ * Failure mode: In the reported test case, the custom compare routine is
+ * given a truncated key to compare, and the unpack functions return errors
+ * because the truncation appeared in the middle of a key.
+ */
+
+static int
+compare_int(int32_t a, int32_t b)
+{
+	return (a < b ? -1 : (a > b ? 1 : 0));
+}
+
+static int32_t
+item_to_int(WT_ITEM *item)
+{
+	testutil_assert(item->size == sizeof(int32_t));
+	return (*(int32_t *)item->data);
+}
+
+static int
+compare_int_items(WT_ITEM *itema, WT_ITEM *itemb)
+{
+	testutil_assert(itema->size == sizeof(int32_t));
+	testutil_assert(itemb->size == sizeof(int32_t));
+	return (compare_int(item_to_int(itema), item_to_int(itemb)));
+}
+
+static void
+print_int_item(const char *str, const WT_ITEM *item)
+{
+	if (item->size > 0) {
+		testutil_assert(item->size == sizeof(int32_t));
+		printf("%s%" PRId32, str, *(int32_t *)item->data);
+	} else
+		printf("%s<empty>", str);
+}
+
+static int
+index_compare(WT_COLLATOR *collator, WT_SESSION *session,
+	      const WT_ITEM *key1, const WT_ITEM *key2, int *cmp)
+{
+	WT_ITEM ikey1, pkey1, ikey2, pkey2;
+
+	(void)collator;
+	testutil_check(wiredtiger_struct_unpack(session,
+	    key1->data, key1->size, "uu", &ikey1, &pkey1));
+	testutil_check(wiredtiger_struct_unpack(session,
+	    key2->data, key2->size, "uu", &ikey2, &pkey2));
+
+	print_int_item("index_compare: index key1 = ", &ikey1);
+	print_int_item(", primary key1 = ", &pkey1);
+	print_int_item(", index key2 = ", &ikey2);
+	print_int_item(", primary key2 = ", &pkey2);
+	printf("\n");
+
+	if ((*cmp = compare_int_items(&ikey1, &ikey2)) != 0)
+		return (0);
+
+	if (pkey1.size != 0 && pkey2.size != 0)
+		*cmp = compare_int_items(&pkey1, &pkey2);
+	else if (pkey1.size != 0)
+		*cmp = 1;
+	else if (pkey2.size != 0)
+		*cmp = -1;
+	else
+		*cmp = 0;
+
+	return (0);
+}
+
+static WT_COLLATOR index_coll = { index_compare, NULL, NULL };
+
+int
+main(int argc, char *argv[])
+{
+	TEST_OPTS *opts, _opts;
+	WT_CURSOR *cursor, *cursor1;
+	WT_ITEM got, k, v;
+	WT_SESSION *session;
+	int32_t ki, vi;
+
+	opts = &_opts;
+	memset(opts, 0, sizeof(*opts));
+	testutil_check(testutil_parse_opts(argc, argv, opts));
+	testutil_make_work_dir(opts->home);
+
+	testutil_check(wiredtiger_open(opts->home, NULL, "create",
+	    &opts->conn));
+	testutil_check(
+	    opts->conn->open_session(opts->conn, NULL, NULL, &session));
+
+	testutil_check(opts->conn->add_collator(opts->conn, "index_coll",
+	    &index_coll, NULL));
+
+	testutil_check(session->create(session,
+	    "table:main", "key_format=u,value_format=u,columns=(k,v)"));
+	testutil_check(session->create(session,
+	    "index:main:index", "columns=(v),collator=index_coll"));
+
+	printf("adding new record\n");
+	testutil_check(session->open_cursor(session, "table:main", NULL, NULL,
+	    &cursor));
+
+	ki = 13;
+	vi = 17;
+
+	k.data = &ki; k.size = sizeof(ki);
+	v.data = &vi; v.size = sizeof(vi);
+
+	cursor->set_key(cursor, &k);
+	cursor->set_value(cursor, &v);
+	testutil_check(cursor->insert(cursor));
+	testutil_check(cursor->close(cursor));
+
+	printf("positioning index cursor\n");
+
+	testutil_check(session->open_cursor(session, "index:main:index", NULL,
+	    NULL, &cursor));
+	cursor->set_key(cursor, &v);
+	testutil_check(cursor->search(cursor));
+
+	printf("duplicating cursor\n");
+	testutil_check(session->open_cursor(session, NULL, cursor, NULL,
+	    &cursor1));
+	cursor->get_value(cursor, &got);
+	testutil_assert(item_to_int(&got) == 17);
+	cursor1->get_value(cursor1, &got);
+	testutil_assert(item_to_int(&got) == 17);
+
+	testutil_check(session->close(session, NULL));
+	testutil_cleanup(opts);
+	return (EXIT_SUCCESS);
+}