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.92 by root, Tue Oct 20 05:57:08 2009 UTC vs.
Revision 1.113 by root, Fri Apr 22 02:03:11 2011 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 it under 6 * Deliantra is free software: you can redistribute it and/or modify it under
7 * the terms of the Affero GNU General Public License as published by the 7 * the terms of the Affero GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your 8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version. 9 * option) any later version.
21 */ 21 */
22 22
23#ifndef UTIL_H__ 23#ifndef UTIL_H__
24#define UTIL_H__ 24#define UTIL_H__
25 25
26#include <compiler.h>
27
26#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0 28#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0
27#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs 29#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs
28#define PREFER_MALLOC 0 // use malloc and not the slice allocator 30#define PREFER_MALLOC 0 // use malloc and not the slice allocator
29
30#if __GNUC__ >= 3
31# define is_constant(c) __builtin_constant_p (c)
32# define expect(expr,value) __builtin_expect ((expr),(value))
33# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
34# define noinline __attribute__((__noinline__))
35#else
36# define is_constant(c) 0
37# define expect(expr,value) (expr)
38# define prefetch(addr,rw,locality)
39# define noinline
40#endif
41
42#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
43# define decltype(x) typeof(x)
44#endif
45
46// put into ifs if you are very sure that the expression
47// is mostly true or mosty false. note that these return
48// booleans, not the expression.
49#define expect_false(expr) expect ((expr) ? 1 : 0, 0)
50#define expect_true(expr) expect ((expr) ? 1 : 0, 1)
51 31
52#include <pthread.h> 32#include <pthread.h>
53 33
54#include <cstddef> 34#include <cstddef>
55#include <cmath> 35#include <cmath>
75#endif 55#endif
76 56
77// 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)
78#define auto(var,expr) decltype(expr) var = (expr) 58#define auto(var,expr) decltype(expr) var = (expr)
79 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
80// very ugly macro that basically declares and initialises a variable 71// very ugly macro that basically declares and initialises a variable
81// that is in scope for the next statement only 72// that is in scope for the next statement only
82// 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
83// (note: works great for pointers) 74// (note: works great for pointers)
84// most ugly macro I ever wrote 75// most ugly macro I ever wrote
113// sign returns -1 or +1 104// sign returns -1 or +1
114template<typename T> 105template<typename T>
115static inline T sign (T v) { return v < 0 ? -1 : +1; } 106static inline T sign (T v) { return v < 0 ? -1 : +1; }
116// relies on 2c representation 107// relies on 2c representation
117template<> 108template<>
118inline 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); }
119 114
120// sign0 returns -1, 0 or +1 115// sign0 returns -1, 0 or +1
121template<typename T> 116template<typename T>
122static inline T sign0 (T v) { return v ? sign (v) : 0; } 117static inline T sign0 (T v) { return v ? sign (v) : 0; }
118
119//clashes with C++0x
120template<typename T, typename U>
121static inline T copysign (T a, U b) { return a > 0 ? b : -b; }
123 122
124// div* only work correctly for div > 0 123// div* only work correctly for div > 0
125// div, with correct rounding (< 0.5 downwards, >=0.5 upwards) 124// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
126template<typename T> static inline T div (T val, T div) 125template<typename T> static inline T div (T val, T div)
127{ 126{
128 return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div; 127 return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div;
129} 128}
129
130template<> inline float div (float val, float div) { return val / div; }
131template<> inline double div (double val, double div) { return val / div; }
132
130// div, round-up 133// div, round-up
131template<typename T> static inline T div_ru (T val, T div) 134template<typename T> static inline T div_ru (T val, T div)
132{ 135{
133 return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div; 136 return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div;
134} 137}
206 int32_t d = b - a; 209 int32_t d = b - a;
207 d &= d >> 31; 210 d &= d >> 31;
208 return b - d; 211 return b - d;
209} 212}
210 213
211// this is much faster than crossfires original algorithm 214// this is much faster than crossfire's original algorithm
212// on modern cpus 215// on modern cpus
213inline int 216inline int
214isqrt (int n) 217isqrt (int n)
215{ 218{
216 return (int)sqrtf ((float)n); 219 return (int)sqrtf ((float)n);
260absdir (int d) 263absdir (int d)
261{ 264{
262 return ((d - 1) & 7) + 1; 265 return ((d - 1) & 7) + 1;
263} 266}
264 267
268// avoid ctz name because netbsd or freebsd spams it's namespace with it
269#if GCC_VERSION(3,4)
270static inline int least_significant_bit (uint32_t x)
271{
272 return __builtin_ctz (x);
273}
274#else
275int least_significant_bit (uint32_t x);
276#endif
277
278#define for_all_bits_sparse_32(mask, idxvar) \
279 for (uint32_t idxvar, mask_ = mask; \
280 mask_ && ((idxvar = least_significant_bit (mask_)), mask_ &= ~(1 << idxvar), 1);)
281
265extern ssize_t slice_alloc; // statistics 282extern ssize_t slice_alloc; // statistics
266 283
267void *salloc_ (int n) throw (std::bad_alloc); 284void *salloc_ (int n) throw (std::bad_alloc);
268void *salloc_ (int n, void *src) throw (std::bad_alloc); 285void *salloc_ (int n, void *src) throw (std::bad_alloc);
269 286
413 { 430 {
414 p->~Tp (); 431 p->~Tp ();
415 } 432 }
416}; 433};
417 434
418// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213.
419// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
420// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
421struct tausworthe_random_generator
422{
423 uint32_t state [4];
424
425 void operator =(const tausworthe_random_generator &src)
426 {
427 state [0] = src.state [0];
428 state [1] = src.state [1];
429 state [2] = src.state [2];
430 state [3] = src.state [3];
431 }
432
433 void seed (uint32_t seed);
434 uint32_t next ();
435};
436
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)
471 uint32_t operator ()(uint32_t num)
472 {
473 return !is_constant (num) ? get_range (num) // non-constant
474 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
475 : this->next () & (num - 1); // constant, power-of-two
476 }
477
478 // return a number within (min .. max)
479 int operator () (int r_min, int r_max)
480 {
481 return is_constant (r_min) && is_constant (r_max) && r_min <= r_max
482 ? r_min + operator ()(r_max - r_min + 1)
483 : get_range (r_min, r_max);
484 }
485
486 double operator ()()
487 {
488 return this->next () / (double)0xFFFFFFFFU;
489 }
490
491protected:
492 uint32_t get_range (uint32_t r_max);
493 int get_range (int r_min, int r_max);
494};
495
496typedef random_number_generator<tausworthe_random_generator> rand_gen;
497
498extern rand_gen rndm, rmg_rndm;
499
500INTERFACE_CLASS (attachable) 435INTERFACE_CLASS (attachable)
501struct refcnt_base 436struct refcnt_base
502{ 437{
503 typedef int refcnt_t; 438 typedef int refcnt_t;
504 mutable refcnt_t ACC (RW, refcnt); 439 mutable refcnt_t ACC (RW, refcnt);
565typedef refptr<maptile> maptile_ptr; 500typedef refptr<maptile> maptile_ptr;
566typedef refptr<object> object_ptr; 501typedef refptr<object> object_ptr;
567typedef refptr<archetype> arch_ptr; 502typedef refptr<archetype> arch_ptr;
568typedef refptr<client> client_ptr; 503typedef refptr<client> client_ptr;
569typedef refptr<player> player_ptr; 504typedef refptr<player> player_ptr;
505typedef refptr<region> region_ptr;
506
507#define STRHSH_NULL 2166136261
508
509static inline uint32_t
510strhsh (const char *s)
511{
512 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
513 // it is about twice as fast as the one-at-a-time one,
514 // with good distribution.
515 // FNV-1a is faster on many cpus because the multiplication
516 // runs concurrently with the looping logic.
517 // we modify the hash a bit to improve its distribution
518 uint32_t hash = STRHSH_NULL;
519
520 while (*s)
521 hash = (hash ^ *s++) * 16777619U;
522
523 return hash ^ (hash >> 16);
524}
525
526static inline uint32_t
527memhsh (const char *s, size_t len)
528{
529 uint32_t hash = STRHSH_NULL;
530
531 while (len--)
532 hash = (hash ^ *s++) * 16777619U;
533
534 return hash;
535}
570 536
571struct str_hash 537struct str_hash
572{ 538{
573 std::size_t operator ()(const char *s) const 539 std::size_t operator ()(const char *s) const
574 { 540 {
575#if 0
576 uint32_t hash = 0;
577
578 /* use the one-at-a-time hash function, which supposedly is
579 * better than the djb2-like one used by perl5.005, but
580 * certainly is better then the bug used here before.
581 * see http://burtleburtle.net/bob/hash/doobs.html
582 */
583 while (*s)
584 {
585 hash += *s++;
586 hash += hash << 10;
587 hash ^= hash >> 6;
588 }
589
590 hash += hash << 3;
591 hash ^= hash >> 11;
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
604
605 return hash; 541 return strhsh (s);
542 }
543
544 std::size_t operator ()(const shstr &s) const
545 {
546 return strhsh (s);
606 } 547 }
607}; 548};
608 549
609struct str_equal 550struct str_equal
610{ 551{
702 { 643 {
703 erase (&obj); 644 erase (&obj);
704 } 645 }
705}; 646};
706 647
648/////////////////////////////////////////////////////////////////////////////
649
650// something like a vector or stack, but without
651// out of bounds checking
652template<typename T>
653struct fixed_stack
654{
655 T *data;
656 int size;
657 int max;
658
659 fixed_stack ()
660 : size (0), data (0)
661 {
662 }
663
664 fixed_stack (int max)
665 : size (0), max (max)
666 {
667 data = salloc<T> (max);
668 }
669
670 void reset (int new_max)
671 {
672 sfree (data, max);
673 size = 0;
674 max = new_max;
675 data = salloc<T> (max);
676 }
677
678 void free ()
679 {
680 sfree (data, max);
681 data = 0;
682 }
683
684 ~fixed_stack ()
685 {
686 sfree (data, max);
687 }
688
689 T &operator[](int idx)
690 {
691 return data [idx];
692 }
693
694 void push (T v)
695 {
696 data [size++] = v;
697 }
698
699 T &pop ()
700 {
701 return data [--size];
702 }
703
704 T remove (int idx)
705 {
706 T v = data [idx];
707
708 data [idx] = data [--size];
709
710 return v;
711 }
712};
713
714/////////////////////////////////////////////////////////////////////////////
715
707// basically does what strncpy should do, but appends "..." to strings exceeding length 716// basically does what strncpy should do, but appends "..." to strings exceeding length
708// returns the number of bytes actually used (including \0) 717// returns the number of bytes actually used (including \0)
709int assign (char *dst, const char *src, int maxsize); 718int assign (char *dst, const char *src, int maxsize);
710 719
711// type-safe version of assign 720// type-safe version of assign
722 731
723int similar_direction (int a, int b); 732int similar_direction (int a, int b);
724 733
725// like v?sprintf, but returns a "static" buffer 734// like v?sprintf, but returns a "static" buffer
726char *vformat (const char *format, va_list ap); 735char *vformat (const char *format, va_list ap);
727char *format (const char *format, ...); 736char *format (const char *format, ...) attribute ((format (printf, 1, 2)));
728 737
729// safety-check player input which will become object->msg 738// safety-check player input which will become object->msg
730bool msg_is_safe (const char *msg); 739bool msg_is_safe (const char *msg);
731 740
732///////////////////////////////////////////////////////////////////////////// 741/////////////////////////////////////////////////////////////////////////////

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines