Ptex
PtexCache.h
Go to the documentation of this file.
1#ifndef PtexCache_h
2#define PtexCache_h
3
4/*
5PTEX SOFTWARE
6Copyright 2014 Disney Enterprises, Inc. All rights reserved
7
8Redistribution and use in source and binary forms, with or without
9modification, are permitted provided that the following conditions are
10met:
11
12 * Redistributions of source code must retain the above copyright
13 notice, this list of conditions and the following disclaimer.
14
15 * Redistributions in binary form must reproduce the above copyright
16 notice, this list of conditions and the following disclaimer in
17 the documentation and/or other materials provided with the
18 distribution.
19
20 * The names "Disney", "Walt Disney Pictures", "Walt Disney Animation
21 Studios" or the names of its contributors may NOT be used to
22 endorse or promote products derived from this software without
23 specific prior written permission from Walt Disney Pictures.
24
25Disclaimer: THIS SOFTWARE IS PROVIDED BY WALT DISNEY PICTURES AND
26CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
27BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
28FOR A PARTICULAR PURPOSE, NONINFRINGEMENT AND TITLE ARE DISCLAIMED.
29IN NO EVENT SHALL WALT DISNEY PICTURES, THE COPYRIGHT HOLDER OR
30CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND BASED ON ANY
34THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
37*/
38
39#include "PtexPlatform.h"
40#include <cstddef>
41
42#include "PtexMutex.h"
43#include "PtexHashMap.h"
44#include "PtexReader.h"
45
47
48// Intrusive LRU list item (to be used only by PtexLruList)
50{
53
54 void extract() {
55 _next->_prev = _prev;
56 _prev->_next = _next;
57 _next = _prev = this;
58 }
59
60public:
61 PtexLruItem() : _prev(this), _next(this) {}
62
63 // add item to end of list (pointed to by _prev)
64 void push(PtexLruItem* item) {
65 item->extract();
66 _prev->_next = item;
67 item->_next = this;
68 item->_prev = _prev;
69 _prev = item;
70 }
71
72 // remove item from front of list (pointed to by _next)
74 if (_next == this) return 0;
75 PtexLruItem* item = _next;
76 _next->extract();
77 return item;
78 }
79};
80
81// Intrusive LRU list (with LRU item stored as member of T)
82template<class T, PtexLruItem T::*item>
84{
86
87public:
88 void push(T* node)
89 {
90 // the item is added to the intrusive pointer specified by the template
91 // templatization allows more than one intrusive list to be in the object
92 _end.push(&(node->*item));
93 }
94
95 T* pop()
96 {
97 PtexLruItem* it = _end.pop();
98 // "it" points to the intrusive item, a member within T
99 // subtract off the pointer-to-member offset to get a pointer to the containing T object
100 static const T* dummy = 0;
101 static const std::ptrdiff_t itemOffset = (const char*)&(dummy->*item) - (const char*)dummy;
102 return it ? (T*) ((char*)it - itemOffset) : 0;
103 }
104};
105
106class PtexReaderCache;
107
109{
111 volatile int32_t _refCount;
117 friend class PtexReaderCache;
118
119 bool trylock()
120 {
121 return AtomicCompareAndSwap(&_refCount, 0, -1);
122 }
123
124 void unlock()
125 {
127 }
128
129public:
130 PtexCachedReader(bool premultiply, PtexInputHandler* inputHandler, PtexErrorHandler* errorHandler, PtexReaderCache* cache)
131 : PtexReader(premultiply, inputHandler, errorHandler), _cache(cache), _refCount(1),
133 {
134 }
135
137
138 void ref() {
139 while (1) {
140 int32_t oldCount = _refCount;
141 if (oldCount >= 0 && AtomicCompareAndSwap(&_refCount, oldCount, oldCount+1))
142 return;
143 }
144 }
145
146 int32_t unref() {
147 return AtomicDecrement(&_refCount);
148 }
149
150 virtual void release();
151
152 bool tryPrune(size_t& memUsedChange) {
153 if (trylock()) {
154 prune();
155 memUsedChange = getMemUsedChange();
156 unlock();
157 return true;
158 }
159 return false;
160 }
161
162 bool tryPurge(size_t& memUsedChange) {
163 if (trylock()) {
164 purge();
165 memUsedChange = getMemUsedChange();
166 unlock();
167 return true;
168 }
170 return false;
171 }
172
174 size_t memUsedTmp = _memUsed;
175 size_t result = memUsedTmp - _memUsedAccountedFor;
176 _memUsedAccountedFor = memUsedTmp;
177 return result;
178 }
179
180 size_t getOpensChange() {
181 size_t opensTmp = _opens;
182 size_t result = opensTmp - _opensAccountedFor;
183 _opensAccountedFor = opensTmp;
184 return result;
185 }
186
188 size_t blockReadsTmp = _blockReads;
189 size_t result = blockReadsTmp - _blockReadsAccountedFor;
190 _blockReadsAccountedFor = blockReadsTmp;
191 return result;
192 }
193};
194
195
198{
199public:
200 PtexReaderCache(int maxFiles, size_t maxMem, bool premultiply, PtexInputHandler* inputHandler, PtexErrorHandler* errorHandler)
201 : _maxFiles(maxFiles), _maxMem(maxMem), _io(inputHandler), _err(errorHandler), _premultiply(premultiply),
202 _memUsed(sizeof(*this)), _filesOpen(0), _mruList(&_mruLists[0]), _prevMruList(&_mruLists[1]),
204 {
205 memset((void*)&_mruLists[0], 0, sizeof(_mruLists));
206 CACHE_LINE_PAD_INIT(_memUsed); // keep cppcheck happy
209 }
210
212 {}
213
214 virtual void release() { delete this; }
215
216 virtual void setSearchPath(const char* path)
217 {
218 // record path
219 _searchpath = path ? path : "";
220
221 // split into dirs
222 _searchdirs.clear();
223
224 if (path) {
225 const char* cp = path;
226 while (1) {
227 const char* delim = strchr(cp, ':');
228 if (!delim) {
229 if (*cp) _searchdirs.push_back(cp);
230 break;
231 }
232 int len = int(delim-cp);
233 if (len) _searchdirs.push_back(std::string(cp, len));
234 cp = delim+1;
235 }
236 }
237 }
238
239 virtual const char* getSearchPath()
240 {
241 return _searchpath.c_str();
242 }
243
244 virtual PtexTexture* get(const char* path, Ptex::String& error);
245
246 virtual void purge(PtexTexture* /*texture*/);
247 virtual void purge(const char* /*filename*/);
248 virtual void purgeAll();
249 virtual void getStats(Stats& stats);
250
251 void purge(PtexCachedReader* reader);
252
253 void adjustMemUsed(size_t amount) {
254 if (amount) {
255 size_t memUsed = AtomicAdd(&_memUsed, amount);
257 }
258 }
259 void adjustFilesOpen(size_t amount) {
260 if (amount) {
261 size_t filesOpen = AtomicAdd(&_filesOpen, amount);
263 }
264 }
265 void logRecentlyUsed(PtexCachedReader* reader);
266
267private:
268 struct Purger {
271 void operator() (PtexCachedReader* reader);
272 };
273
274 bool findFile(const char*& filename, std::string& buffer, Ptex::String& error);
275 void processMru();
276 void pruneFiles();
277 void pruneData();
278 size_t _maxFiles;
279 size_t _maxMem;
282 std::string _searchpath;
283 std::vector<std::string> _searchdirs;
287 volatile size_t _memUsed; CACHE_LINE_PAD(_memUsed,size_t);
288 volatile size_t _filesOpen; CACHE_LINE_PAD(_filesOpen,size_t);
290
291 static const int numMruFiles = 50;
292 struct MruList {
293 volatile int next;
295 };
297 MruList* volatile _mruList;
299
302
307};
308
310
311#endif
Contains PtexHashMap, a lightweight multi-threaded hash table.
Platform-specific classes, functions, and includes.
PTEX_INLINE T AtomicAdd(volatile T *target, T value)
Definition: PtexPlatform.h:209
#define CACHE_LINE_PAD_INIT(var)
Definition: PtexPlatform.h:301
PTEX_INLINE T AtomicDecrement(volatile T *target)
Definition: PtexPlatform.h:247
PTEX_INLINE void AtomicStore(T volatile *target, T value)
Definition: PtexPlatform.h:284
PTEX_INLINE bool AtomicCompareAndSwap(T volatile *target, T oldvalue, T newvalue)
Definition: PtexPlatform.h:278
#define PTEX_NAMESPACE_END
Definition: PtexVersion.h:62
File-handle and memory cache for reading ptex files.
Definition: Ptexture.h:684
size_t _memUsedAccountedFor
Definition: PtexCache.h:112
PtexReaderCache * _cache
Definition: PtexCache.h:110
size_t _opensAccountedFor
Definition: PtexCache.h:113
int32_t unref()
Definition: PtexCache.h:146
bool tryPurge(size_t &memUsedChange)
Definition: PtexCache.h:162
size_t getMemUsedChange()
Definition: PtexCache.h:173
PtexCachedReader(bool premultiply, PtexInputHandler *inputHandler, PtexErrorHandler *errorHandler, PtexReaderCache *cache)
Definition: PtexCache.h:130
bool tryPrune(size_t &memUsedChange)
Definition: PtexCache.h:152
virtual void release()
Release resources held by this pointer (pointer becomes invalid).
Definition: PtexCache.cpp:83
PtexLruItem _activeFilesItem
Definition: PtexCache.h:116
size_t _blockReadsAccountedFor
Definition: PtexCache.h:114
PtexLruItem _openFilesItem
Definition: PtexCache.h:115
size_t getBlockReadsChange()
Definition: PtexCache.h:187
size_t getOpensChange()
Definition: PtexCache.h:180
volatile int32_t _refCount
Definition: PtexCache.h:111
Custom handler interface redirecting Ptex error messages.
Definition: Ptexture.h:658
Custom handler interface for intercepting and redirecting Ptex input stream calls.
Definition: Ptexture.h:619
PtexLruItem * pop()
Definition: PtexCache.h:73
void extract()
Definition: PtexCache.h:54
PtexLruItem * _prev
Definition: PtexCache.h:51
void push(PtexLruItem *item)
Definition: PtexCache.h:64
PtexLruItem * _next
Definition: PtexCache.h:52
PtexLruItem _end
Definition: PtexCache.h:85
T * pop()
Definition: PtexCache.h:95
void push(T *node)
Definition: PtexCache.h:88
Cache for reading Ptex texture files.
Definition: PtexCache.h:198
PtexLruList< PtexCachedReader, &PtexCachedReader::_activeFilesItem > _activeFiles
Definition: PtexCache.h:301
std::string _searchpath
Definition: PtexCache.h:282
PtexInputHandler * _io
Definition: PtexCache.h:280
size_t _maxMem
Definition: PtexCache.h:279
void adjustFilesOpen(size_t amount)
Definition: PtexCache.h:259
size_t _fileOpens
Definition: PtexCache.h:305
volatile size_t _memUsed
Definition: PtexCache.h:287
void logRecentlyUsed(PtexCachedReader *reader)
Definition: PtexCache.cpp:188
MruList *volatile _prevMruList
Definition: PtexCache.h:298
FileMap _files
Definition: PtexCache.h:285
void adjustMemUsed(size_t amount)
Definition: PtexCache.h:253
size_t _peakMemUsed
Definition: PtexCache.h:303
virtual void release()
Release PtexCache. Cache will be immediately destroyed and all resources will be released.
Definition: PtexCache.h:214
virtual void setSearchPath(const char *path)
Set a search path for finding textures.
Definition: PtexCache.h:216
virtual const char * getSearchPath()
Query the search path.
Definition: PtexCache.h:239
virtual PtexTexture * get(const char *path, Ptex::String &error)
Access a texture.
Definition: PtexCache.cpp:121
bool findFile(const char *&filename, std::string &buffer, Ptex::String &error)
Definition: PtexCache.cpp:91
virtual void getStats(Stats &stats)
Get stats.
Definition: PtexCache.cpp:326
PtexReaderCache(int maxFiles, size_t maxMem, bool premultiply, PtexInputHandler *inputHandler, PtexErrorHandler *errorHandler)
Definition: PtexCache.h:200
static const int numMruFiles
Definition: PtexCache.h:291
size_t _maxFiles
Definition: PtexCache.h:278
size_t _peakFilesOpen
Definition: PtexCache.h:304
PtexErrorHandler * _err
Definition: PtexCache.h:281
CACHE_LINE_PAD(_memUsed, size_t)
PtexLruList< PtexCachedReader, &PtexCachedReader::_openFilesItem > _openFiles
Definition: PtexCache.h:300
PtexHashMap< StringKey, PtexCachedReader * > FileMap
Definition: PtexCache.h:284
virtual void purgeAll()
Remove all texture files from the cache.
Definition: PtexCache.cpp:319
size_t _blockReads
Definition: PtexCache.h:306
volatile size_t _filesOpen
Definition: PtexCache.h:288
MruList *volatile _mruList
Definition: PtexCache.h:297
virtual void purge(PtexTexture *)
Remove a texture file from the cache.
Definition: PtexCache.cpp:287
MruList _mruLists[2]
Definition: PtexCache.h:296
std::vector< std::string > _searchdirs
Definition: PtexCache.h:283
void setPendingPurge()
Definition: PtexReader.h:61
volatile size_t _opens
Definition: PtexReader.h:719
void purge()
Definition: PtexReader.cpp:115
void prune()
Definition: PtexReader.cpp:104
volatile size_t _memUsed
Definition: PtexReader.h:718
volatile size_t _blockReads
Definition: PtexReader.h:720
Interface for reading data from a ptex file.
Definition: Ptexture.h:457
Memory-managed string.
Definition: Ptexture.h:296
T max(T a, T b)
Definition: PtexUtils.h:151
PtexCachedReader *volatile files[numMruFiles]
Definition: PtexCache.h:294
void operator()(PtexCachedReader *reader)
Definition: PtexCache.cpp:311