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.85 by root, Thu Jan 1 20:49:48 2009 UTC vs.
Revision 1.101 by root, Wed Apr 28 19:49:50 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# define noinline __attribute__((__noinline__))
34#else
35# define is_constant(c) 0
36# define expect(expr,value) (expr)
37# define prefetch(addr,rw,locality)
38# define noinline
39#endif
40
41#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
42# define decltype(x) typeof(x)
43#endif
44
45// put into ifs if you are very sure that the expression
46// is mostly true or mosty false. note that these return
47// booleans, not the expression.
48#define expect_false(expr) expect ((expr) ? 1 : 0, 0)
49#define expect_true(expr) expect ((expr) ? 1 : 0, 1)
50 31
51#include <pthread.h> 32#include <pthread.h>
52 33
53#include <cstddef> 34#include <cstddef>
54#include <cmath> 35#include <cmath>
74#endif 55#endif
75 56
76// 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)
77#define auto(var,expr) decltype(expr) var = (expr) 58#define auto(var,expr) decltype(expr) var = (expr)
78 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
79// very ugly macro that basically declares and initialises a variable 69// very ugly macro that basically declares and initialises a variable
80// that is in scope for the next statement only 70// that is in scope for the next statement only
81// 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
82// (note: works great for pointers) 72// (note: works great for pointers)
83// most ugly macro I ever wrote 73// most ugly macro I ever wrote
118 108
119// sign0 returns -1, 0 or +1 109// sign0 returns -1, 0 or +1
120template<typename T> 110template<typename T>
121static inline T sign0 (T v) { return v ? sign (v) : 0; } 111static inline T sign0 (T v) { return v ? sign (v) : 0; }
122 112
113template<typename T, typename U>
114static inline T copysign (T a, U b) { return a > 0 ? b : -b; }
115
116// div* only work correctly for div > 0
123// div, with correct rounding (< 0.5 downwards, >=0.5 upwards) 117// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
124template<typename T> static inline T div (T val, T div) { return (val + div / 2) / div; } 118template<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}
125// div, round-up 122// div, round-up
126template<typename T> static inline T div_ru (T val, T div) { return (val + div - 1) / div; } 123template<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}
127// div, round-down 127// div, round-down
128template<typename T> static inline T div_rd (T val, T div) { return (val ) / div; } 128template<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}
129 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
130template<typename T> 135template<typename T>
131static inline T 136static inline T
132lerp (T val, T min_in, T max_in, T min_out, T max_out) 137lerp (T val, T min_in, T max_in, T min_out, T max_out)
133{ 138{
134 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);
193 int32_t d = b - a; 198 int32_t d = b - a;
194 d &= d >> 31; 199 d &= d >> 31;
195 return b - d; 200 return b - d;
196} 201}
197 202
198// this is much faster than crossfires original algorithm 203// this is much faster than crossfire's original algorithm
199// on modern cpus 204// on modern cpus
200inline int 205inline int
201isqrt (int n) 206isqrt (int n)
202{ 207{
203 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
213inline bool
214logical_xor (bool a, bool b)
215{
216 return a != b;
217}
218
219inline bool
220logical_implies (bool a, bool b)
221{
222 return a <= b;
204} 223}
205 224
206// 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)
207#if 0 226#if 0
208// 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.
233absdir (int d) 252absdir (int d)
234{ 253{
235 return ((d - 1) & 7) + 1; 254 return ((d - 1) & 7) + 1;
236} 255}
237 256
257// avoid ctz name because netbsd or freebsd spams it's namespace with it
258#if GCC_VERSION(3,4)
259static inline int least_significant_bit (uint32_t x)
260{
261 return __builtin_ctz (x);
262}
263#else
264int 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
238extern ssize_t slice_alloc; // statistics 271extern ssize_t slice_alloc; // statistics
239 272
240void *salloc_ (int n) throw (std::bad_alloc); 273void *salloc_ (int n) throw (std::bad_alloc);
241void *salloc_ (int n, void *src) throw (std::bad_alloc); 274void *salloc_ (int n, void *src) throw (std::bad_alloc);
242 275
409 442
410// Xorshift RNGs, George Marsaglia 443// Xorshift RNGs, George Marsaglia
411// http://www.jstatsoft.org/v08/i14/paper 444// http://www.jstatsoft.org/v08/i14/paper
412// this one is about 40% faster than the tausworthe one above (i.e. not much), 445// this one is about 40% faster than the tausworthe one above (i.e. not much),
413// despite the inlining, and has the issue of only creating 2**32-1 numbers. 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
414struct xorshift_random_generator 448struct xorshift_random_generator
415{ 449{
416 uint32_t x, y; 450 uint32_t x, y;
417 451
418 void operator =(const xorshift_random_generator &src) 452 void operator =(const xorshift_random_generator &src)
445 return !is_constant (num) ? get_range (num) // non-constant 479 return !is_constant (num) ? get_range (num) // non-constant
446 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two 480 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
447 : this->next () & (num - 1); // constant, power-of-two 481 : this->next () & (num - 1); // constant, power-of-two
448 } 482 }
449 483
450 // return a number within (min .. max) 484 // return a number within the closed interval [min .. max]
451 int operator () (int r_min, int r_max) 485 int operator () (int r_min, int r_max)
452 { 486 {
453 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
454 ? r_min + operator ()(r_max - r_min + 1) 488 ? r_min + operator ()(r_max - r_min + 1)
455 : get_range (r_min, r_max); 489 : get_range (r_min, r_max);
456 } 490 }
457 491
492 // return a number within the closed interval [0..1]
458 double operator ()() 493 double operator ()()
459 { 494 {
460 return this->next () / (double)0xFFFFFFFFU; 495 return this->next () / (double)0xFFFFFFFFU;
461 } 496 }
462 497
538typedef refptr<object> object_ptr; 573typedef refptr<object> object_ptr;
539typedef refptr<archetype> arch_ptr; 574typedef refptr<archetype> arch_ptr;
540typedef refptr<client> client_ptr; 575typedef refptr<client> client_ptr;
541typedef refptr<player> player_ptr; 576typedef refptr<player> player_ptr;
542 577
578#define STRHSH_NULL 2166136261
579
580static inline uint32_t
581strhsh (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
596static inline uint32_t
597memhsh (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
543struct str_hash 607struct str_hash
544{ 608{
545 std::size_t operator ()(const char *s) const 609 std::size_t operator ()(const char *s) const
546 { 610 {
547#if 0
548 uint32_t hash = 0;
549
550 /* use the one-at-a-time hash function, which supposedly is
551 * better than the djb2-like one used by perl5.005, but
552 * certainly is better then the bug used here before.
553 * see http://burtleburtle.net/bob/hash/doobs.html
554 */
555 while (*s)
556 {
557 hash += *s++;
558 hash += hash << 10;
559 hash ^= hash >> 6;
560 }
561
562 hash += hash << 3;
563 hash ^= hash >> 11;
564 hash += hash << 15;
565#else
566 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
567 // it is about twice as fast as the one-at-a-time one,
568 // with good distribution.
569 // FNV-1a is faster on many cpus because the multiplication
570 // runs concurrent with the looping logic.
571 uint32_t hash = 2166136261;
572
573 while (*s)
574 hash = (hash ^ *s++) * 16777619;
575#endif
576
577 return hash; 611 return strhsh (s);
612 }
613
614 std::size_t operator ()(const shstr &s) const
615 {
616 return strhsh (s);
578 } 617 }
579}; 618};
580 619
581struct str_equal 620struct str_equal
582{ 621{
675 erase (&obj); 714 erase (&obj);
676 } 715 }
677}; 716};
678 717
679// 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)
680void assign (char *dst, const char *src, int maxlen); 720int assign (char *dst, const char *src, int maxsize);
681 721
682// type-safe version of assign 722// type-safe version of assign
683template<int N> 723template<int N>
684inline void assign (char (&dst)[N], const char *src) 724inline int assign (char (&dst)[N], const char *src)
685{ 725{
686 assign ((char *)&dst, src, N); 726 return assign ((char *)&dst, src, N);
687} 727}
688 728
689typedef double tstamp; 729typedef double tstamp;
690 730
691// return current time as timestamp 731// return current time as timestamp
692tstamp now (); 732tstamp now ();
693 733
694int similar_direction (int a, int b); 734int similar_direction (int a, int b);
695 735
696// like sprintf, but returns a "static" buffer 736// like v?sprintf, but returns a "static" buffer
697const char *format (const char *format, ...); 737char *vformat (const char *format, va_list ap);
738char *format (const char *format, ...) attribute ((format (printf, 1, 2)));
739
740// safety-check player input which will become object->msg
741bool msg_is_safe (const char *msg);
698 742
699///////////////////////////////////////////////////////////////////////////// 743/////////////////////////////////////////////////////////////////////////////
700// threads, very very thin wrappers around pthreads 744// threads, very very thin wrappers around pthreads
701 745
702struct thread 746struct thread

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines