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,2012 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. |
… | |
… | |
21 | */ |
22 | */ |
22 | |
23 | |
23 | #ifndef UTIL_H__ |
24 | #ifndef UTIL_H__ |
24 | #define UTIL_H__ |
25 | #define UTIL_H__ |
25 | |
26 | |
26 | #include <compiler.h> |
|
|
27 | |
|
|
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 | |
32 | #include <pthread.h> |
31 | #include <pthread.h> |
… | |
… | |
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) |
|
|
62 | template<typename T, int N> |
|
|
63 | static 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 | |
86 | void cleanup (const char *cause, bool make_core = false); |
75 | ecb_cold void cleanup (const char *cause, bool make_core = false); |
87 | void fork_abort (const char *msg); |
76 | ecb_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. |
91 | template<typename T, typename U> static inline T min (T a, U b) { return a < (T)b ? a : (T)b; } |
80 | template<typename T, typename U> static inline T min (T a, U b) { return a < (T)b ? a : (T)b; } |
92 | template<typename T, typename U> static inline T max (T a, U b) { return a > (T)b ? a : (T)b; } |
81 | template<typename T, typename U> static inline T max (T a, U b) { return a > (T)b ? 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) |
125 | template<typename T> static inline T div (T val, T div) |
114 | template<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 | |
130 | template<> inline float div (float val, float div) { return val / div; } |
119 | template<> inline float div (float val, float div) { return val / div; } |
131 | template<> inline double div (double val, double div) { return val / div; } |
120 | template<> inline double div (double val, double div) { return val / div; } |
132 | |
121 | |
133 | // div, round-up |
122 | // div, round-up |
134 | template<typename T> static inline T div_ru (T val, T div) |
123 | template<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 |
139 | template<typename T> static inline T div_rd (T val, T div) |
128 | template<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 |
146 | template<typename T> |
135 | template<typename T> |
… | |
… | |
283 | absdir (int d) |
272 | absdir (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) |
|
|
290 | static inline int least_significant_bit (uint32_t x) |
|
|
291 | { |
|
|
292 | return __builtin_ctz (x); |
|
|
293 | } |
|
|
294 | #else |
|
|
295 | int 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 | |
302 | extern ssize_t slice_alloc; // statistics |
281 | extern ssize_t slice_alloc; // statistics |
303 | |
282 | |
304 | void *salloc_ (int n) throw (std::bad_alloc); |
283 | void *salloc_ (int n) noexcept; |
305 | void *salloc_ (int n, void *src) throw (std::bad_alloc); |
284 | void *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 |
308 | template<typename T> |
287 | template<typename T> |
309 | inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); } |
288 | inline 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 |
313 | template<typename T> |
292 | template<typename T> |
314 | inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); } |
293 | inline T *salloc (int n, T *src) { return (T *)salloc_ (n * sizeof (T), (void *)src); } |
315 | |
294 | |
316 | // clears the memory |
295 | // clears the memory |
317 | template<typename T> |
296 | template<typename T> |
318 | inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); } |
297 | inline T *salloc0(int n = 1) { return (T *)salloc_ (n * sizeof (T), 0); } |
319 | |
298 | |
320 | // for symmetry |
299 | // for symmetry |
321 | template<typename T> |
300 | template<typename T> |
322 | inline void sfree (T *ptr, int n = 1) throw () |
301 | inline 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 | } |
308 | } |
330 | } |
309 | } |
331 | |
310 | |
332 | // nulls the pointer |
311 | // nulls the pointer |
333 | template<typename T> |
312 | template<typename T> |
334 | inline void sfree0 (T *&ptr, int n = 1) throw () |
313 | inline void sfree0 (T *&ptr, int n = 1) noexcept |
335 | { |
314 | { |
336 | sfree<T> (ptr, n); |
315 | sfree<T> (ptr, n); |
337 | ptr = 0; |
316 | ptr = 0; |
338 | } |
317 | } |
339 | |
318 | |
… | |
… | |
395 | sfree ((char *)p, s); |
374 | sfree ((char *)p, s); |
396 | } |
375 | } |
397 | }; |
376 | }; |
398 | |
377 | |
399 | // a STL-compatible allocator that uses g_slice |
378 | // a STL-compatible allocator that uses g_slice |
400 | // boy, this is verbose |
379 | // boy, this is much less verbose in newer C++ versions |
401 | template<typename Tp> |
380 | template<typename Tp> |
402 | struct slice_allocator |
381 | struct slice_allocator |
403 | { |
382 | { |
404 | typedef size_t size_type; |
383 | using value_type = Tp; |
405 | typedef ptrdiff_t difference_type; |
|
|
406 | typedef Tp *pointer; |
|
|
407 | typedef const Tp *const_pointer; |
|
|
408 | typedef Tp &reference; |
|
|
409 | typedef const Tp &const_reference; |
|
|
410 | typedef Tp value_type; |
|
|
411 | |
384 | |
412 | template <class U> |
|
|
413 | struct rebind |
|
|
414 | { |
|
|
415 | typedef slice_allocator<U> other; |
|
|
416 | }; |
|
|
417 | |
|
|
418 | slice_allocator () throw () { } |
|
|
419 | slice_allocator (const slice_allocator &) throw () { } |
|
|
420 | template<typename Tp2> |
|
|
421 | slice_allocator (const slice_allocator<Tp2> &) throw () { } |
|
|
422 | |
|
|
423 | ~slice_allocator () { } |
385 | slice_allocator () noexcept { } |
|
|
386 | template<class U> slice_allocator (const slice_allocator<U> &) noexcept {} |
424 | |
387 | |
425 | pointer address (reference x) const { return &x; } |
388 | value_type *allocate (std::size_t n) |
426 | const_pointer address (const_reference x) const { return &x; } |
|
|
427 | |
|
|
428 | pointer allocate (size_type n, const_pointer = 0) |
|
|
429 | { |
389 | { |
430 | return salloc<Tp> (n); |
390 | return salloc<Tp> (n); |
431 | } |
391 | } |
432 | |
392 | |
433 | void deallocate (pointer p, size_type n) |
393 | void deallocate (value_type *p, std::size_t n) |
434 | { |
394 | { |
435 | sfree<Tp> (p, n); |
395 | sfree<Tp> (p, n); |
436 | } |
396 | } |
437 | |
|
|
438 | size_type max_size () const throw () |
|
|
439 | { |
|
|
440 | return size_t (-1) / sizeof (Tp); |
|
|
441 | } |
|
|
442 | |
|
|
443 | void construct (pointer p, const Tp &val) |
|
|
444 | { |
|
|
445 | ::new (p) Tp (val); |
|
|
446 | } |
|
|
447 | |
|
|
448 | void destroy (pointer p) |
|
|
449 | { |
|
|
450 | p->~Tp (); |
|
|
451 | } |
|
|
452 | }; |
397 | }; |
|
|
398 | |
|
|
399 | template<class T, class U> |
|
|
400 | bool operator == (const slice_allocator<T> &, const slice_allocator<U> &) noexcept |
|
|
401 | { |
|
|
402 | return true; |
|
|
403 | } |
|
|
404 | |
|
|
405 | template<class T, class U> |
|
|
406 | bool operator != (const slice_allocator<T> &x, const slice_allocator<U> &y) noexcept |
|
|
407 | { |
|
|
408 | return !(x == y); |
|
|
409 | } |
453 | |
410 | |
454 | // basically a memory area, but refcounted |
411 | // basically a memory area, but refcounted |
455 | struct refcnt_buf |
412 | struct refcnt_buf |
456 | { |
413 | { |
457 | char *data; |
414 | char *data; |
… | |
… | |
536 | // p if not null |
493 | // p if not null |
537 | 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; } |
538 | |
495 | |
539 | void refcnt_dec () |
496 | void refcnt_dec () |
540 | { |
497 | { |
541 | if (!is_constant (p)) |
498 | if (!ecb_is_constant (p)) |
542 | --*refcnt_ref (); |
499 | --*refcnt_ref (); |
543 | else if (p) |
500 | else if (p) |
544 | --p->refcnt; |
501 | --p->refcnt; |
545 | } |
502 | } |
546 | |
503 | |
547 | void refcnt_inc () |
504 | void refcnt_inc () |
548 | { |
505 | { |
549 | if (!is_constant (p)) |
506 | if (!ecb_is_constant (p)) |
550 | ++*refcnt_ref (); |
507 | ++*refcnt_ref (); |
551 | else if (p) |
508 | else if (p) |
552 | ++p->refcnt; |
509 | ++p->refcnt; |
553 | } |
510 | } |
554 | |
511 | |
… | |
… | |
626 | |
583 | |
627 | std::size_t operator ()(const shstr &s) const |
584 | std::size_t operator ()(const shstr &s) const |
628 | { |
585 | { |
629 | return strhsh (s); |
586 | return strhsh (s); |
630 | } |
587 | } |
|
|
588 | |
|
|
589 | typedef ska::power_of_two_hash_policy hash_policy; |
631 | }; |
590 | }; |
632 | |
591 | |
633 | struct str_equal |
592 | struct str_equal |
634 | { |
593 | { |
635 | bool operator ()(const char *a, const char *b) const |
594 | bool operator ()(const char *a, const char *b) const |
… | |
… | |
814 | |
773 | |
815 | int similar_direction (int a, int b); |
774 | int similar_direction (int a, int b); |
816 | |
775 | |
817 | // like v?sprintf, but returns a "static" buffer |
776 | // like v?sprintf, but returns a "static" buffer |
818 | char *vformat (const char *format, va_list ap); |
777 | char *vformat (const char *format, va_list ap); |
819 | char *format (const char *format, ...) attribute ((format (printf, 1, 2))); |
778 | char *format (const char *format, ...) ecb_attribute ((format (printf, 1, 2))); |
820 | |
779 | |
821 | // safety-check player input which will become object->msg |
780 | // safety-check player input which will become object->msg |
822 | bool msg_is_safe (const char *msg); |
781 | bool msg_is_safe (const char *msg); |
823 | |
782 | |
824 | ///////////////////////////////////////////////////////////////////////////// |
783 | ///////////////////////////////////////////////////////////////////////////// |