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.109 by root, Tue Jun 29 16:52:53 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 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
25#define DEBUG_SALLOC 0 26#include <compiler.h>
26#define PREFER_MALLOC 1
27 27
28#if __GNUC__ >= 3 28#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0
29# define is_constant(c) __builtin_constant_p (c) 29#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs
30# define expect(expr,value) __builtin_expect ((expr),(value)) 30#define PREFER_MALLOC 0 // use malloc and not the slice allocator
31# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
32#else
33# define is_constant(c) 0
34# define expect(expr,value) (expr)
35# define prefetch(addr,rw,locality)
36#endif
37
38#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
39# define decltype(x) typeof(x)
40#endif
41
42// put into ifs if you are very sure that the expression
43// is mostly true or mosty false. note that these return
44// booleans, not the expression.
45#define expect_false(expr) expect ((expr) != 0, 0)
46#define expect_true(expr) expect ((expr) != 0, 1)
47 31
48#include <pthread.h> 32#include <pthread.h>
49 33
50#include <cstddef> 34#include <cstddef>
51#include <cmath> 35#include <cmath>
… …
71#endif 55#endif
72 56
73// 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)
74#define auto(var,expr) decltype(expr) var = (expr) 58#define auto(var,expr) decltype(expr) var = (expr)
75 59
60#if cplusplus_does_not_suck
61// does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm)
62template<typename T, int N>
63static inline int array_length (const T (&arr)[N])
64{
65 return N;
66}
67#else
68#define array_length(name) (sizeof (name) / sizeof (name [0]))
69#endif
70
76// very ugly macro that basicaly declares and initialises a variable 71// very ugly macro that basically declares and initialises a variable
77// that is in scope for the next statement only 72// that is in scope for the next statement only
78// works only for stuff that can be assigned 0 and converts to false 73// works only for stuff that can be assigned 0 and converts to false
79// (note: works great for pointers) 74// (note: works great for pointers)
80// most ugly macro I ever wrote 75// most ugly macro I ever wrote
81#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) 76#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. 90// 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; } 91template<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; } 92template<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; } 93template<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 94
95template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); }
96template<typename T, typename U> static inline void max_it (T &v, U m) { v = max (v, (T)m); }
97template<typename T, typename U, typename V> static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); }
98
100template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } 99template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
101 100
102template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); } 101template<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)); } 102template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
104 103
104// sign returns -1 or +1
105template<typename T>
106static inline T sign (T v) { return v < 0 ? -1 : +1; }
107// relies on 2c representation
108template<>
109inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); }
110template<>
111inline sint16 sign (sint16 v) { return 1 - (sint16 (uint16 (v) >> 15) * 2); }
112template<>
113inline sint32 sign (sint32 v) { return 1 - (sint32 (uint32 (v) >> 31) * 2); }
114
115// sign0 returns -1, 0 or +1
116template<typename T>
117static inline T sign0 (T v) { return v ? sign (v) : 0; }
118
119template<typename T, typename U>
120static inline T copysign (T a, U b) { return a > 0 ? b : -b; }
121
122// div* only work correctly for div > 0
123// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
124template<typename T> static inline T div (T val, T div)
125{
126 return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div;
127}
128
129template<> inline float div (float val, float div) { return val / div; }
130template<> inline double div (double val, double div) { return val / div; }
131
132// div, round-up
133template<typename T> static inline T div_ru (T val, T div)
134{
135 return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div;
136}
137// div, round-down
138template<typename T> static inline T div_rd (T val, T div)
139{
140 return expect_false (val < 0) ? - ((-val + (div - 1) ) / div) : (val ) / div;
141}
142
143// lerp* only work correctly for min_in < max_in
144// Linear intERPolate, scales val from min_in..max_in to min_out..max_out
105template<typename T> 145template<typename T>
106static inline T 146static inline T
107lerp (T val, T min_in, T max_in, T min_out, T max_out) 147lerp (T val, T min_in, T max_in, T min_out, T max_out)
108{ 148{
109 return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; 149 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in);
150}
151
152// lerp, round-down
153template<typename T>
154static inline T
155lerp_rd (T val, T min_in, T max_in, T min_out, T max_out)
156{
157 return min_out + div_rd<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
158}
159
160// lerp, round-up
161template<typename T>
162static inline T
163lerp_ru (T val, T min_in, T max_in, T min_out, T max_out)
164{
165 return min_out + div_ru<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
110} 166}
111 167
112// lots of stuff taken from FXT 168// lots of stuff taken from FXT
113 169
114/* Rotate right. This is used in various places for checksumming */ 170/* Rotate right. This is used in various places for checksumming */
… …
152 int32_t d = b - a; 208 int32_t d = b - a;
153 d &= d >> 31; 209 d &= d >> 31;
154 return b - d; 210 return b - d;
155} 211}
156 212
157// this is much faster than crossfires original algorithm 213// this is much faster than crossfire's original algorithm
158// on modern cpus 214// on modern cpus
159inline int 215inline int
160isqrt (int n) 216isqrt (int n)
161{ 217{
162 return (int)sqrtf ((float)n); 218 return (int)sqrtf ((float)n);
219}
220
221// this is kind of like the ^^ operator, if it would exist, without sequence point.
222// more handy than it looks like, due to the implicit !! done on its arguments
223inline bool
224logical_xor (bool a, bool b)
225{
226 return a != b;
227}
228
229inline bool
230logical_implies (bool a, bool b)
231{
232 return a <= b;
163} 233}
164 234
165// this is only twice as fast as naive sqrtf (dx*dy+dy*dy) 235// this is only twice as fast as naive sqrtf (dx*dy+dy*dy)
166#if 0 236#if 0
167// and has a max. error of 6 in the range -100..+100. 237// and has a max. error of 6 in the range -100..+100.
… …
192absdir (int d) 262absdir (int d)
193{ 263{
194 return ((d - 1) & 7) + 1; 264 return ((d - 1) & 7) + 1;
195} 265}
196 266
267// avoid ctz name because netbsd or freebsd spams it's namespace with it
268#if GCC_VERSION(3,4)
269static inline int least_significant_bit (uint32_t x)
270{
271 return __builtin_ctz (x);
272}
273#else
274int least_significant_bit (uint32_t x);
275#endif
276
277#define for_all_bits_sparse_32(mask, idxvar) \
278 for (uint32_t idxvar, mask_ = mask; \
279 mask_ && ((idxvar = least_significant_bit (mask_)), mask_ &= ~(1 << idxvar), 1);)
280
197extern ssize_t slice_alloc; // statistics 281extern ssize_t slice_alloc; // statistics
198 282
199void *salloc_ (int n) throw (std::bad_alloc); 283void *salloc_ (int n) throw (std::bad_alloc);
200void *salloc_ (int n, void *src) throw (std::bad_alloc); 284void *salloc_ (int n, void *src) throw (std::bad_alloc);
201 285
… …
217inline void sfree (T *ptr, int n = 1) throw () 301inline void sfree (T *ptr, int n = 1) throw ()
218{ 302{
219 if (expect_true (ptr)) 303 if (expect_true (ptr))
220 { 304 {
221 slice_alloc -= n * sizeof (T); 305 slice_alloc -= n * sizeof (T);
306 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
222 g_slice_free1 (n * sizeof (T), (void *)ptr); 307 g_slice_free1 (n * sizeof (T), (void *)ptr);
223 assert (slice_alloc >= 0);//D 308 assert (slice_alloc >= 0);//D
224 } 309 }
225} 310}
226 311
312// nulls the pointer
313template<typename T>
314inline void sfree0 (T *&ptr, int n = 1) throw ()
315{
316 sfree<T> (ptr, n);
317 ptr = 0;
318}
319
227// makes dynamically allocated objects zero-initialised 320// makes dynamically allocated objects zero-initialised
228struct zero_initialised 321struct zero_initialised
229{ 322{
230 void *operator new (size_t s, void *p) 323 void *operator new (size_t s, void *p)
231 { 324 {
… …
239 } 332 }
240 333
241 void *operator new[] (size_t s) 334 void *operator new[] (size_t s)
242 { 335 {
243 return salloc0<char> (s); 336 return salloc0<char> (s);
337 }
338
339 void operator delete (void *p, size_t s)
340 {
341 sfree ((char *)p, s);
342 }
343
344 void operator delete[] (void *p, size_t s)
345 {
346 sfree ((char *)p, s);
347 }
348};
349
350// makes dynamically allocated objects zero-initialised
351struct slice_allocated
352{
353 void *operator new (size_t s, void *p)
354 {
355 return p;
356 }
357
358 void *operator new (size_t s)
359 {
360 return salloc<char> (s);
361 }
362
363 void *operator new[] (size_t s)
364 {
365 return salloc<char> (s);
244 } 366 }
245 367
246 void operator delete (void *p, size_t s) 368 void operator delete (void *p, size_t s)
247 { 369 {
248 sfree ((char *)p, s); 370 sfree ((char *)p, s);
… …
312// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. 434// 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 435// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
314// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps 436// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
315struct tausworthe_random_generator 437struct tausworthe_random_generator
316{ 438{
317 // generator
318 uint32_t state [4]; 439 uint32_t state [4];
319 440
320 void operator =(const tausworthe_random_generator &src) 441 void operator =(const tausworthe_random_generator &src)
321 { 442 {
322 state [0] = src.state [0]; 443 state [0] = src.state [0];
… …
325 state [3] = src.state [3]; 446 state [3] = src.state [3];
326 } 447 }
327 448
328 void seed (uint32_t seed); 449 void seed (uint32_t seed);
329 uint32_t next (); 450 uint32_t next ();
451};
330 452
453// Xorshift RNGs, George Marsaglia
454// http://www.jstatsoft.org/v08/i14/paper
455// this one is about 40% faster than the tausworthe one above (i.e. not much),
456// despite the inlining, and has the issue of only creating 2**32-1 numbers.
457// see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf
458struct xorshift_random_generator
459{
460 uint32_t x, y;
461
462 void operator =(const xorshift_random_generator &src)
463 {
464 x = src.x;
465 y = src.y;
466 }
467
468 void seed (uint32_t seed)
469 {
470 x = seed;
471 y = seed * 69069U;
472 }
473
474 uint32_t next ()
475 {
476 uint32_t t = x ^ (x << 10);
477 x = y;
478 y = y ^ (y >> 13) ^ t ^ (t >> 10);
479 return y;
480 }
481};
482
483template<class generator>
484struct random_number_generator : generator
485{
331 // uniform distribution 486 // uniform distribution, [0 .. num - 1]
332 uint32_t operator ()(uint32_t num) 487 uint32_t operator ()(uint32_t num)
333 { 488 {
334 return is_constant (num) 489 return !is_constant (num) ? get_range (num) // non-constant
335 ? (next () * (uint64_t)num) >> 32U 490 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
336 : get_range (num); 491 : this->next () & (num - 1); // constant, power-of-two
337 } 492 }
338 493
339 // return a number within (min .. max) 494 // return a number within the closed interval [min .. max], max can be >, < or == min.
340 int operator () (int r_min, int r_max) 495 int operator () (int r_min, int r_max)
341 { 496 {
342 return is_constant (r_min) && is_constant (r_max) && r_min <= r_max 497 return is_constant (r_min <= r_max) && r_min <= r_max
343 ? r_min + operator ()(r_max - r_min + 1) 498 ? r_min + operator ()(r_max - r_min + 1)
344 : get_range (r_min, r_max); 499 : get_range (r_min, r_max);
345 } 500 }
346 501
502 // return a number within the half-open interval [0..1[
347 double operator ()() 503 double operator ()()
348 { 504 {
349 return this->next () / (double)0xFFFFFFFFU; 505 return this->next () / (double)0x100000000ULL;
350 } 506 }
351 507
352protected: 508protected:
353 uint32_t get_range (uint32_t r_max); 509 uint32_t get_range (uint32_t r_max);
354 int get_range (int r_min, int r_max); 510 int get_range (int r_min, int r_max);
355}; 511};
356 512
357typedef tausworthe_random_generator rand_gen; 513typedef random_number_generator<tausworthe_random_generator> rand_gen;
358 514
359extern rand_gen rndm; 515extern rand_gen rndm, rmg_rndm;
360 516
361INTERFACE_CLASS (attachable) 517INTERFACE_CLASS (attachable)
362struct refcnt_base 518struct refcnt_base
363{ 519{
364 typedef int refcnt_t; 520 typedef int refcnt_t;
… …
426typedef refptr<maptile> maptile_ptr; 582typedef refptr<maptile> maptile_ptr;
427typedef refptr<object> object_ptr; 583typedef refptr<object> object_ptr;
428typedef refptr<archetype> arch_ptr; 584typedef refptr<archetype> arch_ptr;
429typedef refptr<client> client_ptr; 585typedef refptr<client> client_ptr;
430typedef refptr<player> player_ptr; 586typedef refptr<player> player_ptr;
587typedef refptr<region> region_ptr;
588
589#define STRHSH_NULL 2166136261
590
591static inline uint32_t
592strhsh (const char *s)
593{
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 concurrently with the looping logic.
599 uint32_t hash = STRHSH_NULL;
600
601 while (*s)
602 hash = (hash ^ *s++) * 16777619U;
603
604 return hash;
605}
606
607static inline uint32_t
608memhsh (const char *s, size_t len)
609{
610 uint32_t hash = STRHSH_NULL;
611
612 while (len--)
613 hash = (hash ^ *s++) * 16777619U;
614
615 return hash;
616}
431 617
432struct str_hash 618struct str_hash
433{ 619{
434 std::size_t operator ()(const char *s) const 620 std::size_t operator ()(const char *s) const
435 { 621 {
436 unsigned long hash = 0;
437
438 /* use the one-at-a-time hash function, which supposedly is
439 * better than the djb2-like one used by perl5.005, but
440 * certainly is better then the bug used here before.
441 * see http://burtleburtle.net/bob/hash/doobs.html
442 */
443 while (*s)
444 {
445 hash += *s++;
446 hash += hash << 10;
447 hash ^= hash >> 6;
448 }
449
450 hash += hash << 3;
451 hash ^= hash >> 11;
452 hash += hash << 15;
453
454 return hash; 622 return strhsh (s);
623 }
624
625 std::size_t operator ()(const shstr &s) const
626 {
627 return strhsh (s);
455 } 628 }
456}; 629};
457 630
458struct str_equal 631struct str_equal
459{ 632{
… …
552 erase (&obj); 725 erase (&obj);
553 } 726 }
554}; 727};
555 728
556// basically does what strncpy should do, but appends "..." to strings exceeding length 729// basically does what strncpy should do, but appends "..." to strings exceeding length
730// returns the number of bytes actually used (including \0)
557void assign (char *dst, const char *src, int maxlen); 731int assign (char *dst, const char *src, int maxsize);
558 732
559// type-safe version of assign 733// type-safe version of assign
560template<int N> 734template<int N>
561inline void assign (char (&dst)[N], const char *src) 735inline int assign (char (&dst)[N], const char *src)
562{ 736{
563 assign ((char *)&dst, src, N); 737 return assign ((char *)&dst, src, N);
564} 738}
565 739
566typedef double tstamp; 740typedef double tstamp;
567 741
568// return current time as timestamp 742// return current time as timestamp
569tstamp now (); 743tstamp now ();
570 744
571int similar_direction (int a, int b); 745int similar_direction (int a, int b);
572 746
573// like sprintf, but returns a "static" buffer 747// like v?sprintf, but returns a "static" buffer
574const char *format (const char *format, ...); 748char *vformat (const char *format, va_list ap);
749char *format (const char *format, ...) attribute ((format (printf, 1, 2)));
750
751// safety-check player input which will become object->msg
752bool msg_is_safe (const char *msg);
575 753
576///////////////////////////////////////////////////////////////////////////// 754/////////////////////////////////////////////////////////////////////////////
577// threads, very very thin wrappers around pthreads 755// threads, very very thin wrappers around pthreads
578 756
579struct thread 757struct thread

Diff Legend

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