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.70 by root, Sun Apr 20 05:24: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_POISON 0xaa // poison memory before freeing it if != 0 25#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0
26#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs 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#define PREFER_MALLOC 0 // use malloc and not the slice allocator
28 28
29#if __GNUC__ >= 3 29#if __GNUC__ >= 3
30# define is_constant(c) __builtin_constant_p (c) 30# define is_constant(c) __builtin_constant_p (c)
31# define expect(expr,value) __builtin_expect ((expr),(value)) 31# define expect(expr,value) __builtin_expect ((expr),(value))
32# 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__))
33#else 34#else
34# define is_constant(c) 0 35# define is_constant(c) 0
35# define expect(expr,value) (expr) 36# define expect(expr,value) (expr)
36# define prefetch(addr,rw,locality) 37# define prefetch(addr,rw,locality)
38# define noinline
37#endif 39#endif
38 40
39#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4) 41#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
40# define decltype(x) typeof(x) 42# define decltype(x) typeof(x)
41#endif 43#endif
42 44
43// put into ifs if you are very sure that the expression 45// put into ifs if you are very sure that the expression
44// is mostly true or mosty false. note that these return 46// is mostly true or mosty false. note that these return
45// booleans, not the expression. 47// booleans, not the expression.
46#define expect_false(expr) expect ((expr) != 0, 0) 48#define expect_false(expr) expect ((expr) ? 1 : 0, 0)
47#define expect_true(expr) expect ((expr) != 0, 1) 49#define expect_true(expr) expect ((expr) ? 1 : 0, 1)
48 50
49#include <pthread.h> 51#include <pthread.h>
50 52
51#include <cstddef> 53#include <cstddef>
52#include <cmath> 54#include <cmath>
72#endif 74#endif
73 75
74// 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)
75#define auto(var,expr) decltype(expr) var = (expr) 77#define auto(var,expr) decltype(expr) var = (expr)
76 78
77// very ugly macro that basicaly declares and initialises a variable 79// very ugly macro that basically declares and initialises a variable
78// that is in scope for the next statement only 80// that is in scope for the next statement only
79// 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
80// (note: works great for pointers) 82// (note: works great for pointers)
81// most ugly macro I ever wrote 83// most ugly macro I ever wrote
82#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)
96// 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.
97template<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; }
98template<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; }
99template<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; }
100 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
101template<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; }
102 108
103template<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)); }
104template<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)); }
105 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
106template<typename T> 142template<typename T>
107static inline T 143static inline T
108lerp (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)
109{ 145{
110 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);
111} 163}
112 164
113// lots of stuff taken from FXT 165// lots of stuff taken from FXT
114 166
115/* Rotate right. This is used in various places for checksumming */ 167/* Rotate right. This is used in various places for checksumming */
224 g_slice_free1 (n * sizeof (T), (void *)ptr); 276 g_slice_free1 (n * sizeof (T), (void *)ptr);
225 assert (slice_alloc >= 0);//D 277 assert (slice_alloc >= 0);//D
226 } 278 }
227} 279}
228 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
229// makes dynamically allocated objects zero-initialised 289// makes dynamically allocated objects zero-initialised
230struct zero_initialised 290struct zero_initialised
231{ 291{
232 void *operator new (size_t s, void *p) 292 void *operator new (size_t s, void *p)
233 { 293 {
241 } 301 }
242 302
243 void *operator new[] (size_t s) 303 void *operator new[] (size_t s)
244 { 304 {
245 return salloc0<char> (s); 305 return salloc0<char> (s);
306 }
307
308 void operator delete (void *p, size_t s)
309 {
310 sfree ((char *)p, s);
311 }
312
313 void operator delete[] (void *p, size_t s)
314 {
315 sfree ((char *)p, s);
316 }
317};
318
319// makes dynamically allocated objects zero-initialised
320struct slice_allocated
321{
322 void *operator new (size_t s, void *p)
323 {
324 return p;
325 }
326
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);
246 } 335 }
247 336
248 void operator delete (void *p, size_t s) 337 void operator delete (void *p, size_t s)
249 { 338 {
250 sfree ((char *)p, s); 339 sfree ((char *)p, s);
314// 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.
315// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 404// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
316// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps 405// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
317struct tausworthe_random_generator 406struct tausworthe_random_generator
318{ 407{
319 // generator
320 uint32_t state [4]; 408 uint32_t state [4];
321 409
322 void operator =(const tausworthe_random_generator &src) 410 void operator =(const tausworthe_random_generator &src)
323 { 411 {
324 state [0] = src.state [0]; 412 state [0] = src.state [0];
327 state [3] = src.state [3]; 415 state [3] = src.state [3];
328 } 416 }
329 417
330 void seed (uint32_t seed); 418 void seed (uint32_t seed);
331 uint32_t next (); 419 uint32_t next ();
420};
332 421
333 // 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)
334 uint32_t operator ()(uint32_t num) 456 uint32_t operator ()(uint32_t num)
335 { 457 {
336 return is_constant (num) 458 return !is_constant (num) ? get_range (num) // non-constant
337 ? (next () * (uint64_t)num) >> 32U 459 : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two
338 : get_range (num); 460 : this->next () & (num - 1); // constant, power-of-two
339 } 461 }
340 462
341 // return a number within (min .. max) 463 // return a number within (min .. max)
342 int operator () (int r_min, int r_max) 464 int operator () (int r_min, int r_max)
343 { 465 {
354protected: 476protected:
355 uint32_t get_range (uint32_t r_max); 477 uint32_t get_range (uint32_t r_max);
356 int get_range (int r_min, int r_max); 478 int get_range (int r_min, int r_max);
357}; 479};
358 480
359typedef tausworthe_random_generator rand_gen; 481typedef random_number_generator<tausworthe_random_generator> rand_gen;
360 482
361extern rand_gen rndm; 483extern rand_gen rndm, rmg_rndm;
362 484
363INTERFACE_CLASS (attachable) 485INTERFACE_CLASS (attachable)
364struct refcnt_base 486struct refcnt_base
365{ 487{
366 typedef int refcnt_t; 488 typedef int refcnt_t;
433 555
434struct str_hash 556struct str_hash
435{ 557{
436 std::size_t operator ()(const char *s) const 558 std::size_t operator ()(const char *s) const
437 { 559 {
438 unsigned long hash = 0; 560#if 0
561 uint32_t hash = 0;
439 562
440 /* use the one-at-a-time hash function, which supposedly is 563 /* use the one-at-a-time hash function, which supposedly is
441 * better than the djb2-like one used by perl5.005, but 564 * better than the djb2-like one used by perl5.005, but
442 * certainly is better then the bug used here before. 565 * certainly is better then the bug used here before.
443 * see http://burtleburtle.net/bob/hash/doobs.html 566 * see http://burtleburtle.net/bob/hash/doobs.html
450 } 573 }
451 574
452 hash += hash << 3; 575 hash += hash << 3;
453 hash ^= hash >> 11; 576 hash ^= hash >> 11;
454 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
455 589
456 return hash; 590 return hash;
457 } 591 }
458}; 592};
459 593
554 erase (&obj); 688 erase (&obj);
555 } 689 }
556}; 690};
557 691
558// 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)
559void assign (char *dst, const char *src, int maxlen); 694int assign (char *dst, const char *src, int maxsize);
560 695
561// type-safe version of assign 696// type-safe version of assign
562template<int N> 697template<int N>
563inline void assign (char (&dst)[N], const char *src) 698inline int assign (char (&dst)[N], const char *src)
564{ 699{
565 assign ((char *)&dst, src, N); 700 return assign ((char *)&dst, src, N);
566} 701}
567 702
568typedef double tstamp; 703typedef double tstamp;
569 704
570// return current time as timestamp 705// return current time as timestamp
572 707
573int similar_direction (int a, int b); 708int similar_direction (int a, int b);
574 709
575// like sprintf, but returns a "static" buffer 710// like sprintf, but returns a "static" buffer
576const 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);
577 715
578///////////////////////////////////////////////////////////////////////////// 716/////////////////////////////////////////////////////////////////////////////
579// threads, very very thin wrappers around pthreads 717// threads, very very thin wrappers around pthreads
580 718
581struct thread 719struct thread

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines