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.75 by root, Tue May 6 16:55:26 2008 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#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)
… …
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.
97template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } 89template<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; } 90template<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; } 91template<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
93template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); }
94template<typename T, typename U> static inline void max_it (T &v, U m) { v = max (v, (T)m); }
95template<typename T, typename U, typename V> static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); }
96
101template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } 97template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
102 98
103template<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 min (T a, U b, V c) { return min (a, min (b, c)); }
104template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); } 100template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
105 101
102// sign returns -1 or +1
103template<typename T>
104static inline T sign (T v) { return v < 0 ? -1 : +1; }
105// relies on 2c representation
106template<>
107inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); }
108
109// sign0 returns -1, 0 or +1
110template<typename T>
111static inline T sign0 (T v) { return v ? sign (v) : 0; }
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
117// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
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}
122// div, round-up
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
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}
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
106template<typename T> 135template<typename T>
107static inline T 136static inline T
108lerp (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)
109{ 138{
110 return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; 139 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in);
140}
141
142// lerp, round-down
143template<typename T>
144static inline T
145lerp_rd (T val, T min_in, T max_in, T min_out, T max_out)
146{
147 return min_out + div_rd<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
148}
149
150// lerp, round-up
151template<typename T>
152static inline T
153lerp_ru (T val, T min_in, T max_in, T min_out, T max_out)
154{
155 return min_out + div_ru<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
111} 156}
112 157
113// lots of stuff taken from FXT 158// lots of stuff taken from FXT
114 159
115/* Rotate right. This is used in various places for checksumming */ 160/* Rotate right. This is used in various places for checksumming */
… …
153 int32_t d = b - a; 198 int32_t d = b - a;
154 d &= d >> 31; 199 d &= d >> 31;
155 return b - d; 200 return b - d;
156} 201}
157 202
158// this is much faster than crossfires original algorithm 203// this is much faster than crossfire's original algorithm
159// on modern cpus 204// on modern cpus
160inline int 205inline int
161isqrt (int n) 206isqrt (int n)
162{ 207{
163 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;
164} 223}
165 224
166// 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)
167#if 0 226#if 0
168// 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.
… …
193absdir (int d) 252absdir (int d)
194{ 253{
195 return ((d - 1) & 7) + 1; 254 return ((d - 1) & 7) + 1;
196} 255}
197 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
198extern ssize_t slice_alloc; // statistics 271extern ssize_t slice_alloc; // statistics
199 272
200void *salloc_ (int n) throw (std::bad_alloc); 273void *salloc_ (int n) throw (std::bad_alloc);
201void *salloc_ (int n, void *src) throw (std::bad_alloc); 274void *salloc_ (int n, void *src) throw (std::bad_alloc);
202 275
… …
351// 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.
352// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 425// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
353// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps 426// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
354struct tausworthe_random_generator 427struct tausworthe_random_generator
355{ 428{
356 // generator
357 uint32_t state [4]; 429 uint32_t state [4];
358 430
359 void operator =(const tausworthe_random_generator &src) 431 void operator =(const tausworthe_random_generator &src)
360 { 432 {
361 state [0] = src.state [0]; 433 state [0] = src.state [0];
… …
364 state [3] = src.state [3]; 436 state [3] = src.state [3];
365 } 437 }
366 438
367 void seed (uint32_t seed); 439 void seed (uint32_t seed);
368 uint32_t next (); 440 uint32_t next ();
441};
369 442
370 // uniform distribution 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
448struct 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
473template<class generator>
474struct random_number_generator : generator
475{
476 // uniform distribution, 0 .. max (0, num - 1)
371 uint32_t operator ()(uint32_t num) 477 uint32_t operator ()(uint32_t num)
372 { 478 {
373 return is_constant (num) 479 return !is_constant (num) ? get_range (num) // non-constant
374 ? (next () * (uint64_t)num) >> 32U 480 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
375 : get_range (num); 481 : this->next () & (num - 1); // constant, power-of-two
376 } 482 }
377 483
378 // return a number within (min .. max) 484 // return a number within the closed interval [min .. max]
379 int operator () (int r_min, int r_max) 485 int operator () (int r_min, int r_max)
380 { 486 {
381 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
382 ? r_min + operator ()(r_max - r_min + 1) 488 ? r_min + operator ()(r_max - r_min + 1)
383 : get_range (r_min, r_max); 489 : get_range (r_min, r_max);
384 } 490 }
385 491
492 // return a number within the closed interval [0..1]
386 double operator ()() 493 double operator ()()
387 { 494 {
388 return this->next () / (double)0xFFFFFFFFU; 495 return this->next () / (double)0xFFFFFFFFU;
389 } 496 }
390 497
391protected: 498protected:
392 uint32_t get_range (uint32_t r_max); 499 uint32_t get_range (uint32_t r_max);
393 int get_range (int r_min, int r_max); 500 int get_range (int r_min, int r_max);
394}; 501};
395 502
396typedef tausworthe_random_generator rand_gen; 503typedef random_number_generator<tausworthe_random_generator> rand_gen;
397 504
398extern rand_gen rndm, rmg_rndm; 505extern rand_gen rndm, rmg_rndm;
399 506
400INTERFACE_CLASS (attachable) 507INTERFACE_CLASS (attachable)
401struct refcnt_base 508struct refcnt_base
… …
466typedef refptr<object> object_ptr; 573typedef refptr<object> object_ptr;
467typedef refptr<archetype> arch_ptr; 574typedef refptr<archetype> arch_ptr;
468typedef refptr<client> client_ptr; 575typedef refptr<client> client_ptr;
469typedef refptr<player> player_ptr; 576typedef refptr<player> player_ptr;
470 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
471struct str_hash 607struct str_hash
472{ 608{
473 std::size_t operator ()(const char *s) const 609 std::size_t operator ()(const char *s) const
474 { 610 {
475 unsigned long hash = 0;
476
477 /* use the one-at-a-time hash function, which supposedly is
478 * better than the djb2-like one used by perl5.005, but
479 * certainly is better then the bug used here before.
480 * see http://burtleburtle.net/bob/hash/doobs.html
481 */
482 while (*s)
483 {
484 hash += *s++;
485 hash += hash << 10;
486 hash ^= hash >> 6;
487 }
488
489 hash += hash << 3;
490 hash ^= hash >> 11;
491 hash += hash << 15;
492
493 return hash; 611 return strhsh (s);
612 }
613
614 std::size_t operator ()(const shstr &s) const
615 {
616 return strhsh (s);
494 } 617 }
495}; 618};
496 619
497struct str_equal 620struct str_equal
498{ 621{
… …
591 erase (&obj); 714 erase (&obj);
592 } 715 }
593}; 716};
594 717
595// 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)
596void assign (char *dst, const char *src, int maxlen); 720int assign (char *dst, const char *src, int maxsize);
597 721
598// type-safe version of assign 722// type-safe version of assign
599template<int N> 723template<int N>
600inline void assign (char (&dst)[N], const char *src) 724inline int assign (char (&dst)[N], const char *src)
601{ 725{
602 assign ((char *)&dst, src, N); 726 return assign ((char *)&dst, src, N);
603} 727}
604 728
605typedef double tstamp; 729typedef double tstamp;
606 730
607// return current time as timestamp 731// return current time as timestamp
608tstamp now (); 732tstamp now ();
609 733
610int similar_direction (int a, int b); 734int similar_direction (int a, int b);
611 735
612// like sprintf, but returns a "static" buffer 736// like v?sprintf, but returns a "static" buffer
613const 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);
614 742
615///////////////////////////////////////////////////////////////////////////// 743/////////////////////////////////////////////////////////////////////////////
616// threads, very very thin wrappers around pthreads 744// threads, very very thin wrappers around pthreads
617 745
618struct thread 746struct thread

Diff Legend

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