wgtmac commented on code in PR #624: URL: https://github.com/apache/iceberg-cpp/pull/624#discussion_r3185879176
########## src/iceberg/puffin/puffin_reader.h: ########## @@ -0,0 +1,66 @@ +/* + * 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. + */ + +#pragma once + +/// \file iceberg/puffin/puffin_reader.h +/// Puffin file reader. + +#include <cstddef> +#include <cstdint> +#include <span> +#include <utility> +#include <vector> + +#include "iceberg/iceberg_export.h" +#include "iceberg/puffin/file_metadata.h" +#include "iceberg/result.h" + +namespace iceberg::puffin { + +/// \brief Reader for Puffin files. +/// +/// Parses a Puffin file from an in-memory buffer. Usage: +/// PuffinReader reader(file_data); +/// auto metadata = reader.ReadFileMetadata(); Review Comment: This might not be the recommended approach unless error handling has been added. Otherwise users may silently ignore the error and call `metadata.value()` unconsciously. ########## src/iceberg/puffin/puffin_reader.h: ########## @@ -0,0 +1,66 @@ +/* + * 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. + */ + +#pragma once + +/// \file iceberg/puffin/puffin_reader.h +/// Puffin file reader. + +#include <cstddef> +#include <cstdint> +#include <span> +#include <utility> +#include <vector> + +#include "iceberg/iceberg_export.h" +#include "iceberg/puffin/file_metadata.h" +#include "iceberg/result.h" + +namespace iceberg::puffin { + +/// \brief Reader for Puffin files. +/// +/// Parses a Puffin file from an in-memory buffer. Usage: +/// PuffinReader reader(file_data); +/// auto metadata = reader.ReadFileMetadata(); +/// auto blob = reader.ReadBlob(metadata.value().blobs[0]); +class ICEBERG_EXPORT PuffinReader { + public: + /// \brief Construct a reader from file data. + explicit PuffinReader(std::span<const std::byte> data); Review Comment: The main issue of this ctor is that we lose the capability of seeking into a segment of a puffin file, which is the main use case of v3 deletion vector. ########## src/iceberg/puffin/puffin_reader.cc: ########## @@ -0,0 +1,150 @@ +/* + * 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 "iceberg/puffin/puffin_reader.h" + +#include <algorithm> +#include <array> +#include <cstring> +#include <string_view> + +#include "iceberg/puffin/json_serde_internal.h" +#include "iceberg/puffin/puffin_format.h" +#include "iceberg/util/endian.h" +#include "iceberg/util/macros.h" + +namespace iceberg::puffin { + +namespace { + +// Validate magic bytes at the given offset. +Status CheckMagic(std::span<const std::byte> data, int64_t offset) { + if (offset < 0 || + offset + PuffinFormat::kMagicLength > static_cast<int64_t>(data.size())) { + return Invalid("Invalid file: cannot read magic at offset {}", offset); + } + auto* begin = reinterpret_cast<const uint8_t*>(data.data() + offset); + if (!std::equal(PuffinFormat::kMagicV1.begin(), PuffinFormat::kMagicV1.end(), begin)) { + return Invalid("Invalid file: expected magic at offset {}", offset); + } + return {}; +} + +} // namespace + +PuffinReader::PuffinReader(std::span<const std::byte> data) : data_(data) {} + +Result<FileMetadata> PuffinReader::ReadFileMetadata() { + auto file_size = static_cast<int64_t>(data_.size()); + + if (file_size < PuffinFormat::kFooterStructLength) { + return Invalid("Invalid file: file length {} is less than minimal footer size {}", + file_size, PuffinFormat::kFooterStructLength); + } + + // Read footer struct from end of file + auto footer_struct_offset = file_size - PuffinFormat::kFooterStructLength; + + // Validate footer end magic + ICEBERG_RETURN_UNEXPECTED( + CheckMagic(data_, footer_struct_offset + PuffinFormat::kFooterStructMagicOffset)); + + // Read payload size from footer struct + auto payload_size = ReadLittleEndian<int32_t>( + data_.data() + footer_struct_offset + PuffinFormat::kFooterStructPayloadSizeOffset); + + if (payload_size < 0) { + return Invalid("Invalid file: negative payload size {}", payload_size); + } + + // Calculate total footer size and validate + int64_t footer_size = PuffinFormat::kFooterStartMagicLength + + static_cast<int64_t>(payload_size) + + PuffinFormat::kFooterStructLength; + auto footer_offset = file_size - footer_size; + if (footer_offset < 0) { + return Invalid("Invalid file: footer size {} exceeds file size {}", footer_size, + file_size); + } + + // Validate footer start magic + ICEBERG_RETURN_UNEXPECTED(CheckMagic(data_, footer_offset)); + + // Check flags for footer compression + std::array<uint8_t, 4> flags{}; + std::memcpy( + flags.data(), + data_.data() + footer_struct_offset + PuffinFormat::kFooterStructFlagsOffset, 4); + + PuffinCompressionCodec footer_compression = PuffinCompressionCodec::kNone; + if (IsFlagSet(flags, PuffinFlag::kFooterPayloadCompressed)) { Review Comment: Please validate that all unknown/reserved footer flag bits are unset. Java's PuffinReader rejects unknown flags, and the spec says reserved bits should be 0; silently ignoring them may cause C++ to accept future or invalid files and interpret the footer incorrectly. ########## src/iceberg/puffin/puffin_writer.h: ########## @@ -0,0 +1,80 @@ +/* + * 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. + */ + +#pragma once + +/// \file iceberg/puffin/puffin_writer.h +/// Puffin file writer. + +#include <cstddef> +#include <cstdint> +#include <optional> +#include <string> +#include <unordered_map> +#include <vector> + +#include "iceberg/iceberg_export.h" +#include "iceberg/puffin/file_metadata.h" +#include "iceberg/result.h" + +namespace iceberg::puffin { + +/// \brief Writer for Puffin files. +/// +/// Builds a complete Puffin file in memory. Usage: +/// PuffinWriter writer; +/// writer.Add(blob1); +/// writer.Add(blob2); +/// auto result = writer.Finish({{"created-by", "iceberg-cpp"}}); +/// // result.value() contains the serialized file bytes +class ICEBERG_EXPORT PuffinWriter { + public: + /// \brief Construct a writer with the given default compression codec. + explicit PuffinWriter( + PuffinCompressionCodec default_codec = PuffinCompressionCodec::kNone); + + /// \brief Add a blob to be written. + /// \return The BlobMetadata for the written blob, or an error. + Result<BlobMetadata> Add(const Blob& blob); + + /// \brief Finalize the file and return the serialized bytes. + /// \param properties File-level properties to include in the footer. + /// \return The complete Puffin file as a byte vector, or an error. + Result<std::vector<std::byte>> Finish( + std::unordered_map<std::string, std::string> properties = {}); Review Comment: BTW, it seems that we need to extend our `FileIO` abstraction to support puffin I/O. It looks inefficient to write all blobs into a buffer like this. ########## src/iceberg/puffin/puffin_writer.h: ########## @@ -0,0 +1,80 @@ +/* + * 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. + */ + +#pragma once + +/// \file iceberg/puffin/puffin_writer.h +/// Puffin file writer. + +#include <cstddef> +#include <cstdint> +#include <optional> +#include <string> +#include <unordered_map> +#include <vector> + +#include "iceberg/iceberg_export.h" +#include "iceberg/puffin/file_metadata.h" +#include "iceberg/result.h" + +namespace iceberg::puffin { + +/// \brief Writer for Puffin files. +/// +/// Builds a complete Puffin file in memory. Usage: +/// PuffinWriter writer; +/// writer.Add(blob1); +/// writer.Add(blob2); +/// auto result = writer.Finish({{"created-by", "iceberg-cpp"}}); +/// // result.value() contains the serialized file bytes +class ICEBERG_EXPORT PuffinWriter { + public: + /// \brief Construct a writer with the given default compression codec. + explicit PuffinWriter( + PuffinCompressionCodec default_codec = PuffinCompressionCodec::kNone); + + /// \brief Add a blob to be written. + /// \return The BlobMetadata for the written blob, or an error. + Result<BlobMetadata> Add(const Blob& blob); + + /// \brief Finalize the file and return the serialized bytes. + /// \param properties File-level properties to include in the footer. + /// \return The complete Puffin file as a byte vector, or an error. + Result<std::vector<std::byte>> Finish( + std::unordered_map<std::string, std::string> properties = {}); Review Comment: Why do not set the properties while creating the writer? ########## src/iceberg/puffin/puffin_writer.h: ########## @@ -0,0 +1,80 @@ +/* + * 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. + */ + +#pragma once + +/// \file iceberg/puffin/puffin_writer.h +/// Puffin file writer. + +#include <cstddef> +#include <cstdint> +#include <optional> +#include <string> +#include <unordered_map> +#include <vector> + +#include "iceberg/iceberg_export.h" +#include "iceberg/puffin/file_metadata.h" +#include "iceberg/result.h" + +namespace iceberg::puffin { + +/// \brief Writer for Puffin files. +/// +/// Builds a complete Puffin file in memory. Usage: +/// PuffinWriter writer; +/// writer.Add(blob1); +/// writer.Add(blob2); +/// auto result = writer.Finish({{"created-by", "iceberg-cpp"}}); +/// // result.value() contains the serialized file bytes +class ICEBERG_EXPORT PuffinWriter { + public: + /// \brief Construct a writer with the given default compression codec. + explicit PuffinWriter( + PuffinCompressionCodec default_codec = PuffinCompressionCodec::kNone); + + /// \brief Add a blob to be written. + /// \return The BlobMetadata for the written blob, or an error. + Result<BlobMetadata> Add(const Blob& blob); Review Comment: Do we really need to return a copy of `BlobMetadata` here? IMO, users usually do not care about it and it pays to do so. ########## src/iceberg/puffin/puffin_writer.h: ########## @@ -0,0 +1,80 @@ +/* + * 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. + */ + +#pragma once + +/// \file iceberg/puffin/puffin_writer.h +/// Puffin file writer. + +#include <cstddef> +#include <cstdint> +#include <optional> +#include <string> +#include <unordered_map> +#include <vector> + +#include "iceberg/iceberg_export.h" +#include "iceberg/puffin/file_metadata.h" +#include "iceberg/result.h" + +namespace iceberg::puffin { + +/// \brief Writer for Puffin files. +/// +/// Builds a complete Puffin file in memory. Usage: +/// PuffinWriter writer; +/// writer.Add(blob1); +/// writer.Add(blob2); +/// auto result = writer.Finish({{"created-by", "iceberg-cpp"}}); +/// // result.value() contains the serialized file bytes +class ICEBERG_EXPORT PuffinWriter { + public: + /// \brief Construct a writer with the given default compression codec. + explicit PuffinWriter( + PuffinCompressionCodec default_codec = PuffinCompressionCodec::kNone); Review Comment: Do we need to introduce a `PuffinWriterOptions` to hold all possible (but optional) configs in case of expanding the ctor signature in the future? ########## src/iceberg/puffin/puffin_writer.h: ########## @@ -0,0 +1,80 @@ +/* + * 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. + */ + +#pragma once + +/// \file iceberg/puffin/puffin_writer.h +/// Puffin file writer. + +#include <cstddef> +#include <cstdint> +#include <optional> +#include <string> +#include <unordered_map> +#include <vector> + +#include "iceberg/iceberg_export.h" +#include "iceberg/puffin/file_metadata.h" +#include "iceberg/result.h" + +namespace iceberg::puffin { + +/// \brief Writer for Puffin files. +/// +/// Builds a complete Puffin file in memory. Usage: Review Comment: Same as my comment in the reader, I think we should remove comment like this. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
