1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
#pragma once
#include "platform/country_file.hpp"
#include "platform/local_country_file.hpp"
#include "platform/mwm_version.hpp"
#include "geometry/rect2d.hpp"
#include "base/macros.hpp"
#include "indexer/data_factory.hpp"
#include "indexer/feature_meta.hpp"
#include "indexer/features_offsets_table.hpp"
#include <atomic>
#include <deque>
#include <map>
#include <memory>
#include <mutex>
#include <string>
#include <utility>
#include <vector>
#include "base/observer_list.hpp"
/// Information about stored mwm.
class MwmInfo
{
public:
friend class DataSource;
friend class MwmSet;
enum MwmTypeT
{
COUNTRY,
WORLD,
COASTS
};
enum Status
{
STATUS_REGISTERED, ///< Mwm is registered and up to date.
STATUS_MARKED_TO_DEREGISTER, ///< Mwm is marked to be deregistered as soon as possible.
STATUS_DEREGISTERED, ///< Mwm is deregistered.
};
MwmInfo();
virtual ~MwmInfo() = default;
m2::RectD m_bordersRect; ///< Rect around region border. Features which cross region border may
///< cross this rect.
uint8_t m_minScale; ///< Min zoom level of mwm.
uint8_t m_maxScale; ///< Max zoom level of mwm.
version::MwmVersion m_version; ///< Mwm file version.
Status GetStatus() const { return m_status; }
bool IsUpToDate() const { return IsRegistered(); }
bool IsRegistered() const { return m_status == STATUS_REGISTERED; }
platform::LocalCountryFile const & GetLocalFile() const { return m_file; }
std::string const & GetCountryName() const { return m_file.GetCountryName(); }
int64_t GetVersion() const { return m_file.GetVersion(); }
MwmTypeT GetType() const;
feature::RegionData const & GetRegionData() const { return m_data; }
/// Returns the lock counter value for test needs.
uint8_t GetNumRefs() const { return m_numRefs; }
protected:
Status SetStatus(Status status)
{
Status result = m_status;
m_status = status;
return result;
}
feature::RegionData m_data;
platform::LocalCountryFile m_file; ///< Path to the mwm file.
std::atomic<Status> m_status; ///< Current country status.
uint32_t m_numRefs; ///< Number of active handles.
};
class MwmInfoEx : public MwmInfo
{
private:
friend class DataSource;
friend class MwmValue;
// weak_ptr is needed here to access offsets table in already
// instantiated MwmValue-s for the MWM, including MwmValues in the
// MwmSet's cache. We can't use shared_ptr because of offsets table
// must be removed as soon as the last corresponding MwmValue is
// destroyed. Also, note that this value must be used and modified
// only in MwmValue::SetTable() method, which, in turn, is called
// only in the MwmSet critical section, protected by a lock. So,
// there's an implicit synchronization on this field.
std::weak_ptr<feature::FeaturesOffsetsTable> m_table;
};
class MwmSet
{
public:
class MwmId
{
public:
friend class MwmSet;
MwmId() = default;
MwmId(std::shared_ptr<MwmInfo> const & info) : m_info(info) {}
void Reset() { m_info.reset(); }
bool IsAlive() const { return (m_info && m_info->GetStatus() != MwmInfo::STATUS_DEREGISTERED); }
bool IsDeregistered(platform::LocalCountryFile const & deregisteredCountryFile) const;
std::shared_ptr<MwmInfo> & GetInfo() { return m_info; }
std::shared_ptr<MwmInfo> const & GetInfo() const { return m_info; }
bool operator==(MwmId const & rhs) const { return GetInfo() == rhs.GetInfo(); }
bool operator!=(MwmId const & rhs) const { return !(*this == rhs); }
bool operator<(MwmId const & rhs) const { return GetInfo() < rhs.GetInfo(); }
friend std::string DebugPrint(MwmId const & id);
private:
std::shared_ptr<MwmInfo> m_info;
};
public:
explicit MwmSet(size_t cacheSize = 64) : m_cacheSize(cacheSize) {}
virtual ~MwmSet() = default;
class MwmValueBase
{
public:
virtual ~MwmValueBase() = default;
};
// Mwm handle, which is used to refer to mwm and prevent it from
// deletion when its FileContainer is used.
class MwmHandle
{
public:
MwmHandle();
MwmHandle(MwmHandle && handle);
~MwmHandle();
// Returns a non-owning ptr.
template <typename T>
T * GetValue() const
{
return static_cast<T *>(m_value.get());
}
bool IsAlive() const { return m_value.get() != nullptr; }
MwmId const & GetId() const { return m_mwmId; }
std::shared_ptr<MwmInfo> const & GetInfo() const;
MwmHandle & operator=(MwmHandle && handle);
protected:
MwmId m_mwmId;
private:
friend class MwmSet;
MwmHandle(MwmSet & mwmSet, MwmId const & mwmId, std::unique_ptr<MwmValueBase> && value);
MwmSet * m_mwmSet;
std::unique_ptr<MwmValueBase> m_value;
DISALLOW_COPY(MwmHandle);
};
struct Event
{
enum Type
{
TYPE_REGISTERED,
TYPE_DEREGISTERED,
TYPE_UPDATED,
};
Event() = default;
Event(Type type, platform::LocalCountryFile const & file)
: m_type(type), m_file(file)
{
}
Event(Type type, platform::LocalCountryFile const & newFile,
platform::LocalCountryFile const & oldFile)
: m_type(type), m_file(newFile), m_oldFile(oldFile)
{
}
bool operator==(Event const & rhs) const
{
return m_type == rhs.m_type && m_file == rhs.m_file && m_oldFile == rhs.m_oldFile;
}
bool operator!=(Event const & rhs) const { return !(*this == rhs); }
Type m_type;
platform::LocalCountryFile m_file;
platform::LocalCountryFile m_oldFile;
};
class EventList
{
public:
EventList() = default;
void Add(Event const & event) { m_events.push_back(event); }
void Append(EventList const & events)
{
m_events.insert(m_events.end(), events.m_events.begin(), events.m_events.end());
}
std::vector<Event> const & Get() const { return m_events; }
private:
std::vector<Event> m_events;
DISALLOW_COPY_AND_MOVE(EventList);
};
enum class RegResult
{
Success,
VersionAlreadyExists,
VersionTooOld,
UnsupportedFileFormat,
BadFile
};
// An Observer interface to MwmSet. Note that these functions can
// be called from *ANY* thread because most signals are sent when
// some thread releases its MwmHandle, so overrides must be as fast
// as possible and non-blocking when it's possible.
class Observer
{
public:
virtual ~Observer() = default;
// Called when a map is registered for a first time and can be
// used.
virtual void OnMapRegistered(platform::LocalCountryFile const & /*localFile*/) {}
// Called when a map is updated to a newer version. Feel free to
// treat it as combined OnMapRegistered(newFile) +
// OnMapDeregistered(oldFile).
virtual void OnMapUpdated(platform::LocalCountryFile const & /*newFile*/,
platform::LocalCountryFile const & /*oldFile*/) {}
// Called when a map is deregistered and can no longer be used.
virtual void OnMapDeregistered(platform::LocalCountryFile const & /*localFile*/) {}
};
/// Registers a new map.
///
/// \return An active mwm handle when an mwm file with this version
/// already exists (in this case mwm handle will point to already
/// registered file) or when all registered corresponding mwm files
/// are older than the localFile (in this case mwm handle will point
/// to just-registered file).
protected:
pair<MwmId, RegResult> RegisterImpl(platform::LocalCountryFile const & localFile, EventList & events);
public:
pair<MwmId, RegResult> Register(platform::LocalCountryFile const & localFile);
//@}
/// @name Remove mwm.
//@{
protected:
/// Deregisters a map from internal records.
///
/// \param countryFile A countryFile denoting a map to be deregistered.
/// \return True if the map was successfully deregistered. If map is locked
/// now, returns false.
//@{
bool DeregisterImpl(MwmId const & id, EventList & events);
bool DeregisterImpl(platform::CountryFile const & countryFile, EventList & events);
//@}
public:
bool Deregister(platform::CountryFile const & countryFile);
//@}
bool AddObserver(Observer & observer) { return m_observers.Add(observer); }
bool RemoveObserver(Observer const & observer) { return m_observers.Remove(observer); }
/// Returns true when country is registered and can be used.
bool IsLoaded(platform::CountryFile const & countryFile) const;
/// Get ids of all mwms. Some of them may be with not active status.
/// In that case, LockValue returns NULL.
void GetMwmsInfo(std::vector<std::shared_ptr<MwmInfo>> & info) const;
// Clears caches and mwm's registry. All known mwms won't be marked as DEREGISTERED.
void Clear();
void ClearCache();
MwmId GetMwmIdByCountryFile(platform::CountryFile const & countryFile) const;
MwmHandle GetMwmHandleByCountryFile(platform::CountryFile const & countryFile);
MwmHandle GetMwmHandleById(MwmId const & id);
/// Now this function looks like workaround, but it allows to avoid ugly const_cast everywhere..
/// Client code usually holds const reference to DataSource, but implementation is non-const.
/// @todo Actually, we need to define, is this behaviour (getting Handle) const or non-const.
MwmHandle GetMwmHandleById(MwmId const & id) const
{
return const_cast<MwmSet *>(this)->GetMwmHandleById(id);
}
protected:
virtual std::unique_ptr<MwmInfo> CreateInfo(platform::LocalCountryFile const & localFile) const = 0;
virtual std::unique_ptr<MwmValueBase> CreateValue(MwmInfo & info) const = 0;
private:
using Cache = std::deque<std::pair<MwmId, std::unique_ptr<MwmValueBase>>>;
// This is the only valid way to take |m_lock| and use *Impl()
// functions. The reason is that event processing requires
// triggering of observers, but it's generally unsafe to call
// user-provided functions while |m_lock| is taken, as it may lead
// to deadlocks or locks without any time guarantees. Instead, a
// list of Events is used to collect all events and then send them
// to observers without |m_lock| protection.
template <typename TFn>
void WithEventLog(TFn && fn)
{
EventList events;
{
std::lock_guard<std::mutex> lock(m_lock);
fn(events);
}
ProcessEventList(events);
}
// Sets |status| in |info|, adds corresponding event to |event|.
void SetStatus(MwmInfo & info, MwmInfo::Status status, EventList & events);
// Triggers observers on each event in |events|.
void ProcessEventList(EventList & events);
/// @precondition This function is always called under mutex m_lock.
MwmHandle GetMwmHandleByIdImpl(MwmId const & id, EventList & events);
std::unique_ptr<MwmValueBase> LockValue(MwmId const & id);
std::unique_ptr<MwmValueBase> LockValueImpl(MwmId const & id, EventList & events);
void UnlockValue(MwmId const & id, std::unique_ptr<MwmValueBase> p);
void UnlockValueImpl(MwmId const & id, std::unique_ptr<MwmValueBase> p, EventList & events);
/// Do the cleaning for [beg, end) without acquiring the mutex.
/// @precondition This function is always called under mutex m_lock.
void ClearCacheImpl(Cache::iterator beg, Cache::iterator end);
Cache m_cache;
size_t const m_cacheSize;
protected:
/// @precondition This function is always called under mutex m_lock.
void ClearCache(MwmId const & id);
/// Find mwm with a given name.
/// @precondition This function is always called under mutex m_lock.
MwmId GetMwmIdByCountryFileImpl(platform::CountryFile const & countryFile) const;
std::map<std::string, std::vector<std::shared_ptr<MwmInfo>>> m_info;
mutable std::mutex m_lock;
private:
base::ObserverListSafe<Observer> m_observers;
}; // class MwmSet
class MwmValue : public MwmSet::MwmValueBase
{
public:
FilesContainerR const m_cont;
IndexFactory m_factory;
platform::LocalCountryFile const m_file;
std::shared_ptr<feature::FeaturesOffsetsTable> m_table;
explicit MwmValue(platform::LocalCountryFile const & localFile);
void SetTable(MwmInfoEx & info);
feature::DataHeader const & GetHeader() const { return m_factory.GetHeader(); }
feature::RegionData const & GetRegionData() const { return m_factory.GetRegionData(); }
version::MwmVersion const & GetMwmVersion() const { return m_factory.GetMwmVersion(); }
std::string const & GetCountryFileName() const { return m_file.GetCountryFile().GetName(); }
bool HasSearchIndex() { return m_cont.IsExist(SEARCH_INDEX_FILE_TAG); }
bool HasGeometryIndex() { return m_cont.IsExist(INDEX_FILE_TAG); }
}; // class MwmValue
std::string DebugPrint(MwmSet::RegResult result);
std::string DebugPrint(MwmSet::Event::Type type);
std::string DebugPrint(MwmSet::Event const & event);
|