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.44 by root, Fri May 11 08:00:00 2007 UTC vs.
Revision 1.79 by root, Fri Dec 19 22:47:29 2008 UTC

1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 *
4 * Copyright (©) 2005,2006,2007,2008 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
4//#define PREFER_MALLOC 25#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0
26#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs
27#define PREFER_MALLOC 0 // use malloc and not the slice allocator
5 28
6#if __GNUC__ >= 3 29#if __GNUC__ >= 3
7# 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))
32# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
8#else 33#else
9# define is_constant(c) 0 34# define is_constant(c) 0
35# define expect(expr,value) (expr)
36# define prefetch(addr,rw,locality)
10#endif 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
49#include <pthread.h>
11 50
12#include <cstddef> 51#include <cstddef>
13#include <cmath> 52#include <cmath>
14#include <new> 53#include <new>
15#include <vector> 54#include <vector>
… …
17#include <glib.h> 56#include <glib.h>
18 57
19#include <shstr.h> 58#include <shstr.h>
20#include <traits.h> 59#include <traits.h>
21 60
61#if DEBUG_SALLOC
62# define g_slice_alloc0(s) debug_slice_alloc0(s)
63# define g_slice_alloc(s) debug_slice_alloc(s)
64# define g_slice_free1(s,p) debug_slice_free1(s,p)
65void *g_slice_alloc (unsigned long size);
66void *g_slice_alloc0 (unsigned long size);
67void g_slice_free1 (unsigned long size, void *ptr);
68#elif PREFER_MALLOC
69# define g_slice_alloc0(s) calloc (1, (s))
70# define g_slice_alloc(s) malloc ((s))
71# define g_slice_free1(s,p) free ((p))
72#endif
73
22// use a gcc extension for auto declarations until ISO C++ sanctifies them 74// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever)
23#define auto(var,expr) typeof(expr) var = (expr) 75#define auto(var,expr) decltype(expr) var = (expr)
24 76
25// very ugly macro that basicaly declares and initialises a variable 77// very ugly macro that basicaly declares and initialises a variable
26// that is in scope for the next statement only 78// that is in scope for the next statement only
27// works only for stuff that can be assigned 0 and converts to false 79// works only for stuff that can be assigned 0 and converts to false
28// (note: works great for pointers) 80// (note: works great for pointers)
29// most ugly macro I ever wrote 81// most ugly macro I ever wrote
30#define declvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) 82#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1)
31 83
32// in range including end 84// in range including end
33#define IN_RANGE_INC(val,beg,end) \ 85#define IN_RANGE_INC(val,beg,end) \
34 ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) 86 ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg))
35 87
36// in range excluding end 88// in range excluding end
37#define IN_RANGE_EXC(val,beg,end) \ 89#define IN_RANGE_EXC(val,beg,end) \
38 ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg)) 90 ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg))
39 91
92void cleanup (const char *cause, bool make_core = false);
40void fork_abort (const char *msg); 93void fork_abort (const char *msg);
41 94
42// rationale for using (U) not (T) is to reduce signed/unsigned issues, 95// rationale for using (U) not (T) is to reduce signed/unsigned issues,
43// as a is often a constant while b is the variable. it is still a bug, though. 96// as a is often a constant while b is the variable. it is still a bug, though.
44template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } 97template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; }
45template<typename T, typename U> static inline T max (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; }
46template<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; } 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; }
47 100
101template<typename T> static inline void min_it (T &v, T m) { v = min (v, m); }
102template<typename T> static inline void max_it (T &v, T m) { v = max (v, m); }
103template<typename T> static inline void clamp_it (T &v, T a, T b) { v = clamp (v, a, b); }
104
48template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } 105template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
106
107template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); }
108template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
109
110// sign returns -1 or +1
111template<typename T>
112static inline T sign (T v) { return v < 0 ? -1 : +1; }
113// relies on 2c representation
114template<>
115inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); }
116
117// sign0 returns -1, 0 or +1
118template<typename T>
119static inline T sign0 (T v) { return v ? sign (v) : 0; }
120
121// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
122template<typename T> static inline T div (T val, T div) { return (val + div / 2) / div; }
123// div, round-up
124template<typename T> static inline T div_ru (T val, T div) { return (val + div - 1) / div; }
125// div, round-down
126template<typename T> static inline T div_rd (T val, T div) { return (val ) / div; }
49 127
50template<typename T> 128template<typename T>
51static inline T 129static inline T
52lerp (T val, T min_in, T max_in, T min_out, T max_out) 130lerp (T val, T min_in, T max_in, T min_out, T max_out)
53{ 131{
54 return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; 132 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in);
133}
134
135// lerp, round-down
136template<typename T>
137static inline T
138lerp_rd (T val, T min_in, T max_in, T min_out, T max_out)
139{
140 return min_out + div_rd<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
141}
142
143// lerp, round-up
144template<typename T>
145static inline T
146lerp_ru (T val, T min_in, T max_in, T min_out, T max_out)
147{
148 return min_out + div_ru<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
55} 149}
56 150
57// lots of stuff taken from FXT 151// lots of stuff taken from FXT
58 152
59/* Rotate right. This is used in various places for checksumming */ 153/* Rotate right. This is used in various places for checksumming */
… …
137absdir (int d) 231absdir (int d)
138{ 232{
139 return ((d - 1) & 7) + 1; 233 return ((d - 1) & 7) + 1;
140} 234}
141 235
236extern ssize_t slice_alloc; // statistics
237
238void *salloc_ (int n) throw (std::bad_alloc);
239void *salloc_ (int n, void *src) throw (std::bad_alloc);
240
241// strictly the same as g_slice_alloc, but never returns 0
242template<typename T>
243inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); }
244
245// also copies src into the new area, like "memdup"
246// if src is 0, clears the memory
247template<typename T>
248inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
249
250// clears the memory
251template<typename T>
252inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); }
253
254// for symmetry
255template<typename T>
256inline void sfree (T *ptr, int n = 1) throw ()
257{
258 if (expect_true (ptr))
259 {
260 slice_alloc -= n * sizeof (T);
261 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
262 g_slice_free1 (n * sizeof (T), (void *)ptr);
263 assert (slice_alloc >= 0);//D
264 }
265}
266
267// nulls the pointer
268template<typename T>
269inline void sfree0 (T *&ptr, int n = 1) throw ()
270{
271 sfree<T> (ptr, n);
272 ptr = 0;
273}
274
142// makes dynamically allocated objects zero-initialised 275// makes dynamically allocated objects zero-initialised
143struct zero_initialised 276struct zero_initialised
144{ 277{
145 void *operator new (size_t s, void *p) 278 void *operator new (size_t s, void *p)
146 { 279 {
… …
148 return p; 281 return p;
149 } 282 }
150 283
151 void *operator new (size_t s) 284 void *operator new (size_t s)
152 { 285 {
153 return g_slice_alloc0 (s); 286 return salloc0<char> (s);
154 } 287 }
155 288
156 void *operator new[] (size_t s) 289 void *operator new[] (size_t s)
157 { 290 {
158 return g_slice_alloc0 (s); 291 return salloc0<char> (s);
159 } 292 }
160 293
161 void operator delete (void *p, size_t s) 294 void operator delete (void *p, size_t s)
162 { 295 {
163 g_slice_free1 (s, p); 296 sfree ((char *)p, s);
164 } 297 }
165 298
166 void operator delete[] (void *p, size_t s) 299 void operator delete[] (void *p, size_t s)
167 { 300 {
168 g_slice_free1 (s, p); 301 sfree ((char *)p, s);
169 } 302 }
170}; 303};
171 304
172void *salloc_ (int n) throw (std::bad_alloc); 305// makes dynamically allocated objects zero-initialised
173void *salloc_ (int n, void *src) throw (std::bad_alloc); 306struct slice_allocated
174
175// strictly the same as g_slice_alloc, but never returns 0
176template<typename T>
177inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); }
178
179// also copies src into the new area, like "memdup"
180// if src is 0, clears the memory
181template<typename T>
182inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
183
184// clears the memory
185template<typename T>
186inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); }
187
188// for symmetry
189template<typename T>
190inline void sfree (T *ptr, int n = 1) throw ()
191{ 307{
192#ifdef PREFER_MALLOC 308 void *operator new (size_t s, void *p)
193 free (ptr); 309 {
194#else 310 return p;
195 g_slice_free1 (n * sizeof (T), (void *)ptr); 311 }
196#endif 312
197} 313 void *operator new (size_t s)
314 {
315 return salloc<char> (s);
316 }
317
318 void *operator new[] (size_t s)
319 {
320 return salloc<char> (s);
321 }
322
323 void operator delete (void *p, size_t s)
324 {
325 sfree ((char *)p, s);
326 }
327
328 void operator delete[] (void *p, size_t s)
329 {
330 sfree ((char *)p, s);
331 }
332};
198 333
199// a STL-compatible allocator that uses g_slice 334// a STL-compatible allocator that uses g_slice
200// boy, this is verbose 335// boy, this is verbose
201template<typename Tp> 336template<typename Tp>
202struct slice_allocator 337struct slice_allocator
… …
214 { 349 {
215 typedef slice_allocator<U> other; 350 typedef slice_allocator<U> other;
216 }; 351 };
217 352
218 slice_allocator () throw () { } 353 slice_allocator () throw () { }
219 slice_allocator (const slice_allocator &o) throw () { } 354 slice_allocator (const slice_allocator &) throw () { }
220 template<typename Tp2> 355 template<typename Tp2>
221 slice_allocator (const slice_allocator<Tp2> &) throw () { } 356 slice_allocator (const slice_allocator<Tp2> &) throw () { }
222 357
223 ~slice_allocator () { } 358 ~slice_allocator () { }
224 359
… …
233 void deallocate (pointer p, size_type n) 368 void deallocate (pointer p, size_type n)
234 { 369 {
235 sfree<Tp> (p, n); 370 sfree<Tp> (p, n);
236 } 371 }
237 372
238 size_type max_size ()const throw () 373 size_type max_size () const throw ()
239 { 374 {
240 return size_t (-1) / sizeof (Tp); 375 return size_t (-1) / sizeof (Tp);
241 } 376 }
242 377
243 void construct (pointer p, const Tp &val) 378 void construct (pointer p, const Tp &val)
… …
268 } 403 }
269 404
270 void seed (uint32_t seed); 405 void seed (uint32_t seed);
271 uint32_t next (); 406 uint32_t next ();
272 407
273 // uniform distribution 408 // uniform distribution, 0 .. max (0, num - 1)
274 uint32_t operator ()(uint32_t num) 409 uint32_t operator ()(uint32_t num)
275 { 410 {
276 return is_constant (num) 411 return is_constant (num)
277 ? (next () * (uint64_t)num) >> 32U 412 ? (next () * (uint64_t)num) >> 32U
278 : get_range (num); 413 : get_range (num);
… …
296 int get_range (int r_min, int r_max); 431 int get_range (int r_min, int r_max);
297}; 432};
298 433
299typedef tausworthe_random_generator rand_gen; 434typedef tausworthe_random_generator rand_gen;
300 435
301extern rand_gen rndm; 436extern rand_gen rndm, rmg_rndm;
437
438INTERFACE_CLASS (attachable)
439struct refcnt_base
440{
441 typedef int refcnt_t;
442 mutable refcnt_t ACC (RW, refcnt);
443
444 MTH void refcnt_inc () const { ++refcnt; }
445 MTH void refcnt_dec () const { --refcnt; }
446
447 refcnt_base () : refcnt (0) { }
448};
449
450// to avoid branches with more advanced compilers
451extern refcnt_base::refcnt_t refcnt_dummy;
302 452
303template<class T> 453template<class T>
304struct refptr 454struct refptr
305{ 455{
456 // p if not null
457 refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
458
459 void refcnt_dec ()
460 {
461 if (!is_constant (p))
462 --*refcnt_ref ();
463 else if (p)
464 --p->refcnt;
465 }
466
467 void refcnt_inc ()
468 {
469 if (!is_constant (p))
470 ++*refcnt_ref ();
471 else if (p)
472 ++p->refcnt;
473 }
474
306 T *p; 475 T *p;
307 476
308 refptr () : p(0) { } 477 refptr () : p(0) { }
309 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 478 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
310 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 479 refptr (T *p) : p(p) { refcnt_inc (); }
311 ~refptr () { if (p) p->refcnt_dec (); } 480 ~refptr () { refcnt_dec (); }
312 481
313 const refptr<T> &operator =(T *o) 482 const refptr<T> &operator =(T *o)
314 { 483 {
484 // if decrementing ever destroys we need to reverse the order here
315 if (p) p->refcnt_dec (); 485 refcnt_dec ();
316 p = o; 486 p = o;
317 if (p) p->refcnt_inc (); 487 refcnt_inc ();
318
319 return *this; 488 return *this;
320 } 489 }
321 490
322 const refptr<T> &operator =(const refptr<T> o) 491 const refptr<T> &operator =(const refptr<T> &o)
323 { 492 {
324 *this = o.p; 493 *this = o.p;
325 return *this; 494 return *this;
326 } 495 }
327 496
328 T &operator * () const { return *p; } 497 T &operator * () const { return *p; }
329 T *operator ->() const { return p; } 498 T *operator ->() const { return p; }
330 499
331 operator T *() const { return p; } 500 operator T *() const { return p; }
332}; 501};
333 502
334typedef refptr<maptile> maptile_ptr; 503typedef refptr<maptile> maptile_ptr;
… …
369 { 538 {
370 return !strcmp (a, b); 539 return !strcmp (a, b);
371 } 540 }
372}; 541};
373 542
543// Mostly the same as std::vector, but insert/erase can reorder
544// the elements, making append(=insert)/remove O(1) instead of O(n).
545//
546// NOTE: only some forms of erase are available
374template<class T> 547template<class T>
375struct unordered_vector : std::vector<T, slice_allocator<T> > 548struct unordered_vector : std::vector<T, slice_allocator<T> >
376{ 549{
377 typedef typename unordered_vector::iterator iterator; 550 typedef typename unordered_vector::iterator iterator;
378 551
… …
388 { 561 {
389 erase ((unsigned int )(i - this->begin ())); 562 erase ((unsigned int )(i - this->begin ()));
390 } 563 }
391}; 564};
392 565
393template<class T, int T::* index> 566// This container blends advantages of linked lists
567// (efficiency) with vectors (random access) by
568// by using an unordered vector and storing the vector
569// index inside the object.
570//
571// + memory-efficient on most 64 bit archs
572// + O(1) insert/remove
573// + free unique (but varying) id for inserted objects
574// + cache-friendly iteration
575// - only works for pointers to structs
576//
577// NOTE: only some forms of erase/insert are available
578typedef int object_vector_index;
579
580template<class T, object_vector_index T::*indexmember>
394struct object_vector : std::vector<T *, slice_allocator<T *> > 581struct object_vector : std::vector<T *, slice_allocator<T *> >
395{ 582{
583 typedef typename object_vector::iterator iterator;
584
585 bool contains (const T *obj) const
586 {
587 return obj->*indexmember;
588 }
589
590 iterator find (const T *obj)
591 {
592 return obj->*indexmember
593 ? this->begin () + obj->*indexmember - 1
594 : this->end ();
595 }
596
597 void push_back (T *obj)
598 {
599 std::vector<T *, slice_allocator<T *> >::push_back (obj);
600 obj->*indexmember = this->size ();
601 }
602
396 void insert (T *obj) 603 void insert (T *obj)
397 { 604 {
398 assert (!(obj->*index));
399 push_back (obj); 605 push_back (obj);
400 obj->*index = this->size ();
401 } 606 }
402 607
403 void insert (T &obj) 608 void insert (T &obj)
404 { 609 {
405 insert (&obj); 610 insert (&obj);
406 } 611 }
407 612
408 void erase (T *obj) 613 void erase (T *obj)
409 { 614 {
410 assert (obj->*index);
411 unsigned int pos = obj->*index; 615 unsigned int pos = obj->*indexmember;
412 obj->*index = 0; 616 obj->*indexmember = 0;
413 617
414 if (pos < this->size ()) 618 if (pos < this->size ())
415 { 619 {
416 (*this)[pos - 1] = (*this)[this->size () - 1]; 620 (*this)[pos - 1] = (*this)[this->size () - 1];
417 (*this)[pos - 1]->*index = pos; 621 (*this)[pos - 1]->*indexmember = pos;
418 } 622 }
419 623
420 this->pop_back (); 624 this->pop_back ();
421 } 625 }
422 626
423 void erase (T &obj) 627 void erase (T &obj)
424 { 628 {
425 errase (&obj); 629 erase (&obj);
426 } 630 }
427}; 631};
428 632
429// basically does what strncpy should do, but appends "..." to strings exceeding length 633// basically does what strncpy should do, but appends "..." to strings exceeding length
430void assign (char *dst, const char *src, int maxlen); 634void assign (char *dst, const char *src, int maxlen);
… …
436 assign ((char *)&dst, src, N); 640 assign ((char *)&dst, src, N);
437} 641}
438 642
439typedef double tstamp; 643typedef double tstamp;
440 644
441// return current time as timestampe 645// return current time as timestamp
442tstamp now (); 646tstamp now ();
443 647
444int similar_direction (int a, int b); 648int similar_direction (int a, int b);
445 649
446// like printf, but returns a std::string 650// like sprintf, but returns a "static" buffer
447const std::string format (const char *format, ...); 651const char *format (const char *format, ...);
448 652
653/////////////////////////////////////////////////////////////////////////////
654// threads, very very thin wrappers around pthreads
655
656struct thread
657{
658 pthread_t id;
659
660 void start (void *(*start_routine)(void *), void *arg = 0);
661
662 void cancel ()
663 {
664 pthread_cancel (id);
665 }
666
667 void *join ()
668 {
669 void *ret;
670
671 if (pthread_join (id, &ret))
672 cleanup ("pthread_join failed", 1);
673
674 return ret;
675 }
676};
677
678// note that mutexes are not classes
679typedef pthread_mutex_t smutex;
680
681#if __linux && defined (PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP)
682 #define SMUTEX_INITIALISER PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
683#else
684 #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER
449#endif 685#endif
450 686
687#define SMUTEX(name) smutex name = SMUTEX_INITIALISER
688#define SMUTEX_LOCK(name) pthread_mutex_lock (&(name))
689#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name))
690
691typedef pthread_cond_t scond;
692
693#define SCOND(name) scond name = PTHREAD_COND_INITIALIZER
694#define SCOND_SIGNAL(name) pthread_cond_signal (&(name))
695#define SCOND_BROADCAST(name) pthread_cond_broadcast (&(name))
696#define SCOND_WAIT(name,mutex) pthread_cond_wait (&(name), &(mutex))
697
698#endif
699

Diff Legend

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