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.80 by root, Tue Dec 23 01:51:28 2008 UTC vs.
Revision 1.103 by root, Thu Apr 29 15:49:04 2010 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,2009,2010 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
60// could use the sizeof (arr) /( sizeof (arr [0]) here, but C++ is
61// much more obfuscated... :)
62
63template<typename T, int N>
64inline int array_length (const T (&arr)[N])
65{
66 return N;
67}
68
77// very ugly macro that basicaly declares and initialises a variable 69// very ugly macro that basically declares and initialises a variable
78// that is in scope for the next statement only 70// that is in scope for the next statement only
79// works only for stuff that can be assigned 0 and converts to false 71// works only for stuff that can be assigned 0 and converts to false
80// (note: works great for pointers) 72// (note: works great for pointers)
81// most ugly macro I ever wrote 73// most ugly macro I ever wrote
82#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) 74#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1)
… …
110// sign returns -1 or +1 102// sign returns -1 or +1
111template<typename T> 103template<typename T>
112static inline T sign (T v) { return v < 0 ? -1 : +1; } 104static inline T sign (T v) { return v < 0 ? -1 : +1; }
113// relies on 2c representation 105// relies on 2c representation
114template<> 106template<>
115inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); } 107inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); }
108template<>
109inline sint16 sign (sint16 v) { return 1 - (sint16 (uint16 (v) >> 15) * 2); }
110template<>
111inline sint32 sign (sint32 v) { return 1 - (sint32 (uint32 (v) >> 31) * 2); }
116 112
117// sign0 returns -1, 0 or +1 113// sign0 returns -1, 0 or +1
118template<typename T> 114template<typename T>
119static inline T sign0 (T v) { return v ? sign (v) : 0; } 115static inline T sign0 (T v) { return v ? sign (v) : 0; }
120 116
117template<typename T, typename U>
118static inline T copysign (T a, U b) { return a > 0 ? b : -b; }
119
120// div* only work correctly for div > 0
121// div, with correct rounding (< 0.5 downwards, >=0.5 upwards) 121// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
122template<typename T> static inline T div (T val, T div) { return (val + div / 2) / div; } 122template<typename T> static inline T div (T val, T div)
123{
124 return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div;
125}
123// div, round-up 126// div, round-up
124template<typename T> static inline T div_ru (T val, T div) { return (val + div - 1) / div; } 127template<typename T> static inline T div_ru (T val, T div)
128{
129 return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div;
130}
125// div, round-down 131// div, round-down
126template<typename T> static inline T div_rd (T val, T div) { return (val ) / div; } 132template<typename T> static inline T div_rd (T val, T div)
133{
134 return expect_false (val < 0) ? - ((-val + (div - 1) ) / div) : (val ) / div;
135}
127 136
137// lerp* only work correctly for min_in < max_in
138// Linear intERPolate, scales val from min_in..max_in to min_out..max_out
128template<typename T> 139template<typename T>
129static inline T 140static inline T
130lerp (T val, T min_in, T max_in, T min_out, T max_out) 141lerp (T val, T min_in, T max_in, T min_out, T max_out)
131{ 142{
132 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in); 143 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in);
… …
191 int32_t d = b - a; 202 int32_t d = b - a;
192 d &= d >> 31; 203 d &= d >> 31;
193 return b - d; 204 return b - d;
194} 205}
195 206
196// this is much faster than crossfires original algorithm 207// this is much faster than crossfire's original algorithm
197// on modern cpus 208// on modern cpus
198inline int 209inline int
199isqrt (int n) 210isqrt (int n)
200{ 211{
201 return (int)sqrtf ((float)n); 212 return (int)sqrtf ((float)n);
213}
214
215// this is kind of like the ^^ operator, if it would exist, without sequence point.
216// more handy than it looks like, due to the implicit !! done on its arguments
217inline bool
218logical_xor (bool a, bool b)
219{
220 return a != b;
221}
222
223inline bool
224logical_implies (bool a, bool b)
225{
226 return a <= b;
202} 227}
203 228
204// this is only twice as fast as naive sqrtf (dx*dy+dy*dy) 229// this is only twice as fast as naive sqrtf (dx*dy+dy*dy)
205#if 0 230#if 0
206// and has a max. error of 6 in the range -100..+100. 231// and has a max. error of 6 in the range -100..+100.
… …
231absdir (int d) 256absdir (int d)
232{ 257{
233 return ((d - 1) & 7) + 1; 258 return ((d - 1) & 7) + 1;
234} 259}
235 260
261// avoid ctz name because netbsd or freebsd spams it's namespace with it
262#if GCC_VERSION(3,4)
263static inline int least_significant_bit (uint32_t x)
264{
265 return __builtin_ctz (x);
266}
267#else
268int least_significant_bit (uint32_t x);
269#endif
270
271#define for_all_bits_sparse_32(mask, idxvar) \
272 for (uint32_t idxvar, mask_ = mask; \
273 mask_ && ((idxvar = least_significant_bit (mask_)), mask_ &= ~(1 << idxvar), 1);)
274
236extern ssize_t slice_alloc; // statistics 275extern ssize_t slice_alloc; // statistics
237 276
238void *salloc_ (int n) throw (std::bad_alloc); 277void *salloc_ (int n) throw (std::bad_alloc);
239void *salloc_ (int n, void *src) throw (std::bad_alloc); 278void *salloc_ (int n, void *src) throw (std::bad_alloc);
240 279
… …
389// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. 428// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213.
390// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 429// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
391// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps 430// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
392struct tausworthe_random_generator 431struct tausworthe_random_generator
393{ 432{
394 // generator
395 uint32_t state [4]; 433 uint32_t state [4];
396 434
397 void operator =(const tausworthe_random_generator &src) 435 void operator =(const tausworthe_random_generator &src)
398 { 436 {
399 state [0] = src.state [0]; 437 state [0] = src.state [0];
… …
402 state [3] = src.state [3]; 440 state [3] = src.state [3];
403 } 441 }
404 442
405 void seed (uint32_t seed); 443 void seed (uint32_t seed);
406 uint32_t next (); 444 uint32_t next ();
445};
407 446
447// Xorshift RNGs, George Marsaglia
448// http://www.jstatsoft.org/v08/i14/paper
449// this one is about 40% faster than the tausworthe one above (i.e. not much),
450// despite the inlining, and has the issue of only creating 2**32-1 numbers.
451// see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf
452struct xorshift_random_generator
453{
454 uint32_t x, y;
455
456 void operator =(const xorshift_random_generator &src)
457 {
458 x = src.x;
459 y = src.y;
460 }
461
462 void seed (uint32_t seed)
463 {
464 x = seed;
465 y = seed * 69069U;
466 }
467
468 uint32_t next ()
469 {
470 uint32_t t = x ^ (x << 10);
471 x = y;
472 y = y ^ (y >> 13) ^ t ^ (t >> 10);
473 return y;
474 }
475};
476
477template<class generator>
478struct random_number_generator : generator
479{
408 // uniform distribution, 0 .. max (0, num - 1) 480 // uniform distribution, 0 .. max (0, num - 1)
409 uint32_t operator ()(uint32_t num) 481 uint32_t operator ()(uint32_t num)
410 { 482 {
411 return is_constant (num) 483 return !is_constant (num) ? get_range (num) // non-constant
412 ? (next () * (uint64_t)num) >> 32U 484 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
413 : get_range (num); 485 : this->next () & (num - 1); // constant, power-of-two
414 } 486 }
415 487
416 // return a number within (min .. max) 488 // return a number within the closed interval [min .. max]
417 int operator () (int r_min, int r_max) 489 int operator () (int r_min, int r_max)
418 { 490 {
419 return is_constant (r_min) && is_constant (r_max) && r_min <= r_max 491 return is_constant (r_min) && is_constant (r_max) && r_min <= r_max
420 ? r_min + operator ()(r_max - r_min + 1) 492 ? r_min + operator ()(r_max - r_min + 1)
421 : get_range (r_min, r_max); 493 : get_range (r_min, r_max);
422 } 494 }
423 495
496 // return a number within the closed interval [0..1]
424 double operator ()() 497 double operator ()()
425 { 498 {
426 return this->next () / (double)0xFFFFFFFFU; 499 return this->next () / (double)0xFFFFFFFFU;
427 } 500 }
428 501
429protected: 502protected:
430 uint32_t get_range (uint32_t r_max); 503 uint32_t get_range (uint32_t r_max);
431 int get_range (int r_min, int r_max); 504 int get_range (int r_min, int r_max);
432}; 505};
433 506
434typedef tausworthe_random_generator rand_gen; 507typedef random_number_generator<tausworthe_random_generator> rand_gen;
435 508
436extern rand_gen rndm, rmg_rndm; 509extern rand_gen rndm, rmg_rndm;
437 510
438INTERFACE_CLASS (attachable) 511INTERFACE_CLASS (attachable)
439struct refcnt_base 512struct refcnt_base
… …
503typedef refptr<maptile> maptile_ptr; 576typedef refptr<maptile> maptile_ptr;
504typedef refptr<object> object_ptr; 577typedef refptr<object> object_ptr;
505typedef refptr<archetype> arch_ptr; 578typedef refptr<archetype> arch_ptr;
506typedef refptr<client> client_ptr; 579typedef refptr<client> client_ptr;
507typedef refptr<player> player_ptr; 580typedef refptr<player> player_ptr;
581typedef refptr<region> region_ptr;
582
583#define STRHSH_NULL 2166136261
584
585static inline uint32_t
586strhsh (const char *s)
587{
588 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
589 // it is about twice as fast as the one-at-a-time one,
590 // with good distribution.
591 // FNV-1a is faster on many cpus because the multiplication
592 // runs concurrently with the looping logic.
593 uint32_t hash = STRHSH_NULL;
594
595 while (*s)
596 hash = (hash ^ *s++) * 16777619U;
597
598 return hash;
599}
600
601static inline uint32_t
602memhsh (const char *s, size_t len)
603{
604 uint32_t hash = STRHSH_NULL;
605
606 while (len--)
607 hash = (hash ^ *s++) * 16777619U;
608
609 return hash;
610}
508 611
509struct str_hash 612struct str_hash
510{ 613{
511 std::size_t operator ()(const char *s) const 614 std::size_t operator ()(const char *s) const
512 { 615 {
513 unsigned long hash = 0;
514
515 /* use the one-at-a-time hash function, which supposedly is
516 * better than the djb2-like one used by perl5.005, but
517 * certainly is better then the bug used here before.
518 * see http://burtleburtle.net/bob/hash/doobs.html
519 */
520 while (*s)
521 {
522 hash += *s++;
523 hash += hash << 10;
524 hash ^= hash >> 6;
525 }
526
527 hash += hash << 3;
528 hash ^= hash >> 11;
529 hash += hash << 15;
530
531 return hash; 616 return strhsh (s);
617 }
618
619 std::size_t operator ()(const shstr &s) const
620 {
621 return strhsh (s);
532 } 622 }
533}; 623};
534 624
535struct str_equal 625struct str_equal
536{ 626{
… …
629 erase (&obj); 719 erase (&obj);
630 } 720 }
631}; 721};
632 722
633// basically does what strncpy should do, but appends "..." to strings exceeding length 723// basically does what strncpy should do, but appends "..." to strings exceeding length
724// returns the number of bytes actually used (including \0)
634void assign (char *dst, const char *src, int maxlen); 725int assign (char *dst, const char *src, int maxsize);
635 726
636// type-safe version of assign 727// type-safe version of assign
637template<int N> 728template<int N>
638inline void assign (char (&dst)[N], const char *src) 729inline int assign (char (&dst)[N], const char *src)
639{ 730{
640 assign ((char *)&dst, src, N); 731 return assign ((char *)&dst, src, N);
641} 732}
642 733
643typedef double tstamp; 734typedef double tstamp;
644 735
645// return current time as timestamp 736// return current time as timestamp
646tstamp now (); 737tstamp now ();
647 738
648int similar_direction (int a, int b); 739int similar_direction (int a, int b);
649 740
650// like sprintf, but returns a "static" buffer 741// like v?sprintf, but returns a "static" buffer
651const char *format (const char *format, ...); 742char *vformat (const char *format, va_list ap);
743char *format (const char *format, ...) attribute ((format (printf, 1, 2)));
744
745// safety-check player input which will become object->msg
746bool msg_is_safe (const char *msg);
652 747
653///////////////////////////////////////////////////////////////////////////// 748/////////////////////////////////////////////////////////////////////////////
654// threads, very very thin wrappers around pthreads 749// threads, very very thin wrappers around pthreads
655 750
656struct thread 751struct thread

Diff Legend

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