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.74 by root, Sun May 4 14:12:37 2008 UTC vs.
Revision 1.118 by root, Tue Jan 3 11:25:33 2012 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,2011,2012 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)
… …
92void cleanup (const char *cause, bool make_core = false); 86void cleanup (const char *cause, bool make_core = false);
93void fork_abort (const char *msg); 87void fork_abort (const char *msg);
94 88
95// rationale for using (U) not (T) is to reduce signed/unsigned issues, 89// rationale for using (U) not (T) is to reduce signed/unsigned issues,
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 a < (T)b ? a : (T)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 a > (T)b ? a : (T)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; }
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); }
100 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.
… …
182#else 252#else
183 return dx_ + dy_ - min (dx_, dy_) * 5 / 8; 253 return dx_ + dy_ - min (dx_, dy_) * 5 / 8;
184#endif 254#endif
185} 255}
186 256
257// can be substantially faster than floor, if your value range allows for it
258template<typename T>
259inline T
260fastfloor (T x)
261{
262 return std::floor (x);
263}
264
265inline float
266fastfloor (float x)
267{
268 return sint32(x) - (x < 0);
269}
270
271inline double
272fastfloor (double x)
273{
274 return sint64(x) - (x < 0);
275}
276
187/* 277/*
188 * absdir(int): Returns a number between 1 and 8, which represent 278 * absdir(int): Returns a number between 1 and 8, which represent
189 * the "absolute" direction of a number (it actually takes care of 279 * the "absolute" direction of a number (it actually takes care of
190 * "overflow" in previous calculations of a direction). 280 * "overflow" in previous calculations of a direction).
191 */ 281 */
… …
193absdir (int d) 283absdir (int d)
194{ 284{
195 return ((d - 1) & 7) + 1; 285 return ((d - 1) & 7) + 1;
196} 286}
197 287
288// avoid ctz name because netbsd or freebsd spams it's namespace with it
289#if GCC_VERSION(3,4)
290static inline int least_significant_bit (uint32_t x)
291{
292 return __builtin_ctz (x);
293}
294#else
295int least_significant_bit (uint32_t x);
296#endif
297
298#define for_all_bits_sparse_32(mask, idxvar) \
299 for (uint32_t idxvar, mask_ = mask; \
300 mask_ && ((idxvar = least_significant_bit (mask_)), mask_ &= ~(1 << idxvar), 1);)
301
198extern ssize_t slice_alloc; // statistics 302extern ssize_t slice_alloc; // statistics
199 303
200void *salloc_ (int n) throw (std::bad_alloc); 304void *salloc_ (int n) throw (std::bad_alloc);
201void *salloc_ (int n, void *src) throw (std::bad_alloc); 305void *salloc_ (int n, void *src) throw (std::bad_alloc);
202 306
… …
220 if (expect_true (ptr)) 324 if (expect_true (ptr))
221 { 325 {
222 slice_alloc -= n * sizeof (T); 326 slice_alloc -= n * sizeof (T);
223 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T)); 327 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
224 g_slice_free1 (n * sizeof (T), (void *)ptr); 328 g_slice_free1 (n * sizeof (T), (void *)ptr);
225 assert (slice_alloc >= 0);//D
226 } 329 }
227} 330}
228 331
229// nulls the pointer 332// nulls the pointer
230template<typename T> 333template<typename T>
… …
346 { 449 {
347 p->~Tp (); 450 p->~Tp ();
348 } 451 }
349}; 452};
350 453
351// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. 454// basically a memory area, but refcounted
352// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 455struct refcnt_buf
353// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
354struct tausworthe_random_generator
355{ 456{
356 // generator 457 char *data;
357 uint32_t state [4];
358 458
359 void operator =(const tausworthe_random_generator &src) 459 refcnt_buf (size_t size = 0);
360 { 460 refcnt_buf (void *data, size_t size);
361 state [0] = src.state [0];
362 state [1] = src.state [1];
363 state [2] = src.state [2];
364 state [3] = src.state [3];
365 }
366 461
367 void seed (uint32_t seed); 462 refcnt_buf (const refcnt_buf &src)
368 uint32_t next ();
369
370 // uniform distribution
371 uint32_t operator ()(uint32_t num)
372 { 463 {
373 return is_constant (num) 464 data = src.data;
374 ? (next () * (uint64_t)num) >> 32U 465 ++_refcnt ();
375 : get_range (num);
376 } 466 }
377 467
378 // return a number within (min .. max) 468 ~refcnt_buf ();
379 int operator () (int r_min, int r_max)
380 {
381 return is_constant (r_min) && is_constant (r_max) && r_min <= r_max
382 ? r_min + operator ()(r_max - r_min + 1)
383 : get_range (r_min, r_max);
384 }
385 469
386 double operator ()() 470 refcnt_buf &operator =(const refcnt_buf &src);
471
472 operator char *()
387 { 473 {
388 return this->next () / (double)0xFFFFFFFFU; 474 return data;
475 }
476
477 size_t size () const
478 {
479 return _size ();
389 } 480 }
390 481
391protected: 482protected:
392 uint32_t get_range (uint32_t r_max); 483 enum {
393 int get_range (int r_min, int r_max); 484 overhead = sizeof (unsigned int) * 2
394}; 485 };
395 486
396typedef tausworthe_random_generator rand_gen; 487 unsigned int &_size () const
488 {
489 return ((unsigned int *)data)[-2];
490 }
397 491
398extern rand_gen rndm, rmg_rndm; 492 unsigned int &_refcnt () const
493 {
494 return ((unsigned int *)data)[-1];
495 }
496
497 void _alloc (unsigned int size)
498 {
499 data = ((char *)salloc<char> (size + overhead)) + overhead;
500 _size () = size;
501 _refcnt () = 1;
502 }
503
504 void dec ()
505 {
506 if (!--_refcnt ())
507 sfree<char> (data - overhead, size () + overhead);
508 }
509};
399 510
400INTERFACE_CLASS (attachable) 511INTERFACE_CLASS (attachable)
401struct refcnt_base 512struct refcnt_base
402{ 513{
403 typedef int refcnt_t; 514 typedef int refcnt_t;
… …
465typedef refptr<maptile> maptile_ptr; 576typedef refptr<maptile> maptile_ptr;
466typedef refptr<object> object_ptr; 577typedef refptr<object> object_ptr;
467typedef refptr<archetype> arch_ptr; 578typedef refptr<archetype> arch_ptr;
468typedef refptr<client> client_ptr; 579typedef refptr<client> client_ptr;
469typedef refptr<player> player_ptr; 580typedef refptr<player> player_ptr;
581typedef refptr<region> region_ptr;
582
583#define STRHSH_NULL 2166136261
584
585static inline uint32_t
586strhsh (const char *s)
587{
588 // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/)
589 // it is about twice as fast as the one-at-a-time one,
590 // with good distribution.
591 // FNV-1a is faster on many cpus because the multiplication
592 // runs concurrently with the looping logic.
593 // we modify the hash a bit to improve its distribution
594 uint32_t hash = STRHSH_NULL;
595
596 while (*s)
597 hash = (hash ^ *s++) * 16777619U;
598
599 return hash ^ (hash >> 16);
600}
601
602static inline uint32_t
603memhsh (const char *s, size_t len)
604{
605 uint32_t hash = STRHSH_NULL;
606
607 while (len--)
608 hash = (hash ^ *s++) * 16777619U;
609
610 return hash;
611}
470 612
471struct str_hash 613struct str_hash
472{ 614{
473 std::size_t operator ()(const char *s) const 615 std::size_t operator ()(const char *s) const
474 { 616 {
475 unsigned long hash = 0;
476
477 /* use the one-at-a-time hash function, which supposedly is
478 * better than the djb2-like one used by perl5.005, but
479 * certainly is better then the bug used here before.
480 * see http://burtleburtle.net/bob/hash/doobs.html
481 */
482 while (*s)
483 {
484 hash += *s++;
485 hash += hash << 10;
486 hash ^= hash >> 6;
487 }
488
489 hash += hash << 3;
490 hash ^= hash >> 11;
491 hash += hash << 15;
492
493 return hash; 617 return strhsh (s);
618 }
619
620 std::size_t operator ()(const shstr &s) const
621 {
622 return strhsh (s);
494 } 623 }
495}; 624};
496 625
497struct str_equal 626struct str_equal
498{ 627{
… …
590 { 719 {
591 erase (&obj); 720 erase (&obj);
592 } 721 }
593}; 722};
594 723
724/////////////////////////////////////////////////////////////////////////////
725
726// something like a vector or stack, but without
727// out of bounds checking
728template<typename T>
729struct fixed_stack
730{
731 T *data;
732 int size;
733 int max;
734
735 fixed_stack ()
736 : size (0), data (0)
737 {
738 }
739
740 fixed_stack (int max)
741 : size (0), max (max)
742 {
743 data = salloc<T> (max);
744 }
745
746 void reset (int new_max)
747 {
748 sfree (data, max);
749 size = 0;
750 max = new_max;
751 data = salloc<T> (max);
752 }
753
754 void free ()
755 {
756 sfree (data, max);
757 data = 0;
758 }
759
760 ~fixed_stack ()
761 {
762 sfree (data, max);
763 }
764
765 T &operator[](int idx)
766 {
767 return data [idx];
768 }
769
770 void push (T v)
771 {
772 data [size++] = v;
773 }
774
775 T &pop ()
776 {
777 return data [--size];
778 }
779
780 T remove (int idx)
781 {
782 T v = data [idx];
783
784 data [idx] = data [--size];
785
786 return v;
787 }
788};
789
790/////////////////////////////////////////////////////////////////////////////
791
595// basically does what strncpy should do, but appends "..." to strings exceeding length 792// basically does what strncpy should do, but appends "..." to strings exceeding length
793// returns the number of bytes actually used (including \0)
596void assign (char *dst, const char *src, int maxlen); 794int assign (char *dst, const char *src, int maxsize);
597 795
598// type-safe version of assign 796// type-safe version of assign
599template<int N> 797template<int N>
600inline void assign (char (&dst)[N], const char *src) 798inline int assign (char (&dst)[N], const char *src)
601{ 799{
602 assign ((char *)&dst, src, N); 800 return assign ((char *)&dst, src, N);
603} 801}
604 802
605typedef double tstamp; 803typedef double tstamp;
606 804
607// return current time as timestamp 805// return current time as timestamp
608tstamp now (); 806tstamp now ();
609 807
610int similar_direction (int a, int b); 808int similar_direction (int a, int b);
611 809
612// like sprintf, but returns a "static" buffer 810// like v?sprintf, but returns a "static" buffer
613const char *format (const char *format, ...); 811char *vformat (const char *format, va_list ap);
812char *format (const char *format, ...) attribute ((format (printf, 1, 2)));
813
814// safety-check player input which will become object->msg
815bool msg_is_safe (const char *msg);
614 816
615///////////////////////////////////////////////////////////////////////////// 817/////////////////////////////////////////////////////////////////////////////
616// threads, very very thin wrappers around pthreads 818// threads, very very thin wrappers around pthreads
617 819
618struct thread 820struct thread

Diff Legend

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