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 | |
|
|
63 | template<typename T, int N> |
|
|
64 | inline 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) |
… | |
… | |
96 | // as a is often a constant while b is the variable. it is still a bug, though. |
88 | // as a is often a constant while b is the variable. it is still a bug, though. |
97 | template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } |
89 | template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } |
98 | template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } |
90 | template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } |
99 | 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; } |
91 | 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; } |
100 | |
92 | |
101 | template<typename T> static inline void min_it (T &v, T m) { v = min (v, m); } |
93 | template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); } |
102 | template<typename T> static inline void max_it (T &v, T m) { v = max (v, m); } |
94 | template<typename T, typename U> static inline void max_it (T &v, U m) { v = max (v, (T)m); } |
103 | template<typename T> static inline void clamp_it (T &v, T a, T b) { v = clamp (v, a, b); } |
95 | template<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 | |
96 | |
105 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
97 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
106 | |
98 | |
107 | template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); } |
99 | template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); } |
108 | template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); } |
100 | template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); } |
… | |
… | |
116 | |
108 | |
117 | // sign0 returns -1, 0 or +1 |
109 | // sign0 returns -1, 0 or +1 |
118 | template<typename T> |
110 | template<typename T> |
119 | static inline T sign0 (T v) { return v ? sign (v) : 0; } |
111 | static inline T sign0 (T v) { return v ? sign (v) : 0; } |
120 | |
112 | |
|
|
113 | template<typename T, typename U> |
|
|
114 | static inline T copysign (T a, U b) { return a > 0 ? b : -b; } |
|
|
115 | |
|
|
116 | // div* only work correctly for div > 0 |
121 | // div, with correct rounding (< 0.5 downwards, >=0.5 upwards) |
117 | // div, with correct rounding (< 0.5 downwards, >=0.5 upwards) |
122 | template<typename T> static inline T div (T val, T div) { return (val + div / 2) / div; } |
118 | template<typename T> static inline T div (T val, T div) |
|
|
119 | { |
|
|
120 | return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div; |
|
|
121 | } |
123 | // div, round-up |
122 | // div, round-up |
124 | template<typename T> static inline T div_ru (T val, T div) { return (val + div - 1) / div; } |
123 | template<typename T> static inline T div_ru (T val, T div) |
|
|
124 | { |
|
|
125 | return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div; |
|
|
126 | } |
125 | // div, round-down |
127 | // div, round-down |
126 | template<typename T> static inline T div_rd (T val, T div) { return (val ) / div; } |
128 | template<typename T> static inline T div_rd (T val, T div) |
|
|
129 | { |
|
|
130 | return expect_false (val < 0) ? - ((-val + (div - 1) ) / div) : (val ) / div; |
|
|
131 | } |
127 | |
132 | |
|
|
133 | // lerp* only work correctly for min_in < max_in |
|
|
134 | // Linear intERPolate, scales val from min_in..max_in to min_out..max_out |
128 | template<typename T> |
135 | template<typename T> |
129 | static inline T |
136 | static inline T |
130 | lerp (T val, T min_in, T max_in, T min_out, T max_out) |
137 | lerp (T val, T min_in, T max_in, T min_out, T max_out) |
131 | { |
138 | { |
132 | return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in); |
139 | return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in); |
… | |
… | |
191 | int32_t d = b - a; |
198 | int32_t d = b - a; |
192 | d &= d >> 31; |
199 | d &= d >> 31; |
193 | return b - d; |
200 | return b - d; |
194 | } |
201 | } |
195 | |
202 | |
196 | // this is much faster than crossfires original algorithm |
203 | // this is much faster than crossfire's original algorithm |
197 | // on modern cpus |
204 | // on modern cpus |
198 | inline int |
205 | inline int |
199 | isqrt (int n) |
206 | isqrt (int n) |
200 | { |
207 | { |
201 | return (int)sqrtf ((float)n); |
208 | return (int)sqrtf ((float)n); |
|
|
209 | } |
|
|
210 | |
|
|
211 | // this is kind of like the ^^ operator, if it would exist, without sequence point. |
|
|
212 | // more handy than it looks like, due to the implicit !! done on its arguments |
|
|
213 | inline bool |
|
|
214 | logical_xor (bool a, bool b) |
|
|
215 | { |
|
|
216 | return a != b; |
|
|
217 | } |
|
|
218 | |
|
|
219 | inline bool |
|
|
220 | logical_implies (bool a, bool b) |
|
|
221 | { |
|
|
222 | return a <= b; |
202 | } |
223 | } |
203 | |
224 | |
204 | // this is only twice as fast as naive sqrtf (dx*dy+dy*dy) |
225 | // this is only twice as fast as naive sqrtf (dx*dy+dy*dy) |
205 | #if 0 |
226 | #if 0 |
206 | // and has a max. error of 6 in the range -100..+100. |
227 | // and has a max. error of 6 in the range -100..+100. |
… | |
… | |
231 | absdir (int d) |
252 | absdir (int d) |
232 | { |
253 | { |
233 | return ((d - 1) & 7) + 1; |
254 | return ((d - 1) & 7) + 1; |
234 | } |
255 | } |
235 | |
256 | |
|
|
257 | // avoid ctz name because netbsd or freebsd spams it's namespace with it |
|
|
258 | #if GCC_VERSION(3,4) |
|
|
259 | static inline int least_significant_bit (uint32_t x) |
|
|
260 | { |
|
|
261 | return __builtin_ctz (x); |
|
|
262 | } |
|
|
263 | #else |
|
|
264 | int least_significant_bit (uint32_t x); |
|
|
265 | #endif |
|
|
266 | |
|
|
267 | #define for_all_bits_sparse_32(mask, idxvar) \ |
|
|
268 | for (uint32_t idxvar, mask_ = mask; \ |
|
|
269 | mask_ && ((idxvar = least_significant_bit (mask_)), mask_ &= ~(1 << idxvar), 1);) |
|
|
270 | |
236 | extern ssize_t slice_alloc; // statistics |
271 | extern ssize_t slice_alloc; // statistics |
237 | |
272 | |
238 | void *salloc_ (int n) throw (std::bad_alloc); |
273 | void *salloc_ (int n) throw (std::bad_alloc); |
239 | void *salloc_ (int n, void *src) throw (std::bad_alloc); |
274 | void *salloc_ (int n, void *src) throw (std::bad_alloc); |
240 | |
275 | |
… | |
… | |
389 | // P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. |
424 | // 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 |
425 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps |
391 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps |
426 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps |
392 | struct tausworthe_random_generator |
427 | struct tausworthe_random_generator |
393 | { |
428 | { |
394 | // generator |
|
|
395 | uint32_t state [4]; |
429 | uint32_t state [4]; |
396 | |
430 | |
397 | void operator =(const tausworthe_random_generator &src) |
431 | void operator =(const tausworthe_random_generator &src) |
398 | { |
432 | { |
399 | state [0] = src.state [0]; |
433 | state [0] = src.state [0]; |
… | |
… | |
402 | state [3] = src.state [3]; |
436 | state [3] = src.state [3]; |
403 | } |
437 | } |
404 | |
438 | |
405 | void seed (uint32_t seed); |
439 | void seed (uint32_t seed); |
406 | uint32_t next (); |
440 | uint32_t next (); |
|
|
441 | }; |
407 | |
442 | |
|
|
443 | // Xorshift RNGs, George Marsaglia |
|
|
444 | // http://www.jstatsoft.org/v08/i14/paper |
|
|
445 | // this one is about 40% faster than the tausworthe one above (i.e. not much), |
|
|
446 | // despite the inlining, and has the issue of only creating 2**32-1 numbers. |
|
|
447 | // see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf |
|
|
448 | struct xorshift_random_generator |
|
|
449 | { |
|
|
450 | uint32_t x, y; |
|
|
451 | |
|
|
452 | void operator =(const xorshift_random_generator &src) |
|
|
453 | { |
|
|
454 | x = src.x; |
|
|
455 | y = src.y; |
|
|
456 | } |
|
|
457 | |
|
|
458 | void seed (uint32_t seed) |
|
|
459 | { |
|
|
460 | x = seed; |
|
|
461 | y = seed * 69069U; |
|
|
462 | } |
|
|
463 | |
|
|
464 | uint32_t next () |
|
|
465 | { |
|
|
466 | uint32_t t = x ^ (x << 10); |
|
|
467 | x = y; |
|
|
468 | y = y ^ (y >> 13) ^ t ^ (t >> 10); |
|
|
469 | return y; |
|
|
470 | } |
|
|
471 | }; |
|
|
472 | |
|
|
473 | template<class generator> |
|
|
474 | struct random_number_generator : generator |
|
|
475 | { |
408 | // uniform distribution, 0 .. max (0, num - 1) |
476 | // uniform distribution, 0 .. max (0, num - 1) |
409 | uint32_t operator ()(uint32_t num) |
477 | uint32_t operator ()(uint32_t num) |
410 | { |
478 | { |
411 | return is_constant (num) |
479 | return !is_constant (num) ? get_range (num) // non-constant |
412 | ? (next () * (uint64_t)num) >> 32U |
480 | : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two |
413 | : get_range (num); |
481 | : this->next () & (num - 1); // constant, power-of-two |
414 | } |
482 | } |
415 | |
483 | |
416 | // return a number within (min .. max) |
484 | // return a number within the closed interval [min .. max] |
417 | int operator () (int r_min, int r_max) |
485 | int operator () (int r_min, int r_max) |
418 | { |
486 | { |
419 | return is_constant (r_min) && is_constant (r_max) && r_min <= r_max |
487 | return is_constant (r_min) && is_constant (r_max) && r_min <= r_max |
420 | ? r_min + operator ()(r_max - r_min + 1) |
488 | ? r_min + operator ()(r_max - r_min + 1) |
421 | : get_range (r_min, r_max); |
489 | : get_range (r_min, r_max); |
422 | } |
490 | } |
423 | |
491 | |
|
|
492 | // return a number within the closed interval [0..1] |
424 | double operator ()() |
493 | double operator ()() |
425 | { |
494 | { |
426 | return this->next () / (double)0xFFFFFFFFU; |
495 | return this->next () / (double)0xFFFFFFFFU; |
427 | } |
496 | } |
428 | |
497 | |
429 | protected: |
498 | protected: |
430 | uint32_t get_range (uint32_t r_max); |
499 | uint32_t get_range (uint32_t r_max); |
431 | int get_range (int r_min, int r_max); |
500 | int get_range (int r_min, int r_max); |
432 | }; |
501 | }; |
433 | |
502 | |
434 | typedef tausworthe_random_generator rand_gen; |
503 | typedef random_number_generator<tausworthe_random_generator> rand_gen; |
435 | |
504 | |
436 | extern rand_gen rndm, rmg_rndm; |
505 | extern rand_gen rndm, rmg_rndm; |
437 | |
506 | |
438 | INTERFACE_CLASS (attachable) |
507 | INTERFACE_CLASS (attachable) |
439 | struct refcnt_base |
508 | struct refcnt_base |
… | |
… | |
504 | typedef refptr<object> object_ptr; |
573 | typedef refptr<object> object_ptr; |
505 | typedef refptr<archetype> arch_ptr; |
574 | typedef refptr<archetype> arch_ptr; |
506 | typedef refptr<client> client_ptr; |
575 | typedef refptr<client> client_ptr; |
507 | typedef refptr<player> player_ptr; |
576 | typedef refptr<player> player_ptr; |
508 | |
577 | |
|
|
578 | #define STRHSH_NULL 2166136261 |
|
|
579 | |
|
|
580 | static inline uint32_t |
|
|
581 | strhsh (const char *s) |
|
|
582 | { |
|
|
583 | // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/) |
|
|
584 | // it is about twice as fast as the one-at-a-time one, |
|
|
585 | // with good distribution. |
|
|
586 | // FNV-1a is faster on many cpus because the multiplication |
|
|
587 | // runs concurrently with the looping logic. |
|
|
588 | uint32_t hash = STRHSH_NULL; |
|
|
589 | |
|
|
590 | while (*s) |
|
|
591 | hash = (hash ^ *s++) * 16777619U; |
|
|
592 | |
|
|
593 | return hash; |
|
|
594 | } |
|
|
595 | |
|
|
596 | static inline uint32_t |
|
|
597 | memhsh (const char *s, size_t len) |
|
|
598 | { |
|
|
599 | uint32_t hash = STRHSH_NULL; |
|
|
600 | |
|
|
601 | while (len--) |
|
|
602 | hash = (hash ^ *s++) * 16777619U; |
|
|
603 | |
|
|
604 | return hash; |
|
|
605 | } |
|
|
606 | |
509 | struct str_hash |
607 | struct str_hash |
510 | { |
608 | { |
511 | std::size_t operator ()(const char *s) const |
609 | std::size_t operator ()(const char *s) const |
512 | { |
610 | { |
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; |
611 | return strhsh (s); |
|
|
612 | } |
|
|
613 | |
|
|
614 | std::size_t operator ()(const shstr &s) const |
|
|
615 | { |
|
|
616 | return strhsh (s); |
532 | } |
617 | } |
533 | }; |
618 | }; |
534 | |
619 | |
535 | struct str_equal |
620 | struct str_equal |
536 | { |
621 | { |
… | |
… | |
629 | erase (&obj); |
714 | erase (&obj); |
630 | } |
715 | } |
631 | }; |
716 | }; |
632 | |
717 | |
633 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
718 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
|
|
719 | // returns the number of bytes actually used (including \0) |
634 | void assign (char *dst, const char *src, int maxlen); |
720 | int assign (char *dst, const char *src, int maxsize); |
635 | |
721 | |
636 | // type-safe version of assign |
722 | // type-safe version of assign |
637 | template<int N> |
723 | template<int N> |
638 | inline void assign (char (&dst)[N], const char *src) |
724 | inline int assign (char (&dst)[N], const char *src) |
639 | { |
725 | { |
640 | assign ((char *)&dst, src, N); |
726 | return assign ((char *)&dst, src, N); |
641 | } |
727 | } |
642 | |
728 | |
643 | typedef double tstamp; |
729 | typedef double tstamp; |
644 | |
730 | |
645 | // return current time as timestamp |
731 | // return current time as timestamp |
646 | tstamp now (); |
732 | tstamp now (); |
647 | |
733 | |
648 | int similar_direction (int a, int b); |
734 | int similar_direction (int a, int b); |
649 | |
735 | |
650 | // like sprintf, but returns a "static" buffer |
736 | // like v?sprintf, but returns a "static" buffer |
651 | const char *format (const char *format, ...); |
737 | char *vformat (const char *format, va_list ap); |
|
|
738 | char *format (const char *format, ...) attribute ((format (printf, 1, 2))); |
|
|
739 | |
|
|
740 | // safety-check player input which will become object->msg |
|
|
741 | bool msg_is_safe (const char *msg); |
652 | |
742 | |
653 | ///////////////////////////////////////////////////////////////////////////// |
743 | ///////////////////////////////////////////////////////////////////////////// |
654 | // threads, very very thin wrappers around pthreads |
744 | // threads, very very thin wrappers around pthreads |
655 | |
745 | |
656 | struct thread |
746 | struct thread |