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.115 by root, Tue Apr 26 14:41:36 2011 UTC vs.
Revision 1.133 by root, Sat Oct 8 21:54:05 2022 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,2011 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__
25
26#include <compiler.h>
27 26
28#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0 27#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0
29#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs 28#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs
30#define PREFER_MALLOC 0 // use malloc and not the slice allocator 29#define PREFER_MALLOC 0 // use malloc and not the slice allocator
31 30
36#include <new> 35#include <new>
37#include <vector> 36#include <vector>
38 37
39#include <glib.h> 38#include <glib.h>
40 39
40#include <flat_hash_map.hpp>
41
41#include <shstr.h> 42#include <shstr.h>
42#include <traits.h> 43#include <traits.h>
44
45#include "ecb.h"
43 46
44#if DEBUG_SALLOC 47#if DEBUG_SALLOC
45# define g_slice_alloc0(s) debug_slice_alloc0(s) 48# define g_slice_alloc0(s) debug_slice_alloc0(s)
46# define g_slice_alloc(s) debug_slice_alloc(s) 49# define g_slice_alloc(s) debug_slice_alloc(s)
47# define g_slice_free1(s,p) debug_slice_free1(s,p) 50# define g_slice_free1(s,p) debug_slice_free1(s,p)
52# define g_slice_alloc0(s) calloc (1, (s)) 55# define g_slice_alloc0(s) calloc (1, (s))
53# define g_slice_alloc(s) malloc ((s)) 56# define g_slice_alloc(s) malloc ((s))
54# define g_slice_free1(s,p) free ((p)) 57# define g_slice_free1(s,p) free ((p))
55#endif 58#endif
56 59
57// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever)
58#define auto(var,expr) decltype(expr) var = (expr)
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
71// very ugly macro that basically declares and initialises a variable 60// very ugly macro that basically declares and initialises a variable
72// that is in scope for the next statement only 61// that is in scope for the next statement only
73// works only for stuff that can be assigned 0 and converts to false 62// works only for stuff that can be assigned 0 and converts to false
74// (note: works great for pointers) 63// (note: works great for pointers)
75// most ugly macro I ever wrote 64// most ugly macro I ever wrote
81 70
82// in range excluding end 71// in range excluding end
83#define IN_RANGE_EXC(val,beg,end) \ 72#define IN_RANGE_EXC(val,beg,end) \
84 ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg)) 73 ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg))
85 74
86void cleanup (const char *cause, bool make_core = false); 75ecb_cold void cleanup (const char *cause, bool make_core = false);
87void fork_abort (const char *msg); 76ecb_cold void fork_abort (const char *msg);
88 77
89// rationale for using (U) not (T) is to reduce signed/unsigned issues, 78// 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. 79// 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; } 80template<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; } 81template<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; } 82template<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 83
95template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); } 84template<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); } 85template<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); } 86template<typename T, typename U, typename V> static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); }
122 111
123// div* only work correctly for div > 0 112// div* only work correctly for div > 0
124// div, with correct rounding (< 0.5 downwards, >=0.5 upwards) 113// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
125template<typename T> static inline T div (T val, T div) 114template<typename T> static inline T div (T val, T div)
126{ 115{
127 return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div; 116 return ecb_expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div;
128} 117}
129 118
130template<> inline float div (float val, float div) { return val / div; } 119template<> inline float div (float val, float div) { return val / div; }
131template<> inline double div (double val, double div) { return val / div; } 120template<> inline double div (double val, double div) { return val / div; }
132 121
133// div, round-up 122// div, round-up
134template<typename T> static inline T div_ru (T val, T div) 123template<typename T> static inline T div_ru (T val, T div)
135{ 124{
136 return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div; 125 return ecb_expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div;
137} 126}
138// div, round-down 127// div, round-down
139template<typename T> static inline T div_rd (T val, T div) 128template<typename T> static inline T div_rd (T val, T div)
140{ 129{
141 return expect_false (val < 0) ? - ((-val + (div - 1) ) / div) : (val ) / div; 130 return ecb_expect_false (val < 0) ? - ((-val + (div - 1) ) / div) : (val ) / div;
142} 131}
143 132
144// lerp* only work correctly for min_in < max_in 133// lerp* only work correctly for min_in < max_in
145// Linear intERPolate, scales val from min_in..max_in to min_out..max_out 134// Linear intERPolate, scales val from min_in..max_in to min_out..max_out
146template<typename T> 135template<typename T>
237#if 0 226#if 0
238// and has a max. error of 6 in the range -100..+100. 227// and has a max. error of 6 in the range -100..+100.
239#else 228#else
240// and has a max. error of 9 in the range -100..+100. 229// and has a max. error of 9 in the range -100..+100.
241#endif 230#endif
242inline int 231inline int
243idistance (int dx, int dy) 232idistance (int dx, int dy)
244{ 233{
245 unsigned int dx_ = abs (dx); 234 unsigned int dx_ = abs (dx);
246 unsigned int dy_ = abs (dy); 235 unsigned int dy_ = abs (dy);
247 236
248#if 0 237#if 0
249 return dx_ > dy_ 238 return dx_ > dy_
283absdir (int d) 272absdir (int d)
284{ 273{
285 return ((d - 1) & 7) + 1; 274 return ((d - 1) & 7) + 1;
286} 275}
287 276
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) \ 277#define for_all_bits_sparse_32(mask, idxvar) \
299 for (uint32_t idxvar, mask_ = mask; \ 278 for (uint32_t idxvar, mask_ = mask; \
300 mask_ && ((idxvar = least_significant_bit (mask_)), mask_ &= ~(1 << idxvar), 1);) 279 mask_ && ((idxvar = ecb_ctz32 (mask_)), mask_ &= ~(1 << idxvar), 1);)
301 280
302extern ssize_t slice_alloc; // statistics 281extern ssize_t slice_alloc; // statistics
303 282
304void *salloc_ (int n) throw (std::bad_alloc); 283void *salloc_ (int n) noexcept;
305void *salloc_ (int n, void *src) throw (std::bad_alloc); 284void *salloc_ (int n, void *src) noexcept;
306 285
307// strictly the same as g_slice_alloc, but never returns 0 286// strictly the same as g_slice_alloc, but never returns 0
308template<typename T> 287template<typename T>
309inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); } 288inline T *salloc (int n = 1) { return (T *)salloc_ (n * sizeof (T)); }
310 289
311// also copies src into the new area, like "memdup" 290// also copies src into the new area, like "memdup"
312// if src is 0, clears the memory 291// if src is 0, clears the memory
313template<typename T> 292template<typename T>
314inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); } 293inline T *salloc (int n, T *src) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
315 294
316// clears the memory 295// clears the memory
317template<typename T> 296template<typename T>
318inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); } 297inline T *salloc0(int n = 1) { return (T *)salloc_ (n * sizeof (T), 0); }
319 298
320// for symmetry 299// for symmetry
321template<typename T> 300template<typename T>
322inline void sfree (T *ptr, int n = 1) throw () 301inline void sfree (T *ptr, int n = 1) noexcept
323{ 302{
324 if (expect_true (ptr)) 303 if (ecb_expect_true (ptr))
325 { 304 {
326 slice_alloc -= n * sizeof (T); 305 slice_alloc -= n * sizeof (T);
327 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T)); 306 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
328 g_slice_free1 (n * sizeof (T), (void *)ptr); 307 g_slice_free1 (n * sizeof (T), (void *)ptr);
329 assert (slice_alloc >= 0);//D
330 } 308 }
331} 309}
332 310
333// nulls the pointer 311// nulls the pointer
334template<typename T> 312template<typename T>
335inline void sfree0 (T *&ptr, int n = 1) throw () 313inline void sfree0 (T *&ptr, int n = 1) noexcept
336{ 314{
337 sfree<T> (ptr, n); 315 sfree<T> (ptr, n);
338 ptr = 0; 316 ptr = 0;
339} 317}
340 318
396 sfree ((char *)p, s); 374 sfree ((char *)p, s);
397 } 375 }
398}; 376};
399 377
400// a STL-compatible allocator that uses g_slice 378// a STL-compatible allocator that uses g_slice
401// boy, this is verbose 379// boy, this is much less verbose in newer C++ versions
402template<typename Tp> 380template<typename Tp>
403struct slice_allocator 381struct slice_allocator
404{ 382{
405 typedef size_t size_type; 383 using value_type = Tp;
406 typedef ptrdiff_t difference_type;
407 typedef Tp *pointer;
408 typedef const Tp *const_pointer;
409 typedef Tp &reference;
410 typedef const Tp &const_reference;
411 typedef Tp value_type;
412 384
413 template <class U> 385 slice_allocator () noexcept { }
414 struct rebind 386 template<class U> slice_allocator (const slice_allocator<U> &) noexcept {}
387
388 value_type *allocate (std::size_t n)
415 { 389 {
416 typedef slice_allocator<U> other; 390 return salloc<Tp> (n);
391 }
392
393 void deallocate (value_type *p, std::size_t n)
394 {
395 sfree<Tp> (p, n);
396 }
397};
398
399template<class T, class U>
400bool operator == (const slice_allocator<T> &, const slice_allocator<U> &) noexcept
401{
402 return true;
403}
404
405template<class T, class U>
406bool operator != (const slice_allocator<T> &x, const slice_allocator<U> &y) noexcept
407{
408 return !(x == y);
409}
410
411// basically a memory area, but refcounted
412struct refcnt_buf
413{
414 char *data;
415
416 refcnt_buf (size_t size = 0);
417 refcnt_buf (void *data, size_t size);
418
419 refcnt_buf (const refcnt_buf &src)
420 {
421 data = src.data;
422 inc ();
423 }
424
425 ~refcnt_buf ();
426
427 refcnt_buf &operator =(const refcnt_buf &src);
428
429 operator char *()
430 {
431 return data;
432 }
433
434 size_t size () const
435 {
436 return _size ();
437 }
438
439protected:
440 enum {
441 overhead = sizeof (uint32_t) * 2
417 }; 442 };
418 443
419 slice_allocator () throw () { } 444 uint32_t &_size () const
420 slice_allocator (const slice_allocator &) throw () { }
421 template<typename Tp2>
422 slice_allocator (const slice_allocator<Tp2> &) throw () { }
423
424 ~slice_allocator () { }
425
426 pointer address (reference x) const { return &x; }
427 const_pointer address (const_reference x) const { return &x; }
428
429 pointer allocate (size_type n, const_pointer = 0)
430 { 445 {
431 return salloc<Tp> (n); 446 return ((unsigned int *)data)[-2];
432 } 447 }
433 448
434 void deallocate (pointer p, size_type n) 449 uint32_t &_refcnt () const
435 { 450 {
436 sfree<Tp> (p, n); 451 return ((unsigned int *)data)[-1];
437 } 452 }
438 453
439 size_type max_size () const throw () 454 void _alloc (uint32_t size)
440 { 455 {
441 return size_t (-1) / sizeof (Tp); 456 data = ((char *)salloc<char> (size + overhead)) + overhead;
457 _size () = size;
458 _refcnt () = 1;
442 } 459 }
443 460
444 void construct (pointer p, const Tp &val) 461 void _dealloc ();
445 {
446 ::new (p) Tp (val);
447 }
448 462
449 void destroy (pointer p) 463 void inc ()
450 { 464 {
451 p->~Tp (); 465 ++_refcnt ();
466 }
467
468 void dec ()
469 {
470 if (!--_refcnt ())
471 _dealloc ();
452 } 472 }
453}; 473};
454 474
455INTERFACE_CLASS (attachable) 475INTERFACE_CLASS (attachable)
456struct refcnt_base 476struct refcnt_base
473 // p if not null 493 // p if not null
474 refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; } 494 refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
475 495
476 void refcnt_dec () 496 void refcnt_dec ()
477 { 497 {
478 if (!is_constant (p)) 498 if (!ecb_is_constant (p))
479 --*refcnt_ref (); 499 --*refcnt_ref ();
480 else if (p) 500 else if (p)
481 --p->refcnt; 501 --p->refcnt;
482 } 502 }
483 503
484 void refcnt_inc () 504 void refcnt_inc ()
485 { 505 {
486 if (!is_constant (p)) 506 if (!ecb_is_constant (p))
487 ++*refcnt_ref (); 507 ++*refcnt_ref ();
488 else if (p) 508 else if (p)
489 ++p->refcnt; 509 ++p->refcnt;
490 } 510 }
491 511
534 // with good distribution. 554 // with good distribution.
535 // FNV-1a is faster on many cpus because the multiplication 555 // FNV-1a is faster on many cpus because the multiplication
536 // runs concurrently with the looping logic. 556 // runs concurrently with the looping logic.
537 // we modify the hash a bit to improve its distribution 557 // we modify the hash a bit to improve its distribution
538 uint32_t hash = STRHSH_NULL; 558 uint32_t hash = STRHSH_NULL;
539 559
540 while (*s) 560 while (*s)
541 hash = (hash ^ *s++) * 16777619U; 561 hash = (hash ^ *s++) * 16777619U;
542 562
543 return hash ^ (hash >> 16); 563 return hash ^ (hash >> 16);
544} 564}
545 565
546static inline uint32_t 566static inline uint32_t
547memhsh (const char *s, size_t len) 567memhsh (const char *s, size_t len)
548{ 568{
549 uint32_t hash = STRHSH_NULL; 569 uint32_t hash = STRHSH_NULL;
550 570
551 while (len--) 571 while (len--)
552 hash = (hash ^ *s++) * 16777619U; 572 hash = (hash ^ *s++) * 16777619U;
553 573
554 return hash; 574 return hash;
555} 575}
563 583
564 std::size_t operator ()(const shstr &s) const 584 std::size_t operator ()(const shstr &s) const
565 { 585 {
566 return strhsh (s); 586 return strhsh (s);
567 } 587 }
588
589 typedef ska::power_of_two_hash_policy hash_policy;
568}; 590};
569 591
570struct str_equal 592struct str_equal
571{ 593{
572 bool operator ()(const char *a, const char *b) const 594 bool operator ()(const char *a, const char *b) const
598 } 620 }
599}; 621};
600 622
601// This container blends advantages of linked lists 623// This container blends advantages of linked lists
602// (efficiency) with vectors (random access) by 624// (efficiency) with vectors (random access) by
603// by using an unordered vector and storing the vector 625// using an unordered vector and storing the vector
604// index inside the object. 626// index inside the object.
605// 627//
606// + memory-efficient on most 64 bit archs 628// + memory-efficient on most 64 bit archs
607// + O(1) insert/remove 629// + O(1) insert/remove
608// + free unique (but varying) id for inserted objects 630// + free unique (but varying) id for inserted objects
645 insert (&obj); 667 insert (&obj);
646 } 668 }
647 669
648 void erase (T *obj) 670 void erase (T *obj)
649 { 671 {
650 unsigned int pos = obj->*indexmember; 672 object_vector_index pos = obj->*indexmember;
651 obj->*indexmember = 0; 673 obj->*indexmember = 0;
652 674
653 if (pos < this->size ()) 675 if (pos < this->size ())
654 { 676 {
655 (*this)[pos - 1] = (*this)[this->size () - 1]; 677 (*this)[pos - 1] = (*this)[this->size () - 1];
751 773
752int similar_direction (int a, int b); 774int similar_direction (int a, int b);
753 775
754// like v?sprintf, but returns a "static" buffer 776// like v?sprintf, but returns a "static" buffer
755char *vformat (const char *format, va_list ap); 777char *vformat (const char *format, va_list ap);
756char *format (const char *format, ...) attribute ((format (printf, 1, 2))); 778char *format (const char *format, ...) ecb_attribute ((format (printf, 1, 2)));
757 779
758// safety-check player input which will become object->msg 780// safety-check player input which will become object->msg
759bool msg_is_safe (const char *msg); 781bool msg_is_safe (const char *msg);
760 782
761///////////////////////////////////////////////////////////////////////////// 783/////////////////////////////////////////////////////////////////////////////

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines