Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backwards compatibility: handle 0 chunk var tiles. #4310

Merged
merged 7 commits into from
Sep 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Empty file.
Binary file not shown.
5 changes: 5 additions & 0 deletions test/regression/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ if (TILEDB_CPP_API)
list(APPEND SOURCES targets/sc-24079.cc)
list(APPEND SOURCES targets/sc-25116.cc)
list(APPEND SOURCES targets/sc-29682.cc)
list(APPEND SOURCES targets/sc-33480.cc)
endif()

add_executable(tiledb_regression
Expand All @@ -54,6 +55,10 @@ add_executable(tiledb_regression
${SOURCES}
)

target_compile_definitions(tiledb_regression PRIVATE
-DTILEDB_TEST_INPUTS_DIR="${CMAKE_SOURCE_DIR}/test/inputs/"
)

if (NOT MSVC)
target_compile_options(tiledb_regression PRIVATE -Wno-deprecated-declarations)
endif()
Expand Down
76 changes: 76 additions & 0 deletions test/regression/targets/sc-33480.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
#include <tiledb/tiledb>

#include <test/support/tdb_catch.h>

using namespace tiledb;

TEST_CASE("0 var chunks", "[unfiltering][bug][sc33480]") {
// NOTE: This regression test will not fail on a Mac M1 because on that
// platform, a division by 0 will not generate a segfault but return 0.

// The following code created the zero_var_chunks_v10 array for this test.
// #include <tiledb/tiledb>
// using namespace tiledb;

// int main() {
// Context ctx;

// Domain domain(ctx);
// domain.add_dimension(
// Dimension::create(ctx, "d", TILEDB_STRING_ASCII, nullptr, nullptr));
// ArraySchema schema(ctx, TILEDB_SPARSE);
// schema.set_domain(domain).set_order({{TILEDB_ROW_MAJOR,
// TILEDB_ROW_MAJOR}}); schema.add_attribute(Attribute::create<int32_t>(ctx,
// "a")); Array::create("zero_var_chunks_v10", schema);

// std::vector<char> d = {};
// std::vector<uint64_t> d_offsets = {0};
// std::vector<int32_t> data = {1};

// Array array(ctx, "zero_var_chunks_v10", TILEDB_WRITE);
// Query query(ctx, array, TILEDB_WRITE);
// query.set_layout(TILEDB_UNORDERED)
// .set_data_buffer("a", data)
// .set_data_buffer("d", d)
// .set_offsets_buffer("d", d_offsets);
// query.submit();
// array.close();
// return 0;
// }

// This array has a var file for the "d" dimension with 0 chunks. This was
// only possible if a fragment had all empty values for a variable string in
// versions earlier than v10.
std::string array_name(
std::string(TILEDB_TEST_INPUTS_DIR) + "/arrays/zero_var_chunks_v10");
Context ctx;

// Prepare the array for reading.
Array array(ctx, array_name, TILEDB_READ);

// Prepare the query.
Query query(ctx, array, TILEDB_READ);

// Prepare the vector that will hold the result.
std::vector<char> d(10);
std::vector<uint64_t> d_offsets(10);
std::vector<int32_t> a(10);
query.set_layout(TILEDB_UNORDERED)
.set_data_buffer("d", d)
.set_offsets_buffer("d", d_offsets)
.set_data_buffer("a", a);

// Submit the query and close the array.
query.submit();
array.close();

// Validate the results. This array has one cell at coordinate '' with
// value 1.
auto res = query.result_buffer_elements();
CHECK(res["d"].first == 1);
CHECK(res["d"].second == 0);
CHECK(res["a"].first == 0);
CHECK(res["a"].second == 1);
CHECK(d_offsets[0] == 0);
CHECK(a[0] == 1);
}
2 changes: 1 addition & 1 deletion test/src/unit-backwards_compat.cc
Original file line number Diff line number Diff line change
Expand Up @@ -1363,4 +1363,4 @@ TEST_CASE(
vfs.remove_dir(get_fragment_dir(array_read2.uri()));
vfs.remove_dir(get_commit_dir(array_read2.uri()));
vfs.remove_dir(schema_folder);
}
}
2 changes: 2 additions & 0 deletions tiledb/sm/query/readers/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,5 @@ include(common NO_POLICY_SCOPE)
include(object_library)

add_subdirectory(aggregators)

add_test_subdirectory()
13 changes: 0 additions & 13 deletions tiledb/sm/query/readers/reader_base.cc
Original file line number Diff line number Diff line change
Expand Up @@ -1004,19 +1004,6 @@ Status ReaderBase::unfilter_tile(
return Status::Ok();
}

tuple<uint64_t, uint64_t> ReaderBase::compute_chunk_min_max(
const uint64_t num_chunks,
const uint64_t num_range_threads,
const uint64_t thread_idx) const {
auto t_part_num = std::min(num_chunks, num_range_threads);
auto t_min = (thread_idx * num_chunks + t_part_num - 1) / t_part_num;
auto t_max = std::min(
((thread_idx + 1) * num_chunks + t_part_num - 1) / t_part_num,
num_chunks);

return {t_min, t_max};
}

uint64_t ReaderBase::offsets_bytesize() const {
return offsets_bitsize_ == 32 ? sizeof(uint32_t) :
constants::cell_var_offset_size;
Expand Down
49 changes: 35 additions & 14 deletions tiledb/sm/query/readers/reader_base.h
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,41 @@ class ReaderBase : public StrategyBase {
const std::vector<TileDomain<T>>& frag_tile_domains,
std::map<const T*, ResultSpaceTile<T>>& result_space_tiles);

/**
* Computes the minimum and maximum indexes of tile chunks to process based on
* the available threads.
*
* @param num_chunks Total number of chunks in a tile
* @param num_range_threads Total number of range threads.
* @param range_thread_idx Current range thread index.
* @return {min, max}
*/
static tuple<uint64_t, uint64_t> compute_chunk_min_max(
const uint64_t num_chunks,
const uint64_t num_range_threads,
const uint64_t thread_idx) {
if (num_range_threads == 0) {
throw std::runtime_error("Number of range thread value is 0");
}

if (thread_idx > num_range_threads - 1) {
throw std::runtime_error(
"Range thread index is greater than number of range threads");
}

if (num_chunks == 0) {
return {0, 0};
}

auto t_part_num = std::min(num_chunks, num_range_threads);
auto t_min = (thread_idx * num_chunks + t_part_num - 1) / t_part_num;
auto t_max = std::min(
((thread_idx + 1) * num_chunks + t_part_num - 1) / t_part_num,
num_chunks);

return {t_min, t_max};
}

/* ********************************* */
/* PUBLIC METHODS */
/* ********************************* */
Expand Down Expand Up @@ -517,20 +552,6 @@ class ReaderBase : public StrategyBase {
const ChunkData& tile_chunk_var_data,
const ChunkData& tile_chunk_validity_data) const;

/**
* Computes the minimum and maximum indexes of tile chunks to process based on
* the available threads.
*
* @param num_chunks Total number of chunks in a tile
* @param num_range_threads Total number of range threads.
* @param range_thread_idx Current range thread index.
* @return {min, max}
*/
tuple<uint64_t, uint64_t> compute_chunk_min_max(
const uint64_t num_chunks,
const uint64_t num_range_threads,
const uint64_t thread_idx) const;

/**
* Returns the configured bytesize for var-sized attribute offsets
*/
Expand Down
31 changes: 31 additions & 0 deletions tiledb/sm/query/readers/test/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#
# tiledb/sm/query/readers/test/CMakeLists.txt
#
# The MIT License
#
# Copyright (c) 2023 TileDB, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# 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 OR COPYRIGHT HOLDERS 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(unit_test)

commence(unit_test readers)
this_target_sources(main.cc unit_reader_base.cc)
conclude(unit_test)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @file compile_result_tile_main.cc
* @file tiledb/sm/query/readers/test/main.cc
*
* @section LICENSE
*
Expand All @@ -24,11 +24,11 @@
* 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.
*
* @section DESCRIPTION
*
* This file defines a test `main()`
*/

#include "../result_tile.h"

int main() {
(void)sizeof(tiledb::sm::ResultTile);
return 0;
}
#define CATCH_CONFIG_MAIN
#include <test/support/tdb_catch.h>
85 changes: 85 additions & 0 deletions tiledb/sm/query/readers/test/unit_reader_base.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
/**
* @file unit_reader_base.cc
*
* @section LICENSE
*
* The MIT License
*
* @copyright Copyright (c) 2023 TileDB, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* 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 OR COPYRIGHT HOLDERS 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.
*
* @section DESCRIPTION
*
* Tests the `ReaderBase` class.
*/

#include "tiledb/common/common.h"
#include "tiledb/sm/query/readers/reader_base.h"

#include <test/support/tdb_catch.h>

using namespace tiledb::sm;

TEST_CASE(
"ReaderBase::compute_chunk_min_max valid inputs",
"[readerbase][compute_chunk_min_max][valid]") {
uint64_t num_chunks{0};
uint64_t num_range_threads{2};
uint64_t thread_idx{0};
std::tuple<uint64_t, uint64_t> expected_min_max{0, 0};

SECTION("Three chunks first thread") {
num_chunks = 3;
thread_idx = 0;
expected_min_max = {0, 2};
}

SECTION("Three chunks second thread") {
num_chunks = 3;
thread_idx = 1;
expected_min_max = {2, 3};
}

SECTION("0 chunks") {
num_chunks = 0;
thread_idx = 1;
expected_min_max = {0, 0};
}

auto res = ReaderBase::compute_chunk_min_max(
num_chunks, num_range_threads, thread_idx);
CHECK(res == expected_min_max);
}

TEST_CASE(
"ReaderBase::compute_chunk_min_max invalid inputs",
"[readerbase][compute_chunk_min_max][invalid]") {
SECTION("No range threads") {
CHECK_THROWS_WITH(
ReaderBase::compute_chunk_min_max(10, 0, 0),
"Number of range thread value is 0");
}

SECTION("Invalid range thread index") {
CHECK_THROWS_WITH(
ReaderBase::compute_chunk_min_max(10, 1, 1),
"Range thread index is greater than number of range threads");
}
}
Loading