--- deliantra/server/include/util.h	2007/11/08 19:43:25	1.58
+++ deliantra/server/include/util.h	2009/11/07 18:30:05	1.93
@@ -1,20 +1,21 @@
 /*
  * This file is part of Deliantra, the Roguelike Realtime MMORPG.
  * 
- * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
+ * 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.
+ * Deliantra is free software: you can redistribute it and/or modify it under
+ * the terms of the Affero 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/>.
+ * You should have received a copy of the Affero GNU General Public License
+ * and 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>
  */
@@ -22,27 +23,13 @@
 #ifndef UTIL_H__
 #define UTIL_H__
 
-//#define PREFER_MALLOC
+#include <compiler.h>
 
-#if __GNUC__ >= 3
-# 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 expect(expr,value)         (expr)
-# define prefetch(addr,rw,locality)
-#endif
+#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__ < 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>
@@ -54,10 +41,23 @@
 #include <shstr.h>
 #include <traits.h>
 
+#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
+// very ugly macro that basically 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)
@@ -72,6 +72,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,
@@ -80,13 +81,66 @@
 template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; }
 template<typename T, typename U, typename V> static inline T clamp (T v, U a, V b) { return v < (T)a ? (T)a : v >(T)b ? (T)b : v; }
 
+template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); }
+template<typename T, typename U> static inline void max_it (T &v, U m) { v = max (v, (T)m); }
+template<typename T, typename U, typename V> static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); }
+
 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)); }
+
+// sign returns -1 or +1
+template<typename T>
+static inline T sign (T v) { return v < 0 ? -1 : +1; }
+// relies on 2c representation
+template<>
+inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); }
+
+// sign0 returns -1, 0 or +1
+template<typename T>
+static inline T sign0 (T v) { return v ? sign (v) : 0; }
+
+// div* only work correctly for div > 0
+// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
+template<typename T> static inline T div    (T val, T div)
+{
+  return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div;
+}
+// div, round-up
+template<typename T> static inline T div_ru (T val, T div)
+{
+  return expect_false (val < 0) ? - ((-val                ) / div) : (val + div - 1) / div;
+}
+// div, round-down
+template<typename T> static inline T div_rd (T val, T div)
+{
+  return expect_false (val < 0) ? - ((-val + (div - 1)    ) / div) : (val          ) / div;
+}
+
+// lerp* only work correctly for min_in < max_in
+// Linear intERPolate, scales val from min_in..max_in to min_out..max_out
 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;
+  return min_out + div   <T> ((val - min_in) * (max_out - min_out), max_in  - min_in);
+}
+
+// lerp, round-down
+template<typename T>
+static inline T
+lerp_rd (T val, T min_in, T max_in, T min_out, T max_out)
+{
+  return min_out + div_rd<T> ((val - min_in) * (max_out - min_out), max_in  - min_in);
+}
+
+// lerp, round-up
+template<typename T>
+static inline T
+lerp_ru (T val, T min_in, T max_in, T min_out, T max_out)
+{
+  return min_out + div_ru<T> ((val - min_in) * (max_out - min_out), max_in  - min_in);
 }
 
 // lots of stuff taken from FXT
@@ -142,6 +196,20 @@
   return (int)sqrtf ((float)n);
 }
 
+// this is kind of like the ^^ operator, if it would exist, without sequence point.
+// more handy than it looks like, due to the implicit !! done on its arguments
+inline bool
+logical_xor (bool a, bool b)
+{
+  return a != b;
+}
+
+inline bool
+logical_implies (bool a, bool b)
+{
+  return a <= b;
+}
+
 // this is only twice as fast as naive sqrtf (dx*dy+dy*dy)
 #if 0
 // and has a max. error of 6 in the range -100..+100.
@@ -174,7 +242,44 @@
   return ((d - 1) & 7) + 1;
 }
 
-extern size_t slice_alloc; // statistics
+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
@@ -187,56 +292,53 @@
 
   void *operator new (size_t s)
   {
-    slice_alloc += s;
-    return g_slice_alloc0 (s);
+    return salloc0<char> (s);
   }
 
   void *operator new[] (size_t s)
   {
-    slice_alloc += s;
-    return g_slice_alloc0 (s);
+    return salloc0<char> (s);
   }
 
   void operator delete (void *p, size_t s)
   {
-    slice_alloc -= s;
-    g_slice_free1 (s, p);
+    sfree ((char *)p, s);
   }
 
   void operator delete[] (void *p, size_t s)
   {
-    slice_alloc -= 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
-  slice_alloc -= n * sizeof (T);
-  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
@@ -258,7 +360,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 () { }
 
@@ -277,7 +379,7 @@
     sfree<Tp> (p, n);
   }
 
-  size_type max_size ()const throw ()
+  size_type max_size () const throw ()
   {
     return size_t (-1) / sizeof (Tp);
   }
@@ -298,7 +400,6 @@
 // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
 struct tausworthe_random_generator
 {
-  // generator
   uint32_t state [4];
 
   void operator =(const tausworthe_random_generator &src)
@@ -311,13 +412,47 @@
 
   void seed (uint32_t seed);
   uint32_t next ();
+};
+
+// Xorshift RNGs, George Marsaglia
+// http://www.jstatsoft.org/v08/i14/paper
+// this one is about 40% faster than the tausworthe one above (i.e. not much),
+// despite the inlining, and has the issue of only creating 2**32-1 numbers.
+// see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf
+struct xorshift_random_generator
+{
+  uint32_t x, y;
 
-  // uniform distribution
+  void operator =(const xorshift_random_generator &src)
+  {
+    x = src.x;
+    y = src.y;
+  }
+
+  void seed (uint32_t seed)
+  {
+    x = seed;
+    y = seed * 69069U;
+  }
+
+  uint32_t next ()
+  {
+    uint32_t t = x ^ (x << 10);
+    x = y;
+    y = y ^ (y >> 13) ^ t ^ (t >> 10);
+    return y;
+  }
+};
+
+template<class generator>
+struct random_number_generator : generator
+{
+  // uniform distribution, 0 .. max (0, num - 1)
   uint32_t operator ()(uint32_t num)
   {
-    return is_constant (num)
-             ? (next () * (uint64_t)num) >> 32U
-             : get_range (num);
+    return !is_constant (num) ? get_range (num)                        // non-constant
+         : num & (num - 1)    ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
+         :                      this->next () & (num - 1);             // constant, power-of-two
   }
 
   // return a number within (min .. max)
@@ -338,9 +473,9 @@
   int get_range (int r_min, int r_max);
 };
 
-typedef tausworthe_random_generator rand_gen;
+typedef random_number_generator<tausworthe_random_generator> rand_gen;
 
-extern rand_gen rndm;
+extern rand_gen rndm, rmg_rndm;
 
 INTERFACE_CLASS (attachable)
 struct refcnt_base
@@ -417,7 +552,8 @@
 {
   std::size_t operator ()(const char *s) const
   {
-    unsigned long hash = 0;
+#if 0
+    uint32_t hash = 0;
 
     /* use the one-at-a-time hash function, which supposedly is
      * better than the djb2-like one used by perl5.005, but
@@ -434,6 +570,17 @@
     hash += hash <<  3;
     hash ^= hash >> 11;
     hash += hash << 15;
+#else
+    // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
+    // it is about twice as fast as the one-at-a-time one,
+    // with good distribution.
+    // FNV-1a is faster on many cpus because the multiplication
+    // runs concurrent with the looping logic.
+    uint32_t hash = 2166136261;
+    
+    while (*s)
+      hash = (hash ^ *s++) * 16777619;
+#endif
 
     return hash;
   }
@@ -538,24 +685,74 @@
 };
 
 // basically does what strncpy should do, but appends "..." to strings exceeding length
-void assign (char *dst, const char *src, int maxlen);
+// returns the number of bytes actually used (including \0)
+int assign (char *dst, const char *src, int maxsize);
 
 // type-safe version of assign
 template<int N>
-inline void assign (char (&dst)[N], const char *src)
+inline int assign (char (&dst)[N], const char *src)
 {
-  assign ((char *)&dst, src, N);
+  return assign ((char *)&dst, src, N);
 }
 
 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, ...);
+// like v?sprintf, but returns a "static" buffer
+char *vformat (const char *format, va_list ap);
+char *format (const char *format, ...) attribute ((format (printf, 1, 2)));
+
+// safety-check player input which will become object->msg
+bool msg_is_safe (const char *msg);
+
+/////////////////////////////////////////////////////////////////////////////
+// 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