--- deliantra/server/include/util.h 2007/04/23 18:09:57 1.43 +++ deliantra/server/include/util.h 2009/11/10 00:01:31 1.95 @@ -1,13 +1,35 @@ +/* + * 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 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 Affero GNU General Public License + * and the GNU General Public License along with this program. If not, see + * . + * + * The authors can be reached via e-mail to + */ + #ifndef UTIL_H__ #define UTIL_H__ -//#define PREFER_MALLOC +#include -#if __GNUC__ >= 3 -# define is_constant(c) __builtin_constant_p (c) -#else -# define is_constant(c) 0 -#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 + +#include #include #include @@ -19,15 +41,28 @@ #include #include -// use a gcc extension for auto declarations until ISO C++ sanctifies them -#define auto(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 +// 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) // 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 +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, @@ -45,8 +81,68 @@ template static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } template static inline T clamp (T v, U a, V b) { return v < (T)a ? (T)a : v >(T)b ? (T)b : v; } +template static inline void min_it (T &v, U m) { v = min (v, (T)m); } +template static inline void max_it (T &v, U m) { v = max (v, (T)m); } +template static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); } + template static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } +template static inline T min (T a, U b, V c) { return min (a, min (b, c)); } +template static inline T max (T a, U b, V c) { return max (a, max (b, c)); } + +// sign returns -1 or +1 +template +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 +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 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 static inline T div_ru (T val, T div) +{ + return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div; +} +// div, round-down +template 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 +static inline T +lerp (T val, T min_in, T max_in, T min_out, T max_out) +{ + return min_out + div ((val - min_in) * (max_out - min_out), max_in - min_in); +} + +// lerp, round-down +template +static inline T +lerp_rd (T val, T min_in, T max_in, T min_out, T max_out) +{ + return min_out + div_rd ((val - min_in) * (max_out - min_out), max_in - min_in); +} + +// lerp, round-up +template +static inline T +lerp_ru (T val, T min_in, T max_in, T min_out, T max_out) +{ + return min_out + div_ru ((val - min_in) * (max_out - min_out), max_in - min_in); +} + // lots of stuff taken from FXT /* Rotate right. This is used in various places for checksumming */ @@ -92,7 +188,7 @@ return b - d; } -// this is much faster than crossfires original algorithm +// this is much faster than crossfire's original algorithm // on modern cpus inline int isqrt (int n) @@ -100,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. @@ -132,6 +242,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 +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 +inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); } + +// clears the memory +template +inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); } + +// for symmetry +template +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 +inline void sfree0 (T *&ptr, int n = 1) throw () +{ + sfree (ptr, n); + ptr = 0; +} + // makes dynamically allocated objects zero-initialised struct zero_initialised { @@ -143,51 +292,53 @@ void *operator new (size_t s) { - return g_slice_alloc0 (s); + return salloc0 (s); } void *operator new[] (size_t s) { - return g_slice_alloc0 (s); + return salloc0 (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 -inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); } + void *operator new (size_t s) + { + return salloc (s); + } -// also copies src into the new area, like "memdup" -// if src is 0, clears the memory -template -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 (s); + } -// clears the memory -template -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 -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 +360,7 @@ }; slice_allocator () throw () { } - slice_allocator (const slice_allocator &o) throw () { } + slice_allocator (const slice_allocator &) throw () { } template slice_allocator (const slice_allocator &) throw () { } @@ -228,7 +379,7 @@ sfree (p, n); } - size_type max_size ()const throw () + size_type max_size () const throw () { return size_t (-1) / sizeof (Tp); } @@ -249,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) @@ -262,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; + + void operator =(const xorshift_random_generator &src) + { + x = src.x; + y = src.y; + } + + void seed (uint32_t seed) + { + x = seed; + y = seed * 69069U; + } - // uniform distribution + uint32_t next () + { + uint32_t t = x ^ (x << 10); + x = y; + y = y ^ (y >> 13) ^ t ^ (t >> 10); + return y; + } +}; + +template +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) @@ -289,37 +473,71 @@ int get_range (int r_min, int r_max); }; -typedef tausworthe_random_generator rand_gen; +typedef random_number_generator rand_gen; + +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) { } +}; -extern rand_gen rndm; +// to avoid branches with more advanced compilers +extern refcnt_base::refcnt_t refcnt_dummy; template 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 &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 &p) : p(p.p) { refcnt_inc (); } + refptr (T *p) : p(p) { refcnt_inc (); } + ~refptr () { refcnt_dec (); } const refptr &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 &operator =(const refptr o) + const refptr &operator =(const refptr &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; } }; @@ -330,29 +548,45 @@ typedef refptr client_ptr; typedef refptr player_ptr; +#define STRHSH_NULL 2166136261 + +static inline uint32_t +strhsh (const char *s) +{ + // 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 concurrently with the looping logic. + uint32_t hash = STRHSH_NULL; + + while (*s) + hash = (hash ^ *s++) * 16777619; + + return hash; +} + +static inline uint32_t +memhsh (const char *s, size_t len) +{ + uint32_t hash = STRHSH_NULL; + + while (len--) + hash = (hash ^ *s++) * 16777619; + + return hash; +} + 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 strhsh (s); + } - return hash; + std::size_t operator ()(const shstr &s) const + { + return strhsh (s); } }; @@ -364,6 +598,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 struct unordered_vector : std::vector > { @@ -383,14 +621,46 @@ } }; -template +// 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 struct object_vector : std::vector > { + 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 >::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 +670,13 @@ void erase (T *obj) { - assert (obj->*index); - unsigned 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,29 +684,79 @@ void erase (T &obj) { - errase (&obj); + erase (&obj); } }; // 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 -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 printf, but returns a std::string -const std::string 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