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.65 by root, Tue Apr 1 19:50:38 2008 UTC vs.
Revision 1.88 by root, Tue May 5 04:51:56 2009 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 (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * 5 *
6 * Deliantra 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.
… …
20 */ 20 */
21 21
22#ifndef UTIL_H__ 22#ifndef UTIL_H__
23#define UTIL_H__ 23#define UTIL_H__
24 24
25#define DEBUG_SALLOC 0 25#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0
26#define PREFER_MALLOC 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
27 28
28#if __GNUC__ >= 3 29#if __GNUC__ >= 3
29# define is_constant(c) __builtin_constant_p (c) 30# define is_constant(c) __builtin_constant_p (c)
30# define expect(expr,value) __builtin_expect ((expr),(value)) 31# define expect(expr,value) __builtin_expect ((expr),(value))
31# 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__))
32#else 34#else
33# define is_constant(c) 0 35# define is_constant(c) 0
34# define expect(expr,value) (expr) 36# define expect(expr,value) (expr)
35# define prefetch(addr,rw,locality) 37# define prefetch(addr,rw,locality)
38# define noinline
36#endif 39#endif
37 40
38#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4) 41#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
39# define decltype(x) typeof(x) 42# define decltype(x) typeof(x)
40#endif 43#endif
41 44
42// put into ifs if you are very sure that the expression 45// put into ifs if you are very sure that the expression
43// is mostly true or mosty false. note that these return 46// is mostly true or mosty false. note that these return
44// booleans, not the expression. 47// booleans, not the expression.
45#define expect_false(expr) expect ((expr) != 0, 0) 48#define expect_false(expr) expect ((expr) ? 1 : 0, 0)
46#define expect_true(expr) expect ((expr) != 0, 1) 49#define expect_true(expr) expect ((expr) ? 1 : 0, 1)
50
51#include <pthread.h>
47 52
48#include <cstddef> 53#include <cstddef>
49#include <cmath> 54#include <cmath>
50#include <new> 55#include <new>
51#include <vector> 56#include <vector>
… …
60# define g_slice_alloc(s) debug_slice_alloc(s) 65# define g_slice_alloc(s) debug_slice_alloc(s)
61# define g_slice_free1(s,p) debug_slice_free1(s,p) 66# define g_slice_free1(s,p) debug_slice_free1(s,p)
62void *g_slice_alloc (unsigned long size); 67void *g_slice_alloc (unsigned long size);
63void *g_slice_alloc0 (unsigned long size); 68void *g_slice_alloc0 (unsigned long size);
64void g_slice_free1 (unsigned long size, void *ptr); 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))
65#endif 74#endif
66 75
67// 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)
68#define auto(var,expr) decltype(expr) var = (expr) 77#define auto(var,expr) decltype(expr) var = (expr)
69 78
70// very ugly macro that basicaly declares and initialises a variable 79// very ugly macro that basically declares and initialises a variable
71// that is in scope for the next statement only 80// that is in scope for the next statement only
72// 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
73// (note: works great for pointers) 82// (note: works great for pointers)
74// most ugly macro I ever wrote 83// most ugly macro I ever wrote
75#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)
… …
80 89
81// in range excluding end 90// in range excluding end
82#define IN_RANGE_EXC(val,beg,end) \ 91#define IN_RANGE_EXC(val,beg,end) \
83 ((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))
84 93
94void cleanup (const char *cause, bool make_core = false);
85void fork_abort (const char *msg); 95void fork_abort (const char *msg);
86 96
87// 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,
88// 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.
89template<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; }
90template<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; }
91template<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; }
92 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
93template<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; }
94 108
95template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); } 109template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); }
96template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (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)); }
97 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
98template<typename T> 142template<typename T>
99static inline T 143static inline T
100lerp (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)
101{ 145{
102 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);
103} 163}
104 164
105// lots of stuff taken from FXT 165// lots of stuff taken from FXT
106 166
107/* Rotate right. This is used in various places for checksumming */ 167/* Rotate right. This is used in various places for checksumming */
… …
185absdir (int d) 245absdir (int d)
186{ 246{
187 return ((d - 1) & 7) + 1; 247 return ((d - 1) & 7) + 1;
188} 248}
189 249
190extern size_t slice_alloc; // statistics 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}
191 288
192// makes dynamically allocated objects zero-initialised 289// makes dynamically allocated objects zero-initialised
193struct zero_initialised 290struct zero_initialised
194{ 291{
195 void *operator new (size_t s, void *p) 292 void *operator new (size_t s, void *p)
… …
198 return p; 295 return p;
199 } 296 }
200 297
201 void *operator new (size_t s) 298 void *operator new (size_t s)
202 { 299 {
203 slice_alloc += s;
204 return g_slice_alloc0 (s); 300 return salloc0<char> (s);
205 } 301 }
206 302
207 void *operator new[] (size_t s) 303 void *operator new[] (size_t s)
208 { 304 {
209 slice_alloc += s;
210 return g_slice_alloc0 (s); 305 return salloc0<char> (s);
211 } 306 }
212 307
213 void operator delete (void *p, size_t s) 308 void operator delete (void *p, size_t s)
214 { 309 {
215 slice_alloc -= s; 310 sfree ((char *)p, s);
216 g_slice_free1 (s, p);
217 } 311 }
218 312
219 void operator delete[] (void *p, size_t s) 313 void operator delete[] (void *p, size_t s)
220 { 314 {
221 slice_alloc -= s; 315 sfree ((char *)p, s);
222 g_slice_free1 (s, p);
223 } 316 }
224}; 317};
225 318
226void *salloc_ (int n) throw (std::bad_alloc); 319// makes dynamically allocated objects zero-initialised
227void *salloc_ (int n, void *src) throw (std::bad_alloc); 320struct slice_allocated
228
229// strictly the same as g_slice_alloc, but never returns 0
230template<typename T>
231inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); }
232
233// also copies src into the new area, like "memdup"
234// if src is 0, clears the memory
235template<typename T>
236inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
237
238// clears the memory
239template<typename T>
240inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); }
241
242// for symmetry
243template<typename T>
244inline void sfree (T *ptr, int n = 1) throw ()
245{ 321{
246#if PREFER_MALLOC 322 void *operator new (size_t s, void *p)
247 free (ptr); 323 {
248#else 324 return p;
249 slice_alloc -= n * sizeof (T); 325 }
250 g_slice_free1 (n * sizeof (T), (void *)ptr); 326
251#endif 327 void *operator new (size_t s)
252} 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};
253 347
254// a STL-compatible allocator that uses g_slice 348// a STL-compatible allocator that uses g_slice
255// boy, this is verbose 349// boy, this is verbose
256template<typename Tp> 350template<typename Tp>
257struct slice_allocator 351struct slice_allocator
… …
309// 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.
310// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 404// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
311// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps 405// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
312struct tausworthe_random_generator 406struct tausworthe_random_generator
313{ 407{
314 // generator
315 uint32_t state [4]; 408 uint32_t state [4];
316 409
317 void operator =(const tausworthe_random_generator &src) 410 void operator =(const tausworthe_random_generator &src)
318 { 411 {
319 state [0] = src.state [0]; 412 state [0] = src.state [0];
… …
322 state [3] = src.state [3]; 415 state [3] = src.state [3];
323 } 416 }
324 417
325 void seed (uint32_t seed); 418 void seed (uint32_t seed);
326 uint32_t next (); 419 uint32_t next ();
420};
327 421
328 // 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)
329 uint32_t operator ()(uint32_t num) 456 uint32_t operator ()(uint32_t num)
330 { 457 {
331 return is_constant (num) 458 return !is_constant (num) ? get_range (num) // non-constant
332 ? (next () * (uint64_t)num) >> 32U 459 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
333 : get_range (num); 460 : this->next () & (num - 1); // constant, power-of-two
334 } 461 }
335 462
336 // return a number within (min .. max) 463 // return a number within (min .. max)
337 int operator () (int r_min, int r_max) 464 int operator () (int r_min, int r_max)
338 { 465 {
… …
349protected: 476protected:
350 uint32_t get_range (uint32_t r_max); 477 uint32_t get_range (uint32_t r_max);
351 int get_range (int r_min, int r_max); 478 int get_range (int r_min, int r_max);
352}; 479};
353 480
354typedef tausworthe_random_generator rand_gen; 481typedef random_number_generator<tausworthe_random_generator> rand_gen;
355 482
356extern rand_gen rndm; 483extern rand_gen rndm, rmg_rndm;
357 484
358INTERFACE_CLASS (attachable) 485INTERFACE_CLASS (attachable)
359struct refcnt_base 486struct refcnt_base
360{ 487{
361 typedef int refcnt_t; 488 typedef int refcnt_t;
… …
428 555
429struct str_hash 556struct str_hash
430{ 557{
431 std::size_t operator ()(const char *s) const 558 std::size_t operator ()(const char *s) const
432 { 559 {
433 unsigned long hash = 0; 560#if 0
561 uint32_t hash = 0;
434 562
435 /* use the one-at-a-time hash function, which supposedly is 563 /* use the one-at-a-time hash function, which supposedly is
436 * better than the djb2-like one used by perl5.005, but 564 * better than the djb2-like one used by perl5.005, but
437 * certainly is better then the bug used here before. 565 * certainly is better then the bug used here before.
438 * see http://burtleburtle.net/bob/hash/doobs.html 566 * see http://burtleburtle.net/bob/hash/doobs.html
… …
445 } 573 }
446 574
447 hash += hash << 3; 575 hash += hash << 3;
448 hash ^= hash >> 11; 576 hash ^= hash >> 11;
449 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
450 589
451 return hash; 590 return hash;
452 } 591 }
453}; 592};
454 593
… …
549 erase (&obj); 688 erase (&obj);
550 } 689 }
551}; 690};
552 691
553// 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)
554void assign (char *dst, const char *src, int maxlen); 694int assign (char *dst, const char *src, int maxsize);
555 695
556// type-safe version of assign 696// type-safe version of assign
557template<int N> 697template<int N>
558inline void assign (char (&dst)[N], const char *src) 698inline int assign (char (&dst)[N], const char *src)
559{ 699{
560 assign ((char *)&dst, src, N); 700 return assign ((char *)&dst, src, N);
561} 701}
562 702
563typedef double tstamp; 703typedef double tstamp;
564 704
565// return current time as timestamp 705// return current time as timestamp
… …
568int similar_direction (int a, int b); 708int similar_direction (int a, int b);
569 709
570// like sprintf, but returns a "static" buffer 710// like sprintf, but returns a "static" buffer
571const char *format (const char *format, ...); 711const char *format (const char *format, ...);
572 712
713/////////////////////////////////////////////////////////////////////////////
714// threads, very very thin wrappers around pthreads
715
716struct thread
717{
718 pthread_t id;
719
720 void start (void *(*start_routine)(void *), void *arg = 0);
721
722 void cancel ()
723 {
724 pthread_cancel (id);
725 }
726
727 void *join ()
728 {
729 void *ret;
730
731 if (pthread_join (id, &ret))
732 cleanup ("pthread_join failed", 1);
733
734 return ret;
735 }
736};
737
738// note that mutexes are not classes
739typedef pthread_mutex_t smutex;
740
741#if __linux && defined (PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP)
742 #define SMUTEX_INITIALISER PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
743#else
744 #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER
573#endif 745#endif
574 746
747#define SMUTEX(name) smutex name = SMUTEX_INITIALISER
748#define SMUTEX_LOCK(name) pthread_mutex_lock (&(name))
749#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name))
750
751typedef pthread_cond_t scond;
752
753#define SCOND(name) scond name = PTHREAD_COND_INITIALIZER
754#define SCOND_SIGNAL(name) pthread_cond_signal (&(name))
755#define SCOND_BROADCAST(name) pthread_cond_broadcast (&(name))
756#define SCOND_WAIT(name,mutex) pthread_cond_wait (&(name), &(mutex))
757
758#endif
759

Diff Legend

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