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.105 by root, Fri Apr 30 20:43:18 2010 UTC vs.
Revision 1.127 by root, Sat Nov 17 23:40:02 2018 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 (©) 2017,2018 Marc Alexander Lehmann / the Deliantra team
4 * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 5 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * 6 *
6 * Deliantra is free software: you can redistribute it and/or modify it under 7 * 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 8 * 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 9 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version. 10 * option) any later version.
10 * 11 *
11 * This program is distributed in the hope that it will be useful, 12 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details. 15 * GNU General Public License for more details.
15 * 16 *
16 * You should have received a copy of the Affero GNU General Public License 17 * 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 18 * and the GNU General Public License along with this program. If not, see
18 * <http://www.gnu.org/licenses/>. 19 * <http://www.gnu.org/licenses/>.
19 * 20 *
20 * The authors can be reached via e-mail to <support@deliantra.net> 21 * The authors can be reached via e-mail to <support@deliantra.net>
21 */ 22 */
22 23
23#ifndef UTIL_H__ 24#ifndef UTIL_H__
24#define UTIL_H__ 25#define UTIL_H__
55#endif 56#endif
56 57
57// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever) 58// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever)
58#define auto(var,expr) decltype(expr) var = (expr) 59#define auto(var,expr) decltype(expr) var = (expr)
59 60
60#if cplusplus_does_not_suck 61#if cplusplus_does_not_suck /* still sucks in codesize with gcc 6, although local types work now */
61// does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm) 62// does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm)
62template<typename T, int N> 63template<typename T, int N>
63static inline int array_length (const T (&arr)[N]) 64static inline int array_length (const T (&arr)[N])
64{ 65{
65 return N; 66 return N;
81 82
82// in range excluding end 83// in range excluding end
83#define IN_RANGE_EXC(val,beg,end) \ 84#define IN_RANGE_EXC(val,beg,end) \
84 ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg)) 85 ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg))
85 86
86void cleanup (const char *cause, bool make_core = false); 87ecb_cold void cleanup (const char *cause, bool make_core = false);
87void fork_abort (const char *msg); 88ecb_cold void fork_abort (const char *msg);
88 89
89// rationale for using (U) not (T) is to reduce signed/unsigned issues, 90// rationale for using (U) not (T) is to reduce signed/unsigned issues,
90// as a is often a constant while b is the variable. it is still a bug, though. 91// as a is often a constant while b is the variable. it is still a bug, though.
91template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } 92template<typename T, typename U> static inline T min (T a, U b) { return a < (T)b ? a : (T)b; }
92template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } 93template<typename T, typename U> static inline T max (T a, U b) { return a > (T)b ? a : (T)b; }
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; } 94template<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; }
94 95
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 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> 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); } 98template<typename T, typename U, typename V> static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); }
114 115
115// sign0 returns -1, 0 or +1 116// sign0 returns -1, 0 or +1
116template<typename T> 117template<typename T>
117static inline T sign0 (T v) { return v ? sign (v) : 0; } 118static inline T sign0 (T v) { return v ? sign (v) : 0; }
118 119
120//clashes with C++0x
119template<typename T, typename U> 121template<typename T, typename U>
120static inline T copysign (T a, U b) { return a > 0 ? b : -b; } 122static inline T copysign (T a, U b) { return a > 0 ? b : -b; }
121 123
122// div* only work correctly for div > 0 124// div* only work correctly for div > 0
123// div, with correct rounding (< 0.5 downwards, >=0.5 upwards) 125// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
236#if 0 238#if 0
237// and has a max. error of 6 in the range -100..+100. 239// and has a max. error of 6 in the range -100..+100.
238#else 240#else
239// and has a max. error of 9 in the range -100..+100. 241// and has a max. error of 9 in the range -100..+100.
240#endif 242#endif
241inline int 243inline int
242idistance (int dx, int dy) 244idistance (int dx, int dy)
243{ 245{
244 unsigned int dx_ = abs (dx); 246 unsigned int dx_ = abs (dx);
245 unsigned int dy_ = abs (dy); 247 unsigned int dy_ = abs (dy);
246 248
247#if 0 249#if 0
248 return dx_ > dy_ 250 return dx_ > dy_
251#else 253#else
252 return dx_ + dy_ - min (dx_, dy_) * 5 / 8; 254 return dx_ + dy_ - min (dx_, dy_) * 5 / 8;
253#endif 255#endif
254} 256}
255 257
258// can be substantially faster than floor, if your value range allows for it
259template<typename T>
260inline T
261fastfloor (T x)
262{
263 return std::floor (x);
264}
265
266inline float
267fastfloor (float x)
268{
269 return sint32(x) - (x < 0);
270}
271
272inline double
273fastfloor (double x)
274{
275 return sint64(x) - (x < 0);
276}
277
256/* 278/*
257 * absdir(int): Returns a number between 1 and 8, which represent 279 * absdir(int): Returns a number between 1 and 8, which represent
258 * the "absolute" direction of a number (it actually takes care of 280 * the "absolute" direction of a number (it actually takes care of
259 * "overflow" in previous calculations of a direction). 281 * "overflow" in previous calculations of a direction).
260 */ 282 */
262absdir (int d) 284absdir (int d)
263{ 285{
264 return ((d - 1) & 7) + 1; 286 return ((d - 1) & 7) + 1;
265} 287}
266 288
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) \ 289#define for_all_bits_sparse_32(mask, idxvar) \
278 for (uint32_t idxvar, mask_ = mask; \ 290 for (uint32_t idxvar, mask_ = mask; \
279 mask_ && ((idxvar = least_significant_bit (mask_)), mask_ &= ~(1 << idxvar), 1);) 291 mask_ && ((idxvar = ecb_ctz32 (mask_)), mask_ &= ~(1 << idxvar), 1);)
280 292
281extern ssize_t slice_alloc; // statistics 293extern ssize_t slice_alloc; // statistics
282 294
283void *salloc_ (int n) throw (std::bad_alloc); 295void *salloc_ (int n);
284void *salloc_ (int n, void *src) throw (std::bad_alloc); 296void *salloc_ (int n, void *src);
285 297
286// strictly the same as g_slice_alloc, but never returns 0 298// strictly the same as g_slice_alloc, but never returns 0
287template<typename T> 299template<typename T>
288inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); } 300inline T *salloc (int n = 1) { return (T *)salloc_ (n * sizeof (T)); }
289 301
290// also copies src into the new area, like "memdup" 302// also copies src into the new area, like "memdup"
291// if src is 0, clears the memory 303// if src is 0, clears the memory
292template<typename T> 304template<typename T>
293inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); } 305inline T *salloc (int n, T *src) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
294 306
295// clears the memory 307// clears the memory
296template<typename T> 308template<typename T>
297inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); } 309inline T *salloc0(int n = 1) { return (T *)salloc_ (n * sizeof (T), 0); }
298 310
299// for symmetry 311// for symmetry
300template<typename T> 312template<typename T>
301inline void sfree (T *ptr, int n = 1) throw () 313inline void sfree (T *ptr, int n = 1) noexcept
302{ 314{
303 if (expect_true (ptr)) 315 if (expect_true (ptr))
304 { 316 {
305 slice_alloc -= n * sizeof (T); 317 slice_alloc -= n * sizeof (T);
306 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T)); 318 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
307 g_slice_free1 (n * sizeof (T), (void *)ptr); 319 g_slice_free1 (n * sizeof (T), (void *)ptr);
308 assert (slice_alloc >= 0);//D
309 } 320 }
310} 321}
311 322
312// nulls the pointer 323// nulls the pointer
313template<typename T> 324template<typename T>
314inline void sfree0 (T *&ptr, int n = 1) throw () 325inline void sfree0 (T *&ptr, int n = 1) noexcept
315{ 326{
316 sfree<T> (ptr, n); 327 sfree<T> (ptr, n);
317 ptr = 0; 328 ptr = 0;
318} 329}
319 330
387 typedef const Tp *const_pointer; 398 typedef const Tp *const_pointer;
388 typedef Tp &reference; 399 typedef Tp &reference;
389 typedef const Tp &const_reference; 400 typedef const Tp &const_reference;
390 typedef Tp value_type; 401 typedef Tp value_type;
391 402
392 template <class U> 403 template <class U>
393 struct rebind 404 struct rebind
394 { 405 {
395 typedef slice_allocator<U> other; 406 typedef slice_allocator<U> other;
396 }; 407 };
397 408
398 slice_allocator () throw () { } 409 slice_allocator () noexcept { }
399 slice_allocator (const slice_allocator &) throw () { } 410 slice_allocator (const slice_allocator &) noexcept { }
400 template<typename Tp2> 411 template<typename Tp2>
401 slice_allocator (const slice_allocator<Tp2> &) throw () { } 412 slice_allocator (const slice_allocator<Tp2> &) noexcept { }
402 413
403 ~slice_allocator () { } 414 ~slice_allocator () { }
404 415
405 pointer address (reference x) const { return &x; } 416 pointer address (reference x) const { return &x; }
406 const_pointer address (const_reference x) const { return &x; } 417 const_pointer address (const_reference x) const { return &x; }
413 void deallocate (pointer p, size_type n) 424 void deallocate (pointer p, size_type n)
414 { 425 {
415 sfree<Tp> (p, n); 426 sfree<Tp> (p, n);
416 } 427 }
417 428
418 size_type max_size () const throw () 429 size_type max_size () const noexcept
419 { 430 {
420 return size_t (-1) / sizeof (Tp); 431 return size_t (-1) / sizeof (Tp);
421 } 432 }
422 433
423 void construct (pointer p, const Tp &val) 434 void construct (pointer p, const Tp &val)
429 { 440 {
430 p->~Tp (); 441 p->~Tp ();
431 } 442 }
432}; 443};
433 444
434// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. 445// basically a memory area, but refcounted
435// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 446struct refcnt_buf
436// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
437struct tausworthe_random_generator
438{ 447{
439 uint32_t state [4]; 448 char *data;
440 449
441 void operator =(const tausworthe_random_generator &src) 450 refcnt_buf (size_t size = 0);
442 { 451 refcnt_buf (void *data, size_t size);
443 state [0] = src.state [0];
444 state [1] = src.state [1];
445 state [2] = src.state [2];
446 state [3] = src.state [3];
447 }
448 452
449 void seed (uint32_t seed); 453 refcnt_buf (const refcnt_buf &src)
450 uint32_t next ();
451};
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 { 454 {
464 x = src.x; 455 data = src.data;
465 y = src.y; 456 inc ();
466 } 457 }
467 458
468 void seed (uint32_t seed) 459 ~refcnt_buf ();
469 {
470 x = seed;
471 y = seed * 69069U;
472 }
473 460
474 uint32_t next () 461 refcnt_buf &operator =(const refcnt_buf &src);
462
463 operator char *()
475 { 464 {
476 uint32_t t = x ^ (x << 10);
477 x = y;
478 y = y ^ (y >> 13) ^ t ^ (t >> 10);
479 return y; 465 return data;
480 } 466 }
481};
482 467
483template<class generator> 468 size_t size () const
484struct random_number_generator : generator
485{
486 // uniform distribution, 0 .. max (0, num - 1)
487 uint32_t operator ()(uint32_t num)
488 { 469 {
489 return !is_constant (num) ? get_range (num) // non-constant 470 return _size ();
490 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
491 : this->next () & (num - 1); // constant, power-of-two
492 }
493
494 // return a number within the closed interval [min .. max]
495 int operator () (int r_min, int r_max)
496 {
497 return is_constant (r_min <= r_max) && r_min <= r_max
498 ? r_min + operator ()(r_max - r_min + 1)
499 : get_range (r_min, r_max);
500 }
501
502 // return a number within the closed interval [0..1]
503 double operator ()()
504 {
505 return this->next () / (double)0xFFFFFFFFU;
506 } 471 }
507 472
508protected: 473protected:
509 uint32_t get_range (uint32_t r_max); 474 enum {
510 int get_range (int r_min, int r_max); 475 overhead = sizeof (uint32_t) * 2
511}; 476 };
512 477
513typedef random_number_generator<tausworthe_random_generator> rand_gen; 478 uint32_t &_size () const
479 {
480 return ((unsigned int *)data)[-2];
481 }
514 482
515extern rand_gen rndm, rmg_rndm; 483 uint32_t &_refcnt () const
484 {
485 return ((unsigned int *)data)[-1];
486 }
487
488 void _alloc (uint32_t size)
489 {
490 data = ((char *)salloc<char> (size + overhead)) + overhead;
491 _size () = size;
492 _refcnt () = 1;
493 }
494
495 void _dealloc ();
496
497 void inc ()
498 {
499 ++_refcnt ();
500 }
501
502 void dec ()
503 {
504 if (!--_refcnt ())
505 _dealloc ();
506 }
507};
516 508
517INTERFACE_CLASS (attachable) 509INTERFACE_CLASS (attachable)
518struct refcnt_base 510struct refcnt_base
519{ 511{
520 typedef int refcnt_t; 512 typedef int refcnt_t;
535 // p if not null 527 // p if not null
536 refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; } 528 refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
537 529
538 void refcnt_dec () 530 void refcnt_dec ()
539 { 531 {
540 if (!is_constant (p)) 532 if (!ecb_is_constant (p))
541 --*refcnt_ref (); 533 --*refcnt_ref ();
542 else if (p) 534 else if (p)
543 --p->refcnt; 535 --p->refcnt;
544 } 536 }
545 537
546 void refcnt_inc () 538 void refcnt_inc ()
547 { 539 {
548 if (!is_constant (p)) 540 if (!ecb_is_constant (p))
549 ++*refcnt_ref (); 541 ++*refcnt_ref ();
550 else if (p) 542 else if (p)
551 ++p->refcnt; 543 ++p->refcnt;
552 } 544 }
553 545
594 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/) 586 // 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, 587 // it is about twice as fast as the one-at-a-time one,
596 // with good distribution. 588 // with good distribution.
597 // FNV-1a is faster on many cpus because the multiplication 589 // FNV-1a is faster on many cpus because the multiplication
598 // runs concurrently with the looping logic. 590 // runs concurrently with the looping logic.
591 // we modify the hash a bit to improve its distribution
599 uint32_t hash = STRHSH_NULL; 592 uint32_t hash = STRHSH_NULL;
600 593
601 while (*s) 594 while (*s)
602 hash = (hash ^ *s++) * 16777619U; 595 hash = (hash ^ *s++) * 16777619U;
603 596
604 return hash; 597 return hash ^ (hash >> 16);
605} 598}
606 599
607static inline uint32_t 600static inline uint32_t
608memhsh (const char *s, size_t len) 601memhsh (const char *s, size_t len)
609{ 602{
610 uint32_t hash = STRHSH_NULL; 603 uint32_t hash = STRHSH_NULL;
611 604
612 while (len--) 605 while (len--)
613 hash = (hash ^ *s++) * 16777619U; 606 hash = (hash ^ *s++) * 16777619U;
614 607
615 return hash; 608 return hash;
616} 609}
659 } 652 }
660}; 653};
661 654
662// This container blends advantages of linked lists 655// This container blends advantages of linked lists
663// (efficiency) with vectors (random access) by 656// (efficiency) with vectors (random access) by
664// by using an unordered vector and storing the vector 657// using an unordered vector and storing the vector
665// index inside the object. 658// index inside the object.
666// 659//
667// + memory-efficient on most 64 bit archs 660// + memory-efficient on most 64 bit archs
668// + O(1) insert/remove 661// + O(1) insert/remove
669// + free unique (but varying) id for inserted objects 662// + free unique (but varying) id for inserted objects
706 insert (&obj); 699 insert (&obj);
707 } 700 }
708 701
709 void erase (T *obj) 702 void erase (T *obj)
710 { 703 {
711 unsigned int pos = obj->*indexmember; 704 object_vector_index pos = obj->*indexmember;
712 obj->*indexmember = 0; 705 obj->*indexmember = 0;
713 706
714 if (pos < this->size ()) 707 if (pos < this->size ())
715 { 708 {
716 (*this)[pos - 1] = (*this)[this->size () - 1]; 709 (*this)[pos - 1] = (*this)[this->size () - 1];
724 { 717 {
725 erase (&obj); 718 erase (&obj);
726 } 719 }
727}; 720};
728 721
722/////////////////////////////////////////////////////////////////////////////
723
724// something like a vector or stack, but without
725// out of bounds checking
726template<typename T>
727struct fixed_stack
728{
729 T *data;
730 int size;
731 int max;
732
733 fixed_stack ()
734 : size (0), data (0)
735 {
736 }
737
738 fixed_stack (int max)
739 : size (0), max (max)
740 {
741 data = salloc<T> (max);
742 }
743
744 void reset (int new_max)
745 {
746 sfree (data, max);
747 size = 0;
748 max = new_max;
749 data = salloc<T> (max);
750 }
751
752 void free ()
753 {
754 sfree (data, max);
755 data = 0;
756 }
757
758 ~fixed_stack ()
759 {
760 sfree (data, max);
761 }
762
763 T &operator[](int idx)
764 {
765 return data [idx];
766 }
767
768 void push (T v)
769 {
770 data [size++] = v;
771 }
772
773 T &pop ()
774 {
775 return data [--size];
776 }
777
778 T remove (int idx)
779 {
780 T v = data [idx];
781
782 data [idx] = data [--size];
783
784 return v;
785 }
786};
787
788/////////////////////////////////////////////////////////////////////////////
789
729// basically does what strncpy should do, but appends "..." to strings exceeding length 790// basically does what strncpy should do, but appends "..." to strings exceeding length
730// returns the number of bytes actually used (including \0) 791// returns the number of bytes actually used (including \0)
731int assign (char *dst, const char *src, int maxsize); 792int assign (char *dst, const char *src, int maxsize);
732 793
733// type-safe version of assign 794// type-safe version of assign
744 805
745int similar_direction (int a, int b); 806int similar_direction (int a, int b);
746 807
747// like v?sprintf, but returns a "static" buffer 808// like v?sprintf, but returns a "static" buffer
748char *vformat (const char *format, va_list ap); 809char *vformat (const char *format, va_list ap);
749char *format (const char *format, ...) attribute ((format (printf, 1, 2))); 810char *format (const char *format, ...) ecb_attribute ((format (printf, 1, 2)));
750 811
751// safety-check player input which will become object->msg 812// safety-check player input which will become object->msg
752bool msg_is_safe (const char *msg); 813bool msg_is_safe (const char *msg);
753 814
754///////////////////////////////////////////////////////////////////////////// 815/////////////////////////////////////////////////////////////////////////////

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines