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.

Sign up for GitHub

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

Fix JSON parsing memory corruption - Fix Mixed types nested children removal #15798

Merged
merged 5 commits into from
May 31, 2024
Merged

Fix JSON parsing memory corruption - Fix Mixed types nested children removal #15798

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5819de3
fix for removing child column references for mixed types
karthikeyann May 21, 2024
b2334cb
fix test
karthikeyann May 30, 2024
1519f39
Merge branch 'branch-24.08' into fix-json_mixed_nested_children
karthikeyann May 30, 2024
d98bb83
fix a comment
karthikeyann May 30, 2024
2bf1216
Merge branch 'branch-24.08' into fix-json_mixed_nested_children
karthikeyann May 30, 2024
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
17 changes: 15 additions & 2 deletions cpp/src/io/json/json_column.cu
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -594,8 +594,7 @@ void make_device_json_column(device_span<SymbolT const> input,
col.validity =
cudf::detail::create_null_mask(col.num_rows, cudf::mask_state::ALL_NULL, stream, mr);
col.type = json_col_t::StringColumn;
col.child_columns.clear(); // their references should be deleted too.
col.column_order.clear();
// destroy references of all child columns after
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I'm not understanding this comment.
Destroy references of all child columns after what?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is my only comment about this PR as well. Happy to approve once this is fixed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'after this step'.

};

path_from_tree tree_path{column_categories,
Expand Down Expand Up @@ -628,6 +627,19 @@ void make_device_json_column(device_span<SymbolT const> input,
std::vector<uint8_t> is_pruned(num_columns, 0);
columns.try_emplace(parent_node_sentinel, std::ref(root));

std::function<void(NodeIndexT, device_json_column&)> remove_child_columns =
[&](NodeIndexT this_col_id, device_json_column& col) {
for (auto col_name : col.column_order) {
auto child_id = mapped_columns[{this_col_id, col_name}];
is_mixed_type_column[child_id] = 1;
remove_child_columns(child_id, col.child_columns.at(col_name));
mapped_columns.erase({this_col_id, col_name});
columns.erase(child_id);
}
col.child_columns.clear(); // their references are deleted above.
col.column_order.clear();
};

auto name_and_parent_index = [&is_array_of_arrays,
&row_array_parent_col_id,
&column_parent_ids,
Expand Down Expand Up @@ -721,6 +733,7 @@ void make_device_json_column(device_span<SymbolT const> input,
auto& col = columns.at(old_col_id).get();
if (col.type == json_col_t::ListColumn or col.type == json_col_t::StructColumn) {
reinitialize_as_string(old_col_id, col);
remove_child_columns(old_col_id, col);
// all its children (which are already inserted) are ignored later.
}
col.forced_as_string_column = true;
Expand Down
36 changes: 36 additions & 0 deletions cpp/tests/io/json_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2679,4 +2679,40 @@ TEST_F(JsonReaderTest, JsonNestedDtypeFilter)
}
}

TEST_F(JsonReaderTest, JSONMixedTypeChildren)
{
std::string const json_str = R"(
{ "Root": { "Key": [ { "EE": "A" } ] } }
{ "Root": { "Key": { } } }
{ "Root": { "Key": [{ "YY": 1}] } }
)";
// Column "EE" is created and destroyed
// Column "YY" should not be created

cudf::io::json_reader_options options =
cudf::io::json_reader_options::builder(cudf::io::source_info{json_str.c_str(), json_str.size()})
.lines(true)
.recovery_mode(cudf::io::json_recovery_mode_t::RECOVER_WITH_NULL)
.normalize_single_quotes(true)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Since we do not have single quotes in the input string, do we need to enable single quotes normalization here? Another minor nit is that we can remove normalize_whitespace call since whitespace normalization is disabled by default.

Copy link
Contributor Author

@karthikeyann karthikeyann May 31, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, those options are not required. I used the same options as repro code for the bug, but I reduced the input json to minimal.

.normalize_whitespace(false)
.mixed_types_as_string(true)
.keep_quotes(true);

auto result = cudf::io::read_json(options);

ASSERT_EQ(result.tbl->num_columns(), 1);
ASSERT_EQ(result.metadata.schema_info.size(), 1);
EXPECT_EQ(result.metadata.schema_info[0].name, "Root");
ASSERT_EQ(result.metadata.schema_info[0].children.size(), 1);
EXPECT_EQ(result.metadata.schema_info[0].children[0].name, "Key");
ASSERT_EQ(result.metadata.schema_info[0].children[0].children.size(), 2);
EXPECT_EQ(result.metadata.schema_info[0].children[0].children[0].name, "offsets");
// types
EXPECT_EQ(result.tbl->get_column(0).type().id(), cudf::type_id::STRUCT);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: Can type checks also be ASSERT_EQ? I think the types condition must hold since the goal of the test is to ensure correct mixed types behaviour,

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The EXPECT_EQ will fail the test as appropriate.
The difference is that ASSERT_EQ will abort the test which should really only be used when the remaining code may fail/segfault.
I think the usage of EXPECT_EQ and ASSERT_EQ are correctly implemented here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, thank you for the explanation!

EXPECT_EQ(result.tbl->get_column(0).child(0).type().id(), cudf::type_id::STRING);
cudf::test::strings_column_wrapper expected({R"([ { "EE": "A" } ])", "{ }", R"([{ "YY": 1}])"});

CUDF_TEST_EXPECT_COLUMNS_EQUAL(expected, result.tbl->get_column(0).child(0));
}

CUDF_TEST_PROGRAM_MAIN()
Loading