Blender V5.3
filereader_memory.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2004-2021 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <algorithm>
10#include <cstring>
11
12#include "BLI_fileops.hh"
13#include "BLI_filereader.hh"
14#include "BLI_mmap.hh"
15
16#include "MEM_guardedalloc.h"
17
18namespace blender {
19
20/* This file implements both memory-backed and memory-mapped-file-backed reading. */
23
24 const char *data;
26 size_t length;
27};
28
29static int64_t memory_read_raw(FileReader *reader, void *buffer, size_t size)
30{
31 MemoryReader *mem = reinterpret_cast<MemoryReader *>(reader);
32
33 /* Don't read more bytes than there are available in the buffer. */
34 size_t readsize = std::min(size, size_t(mem->length - mem->reader.offset));
35
36 memcpy(buffer, mem->data + mem->reader.offset, readsize);
37 mem->reader.offset += readsize;
38
39 return readsize;
40}
41
42static off64_t memory_seek(FileReader *reader, off64_t offset, int whence)
43{
44 MemoryReader *mem = reinterpret_cast<MemoryReader *>(reader);
45
46 off64_t new_pos;
47 if (whence == SEEK_CUR) {
48 new_pos = mem->reader.offset + offset;
49 }
50 else if (whence == SEEK_SET) {
51 new_pos = offset;
52 }
53 else if (whence == SEEK_END) {
54 new_pos = mem->length + offset;
55 }
56 else {
57 return -1;
58 }
59
60 if (new_pos < 0 || new_pos > mem->length) {
61 return -1;
62 }
63
64 mem->reader.offset = new_pos;
65 return mem->reader.offset;
66}
67
68static void memory_close_raw(FileReader *reader)
69{
70 MEM_delete(reader);
71}
72
74{
76
77 mem->data = static_cast<const char *>(data);
78 mem->length = len;
79
81 mem->reader.seek = memory_seek;
83
84 return reinterpret_cast<FileReader *>(mem);
85}
86
87/* Memory-mapped file reading.
88 * By using `mmap()`, we can map a file so that it can be treated like normal memory,
89 * meaning that we can just read from it with `memcpy()` etc.
90 * This avoids system call overhead and can significantly speed up file loading.
91 */
92
93static int64_t memory_read_mmap(FileReader *reader, void *buffer, size_t size)
94{
95 MemoryReader *mem = reinterpret_cast<MemoryReader *>(reader);
96
97 /* Don't read more bytes than there are available in the buffer. */
98 size_t readsize = std::min(size, size_t(mem->length - mem->reader.offset));
99
100 if (!BLI_mmap_read(mem->mmap, buffer, mem->reader.offset, readsize)) {
101 return 0;
102 }
103
104 mem->reader.offset += readsize;
105
106 return readsize;
107}
108
109static void memory_close_mmap(FileReader *reader)
110{
111 MemoryReader *mem = reinterpret_cast<MemoryReader *>(reader);
112 BLI_mmap_free(mem->mmap);
113 MEM_delete(mem);
114}
115
117{
118 BLI_mmap_file *mmap = BLI_mmap_open(filedes);
119 if (mmap == nullptr) {
120 return nullptr;
121 }
122
124
125 mem->mmap = mmap;
126 mem->length = BLI_mmap_get_length(mmap);
127
129 mem->reader.seek = memory_seek;
131
132 return reinterpret_cast<FileReader *>(mem);
133}
134
135} // namespace blender
File and directory operations.
Wrapper for reading from various sources (e.g. raw files, compressed files, memory....
Read Blender memory allocation and freeing.
ccl_device_inline dual1 len(const ccl_private dual< T > &a)
Definition math_dual.h:263
BMesh Iterators.
__int64 int64_t
Definition BKE_text.h:90
static void memory_close_mmap(FileReader *reader)
FileReader * BLI_filereader_new_mmap(int filedes) ATTR_WARN_UNUSED_RESULT
size_t BLI_mmap_get_length(const BLI_mmap_file *file) ATTR_WARN_UNUSED_RESULT
Definition BLI_mmap.cc:484
BLI_mmap_file * BLI_mmap_open(int fd) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT
Definition BLI_mmap.cc:369
static void memory_close_raw(FileReader *reader)
void BLI_mmap_free(BLI_mmap_file *file) ATTR_NONNULL(1)
Definition BLI_mmap.cc:494
FileReader * BLI_filereader_new_memory(const void *data, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
static off64_t memory_seek(FileReader *reader, off64_t offset, int whence)
void * MEM_new_zeroed(size_t len, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
BMesh const char void * data
bool BLI_mmap_read(BLI_mmap_file *file, void *dest, size_t offset, size_t length) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition BLI_mmap.cc:466
static int64_t memory_read_mmap(FileReader *reader, void *buffer, size_t size)
static int64_t memory_read_raw(FileReader *reader, void *buffer, size_t size)
FileReaderCloseFn close
FileReaderSeekFn seek
FileReaderReadFn read