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.88 by root, Tue May 5 04:51:56 2009 UTC vs.
Revision 1.112 by root, Tue Jul 6 20:15:13 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#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
79// very ugly macro that basically declares and initialises a variable 71// very ugly macro that basically declares and initialises a variable
80// that is in scope for the next statement only 72// that is in scope for the next statement only
81// 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
82// (note: works great for pointers) 74// (note: works great for pointers)
83// most ugly macro I ever wrote 75// most ugly macro I ever wrote
… …
112// sign returns -1 or +1 104// sign returns -1 or +1
113template<typename T> 105template<typename T>
114static inline T sign (T v) { return v < 0 ? -1 : +1; } 106static inline T sign (T v) { return v < 0 ? -1 : +1; }
115// relies on 2c representation 107// relies on 2c representation
116template<> 108template<>
117inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); } 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); }
118 114
119// sign0 returns -1, 0 or +1 115// sign0 returns -1, 0 or +1
120template<typename T> 116template<typename T>
121static inline T sign0 (T v) { return v ? sign (v) : 0; } 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; }
122 121
123// div* only work correctly for div > 0 122// div* only work correctly for div > 0
124// div, with correct rounding (< 0.5 downwards, >=0.5 upwards) 123// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
125template<typename T> static inline T div (T val, T div) 124template<typename T> static inline T div (T val, T div)
126{ 125{
127 return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div; 126 return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div;
128} 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
129// div, round-up 132// div, round-up
130template<typename T> static inline T div_ru (T val, T div) 133template<typename T> static inline T div_ru (T val, T div)
131{ 134{
132 return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div; 135 return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div;
133} 136}
… …
205 int32_t d = b - a; 208 int32_t d = b - a;
206 d &= d >> 31; 209 d &= d >> 31;
207 return b - d; 210 return b - d;
208} 211}
209 212
210// this is much faster than crossfires original algorithm 213// this is much faster than crossfire's original algorithm
211// on modern cpus 214// on modern cpus
212inline int 215inline int
213isqrt (int n) 216isqrt (int n)
214{ 217{
215 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;
216} 233}
217 234
218// 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)
219#if 0 236#if 0
220// 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.
… …
245absdir (int d) 262absdir (int d)
246{ 263{
247 return ((d - 1) & 7) + 1; 264 return ((d - 1) & 7) + 1;
248} 265}
249 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
250extern ssize_t slice_alloc; // statistics 281extern ssize_t slice_alloc; // statistics
251 282
252void *salloc_ (int n) throw (std::bad_alloc); 283void *salloc_ (int n) throw (std::bad_alloc);
253void *salloc_ (int n, void *src) throw (std::bad_alloc); 284void *salloc_ (int n, void *src) throw (std::bad_alloc);
254 285
… …
398 { 429 {
399 p->~Tp (); 430 p->~Tp ();
400 } 431 }
401}; 432};
402 433
403// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213.
404// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
405// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
406struct tausworthe_random_generator
407{
408 uint32_t state [4];
409
410 void operator =(const tausworthe_random_generator &src)
411 {
412 state [0] = src.state [0];
413 state [1] = src.state [1];
414 state [2] = src.state [2];
415 state [3] = src.state [3];
416 }
417
418 void seed (uint32_t seed);
419 uint32_t next ();
420};
421
422// Xorshift RNGs, George Marsaglia
423// http://www.jstatsoft.org/v08/i14/paper
424// this one is about 40% faster than the tausworthe one above (i.e. not much),
425// despite the inlining, and has the issue of only creating 2**32-1 numbers.
426// see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf
427struct xorshift_random_generator
428{
429 uint32_t x, y;
430
431 void operator =(const xorshift_random_generator &src)
432 {
433 x = src.x;
434 y = src.y;
435 }
436
437 void seed (uint32_t seed)
438 {
439 x = seed;
440 y = seed * 69069U;
441 }
442
443 uint32_t next ()
444 {
445 uint32_t t = x ^ (x << 10);
446 x = y;
447 y = y ^ (y >> 13) ^ t ^ (t >> 10);
448 return y;
449 }
450};
451
452template<class generator>
453struct random_number_generator : generator
454{
455 // uniform distribution, 0 .. max (0, num - 1)
456 uint32_t operator ()(uint32_t num)
457 {
458 return !is_constant (num) ? get_range (num) // non-constant
459 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
460 : this->next () & (num - 1); // constant, power-of-two
461 }
462
463 // return a number within (min .. max)
464 int operator () (int r_min, int r_max)
465 {
466 return is_constant (r_min) && is_constant (r_max) && r_min <= r_max
467 ? r_min + operator ()(r_max - r_min + 1)
468 : get_range (r_min, r_max);
469 }
470
471 double operator ()()
472 {
473 return this->next () / (double)0xFFFFFFFFU;
474 }
475
476protected:
477 uint32_t get_range (uint32_t r_max);
478 int get_range (int r_min, int r_max);
479};
480
481typedef random_number_generator<tausworthe_random_generator> rand_gen;
482
483extern rand_gen rndm, rmg_rndm;
484
485INTERFACE_CLASS (attachable) 434INTERFACE_CLASS (attachable)
486struct refcnt_base 435struct refcnt_base
487{ 436{
488 typedef int refcnt_t; 437 typedef int refcnt_t;
489 mutable refcnt_t ACC (RW, refcnt); 438 mutable refcnt_t ACC (RW, refcnt);
… …
550typedef refptr<maptile> maptile_ptr; 499typedef refptr<maptile> maptile_ptr;
551typedef refptr<object> object_ptr; 500typedef refptr<object> object_ptr;
552typedef refptr<archetype> arch_ptr; 501typedef refptr<archetype> arch_ptr;
553typedef refptr<client> client_ptr; 502typedef refptr<client> client_ptr;
554typedef refptr<player> player_ptr; 503typedef refptr<player> player_ptr;
504typedef refptr<region> region_ptr;
505
506#define STRHSH_NULL 2166136261
507
508static inline uint32_t
509strhsh (const char *s)
510{
511 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
512 // it is about twice as fast as the one-at-a-time one,
513 // with good distribution.
514 // FNV-1a is faster on many cpus because the multiplication
515 // runs concurrently with the looping logic.
516 // we modify the hash a bit to improve its distribution
517 uint32_t hash = STRHSH_NULL;
518
519 while (*s)
520 hash = (hash ^ *s++) * 16777619U;
521
522 return hash ^ (hash >> 16);
523}
524
525static inline uint32_t
526memhsh (const char *s, size_t len)
527{
528 uint32_t hash = STRHSH_NULL;
529
530 while (len--)
531 hash = (hash ^ *s++) * 16777619U;
532
533 return hash;
534}
555 535
556struct str_hash 536struct str_hash
557{ 537{
558 std::size_t operator ()(const char *s) const 538 std::size_t operator ()(const char *s) const
559 { 539 {
560#if 0
561 uint32_t hash = 0;
562
563 /* use the one-at-a-time hash function, which supposedly is
564 * better than the djb2-like one used by perl5.005, but
565 * certainly is better then the bug used here before.
566 * see http://burtleburtle.net/bob/hash/doobs.html
567 */
568 while (*s)
569 {
570 hash += *s++;
571 hash += hash << 10;
572 hash ^= hash >> 6;
573 }
574
575 hash += hash << 3;
576 hash ^= hash >> 11;
577 hash += hash << 15;
578#else
579 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
580 // it is about twice as fast as the one-at-a-time one,
581 // with good distribution.
582 // FNV-1a is faster on many cpus because the multiplication
583 // runs concurrent with the looping logic.
584 uint32_t hash = 2166136261;
585
586 while (*s)
587 hash = (hash ^ *s++) * 16777619;
588#endif
589
590 return hash; 540 return strhsh (s);
541 }
542
543 std::size_t operator ()(const shstr &s) const
544 {
545 return strhsh (s);
591 } 546 }
592}; 547};
593 548
594struct str_equal 549struct str_equal
595{ 550{
… …
687 { 642 {
688 erase (&obj); 643 erase (&obj);
689 } 644 }
690}; 645};
691 646
647/////////////////////////////////////////////////////////////////////////////
648
649// something like a vector or stack, but without
650// out of bounds checking
651template<typename T>
652struct fixed_stack
653{
654 T *data;
655 int size;
656 int max;
657
658 fixed_stack ()
659 : size (0), data (0)
660 {
661 }
662
663 fixed_stack (int max)
664 : size (0), max (max)
665 {
666 data = salloc<T> (max);
667 }
668
669 void reset (int new_max)
670 {
671 sfree (data, max);
672 size = 0;
673 max = new_max;
674 data = salloc<T> (max);
675 }
676
677 void free ()
678 {
679 sfree (data, max);
680 data = 0;
681 }
682
683 ~fixed_stack ()
684 {
685 sfree (data, max);
686 }
687
688 T &operator[](int idx)
689 {
690 return data [idx];
691 }
692
693 void push (T v)
694 {
695 data [size++] = v;
696 }
697
698 T &pop ()
699 {
700 return data [--size];
701 }
702
703 T remove (int idx)
704 {
705 T v = data [idx];
706
707 data [idx] = data [--size];
708
709 return v;
710 }
711};
712
713/////////////////////////////////////////////////////////////////////////////
714
692// basically does what strncpy should do, but appends "..." to strings exceeding length 715// basically does what strncpy should do, but appends "..." to strings exceeding length
693// returns the number of bytes actually used (including \0) 716// returns the number of bytes actually used (including \0)
694int assign (char *dst, const char *src, int maxsize); 717int assign (char *dst, const char *src, int maxsize);
695 718
696// type-safe version of assign 719// type-safe version of assign
… …
705// return current time as timestamp 728// return current time as timestamp
706tstamp now (); 729tstamp now ();
707 730
708int similar_direction (int a, int b); 731int similar_direction (int a, int b);
709 732
710// like sprintf, but returns a "static" buffer 733// like v?sprintf, but returns a "static" buffer
711const char *format (const char *format, ...); 734char *vformat (const char *format, va_list ap);
735char *format (const char *format, ...) attribute ((format (printf, 1, 2)));
736
737// safety-check player input which will become object->msg
738bool msg_is_safe (const char *msg);
712 739
713///////////////////////////////////////////////////////////////////////////// 740/////////////////////////////////////////////////////////////////////////////
714// threads, very very thin wrappers around pthreads 741// threads, very very thin wrappers around pthreads
715 742
716struct thread 743struct thread

Diff Legend

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