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

Diff Legend

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