| 1 | /* |
1 | /* |
| 2 | * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game. |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
| 3 | * |
3 | * |
| 4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team |
4 | * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
| 5 | * |
5 | * |
| 6 | * Crossfire TRT is free software; you can redistribute it and/or modify it |
6 | * Deliantra is free software: you can redistribute it and/or modify it under |
| 7 | * under the terms of the GNU General Public License as published by the Free |
7 | * the terms of the Affero GNU General Public License as published by the |
| 8 | * Software Foundation; either version 2 of the License, or (at your option) |
8 | * Free Software Foundation, either version 3 of the License, or (at your |
| 9 | * any later version. |
9 | * option) any later version. |
| 10 | * |
10 | * |
| 11 | * This program is distributed in the hope that it will be useful, but |
11 | * This program is distributed in the hope that it will be useful, |
| 12 | * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * 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 along |
16 | * You should have received a copy of the Affero GNU General Public License |
| 17 | * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51 |
17 | * and the GNU General Public License along with this program. If not, see |
| 18 | * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
18 | * <http://www.gnu.org/licenses/>. |
| 19 | * |
19 | * |
| 20 | * The authors can be reached via e-mail to <crossfire@schmorp.de> |
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 | |
25 | |
| 26 | //#define PREFER_MALLOC |
26 | #include <compiler.h> |
| 27 | |
27 | |
| 28 | #if __GNUC__ >= 3 |
28 | #define DEBUG_POISON 0x00 // poison memory before freeing it if != 0 |
| 29 | # define is_constant(c) __builtin_constant_p (c) |
29 | #define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs |
| 30 | # define expect(expr,value) __builtin_expect ((expr),(value)) |
30 | #define PREFER_MALLOC 0 // use malloc and not the slice allocator |
| 31 | # define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality) |
|
|
| 32 | #else |
|
|
| 33 | # define is_constant(c) 0 |
|
|
| 34 | # define expect(expr,value) (expr) |
|
|
| 35 | # define prefetch(addr,rw,locality) |
|
|
| 36 | #endif |
|
|
| 37 | |
31 | |
| 38 | #if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4) |
32 | #include <pthread.h> |
| 39 | # define decltype(x) typeof(x) |
|
|
| 40 | #endif |
|
|
| 41 | |
|
|
| 42 | // put into ifs if you are very sure that the expression |
|
|
| 43 | // is mostly true or mosty false. note that these return |
|
|
| 44 | // booleans, not the expression. |
|
|
| 45 | #define expect_false(expr) expect ((expr) != 0, 0) |
|
|
| 46 | #define expect_true(expr) expect ((expr) != 0, 1) |
|
|
| 47 | |
33 | |
| 48 | #include <cstddef> |
34 | #include <cstddef> |
| 49 | #include <cmath> |
35 | #include <cmath> |
| 50 | #include <new> |
36 | #include <new> |
| 51 | #include <vector> |
37 | #include <vector> |
| … | |
… | |
| 53 | #include <glib.h> |
39 | #include <glib.h> |
| 54 | |
40 | |
| 55 | #include <shstr.h> |
41 | #include <shstr.h> |
| 56 | #include <traits.h> |
42 | #include <traits.h> |
| 57 | |
43 | |
|
|
44 | #if DEBUG_SALLOC |
|
|
45 | # define g_slice_alloc0(s) debug_slice_alloc0(s) |
|
|
46 | # define g_slice_alloc(s) debug_slice_alloc(s) |
|
|
47 | # define g_slice_free1(s,p) debug_slice_free1(s,p) |
|
|
48 | void *g_slice_alloc (unsigned long size); |
|
|
49 | void *g_slice_alloc0 (unsigned long size); |
|
|
50 | void g_slice_free1 (unsigned long size, void *ptr); |
|
|
51 | #elif PREFER_MALLOC |
|
|
52 | # define g_slice_alloc0(s) calloc (1, (s)) |
|
|
53 | # define g_slice_alloc(s) malloc ((s)) |
|
|
54 | # define g_slice_free1(s,p) free ((p)) |
|
|
55 | #endif |
|
|
56 | |
| 58 | // use a gcc extension for auto declarations until ISO C++ sanctifies them |
57 | // use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever) |
| 59 | #define auto(var,expr) decltype(expr) var = (expr) |
58 | #define auto(var,expr) decltype(expr) var = (expr) |
| 60 | |
59 | |
|
|
60 | // could use the sizeof (arr) /( sizeof (arr [0]) here, but C++ is |
|
|
61 | // much more obfuscated... :) |
|
|
62 | |
|
|
63 | template<typename T, int N> |
|
|
64 | inline int array_length (const T (&arr)[N]) |
|
|
65 | { |
|
|
66 | return N; |
|
|
67 | } |
|
|
68 | |
| 61 | // very ugly macro that basicaly declares and initialises a variable |
69 | // very ugly macro that basically declares and initialises a variable |
| 62 | // that is in scope for the next statement only |
70 | // that is in scope for the next statement only |
| 63 | // works only for stuff that can be assigned 0 and converts to false |
71 | // works only for stuff that can be assigned 0 and converts to false |
| 64 | // (note: works great for pointers) |
72 | // (note: works great for pointers) |
| 65 | // most ugly macro I ever wrote |
73 | // most ugly macro I ever wrote |
| 66 | #define declvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) |
74 | #define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) |
| 67 | |
75 | |
| 68 | // in range including end |
76 | // in range including end |
| 69 | #define IN_RANGE_INC(val,beg,end) \ |
77 | #define IN_RANGE_INC(val,beg,end) \ |
| 70 | ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) |
78 | ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) |
| 71 | |
79 | |
| 72 | // in range excluding end |
80 | // in range excluding end |
| 73 | #define IN_RANGE_EXC(val,beg,end) \ |
81 | #define IN_RANGE_EXC(val,beg,end) \ |
| 74 | ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg)) |
82 | ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg)) |
| 75 | |
83 | |
|
|
84 | void cleanup (const char *cause, bool make_core = false); |
| 76 | void fork_abort (const char *msg); |
85 | void fork_abort (const char *msg); |
| 77 | |
86 | |
| 78 | // rationale for using (U) not (T) is to reduce signed/unsigned issues, |
87 | // rationale for using (U) not (T) is to reduce signed/unsigned issues, |
| 79 | // as a is often a constant while b is the variable. it is still a bug, though. |
88 | // as a is often a constant while b is the variable. it is still a bug, though. |
| 80 | template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } |
89 | template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } |
| 81 | template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } |
90 | template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } |
| 82 | template<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; } |
91 | template<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; } |
| 83 | |
92 | |
|
|
93 | template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); } |
|
|
94 | template<typename T, typename U> static inline void max_it (T &v, U m) { v = max (v, (T)m); } |
|
|
95 | template<typename T, typename U, typename V> static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); } |
|
|
96 | |
| 84 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
97 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
| 85 | |
98 | |
|
|
99 | template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); } |
|
|
100 | template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); } |
|
|
101 | |
|
|
102 | // sign returns -1 or +1 |
|
|
103 | template<typename T> |
|
|
104 | static inline T sign (T v) { return v < 0 ? -1 : +1; } |
|
|
105 | // relies on 2c representation |
|
|
106 | template<> |
|
|
107 | inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); } |
|
|
108 | template<> |
|
|
109 | inline sint16 sign (sint16 v) { return 1 - (sint16 (uint16 (v) >> 15) * 2); } |
|
|
110 | template<> |
|
|
111 | inline sint32 sign (sint32 v) { return 1 - (sint32 (uint32 (v) >> 31) * 2); } |
|
|
112 | |
|
|
113 | // sign0 returns -1, 0 or +1 |
|
|
114 | template<typename T> |
|
|
115 | static inline T sign0 (T v) { return v ? sign (v) : 0; } |
|
|
116 | |
|
|
117 | template<typename T, typename U> |
|
|
118 | static inline T copysign (T a, U b) { return a > 0 ? b : -b; } |
|
|
119 | |
|
|
120 | // div* only work correctly for div > 0 |
|
|
121 | // div, with correct rounding (< 0.5 downwards, >=0.5 upwards) |
|
|
122 | template<typename T> static inline T div (T val, T div) |
|
|
123 | { |
|
|
124 | return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div; |
|
|
125 | } |
|
|
126 | // div, round-up |
|
|
127 | template<typename T> static inline T div_ru (T val, T div) |
|
|
128 | { |
|
|
129 | return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div; |
|
|
130 | } |
|
|
131 | // div, round-down |
|
|
132 | template<typename T> static inline T div_rd (T val, T div) |
|
|
133 | { |
|
|
134 | return expect_false (val < 0) ? - ((-val + (div - 1) ) / div) : (val ) / div; |
|
|
135 | } |
|
|
136 | |
|
|
137 | // lerp* only work correctly for min_in < max_in |
|
|
138 | // Linear intERPolate, scales val from min_in..max_in to min_out..max_out |
| 86 | template<typename T> |
139 | template<typename T> |
| 87 | static inline T |
140 | static inline T |
| 88 | lerp (T val, T min_in, T max_in, T min_out, T max_out) |
141 | lerp (T val, T min_in, T max_in, T min_out, T max_out) |
| 89 | { |
142 | { |
| 90 | return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; |
143 | return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in); |
|
|
144 | } |
|
|
145 | |
|
|
146 | // lerp, round-down |
|
|
147 | template<typename T> |
|
|
148 | static inline T |
|
|
149 | lerp_rd (T val, T min_in, T max_in, T min_out, T max_out) |
|
|
150 | { |
|
|
151 | return min_out + div_rd<T> ((val - min_in) * (max_out - min_out), max_in - min_in); |
|
|
152 | } |
|
|
153 | |
|
|
154 | // lerp, round-up |
|
|
155 | template<typename T> |
|
|
156 | static inline T |
|
|
157 | lerp_ru (T val, T min_in, T max_in, T min_out, T max_out) |
|
|
158 | { |
|
|
159 | return min_out + div_ru<T> ((val - min_in) * (max_out - min_out), max_in - min_in); |
| 91 | } |
160 | } |
| 92 | |
161 | |
| 93 | // lots of stuff taken from FXT |
162 | // lots of stuff taken from FXT |
| 94 | |
163 | |
| 95 | /* Rotate right. This is used in various places for checksumming */ |
164 | /* Rotate right. This is used in various places for checksumming */ |
| … | |
… | |
| 133 | int32_t d = b - a; |
202 | int32_t d = b - a; |
| 134 | d &= d >> 31; |
203 | d &= d >> 31; |
| 135 | return b - d; |
204 | return b - d; |
| 136 | } |
205 | } |
| 137 | |
206 | |
| 138 | // this is much faster than crossfires original algorithm |
207 | // this is much faster than crossfire's original algorithm |
| 139 | // on modern cpus |
208 | // on modern cpus |
| 140 | inline int |
209 | inline int |
| 141 | isqrt (int n) |
210 | isqrt (int n) |
| 142 | { |
211 | { |
| 143 | return (int)sqrtf ((float)n); |
212 | return (int)sqrtf ((float)n); |
|
|
213 | } |
|
|
214 | |
|
|
215 | // this is kind of like the ^^ operator, if it would exist, without sequence point. |
|
|
216 | // more handy than it looks like, due to the implicit !! done on its arguments |
|
|
217 | inline bool |
|
|
218 | logical_xor (bool a, bool b) |
|
|
219 | { |
|
|
220 | return a != b; |
|
|
221 | } |
|
|
222 | |
|
|
223 | inline bool |
|
|
224 | logical_implies (bool a, bool b) |
|
|
225 | { |
|
|
226 | return a <= b; |
| 144 | } |
227 | } |
| 145 | |
228 | |
| 146 | // this is only twice as fast as naive sqrtf (dx*dy+dy*dy) |
229 | // this is only twice as fast as naive sqrtf (dx*dy+dy*dy) |
| 147 | #if 0 |
230 | #if 0 |
| 148 | // and has a max. error of 6 in the range -100..+100. |
231 | // and has a max. error of 6 in the range -100..+100. |
| … | |
… | |
| 173 | absdir (int d) |
256 | absdir (int d) |
| 174 | { |
257 | { |
| 175 | return ((d - 1) & 7) + 1; |
258 | return ((d - 1) & 7) + 1; |
| 176 | } |
259 | } |
| 177 | |
260 | |
|
|
261 | // avoid ctz name because netbsd or freebsd spams it's namespace with it |
|
|
262 | #if GCC_VERSION(3,4) |
|
|
263 | static inline int least_significant_bit (uint32_t x) |
|
|
264 | { |
|
|
265 | return __builtin_ctz (x); |
|
|
266 | } |
|
|
267 | #else |
|
|
268 | int least_significant_bit (uint32_t x); |
|
|
269 | #endif |
|
|
270 | |
|
|
271 | #define for_all_bits_sparse_32(mask, idxvar) \ |
|
|
272 | for (uint32_t idxvar, mask_ = mask; \ |
|
|
273 | mask_ && ((idxvar = least_significant_bit (mask_)), mask_ &= ~(1 << idxvar), 1);) |
|
|
274 | |
|
|
275 | extern ssize_t slice_alloc; // statistics |
|
|
276 | |
|
|
277 | void *salloc_ (int n) throw (std::bad_alloc); |
|
|
278 | void *salloc_ (int n, void *src) throw (std::bad_alloc); |
|
|
279 | |
|
|
280 | // strictly the same as g_slice_alloc, but never returns 0 |
|
|
281 | template<typename T> |
|
|
282 | inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); } |
|
|
283 | |
|
|
284 | // also copies src into the new area, like "memdup" |
|
|
285 | // if src is 0, clears the memory |
|
|
286 | template<typename T> |
|
|
287 | inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); } |
|
|
288 | |
|
|
289 | // clears the memory |
|
|
290 | template<typename T> |
|
|
291 | inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); } |
|
|
292 | |
|
|
293 | // for symmetry |
|
|
294 | template<typename T> |
|
|
295 | inline void sfree (T *ptr, int n = 1) throw () |
|
|
296 | { |
|
|
297 | if (expect_true (ptr)) |
|
|
298 | { |
|
|
299 | slice_alloc -= n * sizeof (T); |
|
|
300 | if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T)); |
|
|
301 | g_slice_free1 (n * sizeof (T), (void *)ptr); |
|
|
302 | assert (slice_alloc >= 0);//D |
|
|
303 | } |
|
|
304 | } |
|
|
305 | |
|
|
306 | // nulls the pointer |
|
|
307 | template<typename T> |
|
|
308 | inline void sfree0 (T *&ptr, int n = 1) throw () |
|
|
309 | { |
|
|
310 | sfree<T> (ptr, n); |
|
|
311 | ptr = 0; |
|
|
312 | } |
|
|
313 | |
| 178 | // makes dynamically allocated objects zero-initialised |
314 | // makes dynamically allocated objects zero-initialised |
| 179 | struct zero_initialised |
315 | struct zero_initialised |
| 180 | { |
316 | { |
| 181 | void *operator new (size_t s, void *p) |
317 | void *operator new (size_t s, void *p) |
| 182 | { |
318 | { |
| … | |
… | |
| 184 | return p; |
320 | return p; |
| 185 | } |
321 | } |
| 186 | |
322 | |
| 187 | void *operator new (size_t s) |
323 | void *operator new (size_t s) |
| 188 | { |
324 | { |
| 189 | return g_slice_alloc0 (s); |
325 | return salloc0<char> (s); |
| 190 | } |
326 | } |
| 191 | |
327 | |
| 192 | void *operator new[] (size_t s) |
328 | void *operator new[] (size_t s) |
| 193 | { |
329 | { |
| 194 | return g_slice_alloc0 (s); |
330 | return salloc0<char> (s); |
| 195 | } |
331 | } |
| 196 | |
332 | |
| 197 | void operator delete (void *p, size_t s) |
333 | void operator delete (void *p, size_t s) |
| 198 | { |
334 | { |
| 199 | g_slice_free1 (s, p); |
335 | sfree ((char *)p, s); |
| 200 | } |
336 | } |
| 201 | |
337 | |
| 202 | void operator delete[] (void *p, size_t s) |
338 | void operator delete[] (void *p, size_t s) |
| 203 | { |
339 | { |
| 204 | g_slice_free1 (s, p); |
340 | sfree ((char *)p, s); |
| 205 | } |
341 | } |
| 206 | }; |
342 | }; |
| 207 | |
343 | |
| 208 | void *salloc_ (int n) throw (std::bad_alloc); |
344 | // makes dynamically allocated objects zero-initialised |
| 209 | void *salloc_ (int n, void *src) throw (std::bad_alloc); |
345 | struct slice_allocated |
| 210 | |
|
|
| 211 | // strictly the same as g_slice_alloc, but never returns 0 |
|
|
| 212 | template<typename T> |
|
|
| 213 | inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); } |
|
|
| 214 | |
|
|
| 215 | // also copies src into the new area, like "memdup" |
|
|
| 216 | // if src is 0, clears the memory |
|
|
| 217 | template<typename T> |
|
|
| 218 | inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); } |
|
|
| 219 | |
|
|
| 220 | // clears the memory |
|
|
| 221 | template<typename T> |
|
|
| 222 | inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); } |
|
|
| 223 | |
|
|
| 224 | // for symmetry |
|
|
| 225 | template<typename T> |
|
|
| 226 | inline void sfree (T *ptr, int n = 1) throw () |
|
|
| 227 | { |
346 | { |
| 228 | #ifdef PREFER_MALLOC |
347 | void *operator new (size_t s, void *p) |
| 229 | free (ptr); |
348 | { |
| 230 | #else |
349 | return p; |
| 231 | g_slice_free1 (n * sizeof (T), (void *)ptr); |
350 | } |
| 232 | #endif |
351 | |
| 233 | } |
352 | void *operator new (size_t s) |
|
|
353 | { |
|
|
354 | return salloc<char> (s); |
|
|
355 | } |
|
|
356 | |
|
|
357 | void *operator new[] (size_t s) |
|
|
358 | { |
|
|
359 | return salloc<char> (s); |
|
|
360 | } |
|
|
361 | |
|
|
362 | void operator delete (void *p, size_t s) |
|
|
363 | { |
|
|
364 | sfree ((char *)p, s); |
|
|
365 | } |
|
|
366 | |
|
|
367 | void operator delete[] (void *p, size_t s) |
|
|
368 | { |
|
|
369 | sfree ((char *)p, s); |
|
|
370 | } |
|
|
371 | }; |
| 234 | |
372 | |
| 235 | // a STL-compatible allocator that uses g_slice |
373 | // a STL-compatible allocator that uses g_slice |
| 236 | // boy, this is verbose |
374 | // boy, this is verbose |
| 237 | template<typename Tp> |
375 | template<typename Tp> |
| 238 | struct slice_allocator |
376 | struct slice_allocator |
| … | |
… | |
| 250 | { |
388 | { |
| 251 | typedef slice_allocator<U> other; |
389 | typedef slice_allocator<U> other; |
| 252 | }; |
390 | }; |
| 253 | |
391 | |
| 254 | slice_allocator () throw () { } |
392 | slice_allocator () throw () { } |
| 255 | slice_allocator (const slice_allocator &o) throw () { } |
393 | slice_allocator (const slice_allocator &) throw () { } |
| 256 | template<typename Tp2> |
394 | template<typename Tp2> |
| 257 | slice_allocator (const slice_allocator<Tp2> &) throw () { } |
395 | slice_allocator (const slice_allocator<Tp2> &) throw () { } |
| 258 | |
396 | |
| 259 | ~slice_allocator () { } |
397 | ~slice_allocator () { } |
| 260 | |
398 | |
| … | |
… | |
| 269 | void deallocate (pointer p, size_type n) |
407 | void deallocate (pointer p, size_type n) |
| 270 | { |
408 | { |
| 271 | sfree<Tp> (p, n); |
409 | sfree<Tp> (p, n); |
| 272 | } |
410 | } |
| 273 | |
411 | |
| 274 | size_type max_size ()const throw () |
412 | size_type max_size () const throw () |
| 275 | { |
413 | { |
| 276 | return size_t (-1) / sizeof (Tp); |
414 | return size_t (-1) / sizeof (Tp); |
| 277 | } |
415 | } |
| 278 | |
416 | |
| 279 | void construct (pointer p, const Tp &val) |
417 | void construct (pointer p, const Tp &val) |
| … | |
… | |
| 290 | // P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. |
428 | // P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. |
| 291 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps |
429 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps |
| 292 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps |
430 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps |
| 293 | struct tausworthe_random_generator |
431 | struct tausworthe_random_generator |
| 294 | { |
432 | { |
| 295 | // generator |
|
|
| 296 | uint32_t state [4]; |
433 | uint32_t state [4]; |
| 297 | |
434 | |
| 298 | void operator =(const tausworthe_random_generator &src) |
435 | void operator =(const tausworthe_random_generator &src) |
| 299 | { |
436 | { |
| 300 | state [0] = src.state [0]; |
437 | state [0] = src.state [0]; |
| … | |
… | |
| 303 | state [3] = src.state [3]; |
440 | state [3] = src.state [3]; |
| 304 | } |
441 | } |
| 305 | |
442 | |
| 306 | void seed (uint32_t seed); |
443 | void seed (uint32_t seed); |
| 307 | uint32_t next (); |
444 | uint32_t next (); |
|
|
445 | }; |
| 308 | |
446 | |
| 309 | // uniform distribution |
447 | // Xorshift RNGs, George Marsaglia |
|
|
448 | // http://www.jstatsoft.org/v08/i14/paper |
|
|
449 | // this one is about 40% faster than the tausworthe one above (i.e. not much), |
|
|
450 | // despite the inlining, and has the issue of only creating 2**32-1 numbers. |
|
|
451 | // see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf |
|
|
452 | struct xorshift_random_generator |
|
|
453 | { |
|
|
454 | uint32_t x, y; |
|
|
455 | |
|
|
456 | void operator =(const xorshift_random_generator &src) |
|
|
457 | { |
|
|
458 | x = src.x; |
|
|
459 | y = src.y; |
|
|
460 | } |
|
|
461 | |
|
|
462 | void seed (uint32_t seed) |
|
|
463 | { |
|
|
464 | x = seed; |
|
|
465 | y = seed * 69069U; |
|
|
466 | } |
|
|
467 | |
|
|
468 | uint32_t next () |
|
|
469 | { |
|
|
470 | uint32_t t = x ^ (x << 10); |
|
|
471 | x = y; |
|
|
472 | y = y ^ (y >> 13) ^ t ^ (t >> 10); |
|
|
473 | return y; |
|
|
474 | } |
|
|
475 | }; |
|
|
476 | |
|
|
477 | template<class generator> |
|
|
478 | struct random_number_generator : generator |
|
|
479 | { |
|
|
480 | // uniform distribution, 0 .. max (0, num - 1) |
| 310 | uint32_t operator ()(uint32_t num) |
481 | uint32_t operator ()(uint32_t num) |
| 311 | { |
482 | { |
| 312 | return is_constant (num) |
483 | return !is_constant (num) ? get_range (num) // non-constant |
| 313 | ? (next () * (uint64_t)num) >> 32U |
484 | : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two |
| 314 | : get_range (num); |
485 | : this->next () & (num - 1); // constant, power-of-two |
| 315 | } |
486 | } |
| 316 | |
487 | |
| 317 | // return a number within (min .. max) |
488 | // return a number within the closed interval [min .. max] |
| 318 | int operator () (int r_min, int r_max) |
489 | int operator () (int r_min, int r_max) |
| 319 | { |
490 | { |
| 320 | return is_constant (r_min) && is_constant (r_max) && r_min <= r_max |
491 | return is_constant (r_min) && is_constant (r_max) && r_min <= r_max |
| 321 | ? r_min + operator ()(r_max - r_min + 1) |
492 | ? r_min + operator ()(r_max - r_min + 1) |
| 322 | : get_range (r_min, r_max); |
493 | : get_range (r_min, r_max); |
| 323 | } |
494 | } |
| 324 | |
495 | |
|
|
496 | // return a number within the closed interval [0..1] |
| 325 | double operator ()() |
497 | double operator ()() |
| 326 | { |
498 | { |
| 327 | return this->next () / (double)0xFFFFFFFFU; |
499 | return this->next () / (double)0xFFFFFFFFU; |
| 328 | } |
500 | } |
| 329 | |
501 | |
| 330 | protected: |
502 | protected: |
| 331 | uint32_t get_range (uint32_t r_max); |
503 | uint32_t get_range (uint32_t r_max); |
| 332 | int get_range (int r_min, int r_max); |
504 | int get_range (int r_min, int r_max); |
| 333 | }; |
505 | }; |
| 334 | |
506 | |
| 335 | typedef tausworthe_random_generator rand_gen; |
507 | typedef random_number_generator<tausworthe_random_generator> rand_gen; |
| 336 | |
508 | |
| 337 | extern rand_gen rndm; |
509 | extern rand_gen rndm, rmg_rndm; |
|
|
510 | |
|
|
511 | INTERFACE_CLASS (attachable) |
|
|
512 | struct refcnt_base |
|
|
513 | { |
|
|
514 | typedef int refcnt_t; |
|
|
515 | mutable refcnt_t ACC (RW, refcnt); |
|
|
516 | |
|
|
517 | MTH void refcnt_inc () const { ++refcnt; } |
|
|
518 | MTH void refcnt_dec () const { --refcnt; } |
|
|
519 | |
|
|
520 | refcnt_base () : refcnt (0) { } |
|
|
521 | }; |
|
|
522 | |
|
|
523 | // to avoid branches with more advanced compilers |
|
|
524 | extern refcnt_base::refcnt_t refcnt_dummy; |
| 338 | |
525 | |
| 339 | template<class T> |
526 | template<class T> |
| 340 | struct refptr |
527 | struct refptr |
| 341 | { |
528 | { |
|
|
529 | // p if not null |
|
|
530 | refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; } |
|
|
531 | |
|
|
532 | void refcnt_dec () |
|
|
533 | { |
|
|
534 | if (!is_constant (p)) |
|
|
535 | --*refcnt_ref (); |
|
|
536 | else if (p) |
|
|
537 | --p->refcnt; |
|
|
538 | } |
|
|
539 | |
|
|
540 | void refcnt_inc () |
|
|
541 | { |
|
|
542 | if (!is_constant (p)) |
|
|
543 | ++*refcnt_ref (); |
|
|
544 | else if (p) |
|
|
545 | ++p->refcnt; |
|
|
546 | } |
|
|
547 | |
| 342 | T *p; |
548 | T *p; |
| 343 | |
549 | |
| 344 | refptr () : p(0) { } |
550 | refptr () : p(0) { } |
| 345 | refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } |
551 | refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); } |
| 346 | refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } |
552 | refptr (T *p) : p(p) { refcnt_inc (); } |
| 347 | ~refptr () { if (p) p->refcnt_dec (); } |
553 | ~refptr () { refcnt_dec (); } |
| 348 | |
554 | |
| 349 | const refptr<T> &operator =(T *o) |
555 | const refptr<T> &operator =(T *o) |
| 350 | { |
556 | { |
|
|
557 | // if decrementing ever destroys we need to reverse the order here |
| 351 | if (p) p->refcnt_dec (); |
558 | refcnt_dec (); |
| 352 | p = o; |
559 | p = o; |
| 353 | if (p) p->refcnt_inc (); |
560 | refcnt_inc (); |
| 354 | |
|
|
| 355 | return *this; |
561 | return *this; |
| 356 | } |
562 | } |
| 357 | |
563 | |
| 358 | const refptr<T> &operator =(const refptr<T> o) |
564 | const refptr<T> &operator =(const refptr<T> &o) |
| 359 | { |
565 | { |
| 360 | *this = o.p; |
566 | *this = o.p; |
| 361 | return *this; |
567 | return *this; |
| 362 | } |
568 | } |
| 363 | |
569 | |
| 364 | T &operator * () const { return *p; } |
570 | T &operator * () const { return *p; } |
| 365 | T *operator ->() const { return p; } |
571 | T *operator ->() const { return p; } |
| 366 | |
572 | |
| 367 | operator T *() const { return p; } |
573 | operator T *() const { return p; } |
| 368 | }; |
574 | }; |
| 369 | |
575 | |
| 370 | typedef refptr<maptile> maptile_ptr; |
576 | typedef refptr<maptile> maptile_ptr; |
| 371 | typedef refptr<object> object_ptr; |
577 | typedef refptr<object> object_ptr; |
| 372 | typedef refptr<archetype> arch_ptr; |
578 | typedef refptr<archetype> arch_ptr; |
| 373 | typedef refptr<client> client_ptr; |
579 | typedef refptr<client> client_ptr; |
| 374 | typedef refptr<player> player_ptr; |
580 | typedef refptr<player> player_ptr; |
|
|
581 | typedef refptr<region> region_ptr; |
|
|
582 | |
|
|
583 | #define STRHSH_NULL 2166136261 |
|
|
584 | |
|
|
585 | static inline uint32_t |
|
|
586 | strhsh (const char *s) |
|
|
587 | { |
|
|
588 | // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/) |
|
|
589 | // it is about twice as fast as the one-at-a-time one, |
|
|
590 | // with good distribution. |
|
|
591 | // FNV-1a is faster on many cpus because the multiplication |
|
|
592 | // runs concurrently with the looping logic. |
|
|
593 | uint32_t hash = STRHSH_NULL; |
|
|
594 | |
|
|
595 | while (*s) |
|
|
596 | hash = (hash ^ *s++) * 16777619U; |
|
|
597 | |
|
|
598 | return hash; |
|
|
599 | } |
|
|
600 | |
|
|
601 | static inline uint32_t |
|
|
602 | memhsh (const char *s, size_t len) |
|
|
603 | { |
|
|
604 | uint32_t hash = STRHSH_NULL; |
|
|
605 | |
|
|
606 | while (len--) |
|
|
607 | hash = (hash ^ *s++) * 16777619U; |
|
|
608 | |
|
|
609 | return hash; |
|
|
610 | } |
| 375 | |
611 | |
| 376 | struct str_hash |
612 | struct str_hash |
| 377 | { |
613 | { |
| 378 | std::size_t operator ()(const char *s) const |
614 | std::size_t operator ()(const char *s) const |
| 379 | { |
615 | { |
| 380 | unsigned long hash = 0; |
|
|
| 381 | |
|
|
| 382 | /* use the one-at-a-time hash function, which supposedly is |
|
|
| 383 | * better than the djb2-like one used by perl5.005, but |
|
|
| 384 | * certainly is better then the bug used here before. |
|
|
| 385 | * see http://burtleburtle.net/bob/hash/doobs.html |
|
|
| 386 | */ |
|
|
| 387 | while (*s) |
|
|
| 388 | { |
|
|
| 389 | hash += *s++; |
|
|
| 390 | hash += hash << 10; |
|
|
| 391 | hash ^= hash >> 6; |
|
|
| 392 | } |
|
|
| 393 | |
|
|
| 394 | hash += hash << 3; |
|
|
| 395 | hash ^= hash >> 11; |
|
|
| 396 | hash += hash << 15; |
|
|
| 397 | |
|
|
| 398 | return hash; |
616 | return strhsh (s); |
|
|
617 | } |
|
|
618 | |
|
|
619 | std::size_t operator ()(const shstr &s) const |
|
|
620 | { |
|
|
621 | return strhsh (s); |
| 399 | } |
622 | } |
| 400 | }; |
623 | }; |
| 401 | |
624 | |
| 402 | struct str_equal |
625 | struct str_equal |
| 403 | { |
626 | { |
| … | |
… | |
| 405 | { |
628 | { |
| 406 | return !strcmp (a, b); |
629 | return !strcmp (a, b); |
| 407 | } |
630 | } |
| 408 | }; |
631 | }; |
| 409 | |
632 | |
|
|
633 | // Mostly the same as std::vector, but insert/erase can reorder |
|
|
634 | // the elements, making append(=insert)/remove O(1) instead of O(n). |
|
|
635 | // |
|
|
636 | // NOTE: only some forms of erase are available |
| 410 | template<class T> |
637 | template<class T> |
| 411 | struct unordered_vector : std::vector<T, slice_allocator<T> > |
638 | struct unordered_vector : std::vector<T, slice_allocator<T> > |
| 412 | { |
639 | { |
| 413 | typedef typename unordered_vector::iterator iterator; |
640 | typedef typename unordered_vector::iterator iterator; |
| 414 | |
641 | |
| … | |
… | |
| 424 | { |
651 | { |
| 425 | erase ((unsigned int )(i - this->begin ())); |
652 | erase ((unsigned int )(i - this->begin ())); |
| 426 | } |
653 | } |
| 427 | }; |
654 | }; |
| 428 | |
655 | |
| 429 | template<class T, int T::* index> |
656 | // This container blends advantages of linked lists |
|
|
657 | // (efficiency) with vectors (random access) by |
|
|
658 | // by using an unordered vector and storing the vector |
|
|
659 | // index inside the object. |
|
|
660 | // |
|
|
661 | // + memory-efficient on most 64 bit archs |
|
|
662 | // + O(1) insert/remove |
|
|
663 | // + free unique (but varying) id for inserted objects |
|
|
664 | // + cache-friendly iteration |
|
|
665 | // - only works for pointers to structs |
|
|
666 | // |
|
|
667 | // NOTE: only some forms of erase/insert are available |
|
|
668 | typedef int object_vector_index; |
|
|
669 | |
|
|
670 | template<class T, object_vector_index T::*indexmember> |
| 430 | struct object_vector : std::vector<T *, slice_allocator<T *> > |
671 | struct object_vector : std::vector<T *, slice_allocator<T *> > |
| 431 | { |
672 | { |
|
|
673 | typedef typename object_vector::iterator iterator; |
|
|
674 | |
|
|
675 | bool contains (const T *obj) const |
|
|
676 | { |
|
|
677 | return obj->*indexmember; |
|
|
678 | } |
|
|
679 | |
|
|
680 | iterator find (const T *obj) |
|
|
681 | { |
|
|
682 | return obj->*indexmember |
|
|
683 | ? this->begin () + obj->*indexmember - 1 |
|
|
684 | : this->end (); |
|
|
685 | } |
|
|
686 | |
|
|
687 | void push_back (T *obj) |
|
|
688 | { |
|
|
689 | std::vector<T *, slice_allocator<T *> >::push_back (obj); |
|
|
690 | obj->*indexmember = this->size (); |
|
|
691 | } |
|
|
692 | |
| 432 | void insert (T *obj) |
693 | void insert (T *obj) |
| 433 | { |
694 | { |
| 434 | assert (!(obj->*index)); |
|
|
| 435 | push_back (obj); |
695 | push_back (obj); |
| 436 | obj->*index = this->size (); |
|
|
| 437 | } |
696 | } |
| 438 | |
697 | |
| 439 | void insert (T &obj) |
698 | void insert (T &obj) |
| 440 | { |
699 | { |
| 441 | insert (&obj); |
700 | insert (&obj); |
| 442 | } |
701 | } |
| 443 | |
702 | |
| 444 | void erase (T *obj) |
703 | void erase (T *obj) |
| 445 | { |
704 | { |
| 446 | assert (obj->*index); |
|
|
| 447 | unsigned int pos = obj->*index; |
705 | unsigned int pos = obj->*indexmember; |
| 448 | obj->*index = 0; |
706 | obj->*indexmember = 0; |
| 449 | |
707 | |
| 450 | if (pos < this->size ()) |
708 | if (pos < this->size ()) |
| 451 | { |
709 | { |
| 452 | (*this)[pos - 1] = (*this)[this->size () - 1]; |
710 | (*this)[pos - 1] = (*this)[this->size () - 1]; |
| 453 | (*this)[pos - 1]->*index = pos; |
711 | (*this)[pos - 1]->*indexmember = pos; |
| 454 | } |
712 | } |
| 455 | |
713 | |
| 456 | this->pop_back (); |
714 | this->pop_back (); |
| 457 | } |
715 | } |
| 458 | |
716 | |
| 459 | void erase (T &obj) |
717 | void erase (T &obj) |
| 460 | { |
718 | { |
| 461 | errase (&obj); |
719 | erase (&obj); |
| 462 | } |
720 | } |
| 463 | }; |
721 | }; |
| 464 | |
722 | |
| 465 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
723 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
|
|
724 | // returns the number of bytes actually used (including \0) |
| 466 | void assign (char *dst, const char *src, int maxlen); |
725 | int assign (char *dst, const char *src, int maxsize); |
| 467 | |
726 | |
| 468 | // type-safe version of assign |
727 | // type-safe version of assign |
| 469 | template<int N> |
728 | template<int N> |
| 470 | inline void assign (char (&dst)[N], const char *src) |
729 | inline int assign (char (&dst)[N], const char *src) |
| 471 | { |
730 | { |
| 472 | assign ((char *)&dst, src, N); |
731 | return assign ((char *)&dst, src, N); |
| 473 | } |
732 | } |
| 474 | |
733 | |
| 475 | typedef double tstamp; |
734 | typedef double tstamp; |
| 476 | |
735 | |
| 477 | // return current time as timestampe |
736 | // return current time as timestamp |
| 478 | tstamp now (); |
737 | tstamp now (); |
| 479 | |
738 | |
| 480 | int similar_direction (int a, int b); |
739 | int similar_direction (int a, int b); |
| 481 | |
740 | |
| 482 | // like printf, but returns a std::string |
741 | // like v?sprintf, but returns a "static" buffer |
| 483 | const std::string format (const char *format, ...); |
742 | char *vformat (const char *format, va_list ap); |
|
|
743 | char *format (const char *format, ...) attribute ((format (printf, 1, 2))); |
| 484 | |
744 | |
|
|
745 | // safety-check player input which will become object->msg |
|
|
746 | bool msg_is_safe (const char *msg); |
|
|
747 | |
|
|
748 | ///////////////////////////////////////////////////////////////////////////// |
|
|
749 | // threads, very very thin wrappers around pthreads |
|
|
750 | |
|
|
751 | struct thread |
|
|
752 | { |
|
|
753 | pthread_t id; |
|
|
754 | |
|
|
755 | void start (void *(*start_routine)(void *), void *arg = 0); |
|
|
756 | |
|
|
757 | void cancel () |
|
|
758 | { |
|
|
759 | pthread_cancel (id); |
|
|
760 | } |
|
|
761 | |
|
|
762 | void *join () |
|
|
763 | { |
|
|
764 | void *ret; |
|
|
765 | |
|
|
766 | if (pthread_join (id, &ret)) |
|
|
767 | cleanup ("pthread_join failed", 1); |
|
|
768 | |
|
|
769 | return ret; |
|
|
770 | } |
|
|
771 | }; |
|
|
772 | |
|
|
773 | // note that mutexes are not classes |
|
|
774 | typedef pthread_mutex_t smutex; |
|
|
775 | |
|
|
776 | #if __linux && defined (PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP) |
|
|
777 | #define SMUTEX_INITIALISER PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP |
|
|
778 | #else |
|
|
779 | #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER |
| 485 | #endif |
780 | #endif |
| 486 | |
781 | |
|
|
782 | #define SMUTEX(name) smutex name = SMUTEX_INITIALISER |
|
|
783 | #define SMUTEX_LOCK(name) pthread_mutex_lock (&(name)) |
|
|
784 | #define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name)) |
|
|
785 | |
|
|
786 | typedef pthread_cond_t scond; |
|
|
787 | |
|
|
788 | #define SCOND(name) scond name = PTHREAD_COND_INITIALIZER |
|
|
789 | #define SCOND_SIGNAL(name) pthread_cond_signal (&(name)) |
|
|
790 | #define SCOND_BROADCAST(name) pthread_cond_broadcast (&(name)) |
|
|
791 | #define SCOND_WAIT(name,mutex) pthread_cond_wait (&(name), &(mutex)) |
|
|
792 | |
|
|
793 | #endif |
|
|
794 | |
