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.56 by root, Sun Sep 9 06:25:46 2007 UTC vs.
Revision 1.89 by sf-marcmagus, Sun Oct 11 01:35:52 2009 UTC

1/* 1/*
2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. 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 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * 5 *
6 * Crossfire TRT is free software: you can redistribute it and/or modify 6 * Deliantra is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by 7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or 8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version. 9 * (at your option) any later version.
10 * 10 *
11 * This program is distributed in the hope that it will be useful, 11 * This program is distributed in the hope that it will be useful,
… …
14 * GNU General Public License for more details. 14 * GNU General Public License for more details.
15 * 15 *
16 * You should have received a copy of the GNU General Public License 16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>. 17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 * 18 *
19 * The authors can be reached via e-mail to <crossfire@schmorp.de> 19 * The authors can be reached via e-mail to <support@deliantra.net>
20 */ 20 */
21 21
22#ifndef UTIL_H__ 22#ifndef UTIL_H__
23#define UTIL_H__ 23#define UTIL_H__
24 24
25//#define PREFER_MALLOC 25#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0
26#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs
27#define PREFER_MALLOC 0 // use malloc and not the slice allocator
26 28
27#if __GNUC__ >= 3 29#if __GNUC__ >= 3
28# define is_constant(c) __builtin_constant_p (c) 30# define is_constant(c) __builtin_constant_p (c)
29# define expect(expr,value) __builtin_expect ((expr),(value)) 31# define expect(expr,value) __builtin_expect ((expr),(value))
30# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality) 32# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
33# define noinline __attribute__((__noinline__))
31#else 34#else
32# define is_constant(c) 0 35# define is_constant(c) 0
33# define expect(expr,value) (expr) 36# define expect(expr,value) (expr)
34# define prefetch(addr,rw,locality) 37# define prefetch(addr,rw,locality)
38# define noinline
35#endif 39#endif
36 40
37#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4) 41#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
38# define decltype(x) typeof(x) 42# define decltype(x) typeof(x)
39#endif 43#endif
40 44
41// put into ifs if you are very sure that the expression 45// put into ifs if you are very sure that the expression
42// is mostly true or mosty false. note that these return 46// is mostly true or mosty false. note that these return
43// booleans, not the expression. 47// booleans, not the expression.
44#define expect_false(expr) expect ((expr) != 0, 0) 48#define expect_false(expr) expect ((expr) ? 1 : 0, 0)
45#define expect_true(expr) expect ((expr) != 0, 1) 49#define expect_true(expr) expect ((expr) ? 1 : 0, 1)
50
51#include <pthread.h>
46 52
47#include <cstddef> 53#include <cstddef>
48#include <cmath> 54#include <cmath>
49#include <new> 55#include <new>
50#include <vector> 56#include <vector>
… …
52#include <glib.h> 58#include <glib.h>
53 59
54#include <shstr.h> 60#include <shstr.h>
55#include <traits.h> 61#include <traits.h>
56 62
63#if DEBUG_SALLOC
64# define g_slice_alloc0(s) debug_slice_alloc0(s)
65# define g_slice_alloc(s) debug_slice_alloc(s)
66# define g_slice_free1(s,p) debug_slice_free1(s,p)
67void *g_slice_alloc (unsigned long size);
68void *g_slice_alloc0 (unsigned long size);
69void g_slice_free1 (unsigned long size, void *ptr);
70#elif PREFER_MALLOC
71# define g_slice_alloc0(s) calloc (1, (s))
72# define g_slice_alloc(s) malloc ((s))
73# define g_slice_free1(s,p) free ((p))
74#endif
75
57// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever) 76// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever)
58#define auto(var,expr) decltype(expr) var = (expr) 77#define auto(var,expr) decltype(expr) var = (expr)
59 78
60// very ugly macro that basicaly declares and initialises a variable 79// very ugly macro that basically declares and initialises a variable
61// that is in scope for the next statement only 80// that is in scope for the next statement only
62// works only for stuff that can be assigned 0 and converts to false 81// works only for stuff that can be assigned 0 and converts to false
63// (note: works great for pointers) 82// (note: works great for pointers)
64// most ugly macro I ever wrote 83// most ugly macro I ever wrote
65#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) 84#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1)
… …
70 89
71// in range excluding end 90// in range excluding end
72#define IN_RANGE_EXC(val,beg,end) \ 91#define IN_RANGE_EXC(val,beg,end) \
73 ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg)) 92 ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg))
74 93
94void cleanup (const char *cause, bool make_core = false);
75void fork_abort (const char *msg); 95void fork_abort (const char *msg);
76 96
77// rationale for using (U) not (T) is to reduce signed/unsigned issues, 97// rationale for using (U) not (T) is to reduce signed/unsigned issues,
78// as a is often a constant while b is the variable. it is still a bug, though. 98// as a is often a constant while b is the variable. it is still a bug, though.
79template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } 99template<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 max (T a, U b) { return (U)a > b ? (U)a : b; } 100template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; }
81template<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; } 101template<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; }
82 102
103template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); }
104template<typename T, typename U> static inline void max_it (T &v, U m) { v = max (v, (T)m); }
105template<typename T, typename U, typename V> static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); }
106
83template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } 107template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
84 108
109template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); }
110template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
111
112// sign returns -1 or +1
113template<typename T>
114static inline T sign (T v) { return v < 0 ? -1 : +1; }
115// relies on 2c representation
116template<>
117inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); }
118
119// sign0 returns -1, 0 or +1
120template<typename T>
121static inline T sign0 (T v) { return v ? sign (v) : 0; }
122
123// div* only work correctly for div > 0
124// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
125template<typename T> static inline T div (T val, T div)
126{
127 return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div;
128}
129// div, round-up
130template<typename T> static inline T div_ru (T val, T div)
131{
132 return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div;
133}
134// div, round-down
135template<typename T> static inline T div_rd (T val, T div)
136{
137 return expect_false (val < 0) ? - ((-val + (div - 1) ) / div) : (val ) / div;
138}
139
140// lerp* only work correctly for min_in < max_in
141// Linear intERPolate, scales val from min_in..max_in to min_out..max_out
85template<typename T> 142template<typename T>
86static inline T 143static inline T
87lerp (T val, T min_in, T max_in, T min_out, T max_out) 144lerp (T val, T min_in, T max_in, T min_out, T max_out)
88{ 145{
89 return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; 146 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in);
147}
148
149// lerp, round-down
150template<typename T>
151static inline T
152lerp_rd (T val, T min_in, T max_in, T min_out, T max_out)
153{
154 return min_out + div_rd<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
155}
156
157// lerp, round-up
158template<typename T>
159static inline T
160lerp_ru (T val, T min_in, T max_in, T min_out, T max_out)
161{
162 return min_out + div_ru<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
90} 163}
91 164
92// lots of stuff taken from FXT 165// lots of stuff taken from FXT
93 166
94/* Rotate right. This is used in various places for checksumming */ 167/* Rotate right. This is used in various places for checksumming */
… …
172absdir (int d) 245absdir (int d)
173{ 246{
174 return ((d - 1) & 7) + 1; 247 return ((d - 1) & 7) + 1;
175} 248}
176 249
250extern ssize_t slice_alloc; // statistics
251
252void *salloc_ (int n) throw (std::bad_alloc);
253void *salloc_ (int n, void *src) throw (std::bad_alloc);
254
255// strictly the same as g_slice_alloc, but never returns 0
256template<typename T>
257inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); }
258
259// also copies src into the new area, like "memdup"
260// if src is 0, clears the memory
261template<typename T>
262inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
263
264// clears the memory
265template<typename T>
266inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); }
267
268// for symmetry
269template<typename T>
270inline void sfree (T *ptr, int n = 1) throw ()
271{
272 if (expect_true (ptr))
273 {
274 slice_alloc -= n * sizeof (T);
275 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
276 g_slice_free1 (n * sizeof (T), (void *)ptr);
277 assert (slice_alloc >= 0);//D
278 }
279}
280
281// nulls the pointer
282template<typename T>
283inline void sfree0 (T *&ptr, int n = 1) throw ()
284{
285 sfree<T> (ptr, n);
286 ptr = 0;
287}
288
177// makes dynamically allocated objects zero-initialised 289// makes dynamically allocated objects zero-initialised
178struct zero_initialised 290struct zero_initialised
179{ 291{
180 void *operator new (size_t s, void *p) 292 void *operator new (size_t s, void *p)
181 { 293 {
… …
183 return p; 295 return p;
184 } 296 }
185 297
186 void *operator new (size_t s) 298 void *operator new (size_t s)
187 { 299 {
188 return g_slice_alloc0 (s); 300 return salloc0<char> (s);
189 } 301 }
190 302
191 void *operator new[] (size_t s) 303 void *operator new[] (size_t s)
192 { 304 {
193 return g_slice_alloc0 (s); 305 return salloc0<char> (s);
194 } 306 }
195 307
196 void operator delete (void *p, size_t s) 308 void operator delete (void *p, size_t s)
197 { 309 {
198 g_slice_free1 (s, p); 310 sfree ((char *)p, s);
199 } 311 }
200 312
201 void operator delete[] (void *p, size_t s) 313 void operator delete[] (void *p, size_t s)
202 { 314 {
203 g_slice_free1 (s, p); 315 sfree ((char *)p, s);
204 } 316 }
205}; 317};
206 318
207void *salloc_ (int n) throw (std::bad_alloc); 319// makes dynamically allocated objects zero-initialised
208void *salloc_ (int n, void *src) throw (std::bad_alloc); 320struct slice_allocated
209
210// strictly the same as g_slice_alloc, but never returns 0
211template<typename T>
212inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); }
213
214// also copies src into the new area, like "memdup"
215// if src is 0, clears the memory
216template<typename T>
217inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
218
219// clears the memory
220template<typename T>
221inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); }
222
223// for symmetry
224template<typename T>
225inline void sfree (T *ptr, int n = 1) throw ()
226{ 321{
227#ifdef PREFER_MALLOC 322 void *operator new (size_t s, void *p)
228 free (ptr); 323 {
229#else 324 return p;
230 g_slice_free1 (n * sizeof (T), (void *)ptr); 325 }
231#endif 326
232} 327 void *operator new (size_t s)
328 {
329 return salloc<char> (s);
330 }
331
332 void *operator new[] (size_t s)
333 {
334 return salloc<char> (s);
335 }
336
337 void operator delete (void *p, size_t s)
338 {
339 sfree ((char *)p, s);
340 }
341
342 void operator delete[] (void *p, size_t s)
343 {
344 sfree ((char *)p, s);
345 }
346};
233 347
234// a STL-compatible allocator that uses g_slice 348// a STL-compatible allocator that uses g_slice
235// boy, this is verbose 349// boy, this is verbose
236template<typename Tp> 350template<typename Tp>
237struct slice_allocator 351struct slice_allocator
… …
249 { 363 {
250 typedef slice_allocator<U> other; 364 typedef slice_allocator<U> other;
251 }; 365 };
252 366
253 slice_allocator () throw () { } 367 slice_allocator () throw () { }
254 slice_allocator (const slice_allocator &o) throw () { } 368 slice_allocator (const slice_allocator &) throw () { }
255 template<typename Tp2> 369 template<typename Tp2>
256 slice_allocator (const slice_allocator<Tp2> &) throw () { } 370 slice_allocator (const slice_allocator<Tp2> &) throw () { }
257 371
258 ~slice_allocator () { } 372 ~slice_allocator () { }
259 373
… …
268 void deallocate (pointer p, size_type n) 382 void deallocate (pointer p, size_type n)
269 { 383 {
270 sfree<Tp> (p, n); 384 sfree<Tp> (p, n);
271 } 385 }
272 386
273 size_type max_size ()const throw () 387 size_type max_size () const throw ()
274 { 388 {
275 return size_t (-1) / sizeof (Tp); 389 return size_t (-1) / sizeof (Tp);
276 } 390 }
277 391
278 void construct (pointer p, const Tp &val) 392 void construct (pointer p, const Tp &val)
… …
289// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. 403// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213.
290// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 404// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
291// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps 405// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
292struct tausworthe_random_generator 406struct tausworthe_random_generator
293{ 407{
294 // generator
295 uint32_t state [4]; 408 uint32_t state [4];
296 409
297 void operator =(const tausworthe_random_generator &src) 410 void operator =(const tausworthe_random_generator &src)
298 { 411 {
299 state [0] = src.state [0]; 412 state [0] = src.state [0];
… …
302 state [3] = src.state [3]; 415 state [3] = src.state [3];
303 } 416 }
304 417
305 void seed (uint32_t seed); 418 void seed (uint32_t seed);
306 uint32_t next (); 419 uint32_t next ();
420};
307 421
308 // uniform distribution 422// Xorshift RNGs, George Marsaglia
423// http://www.jstatsoft.org/v08/i14/paper
424// this one is about 40% faster than the tausworthe one above (i.e. not much),
425// despite the inlining, and has the issue of only creating 2**32-1 numbers.
426// see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf
427struct xorshift_random_generator
428{
429 uint32_t x, y;
430
431 void operator =(const xorshift_random_generator &src)
432 {
433 x = src.x;
434 y = src.y;
435 }
436
437 void seed (uint32_t seed)
438 {
439 x = seed;
440 y = seed * 69069U;
441 }
442
443 uint32_t next ()
444 {
445 uint32_t t = x ^ (x << 10);
446 x = y;
447 y = y ^ (y >> 13) ^ t ^ (t >> 10);
448 return y;
449 }
450};
451
452template<class generator>
453struct random_number_generator : generator
454{
455 // uniform distribution, 0 .. max (0, num - 1)
309 uint32_t operator ()(uint32_t num) 456 uint32_t operator ()(uint32_t num)
310 { 457 {
311 return is_constant (num) 458 return !is_constant (num) ? get_range (num) // non-constant
312 ? (next () * (uint64_t)num) >> 32U 459 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
313 : get_range (num); 460 : this->next () & (num - 1); // constant, power-of-two
314 } 461 }
315 462
316 // return a number within (min .. max) 463 // return a number within (min .. max)
317 int operator () (int r_min, int r_max) 464 int operator () (int r_min, int r_max)
318 { 465 {
… …
329protected: 476protected:
330 uint32_t get_range (uint32_t r_max); 477 uint32_t get_range (uint32_t r_max);
331 int get_range (int r_min, int r_max); 478 int get_range (int r_min, int r_max);
332}; 479};
333 480
334typedef tausworthe_random_generator rand_gen; 481typedef random_number_generator<tausworthe_random_generator> rand_gen;
335 482
336extern rand_gen rndm; 483extern rand_gen rndm, rmg_rndm;
337 484
338INTERFACE_CLASS (attachable) 485INTERFACE_CLASS (attachable)
339struct refcnt_base 486struct refcnt_base
340{ 487{
341 typedef int refcnt_t; 488 typedef int refcnt_t;
… …
408 555
409struct str_hash 556struct str_hash
410{ 557{
411 std::size_t operator ()(const char *s) const 558 std::size_t operator ()(const char *s) const
412 { 559 {
413 unsigned long hash = 0; 560#if 0
561 uint32_t hash = 0;
414 562
415 /* use the one-at-a-time hash function, which supposedly is 563 /* use the one-at-a-time hash function, which supposedly is
416 * better than the djb2-like one used by perl5.005, but 564 * better than the djb2-like one used by perl5.005, but
417 * certainly is better then the bug used here before. 565 * certainly is better then the bug used here before.
418 * see http://burtleburtle.net/bob/hash/doobs.html 566 * see http://burtleburtle.net/bob/hash/doobs.html
… …
425 } 573 }
426 574
427 hash += hash << 3; 575 hash += hash << 3;
428 hash ^= hash >> 11; 576 hash ^= hash >> 11;
429 hash += hash << 15; 577 hash += hash << 15;
578#else
579 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
580 // it is about twice as fast as the one-at-a-time one,
581 // with good distribution.
582 // FNV-1a is faster on many cpus because the multiplication
583 // runs concurrent with the looping logic.
584 uint32_t hash = 2166136261;
585
586 while (*s)
587 hash = (hash ^ *s++) * 16777619;
588#endif
430 589
431 return hash; 590 return hash;
432 } 591 }
433}; 592};
434 593
… …
529 erase (&obj); 688 erase (&obj);
530 } 689 }
531}; 690};
532 691
533// basically does what strncpy should do, but appends "..." to strings exceeding length 692// basically does what strncpy should do, but appends "..." to strings exceeding length
693// returns the number of bytes actually used (including \0)
534void assign (char *dst, const char *src, int maxlen); 694int assign (char *dst, const char *src, int maxsize);
535 695
536// type-safe version of assign 696// type-safe version of assign
537template<int N> 697template<int N>
538inline void assign (char (&dst)[N], const char *src) 698inline int assign (char (&dst)[N], const char *src)
539{ 699{
540 assign ((char *)&dst, src, N); 700 return assign ((char *)&dst, src, N);
541} 701}
542 702
543typedef double tstamp; 703typedef double tstamp;
544 704
545// return current time as timestampe 705// return current time as timestamp
546tstamp now (); 706tstamp now ();
547 707
548int similar_direction (int a, int b); 708int similar_direction (int a, int b);
549 709
550// like sprintf, but returns a "static" buffer 710// like sprintf, but returns a "static" buffer
551const char *format (const char *format, ...); 711const char *format (const char *format, ...);
552 712
713// safety-check player input which will become object->msg
714bool msg_is_safe (const char *msg);
715
716/////////////////////////////////////////////////////////////////////////////
717// threads, very very thin wrappers around pthreads
718
719struct thread
720{
721 pthread_t id;
722
723 void start (void *(*start_routine)(void *), void *arg = 0);
724
725 void cancel ()
726 {
727 pthread_cancel (id);
728 }
729
730 void *join ()
731 {
732 void *ret;
733
734 if (pthread_join (id, &ret))
735 cleanup ("pthread_join failed", 1);
736
737 return ret;
738 }
739};
740
741// note that mutexes are not classes
742typedef pthread_mutex_t smutex;
743
744#if __linux && defined (PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP)
745 #define SMUTEX_INITIALISER PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
746#else
747 #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER
553#endif 748#endif
554 749
750#define SMUTEX(name) smutex name = SMUTEX_INITIALISER
751#define SMUTEX_LOCK(name) pthread_mutex_lock (&(name))
752#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name))
753
754typedef pthread_cond_t scond;
755
756#define SCOND(name) scond name = PTHREAD_COND_INITIALIZER
757#define SCOND_SIGNAL(name) pthread_cond_signal (&(name))
758#define SCOND_BROADCAST(name) pthread_cond_broadcast (&(name))
759#define SCOND_WAIT(name,mutex) pthread_cond_wait (&(name), &(mutex))
760
761#endif
762

Diff Legend

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