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                 CacheBuffer buffer(&data[0], data.size()*sizeof(T));
  61                 buffers.push_back(buffer);
  62         }
  63
  64         template<typename T> void add(const array<T>& data)
  65         {
  66                 CacheBuffer buffer(&data[0], data.size()*sizeof(T));
  67                 buffers.push_back(buffer);
  68         }
  69
  70         void add(void *data, size_t size)
  71         {
  72                 CacheBuffer buffer(data, size);
  73                 buffers.push_back(buffer);
  74         }
  75
  76         void add(int& data)
  77         {
  78                 CacheBuffer buffer(&data, sizeof(int));
  79                 buffers.push_back(buffer);
  80         }
  81
  82         void add(size_t& data)
  83         {
  84                 CacheBuffer buffer(&data, sizeof(size_t));
  85                 buffers.push_back(buffer);
  86         }
  87
  88         template<typename T> void read(array<T>& data)
  89         {
  90                 size_t size;
  91
  92                 if(!fread(&size, sizeof(size), 1, f)) {
  93                         fprintf(stderr, "Failed to read vector size from cache.\n");
  94                         return;
  95                 }
  96
  97                 data.resize(size/sizeof(T));
  98
  99                 if(!fread(&data[0], size, 1, f)) {
 100                         fprintf(stderr, "Failed to read vector data from cache (%ld).\n", size);
 101                         return;
 102                 }
 103         }
 104
 105         void read(int& data)
 106         {
 107                 if(!fread(&data, sizeof(data), 1, f))
 108                         fprintf(stderr, "Failed to read int from cache.\n");
 109         }
 110
 111         void read(size_t& data)
 112         {
 113                 if(!fread(&data, sizeof(data), 1, f))
 114                         fprintf(stderr, "Failed to read size_t from cache.\n");
 115         }
 116 };
 117
 118 class Cache {
 119 public:
 120         static Cache global;
 121
 122         void insert(const CacheData& key, const CacheData& value);
 123         bool lookup(const CacheData& key, CacheData& value);
 124
 125 protected:
 126         string data_filename(const CacheData& key);
 127 };
 128
 129 CCL_NAMESPACE_END
 130
 131 #endif /* __UTIL_CACHE_H__ */
 132