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.72 by root, Wed Apr 30 16:26:28 2008 UTC vs.
Revision 1.113 by root, Fri Apr 22 02:03:11 2011 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,2009,2010 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 it under
7 * it under the terms of the GNU General Public License as published by 7 * the terms of the Affero GNU General Public License as published by the
8 * the Free Software Foundation, either version 3 of the License, or 8 * Free Software Foundation, either version 3 of the License, or (at your
9 * (at your option) any later version. 9 * 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,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
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 Affero GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>. 17 * and the GNU General Public License along with this program. If not, see
18 * <http://www.gnu.org/licenses/>.
18 * 19 *
19 * The authors can be reached via e-mail to <support@deliantra.net> 20 * The authors can be reached via e-mail to <support@deliantra.net>
20 */ 21 */
21 22
22#ifndef UTIL_H__ 23#ifndef UTIL_H__
23#define UTIL_H__ 24#define UTIL_H__
24 25
26#include <compiler.h>
27
25#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0 28#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0
26#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs 29#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs
27#define PREFER_MALLOC 0 // use malloc and not the slice allocator 30#define PREFER_MALLOC 0 // use malloc and not the slice allocator
28
29#if __GNUC__ >= 3
30# define is_constant(c) __builtin_constant_p (c)
31# define expect(expr,value) __builtin_expect ((expr),(value))
32# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
33#else
34# define is_constant(c) 0
35# define expect(expr,value) (expr)
36# define prefetch(addr,rw,locality)
37#endif
38
39#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
40# define decltype(x) typeof(x)
41#endif
42
43// put into ifs if you are very sure that the expression
44// is mostly true or mosty false. note that these return
45// booleans, not the expression.
46#define expect_false(expr) expect ((expr) != 0, 0)
47#define expect_true(expr) expect ((expr) != 0, 1)
48 31
49#include <pthread.h> 32#include <pthread.h>
50 33
51#include <cstddef> 34#include <cstddef>
52#include <cmath> 35#include <cmath>
… …
72#endif 55#endif
73 56
74// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever) 57// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever)
75#define auto(var,expr) decltype(expr) var = (expr) 58#define auto(var,expr) decltype(expr) var = (expr)
76 59
60#if cplusplus_does_not_suck
61// does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm)
62template<typename T, int N>
63static inline int array_length (const T (&arr)[N])
64{
65 return N;
66}
67#else
68#define array_length(name) (sizeof (name) / sizeof (name [0]))
69#endif
70
77// very ugly macro that basicaly declares and initialises a variable 71// very ugly macro that basically declares and initialises a variable
78// that is in scope for the next statement only 72// that is in scope for the next statement only
79// works only for stuff that can be assigned 0 and converts to false 73// works only for stuff that can be assigned 0 and converts to false
80// (note: works great for pointers) 74// (note: works great for pointers)
81// most ugly macro I ever wrote 75// most ugly macro I ever wrote
82#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) 76#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. 90// 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; } 91template<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; } 92template<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; } 93template<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 94
95template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); }
96template<typename T, typename U> static inline void max_it (T &v, U m) { v = max (v, (T)m); }
97template<typename T, typename U, typename V> static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); }
98
101template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } 99template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
102 100
103template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); } 101template<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)); } 102template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
105 103
104// sign returns -1 or +1
105template<typename T>
106static inline T sign (T v) { return v < 0 ? -1 : +1; }
107// relies on 2c representation
108template<>
109inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); }
110template<>
111inline sint16 sign (sint16 v) { return 1 - (sint16 (uint16 (v) >> 15) * 2); }
112template<>
113inline sint32 sign (sint32 v) { return 1 - (sint32 (uint32 (v) >> 31) * 2); }
114
115// sign0 returns -1, 0 or +1
116template<typename T>
117static inline T sign0 (T v) { return v ? sign (v) : 0; }
118
119//clashes with C++0x
120template<typename T, typename U>
121static inline T copysign (T a, U b) { return a > 0 ? b : -b; }
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
130template<> inline float div (float val, float div) { return val / div; }
131template<> inline double div (double val, double div) { return val / div; }
132
133// div, round-up
134template<typename T> static inline T div_ru (T val, T div)
135{
136 return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div;
137}
138// div, round-down
139template<typename T> static inline T div_rd (T val, T div)
140{
141 return expect_false (val < 0) ? - ((-val + (div - 1) ) / div) : (val ) / div;
142}
143
144// lerp* only work correctly for min_in < max_in
145// Linear intERPolate, scales val from min_in..max_in to min_out..max_out
106template<typename T> 146template<typename T>
107static inline T 147static inline T
108lerp (T val, T min_in, T max_in, T min_out, T max_out) 148lerp (T val, T min_in, T max_in, T min_out, T max_out)
109{ 149{
110 return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; 150 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in);
151}
152
153// lerp, round-down
154template<typename T>
155static inline T
156lerp_rd (T val, T min_in, T max_in, T min_out, T max_out)
157{
158 return min_out + div_rd<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
159}
160
161// lerp, round-up
162template<typename T>
163static inline T
164lerp_ru (T val, T min_in, T max_in, T min_out, T max_out)
165{
166 return min_out + div_ru<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
111} 167}
112 168
113// lots of stuff taken from FXT 169// lots of stuff taken from FXT
114 170
115/* Rotate right. This is used in various places for checksumming */ 171/* Rotate right. This is used in various places for checksumming */
… …
153 int32_t d = b - a; 209 int32_t d = b - a;
154 d &= d >> 31; 210 d &= d >> 31;
155 return b - d; 211 return b - d;
156} 212}
157 213
158// this is much faster than crossfires original algorithm 214// this is much faster than crossfire's original algorithm
159// on modern cpus 215// on modern cpus
160inline int 216inline int
161isqrt (int n) 217isqrt (int n)
162{ 218{
163 return (int)sqrtf ((float)n); 219 return (int)sqrtf ((float)n);
220}
221
222// this is kind of like the ^^ operator, if it would exist, without sequence point.
223// more handy than it looks like, due to the implicit !! done on its arguments
224inline bool
225logical_xor (bool a, bool b)
226{
227 return a != b;
228}
229
230inline bool
231logical_implies (bool a, bool b)
232{
233 return a <= b;
164} 234}
165 235
166// this is only twice as fast as naive sqrtf (dx*dy+dy*dy) 236// this is only twice as fast as naive sqrtf (dx*dy+dy*dy)
167#if 0 237#if 0
168// and has a max. error of 6 in the range -100..+100. 238// and has a max. error of 6 in the range -100..+100.
… …
193absdir (int d) 263absdir (int d)
194{ 264{
195 return ((d - 1) & 7) + 1; 265 return ((d - 1) & 7) + 1;
196} 266}
197 267
268// avoid ctz name because netbsd or freebsd spams it's namespace with it
269#if GCC_VERSION(3,4)
270static inline int least_significant_bit (uint32_t x)
271{
272 return __builtin_ctz (x);
273}
274#else
275int least_significant_bit (uint32_t x);
276#endif
277
278#define for_all_bits_sparse_32(mask, idxvar) \
279 for (uint32_t idxvar, mask_ = mask; \
280 mask_ && ((idxvar = least_significant_bit (mask_)), mask_ &= ~(1 << idxvar), 1);)
281
198extern ssize_t slice_alloc; // statistics 282extern ssize_t slice_alloc; // statistics
199 283
200void *salloc_ (int n) throw (std::bad_alloc); 284void *salloc_ (int n) throw (std::bad_alloc);
201void *salloc_ (int n, void *src) throw (std::bad_alloc); 285void *salloc_ (int n, void *src) throw (std::bad_alloc);
202 286
… …
262 { 346 {
263 sfree ((char *)p, s); 347 sfree ((char *)p, s);
264 } 348 }
265}; 349};
266 350
351// makes dynamically allocated objects zero-initialised
352struct slice_allocated
353{
354 void *operator new (size_t s, void *p)
355 {
356 return p;
357 }
358
359 void *operator new (size_t s)
360 {
361 return salloc<char> (s);
362 }
363
364 void *operator new[] (size_t s)
365 {
366 return salloc<char> (s);
367 }
368
369 void operator delete (void *p, size_t s)
370 {
371 sfree ((char *)p, s);
372 }
373
374 void operator delete[] (void *p, size_t s)
375 {
376 sfree ((char *)p, s);
377 }
378};
379
267// a STL-compatible allocator that uses g_slice 380// a STL-compatible allocator that uses g_slice
268// boy, this is verbose 381// boy, this is verbose
269template<typename Tp> 382template<typename Tp>
270struct slice_allocator 383struct slice_allocator
271{ 384{
… …
317 { 430 {
318 p->~Tp (); 431 p->~Tp ();
319 } 432 }
320}; 433};
321 434
322// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213.
323// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
324// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
325struct tausworthe_random_generator
326{
327 // generator
328 uint32_t state [4];
329
330 void operator =(const tausworthe_random_generator &src)
331 {
332 state [0] = src.state [0];
333 state [1] = src.state [1];
334 state [2] = src.state [2];
335 state [3] = src.state [3];
336 }
337
338 void seed (uint32_t seed);
339 uint32_t next ();
340
341 // uniform distribution
342 uint32_t operator ()(uint32_t num)
343 {
344 return is_constant (num)
345 ? (next () * (uint64_t)num) >> 32U
346 : get_range (num);
347 }
348
349 // return a number within (min .. max)
350 int operator () (int r_min, int r_max)
351 {
352 return is_constant (r_min) && is_constant (r_max) && r_min <= r_max
353 ? r_min + operator ()(r_max - r_min + 1)
354 : get_range (r_min, r_max);
355 }
356
357 double operator ()()
358 {
359 return this->next () / (double)0xFFFFFFFFU;
360 }
361
362protected:
363 uint32_t get_range (uint32_t r_max);
364 int get_range (int r_min, int r_max);
365};
366
367typedef tausworthe_random_generator rand_gen;
368
369extern rand_gen rndm;
370
371INTERFACE_CLASS (attachable) 435INTERFACE_CLASS (attachable)
372struct refcnt_base 436struct refcnt_base
373{ 437{
374 typedef int refcnt_t; 438 typedef int refcnt_t;
375 mutable refcnt_t ACC (RW, refcnt); 439 mutable refcnt_t ACC (RW, refcnt);
… …
436typedef refptr<maptile> maptile_ptr; 500typedef refptr<maptile> maptile_ptr;
437typedef refptr<object> object_ptr; 501typedef refptr<object> object_ptr;
438typedef refptr<archetype> arch_ptr; 502typedef refptr<archetype> arch_ptr;
439typedef refptr<client> client_ptr; 503typedef refptr<client> client_ptr;
440typedef refptr<player> player_ptr; 504typedef refptr<player> player_ptr;
505typedef refptr<region> region_ptr;
506
507#define STRHSH_NULL 2166136261
508
509static inline uint32_t
510strhsh (const char *s)
511{
512 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
513 // it is about twice as fast as the one-at-a-time one,
514 // with good distribution.
515 // FNV-1a is faster on many cpus because the multiplication
516 // runs concurrently with the looping logic.
517 // we modify the hash a bit to improve its distribution
518 uint32_t hash = STRHSH_NULL;
519
520 while (*s)
521 hash = (hash ^ *s++) * 16777619U;
522
523 return hash ^ (hash >> 16);
524}
525
526static inline uint32_t
527memhsh (const char *s, size_t len)
528{
529 uint32_t hash = STRHSH_NULL;
530
531 while (len--)
532 hash = (hash ^ *s++) * 16777619U;
533
534 return hash;
535}
441 536
442struct str_hash 537struct str_hash
443{ 538{
444 std::size_t operator ()(const char *s) const 539 std::size_t operator ()(const char *s) const
445 { 540 {
446 unsigned long hash = 0;
447
448 /* use the one-at-a-time hash function, which supposedly is
449 * better than the djb2-like one used by perl5.005, but
450 * certainly is better then the bug used here before.
451 * see http://burtleburtle.net/bob/hash/doobs.html
452 */
453 while (*s)
454 {
455 hash += *s++;
456 hash += hash << 10;
457 hash ^= hash >> 6;
458 }
459
460 hash += hash << 3;
461 hash ^= hash >> 11;
462 hash += hash << 15;
463
464 return hash; 541 return strhsh (s);
542 }
543
544 std::size_t operator ()(const shstr &s) const
545 {
546 return strhsh (s);
465 } 547 }
466}; 548};
467 549
468struct str_equal 550struct str_equal
469{ 551{
… …
561 { 643 {
562 erase (&obj); 644 erase (&obj);
563 } 645 }
564}; 646};
565 647
648/////////////////////////////////////////////////////////////////////////////
649
650// something like a vector or stack, but without
651// out of bounds checking
652template<typename T>
653struct fixed_stack
654{
655 T *data;
656 int size;
657 int max;
658
659 fixed_stack ()
660 : size (0), data (0)
661 {
662 }
663
664 fixed_stack (int max)
665 : size (0), max (max)
666 {
667 data = salloc<T> (max);
668 }
669
670 void reset (int new_max)
671 {
672 sfree (data, max);
673 size = 0;
674 max = new_max;
675 data = salloc<T> (max);
676 }
677
678 void free ()
679 {
680 sfree (data, max);
681 data = 0;
682 }
683
684 ~fixed_stack ()
685 {
686 sfree (data, max);
687 }
688
689 T &operator[](int idx)
690 {
691 return data [idx];
692 }
693
694 void push (T v)
695 {
696 data [size++] = v;
697 }
698
699 T &pop ()
700 {
701 return data [--size];
702 }
703
704 T remove (int idx)
705 {
706 T v = data [idx];
707
708 data [idx] = data [--size];
709
710 return v;
711 }
712};
713
714/////////////////////////////////////////////////////////////////////////////
715
566// basically does what strncpy should do, but appends "..." to strings exceeding length 716// basically does what strncpy should do, but appends "..." to strings exceeding length
717// returns the number of bytes actually used (including \0)
567void assign (char *dst, const char *src, int maxlen); 718int assign (char *dst, const char *src, int maxsize);
568 719
569// type-safe version of assign 720// type-safe version of assign
570template<int N> 721template<int N>
571inline void assign (char (&dst)[N], const char *src) 722inline int assign (char (&dst)[N], const char *src)
572{ 723{
573 assign ((char *)&dst, src, N); 724 return assign ((char *)&dst, src, N);
574} 725}
575 726
576typedef double tstamp; 727typedef double tstamp;
577 728
578// return current time as timestamp 729// return current time as timestamp
579tstamp now (); 730tstamp now ();
580 731
581int similar_direction (int a, int b); 732int similar_direction (int a, int b);
582 733
583// like sprintf, but returns a "static" buffer 734// like v?sprintf, but returns a "static" buffer
584const char *format (const char *format, ...); 735char *vformat (const char *format, va_list ap);
736char *format (const char *format, ...) attribute ((format (printf, 1, 2)));
737
738// safety-check player input which will become object->msg
739bool msg_is_safe (const char *msg);
585 740
586///////////////////////////////////////////////////////////////////////////// 741/////////////////////////////////////////////////////////////////////////////
587// threads, very very thin wrappers around pthreads 742// threads, very very thin wrappers around pthreads
588 743
589struct thread 744struct thread

Diff Legend

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