src/util/areastore.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2015 est31 <mtest31@outlook.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #include "util/areastore.h"
  21 #include "util/serialize.h"
  22 #include "util/container.h"
  23
  24 #if USE_SPATIAL
  25         #include <spatialindex/SpatialIndex.h>
  26         #include <spatialindex/RTree.h>
  27         #include <spatialindex/Point.h>
  28 #endif
  29
  30 #define AST_SMALLER_EQ_AS(p, q) (((p).X <= (q).X) && ((p).Y <= (q).Y) && ((p).Z <= (q).Z))
  31
  32 #define AST_OVERLAPS_IN_DIMENSION(amine, amaxe, b, d) \
  33         (!(((amine).d > (b)->maxedge.d) || ((amaxe).d < (b)->minedge.d)))
  34
  35 #define AST_CONTAINS_PT(a, p) (AST_SMALLER_EQ_AS((a)->minedge, (p)) && \
  36         AST_SMALLER_EQ_AS((p), (a)->maxedge))
  37
  38 #define AST_CONTAINS_AREA(amine, amaxe, b)         \
  39         (AST_SMALLER_EQ_AS((amine), (b)->minedge) \
  40         && AST_SMALLER_EQ_AS((b)->maxedge, (amaxe)))
  41
  42 #define AST_AREAS_OVERLAP(amine, amaxe, b)                \
  43         (AST_OVERLAPS_IN_DIMENSION((amine), (amaxe), (b), X) && \
  44         AST_OVERLAPS_IN_DIMENSION((amine), (amaxe), (b), Y) &&  \
  45         AST_OVERLAPS_IN_DIMENSION((amine), (amaxe), (b), Z))
  46
  47
  48 AreaStore *AreaStore::getOptimalImplementation()
  49 {
  50 #if USE_SPATIAL
  51         return new SpatialAreaStore();
  52 #else
  53         return new VectorAreaStore();
  54 #endif
  55 }
  56
  57 const Area *AreaStore::getArea(u32 id) const
  58 {
  59         AreaMap::const_iterator it = areas_map.find(id);
  60         if (it == areas_map.end())
  61                 return nullptr;
  62         return &it->second;
  63 }
  64
  65 void AreaStore::serialize(std::ostream &os) const
  66 {
  67         // WARNING:
  68         // Before 5.1.0-dev: version != 0 throws SerializationError
  69         // After 5.1.0-dev:  version >= 5 throws SerializationError
  70         // Forwards-compatibility is assumed before version 5.
  71
  72         writeU8(os, 0); // Serialisation version
  73
  74         // TODO: Compression?
  75         writeU16(os, areas_map.size());
  76         for (const auto &it : areas_map) {
  77                 const Area &a = it.second;
  78                 writeV3S16(os, a.minedge);
  79                 writeV3S16(os, a.maxedge);
  80                 writeU16(os, a.data.size());
  81                 os.write(a.data.data(), a.data.size());
  82         }
  83
  84         // Serialize IDs
  85         for (const auto &it : areas_map)
  86                 writeU32(os, it.second.id);
  87 }
  88
  89 void AreaStore::deserialize(std::istream &is)
  90 {
  91         u8 ver = readU8(is);
  92         // Assume forwards-compatibility before version 5
  93         if (ver >= 5)
  94                 throw SerializationError("Unknown AreaStore "
  95                                 "serialization version!");
  96
  97         u16 num_areas = readU16(is);
  98         std::vector<Area> areas;
  99         for (u32 i = 0; i < num_areas; ++i) {
 100                 Area a(U32_MAX);
 101                 a.minedge = readV3S16(is);
 102                 a.maxedge = readV3S16(is);
 103                 u16 data_len = readU16(is);
 104                 char *data = new char[data_len];
 105                 is.read(data, data_len);
 106                 a.data = std::string(data, data_len);
 107                 areas.emplace_back(a);
 108                 delete [] data;
 109         }
 110
 111         bool read_ids = is.good(); // EOF for old formats
 112
 113         for (auto &area : areas) {
 114                 if (read_ids)
 115                         area.id = readU32(is);
 116                 insertArea(&area);
 117         }
 118 }
 119
 120 void AreaStore::invalidateCache()
 121 {
 122         if (m_cache_enabled) {
 123                 m_res_cache.invalidate();
 124         }
 125 }
 126
 127 u32 AreaStore::getNextId() const
 128 {
 129         u32 free_id = 0;
 130         for (const auto &area : areas_map) {
 131                 if (area.first > free_id)
 132                         return free_id; // Found gap
 133
 134                 free_id = area.first + 1;
 135         }
 136         // End of map
 137         return free_id;
 138 }
 139
 140 void AreaStore::setCacheParams(bool enabled, u8 block_radius, size_t limit)
 141 {
 142         m_cache_enabled = enabled;
 143         m_cacheblock_radius = MYMAX(block_radius, 16);
 144         m_res_cache.setLimit(MYMAX(limit, 20));
 145         invalidateCache();
 146 }
 147
 148 void AreaStore::cacheMiss(void *data, const v3s16 &mpos, std::vector<Area *> *dest)
 149 {
 150         AreaStore *as = (AreaStore *)data;
 151         u8 r = as->m_cacheblock_radius;
 152
 153         // get the points at the edges of the mapblock
 154         v3s16 minedge(mpos.X * r, mpos.Y * r, mpos.Z * r);
 155         v3s16 maxedge(
 156                 minedge.X + r - 1,
 157                 minedge.Y + r - 1,
 158                 minedge.Z + r - 1);
 159
 160         as->getAreasInArea(dest, minedge, maxedge, true);
 161
 162         /* infostream << "Cache miss with " << dest->size() << " areas, between ("
 163                         << minedge.X << ", " << minedge.Y << ", " << minedge.Z
 164                         << ") and ("
 165                         << maxedge.X << ", " << maxedge.Y << ", " << maxedge.Z
 166                         << ")" << std::endl; // */
 167 }
 168
 169 void AreaStore::getAreasForPos(std::vector<Area *> *result, v3s16 pos)
 170 {
 171         if (m_cache_enabled) {
 172                 v3s16 mblock = getContainerPos(pos, m_cacheblock_radius);
 173                 const std::vector<Area *> *pre_list = m_res_cache.lookupCache(mblock);
 174
 175                 size_t s_p_l = pre_list->size();
 176                 for (size_t i = 0; i < s_p_l; i++) {
 177                         Area *b = (*pre_list)[i];
 178                         if (AST_CONTAINS_PT(b, pos)) {
 179                                 result->push_back(b);
 180                         }
 181                 }
 182         } else {
 183                 return getAreasForPosImpl(result, pos);
 184         }
 185 }
 186
 187
 188 ////
 189 // VectorAreaStore
 190 ////
 191
 192
 193 bool VectorAreaStore::insertArea(Area *a)
 194 {
 195         if (a->id == U32_MAX)
 196                 a->id = getNextId();
 197         std::pair<AreaMap::iterator, bool> res =
 198                         areas_map.insert(std::make_pair(a->id, *a));
 199         if (!res.second)
 200                 // ID is not unique
 201                 return false;
 202         m_areas.push_back(&res.first->second);
 203         invalidateCache();
 204         return true;
 205 }
 206
 207 bool VectorAreaStore::removeArea(u32 id)
 208 {
 209         AreaMap::iterator it = areas_map.find(id);
 210         if (it == areas_map.end())
 211                 return false;
 212         Area *a = &it->second;
 213         for (std::vector<Area *>::iterator v_it = m_areas.begin();
 214                         v_it != m_areas.end(); ++v_it) {
 215                 if (*v_it == a) {
 216                         m_areas.erase(v_it);
 217                         break;
 218                 }
 219         }
 220         areas_map.erase(it);
 221         invalidateCache();
 222         return true;
 223 }
 224
 225 void VectorAreaStore::getAreasForPosImpl(std::vector<Area *> *result, v3s16 pos)
 226 {
 227         for (Area *area : m_areas) {
 228                 if (AST_CONTAINS_PT(area, pos)) {
 229                         result->push_back(area);
 230                 }
 231         }
 232 }
 233
 234 void VectorAreaStore::getAreasInArea(std::vector<Area *> *result,
 235                 v3s16 minedge, v3s16 maxedge, bool accept_overlap)
 236 {
 237         for (Area *area : m_areas) {
 238                 if (accept_overlap ? AST_AREAS_OVERLAP(minedge, maxedge, area) :
 239                                 AST_CONTAINS_AREA(minedge, maxedge, area)) {
 240                         result->push_back(area);
 241                 }
 242         }
 243 }
 244
 245 #if USE_SPATIAL
 246
 247 static inline SpatialIndex::Region get_spatial_region(const v3s16 minedge,
 248                 const v3s16 maxedge)
 249 {
 250         const double p_low[] = {(double)minedge.X,
 251                 (double)minedge.Y, (double)minedge.Z};
 252         const double p_high[] = {(double)maxedge.X, (double)maxedge.Y,
 253                 (double)maxedge.Z};
 254         return SpatialIndex::Region(p_low, p_high, 3);
 255 }
 256
 257 static inline SpatialIndex::Point get_spatial_point(const v3s16 pos)
 258 {
 259         const double p[] = {(double)pos.X, (double)pos.Y, (double)pos.Z};
 260         return SpatialIndex::Point(p, 3);
 261 }
 262
 263
 264 bool SpatialAreaStore::insertArea(Area *a)
 265 {
 266         if (a->id == U32_MAX)
 267                 a->id = getNextId();
 268         if (!areas_map.insert(std::make_pair(a->id, *a)).second)
 269                 // ID is not unique
 270                 return false;
 271         m_tree->insertData(0, nullptr, get_spatial_region(a->minedge, a->maxedge), a->id);
 272         invalidateCache();
 273         return true;
 274 }
 275
 276 bool SpatialAreaStore::removeArea(u32 id)
 277 {
 278         std::map<u32, Area>::iterator itr = areas_map.find(id);
 279         if (itr != areas_map.end()) {
 280                 Area *a = &itr->second;
 281                 bool result = m_tree->deleteData(get_spatial_region(a->minedge,
 282                         a->maxedge), id);
 283                 areas_map.erase(itr);
 284                 invalidateCache();
 285                 return result;
 286         } else {
 287                 return false;
 288         }
 289 }
 290
 291 void SpatialAreaStore::getAreasForPosImpl(std::vector<Area *> *result, v3s16 pos)
 292 {
 293         VectorResultVisitor visitor(result, this);
 294         m_tree->pointLocationQuery(get_spatial_point(pos), visitor);
 295 }
 296
 297 void SpatialAreaStore::getAreasInArea(std::vector<Area *> *result,
 298                 v3s16 minedge, v3s16 maxedge, bool accept_overlap)
 299 {
 300         VectorResultVisitor visitor(result, this);
 301         if (accept_overlap) {
 302                 m_tree->intersectsWithQuery(get_spatial_region(minedge, maxedge),
 303                         visitor);
 304         } else {
 305                 m_tree->containsWhatQuery(get_spatial_region(minedge, maxedge), visitor);
 306         }
 307 }
 308
 309 SpatialAreaStore::~SpatialAreaStore()
 310 {
 311         delete m_tree;
 312 }
 313
 314 SpatialAreaStore::SpatialAreaStore()
 315 {
 316         m_storagemanager =
 317                 SpatialIndex::StorageManager::createNewMemoryStorageManager();
 318         SpatialIndex::id_type id;
 319         m_tree = SpatialIndex::RTree::createNewRTree(
 320                 *m_storagemanager,
 321                 .7, // Fill factor
 322                 100, // Index capacity
 323                 100, // Leaf capacity
 324                 3, // dimension :)
 325                 SpatialIndex::RTree::RV_RSTAR,
 326                 id);
 327 }
 328
 329 #endif