paleolimbot commented on code in PR #45459: URL: https://github.com/apache/arrow/pull/45459#discussion_r2008350733
########## cpp/src/parquet/geospatial_util_internal.cc: ########## @@ -0,0 +1,241 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +#include "parquet/geospatial_util_internal.h" + +#include "arrow/result.h" +#include "arrow/util/endian.h" +#include "arrow/util/macros.h" +#include "arrow/util/ubsan.h" + +namespace parquet::geometry { + +/// \brief Object to keep track of the low-level consumption of a well-known binary +/// geometry +/// +/// Briefly, ISO well-known binary supported by the Parquet spec is an endian byte +/// (0x01 or 0x00), followed by geometry type + dimensions encoded as a (uint32_t), +/// followed by geometry-specific data. Coordinate sequences are represented by a +/// uint32_t (the number of coordinates) plus a sequence of doubles (number of coordinates +/// multiplied by the number of dimensions). +class WKBBuffer { + public: + WKBBuffer() : data_(NULLPTR), size_(0) {} + WKBBuffer(const uint8_t* data, int64_t size) : data_(data), size_(size) {} + + void Init(const uint8_t* data, int64_t size) { Review Comment: Previous code reused the buffer (but no longer does, so this is removed!) ########## cpp/src/parquet/geospatial_util_internal.cc: ########## @@ -0,0 +1,241 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +#include "parquet/geospatial_util_internal.h" + +#include "arrow/result.h" +#include "arrow/util/endian.h" +#include "arrow/util/macros.h" +#include "arrow/util/ubsan.h" + +namespace parquet::geometry { + +/// \brief Object to keep track of the low-level consumption of a well-known binary +/// geometry +/// +/// Briefly, ISO well-known binary supported by the Parquet spec is an endian byte +/// (0x01 or 0x00), followed by geometry type + dimensions encoded as a (uint32_t), +/// followed by geometry-specific data. Coordinate sequences are represented by a +/// uint32_t (the number of coordinates) plus a sequence of doubles (number of coordinates +/// multiplied by the number of dimensions). +class WKBBuffer { + public: + WKBBuffer() : data_(NULLPTR), size_(0) {} + WKBBuffer(const uint8_t* data, int64_t size) : data_(data), size_(size) {} + + void Init(const uint8_t* data, int64_t size) { + data_ = data; + size_ = size; + } + + ::arrow::Result<uint8_t> ReadUInt8() { return ReadChecked<uint8_t>(); } + + ::arrow::Result<uint32_t> ReadUInt32(bool swap) { + ARROW_ASSIGN_OR_RAISE(auto value, ReadChecked<uint32_t>()); + if (ARROW_PREDICT_FALSE(swap)) { + return ByteSwap(value); + } else { + return value; + } + } + + template <typename Coord, typename Visit> + ::arrow::Status ReadDoubles(uint32_t n_coords, bool swap, Visit&& visit) { + size_t total_bytes = n_coords * sizeof(Coord); + if (size_ < total_bytes) { + return ::arrow::Status::SerializationError( + "Can't coordinate sequence of ", total_bytes, " bytes from WKBBuffer with ", + size_, " remaining"); + } + + if (ARROW_PREDICT_FALSE(swap)) { + Coord coord; + for (uint32_t i = 0; i < n_coords; i++) { + coord = ReadUnchecked<Coord>(); + for (uint32_t j = 0; j < coord.size(); j++) { + coord[j] = ByteSwap(coord[j]); + } + + visit(coord); + } + } else { + for (uint32_t i = 0; i < n_coords; i++) { + visit(ReadUnchecked<Coord>()); + } + } + + return ::arrow::Status::OK(); + } + + size_t size() { return size_; } + + private: + const uint8_t* data_; + size_t size_; + + template <typename T> + ::arrow::Result<T> ReadChecked() { + if (size_ < sizeof(T)) { + return ::arrow::Status::SerializationError( + "Can't read ", sizeof(T), " bytes from WKBBuffer with ", size_, " remaining"); + } + + return ReadUnchecked<T>(); + } + + template <typename T> + T ReadUnchecked() { + T out = ::arrow::util::SafeLoadAs<T>(data_); + data_ += sizeof(T); + size_ -= sizeof(T); + return out; + } + + template <typename T> + T ByteSwap(T value) { + return ::arrow::bit_util::ByteSwap(value); + } +}; + +using GeometryTypeAndDimensions = std::pair<GeometryType, Dimensions>; + +namespace { + +::arrow::Result<GeometryTypeAndDimensions> ParseGeometryType(uint32_t wkb_geometry_type) { + // The number 1000 can be used because WKB geometry types are constructed + // on purpose such that this relationship is true (e.g., LINESTRING ZM maps + // to 3002). + uint32_t geometry_type_component = wkb_geometry_type % 1000; + uint32_t dimensions_component = wkb_geometry_type / 1000; + + auto min_geometry_type_value = static_cast<uint32_t>(GeometryType::kWKBValueMin); + auto max_geometry_type_value = static_cast<uint32_t>(GeometryType::kWKBValueMax); + auto min_dimension_value = static_cast<uint32_t>(Dimensions::kWKBValueMin); + auto max_dimension_value = static_cast<uint32_t>(Dimensions::kWKBValueMax); + + if (geometry_type_component < min_geometry_type_value || + geometry_type_component > max_geometry_type_value || + dimensions_component < min_dimension_value || + dimensions_component > max_dimension_value) { + return ::arrow::Status::SerializationError("Invalid WKB geometry type: ", + wkb_geometry_type); + } + + GeometryTypeAndDimensions out{static_cast<GeometryType>(geometry_type_component), + static_cast<Dimensions>(dimensions_component)}; + return out; +} + +} // namespace + +std::vector<int32_t> WKBGeometryBounder::GeometryTypes() const { + std::vector<int32_t> out(geospatial_types_.begin(), geospatial_types_.end()); + std::sort(out.begin(), out.end()); + return out; +} + +::arrow::Status WKBGeometryBounder::ReadGeometry(std::string_view bytes_wkb) { + WKBBuffer src{reinterpret_cast<const uint8_t*>(bytes_wkb.data()), + static_cast<int64_t>(bytes_wkb.size())}; + ARROW_RETURN_NOT_OK(ReadGeometryInternal(&src, /*record_wkb_type=*/true)); + if (src.size() != 0) { + return ::arrow::Status::SerializationError( + "Exepcted zero bytes after consuming WKB but got ", src.size()); + } + + return ::arrow::Status::OK(); +} + +::arrow::Status WKBGeometryBounder::ReadGeometryInternal(WKBBuffer* src, + bool record_wkb_type) { + ARROW_ASSIGN_OR_RAISE(uint8_t endian, src->ReadUInt8()); +#if defined(ARROW_LITTLE_ENDIAN) + bool swap = endian != 0x01; +#else + bool swap = endian != 0x00; +#endif + + ARROW_ASSIGN_OR_RAISE(uint32_t wkb_geometry_type, src->ReadUInt32(swap)); + ARROW_ASSIGN_OR_RAISE(auto geometry_type_and_dimensions, Review Comment: Done! -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
