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.57 by root, Tue Oct 16 05:34:24 2007 UTC vs.
Revision 1.87 by root, Mon Jan 12 03:40:21 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; }
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, with correct rounding (< 0.5 downwards, >=0.5 upwards)
124template<typename T> static inline T div (T val, T div) { return (val + div / 2) / div; }
125// div, round-up
126template<typename T> static inline T div_ru (T val, T div) { return (val + div - 1) / div; }
127// div, round-down
128template<typename T> static inline T div_rd (T val, T div) { return (val ) / div; }
84 129
85template<typename T> 130template<typename T>
86static inline T 131static inline T
87lerp (T val, T min_in, T max_in, T min_out, T max_out) 132lerp (T val, T min_in, T max_in, T min_out, T max_out)
88{ 133{
89 return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; 134 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in);
135}
136
137// lerp, round-down
138template<typename T>
139static inline T
140lerp_rd (T val, T min_in, T max_in, T min_out, T max_out)
141{
142 return min_out + div_rd<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
143}
144
145// lerp, round-up
146template<typename T>
147static inline T
148lerp_ru (T val, T min_in, T max_in, T min_out, T max_out)
149{
150 return min_out + div_ru<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
90} 151}
91 152
92// lots of stuff taken from FXT 153// lots of stuff taken from FXT
93 154
94/* Rotate right. This is used in various places for checksumming */ 155/* Rotate right. This is used in various places for checksumming */
… …
172absdir (int d) 233absdir (int d)
173{ 234{
174 return ((d - 1) & 7) + 1; 235 return ((d - 1) & 7) + 1;
175} 236}
176 237
177extern size_t slice_alloc; // statistics 238extern ssize_t slice_alloc; // statistics
239
240void *salloc_ (int n) throw (std::bad_alloc);
241void *salloc_ (int n, void *src) throw (std::bad_alloc);
242
243// strictly the same as g_slice_alloc, but never returns 0
244template<typename T>
245inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); }
246
247// also copies src into the new area, like "memdup"
248// if src is 0, clears the memory
249template<typename T>
250inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
251
252// clears the memory
253template<typename T>
254inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); }
255
256// for symmetry
257template<typename T>
258inline void sfree (T *ptr, int n = 1) throw ()
259{
260 if (expect_true (ptr))
261 {
262 slice_alloc -= n * sizeof (T);
263 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
264 g_slice_free1 (n * sizeof (T), (void *)ptr);
265 assert (slice_alloc >= 0);//D
266 }
267}
268
269// nulls the pointer
270template<typename T>
271inline void sfree0 (T *&ptr, int n = 1) throw ()
272{
273 sfree<T> (ptr, n);
274 ptr = 0;
275}
178 276
179// makes dynamically allocated objects zero-initialised 277// makes dynamically allocated objects zero-initialised
180struct zero_initialised 278struct zero_initialised
181{ 279{
182 void *operator new (size_t s, void *p) 280 void *operator new (size_t s, void *p)
… …
185 return p; 283 return p;
186 } 284 }
187 285
188 void *operator new (size_t s) 286 void *operator new (size_t s)
189 { 287 {
190 slice_alloc += s;
191 return g_slice_alloc0 (s); 288 return salloc0<char> (s);
192 } 289 }
193 290
194 void *operator new[] (size_t s) 291 void *operator new[] (size_t s)
195 { 292 {
196 slice_alloc += s;
197 return g_slice_alloc0 (s); 293 return salloc0<char> (s);
198 } 294 }
199 295
200 void operator delete (void *p, size_t s) 296 void operator delete (void *p, size_t s)
201 { 297 {
202 slice_alloc -= s; 298 sfree ((char *)p, s);
203 g_slice_free1 (s, p);
204 } 299 }
205 300
206 void operator delete[] (void *p, size_t s) 301 void operator delete[] (void *p, size_t s)
207 { 302 {
208 slice_alloc -= s; 303 sfree ((char *)p, s);
209 g_slice_free1 (s, p);
210 } 304 }
211}; 305};
212 306
213void *salloc_ (int n) throw (std::bad_alloc); 307// makes dynamically allocated objects zero-initialised
214void *salloc_ (int n, void *src) throw (std::bad_alloc); 308struct slice_allocated
215
216// strictly the same as g_slice_alloc, but never returns 0
217template<typename T>
218inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); }
219
220// also copies src into the new area, like "memdup"
221// if src is 0, clears the memory
222template<typename T>
223inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
224
225// clears the memory
226template<typename T>
227inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); }
228
229// for symmetry
230template<typename T>
231inline void sfree (T *ptr, int n = 1) throw ()
232{ 309{
233#ifdef PREFER_MALLOC 310 void *operator new (size_t s, void *p)
234 free (ptr); 311 {
235#else 312 return p;
236 slice_alloc -= n * sizeof (T); 313 }
237 g_slice_free1 (n * sizeof (T), (void *)ptr); 314
238#endif 315 void *operator new (size_t s)
239} 316 {
317 return salloc<char> (s);
318 }
319
320 void *operator new[] (size_t s)
321 {
322 return salloc<char> (s);
323 }
324
325 void operator delete (void *p, size_t s)
326 {
327 sfree ((char *)p, s);
328 }
329
330 void operator delete[] (void *p, size_t s)
331 {
332 sfree ((char *)p, s);
333 }
334};
240 335
241// a STL-compatible allocator that uses g_slice 336// a STL-compatible allocator that uses g_slice
242// boy, this is verbose 337// boy, this is verbose
243template<typename Tp> 338template<typename Tp>
244struct slice_allocator 339struct slice_allocator
… …
256 { 351 {
257 typedef slice_allocator<U> other; 352 typedef slice_allocator<U> other;
258 }; 353 };
259 354
260 slice_allocator () throw () { } 355 slice_allocator () throw () { }
261 slice_allocator (const slice_allocator &o) throw () { } 356 slice_allocator (const slice_allocator &) throw () { }
262 template<typename Tp2> 357 template<typename Tp2>
263 slice_allocator (const slice_allocator<Tp2> &) throw () { } 358 slice_allocator (const slice_allocator<Tp2> &) throw () { }
264 359
265 ~slice_allocator () { } 360 ~slice_allocator () { }
266 361
… …
275 void deallocate (pointer p, size_type n) 370 void deallocate (pointer p, size_type n)
276 { 371 {
277 sfree<Tp> (p, n); 372 sfree<Tp> (p, n);
278 } 373 }
279 374
280 size_type max_size ()const throw () 375 size_type max_size () const throw ()
281 { 376 {
282 return size_t (-1) / sizeof (Tp); 377 return size_t (-1) / sizeof (Tp);
283 } 378 }
284 379
285 void construct (pointer p, const Tp &val) 380 void construct (pointer p, const Tp &val)
… …
296// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. 391// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213.
297// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 392// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
298// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps 393// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
299struct tausworthe_random_generator 394struct tausworthe_random_generator
300{ 395{
301 // generator
302 uint32_t state [4]; 396 uint32_t state [4];
303 397
304 void operator =(const tausworthe_random_generator &src) 398 void operator =(const tausworthe_random_generator &src)
305 { 399 {
306 state [0] = src.state [0]; 400 state [0] = src.state [0];
… …
309 state [3] = src.state [3]; 403 state [3] = src.state [3];
310 } 404 }
311 405
312 void seed (uint32_t seed); 406 void seed (uint32_t seed);
313 uint32_t next (); 407 uint32_t next ();
408};
314 409
315 // uniform distribution 410// Xorshift RNGs, George Marsaglia
411// http://www.jstatsoft.org/v08/i14/paper
412// this one is about 40% faster than the tausworthe one above (i.e. not much),
413// despite the inlining, and has the issue of only creating 2**32-1 numbers.
414// see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf
415struct xorshift_random_generator
416{
417 uint32_t x, y;
418
419 void operator =(const xorshift_random_generator &src)
420 {
421 x = src.x;
422 y = src.y;
423 }
424
425 void seed (uint32_t seed)
426 {
427 x = seed;
428 y = seed * 69069U;
429 }
430
431 uint32_t next ()
432 {
433 uint32_t t = x ^ (x << 10);
434 x = y;
435 y = y ^ (y >> 13) ^ t ^ (t >> 10);
436 return y;
437 }
438};
439
440template<class generator>
441struct random_number_generator : generator
442{
443 // uniform distribution, 0 .. max (0, num - 1)
316 uint32_t operator ()(uint32_t num) 444 uint32_t operator ()(uint32_t num)
317 { 445 {
318 return is_constant (num) 446 return !is_constant (num) ? get_range (num) // non-constant
319 ? (next () * (uint64_t)num) >> 32U 447 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
320 : get_range (num); 448 : this->next () & (num - 1); // constant, power-of-two
321 } 449 }
322 450
323 // return a number within (min .. max) 451 // return a number within (min .. max)
324 int operator () (int r_min, int r_max) 452 int operator () (int r_min, int r_max)
325 { 453 {
… …
336protected: 464protected:
337 uint32_t get_range (uint32_t r_max); 465 uint32_t get_range (uint32_t r_max);
338 int get_range (int r_min, int r_max); 466 int get_range (int r_min, int r_max);
339}; 467};
340 468
341typedef tausworthe_random_generator rand_gen; 469typedef random_number_generator<tausworthe_random_generator> rand_gen;
342 470
343extern rand_gen rndm; 471extern rand_gen rndm, rmg_rndm;
344 472
345INTERFACE_CLASS (attachable) 473INTERFACE_CLASS (attachable)
346struct refcnt_base 474struct refcnt_base
347{ 475{
348 typedef int refcnt_t; 476 typedef int refcnt_t;
… …
415 543
416struct str_hash 544struct str_hash
417{ 545{
418 std::size_t operator ()(const char *s) const 546 std::size_t operator ()(const char *s) const
419 { 547 {
420 unsigned long hash = 0; 548#if 0
549 uint32_t hash = 0;
421 550
422 /* use the one-at-a-time hash function, which supposedly is 551 /* use the one-at-a-time hash function, which supposedly is
423 * better than the djb2-like one used by perl5.005, but 552 * better than the djb2-like one used by perl5.005, but
424 * certainly is better then the bug used here before. 553 * certainly is better then the bug used here before.
425 * see http://burtleburtle.net/bob/hash/doobs.html 554 * see http://burtleburtle.net/bob/hash/doobs.html
… …
432 } 561 }
433 562
434 hash += hash << 3; 563 hash += hash << 3;
435 hash ^= hash >> 11; 564 hash ^= hash >> 11;
436 hash += hash << 15; 565 hash += hash << 15;
566#else
567 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
568 // it is about twice as fast as the one-at-a-time one,
569 // with good distribution.
570 // FNV-1a is faster on many cpus because the multiplication
571 // runs concurrent with the looping logic.
572 uint32_t hash = 2166136261;
573
574 while (*s)
575 hash = (hash ^ *s++) * 16777619;
576#endif
437 577
438 return hash; 578 return hash;
439 } 579 }
440}; 580};
441 581
… …
536 erase (&obj); 676 erase (&obj);
537 } 677 }
538}; 678};
539 679
540// basically does what strncpy should do, but appends "..." to strings exceeding length 680// basically does what strncpy should do, but appends "..." to strings exceeding length
681// returns the number of bytes actually used (including \0)
541void assign (char *dst, const char *src, int maxlen); 682int assign (char *dst, const char *src, int maxsize);
542 683
543// type-safe version of assign 684// type-safe version of assign
544template<int N> 685template<int N>
545inline void assign (char (&dst)[N], const char *src) 686inline int assign (char (&dst)[N], const char *src)
546{ 687{
547 assign ((char *)&dst, src, N); 688 return assign ((char *)&dst, src, N);
548} 689}
549 690
550typedef double tstamp; 691typedef double tstamp;
551 692
552// return current time as timestampe 693// return current time as timestamp
553tstamp now (); 694tstamp now ();
554 695
555int similar_direction (int a, int b); 696int similar_direction (int a, int b);
556 697
557// like sprintf, but returns a "static" buffer 698// like sprintf, but returns a "static" buffer
558const char *format (const char *format, ...); 699const char *format (const char *format, ...);
559 700
701/////////////////////////////////////////////////////////////////////////////
702// threads, very very thin wrappers around pthreads
703
704struct thread
705{
706 pthread_t id;
707
708 void start (void *(*start_routine)(void *), void *arg = 0);
709
710 void cancel ()
711 {
712 pthread_cancel (id);
713 }
714
715 void *join ()
716 {
717 void *ret;
718
719 if (pthread_join (id, &ret))
720 cleanup ("pthread_join failed", 1);
721
722 return ret;
723 }
724};
725
726// note that mutexes are not classes
727typedef pthread_mutex_t smutex;
728
729#if __linux && defined (PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP)
730 #define SMUTEX_INITIALISER PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
731#else
732 #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER
560#endif 733#endif
561 734
735#define SMUTEX(name) smutex name = SMUTEX_INITIALISER
736#define SMUTEX_LOCK(name) pthread_mutex_lock (&(name))
737#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name))
738
739typedef pthread_cond_t scond;
740
741#define SCOND(name) scond name = PTHREAD_COND_INITIALIZER
742#define SCOND_SIGNAL(name) pthread_cond_signal (&(name))
743#define SCOND_BROADCAST(name) pthread_cond_broadcast (&(name))
744#define SCOND_WAIT(name,mutex) pthread_cond_wait (&(name), &(mutex))
745
746#endif
747

Diff Legend

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