server/include/util.h

/*
 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
 * 
 * Copyright (©) 2005,2006,2007 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 DEBUG_SALLOC 0
#define PREFER_MALLOC 0

#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

#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>
#include <vector>

#include <glib.h>

#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
// 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 statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1)

// in range including end
#define IN_RANGE_INC(val,beg,end) \
  ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg))

// in range excluding end
#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,
// as a is often a constant while b is the variable. it is still a bug, though.
template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; }
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 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 */
//TODO: that sucks, use a better checksum algo
static inline uint32_t
rotate_right (uint32_t c, uint32_t count = 1)
{
  return (c << (32 - count)) | (c >> count);
}

static inline uint32_t
rotate_left (uint32_t c, uint32_t count = 1)
{
  return (c >> (32 - count)) | (c << count);
}

// Return abs(a-b)
// Both a and b must not have the most significant bit set
static inline uint32_t
upos_abs_diff (uint32_t a, uint32_t b)
{
  long d1 = b - a;
  long d2 = (d1 & (d1 >> 31)) << 1;

  return d1 - d2;               // == (b - d) - (a + d);
}

// Both a and b must not have the most significant bit set
static inline uint32_t
upos_min (uint32_t a, uint32_t b)
{
  int32_t d = b - a;
  d &= d >> 31;
  return a + d;
}

// Both a and b must not have the most significant bit set
static inline uint32_t
upos_max (uint32_t a, uint32_t b)
{
  int32_t d = b - a;
  d &= d >> 31;
  return b - d;
}

// this is much faster than crossfires original algorithm
// on modern cpus
inline int
isqrt (int n)
{
  return (int)sqrtf ((float)n);
}

// 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.
#else
// and has a max. error of 9 in the range -100..+100.
#endif
inline int 
idistance (int dx, int dy)
{ 
  unsigned int dx_ = abs (dx);
  unsigned int dy_ = abs (dy);

#if 0
  return dx_ > dy_
      ? (dx_ * 61685 + dy_ * 26870) >> 16
      : (dy_ * 61685 + dx_ * 26870) >> 16;
#else
  return dx_ + dy_ - min (dx_, dy_) * 5 / 8;
#endif
}

/*
 * absdir(int): Returns a number between 1 and 8, which represent
 * the "absolute" direction of a number (it actually takes care of
 * "overflow" in previous calculations of a direction).
 */
inline int
absdir (int d)
{
  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);
      g_slice_free1 (n * sizeof (T), (void *)ptr);
      assert (slice_alloc >= 0);//D
    }
}

// makes dynamically allocated objects zero-initialised
struct zero_initialised
{
  void *operator new (size_t s, void *p)
  {
    memset (p, 0, s);
    return p;
  }

  void *operator new (size_t s)
  {
    return salloc0<char> (s);
  }

  void *operator new[] (size_t s)
  {
    return salloc0<char> (s);
  }

  void operator delete (void *p, size_t s)
  {
    sfree ((char *)p, s);
  }

  void operator delete[] (void *p, size_t s)
  {
    sfree ((char *)p, s);
  }
};

// a STL-compatible allocator that uses g_slice
// boy, this is verbose
template<typename Tp>
struct slice_allocator
{
  typedef size_t size_type;
  typedef ptrdiff_t difference_type;
  typedef Tp *pointer;
  typedef const Tp *const_pointer;
  typedef Tp &reference;
  typedef const Tp &const_reference;
  typedef Tp value_type;

  template <class U> 
  struct rebind
  {
    typedef slice_allocator<U> other;
  };

  slice_allocator () throw () { }
  slice_allocator (const slice_allocator &) throw () { }
  template<typename Tp2>
  slice_allocator (const slice_allocator<Tp2> &) throw () { }

  ~slice_allocator () { }

  pointer address (reference x) const { return &x; }
  const_pointer address (const_reference x) const { return &x; }

  pointer allocate (size_type n, const_pointer = 0)
  {
    return salloc<Tp> (n);
  }

  void deallocate (pointer p, size_type n)
  {
    sfree<Tp> (p, n);
  }

  size_type max_size () const throw ()
  {
    return size_t (-1) / sizeof (Tp);
  }

  void construct (pointer p, const Tp &val)
  {
    ::new (p) Tp (val);
  }

  void destroy (pointer p)
  {
    p->~Tp ();
  }
};

// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213.
// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
// 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)
  {
    state [0] = src.state [0];
    state [1] = src.state [1];
    state [2] = src.state [2];
    state [3] = src.state [3];
  }

  void seed (uint32_t seed);
  uint32_t next ();

  // uniform distribution
  uint32_t operator ()(uint32_t num)
  {
    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 <= r_max
              ? r_min + operator ()(r_max - r_min + 1)
              : get_range (r_min, r_max);
  }

  double operator ()()
  {
    return this->next () / (double)0xFFFFFFFFU;
  }

protected:
  uint32_t get_range (uint32_t r_max);
  int get_range (int r_min, int r_max);
};

typedef tausworthe_random_generator rand_gen;

extern rand_gen 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) { refcnt_inc (); }
  refptr (T *p) : p(p) { refcnt_inc (); }
  ~refptr () { refcnt_dec (); }

  const refptr<T> &operator =(T *o)
  {
    // if decrementing ever destroys we need to reverse the order here
    refcnt_dec ();
    p = o;
    refcnt_inc ();
    return *this;
  }

  const refptr<T> &operator =(const refptr<T> &o)
  {
    *this = o.p;
    return *this;
  }

  T &operator * () const { return *p; }
  T *operator ->() const { return  p; }

  operator T *() const { return p; }
};

typedef refptr<maptile>   maptile_ptr;
typedef refptr<object>    object_ptr;
typedef refptr<archetype> arch_ptr;
typedef refptr<client>    client_ptr;
typedef refptr<player>    player_ptr;

struct str_hash
{
  std::size_t operator ()(const char *s) const
  {
    unsigned long hash = 0;

    /* use the one-at-a-time hash function, which supposedly is
     * better than the djb2-like one used by perl5.005, but
     * certainly is better then the bug used here before.
     * see http://burtleburtle.net/bob/hash/doobs.html
     */
    while (*s)
      {
        hash += *s++;
        hash += hash << 10;
        hash ^= hash >>  6;
      }

    hash += hash <<  3;
    hash ^= hash >> 11;
    hash += hash << 15;

    return hash;
  }
};

struct str_equal
{
  bool operator ()(const char *a, const char *b) const
  {
    return !strcmp (a, b);
  }
};

// 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> >
{
  typedef typename unordered_vector::iterator iterator;

  void erase (unsigned int pos)
  {
    if (pos < this->size () - 1)
      (*this)[pos] = (*this)[this->size () - 1];

    this->pop_back ();
  }

  void erase (iterator i)
  {
    erase ((unsigned int )(i - this->begin ()));
  }
};

// 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)
  {
    push_back (obj);
  }

  void insert (T &obj)
  {
    insert (&obj);
  }

  void erase (T *obj)
  {
    unsigned int pos = obj->*indexmember;
    obj->*indexmember = 0;

    if (pos < this->size ())
      {
        (*this)[pos - 1] = (*this)[this->size () - 1];
        (*this)[pos - 1]->*indexmember = pos;
      }

    this->pop_back ();
  }

  void erase (T &obj)
  {
    erase (&obj);
  }
};

// basically does what strncpy should do, but appends "..." to strings exceeding length
void assign (char *dst, const char *src, int maxlen);

// type-safe version of assign
template<int N>
inline void assign (char (&dst)[N], const char *src)
{
  assign ((char *)&dst, src, N);
}

typedef double tstamp;

// 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

Revision:	1.69
Committed:	Fri Apr 18 23:43:59 2008 UTC (16 years, 1 month ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.68:	+1 -1 lines
Log Message:	* empty log message *
#	Content
1	/*
2	* This file is part of Deliantra, the Roguelike Realtime MMORPG.
3	*
4	* Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5	*
6	* Deliantra is free software: you can redistribute it and/or modify
7	* it under the terms of the GNU General Public License as published by
8	* the Free Software Foundation, either version 3 of the License, or
9	* (at your option) any later version.
10	*
11	* This program is distributed in the hope that it will be useful,
12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	* GNU General Public License for more details.
15	*
16	* You should have received a copy of the GNU General Public License
17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
18	*
19	* The authors can be reached via e-mail to <support@deliantra.net>
20	*/
21
22	#ifndef UTIL_H__
23	#define UTIL_H__
24
25	#define DEBUG_SALLOC 0
26	#define PREFER_MALLOC 0
27
28	#if __GNUC__ >= 3
29	# define is_constant(c) __builtin_constant_p (c)
30	# define expect(expr,value) __builtin_expect ((expr),(value))
31	# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
32	#else
33	# define is_constant(c) 0
34	# define expect(expr,value) (expr)
35	# define prefetch(addr,rw,locality)
36	#endif
37
38	#if __GNUC__ < 4 \|\| (__GNUC__ == 4 \|\| __GNUC_MINOR__ < 4)
39	# define decltype(x) typeof(x)
40	#endif
41
42	// put into ifs if you are very sure that the expression
43	// is mostly true or mosty false. note that these return
44	// booleans, not the expression.
45	#define expect_false(expr) expect ((expr) != 0, 0)
46	#define expect_true(expr) expect ((expr) != 0, 1)
47
48	#include <pthread.h>
49
50	#include <cstddef>
51	#include <cmath>
52	#include <new>
53	#include <vector>
54
55	#include <glib.h>
56
57	#include <shstr.h>
58	#include <traits.h>
59
60	#if DEBUG_SALLOC
61	# define g_slice_alloc0(s) debug_slice_alloc0(s)
62	# define g_slice_alloc(s) debug_slice_alloc(s)
63	# define g_slice_free1(s,p) debug_slice_free1(s,p)
64	void *g_slice_alloc (unsigned long size);
65	void *g_slice_alloc0 (unsigned long size);
66	void g_slice_free1 (unsigned long size, void *ptr);
67	#elif PREFER_MALLOC
68	# define g_slice_alloc0(s) calloc (1, (s))
69	# define g_slice_alloc(s) malloc ((s))
70	# define g_slice_free1(s,p) free ((p))
71	#endif
72
73	// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever)
74	#define auto(var,expr) decltype(expr) var = (expr)
75
76	// very ugly macro that basicaly declares and initialises a variable
77	// that is in scope for the next statement only
78	// works only for stuff that can be assigned 0 and converts to false
79	// (note: works great for pointers)
80	// most ugly macro I ever wrote
81	#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1)
82
83	// in range including end
84	#define IN_RANGE_INC(val,beg,end) \
85	((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg))
86
87	// in range excluding end
88	#define IN_RANGE_EXC(val,beg,end) \
89	((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg))
90
91	void cleanup (const char *cause, bool make_core = false);
92	void fork_abort (const char *msg);
93
94	// rationale for using (U) not (T) is to reduce signed/unsigned issues,
95	// as a is often a constant while b is the variable. it is still a bug, though.
96	template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; }
97	template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; }
98	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; }
99
100	template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
101
102	template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); }
103	template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
104
105	template<typename T>
106	static inline T
107	lerp (T val, T min_in, T max_in, T min_out, T max_out)
108	{
109	return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out;
110	}
111
112	// lots of stuff taken from FXT
113
114	/* Rotate right. This is used in various places for checksumming */
115	//TODO: that sucks, use a better checksum algo
116	static inline uint32_t
117	rotate_right (uint32_t c, uint32_t count = 1)
118	{
119	return (c << (32 - count)) \| (c >> count);
120	}
121
122	static inline uint32_t
123	rotate_left (uint32_t c, uint32_t count = 1)
124	{
125	return (c >> (32 - count)) \| (c << count);
126	}
127
128	// Return abs(a-b)
129	// Both a and b must not have the most significant bit set
130	static inline uint32_t
131	upos_abs_diff (uint32_t a, uint32_t b)
132	{
133	long d1 = b - a;
134	long d2 = (d1 & (d1 >> 31)) << 1;
135
136	return d1 - d2; // == (b - d) - (a + d);
137	}
138
139	// Both a and b must not have the most significant bit set
140	static inline uint32_t
141	upos_min (uint32_t a, uint32_t b)
142	{
143	int32_t d = b - a;
144	d &= d >> 31;
145	return a + d;
146	}
147
148	// Both a and b must not have the most significant bit set
149	static inline uint32_t
150	upos_max (uint32_t a, uint32_t b)
151	{
152	int32_t d = b - a;
153	d &= d >> 31;
154	return b - d;
155	}
156
157	// this is much faster than crossfires original algorithm
158	// on modern cpus
159	inline int
160	isqrt (int n)
161	{
162	return (int)sqrtf ((float)n);
163	}
164
165	// this is only twice as fast as naive sqrtf (dxdy+dydy)
166	#if 0
167	// and has a max. error of 6 in the range -100..+100.
168	#else
169	// and has a max. error of 9 in the range -100..+100.
170	#endif
171	inline int
172	idistance (int dx, int dy)
173	{
174	unsigned int dx_ = abs (dx);
175	unsigned int dy_ = abs (dy);
176
177	#if 0
178	return dx_ > dy_
179	? (dx_ * 61685 + dy_ * 26870) >> 16
180	: (dy_ * 61685 + dx_ * 26870) >> 16;
181	#else
182	return dx_ + dy_ - min (dx_, dy_) * 5 / 8;
183	#endif
184	}
185
186	/*
187	* absdir(int): Returns a number between 1 and 8, which represent
188	* the "absolute" direction of a number (it actually takes care of
189	* "overflow" in previous calculations of a direction).
190	*/
191	inline int
192	absdir (int d)
193	{
194	return ((d - 1) & 7) + 1;
195	}
196
197	extern ssize_t slice_alloc; // statistics
198
199	void *salloc_ (int n) throw (std::bad_alloc);
200	void salloc_ (int n, void src) throw (std::bad_alloc);
201
202	// strictly the same as g_slice_alloc, but never returns 0
203	template<typename T>
204	inline T salloc (int n = 1) throw (std::bad_alloc) { return (T )salloc_ (n * sizeof (T)); }
205
206	// also copies src into the new area, like "memdup"
207	// if src is 0, clears the memory
208	template<typename T>
209	inline T salloc (int n, T src) throw (std::bad_alloc) { return (T )salloc_ (n sizeof (T), (void *)src); }
210
211	// clears the memory
212	template<typename T>
213	inline T salloc0(int n = 1) throw (std::bad_alloc) { return (T )salloc_ (n * sizeof (T), 0); }
214
215	// for symmetry
216	template<typename T>
217	inline void sfree (T *ptr, int n = 1) throw ()
218	{
219	if (expect_true (ptr))
220	{
221	slice_alloc -= n * sizeof (T);
222	g_slice_free1 (n * sizeof (T), (void *)ptr);
223	assert (slice_alloc >= 0);//D
224	}
225	}
226
227	// makes dynamically allocated objects zero-initialised
228	struct zero_initialised
229	{
230	void operator new (size_t s, void p)
231	{
232	memset (p, 0, s);
233	return p;
234	}
235
236	void *operator new (size_t s)
237	{
238	return salloc0<char> (s);
239	}
240
241	void *operator new[] (size_t s)
242	{
243	return salloc0<char> (s);
244	}
245
246	void operator delete (void *p, size_t s)
247	{
248	sfree ((char *)p, s);
249	}
250
251	void operator delete[] (void *p, size_t s)
252	{
253	sfree ((char *)p, s);
254	}
255	};
256
257	// a STL-compatible allocator that uses g_slice
258	// boy, this is verbose
259	template<typename Tp>
260	struct slice_allocator
261	{
262	typedef size_t size_type;
263	typedef ptrdiff_t difference_type;
264	typedef Tp *pointer;
265	typedef const Tp *const_pointer;
266	typedef Tp &reference;
267	typedef const Tp &const_reference;
268	typedef Tp value_type;
269
270	template <class U>
271	struct rebind
272	{
273	typedef slice_allocator<U> other;
274	};
275
276	slice_allocator () throw () { }
277	slice_allocator (const slice_allocator &) throw () { }
278	template<typename Tp2>
279	slice_allocator (const slice_allocator<Tp2> &) throw () { }
280
281	~slice_allocator () { }
282
283	pointer address (reference x) const { return &x; }
284	const_pointer address (const_reference x) const { return &x; }
285
286	pointer allocate (size_type n, const_pointer = 0)
287	{
288	return salloc<Tp> (n);
289	}
290
291	void deallocate (pointer p, size_type n)
292	{
293	sfree<Tp> (p, n);
294	}
295
296	size_type max_size () const throw ()
297	{
298	return size_t (-1) / sizeof (Tp);
299	}
300
301	void construct (pointer p, const Tp &val)
302	{
303	::new (p) Tp (val);
304	}
305
306	void destroy (pointer p)
307	{
308	p->~Tp ();
309	}
310	};
311
312	// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213.
313	// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
314	// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
315	struct tausworthe_random_generator
316	{
317	// generator
318	uint32_t state [4];
319
320	void operator =(const tausworthe_random_generator &src)
321	{
322	state [0] = src.state [0];
323	state [1] = src.state [1];
324	state [2] = src.state [2];
325	state [3] = src.state [3];
326	}
327
328	void seed (uint32_t seed);
329	uint32_t next ();
330
331	// uniform distribution
332	uint32_t operator ()(uint32_t num)
333	{
334	return is_constant (num)
335	? (next () * (uint64_t)num) >> 32U
336	: get_range (num);
337	}
338
339	// return a number within (min .. max)
340	int operator () (int r_min, int r_max)
341	{
342	return is_constant (r_min) && is_constant (r_max) && r_min <= r_max
343	? r_min + operator ()(r_max - r_min + 1)
344	: get_range (r_min, r_max);
345	}
346
347	double operator ()()
348	{
349	return this->next () / (double)0xFFFFFFFFU;
350	}
351
352	protected:
353	uint32_t get_range (uint32_t r_max);
354	int get_range (int r_min, int r_max);
355	};
356
357	typedef tausworthe_random_generator rand_gen;
358
359	extern rand_gen rndm;
360
361	INTERFACE_CLASS (attachable)
362	struct refcnt_base
363	{
364	typedef int refcnt_t;
365	mutable refcnt_t ACC (RW, refcnt);
366
367	MTH void refcnt_inc () const { ++refcnt; }
368	MTH void refcnt_dec () const { --refcnt; }
369
370	refcnt_base () : refcnt (0) { }
371	};
372
373	// to avoid branches with more advanced compilers
374	extern refcnt_base::refcnt_t refcnt_dummy;
375
376	template<class T>
377	struct refptr
378	{
379	// p if not null
380	refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
381
382	void refcnt_dec ()
383	{
384	if (!is_constant (p))
385	--*refcnt_ref ();
386	else if (p)
387	--p->refcnt;
388	}
389
390	void refcnt_inc ()
391	{
392	if (!is_constant (p))
393	++*refcnt_ref ();
394	else if (p)
395	++p->refcnt;
396	}
397
398	T *p;
399
400	refptr () : p(0) { }
401	refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
402	refptr (T *p) : p(p) { refcnt_inc (); }
403	~refptr () { refcnt_dec (); }
404
405	const refptr<T> &operator =(T *o)
406	{
407	// if decrementing ever destroys we need to reverse the order here
408	refcnt_dec ();
409	p = o;
410	refcnt_inc ();
411	return *this;
412	}
413
414	const refptr<T> &operator =(const refptr<T> &o)
415	{
416	*this = o.p;
417	return *this;
418	}
419
420	T &operator * () const { return *p; }
421	T *operator ->() const { return p; }
422
423	operator T *() const { return p; }
424	};
425
426	typedef refptr<maptile> maptile_ptr;
427	typedef refptr<object> object_ptr;
428	typedef refptr<archetype> arch_ptr;
429	typedef refptr<client> client_ptr;
430	typedef refptr<player> player_ptr;
431
432	struct str_hash
433	{
434	std::size_t operator ()(const char *s) const
435	{
436	unsigned long hash = 0;
437
438	/* use the one-at-a-time hash function, which supposedly is
439	* better than the djb2-like one used by perl5.005, but
440	* certainly is better then the bug used here before.
441	* see http://burtleburtle.net/bob/hash/doobs.html
442	*/
443	while (*s)
444	{
445	hash += *s++;
446	hash += hash << 10;
447	hash ^= hash >> 6;
448	}
449
450	hash += hash << 3;
451	hash ^= hash >> 11;
452	hash += hash << 15;
453
454	return hash;
455	}
456	};
457
458	struct str_equal
459	{
460	bool operator ()(const char a, const char b) const
461	{
462	return !strcmp (a, b);
463	}
464	};
465
466	// Mostly the same as std::vector, but insert/erase can reorder
467	// the elements, making append(=insert)/remove O(1) instead of O(n).
468	//
469	// NOTE: only some forms of erase are available
470	template<class T>
471	struct unordered_vector : std::vector<T, slice_allocator<T> >
472	{
473	typedef typename unordered_vector::iterator iterator;
474
475	void erase (unsigned int pos)
476	{
477	if (pos < this->size () - 1)
478	(this)[pos] = (this)[this->size () - 1];
479
480	this->pop_back ();
481	}
482
483	void erase (iterator i)
484	{
485	erase ((unsigned int )(i - this->begin ()));
486	}
487	};
488
489	// This container blends advantages of linked lists
490	// (efficiency) with vectors (random access) by
491	// by using an unordered vector and storing the vector
492	// index inside the object.
493	//
494	// + memory-efficient on most 64 bit archs
495	// + O(1) insert/remove
496	// + free unique (but varying) id for inserted objects
497	// + cache-friendly iteration
498	// - only works for pointers to structs
499	//
500	// NOTE: only some forms of erase/insert are available
501	typedef int object_vector_index;
502
503	template<class T, object_vector_index T::*indexmember>
504	struct object_vector : std::vector<T , slice_allocator<T > >
505	{
506	typedef typename object_vector::iterator iterator;
507
508	bool contains (const T *obj) const
509	{
510	return obj->*indexmember;
511	}
512
513	iterator find (const T *obj)
514	{
515	return obj->*indexmember
516	? this->begin () + obj->*indexmember - 1
517	: this->end ();
518	}
519
520	void push_back (T *obj)
521	{
522	std::vector<T , slice_allocator<T > >::push_back (obj);
523	obj->*indexmember = this->size ();
524	}
525
526	void insert (T *obj)
527	{
528	push_back (obj);
529	}
530
531	void insert (T &obj)
532	{
533	insert (&obj);
534	}
535
536	void erase (T *obj)
537	{
538	unsigned int pos = obj->*indexmember;
539	obj->*indexmember = 0;
540
541	if (pos < this->size ())
542	{
543	(this)[pos - 1] = (this)[this->size () - 1];
544	(this)[pos - 1]->indexmember = pos;
545	}
546
547	this->pop_back ();
548	}
549
550	void erase (T &obj)
551	{
552	erase (&obj);
553	}
554	};
555
556	// basically does what strncpy should do, but appends "..." to strings exceeding length
557	void assign (char dst, const char src, int maxlen);
558
559	// type-safe version of assign
560	template<int N>
561	inline void assign (char (&dst)[N], const char *src)
562	{
563	assign ((char *)&dst, src, N);
564	}
565
566	typedef double tstamp;
567
568	// return current time as timestamp
569	tstamp now ();
570
571	int similar_direction (int a, int b);
572
573	// like sprintf, but returns a "static" buffer
574	const char format (const char format, ...);
575
576	/////////////////////////////////////////////////////////////////////////////
577	// threads, very very thin wrappers around pthreads
578
579	struct thread
580	{
581	pthread_t id;
582
583	void start (void (start_routine)(void ), void arg = 0);
584
585	void cancel ()
586	{
587	pthread_cancel (id);
588	}
589
590	void *join ()
591	{
592	void *ret;
593
594	if (pthread_join (id, &ret))
595	cleanup ("pthread_join failed", 1);
596
597	return ret;
598	}
599	};
600
601	// note that mutexes are not classes
602	typedef pthread_mutex_t smutex;
603
604	#if __linux && defined (PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP)
605	#define SMUTEX_INITIALISER PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
606	#else
607	#define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER
608	#endif
609
610	#define SMUTEX(name) smutex name = SMUTEX_INITIALISER
611	#define SMUTEX_LOCK(name) pthread_mutex_lock (&(name))
612	#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name))
613
614	typedef pthread_cond_t scond;
615
616	#define SCOND(name) scond name = PTHREAD_COND_INITIALIZER
617	#define SCOND_SIGNAL(name) pthread_cond_signal (&(name))
618	#define SCOND_BROADCAST(name) pthread_cond_broadcast (&(name))
619	#define SCOND_WAIT(name,mutex) pthread_cond_wait (&(name), &(mutex))
620
621	#endif
622