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.32 by root, Thu Jan 18 19:32:37 2007 UTC vs.
Revision 1.63 by root, Sat Mar 15 13:52:38 2008 UTC

1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 *
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
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
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/>.
18 *
19 * The authors can be reached via e-mail to <support@deliantra.net>
20 */
21
1#ifndef UTIL_H__ 22#ifndef UTIL_H__
2#define UTIL_H__ 23#define UTIL_H__
3 24
25//#define PREFER_MALLOC
26#define DEBUG_SALLOC
27
4#if __GNUC__ >= 3 28#if __GNUC__ >= 3
5# define is_constant(c) __builtin_constant_p (c) 29# define is_constant(c) __builtin_constant_p (c)
30# define expect(expr,value) __builtin_expect ((expr),(value))
31# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
6#else 32#else
7# define is_constant(c) 0 33# define is_constant(c) 0
34# define expect(expr,value) (expr)
35# define prefetch(addr,rw,locality)
8#endif 36#endif
37
38#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
39# define decltype(x) typeof(x)
40#endif
41
42// put into ifs if you are very sure that the expression
43// is mostly true or mosty false. note that these return
44// booleans, not the expression.
45#define expect_false(expr) expect ((expr) != 0, 0)
46#define expect_true(expr) expect ((expr) != 0, 1)
9 47
10#include <cstddef> 48#include <cstddef>
11#include <cmath> 49#include <cmath>
12#include <new> 50#include <new>
13#include <vector> 51#include <vector>
… …
15#include <glib.h> 53#include <glib.h>
16 54
17#include <shstr.h> 55#include <shstr.h>
18#include <traits.h> 56#include <traits.h>
19 57
58#ifdef DEBUG_SALLOC
59# define g_slice_alloc0(s) debug_slice_alloc0(s)
60# define g_slice_alloc(s) debug_slice_alloc(s)
61# define g_slice_free1(s,p) debug_slice_free1(s,p)
62void *g_slice_alloc (unsigned long size);
63void *g_slice_alloc0 (unsigned long size);
64void g_slice_free1 (unsigned long size, void *ptr);
65#endif
66
20// use a gcc extension for auto declarations until ISO C++ sanctifies them 67// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever)
21#define AUTODECL(var,expr) typeof(expr) var = (expr) 68#define auto(var,expr) decltype(expr) var = (expr)
22 69
23// very ugly macro that basicaly declares and initialises a variable 70// very ugly macro that basicaly declares and initialises a variable
24// that is in scope for the next statement only 71// that is in scope for the next statement only
25// works only for stuff that can be assigned 0 and converts to false 72// works only for stuff that can be assigned 0 and converts to false
26// (note: works great for pointers) 73// (note: works great for pointers)
27// most ugly macro I ever wrote 74// most ugly macro I ever wrote
28#define declvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) 75#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1)
29 76
30// in range including end 77// in range including end
31#define IN_RANGE_INC(val,beg,end) \ 78#define IN_RANGE_INC(val,beg,end) \
32 ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) 79 ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg))
33 80
… …
35#define IN_RANGE_EXC(val,beg,end) \ 82#define IN_RANGE_EXC(val,beg,end) \
36 ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg)) 83 ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg))
37 84
38void fork_abort (const char *msg); 85void fork_abort (const char *msg);
39 86
87// rationale for using (U) not (T) is to reduce signed/unsigned issues,
88// as a is often a constant while b is the variable. it is still a bug, though.
40template<typename T, typename U> static inline T min (T a, U b) { return a < (T)b ? a : (T)b; } 89template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; }
41template<typename T, typename U> static inline T max (T a, U b) { return a > (T)b ? a : (T)b; } 90template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; }
42template<typename T, typename U, typename V> static inline T clamp (T v, U a, V b) { return v < (T)a ? a : v >(T)b ? b : v; } 91template<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; }
43 92
44template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } 93template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
94
95template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); }
96template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
97
98template<typename T>
99static inline T
100lerp (T val, T min_in, T max_in, T min_out, T max_out)
101{
102 return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out;
103}
104
105// lots of stuff taken from FXT
106
107/* Rotate right. This is used in various places for checksumming */
108//TODO: that sucks, use a better checksum algo
109static inline uint32_t
110rotate_right (uint32_t c, uint32_t count = 1)
111{
112 return (c << (32 - count)) | (c >> count);
113}
114
115static inline uint32_t
116rotate_left (uint32_t c, uint32_t count = 1)
117{
118 return (c >> (32 - count)) | (c << count);
119}
120
121// Return abs(a-b)
122// Both a and b must not have the most significant bit set
123static inline uint32_t
124upos_abs_diff (uint32_t a, uint32_t b)
125{
126 long d1 = b - a;
127 long d2 = (d1 & (d1 >> 31)) << 1;
128
129 return d1 - d2; // == (b - d) - (a + d);
130}
131
132// Both a and b must not have the most significant bit set
133static inline uint32_t
134upos_min (uint32_t a, uint32_t b)
135{
136 int32_t d = b - a;
137 d &= d >> 31;
138 return a + d;
139}
140
141// Both a and b must not have the most significant bit set
142static inline uint32_t
143upos_max (uint32_t a, uint32_t b)
144{
145 int32_t d = b - a;
146 d &= d >> 31;
147 return b - d;
148}
45 149
46// this is much faster than crossfires original algorithm 150// this is much faster than crossfires original algorithm
47// on modern cpus 151// on modern cpus
48inline int 152inline int
49isqrt (int n) 153isqrt (int n)
… …
81absdir (int d) 185absdir (int d)
82{ 186{
83 return ((d - 1) & 7) + 1; 187 return ((d - 1) & 7) + 1;
84} 188}
85 189
190extern size_t slice_alloc; // statistics
191
86// makes dynamically allocated objects zero-initialised 192// makes dynamically allocated objects zero-initialised
87struct zero_initialised 193struct zero_initialised
88{ 194{
89 void *operator new (size_t s, void *p) 195 void *operator new (size_t s, void *p)
90 { 196 {
… …
92 return p; 198 return p;
93 } 199 }
94 200
95 void *operator new (size_t s) 201 void *operator new (size_t s)
96 { 202 {
203 slice_alloc += s;
97 return g_slice_alloc0 (s); 204 return g_slice_alloc0 (s);
98 } 205 }
99 206
100 void *operator new[] (size_t s) 207 void *operator new[] (size_t s)
101 { 208 {
209 slice_alloc += s;
102 return g_slice_alloc0 (s); 210 return g_slice_alloc0 (s);
103 } 211 }
104 212
105 void operator delete (void *p, size_t s) 213 void operator delete (void *p, size_t s)
106 { 214 {
215 slice_alloc -= s;
107 g_slice_free1 (s, p); 216 g_slice_free1 (s, p);
108 } 217 }
109 218
110 void operator delete[] (void *p, size_t s) 219 void operator delete[] (void *p, size_t s)
111 { 220 {
221 slice_alloc -= s;
112 g_slice_free1 (s, p); 222 g_slice_free1 (s, p);
113 } 223 }
114}; 224};
115 225
116void *salloc_ (int n) throw (std::bad_alloc); 226void *salloc_ (int n) throw (std::bad_alloc);
… …
131 241
132// for symmetry 242// for symmetry
133template<typename T> 243template<typename T>
134inline void sfree (T *ptr, int n = 1) throw () 244inline void sfree (T *ptr, int n = 1) throw ()
135{ 245{
246#ifdef PREFER_MALLOC
247 free (ptr);
248#else
249 slice_alloc -= n * sizeof (T);
136 g_slice_free1 (n * sizeof (T), (void *)ptr); 250 g_slice_free1 (n * sizeof (T), (void *)ptr);
251#endif
137} 252}
138 253
139// a STL-compatible allocator that uses g_slice 254// a STL-compatible allocator that uses g_slice
140// boy, this is verbose 255// boy, this is verbose
141template<typename Tp> 256template<typename Tp>
… …
194// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. 309// P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213.
195// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps 310// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
196// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps 311// http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
197struct tausworthe_random_generator 312struct tausworthe_random_generator
198{ 313{
314 // generator
199 uint32_t state [4]; 315 uint32_t state [4];
200 316
201 tausworthe_random_generator (uint32_t seed); 317 void operator =(const tausworthe_random_generator &src)
318 {
319 state [0] = src.state [0];
320 state [1] = src.state [1];
321 state [2] = src.state [2];
322 state [3] = src.state [3];
323 }
324
325 void seed (uint32_t seed);
202 uint32_t next (); 326 uint32_t next ();
203 327
328 // uniform distribution
204 uint32_t operator ()(uint32_t r_max) 329 uint32_t operator ()(uint32_t num)
205 { 330 {
206 return next () % r_max; 331 return is_constant (num)
332 ? (next () * (uint64_t)num) >> 32U
333 : get_range (num);
207 } 334 }
208 335
209 // return a number within (min .. max) 336 // return a number within (min .. max)
210 int operator () (int r_min, int r_max) 337 int operator () (int r_min, int r_max)
211 { 338 {
212 return r_min + next () % max (r_max - r_min + 1, 1); 339 return is_constant (r_min) && is_constant (r_max) && r_min <= r_max
340 ? r_min + operator ()(r_max - r_min + 1)
341 : get_range (r_min, r_max);
213 } 342 }
214 343
215 double operator ()() 344 double operator ()()
216 { 345 {
217 return next () / (double)0xFFFFFFFFU; 346 return this->next () / (double)0xFFFFFFFFU;
218 } 347 }
348
349protected:
350 uint32_t get_range (uint32_t r_max);
351 int get_range (int r_min, int r_max);
219}; 352};
220 353
221typedef tausworthe_random_generator rand_gen; 354typedef tausworthe_random_generator rand_gen;
222 355
223extern rand_gen rndm; 356extern rand_gen rndm;
357
358INTERFACE_CLASS (attachable)
359struct refcnt_base
360{
361 typedef int refcnt_t;
362 mutable refcnt_t ACC (RW, refcnt);
363
364 MTH void refcnt_inc () const { ++refcnt; }
365 MTH void refcnt_dec () const { --refcnt; }
366
367 refcnt_base () : refcnt (0) { }
368};
369
370// to avoid branches with more advanced compilers
371extern refcnt_base::refcnt_t refcnt_dummy;
224 372
225template<class T> 373template<class T>
226struct refptr 374struct refptr
227{ 375{
376 // p if not null
377 refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
378
379 void refcnt_dec ()
380 {
381 if (!is_constant (p))
382 --*refcnt_ref ();
383 else if (p)
384 --p->refcnt;
385 }
386
387 void refcnt_inc ()
388 {
389 if (!is_constant (p))
390 ++*refcnt_ref ();
391 else if (p)
392 ++p->refcnt;
393 }
394
228 T *p; 395 T *p;
229 396
230 refptr () : p(0) { } 397 refptr () : p(0) { }
231 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 398 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
232 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 399 refptr (T *p) : p(p) { refcnt_inc (); }
233 ~refptr () { if (p) p->refcnt_dec (); } 400 ~refptr () { refcnt_dec (); }
234 401
235 const refptr<T> &operator =(T *o) 402 const refptr<T> &operator =(T *o)
236 { 403 {
404 // if decrementing ever destroys we need to reverse the order here
237 if (p) p->refcnt_dec (); 405 refcnt_dec ();
238 p = o; 406 p = o;
239 if (p) p->refcnt_inc (); 407 refcnt_inc ();
240
241 return *this; 408 return *this;
242 } 409 }
243 410
244 const refptr<T> &operator =(const refptr<T> o) 411 const refptr<T> &operator =(const refptr<T> &o)
245 { 412 {
246 *this = o.p; 413 *this = o.p;
247 return *this; 414 return *this;
248 } 415 }
249 416
250 T &operator * () const { return *p; } 417 T &operator * () const { return *p; }
251 T *operator ->() const { return p; } 418 T *operator ->() const { return p; }
252 419
253 operator T *() const { return p; } 420 operator T *() const { return p; }
254}; 421};
255 422
256typedef refptr<maptile> maptile_ptr; 423typedef refptr<maptile> maptile_ptr;
… …
291 { 458 {
292 return !strcmp (a, b); 459 return !strcmp (a, b);
293 } 460 }
294}; 461};
295 462
463// Mostly the same as std::vector, but insert/erase can reorder
464// the elements, making append(=insert)/remove O(1) instead of O(n).
465//
466// NOTE: only some forms of erase are available
296template<class T> 467template<class T>
297struct unordered_vector : std::vector<T, slice_allocator<T> > 468struct unordered_vector : std::vector<T, slice_allocator<T> >
298{ 469{
299 typedef typename unordered_vector::iterator iterator; 470 typedef typename unordered_vector::iterator iterator;
300 471
… …
310 { 481 {
311 erase ((unsigned int )(i - this->begin ())); 482 erase ((unsigned int )(i - this->begin ()));
312 } 483 }
313}; 484};
314 485
315template<class T, int T::* index> 486// This container blends advantages of linked lists
487// (efficiency) with vectors (random access) by
488// by using an unordered vector and storing the vector
489// index inside the object.
490//
491// + memory-efficient on most 64 bit archs
492// + O(1) insert/remove
493// + free unique (but varying) id for inserted objects
494// + cache-friendly iteration
495// - only works for pointers to structs
496//
497// NOTE: only some forms of erase/insert are available
498typedef int object_vector_index;
499
500template<class T, object_vector_index T::*indexmember>
316struct object_vector : std::vector<T *, slice_allocator<T *> > 501struct object_vector : std::vector<T *, slice_allocator<T *> >
317{ 502{
503 typedef typename object_vector::iterator iterator;
504
505 bool contains (const T *obj) const
506 {
507 return obj->*indexmember;
508 }
509
510 iterator find (const T *obj)
511 {
512 return obj->*indexmember
513 ? this->begin () + obj->*indexmember - 1
514 : this->end ();
515 }
516
517 void push_back (T *obj)
518 {
519 std::vector<T *, slice_allocator<T *> >::push_back (obj);
520 obj->*indexmember = this->size ();
521 }
522
318 void insert (T *obj) 523 void insert (T *obj)
319 { 524 {
320 assert (!(obj->*index));
321 push_back (obj); 525 push_back (obj);
322 obj->*index = this->size ();
323 } 526 }
324 527
325 void insert (T &obj) 528 void insert (T &obj)
326 { 529 {
327 insert (&obj); 530 insert (&obj);
328 } 531 }
329 532
330 void erase (T *obj) 533 void erase (T *obj)
331 { 534 {
332 assert (obj->*index);
333 int pos = obj->*index; 535 unsigned int pos = obj->*indexmember;
334 obj->*index = 0; 536 obj->*indexmember = 0;
335 537
336 if (pos < this->size ()) 538 if (pos < this->size ())
337 { 539 {
338 (*this)[pos - 1] = (*this)[this->size () - 1]; 540 (*this)[pos - 1] = (*this)[this->size () - 1];
339 (*this)[pos - 1]->*index = pos; 541 (*this)[pos - 1]->*indexmember = pos;
340 } 542 }
341 543
342 this->pop_back (); 544 this->pop_back ();
343 } 545 }
344 546
345 void erase (T &obj) 547 void erase (T &obj)
346 { 548 {
347 errase (&obj); 549 erase (&obj);
348 } 550 }
349}; 551};
350 552
351// basically does what strncpy should do, but appends "..." to strings exceeding length 553// basically does what strncpy should do, but appends "..." to strings exceeding length
352void assign (char *dst, const char *src, int maxlen); 554void assign (char *dst, const char *src, int maxlen);
… …
358 assign ((char *)&dst, src, N); 560 assign ((char *)&dst, src, N);
359} 561}
360 562
361typedef double tstamp; 563typedef double tstamp;
362 564
363// return current time as timestampe 565// return current time as timestamp
364tstamp now (); 566tstamp now ();
365 567
366int similar_direction (int a, int b); 568int similar_direction (int a, int b);
367 569
368#endif 570// like sprintf, but returns a "static" buffer
571const char *format (const char *format, ...);
369 572
573#endif
574

Diff Legend

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