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.87 by root, Mon Jan 12 03:40:21 2009 UTC vs.
Revision 1.121 by root, Sun Nov 11 01:27:44 2012 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,2011,2012 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__
25
26#include <compiler.h>
24 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
… …
94void cleanup (const char *cause, bool make_core = false); 86void cleanup (const char *cause, bool make_core = false);
95void fork_abort (const char *msg); 87void fork_abort (const char *msg);
96 88
97// rationale for using (U) not (T) is to reduce signed/unsigned issues, 89// rationale for using (U) not (T) is to reduce signed/unsigned issues,
98// 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.
99template<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 a < (T)b ? a : (T)b; }
100template<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 a > (T)b ? a : (T)b; }
101template<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; }
102 94
103template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); } 95template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); }
104template<typename T, typename U> static inline void max_it (T &v, U m) { v = max (v, (T)m); } 96template<typename T, typename U> static inline void max_it (T &v, U m) { v = max (v, (T)m); }
105template<typename T, typename U, typename V> static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); } 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); }
… …
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; }
122 118
119//clashes with C++0x
120template<typename T, typename U>
121static inline T copysign (T a, U b) { return a > 0 ? b : -b; }
122
123// div* only work correctly for div > 0
123// div, with correct rounding (< 0.5 downwards, >=0.5 upwards) 124// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
124template<typename T> static inline T div (T val, T div) { return (val + div / 2) / div; } 125template<typename T> static inline T div (T val, T div)
126{
127 return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div;
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
125// div, round-up 133// div, round-up
126template<typename T> static inline T div_ru (T val, T div) { return (val + div - 1) / div; } 134template<typename T> static inline T div_ru (T val, T div)
135{
136 return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div;
137}
127// div, round-down 138// div, round-down
128template<typename T> static inline T div_rd (T val, T div) { return (val ) / div; } 139template<typename T> static inline T div_rd (T val, T div)
140{
141 return expect_false (val < 0) ? - ((-val + (div - 1) ) / div) : (val ) / div;
142}
129 143
144// lerp* only work correctly for min_in < max_in
145// Linear intERPolate, scales val from min_in..max_in to min_out..max_out
130template<typename T> 146template<typename T>
131static inline T 147static inline T
132lerp (T val, T min_in, T max_in, T min_out, T max_out) 148lerp (T val, T min_in, T max_in, T min_out, T max_out)
133{ 149{
134 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in); 150 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in);
… …
193 int32_t d = b - a; 209 int32_t d = b - a;
194 d &= d >> 31; 210 d &= d >> 31;
195 return b - d; 211 return b - d;
196} 212}
197 213
198// this is much faster than crossfires original algorithm 214// this is much faster than crossfire's original algorithm
199// on modern cpus 215// on modern cpus
200inline int 216inline int
201isqrt (int n) 217isqrt (int n)
202{ 218{
203 return (int)sqrtf ((float)n); 219 return (int)sqrtf ((float)n);
220}
221
222// this is kind of like the ^^ operator, if it would exist, without sequence point.
223// more handy than it looks like, due to the implicit !! done on its arguments
224inline bool
225logical_xor (bool a, bool b)
226{
227 return a != b;
228}
229
230inline bool
231logical_implies (bool a, bool b)
232{
233 return a <= b;
204} 234}
205 235
206// this is only twice as fast as naive sqrtf (dx*dy+dy*dy) 236// this is only twice as fast as naive sqrtf (dx*dy+dy*dy)
207#if 0 237#if 0
208// and has a max. error of 6 in the range -100..+100. 238// and has a max. error of 6 in the range -100..+100.
… …
222#else 252#else
223 return dx_ + dy_ - min (dx_, dy_) * 5 / 8; 253 return dx_ + dy_ - min (dx_, dy_) * 5 / 8;
224#endif 254#endif
225} 255}
226 256
257// can be substantially faster than floor, if your value range allows for it
258template<typename T>
259inline T
260fastfloor (T x)
261{
262 return std::floor (x);
263}
264
265inline float
266fastfloor (float x)
267{
268 return sint32(x) - (x < 0);
269}
270
271inline double
272fastfloor (double x)
273{
274 return sint64(x) - (x < 0);
275}
276
227/* 277/*
228 * absdir(int): Returns a number between 1 and 8, which represent 278 * absdir(int): Returns a number between 1 and 8, which represent
229 * the "absolute" direction of a number (it actually takes care of 279 * the "absolute" direction of a number (it actually takes care of
230 * "overflow" in previous calculations of a direction). 280 * "overflow" in previous calculations of a direction).
231 */ 281 */
… …
233absdir (int d) 283absdir (int d)
234{ 284{
235 return ((d - 1) & 7) + 1; 285 return ((d - 1) & 7) + 1;
236} 286}
237 287
288// avoid ctz name because netbsd or freebsd spams it's namespace with it
289#if GCC_VERSION(3,4)
290static inline int least_significant_bit (uint32_t x)
291{
292 return __builtin_ctz (x);
293}
294#else
295int least_significant_bit (uint32_t x);
296#endif
297
298#define for_all_bits_sparse_32(mask, idxvar) \
299 for (uint32_t idxvar, mask_ = mask; \
300 mask_ && ((idxvar = least_significant_bit (mask_)), mask_ &= ~(1 << idxvar), 1);)
301
238extern ssize_t slice_alloc; // statistics 302extern ssize_t slice_alloc; // statistics
239 303
240void *salloc_ (int n) throw (std::bad_alloc); 304void *salloc_ (int n) throw (std::bad_alloc);
241void *salloc_ (int n, void *src) throw (std::bad_alloc); 305void *salloc_ (int n, void *src) throw (std::bad_alloc);
242 306
… …
260 if (expect_true (ptr)) 324 if (expect_true (ptr))
261 { 325 {
262 slice_alloc -= n * sizeof (T); 326 slice_alloc -= n * sizeof (T);
263 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T)); 327 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
264 g_slice_free1 (n * sizeof (T), (void *)ptr); 328 g_slice_free1 (n * sizeof (T), (void *)ptr);
265 assert (slice_alloc >= 0);//D
266 } 329 }
267} 330}
268 331
269// nulls the pointer 332// nulls the pointer
270template<typename T> 333template<typename T>
… …
386 { 449 {
387 p->~Tp (); 450 p->~Tp ();
388 } 451 }
389}; 452};
390 453
391// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. 454// basically a memory area, but refcounted
392// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 455struct refcnt_buf
393// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
394struct tausworthe_random_generator
395{ 456{
396 uint32_t state [4]; 457 char *data;
397 458
398 void operator =(const tausworthe_random_generator &src) 459 refcnt_buf (size_t size = 0);
399 { 460 refcnt_buf (void *data, size_t size);
400 state [0] = src.state [0];
401 state [1] = src.state [1];
402 state [2] = src.state [2];
403 state [3] = src.state [3];
404 }
405 461
406 void seed (uint32_t seed); 462 refcnt_buf (const refcnt_buf &src)
407 uint32_t next ();
408};
409
410// Xorshift RNGs, George Marsaglia
411// http://www.jstatsoft.org/v08/i14/paper
412// this one is about 40% faster than the tausworthe one above (i.e. not much),
413// despite the inlining, and has the issue of only creating 2**32-1 numbers.
414// see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf
415struct xorshift_random_generator
416{
417 uint32_t x, y;
418
419 void operator =(const xorshift_random_generator &src)
420 { 463 {
421 x = src.x; 464 data = src.data;
422 y = src.y; 465 inc ();
423 } 466 }
424 467
425 void seed (uint32_t seed) 468 ~refcnt_buf ();
426 {
427 x = seed;
428 y = seed * 69069U;
429 }
430 469
431 uint32_t next () 470 refcnt_buf &operator =(const refcnt_buf &src);
471
472 operator char *()
432 { 473 {
433 uint32_t t = x ^ (x << 10);
434 x = y;
435 y = y ^ (y >> 13) ^ t ^ (t >> 10);
436 return y; 474 return data;
437 } 475 }
438};
439 476
440template<class generator> 477 size_t size () const
441struct random_number_generator : generator
442{
443 // uniform distribution, 0 .. max (0, num - 1)
444 uint32_t operator ()(uint32_t num)
445 { 478 {
446 return !is_constant (num) ? get_range (num) // non-constant 479 return _size ();
447 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
448 : this->next () & (num - 1); // constant, power-of-two
449 }
450
451 // return a number within (min .. max)
452 int operator () (int r_min, int r_max)
453 {
454 return is_constant (r_min) && is_constant (r_max) && r_min <= r_max
455 ? r_min + operator ()(r_max - r_min + 1)
456 : get_range (r_min, r_max);
457 }
458
459 double operator ()()
460 {
461 return this->next () / (double)0xFFFFFFFFU;
462 } 480 }
463 481
464protected: 482protected:
465 uint32_t get_range (uint32_t r_max); 483 enum {
466 int get_range (int r_min, int r_max); 484 overhead = sizeof (uint32_t) * 2
467}; 485 };
468 486
469typedef random_number_generator<tausworthe_random_generator> rand_gen; 487 uint32_t &_size () const
488 {
489 return ((unsigned int *)data)[-2];
490 }
470 491
471extern rand_gen rndm, rmg_rndm; 492 uint32_t &_refcnt () const
493 {
494 return ((unsigned int *)data)[-1];
495 }
496
497 void _alloc (uint32_t size)
498 {
499 data = ((char *)salloc<char> (size + overhead)) + overhead;
500 _size () = size;
501 _refcnt () = 1;
502 }
503
504 void _dealloc ();
505
506 void inc ()
507 {
508 ++_refcnt ();
509 }
510
511 void dec ()
512 {
513 if (!--_refcnt ())
514 _dealloc ();
515 }
516};
472 517
473INTERFACE_CLASS (attachable) 518INTERFACE_CLASS (attachable)
474struct refcnt_base 519struct refcnt_base
475{ 520{
476 typedef int refcnt_t; 521 typedef int refcnt_t;
… …
538typedef refptr<maptile> maptile_ptr; 583typedef refptr<maptile> maptile_ptr;
539typedef refptr<object> object_ptr; 584typedef refptr<object> object_ptr;
540typedef refptr<archetype> arch_ptr; 585typedef refptr<archetype> arch_ptr;
541typedef refptr<client> client_ptr; 586typedef refptr<client> client_ptr;
542typedef refptr<player> player_ptr; 587typedef refptr<player> player_ptr;
588typedef refptr<region> region_ptr;
589
590#define STRHSH_NULL 2166136261
591
592static inline uint32_t
593strhsh (const char *s)
594{
595 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
596 // it is about twice as fast as the one-at-a-time one,
597 // with good distribution.
598 // FNV-1a is faster on many cpus because the multiplication
599 // runs concurrently with the looping logic.
600 // we modify the hash a bit to improve its distribution
601 uint32_t hash = STRHSH_NULL;
602
603 while (*s)
604 hash = (hash ^ *s++) * 16777619U;
605
606 return hash ^ (hash >> 16);
607}
608
609static inline uint32_t
610memhsh (const char *s, size_t len)
611{
612 uint32_t hash = STRHSH_NULL;
613
614 while (len--)
615 hash = (hash ^ *s++) * 16777619U;
616
617 return hash;
618}
543 619
544struct str_hash 620struct str_hash
545{ 621{
546 std::size_t operator ()(const char *s) const 622 std::size_t operator ()(const char *s) const
547 { 623 {
548#if 0
549 uint32_t hash = 0;
550
551 /* use the one-at-a-time hash function, which supposedly is
552 * better than the djb2-like one used by perl5.005, but
553 * certainly is better then the bug used here before.
554 * see http://burtleburtle.net/bob/hash/doobs.html
555 */
556 while (*s)
557 {
558 hash += *s++;
559 hash += hash << 10;
560 hash ^= hash >> 6;
561 }
562
563 hash += hash << 3;
564 hash ^= hash >> 11;
565 hash += hash << 15;
566#else
567 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
568 // it is about twice as fast as the one-at-a-time one,
569 // with good distribution.
570 // FNV-1a is faster on many cpus because the multiplication
571 // runs concurrent with the looping logic.
572 uint32_t hash = 2166136261;
573
574 while (*s)
575 hash = (hash ^ *s++) * 16777619;
576#endif
577
578 return hash; 624 return strhsh (s);
625 }
626
627 std::size_t operator ()(const shstr &s) const
628 {
629 return strhsh (s);
579 } 630 }
580}; 631};
581 632
582struct str_equal 633struct str_equal
583{ 634{
… …
610 } 661 }
611}; 662};
612 663
613// This container blends advantages of linked lists 664// This container blends advantages of linked lists
614// (efficiency) with vectors (random access) by 665// (efficiency) with vectors (random access) by
615// by using an unordered vector and storing the vector 666// using an unordered vector and storing the vector
616// index inside the object. 667// index inside the object.
617// 668//
618// + memory-efficient on most 64 bit archs 669// + memory-efficient on most 64 bit archs
619// + O(1) insert/remove 670// + O(1) insert/remove
620// + free unique (but varying) id for inserted objects 671// + free unique (but varying) id for inserted objects
… …
657 insert (&obj); 708 insert (&obj);
658 } 709 }
659 710
660 void erase (T *obj) 711 void erase (T *obj)
661 { 712 {
662 unsigned int pos = obj->*indexmember; 713 object_vector_index pos = obj->*indexmember;
663 obj->*indexmember = 0; 714 obj->*indexmember = 0;
664 715
665 if (pos < this->size ()) 716 if (pos < this->size ())
666 { 717 {
667 (*this)[pos - 1] = (*this)[this->size () - 1]; 718 (*this)[pos - 1] = (*this)[this->size () - 1];
… …
675 { 726 {
676 erase (&obj); 727 erase (&obj);
677 } 728 }
678}; 729};
679 730
731/////////////////////////////////////////////////////////////////////////////
732
733// something like a vector or stack, but without
734// out of bounds checking
735template<typename T>
736struct fixed_stack
737{
738 T *data;
739 int size;
740 int max;
741
742 fixed_stack ()
743 : size (0), data (0)
744 {
745 }
746
747 fixed_stack (int max)
748 : size (0), max (max)
749 {
750 data = salloc<T> (max);
751 }
752
753 void reset (int new_max)
754 {
755 sfree (data, max);
756 size = 0;
757 max = new_max;
758 data = salloc<T> (max);
759 }
760
761 void free ()
762 {
763 sfree (data, max);
764 data = 0;
765 }
766
767 ~fixed_stack ()
768 {
769 sfree (data, max);
770 }
771
772 T &operator[](int idx)
773 {
774 return data [idx];
775 }
776
777 void push (T v)
778 {
779 data [size++] = v;
780 }
781
782 T &pop ()
783 {
784 return data [--size];
785 }
786
787 T remove (int idx)
788 {
789 T v = data [idx];
790
791 data [idx] = data [--size];
792
793 return v;
794 }
795};
796
797/////////////////////////////////////////////////////////////////////////////
798
680// basically does what strncpy should do, but appends "..." to strings exceeding length 799// basically does what strncpy should do, but appends "..." to strings exceeding length
681// returns the number of bytes actually used (including \0) 800// returns the number of bytes actually used (including \0)
682int assign (char *dst, const char *src, int maxsize); 801int assign (char *dst, const char *src, int maxsize);
683 802
684// type-safe version of assign 803// type-safe version of assign
… …
693// return current time as timestamp 812// return current time as timestamp
694tstamp now (); 813tstamp now ();
695 814
696int similar_direction (int a, int b); 815int similar_direction (int a, int b);
697 816
698// like sprintf, but returns a "static" buffer 817// like v?sprintf, but returns a "static" buffer
699const char *format (const char *format, ...); 818char *vformat (const char *format, va_list ap);
819char *format (const char *format, ...) attribute ((format (printf, 1, 2)));
820
821// safety-check player input which will become object->msg
822bool msg_is_safe (const char *msg);
700 823
701///////////////////////////////////////////////////////////////////////////// 824/////////////////////////////////////////////////////////////////////////////
702// threads, very very thin wrappers around pthreads 825// threads, very very thin wrappers around pthreads
703 826
704struct thread 827struct thread

Diff Legend

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