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.68 by root, Tue Apr 15 03:16:02 2008 UTC vs.
Revision 1.92 by root, Tue Oct 20 05:57:08 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 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
25#define DEBUG_SALLOC 0 26#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0
26#define PREFER_MALLOC 1 27#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs
28#define PREFER_MALLOC 0 // use malloc and not the slice allocator
27 29
28#if __GNUC__ >= 3 30#if __GNUC__ >= 3
29# define is_constant(c) __builtin_constant_p (c) 31# define is_constant(c) __builtin_constant_p (c)
30# define expect(expr,value) __builtin_expect ((expr),(value)) 32# define expect(expr,value) __builtin_expect ((expr),(value))
31# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality) 33# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
34# define noinline __attribute__((__noinline__))
32#else 35#else
33# define is_constant(c) 0 36# define is_constant(c) 0
34# define expect(expr,value) (expr) 37# define expect(expr,value) (expr)
35# define prefetch(addr,rw,locality) 38# define prefetch(addr,rw,locality)
39# define noinline
36#endif 40#endif
37 41
38#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4) 42#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
39# define decltype(x) typeof(x) 43# define decltype(x) typeof(x)
40#endif 44#endif
41 45
42// put into ifs if you are very sure that the expression 46// put into ifs if you are very sure that the expression
43// is mostly true or mosty false. note that these return 47// is mostly true or mosty false. note that these return
44// booleans, not the expression. 48// booleans, not the expression.
45#define expect_false(expr) expect ((expr) != 0, 0) 49#define expect_false(expr) expect ((expr) ? 1 : 0, 0)
46#define expect_true(expr) expect ((expr) != 0, 1) 50#define expect_true(expr) expect ((expr) ? 1 : 0, 1)
47 51
48#include <pthread.h> 52#include <pthread.h>
49 53
50#include <cstddef> 54#include <cstddef>
51#include <cmath> 55#include <cmath>
… …
71#endif 75#endif
72 76
73// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever) 77// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever)
74#define auto(var,expr) decltype(expr) var = (expr) 78#define auto(var,expr) decltype(expr) var = (expr)
75 79
76// very ugly macro that basicaly declares and initialises a variable 80// very ugly macro that basically declares and initialises a variable
77// that is in scope for the next statement only 81// that is in scope for the next statement only
78// works only for stuff that can be assigned 0 and converts to false 82// works only for stuff that can be assigned 0 and converts to false
79// (note: works great for pointers) 83// (note: works great for pointers)
80// most ugly macro I ever wrote 84// most ugly macro I ever wrote
81#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) 85#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1)
… …
95// as a is often a constant while b is the variable. it is still a bug, though. 99// as a is often a constant while b is the variable. it is still a bug, though.
96template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } 100template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; }
97template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } 101template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; }
98template<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; } 102template<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; }
99 103
104template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); }
105template<typename T, typename U> static inline void max_it (T &v, U m) { v = max (v, (T)m); }
106template<typename T, typename U, typename V> static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); }
107
100template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } 108template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
101 109
102template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); } 110template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); }
103template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); } 111template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
104 112
113// sign returns -1 or +1
114template<typename T>
115static inline T sign (T v) { return v < 0 ? -1 : +1; }
116// relies on 2c representation
117template<>
118inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); }
119
120// sign0 returns -1, 0 or +1
121template<typename T>
122static inline T sign0 (T v) { return v ? sign (v) : 0; }
123
124// div* only work correctly for div > 0
125// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
126template<typename T> static inline T div (T val, T div)
127{
128 return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div;
129}
130// div, round-up
131template<typename T> static inline T div_ru (T val, T div)
132{
133 return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div;
134}
135// div, round-down
136template<typename T> static inline T div_rd (T val, T div)
137{
138 return expect_false (val < 0) ? - ((-val + (div - 1) ) / div) : (val ) / div;
139}
140
141// lerp* only work correctly for min_in < max_in
142// Linear intERPolate, scales val from min_in..max_in to min_out..max_out
105template<typename T> 143template<typename T>
106static inline T 144static inline T
107lerp (T val, T min_in, T max_in, T min_out, T max_out) 145lerp (T val, T min_in, T max_in, T min_out, T max_out)
108{ 146{
109 return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; 147 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in);
148}
149
150// lerp, round-down
151template<typename T>
152static inline T
153lerp_rd (T val, T min_in, T max_in, T min_out, T max_out)
154{
155 return min_out + div_rd<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
156}
157
158// lerp, round-up
159template<typename T>
160static inline T
161lerp_ru (T val, T min_in, T max_in, T min_out, T max_out)
162{
163 return min_out + div_ru<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
110} 164}
111 165
112// lots of stuff taken from FXT 166// lots of stuff taken from FXT
113 167
114/* Rotate right. This is used in various places for checksumming */ 168/* Rotate right. This is used in various places for checksumming */
… …
158// on modern cpus 212// on modern cpus
159inline int 213inline int
160isqrt (int n) 214isqrt (int n)
161{ 215{
162 return (int)sqrtf ((float)n); 216 return (int)sqrtf ((float)n);
217}
218
219// this is kind of like the ^^ operator, if it would exist, without sequence point.
220// more handy than it looks like, due to the implicit !! done on its arguments
221inline bool
222logical_xor (bool a, bool b)
223{
224 return a != b;
225}
226
227inline bool
228logical_implies (bool a, bool b)
229{
230 return a <= b;
163} 231}
164 232
165// this is only twice as fast as naive sqrtf (dx*dy+dy*dy) 233// this is only twice as fast as naive sqrtf (dx*dy+dy*dy)
166#if 0 234#if 0
167// and has a max. error of 6 in the range -100..+100. 235// and has a max. error of 6 in the range -100..+100.
… …
217inline void sfree (T *ptr, int n = 1) throw () 285inline void sfree (T *ptr, int n = 1) throw ()
218{ 286{
219 if (expect_true (ptr)) 287 if (expect_true (ptr))
220 { 288 {
221 slice_alloc -= n * sizeof (T); 289 slice_alloc -= n * sizeof (T);
290 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
222 g_slice_free1 (n * sizeof (T), (void *)ptr); 291 g_slice_free1 (n * sizeof (T), (void *)ptr);
223 assert (slice_alloc >= 0);//D 292 assert (slice_alloc >= 0);//D
224 } 293 }
225} 294}
226 295
296// nulls the pointer
297template<typename T>
298inline void sfree0 (T *&ptr, int n = 1) throw ()
299{
300 sfree<T> (ptr, n);
301 ptr = 0;
302}
303
227// makes dynamically allocated objects zero-initialised 304// makes dynamically allocated objects zero-initialised
228struct zero_initialised 305struct zero_initialised
229{ 306{
230 void *operator new (size_t s, void *p) 307 void *operator new (size_t s, void *p)
231 { 308 {
… …
239 } 316 }
240 317
241 void *operator new[] (size_t s) 318 void *operator new[] (size_t s)
242 { 319 {
243 return salloc0<char> (s); 320 return salloc0<char> (s);
321 }
322
323 void operator delete (void *p, size_t s)
324 {
325 sfree ((char *)p, s);
326 }
327
328 void operator delete[] (void *p, size_t s)
329 {
330 sfree ((char *)p, s);
331 }
332};
333
334// makes dynamically allocated objects zero-initialised
335struct slice_allocated
336{
337 void *operator new (size_t s, void *p)
338 {
339 return p;
340 }
341
342 void *operator new (size_t s)
343 {
344 return salloc<char> (s);
345 }
346
347 void *operator new[] (size_t s)
348 {
349 return salloc<char> (s);
244 } 350 }
245 351
246 void operator delete (void *p, size_t s) 352 void operator delete (void *p, size_t s)
247 { 353 {
248 sfree ((char *)p, s); 354 sfree ((char *)p, s);
… …
312// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. 418// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213.
313// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 419// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
314// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps 420// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
315struct tausworthe_random_generator 421struct tausworthe_random_generator
316{ 422{
317 // generator
318 uint32_t state [4]; 423 uint32_t state [4];
319 424
320 void operator =(const tausworthe_random_generator &src) 425 void operator =(const tausworthe_random_generator &src)
321 { 426 {
322 state [0] = src.state [0]; 427 state [0] = src.state [0];
… …
325 state [3] = src.state [3]; 430 state [3] = src.state [3];
326 } 431 }
327 432
328 void seed (uint32_t seed); 433 void seed (uint32_t seed);
329 uint32_t next (); 434 uint32_t next ();
435};
330 436
331 // uniform distribution 437// Xorshift RNGs, George Marsaglia
438// http://www.jstatsoft.org/v08/i14/paper
439// this one is about 40% faster than the tausworthe one above (i.e. not much),
440// despite the inlining, and has the issue of only creating 2**32-1 numbers.
441// see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf
442struct xorshift_random_generator
443{
444 uint32_t x, y;
445
446 void operator =(const xorshift_random_generator &src)
447 {
448 x = src.x;
449 y = src.y;
450 }
451
452 void seed (uint32_t seed)
453 {
454 x = seed;
455 y = seed * 69069U;
456 }
457
458 uint32_t next ()
459 {
460 uint32_t t = x ^ (x << 10);
461 x = y;
462 y = y ^ (y >> 13) ^ t ^ (t >> 10);
463 return y;
464 }
465};
466
467template<class generator>
468struct random_number_generator : generator
469{
470 // uniform distribution, 0 .. max (0, num - 1)
332 uint32_t operator ()(uint32_t num) 471 uint32_t operator ()(uint32_t num)
333 { 472 {
334 return is_constant (num) 473 return !is_constant (num) ? get_range (num) // non-constant
335 ? (next () * (uint64_t)num) >> 32U 474 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
336 : get_range (num); 475 : this->next () & (num - 1); // constant, power-of-two
337 } 476 }
338 477
339 // return a number within (min .. max) 478 // return a number within (min .. max)
340 int operator () (int r_min, int r_max) 479 int operator () (int r_min, int r_max)
341 { 480 {
… …
352protected: 491protected:
353 uint32_t get_range (uint32_t r_max); 492 uint32_t get_range (uint32_t r_max);
354 int get_range (int r_min, int r_max); 493 int get_range (int r_min, int r_max);
355}; 494};
356 495
357typedef tausworthe_random_generator rand_gen; 496typedef random_number_generator<tausworthe_random_generator> rand_gen;
358 497
359extern rand_gen rndm; 498extern rand_gen rndm, rmg_rndm;
360 499
361INTERFACE_CLASS (attachable) 500INTERFACE_CLASS (attachable)
362struct refcnt_base 501struct refcnt_base
363{ 502{
364 typedef int refcnt_t; 503 typedef int refcnt_t;
… …
431 570
432struct str_hash 571struct str_hash
433{ 572{
434 std::size_t operator ()(const char *s) const 573 std::size_t operator ()(const char *s) const
435 { 574 {
436 unsigned long hash = 0; 575#if 0
576 uint32_t hash = 0;
437 577
438 /* use the one-at-a-time hash function, which supposedly is 578 /* use the one-at-a-time hash function, which supposedly is
439 * better than the djb2-like one used by perl5.005, but 579 * better than the djb2-like one used by perl5.005, but
440 * certainly is better then the bug used here before. 580 * certainly is better then the bug used here before.
441 * see http://burtleburtle.net/bob/hash/doobs.html 581 * see http://burtleburtle.net/bob/hash/doobs.html
… …
448 } 588 }
449 589
450 hash += hash << 3; 590 hash += hash << 3;
451 hash ^= hash >> 11; 591 hash ^= hash >> 11;
452 hash += hash << 15; 592 hash += hash << 15;
593#else
594 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
595 // it is about twice as fast as the one-at-a-time one,
596 // with good distribution.
597 // FNV-1a is faster on many cpus because the multiplication
598 // runs concurrent with the looping logic.
599 uint32_t hash = 2166136261;
600
601 while (*s)
602 hash = (hash ^ *s++) * 16777619;
603#endif
453 604
454 return hash; 605 return hash;
455 } 606 }
456}; 607};
457 608
… …
552 erase (&obj); 703 erase (&obj);
553 } 704 }
554}; 705};
555 706
556// basically does what strncpy should do, but appends "..." to strings exceeding length 707// basically does what strncpy should do, but appends "..." to strings exceeding length
708// returns the number of bytes actually used (including \0)
557void assign (char *dst, const char *src, int maxlen); 709int assign (char *dst, const char *src, int maxsize);
558 710
559// type-safe version of assign 711// type-safe version of assign
560template<int N> 712template<int N>
561inline void assign (char (&dst)[N], const char *src) 713inline int assign (char (&dst)[N], const char *src)
562{ 714{
563 assign ((char *)&dst, src, N); 715 return assign ((char *)&dst, src, N);
564} 716}
565 717
566typedef double tstamp; 718typedef double tstamp;
567 719
568// return current time as timestamp 720// return current time as timestamp
569tstamp now (); 721tstamp now ();
570 722
571int similar_direction (int a, int b); 723int similar_direction (int a, int b);
572 724
573// like sprintf, but returns a "static" buffer 725// like v?sprintf, but returns a "static" buffer
726char *vformat (const char *format, va_list ap);
574const char *format (const char *format, ...); 727char *format (const char *format, ...);
728
729// safety-check player input which will become object->msg
730bool msg_is_safe (const char *msg);
575 731
576///////////////////////////////////////////////////////////////////////////// 732/////////////////////////////////////////////////////////////////////////////
577// threads, very very thin wrappers around pthreads 733// threads, very very thin wrappers around pthreads
578 734
579struct thread 735struct thread

Diff Legend

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