--- deliantra/server/include/util.h	2007/02/15 18:09:34	1.38
+++ deliantra/server/include/util.h	2008/05/06 16:55:26	1.75
@@ -1,14 +1,53 @@
+/*
+ * This file is part of Deliantra, the Roguelike Realtime MMORPG.
+ * 
+ * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
+ * 
+ * Deliantra is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 
+ * The authors can be reached via e-mail to <support@deliantra.net>
+ */
+
 #ifndef UTIL_H__
 #define UTIL_H__
 
-//#define PREFER_MALLOC
+#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0
+#define DEBUG_SALLOC  0   // add a debug wrapper around all sallocs
+#define PREFER_MALLOC 0   // use malloc and not the slice allocator
 
 #if __GNUC__ >= 3
-# define is_constant(c) __builtin_constant_p (c)
+# define is_constant(c)             __builtin_constant_p (c)
+# define expect(expr,value)         __builtin_expect ((expr),(value))
+# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
 #else
-# define is_constant(c) 0
+# define is_constant(c)             0
+# define expect(expr,value)         (expr)
+# define prefetch(addr,rw,locality)
+#endif
+
+#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
+# define decltype(x) typeof(x)
 #endif
 
+// put into ifs if you are very sure that the expression
+// is mostly true or mosty false. note that these return
+// booleans, not the expression.
+#define expect_false(expr) expect ((expr) != 0, 0)
+#define expect_true(expr)  expect ((expr) != 0, 1)
+
+#include <pthread.h>
+
 #include <cstddef>
 #include <cmath>
 #include <new>
@@ -19,15 +58,28 @@
 #include <shstr.h>
 #include <traits.h>
 
-// use a gcc extension for auto declarations until ISO C++ sanctifies them
-#define AUTODECL(var,expr) typeof(expr) var = (expr)
+#if DEBUG_SALLOC
+# define g_slice_alloc0(s) debug_slice_alloc0(s)
+# define g_slice_alloc(s) debug_slice_alloc(s)
+# define g_slice_free1(s,p) debug_slice_free1(s,p)
+void *g_slice_alloc (unsigned long size);
+void *g_slice_alloc0 (unsigned long size);
+void g_slice_free1 (unsigned long size, void *ptr);
+#elif PREFER_MALLOC
+# define g_slice_alloc0(s) calloc (1, (s))
+# define g_slice_alloc(s) malloc ((s))
+# define g_slice_free1(s,p) free ((p))
+#endif
+
+// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever)
+#define auto(var,expr) decltype(expr) var = (expr)
 
 // very ugly macro that basicaly declares and initialises a variable
 // that is in scope for the next statement only
 // works only for stuff that can be assigned 0 and converts to false
 // (note: works great for pointers)
 // most ugly macro I ever wrote
-#define declvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1)
+#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1)
 
 // in range including end
 #define IN_RANGE_INC(val,beg,end) \
@@ -37,6 +89,7 @@
 #define IN_RANGE_EXC(val,beg,end) \
   ((unsigned int)(val) - (unsigned int)(beg) <  (unsigned int)(end) - (unsigned int)(beg))
 
+void cleanup (const char *cause, bool make_core = false);
 void fork_abort (const char *msg);
 
 // rationale for using (U) not (T) is to reduce signed/unsigned issues,
@@ -47,6 +100,16 @@
 
 template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
 
+template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); }
+template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
+
+template<typename T>
+static inline T
+lerp (T val, T min_in, T max_in, T min_out, T max_out)
+{
+  return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out;
+}
+
 // lots of stuff taken from FXT
 
 /* Rotate right. This is used in various places for checksumming */
@@ -132,6 +195,45 @@
   return ((d - 1) & 7) + 1;
 }
 
+extern ssize_t slice_alloc; // statistics
+
+void *salloc_ (int n)            throw (std::bad_alloc);
+void *salloc_ (int n, void *src) throw (std::bad_alloc);
+
+// strictly the same as g_slice_alloc, but never returns 0
+template<typename T>
+inline T *salloc (int n = 1)     throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T));              }
+
+// also copies src into the new area, like "memdup"
+// if src is 0, clears the memory
+template<typename T>
+inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
+
+// clears the memory
+template<typename T>
+inline T *salloc0(int n = 1)     throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0);           }
+
+// for symmetry
+template<typename T>
+inline void sfree (T *ptr, int n = 1) throw ()
+{
+  if (expect_true (ptr))
+    {
+      slice_alloc -= n * sizeof (T);
+      if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
+      g_slice_free1 (n * sizeof (T), (void *)ptr);
+      assert (slice_alloc >= 0);//D
+    }
+}
+
+// nulls the pointer
+template<typename T>
+inline void sfree0 (T *&ptr, int n = 1) throw ()
+{
+  sfree<T> (ptr, n);
+  ptr = 0;
+}
+
 // makes dynamically allocated objects zero-initialised
 struct zero_initialised
 {
@@ -143,51 +245,53 @@
 
   void *operator new (size_t s)
   {
-    return g_slice_alloc0 (s);
+    return salloc0<char> (s);
   }
 
   void *operator new[] (size_t s)
   {
-    return g_slice_alloc0 (s);
+    return salloc0<char> (s);
   }
 
   void operator delete (void *p, size_t s)
   {
-    g_slice_free1 (s, p);
+    sfree ((char *)p, s);
   }
 
   void operator delete[] (void *p, size_t s)
   {
-    g_slice_free1 (s, p);
+    sfree ((char *)p, s);
   }
 };
 
-void *salloc_ (int n)            throw (std::bad_alloc);
-void *salloc_ (int n, void *src) throw (std::bad_alloc);
+// makes dynamically allocated objects zero-initialised
+struct slice_allocated
+{
+  void *operator new (size_t s, void *p)
+  {
+    return p;
+  }
 
-// strictly the same as g_slice_alloc, but never returns 0
-template<typename T>
-inline T *salloc (int n = 1)     throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T));              }
+  void *operator new (size_t s)
+  {
+    return salloc<char> (s);
+  }
 
-// also copies src into the new area, like "memdup"
-// if src is 0, clears the memory
-template<typename T>
-inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
+  void *operator new[] (size_t s)
+  {
+    return salloc<char> (s);
+  }
 
-// clears the memory
-template<typename T>
-inline T *salloc0(int n = 1)     throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0);           }
+  void operator delete (void *p, size_t s)
+  {
+    sfree ((char *)p, s);
+  }
 
-// for symmetry
-template<typename T>
-inline void sfree (T *ptr, int n = 1) throw ()
-{
-#ifdef PREFER_MALLOC
-  free (ptr);
-#else
-  g_slice_free1 (n * sizeof (T), (void *)ptr);
-#endif
-}
+  void operator delete[] (void *p, size_t s)
+  {
+    sfree ((char *)p, s);
+  }
+};
 
 // a STL-compatible allocator that uses g_slice
 // boy, this is verbose
@@ -209,7 +313,7 @@
   };
 
   slice_allocator () throw () { }
-  slice_allocator (const slice_allocator &o) throw () { }
+  slice_allocator (const slice_allocator &) throw () { }
   template<typename Tp2>
   slice_allocator (const slice_allocator<Tp2> &) throw () { }
 
@@ -228,7 +332,7 @@
     sfree<Tp> (p, n);
   }
 
-  size_type max_size ()const throw ()
+  size_type max_size () const throw ()
   {
     return size_t (-1) / sizeof (Tp);
   }
@@ -264,18 +368,18 @@
   uint32_t next ();
 
   // uniform distribution
-  uint32_t operator ()(uint32_t r_max)
+  uint32_t operator ()(uint32_t num)
   {
-    return is_constant (r_max)
-             ? this->next () % r_max
-             : get_range (r_max);
+    return is_constant (num)
+             ? (next () * (uint64_t)num) >> 32U
+             : get_range (num);
   }
 
   // return a number within (min .. max)
   int operator () (int r_min, int r_max)
   {
-    return is_constant (r_min) && is_constant (r_max)
-              ? r_min + (*this) (max (r_max - r_min + 1, 1))
+    return is_constant (r_min) && is_constant (r_max) && r_min <= r_max
+              ? r_min + operator ()(r_max - r_min + 1)
               : get_range (r_min, r_max);
   }
 
@@ -291,35 +395,69 @@
 
 typedef tausworthe_random_generator rand_gen;
 
-extern rand_gen rndm;
+extern rand_gen rndm, rmg_rndm;
+
+INTERFACE_CLASS (attachable)
+struct refcnt_base
+{
+  typedef int refcnt_t;
+  mutable refcnt_t ACC (RW, refcnt);
+
+  MTH void refcnt_inc () const { ++refcnt; }
+  MTH void refcnt_dec () const { --refcnt; }
+
+  refcnt_base () : refcnt (0) { }
+};
+
+// to avoid branches with more advanced compilers
+extern refcnt_base::refcnt_t refcnt_dummy;
 
 template<class T>
 struct refptr
 {
+  // p if not null
+  refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
+
+  void refcnt_dec ()
+  {
+    if (!is_constant (p))
+      --*refcnt_ref ();
+    else if (p)
+      --p->refcnt;
+  }
+
+  void refcnt_inc ()
+  {
+    if (!is_constant (p))
+      ++*refcnt_ref ();
+    else if (p)
+      ++p->refcnt;
+  }
+
   T *p;
 
   refptr () : p(0) { }
-  refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); }
-  refptr (T *p) : p(p) { if (p) p->refcnt_inc (); }
-  ~refptr () { if (p) p->refcnt_dec (); }
+  refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
+  refptr (T *p) : p(p) { refcnt_inc (); }
+  ~refptr () { refcnt_dec (); }
 
   const refptr<T> &operator =(T *o)
   {
-    if (p) p->refcnt_dec ();
+    // if decrementing ever destroys we need to reverse the order here
+    refcnt_dec ();
     p = o;
-    if (p) p->refcnt_inc ();
-
+    refcnt_inc ();
     return *this;
   }
 
-  const refptr<T> &operator =(const refptr<T> o)
+  const refptr<T> &operator =(const refptr<T> &o)
   {
     *this = o.p;
     return *this;
   }
 
   T &operator * () const { return *p; }
-  T *operator ->() const { return p; }
+  T *operator ->() const { return  p; }
 
   operator T *() const { return p; }
 };
@@ -364,6 +502,10 @@
   }
 };
 
+// Mostly the same as std::vector, but insert/erase can reorder
+// the elements, making append(=insert)/remove O(1) instead of O(n).
+//
+// NOTE: only some forms of erase are available
 template<class T>
 struct unordered_vector : std::vector<T, slice_allocator<T> >
 {
@@ -383,14 +525,46 @@
   }
 };
 
-template<class T, int T::* index>
+// This container blends advantages of linked lists
+// (efficiency) with vectors (random access) by
+// by using an unordered vector and storing the vector
+// index inside the object.
+//
+// + memory-efficient on most 64 bit archs
+// + O(1) insert/remove
+// + free unique (but varying) id for inserted objects
+// + cache-friendly iteration
+// - only works for pointers to structs
+//
+// NOTE: only some forms of erase/insert are available
+typedef int object_vector_index;
+
+template<class T, object_vector_index T::*indexmember>
 struct object_vector : std::vector<T *, slice_allocator<T *> >
 {
+  typedef typename object_vector::iterator iterator;
+
+  bool contains (const T *obj) const
+  {
+    return obj->*indexmember;
+  }
+
+  iterator find (const T *obj)
+  {
+    return obj->*indexmember
+      ? this->begin () + obj->*indexmember - 1
+      : this->end ();
+  }
+
+  void push_back (T *obj)
+  {
+    std::vector<T *, slice_allocator<T *> >::push_back (obj);
+    obj->*indexmember = this->size ();
+  }
+
   void insert (T *obj)
   {
-    assert (!(obj->*index));
     push_back (obj);
-    obj->*index = this->size ();
   }
 
   void insert (T &obj)
@@ -400,14 +574,13 @@
 
   void erase (T *obj)
   {
-    assert (obj->*index);
-    int pos = obj->*index;
-    obj->*index = 0;
+    unsigned int pos = obj->*indexmember;
+    obj->*indexmember = 0;
 
     if (pos < this->size ())
       {
         (*this)[pos - 1] = (*this)[this->size () - 1];
-        (*this)[pos - 1]->*index = pos;
+        (*this)[pos - 1]->*indexmember = pos;
       }
 
     this->pop_back ();
@@ -415,7 +588,7 @@
 
   void erase (T &obj)
   {
-    errase (&obj);
+    erase (&obj);
   }
 };
 
@@ -431,10 +604,58 @@
 
 typedef double tstamp;
 
-// return current time as timestampe
+// return current time as timestamp
 tstamp now ();
 
 int similar_direction (int a, int b);
 
+// like sprintf, but returns a "static" buffer
+const char *format (const char *format, ...);
+
+/////////////////////////////////////////////////////////////////////////////
+// threads, very very thin wrappers around pthreads
+
+struct thread
+{
+  pthread_t id;
+
+  void start (void *(*start_routine)(void *), void *arg = 0);
+
+  void cancel ()
+  {
+    pthread_cancel (id);
+  }
+
+  void *join ()
+  {
+    void *ret;
+
+    if (pthread_join (id, &ret))
+      cleanup ("pthread_join failed", 1);
+
+    return ret;
+  }
+};
+
+// note that mutexes are not classes
+typedef pthread_mutex_t smutex;
+
+#if __linux && defined (PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP)
+ #define SMUTEX_INITIALISER PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
+#else
+ #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER
+#endif
+
+#define SMUTEX(name) smutex name = SMUTEX_INITIALISER
+#define SMUTEX_LOCK(name)   pthread_mutex_lock   (&(name))
+#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name))
+
+typedef pthread_cond_t scond;
+
+#define SCOND(name) scond name = PTHREAD_COND_INITIALIZER
+#define SCOND_SIGNAL(name)     pthread_cond_signal    (&(name))
+#define SCOND_BROADCAST(name)  pthread_cond_broadcast (&(name))
+#define SCOND_WAIT(name,mutex) pthread_cond_wait      (&(name), &(mutex))
+
 #endif