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.66 by root, Wed Apr 2 11:13:55 2008 UTC vs.
Revision 1.89 by sf-marcmagus, Sun Oct 11 01:35:52 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)
47 50
48#include <pthread.h> 51#include <pthread.h>
49 52
50#include <cstddef> 53#include <cstddef>
51#include <cmath> 54#include <cmath>
… …
62# define g_slice_alloc(s) debug_slice_alloc(s) 65# define g_slice_alloc(s) debug_slice_alloc(s)
63# define g_slice_free1(s,p) debug_slice_free1(s,p) 66# define g_slice_free1(s,p) debug_slice_free1(s,p)
64void *g_slice_alloc (unsigned long size); 67void *g_slice_alloc (unsigned long size);
65void *g_slice_alloc0 (unsigned long size); 68void *g_slice_alloc0 (unsigned long size);
66void 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))
67#endif 74#endif
68 75
69// 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)
70#define auto(var,expr) decltype(expr) var = (expr) 77#define auto(var,expr) decltype(expr) var = (expr)
71 78
72// very ugly macro that basicaly declares and initialises a variable 79// very ugly macro that basically declares and initialises a variable
73// that is in scope for the next statement only 80// that is in scope for the next statement only
74// 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
75// (note: works great for pointers) 82// (note: works great for pointers)
76// most ugly macro I ever wrote 83// most ugly macro I ever wrote
77#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)
… …
91// 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.
92template<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; }
93template<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; }
94template<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; }
95 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
96template<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; }
97 108
98template<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)); }
99template<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)); }
100 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
101template<typename T> 142template<typename T>
102static inline T 143static inline T
103lerp (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)
104{ 145{
105 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);
106} 163}
107 164
108// lots of stuff taken from FXT 165// lots of stuff taken from FXT
109 166
110/* Rotate right. This is used in various places for checksumming */ 167/* Rotate right. This is used in various places for checksumming */
… …
188absdir (int d) 245absdir (int d)
189{ 246{
190 return ((d - 1) & 7) + 1; 247 return ((d - 1) & 7) + 1;
191} 248}
192 249
193extern 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}
194 288
195// makes dynamically allocated objects zero-initialised 289// makes dynamically allocated objects zero-initialised
196struct zero_initialised 290struct zero_initialised
197{ 291{
198 void *operator new (size_t s, void *p) 292 void *operator new (size_t s, void *p)
… …
201 return p; 295 return p;
202 } 296 }
203 297
204 void *operator new (size_t s) 298 void *operator new (size_t s)
205 { 299 {
206 slice_alloc += s;
207 return g_slice_alloc0 (s); 300 return salloc0<char> (s);
208 } 301 }
209 302
210 void *operator new[] (size_t s) 303 void *operator new[] (size_t s)
211 { 304 {
212 slice_alloc += s;
213 return g_slice_alloc0 (s); 305 return salloc0<char> (s);
214 } 306 }
215 307
216 void operator delete (void *p, size_t s) 308 void operator delete (void *p, size_t s)
217 { 309 {
218 slice_alloc -= s; 310 sfree ((char *)p, s);
219 g_slice_free1 (s, p);
220 } 311 }
221 312
222 void operator delete[] (void *p, size_t s) 313 void operator delete[] (void *p, size_t s)
223 { 314 {
224 slice_alloc -= s; 315 sfree ((char *)p, s);
225 g_slice_free1 (s, p);
226 } 316 }
227}; 317};
228 318
229void *salloc_ (int n) throw (std::bad_alloc); 319// makes dynamically allocated objects zero-initialised
230void *salloc_ (int n, void *src) throw (std::bad_alloc); 320struct slice_allocated
231
232// strictly the same as g_slice_alloc, but never returns 0
233template<typename T>
234inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); }
235
236// also copies src into the new area, like "memdup"
237// if src is 0, clears the memory
238template<typename T>
239inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
240
241// clears the memory
242template<typename T>
243inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); }
244
245// for symmetry
246template<typename T>
247inline void sfree (T *ptr, int n = 1) throw ()
248{ 321{
249#if PREFER_MALLOC 322 void *operator new (size_t s, void *p)
250 free (ptr); 323 {
251#else 324 return p;
252 slice_alloc -= n * sizeof (T); 325 }
253 g_slice_free1 (n * sizeof (T), (void *)ptr); 326
254#endif 327 void *operator new (size_t s)
255} 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};
256 347
257// a STL-compatible allocator that uses g_slice 348// a STL-compatible allocator that uses g_slice
258// boy, this is verbose 349// boy, this is verbose
259template<typename Tp> 350template<typename Tp>
260struct slice_allocator 351struct slice_allocator
… …
312// 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.
313// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 404// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
314// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps 405// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
315struct tausworthe_random_generator 406struct tausworthe_random_generator
316{ 407{
317 // generator
318 uint32_t state [4]; 408 uint32_t state [4];
319 409
320 void operator =(const tausworthe_random_generator &src) 410 void operator =(const tausworthe_random_generator &src)
321 { 411 {
322 state [0] = src.state [0]; 412 state [0] = src.state [0];
… …
325 state [3] = src.state [3]; 415 state [3] = src.state [3];
326 } 416 }
327 417
328 void seed (uint32_t seed); 418 void seed (uint32_t seed);
329 uint32_t next (); 419 uint32_t next ();
420};
330 421
331 // 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)
332 uint32_t operator ()(uint32_t num) 456 uint32_t operator ()(uint32_t num)
333 { 457 {
334 return is_constant (num) 458 return !is_constant (num) ? get_range (num) // non-constant
335 ? (next () * (uint64_t)num) >> 32U 459 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
336 : get_range (num); 460 : this->next () & (num - 1); // constant, power-of-two
337 } 461 }
338 462
339 // return a number within (min .. max) 463 // return a number within (min .. max)
340 int operator () (int r_min, int r_max) 464 int operator () (int r_min, int r_max)
341 { 465 {
… …
352protected: 476protected:
353 uint32_t get_range (uint32_t r_max); 477 uint32_t get_range (uint32_t r_max);
354 int get_range (int r_min, int r_max); 478 int get_range (int r_min, int r_max);
355}; 479};
356 480
357typedef tausworthe_random_generator rand_gen; 481typedef random_number_generator<tausworthe_random_generator> rand_gen;
358 482
359extern rand_gen rndm; 483extern rand_gen rndm, rmg_rndm;
360 484
361INTERFACE_CLASS (attachable) 485INTERFACE_CLASS (attachable)
362struct refcnt_base 486struct refcnt_base
363{ 487{
364 typedef int refcnt_t; 488 typedef int refcnt_t;
… …
431 555
432struct str_hash 556struct str_hash
433{ 557{
434 std::size_t operator ()(const char *s) const 558 std::size_t operator ()(const char *s) const
435 { 559 {
436 unsigned long hash = 0; 560#if 0
561 uint32_t hash = 0;
437 562
438 /* use the one-at-a-time hash function, which supposedly is 563 /* use the one-at-a-time hash function, which supposedly is
439 * better than the djb2-like one used by perl5.005, but 564 * better than the djb2-like one used by perl5.005, but
440 * certainly is better then the bug used here before. 565 * certainly is better then the bug used here before.
441 * see http://burtleburtle.net/bob/hash/doobs.html 566 * see http://burtleburtle.net/bob/hash/doobs.html
… …
448 } 573 }
449 574
450 hash += hash << 3; 575 hash += hash << 3;
451 hash ^= hash >> 11; 576 hash ^= hash >> 11;
452 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
453 589
454 return hash; 590 return hash;
455 } 591 }
456}; 592};
457 593
… …
552 erase (&obj); 688 erase (&obj);
553 } 689 }
554}; 690};
555 691
556// 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)
557void assign (char *dst, const char *src, int maxlen); 694int assign (char *dst, const char *src, int maxsize);
558 695
559// type-safe version of assign 696// type-safe version of assign
560template<int N> 697template<int N>
561inline void assign (char (&dst)[N], const char *src) 698inline int assign (char (&dst)[N], const char *src)
562{ 699{
563 assign ((char *)&dst, src, N); 700 return assign ((char *)&dst, src, N);
564} 701}
565 702
566typedef double tstamp; 703typedef double tstamp;
567 704
568// return current time as timestamp 705// return current time as timestamp
… …
570 707
571int similar_direction (int a, int b); 708int similar_direction (int a, int b);
572 709
573// like sprintf, but returns a "static" buffer 710// like sprintf, but returns a "static" buffer
574const char *format (const char *format, ...); 711const char *format (const char *format, ...);
712
713// safety-check player input which will become object->msg
714bool msg_is_safe (const char *msg);
575 715
576///////////////////////////////////////////////////////////////////////////// 716/////////////////////////////////////////////////////////////////////////////
577// threads, very very thin wrappers around pthreads 717// threads, very very thin wrappers around pthreads
578 718
579struct thread 719struct thread
… …
606#else 746#else
607 #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER 747 #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER
608#endif 748#endif
609 749
610#define SMUTEX(name) smutex name = SMUTEX_INITIALISER 750#define SMUTEX(name) smutex name = SMUTEX_INITIALISER
611#define SMUTEX_LOCK(name) pthread_mutex_lock (&(name)) 751#define SMUTEX_LOCK(name) pthread_mutex_lock (&(name))
612#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name)) 752#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name))
613 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
614#endif 761#endif
615 762

Diff Legend

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