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.78 by root, Thu Dec 4 03:48:19 2008 UTC vs.
Revision 1.96 by root, Wed Nov 11 03:52:44 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,2008 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
26#include <compiler.h>
27
25#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0 28#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0
26#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs 29#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs
27#define PREFER_MALLOC 0 // use malloc and not the slice allocator 30#define PREFER_MALLOC 0 // use malloc and not the slice allocator
28
29#if __GNUC__ >= 3
30# define is_constant(c) __builtin_constant_p (c)
31# define expect(expr,value) __builtin_expect ((expr),(value))
32# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
33#else
34# define is_constant(c) 0
35# define expect(expr,value) (expr)
36# define prefetch(addr,rw,locality)
37#endif
38
39#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
40# define decltype(x) typeof(x)
41#endif
42
43// put into ifs if you are very sure that the expression
44// is mostly true or mosty false. note that these return
45// booleans, not the expression.
46#define expect_false(expr) expect ((expr) != 0, 0)
47#define expect_true(expr) expect ((expr) != 0, 1)
48 31
49#include <pthread.h> 32#include <pthread.h>
50 33
51#include <cstddef> 34#include <cstddef>
52#include <cmath> 35#include <cmath>
… …
72#endif 55#endif
73 56
74// 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)
75#define auto(var,expr) decltype(expr) var = (expr) 58#define auto(var,expr) decltype(expr) var = (expr)
76 59
77// very ugly macro that basicaly declares and initialises a variable 60// very ugly macro that basically declares and initialises a variable
78// that is in scope for the next statement only 61// that is in scope for the next statement only
79// 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
80// (note: works great for pointers) 63// (note: works great for pointers)
81// most ugly macro I ever wrote 64// most ugly macro I ever wrote
82#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)
… …
96// 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.
97template<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; }
98template<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; }
99template<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; }
100 83
101template<typename T> static inline void min_it (T &v, T m) { v = min (v, m); } 84template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); }
102template<typename T> static inline void max_it (T &v, T m) { v = max (v, m); } 85template<typename T, typename U> static inline void max_it (T &v, U m) { v = max (v, (T)m); }
103template<typename T> static inline void clamp_it (T &v, T a, T b) { v = clamp (v, a, b); } 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); }
104 87
105template<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; }
106 89
107template<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)); }
108template<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)); }
109 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
110// div, with correct rounding (< 0.5 downwards, >=0.5 upwards) 105// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
111template<typename T> static inline T div (T val, T div) { return (val + div / 2) / div; } 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}
112// div, round-up 110// div, round-up
113template<typename T> static inline T div_ru (T val, T div) { return (val + div - 1) / div; } 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}
114// div, round-down 115// div, round-down
115template<typename T> static inline T div_rd (T val, T div) { return (val ) / div; } 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}
116 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
117template<typename T> 123template<typename T>
118static inline T 124static inline T
119lerp (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)
120{ 126{
121 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in); 127 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in);
… …
180 int32_t d = b - a; 186 int32_t d = b - a;
181 d &= d >> 31; 187 d &= d >> 31;
182 return b - d; 188 return b - d;
183} 189}
184 190
185// this is much faster than crossfires original algorithm 191// this is much faster than crossfire's original algorithm
186// on modern cpus 192// on modern cpus
187inline int 193inline int
188isqrt (int n) 194isqrt (int n)
189{ 195{
190 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;
191} 211}
192 212
193// 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)
194#if 0 214#if 0
195// 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.
… …
220absdir (int d) 240absdir (int d)
221{ 241{
222 return ((d - 1) & 7) + 1; 242 return ((d - 1) & 7) + 1;
223} 243}
224 244
245// avoid ctz name because netbsd or freebsd spams it's namespace with it
246#if GCC_VERSION(3,4)
247static inline int least_significant_bit (uint32_t x)
248{
249 return __builtin_ctz (x);
250}
251#else
252int least_significant_bit (uint32_t x);
253#endif
254
255#define for_all_bits_sparse_32(mask, idxvar) \
256 for (uint32_t idxvar, mask_ = mask; \
257 mask_ && ((idxvar = least_significant_bit (mask_)), mask_ &= ~(1 << idxvar), 1);)
258
225extern ssize_t slice_alloc; // statistics 259extern ssize_t slice_alloc; // statistics
226 260
227void *salloc_ (int n) throw (std::bad_alloc); 261void *salloc_ (int n) throw (std::bad_alloc);
228void *salloc_ (int n, void *src) throw (std::bad_alloc); 262void *salloc_ (int n, void *src) throw (std::bad_alloc);
229 263
… …
378// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. 412// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213.
379// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 413// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
380// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps 414// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
381struct tausworthe_random_generator 415struct tausworthe_random_generator
382{ 416{
383 // generator
384 uint32_t state [4]; 417 uint32_t state [4];
385 418
386 void operator =(const tausworthe_random_generator &src) 419 void operator =(const tausworthe_random_generator &src)
387 { 420 {
388 state [0] = src.state [0]; 421 state [0] = src.state [0];
… …
391 state [3] = src.state [3]; 424 state [3] = src.state [3];
392 } 425 }
393 426
394 void seed (uint32_t seed); 427 void seed (uint32_t seed);
395 uint32_t next (); 428 uint32_t next ();
429};
396 430
431// Xorshift RNGs, George Marsaglia
432// http://www.jstatsoft.org/v08/i14/paper
433// this one is about 40% faster than the tausworthe one above (i.e. not much),
434// despite the inlining, and has the issue of only creating 2**32-1 numbers.
435// see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf
436struct xorshift_random_generator
437{
438 uint32_t x, y;
439
440 void operator =(const xorshift_random_generator &src)
441 {
442 x = src.x;
443 y = src.y;
444 }
445
446 void seed (uint32_t seed)
447 {
448 x = seed;
449 y = seed * 69069U;
450 }
451
452 uint32_t next ()
453 {
454 uint32_t t = x ^ (x << 10);
455 x = y;
456 y = y ^ (y >> 13) ^ t ^ (t >> 10);
457 return y;
458 }
459};
460
461template<class generator>
462struct random_number_generator : generator
463{
397 // uniform distribution, 0 .. max (0, num - 1) 464 // uniform distribution, 0 .. max (0, num - 1)
398 uint32_t operator ()(uint32_t num) 465 uint32_t operator ()(uint32_t num)
399 { 466 {
400 return is_constant (num) 467 return !is_constant (num) ? get_range (num) // non-constant
401 ? (next () * (uint64_t)num) >> 32U 468 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
402 : get_range (num); 469 : this->next () & (num - 1); // constant, power-of-two
403 } 470 }
404 471
405 // return a number within (min .. max) 472 // return a number within (min .. max)
406 int operator () (int r_min, int r_max) 473 int operator () (int r_min, int r_max)
407 { 474 {
… …
418protected: 485protected:
419 uint32_t get_range (uint32_t r_max); 486 uint32_t get_range (uint32_t r_max);
420 int get_range (int r_min, int r_max); 487 int get_range (int r_min, int r_max);
421}; 488};
422 489
423typedef tausworthe_random_generator rand_gen; 490typedef random_number_generator<tausworthe_random_generator> rand_gen;
424 491
425extern rand_gen rndm, rmg_rndm; 492extern rand_gen rndm, rmg_rndm;
426 493
427INTERFACE_CLASS (attachable) 494INTERFACE_CLASS (attachable)
428struct refcnt_base 495struct refcnt_base
… …
493typedef refptr<object> object_ptr; 560typedef refptr<object> object_ptr;
494typedef refptr<archetype> arch_ptr; 561typedef refptr<archetype> arch_ptr;
495typedef refptr<client> client_ptr; 562typedef refptr<client> client_ptr;
496typedef refptr<player> player_ptr; 563typedef refptr<player> player_ptr;
497 564
565#define STRHSH_NULL 2166136261
566
567static inline uint32_t
568strhsh (const char *s)
569{
570 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
571 // it is about twice as fast as the one-at-a-time one,
572 // with good distribution.
573 // FNV-1a is faster on many cpus because the multiplication
574 // runs concurrently with the looping logic.
575 uint32_t hash = STRHSH_NULL;
576
577 while (*s)
578 hash = (hash ^ *s++) * 16777619;
579
580 return hash;
581}
582
583static inline uint32_t
584memhsh (const char *s, size_t len)
585{
586 uint32_t hash = STRHSH_NULL;
587
588 while (len--)
589 hash = (hash ^ *s++) * 16777619;
590
591 return hash;
592}
593
498struct str_hash 594struct str_hash
499{ 595{
500 std::size_t operator ()(const char *s) const 596 std::size_t operator ()(const char *s) const
501 { 597 {
502 unsigned long hash = 0;
503
504 /* use the one-at-a-time hash function, which supposedly is
505 * better than the djb2-like one used by perl5.005, but
506 * certainly is better then the bug used here before.
507 * see http://burtleburtle.net/bob/hash/doobs.html
508 */
509 while (*s)
510 {
511 hash += *s++;
512 hash += hash << 10;
513 hash ^= hash >> 6;
514 }
515
516 hash += hash << 3;
517 hash ^= hash >> 11;
518 hash += hash << 15;
519
520 return hash; 598 return strhsh (s);
599 }
600
601 std::size_t operator ()(const shstr &s) const
602 {
603 return strhsh (s);
521 } 604 }
522}; 605};
523 606
524struct str_equal 607struct str_equal
525{ 608{
… …
618 erase (&obj); 701 erase (&obj);
619 } 702 }
620}; 703};
621 704
622// basically does what strncpy should do, but appends "..." to strings exceeding length 705// basically does what strncpy should do, but appends "..." to strings exceeding length
706// returns the number of bytes actually used (including \0)
623void assign (char *dst, const char *src, int maxlen); 707int assign (char *dst, const char *src, int maxsize);
624 708
625// type-safe version of assign 709// type-safe version of assign
626template<int N> 710template<int N>
627inline void assign (char (&dst)[N], const char *src) 711inline int assign (char (&dst)[N], const char *src)
628{ 712{
629 assign ((char *)&dst, src, N); 713 return assign ((char *)&dst, src, N);
630} 714}
631 715
632typedef double tstamp; 716typedef double tstamp;
633 717
634// return current time as timestamp 718// return current time as timestamp
635tstamp now (); 719tstamp now ();
636 720
637int similar_direction (int a, int b); 721int similar_direction (int a, int b);
638 722
639// like sprintf, but returns a "static" buffer 723// like v?sprintf, but returns a "static" buffer
640const char *format (const char *format, ...); 724char *vformat (const char *format, va_list ap);
725char *format (const char *format, ...) attribute ((format (printf, 1, 2)));
726
727// safety-check player input which will become object->msg
728bool msg_is_safe (const char *msg);
641 729
642///////////////////////////////////////////////////////////////////////////// 730/////////////////////////////////////////////////////////////////////////////
643// threads, very very thin wrappers around pthreads 731// threads, very very thin wrappers around pthreads
644 732
645struct thread 733struct thread

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines