Cycles: svn merge -r41225:41232 ^/trunk/blender
[blender.git] / intern / cycles / util / util_cache.h
1 /*
2  * Copyright 2011, Blender Foundation.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  */
18
19 #ifndef __UTIL_CACHE_H__
20 #define __UTIL_CACHE_H__
21
22 /* Disk Cache based on Hashing
23  *
24  * To be used to cache expensive computations. The hash key is created from an
25  * arbitrary number of bytes, by hashing the bytes using MD5, which then gives
26  * the file name containing the data. This data then is read from the file
27  * again into the appropriate data structures.
28  *
29  * This way we do not need to accurately track changes, compare dates and
30  * invalidate cache entries, at the cost of exta computation. If everything
31  * is stored in a global cache, computations can perhaps even be shared between
32  * different scenes where it may be hard to detect duplicate work.
33  */
34
35 #include "util_string.h"
36 #include "util_vector.h"
37
38 CCL_NAMESPACE_BEGIN
39
40 class CacheBuffer {
41 public:
42         const void *data;
43         size_t size;
44
45         CacheBuffer(const void *data_, size_t size_)
46         { data = data_; size = size_; }
47 };
48
49 class CacheData {
50 public:
51         vector<CacheBuffer> buffers;
52         string name;
53         FILE *f;
54
55         CacheData(const string& name = "");
56         ~CacheData();
57
58         template<typename T> void add(const vector<T>& data)
59         {
60                 if(data.size()) {
61                         CacheBuffer buffer(&data[0], data.size()*sizeof(T));
62                         buffers.push_back(buffer);
63                 }
64         }
65
66         template<typename T> void add(const array<T>& data)
67         {
68                 if(data.size()) {
69                         CacheBuffer buffer(&data[0], data.size()*sizeof(T));
70                         buffers.push_back(buffer);
71                 }
72         }
73
74         void add(void *data, size_t size)
75         {
76                 if(size) {
77                         CacheBuffer buffer(data, size);
78                         buffers.push_back(buffer);
79                 }
80         }
81
82         void add(int& data)
83         {
84                 CacheBuffer buffer(&data, sizeof(int));
85                 buffers.push_back(buffer);
86         }
87
88         void add(size_t& data)
89         {
90                 CacheBuffer buffer(&data, sizeof(size_t));
91                 buffers.push_back(buffer);
92         }
93
94         template<typename T> void read(array<T>& data)
95         {
96                 size_t size;
97
98                 if(!fread(&size, sizeof(size), 1, f)) {
99                         fprintf(stderr, "Failed to read vector size from cache.\n");
100                         return;
101                 }
102
103                 if(!size)
104                         return;
105
106                 data.resize(size/sizeof(T));
107
108                 if(!fread(&data[0], size, 1, f)) {
109                         fprintf(stderr, "Failed to read vector data from cache (%ld).\n", size);
110                         return;
111                 }
112         }
113
114         void read(int& data)
115         {
116                 if(!fread(&data, sizeof(data), 1, f))
117                         fprintf(stderr, "Failed to read int from cache.\n");
118         }
119
120         void read(size_t& data)
121         {
122                 if(!fread(&data, sizeof(data), 1, f))
123                         fprintf(stderr, "Failed to read size_t from cache.\n");
124         }
125 };
126
127 class Cache {
128 public:
129         static Cache global;
130
131         void insert(const CacheData& key, const CacheData& value);
132         bool lookup(const CacheData& key, CacheData& value);
133
134 protected:
135         string data_filename(const CacheData& key);
136 };
137
138 CCL_NAMESPACE_END
139
140 #endif /* __UTIL_CACHE_H__ */
141