51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#ifndef UTIL_CONTAINER_HEADER
-#define UTIL_CONTAINER_HEADER
-
-#include "../irrlichttypes.h"
-#include "../exceptions.h"
-#include "../jthread/jmutex.h"
-#include "../jthread/jmutexautolock.h"
-#include "../porting.h" // For sleep_ms
+#pragma once
+
+#include "irrlichttypes.h"
+#include "exceptions.h"
+#include "threading/mutex_auto_lock.h"
+#include "threading/semaphore.h"
#include <list>
#include <vector>
#include <map>
+#include <set>
+#include <queue>
/*
- Queue with unique values with fast checking of value existence
+Queue with unique values with fast checking of value existence
*/
template<typename Value>
class UniqueQueue
{
public:
-
+
/*
- Does nothing if value is already queued.
- Return value:
- true: value added
- false: value already exists
+ Does nothing if value is already queued.
+ Return value:
+ true: value added
+ false: value already exists
*/
- bool push_back(Value value)
+ bool push_back(const Value& value)
{
- // Check if already exists
- if(m_map.find(value) != m_map.end())
- return false;
+ if (m_set.insert(value).second)
+ {
+ m_queue.push(value);
+ return true;
+ }
+ return false;
+ }
- // Add
- m_map[value] = 0;
- m_list.push_back(value);
-
- return true;
+ void pop_front()
+ {
+ m_set.erase(m_queue.front());
+ m_queue.pop();
}
- Value pop_front()
+ const Value& front() const
{
- typename std::list<Value>::iterator i = m_list.begin();
- Value value = *i;
- m_map.erase(value);
- m_list.erase(i);
- return value;
+ return m_queue.front();
}
- u32 size()
+ u32 size() const
{
- return m_map.size();
+ return m_queue.size();
}
private:
- std::map<Value, u8> m_map;
- std::list<Value> m_list;
+ std::set<Value> m_set;
+ std::queue<Value> m_queue;
};
-#if 1
template<typename Key, typename Value>
class MutexedMap
{
public:
- MutexedMap()
- {
- m_mutex.Init();
- assert(m_mutex.IsInitialized());
- }
-
+ MutexedMap() = default;
+
void set(const Key &name, const Value &value)
{
- JMutexAutoLock lock(m_mutex);
-
+ MutexAutoLock lock(m_mutex);
m_values[name] = value;
}
-
- bool get(const Key &name, Value *result)
- {
- JMutexAutoLock lock(m_mutex);
-
- typename std::map<Key, Value>::iterator n;
- n = m_values.find(name);
- if(n == m_values.end())
+ bool get(const Key &name, Value *result) const
+ {
+ MutexAutoLock lock(m_mutex);
+ typename std::map<Key, Value>::const_iterator n =
+ m_values.find(name);
+ if (n == m_values.end())
return false;
-
- if(result != NULL)
+ if (result)
*result = n->second;
-
return true;
}
- std::list<Value> getValues()
+ std::vector<Value> getValues() const
{
- std::list<Value> result;
- for(typename std::map<Key, Value>::iterator
- i = m_values.begin();
- i != m_values.end(); ++i){
- result.push_back(i->second);
+ MutexAutoLock lock(m_mutex);
+ std::vector<Value> result;
+ for (typename std::map<Key, Value>::const_iterator
+ it = m_values.begin();
+ it != m_values.end(); ++it){
+ result.push_back(it->second);
}
return result;
}
-
- void clear ()
- {
- m_values.clear();
- }
+
+ void clear() { m_values.clear(); }
private:
std::map<Key, Value> m_values;
- JMutex m_mutex;
+ mutable std::mutex m_mutex;
};
-#endif
-/*
- Generates ids for comparable values.
- Id=0 is reserved for "no value".
- Is fast at:
- - Returning value by id (very fast)
- - Returning id by value
- - Generating a new id for a value
+// Thread-safe Double-ended queue
- Is not able to:
- - Remove an id/value pair (is possible to implement but slow)
-*/
template<typename T>
-class MutexedIdGenerator
+class MutexedQueue
{
public:
- MutexedIdGenerator()
+ template<typename Key, typename U, typename Caller, typename CallerData>
+ friend class RequestQueue;
+
+ MutexedQueue() = default;
+
+ bool empty() const
{
- m_mutex.Init();
- assert(m_mutex.IsInitialized());
+ MutexAutoLock lock(m_mutex);
+ return m_queue.empty();
}
-
- // Returns true if found
- bool getValue(u32 id, T &value)
+
+ void push_back(T t)
{
- if(id == 0)
- return false;
- JMutexAutoLock lock(m_mutex);
- if(m_id_to_value.size() < id)
- return false;
- value = m_id_to_value[id-1];
- return true;
+ MutexAutoLock lock(m_mutex);
+ m_queue.push_back(t);
+ m_signal.post();
}
-
- // If id exists for value, returns the id.
- // Otherwise generates an id for the value.
- u32 getId(const T &value)
+
+ /* this version of pop_front returns a empty element of T on timeout.
+ * Make sure default constructor of T creates a recognizable "empty" element
+ */
+ T pop_frontNoEx(u32 wait_time_max_ms)
{
- JMutexAutoLock lock(m_mutex);
- typename std::map<T, u32>::iterator n;
- n = m_value_to_id.find(value);
- if(n != m_value_to_id.end())
- return n->second;
- m_id_to_value.push_back(value);
- u32 new_id = m_id_to_value.size();
- m_value_to_id.insert(value, new_id);
- return new_id;
- }
+ if (m_signal.wait(wait_time_max_ms)) {
+ MutexAutoLock lock(m_mutex);
-private:
- JMutex m_mutex;
- // Values are stored here at id-1 position (id 1 = [0])
- std::vector<T> m_id_to_value;
- std::map<T, u32> m_value_to_id;
-};
+ T t = m_queue.front();
+ m_queue.pop_front();
+ return t;
+ }
-/*
- FIFO queue (well, actually a FILO also)
-*/
-template<typename T>
-class Queue
-{
-public:
- Queue():
- m_list_size(0)
- {}
+ return T();
+ }
- void push_back(T t)
+ T pop_front(u32 wait_time_max_ms)
{
- m_list.push_back(t);
- ++m_list_size;
+ if (m_signal.wait(wait_time_max_ms)) {
+ MutexAutoLock lock(m_mutex);
+
+ T t = m_queue.front();
+ m_queue.pop_front();
+ return t;
+ }
+
+ throw ItemNotFoundException("MutexedQueue: queue is empty");
}
-
- T pop_front()
+
+ T pop_frontNoEx()
{
- if(m_list.empty())
- throw ItemNotFoundException("Queue: queue is empty");
+ m_signal.wait();
+
+ MutexAutoLock lock(m_mutex);
- typename std::list<T>::iterator begin = m_list.begin();
- T t = *begin;
- m_list.erase(begin);
- --m_list_size;
+ T t = m_queue.front();
+ m_queue.pop_front();
return t;
}
- T pop_back()
+
+ T pop_back(u32 wait_time_max_ms=0)
{
- if(m_list.empty())
- throw ItemNotFoundException("Queue: queue is empty");
+ if (m_signal.wait(wait_time_max_ms)) {
+ MutexAutoLock lock(m_mutex);
- typename std::list<T>::iterator last = m_list.back();
- T t = *last;
- m_list.erase(last);
- --m_list_size;
- return t;
+ T t = m_queue.back();
+ m_queue.pop_back();
+ return t;
+ }
+
+ throw ItemNotFoundException("MutexedQueue: queue is empty");
}
- u32 size()
+ /* this version of pop_back returns a empty element of T on timeout.
+ * Make sure default constructor of T creates a recognizable "empty" element
+ */
+ T pop_backNoEx(u32 wait_time_max_ms)
{
- return m_list_size;
+ if (m_signal.wait(wait_time_max_ms)) {
+ MutexAutoLock lock(m_mutex);
+
+ T t = m_queue.back();
+ m_queue.pop_back();
+ return t;
+ }
+
+ return T();
}
- bool empty()
+ T pop_backNoEx()
{
- return m_list.empty();
+ m_signal.wait();
+
+ MutexAutoLock lock(m_mutex);
+
+ T t = m_queue.back();
+ m_queue.pop_back();
+ return t;
}
protected:
- std::list<T> m_list;
- u32 m_list_size;
-};
+ std::mutex &getMutex() { return m_mutex; }
-/*
- Thread-safe FIFO queue (well, actually a FILO also)
-*/
+ std::deque<T> &getQueue() { return m_queue; }
-template<typename T>
-class MutexedQueue
+ std::deque<T> m_queue;
+ mutable std::mutex m_mutex;
+ Semaphore m_signal;
+};
+
+template<typename K, typename V>
+class LRUCache
{
public:
- MutexedQueue()
+ LRUCache(size_t limit, void (*cache_miss)(void *data, const K &key, V *dest),
+ void *data)
{
- m_mutex.Init();
+ m_limit = limit;
+ m_cache_miss = cache_miss;
+ m_cache_miss_data = data;
}
- bool empty()
+
+ void setLimit(size_t limit)
{
- JMutexAutoLock lock(m_mutex);
- return m_list.empty();
+ m_limit = limit;
+ invalidate();
}
- void push_back(T t)
+
+ void invalidate()
{
- JMutexAutoLock lock(m_mutex);
- m_list.push_back(t);
+ m_map.clear();
+ m_queue.clear();
}
- T pop_front(u32 wait_time_max_ms=0)
- {
- u32 wait_time_ms = 0;
-
- for(;;)
- {
- {
- JMutexAutoLock lock(m_mutex);
-
- if(!m_list.empty())
- {
- typename std::list<T>::iterator begin = m_list.begin();
- T t = *begin;
- m_list.erase(begin);
- return t;
- }
-
- if(wait_time_ms >= wait_time_max_ms)
- throw ItemNotFoundException("MutexedQueue: queue is empty");
- }
- // Wait a while before trying again
- sleep_ms(10);
- wait_time_ms += 10;
- }
- }
- T pop_back(u32 wait_time_max_ms=0)
+ const V *lookupCache(K key)
{
- u32 wait_time_ms = 0;
-
- for(;;)
- {
- {
- JMutexAutoLock lock(m_mutex);
-
- if(!m_list.empty())
- {
- typename std::list<T>::iterator last = m_list.back();
- T t = *last;
- m_list.erase(last);
- return t;
- }
-
- if(wait_time_ms >= wait_time_max_ms)
- throw ItemNotFoundException("MutexedQueue: queue is empty");
+ typename cache_type::iterator it = m_map.find(key);
+ V *ret;
+ if (it != m_map.end()) {
+ // found!
+
+ cache_entry_t &entry = it->second;
+
+ ret = &entry.second;
+
+ // update the usage information
+ m_queue.erase(entry.first);
+ m_queue.push_front(key);
+ entry.first = m_queue.begin();
+ } else {
+ // cache miss -- enter into cache
+ cache_entry_t &entry =
+ m_map[key];
+ ret = &entry.second;
+ m_cache_miss(m_cache_miss_data, key, &entry.second);
+
+ // delete old entries
+ if (m_queue.size() == m_limit) {
+ const K &id = m_queue.back();
+ m_map.erase(id);
+ m_queue.pop_back();
}
- // Wait a while before trying again
- sleep_ms(10);
- wait_time_ms += 10;
+ m_queue.push_front(key);
+ entry.first = m_queue.begin();
}
+ return ret;
}
-
- JMutex & getMutex()
- {
- return m_mutex;
- }
-
- std::list<T> & getList()
- {
- return m_list;
- }
-
-protected:
- JMutex m_mutex;
- std::list<T> m_list;
+private:
+ void (*m_cache_miss)(void *data, const K &key, V *dest);
+ void *m_cache_miss_data;
+ size_t m_limit;
+ typedef typename std::template pair<typename std::template list<K>::iterator, V> cache_entry_t;
+ typedef std::template map<K, cache_entry_t> cache_type;
+ cache_type m_map;
+ // we can't use std::deque here, because its iterators get invalidated
+ std::list<K> m_queue;
};
-
-#endif
-
projects / minetest.git / blobdiff