ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/util.h
(Generate patch)

Comparing deliantra/server/include/util.h (file contents):
Revision 1.66 by root, Wed Apr 2 11:13:55 2008 UTC vs.
Revision 1.95 by root, Tue Nov 10 00:01:31 2009 UTC

1/* 1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * 5 *
6 * Deliantra is free software: you can redistribute it and/or modify 6 * Deliantra is free software: you can redistribute it and/or modify it under
7 * it under the terms of the GNU General Public License as published by 7 * the terms of the Affero GNU General Public License as published by the
8 * the Free Software Foundation, either version 3 of the License, or 8 * Free Software Foundation, either version 3 of the License, or (at your
9 * (at your option) any later version. 9 * option) any later version.
10 * 10 *
11 * This program is distributed in the hope that it will be useful, 11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details. 14 * GNU General Public License for more details.
15 * 15 *
16 * You should have received a copy of the GNU General Public License 16 * You should have received a copy of the Affero GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>. 17 * and the GNU General Public License along with this program. If not, see
18 * <http://www.gnu.org/licenses/>.
18 * 19 *
19 * The authors can be reached via e-mail to <support@deliantra.net> 20 * The authors can be reached via e-mail to <support@deliantra.net>
20 */ 21 */
21 22
22#ifndef UTIL_H__ 23#ifndef UTIL_H__
23#define UTIL_H__ 24#define UTIL_H__
24 25
25#define DEBUG_SALLOC 0 26#include <compiler.h>
26#define PREFER_MALLOC 0
27 27
28#if __GNUC__ >= 3 28#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0
29# define is_constant(c) __builtin_constant_p (c) 29#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs
30# define expect(expr,value) __builtin_expect ((expr),(value)) 30#define PREFER_MALLOC 0 // use malloc and not the slice allocator
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 31
48#include <pthread.h> 32#include <pthread.h>
49 33
50#include <cstddef> 34#include <cstddef>
51#include <cmath> 35#include <cmath>
62# define g_slice_alloc(s) debug_slice_alloc(s) 46# define g_slice_alloc(s) debug_slice_alloc(s)
63# define g_slice_free1(s,p) debug_slice_free1(s,p) 47# define g_slice_free1(s,p) debug_slice_free1(s,p)
64void *g_slice_alloc (unsigned long size); 48void *g_slice_alloc (unsigned long size);
65void *g_slice_alloc0 (unsigned long size); 49void *g_slice_alloc0 (unsigned long size);
66void g_slice_free1 (unsigned long size, void *ptr); 50void g_slice_free1 (unsigned long size, void *ptr);
51#elif PREFER_MALLOC
52# define g_slice_alloc0(s) calloc (1, (s))
53# define g_slice_alloc(s) malloc ((s))
54# define g_slice_free1(s,p) free ((p))
67#endif 55#endif
68 56
69// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever) 57// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever)
70#define auto(var,expr) decltype(expr) var = (expr) 58#define auto(var,expr) decltype(expr) var = (expr)
71 59
72// very ugly macro that basicaly declares and initialises a variable 60// very ugly macro that basically declares and initialises a variable
73// that is in scope for the next statement only 61// that is in scope for the next statement only
74// works only for stuff that can be assigned 0 and converts to false 62// works only for stuff that can be assigned 0 and converts to false
75// (note: works great for pointers) 63// (note: works great for pointers)
76// most ugly macro I ever wrote 64// most ugly macro I ever wrote
77#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) 65#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1)
91// as a is often a constant while b is the variable. it is still a bug, though. 79// as a is often a constant while b is the variable. it is still a bug, though.
92template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } 80template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; }
93template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } 81template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; }
94template<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; } 82template<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; }
95 83
84template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); }
85template<typename T, typename U> static inline void max_it (T &v, U m) { v = max (v, (T)m); }
86template<typename T, typename U, typename V> static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); }
87
96template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } 88template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
97 89
98template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); } 90template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); }
99template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); } 91template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
100 92
93// sign returns -1 or +1
94template<typename T>
95static inline T sign (T v) { return v < 0 ? -1 : +1; }
96// relies on 2c representation
97template<>
98inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); }
99
100// sign0 returns -1, 0 or +1
101template<typename T>
102static inline T sign0 (T v) { return v ? sign (v) : 0; }
103
104// div* only work correctly for div > 0
105// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
106template<typename T> static inline T div (T val, T div)
107{
108 return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div;
109}
110// div, round-up
111template<typename T> static inline T div_ru (T val, T div)
112{
113 return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div;
114}
115// div, round-down
116template<typename T> static inline T div_rd (T val, T div)
117{
118 return expect_false (val < 0) ? - ((-val + (div - 1) ) / div) : (val ) / div;
119}
120
121// lerp* only work correctly for min_in < max_in
122// Linear intERPolate, scales val from min_in..max_in to min_out..max_out
101template<typename T> 123template<typename T>
102static inline T 124static inline T
103lerp (T val, T min_in, T max_in, T min_out, T max_out) 125lerp (T val, T min_in, T max_in, T min_out, T max_out)
104{ 126{
105 return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; 127 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in);
128}
129
130// lerp, round-down
131template<typename T>
132static inline T
133lerp_rd (T val, T min_in, T max_in, T min_out, T max_out)
134{
135 return min_out + div_rd<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
136}
137
138// lerp, round-up
139template<typename T>
140static inline T
141lerp_ru (T val, T min_in, T max_in, T min_out, T max_out)
142{
143 return min_out + div_ru<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
106} 144}
107 145
108// lots of stuff taken from FXT 146// lots of stuff taken from FXT
109 147
110/* Rotate right. This is used in various places for checksumming */ 148/* Rotate right. This is used in various places for checksumming */
148 int32_t d = b - a; 186 int32_t d = b - a;
149 d &= d >> 31; 187 d &= d >> 31;
150 return b - d; 188 return b - d;
151} 189}
152 190
153// this is much faster than crossfires original algorithm 191// this is much faster than crossfire's original algorithm
154// on modern cpus 192// on modern cpus
155inline int 193inline int
156isqrt (int n) 194isqrt (int n)
157{ 195{
158 return (int)sqrtf ((float)n); 196 return (int)sqrtf ((float)n);
197}
198
199// this is kind of like the ^^ operator, if it would exist, without sequence point.
200// more handy than it looks like, due to the implicit !! done on its arguments
201inline bool
202logical_xor (bool a, bool b)
203{
204 return a != b;
205}
206
207inline bool
208logical_implies (bool a, bool b)
209{
210 return a <= b;
159} 211}
160 212
161// this is only twice as fast as naive sqrtf (dx*dy+dy*dy) 213// this is only twice as fast as naive sqrtf (dx*dy+dy*dy)
162#if 0 214#if 0
163// and has a max. error of 6 in the range -100..+100. 215// and has a max. error of 6 in the range -100..+100.
188absdir (int d) 240absdir (int d)
189{ 241{
190 return ((d - 1) & 7) + 1; 242 return ((d - 1) & 7) + 1;
191} 243}
192 244
193extern size_t slice_alloc; // statistics 245extern ssize_t slice_alloc; // statistics
246
247void *salloc_ (int n) throw (std::bad_alloc);
248void *salloc_ (int n, void *src) throw (std::bad_alloc);
249
250// strictly the same as g_slice_alloc, but never returns 0
251template<typename T>
252inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); }
253
254// also copies src into the new area, like "memdup"
255// if src is 0, clears the memory
256template<typename T>
257inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
258
259// clears the memory
260template<typename T>
261inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); }
262
263// for symmetry
264template<typename T>
265inline void sfree (T *ptr, int n = 1) throw ()
266{
267 if (expect_true (ptr))
268 {
269 slice_alloc -= n * sizeof (T);
270 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
271 g_slice_free1 (n * sizeof (T), (void *)ptr);
272 assert (slice_alloc >= 0);//D
273 }
274}
275
276// nulls the pointer
277template<typename T>
278inline void sfree0 (T *&ptr, int n = 1) throw ()
279{
280 sfree<T> (ptr, n);
281 ptr = 0;
282}
194 283
195// makes dynamically allocated objects zero-initialised 284// makes dynamically allocated objects zero-initialised
196struct zero_initialised 285struct zero_initialised
197{ 286{
198 void *operator new (size_t s, void *p) 287 void *operator new (size_t s, void *p)
201 return p; 290 return p;
202 } 291 }
203 292
204 void *operator new (size_t s) 293 void *operator new (size_t s)
205 { 294 {
206 slice_alloc += s;
207 return g_slice_alloc0 (s); 295 return salloc0<char> (s);
208 } 296 }
209 297
210 void *operator new[] (size_t s) 298 void *operator new[] (size_t s)
211 { 299 {
212 slice_alloc += s;
213 return g_slice_alloc0 (s); 300 return salloc0<char> (s);
214 } 301 }
215 302
216 void operator delete (void *p, size_t s) 303 void operator delete (void *p, size_t s)
217 { 304 {
218 slice_alloc -= s; 305 sfree ((char *)p, s);
219 g_slice_free1 (s, p);
220 } 306 }
221 307
222 void operator delete[] (void *p, size_t s) 308 void operator delete[] (void *p, size_t s)
223 { 309 {
224 slice_alloc -= s; 310 sfree ((char *)p, s);
225 g_slice_free1 (s, p);
226 } 311 }
227}; 312};
228 313
229void *salloc_ (int n) throw (std::bad_alloc); 314// makes dynamically allocated objects zero-initialised
230void *salloc_ (int n, void *src) throw (std::bad_alloc); 315struct slice_allocated
231
232// strictly the same as g_slice_alloc, but never returns 0
233template<typename T>
234inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); }
235
236// also copies src into the new area, like "memdup"
237// if src is 0, clears the memory
238template<typename T>
239inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
240
241// clears the memory
242template<typename T>
243inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); }
244
245// for symmetry
246template<typename T>
247inline void sfree (T *ptr, int n = 1) throw ()
248{ 316{
249#if PREFER_MALLOC 317 void *operator new (size_t s, void *p)
250 free (ptr); 318 {
251#else 319 return p;
252 slice_alloc -= n * sizeof (T); 320 }
253 g_slice_free1 (n * sizeof (T), (void *)ptr); 321
254#endif 322 void *operator new (size_t s)
255} 323 {
324 return salloc<char> (s);
325 }
326
327 void *operator new[] (size_t s)
328 {
329 return salloc<char> (s);
330 }
331
332 void operator delete (void *p, size_t s)
333 {
334 sfree ((char *)p, s);
335 }
336
337 void operator delete[] (void *p, size_t s)
338 {
339 sfree ((char *)p, s);
340 }
341};
256 342
257// a STL-compatible allocator that uses g_slice 343// a STL-compatible allocator that uses g_slice
258// boy, this is verbose 344// boy, this is verbose
259template<typename Tp> 345template<typename Tp>
260struct slice_allocator 346struct slice_allocator
312// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. 398// 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 399// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
314// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps 400// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
315struct tausworthe_random_generator 401struct tausworthe_random_generator
316{ 402{
317 // generator
318 uint32_t state [4]; 403 uint32_t state [4];
319 404
320 void operator =(const tausworthe_random_generator &src) 405 void operator =(const tausworthe_random_generator &src)
321 { 406 {
322 state [0] = src.state [0]; 407 state [0] = src.state [0];
325 state [3] = src.state [3]; 410 state [3] = src.state [3];
326 } 411 }
327 412
328 void seed (uint32_t seed); 413 void seed (uint32_t seed);
329 uint32_t next (); 414 uint32_t next ();
415};
330 416
331 // uniform distribution 417// Xorshift RNGs, George Marsaglia
418// http://www.jstatsoft.org/v08/i14/paper
419// this one is about 40% faster than the tausworthe one above (i.e. not much),
420// despite the inlining, and has the issue of only creating 2**32-1 numbers.
421// see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf
422struct xorshift_random_generator
423{
424 uint32_t x, y;
425
426 void operator =(const xorshift_random_generator &src)
427 {
428 x = src.x;
429 y = src.y;
430 }
431
432 void seed (uint32_t seed)
433 {
434 x = seed;
435 y = seed * 69069U;
436 }
437
438 uint32_t next ()
439 {
440 uint32_t t = x ^ (x << 10);
441 x = y;
442 y = y ^ (y >> 13) ^ t ^ (t >> 10);
443 return y;
444 }
445};
446
447template<class generator>
448struct random_number_generator : generator
449{
450 // uniform distribution, 0 .. max (0, num - 1)
332 uint32_t operator ()(uint32_t num) 451 uint32_t operator ()(uint32_t num)
333 { 452 {
334 return is_constant (num) 453 return !is_constant (num) ? get_range (num) // non-constant
335 ? (next () * (uint64_t)num) >> 32U 454 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
336 : get_range (num); 455 : this->next () & (num - 1); // constant, power-of-two
337 } 456 }
338 457
339 // return a number within (min .. max) 458 // return a number within (min .. max)
340 int operator () (int r_min, int r_max) 459 int operator () (int r_min, int r_max)
341 { 460 {
352protected: 471protected:
353 uint32_t get_range (uint32_t r_max); 472 uint32_t get_range (uint32_t r_max);
354 int get_range (int r_min, int r_max); 473 int get_range (int r_min, int r_max);
355}; 474};
356 475
357typedef tausworthe_random_generator rand_gen; 476typedef random_number_generator<tausworthe_random_generator> rand_gen;
358 477
359extern rand_gen rndm; 478extern rand_gen rndm, rmg_rndm;
360 479
361INTERFACE_CLASS (attachable) 480INTERFACE_CLASS (attachable)
362struct refcnt_base 481struct refcnt_base
363{ 482{
364 typedef int refcnt_t; 483 typedef int refcnt_t;
427typedef refptr<object> object_ptr; 546typedef refptr<object> object_ptr;
428typedef refptr<archetype> arch_ptr; 547typedef refptr<archetype> arch_ptr;
429typedef refptr<client> client_ptr; 548typedef refptr<client> client_ptr;
430typedef refptr<player> player_ptr; 549typedef refptr<player> player_ptr;
431 550
551#define STRHSH_NULL 2166136261
552
553static inline uint32_t
554strhsh (const char *s)
555{
556 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
557 // it is about twice as fast as the one-at-a-time one,
558 // with good distribution.
559 // FNV-1a is faster on many cpus because the multiplication
560 // runs concurrently with the looping logic.
561 uint32_t hash = STRHSH_NULL;
562
563 while (*s)
564 hash = (hash ^ *s++) * 16777619;
565
566 return hash;
567}
568
569static inline uint32_t
570memhsh (const char *s, size_t len)
571{
572 uint32_t hash = STRHSH_NULL;
573
574 while (len--)
575 hash = (hash ^ *s++) * 16777619;
576
577 return hash;
578}
579
432struct str_hash 580struct str_hash
433{ 581{
434 std::size_t operator ()(const char *s) const 582 std::size_t operator ()(const char *s) const
435 { 583 {
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; 584 return strhsh (s);
585 }
586
587 std::size_t operator ()(const shstr &s) const
588 {
589 return strhsh (s);
455 } 590 }
456}; 591};
457 592
458struct str_equal 593struct str_equal
459{ 594{
552 erase (&obj); 687 erase (&obj);
553 } 688 }
554}; 689};
555 690
556// basically does what strncpy should do, but appends "..." to strings exceeding length 691// basically does what strncpy should do, but appends "..." to strings exceeding length
692// returns the number of bytes actually used (including \0)
557void assign (char *dst, const char *src, int maxlen); 693int assign (char *dst, const char *src, int maxsize);
558 694
559// type-safe version of assign 695// type-safe version of assign
560template<int N> 696template<int N>
561inline void assign (char (&dst)[N], const char *src) 697inline int assign (char (&dst)[N], const char *src)
562{ 698{
563 assign ((char *)&dst, src, N); 699 return assign ((char *)&dst, src, N);
564} 700}
565 701
566typedef double tstamp; 702typedef double tstamp;
567 703
568// return current time as timestamp 704// return current time as timestamp
569tstamp now (); 705tstamp now ();
570 706
571int similar_direction (int a, int b); 707int similar_direction (int a, int b);
572 708
573// like sprintf, but returns a "static" buffer 709// like v?sprintf, but returns a "static" buffer
574const char *format (const char *format, ...); 710char *vformat (const char *format, va_list ap);
711char *format (const char *format, ...) attribute ((format (printf, 1, 2)));
712
713// safety-check player input which will become object->msg
714bool msg_is_safe (const char *msg);
575 715
576///////////////////////////////////////////////////////////////////////////// 716/////////////////////////////////////////////////////////////////////////////
577// threads, very very thin wrappers around pthreads 717// threads, very very thin wrappers around pthreads
578 718
579struct thread 719struct thread
606#else 746#else
607 #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER 747 #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER
608#endif 748#endif
609 749
610#define SMUTEX(name) smutex name = SMUTEX_INITIALISER 750#define SMUTEX(name) smutex name = SMUTEX_INITIALISER
611#define SMUTEX_LOCK(name) pthread_mutex_lock (&(name)) 751#define SMUTEX_LOCK(name) pthread_mutex_lock (&(name))
612#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name)) 752#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name))
613 753
754typedef pthread_cond_t scond;
755
756#define SCOND(name) scond name = PTHREAD_COND_INITIALIZER
757#define SCOND_SIGNAL(name) pthread_cond_signal (&(name))
758#define SCOND_BROADCAST(name) pthread_cond_broadcast (&(name))
759#define SCOND_WAIT(name,mutex) pthread_cond_wait (&(name), &(mutex))
760
614#endif 761#endif
615 762

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines