Blender V5.3
BKE_bake_items_serialize.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "BLI_fileops.hh"
12#include "BLI_function_ref.hh"
14#include "BLI_mutex.hh"
15#include "BLI_serialize.hh"
16
17#include "BKE_bake_values.hh"
18
19namespace blender::bke::bake {
20
25struct BlobSlice {
26 std::string name;
28
29 std::shared_ptr<io::serialize::DictionaryValue> serialize() const;
30 static std::optional<BlobSlice> deserialize(const io::serialize::DictionaryValue &io_slice);
31};
32
37 public:
38 virtual ~BlobReader() = default;
39
44 [[nodiscard]] virtual bool read(const BlobSlice &slice, void *r_data) const = 0;
45
50 [[nodiscard]] virtual bool read_as_stream(const BlobSlice &slice,
51 FunctionRef<bool(std::istream &)> fn) const;
52};
53
58 protected:
60
61 public:
62 virtual ~BlobWriter() = default;
63
68 virtual BlobSlice write(const void *data, int64_t size) = 0;
69
76 virtual BlobSlice write_as_stream(StringRef file_extension,
77 FunctionRef<void(std::ostream &)> fn);
78
80 {
82 }
83};
84
89 private:
90 struct StoredByRuntimeValue {
95 int64_t sharing_info_version;
100 std::shared_ptr<io::serialize::DictionaryValue> io_data;
101 };
102
109
114 Map<uint64_t, BlobSlice> slice_by_content_hash_;
115
116 public:
118
125 [[nodiscard]] std::shared_ptr<io::serialize::DictionaryValue> write_implicitly_shared(
126 const ImplicitSharingInfo *sharing_info,
127 FunctionRef<std::shared_ptr<io::serialize::DictionaryValue>()> write_fn);
128
134 [[nodiscard]] std::shared_ptr<io::serialize::DictionaryValue> write_deduplicated(
135 BlobWriter &writer, const void *data, int64_t size_in_bytes);
136};
137
142 private:
146 mutable Mutex mutex_;
151 mutable Map<std::string, ImplicitSharingInfoAndData> runtime_by_stored_;
152
153 public:
155
160 [[nodiscard]] std::optional<ImplicitSharingInfoAndData> read_shared(
161 const io::serialize::DictionaryValue &io_data,
162 FunctionRef<std::optional<ImplicitSharingInfoAndData>()> read_fn) const;
163};
164
169 private:
170 const std::string blobs_dir_;
171 mutable Mutex mutex_;
172 mutable Map<std::string, std::unique_ptr<fstream>> open_input_streams_;
173
174 public:
175 DiskBlobReader(std::string blobs_dir);
176 [[nodiscard]] bool read(const BlobSlice &slice, void *r_data) const override;
177};
178
183 private:
185 std::string blob_dir_;
187 std::string base_name_;
188 std::string blob_name_;
190 std::fstream blob_stream_;
192 int64_t current_offset_ = 0;
194 int independent_file_count_ = 0;
195
196 public:
197 DiskBlobWriter(std::string blob_dir, std::string base_name);
198
199 BlobSlice write(const void *data, int64_t size) override;
200
201 BlobSlice write_as_stream(StringRef file_extension,
202 FunctionRef<void(std::ostream &)> fn) override;
203};
204
209 public:
211 std::unique_ptr<std::ostringstream> stream;
213 };
214
215 private:
216 std::string base_name_;
217 std::string blob_name_;
218 Map<std::string, OutputStream> stream_by_name_;
219 int independent_file_count_ = 0;
220
221 public:
222 MemoryBlobWriter(std::string base_name);
223
224 BlobSlice write(const void *data, int64_t size) override;
225
226 BlobSlice write_as_stream(StringRef file_extension,
227 FunctionRef<void(std::ostream &)> fn) override;
228
230 {
231 return stream_by_name_;
232 }
233};
234
239 private:
241
242 public:
243 void add(StringRef name, Span<std::byte> blob);
244
245 [[nodiscard]] bool read(const BlobSlice &slice, void *r_data) const override;
246};
247
248void serialize_bake(const BakeValues &bake_values,
249 BlobWriter &blob_writer,
250 BlobWriteSharing &blob_sharing,
251 std::ostream &r_stream);
252
253std::optional<BakeValues> deserialize_bake(std::istream &stream,
254 const BlobReader &blob_reader,
255 const BlobReadSharing &blob_sharing);
256
257} // namespace blender::bke::bake
File and directory operations.
std::optional< ImplicitSharingInfoAndData > read_shared(const io::serialize::DictionaryValue &io_data, FunctionRef< std::optional< ImplicitSharingInfoAndData >()> read_fn) const
virtual bool read_as_stream(const BlobSlice &slice, FunctionRef< bool(std::istream &)> fn) const
virtual ~BlobReader()=default
virtual bool read(const BlobSlice &slice, void *r_data) const =0
std::shared_ptr< io::serialize::DictionaryValue > write_implicitly_shared(const ImplicitSharingInfo *sharing_info, FunctionRef< std::shared_ptr< io::serialize::DictionaryValue >()> write_fn)
std::shared_ptr< io::serialize::DictionaryValue > write_deduplicated(BlobWriter &writer, const void *data, int64_t size_in_bytes)
virtual BlobSlice write(const void *data, int64_t size)=0
virtual BlobSlice write_as_stream(StringRef file_extension, FunctionRef< void(std::ostream &)> fn)
virtual ~BlobWriter()=default
bool read(const BlobSlice &slice, void *r_data) const override
DiskBlobWriter(std::string blob_dir, std::string base_name)
BlobSlice write_as_stream(StringRef file_extension, FunctionRef< void(std::ostream &)> fn) override
BlobSlice write(const void *data, int64_t size) override
void add(StringRef name, Span< std::byte > blob)
bool read(const BlobSlice &slice, void *r_data) const override
const Map< std::string, OutputStream > & get_stream_by_name() const
BlobSlice write(const void *data, int64_t size) override
BlobSlice write_as_stream(StringRef file_extension, FunctionRef< void(std::ostream &)> fn) override
NonCopyable(const NonCopyable &other)=delete
NonMovable(NonMovable &&other)=delete
void serialize_bake(const BakeValues &bake_values, BlobWriter &blob_writer, BlobWriteSharing &blob_sharing, std::ostream &r_stream)
std::optional< BakeValues > deserialize_bake(std::istream &stream, const BlobReader &blob_reader, const BlobReadSharing &blob_sharing)
__int64 int64_t
Definition BKE_text.h:90
BMesh const char void * data
std::mutex Mutex
Definition BLI_mutex.hh:51
std::shared_ptr< io::serialize::DictionaryValue > serialize() const
static std::optional< BlobSlice > deserialize(const io::serialize::DictionaryValue &io_slice)