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.90 by root, Mon Oct 12 14:00:58 2009 UTC vs.
Revision 1.123 by root, Wed Nov 16 23:42:01 2016 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,2013,2014,2015,2016 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.
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 Affero GNU General Public License 16 * You should have received a copy of the Affero GNU General Public License
17 * and the GNU General Public License along with this program. If not, see 17 * and the GNU General Public License along with this program. If not, see
18 * <http://www.gnu.org/licenses/>. 18 * <http://www.gnu.org/licenses/>.
19 * 19 *
20 * 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>
21 */ 21 */
22 22
23#ifndef UTIL_H__ 23#ifndef UTIL_H__
24#define UTIL_H__ 24#define UTIL_H__
25
26#include <compiler.h>
25 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
… …
95void cleanup (const char *cause, bool make_core = false); 86void cleanup (const char *cause, bool make_core = false);
96void fork_abort (const char *msg); 87void fork_abort (const char *msg);
97 88
98// 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,
99// 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.
100template<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; }
101template<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; }
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; } 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; }
103 94
104template<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); }
105template<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); }
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); } 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); }
… …
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);
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;
217} 234}
218 235
219// 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)
220#if 0 237#if 0
221// 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 239#else
223// and has a max. error of 9 in the range -100..+100. 240// and has a max. error of 9 in the range -100..+100.
224#endif 241#endif
225inline int 242inline int
226idistance (int dx, int dy) 243idistance (int dx, int dy)
227{ 244{
228 unsigned int dx_ = abs (dx); 245 unsigned int dx_ = abs (dx);
229 unsigned int dy_ = abs (dy); 246 unsigned int dy_ = abs (dy);
230 247
231#if 0 248#if 0
232 return dx_ > dy_ 249 return dx_ > dy_
… …
235#else 252#else
236 return dx_ + dy_ - min (dx_, dy_) * 5 / 8; 253 return dx_ + dy_ - min (dx_, dy_) * 5 / 8;
237#endif 254#endif
238} 255}
239 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
240/* 277/*
241 * absdir(int): Returns a number between 1 and 8, which represent 278 * absdir(int): Returns a number between 1 and 8, which represent
242 * the "absolute" direction of a number (it actually takes care of 279 * the "absolute" direction of a number (it actually takes care of
243 * "overflow" in previous calculations of a direction). 280 * "overflow" in previous calculations of a direction).
244 */ 281 */
… …
246absdir (int d) 283absdir (int d)
247{ 284{
248 return ((d - 1) & 7) + 1; 285 return ((d - 1) & 7) + 1;
249} 286}
250 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
251extern ssize_t slice_alloc; // statistics 302extern ssize_t slice_alloc; // statistics
252 303
253void *salloc_ (int n) throw (std::bad_alloc); 304void *salloc_ (int n) throw (std::bad_alloc);
254void *salloc_ (int n, void *src) throw (std::bad_alloc); 305void *salloc_ (int n, void *src) throw (std::bad_alloc);
255 306
… …
273 if (expect_true (ptr)) 324 if (expect_true (ptr))
274 { 325 {
275 slice_alloc -= n * sizeof (T); 326 slice_alloc -= n * sizeof (T);
276 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T)); 327 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
277 g_slice_free1 (n * sizeof (T), (void *)ptr); 328 g_slice_free1 (n * sizeof (T), (void *)ptr);
278 assert (slice_alloc >= 0);//D
279 } 329 }
280} 330}
281 331
282// nulls the pointer 332// nulls the pointer
283template<typename T> 333template<typename T>
… …
357 typedef const Tp *const_pointer; 407 typedef const Tp *const_pointer;
358 typedef Tp &reference; 408 typedef Tp &reference;
359 typedef const Tp &const_reference; 409 typedef const Tp &const_reference;
360 typedef Tp value_type; 410 typedef Tp value_type;
361 411
362 template <class U> 412 template <class U>
363 struct rebind 413 struct rebind
364 { 414 {
365 typedef slice_allocator<U> other; 415 typedef slice_allocator<U> other;
366 }; 416 };
367 417
… …
399 { 449 {
400 p->~Tp (); 450 p->~Tp ();
401 } 451 }
402}; 452};
403 453
404// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. 454// basically a memory area, but refcounted
405// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 455struct refcnt_buf
406// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
407struct tausworthe_random_generator
408{ 456{
409 uint32_t state [4]; 457 char *data;
410 458
411 void operator =(const tausworthe_random_generator &src) 459 refcnt_buf (size_t size = 0);
412 { 460 refcnt_buf (void *data, size_t size);
413 state [0] = src.state [0];
414 state [1] = src.state [1];
415 state [2] = src.state [2];
416 state [3] = src.state [3];
417 }
418 461
419 void seed (uint32_t seed); 462 refcnt_buf (const refcnt_buf &src)
420 uint32_t next ();
421};
422
423// Xorshift RNGs, George Marsaglia
424// http://www.jstatsoft.org/v08/i14/paper
425// this one is about 40% faster than the tausworthe one above (i.e. not much),
426// despite the inlining, and has the issue of only creating 2**32-1 numbers.
427// see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf
428struct xorshift_random_generator
429{
430 uint32_t x, y;
431
432 void operator =(const xorshift_random_generator &src)
433 { 463 {
434 x = src.x; 464 data = src.data;
435 y = src.y; 465 inc ();
436 } 466 }
437 467
438 void seed (uint32_t seed) 468 ~refcnt_buf ();
439 {
440 x = seed;
441 y = seed * 69069U;
442 }
443 469
444 uint32_t next () 470 refcnt_buf &operator =(const refcnt_buf &src);
471
472 operator char *()
445 { 473 {
446 uint32_t t = x ^ (x << 10);
447 x = y;
448 y = y ^ (y >> 13) ^ t ^ (t >> 10);
449 return y; 474 return data;
450 } 475 }
451};
452 476
453template<class generator> 477 size_t size () const
454struct random_number_generator : generator
455{
456 // uniform distribution, 0 .. max (0, num - 1)
457 uint32_t operator ()(uint32_t num)
458 { 478 {
459 return !is_constant (num) ? get_range (num) // non-constant 479 return _size ();
460 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
461 : this->next () & (num - 1); // constant, power-of-two
462 }
463
464 // return a number within (min .. max)
465 int operator () (int r_min, int r_max)
466 {
467 return is_constant (r_min) && is_constant (r_max) && r_min <= r_max
468 ? r_min + operator ()(r_max - r_min + 1)
469 : get_range (r_min, r_max);
470 }
471
472 double operator ()()
473 {
474 return this->next () / (double)0xFFFFFFFFU;
475 } 480 }
476 481
477protected: 482protected:
478 uint32_t get_range (uint32_t r_max); 483 enum {
479 int get_range (int r_min, int r_max); 484 overhead = sizeof (uint32_t) * 2
480}; 485 };
481 486
482typedef random_number_generator<tausworthe_random_generator> rand_gen; 487 uint32_t &_size () const
488 {
489 return ((unsigned int *)data)[-2];
490 }
483 491
484extern 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};
485 517
486INTERFACE_CLASS (attachable) 518INTERFACE_CLASS (attachable)
487struct refcnt_base 519struct refcnt_base
488{ 520{
489 typedef int refcnt_t; 521 typedef int refcnt_t;
… …
551typedef refptr<maptile> maptile_ptr; 583typedef refptr<maptile> maptile_ptr;
552typedef refptr<object> object_ptr; 584typedef refptr<object> object_ptr;
553typedef refptr<archetype> arch_ptr; 585typedef refptr<archetype> arch_ptr;
554typedef refptr<client> client_ptr; 586typedef refptr<client> client_ptr;
555typedef 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}
556 619
557struct str_hash 620struct str_hash
558{ 621{
559 std::size_t operator ()(const char *s) const 622 std::size_t operator ()(const char *s) const
560 { 623 {
561#if 0
562 uint32_t hash = 0;
563
564 /* use the one-at-a-time hash function, which supposedly is
565 * better than the djb2-like one used by perl5.005, but
566 * certainly is better then the bug used here before.
567 * see http://burtleburtle.net/bob/hash/doobs.html
568 */
569 while (*s)
570 {
571 hash += *s++;
572 hash += hash << 10;
573 hash ^= hash >> 6;
574 }
575
576 hash += hash << 3;
577 hash ^= hash >> 11;
578 hash += hash << 15;
579#else
580 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
581 // it is about twice as fast as the one-at-a-time one,
582 // with good distribution.
583 // FNV-1a is faster on many cpus because the multiplication
584 // runs concurrent with the looping logic.
585 uint32_t hash = 2166136261;
586
587 while (*s)
588 hash = (hash ^ *s++) * 16777619;
589#endif
590
591 return hash; 624 return strhsh (s);
625 }
626
627 std::size_t operator ()(const shstr &s) const
628 {
629 return strhsh (s);
592 } 630 }
593}; 631};
594 632
595struct str_equal 633struct str_equal
596{ 634{
… …
623 } 661 }
624}; 662};
625 663
626// This container blends advantages of linked lists 664// This container blends advantages of linked lists
627// (efficiency) with vectors (random access) by 665// (efficiency) with vectors (random access) by
628// by using an unordered vector and storing the vector 666// using an unordered vector and storing the vector
629// index inside the object. 667// index inside the object.
630// 668//
631// + memory-efficient on most 64 bit archs 669// + memory-efficient on most 64 bit archs
632// + O(1) insert/remove 670// + O(1) insert/remove
633// + free unique (but varying) id for inserted objects 671// + free unique (but varying) id for inserted objects
… …
670 insert (&obj); 708 insert (&obj);
671 } 709 }
672 710
673 void erase (T *obj) 711 void erase (T *obj)
674 { 712 {
675 unsigned int pos = obj->*indexmember; 713 object_vector_index pos = obj->*indexmember;
676 obj->*indexmember = 0; 714 obj->*indexmember = 0;
677 715
678 if (pos < this->size ()) 716 if (pos < this->size ())
679 { 717 {
680 (*this)[pos - 1] = (*this)[this->size () - 1]; 718 (*this)[pos - 1] = (*this)[this->size () - 1];
… …
688 { 726 {
689 erase (&obj); 727 erase (&obj);
690 } 728 }
691}; 729};
692 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
693// 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
694// returns the number of bytes actually used (including \0) 800// returns the number of bytes actually used (including \0)
695int assign (char *dst, const char *src, int maxsize); 801int assign (char *dst, const char *src, int maxsize);
696 802
697// type-safe version of assign 803// type-safe version of assign
… …
706// return current time as timestamp 812// return current time as timestamp
707tstamp now (); 813tstamp now ();
708 814
709int similar_direction (int a, int b); 815int similar_direction (int a, int b);
710 816
711// like sprintf, but returns a "static" buffer 817// like v?sprintf, but returns a "static" buffer
712const char *format (const char *format, ...); 818char *vformat (const char *format, va_list ap);
819char *format (const char *format, ...) attribute ((format (printf, 1, 2)));
713 820
714// safety-check player input which will become object->msg 821// safety-check player input which will become object->msg
715bool msg_is_safe (const char *msg); 822bool msg_is_safe (const char *msg);
716 823
717///////////////////////////////////////////////////////////////////////////// 824/////////////////////////////////////////////////////////////////////////////

Diff Legend

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