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.73 by root, Sat May 3 11:14:50 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
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
48template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } 101template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
102
103template<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)); }
49 105
50template<typename T> 106template<typename T>
51static inline T 107static inline T
52lerp (T val, T min_in, T max_in, T min_out, T max_out) 108lerp (T val, T min_in, T max_in, T min_out, T max_out)
53{ 109{
… …
137absdir (int d) 193absdir (int d)
138{ 194{
139 return ((d - 1) & 7) + 1; 195 return ((d - 1) & 7) + 1;
140} 196}
141 197
142// makes dynamically allocated objects zero-initialised 198extern ssize_t slice_alloc; // statistics
143struct zero_initialised
144{
145 void *operator new (size_t s, void *p)
146 {
147 memset (p, 0, s);
148 return p;
149 }
150
151 void *operator new (size_t s)
152 {
153 return g_slice_alloc0 (s);
154 }
155
156 void *operator new[] (size_t s)
157 {
158 return g_slice_alloc0 (s);
159 }
160
161 void operator delete (void *p, size_t s)
162 {
163 g_slice_free1 (s, p);
164 }
165
166 void operator delete[] (void *p, size_t s)
167 {
168 g_slice_free1 (s, p);
169 }
170};
171 199
172void *salloc_ (int n) throw (std::bad_alloc); 200void *salloc_ (int n) throw (std::bad_alloc);
173void *salloc_ (int n, void *src) throw (std::bad_alloc); 201void *salloc_ (int n, void *src) throw (std::bad_alloc);
174 202
175// strictly the same as g_slice_alloc, but never returns 0 203// strictly the same as g_slice_alloc, but never returns 0
… …
187 215
188// for symmetry 216// for symmetry
189template<typename T> 217template<typename T>
190inline void sfree (T *ptr, int n = 1) throw () 218inline void sfree (T *ptr, int n = 1) throw ()
191{ 219{
192#ifdef PREFER_MALLOC 220 if (expect_true (ptr))
193 free (ptr); 221 {
194#else 222 slice_alloc -= n * sizeof (T);
223 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
195 g_slice_free1 (n * sizeof (T), (void *)ptr); 224 g_slice_free1 (n * sizeof (T), (void *)ptr);
196#endif 225 assert (slice_alloc >= 0);//D
226 }
197} 227}
228
229// nulls the pointer
230template<typename T>
231inline void sfree0 (T *&ptr, int n = 1) throw ()
232{
233 sfree<T> (ptr, n);
234 ptr = 0;
235}
236
237// makes dynamically allocated objects zero-initialised
238struct zero_initialised
239{
240 void *operator new (size_t s, void *p)
241 {
242 memset (p, 0, s);
243 return p;
244 }
245
246 void *operator new (size_t s)
247 {
248 return salloc0<char> (s);
249 }
250
251 void *operator new[] (size_t s)
252 {
253 return salloc0<char> (s);
254 }
255
256 void operator delete (void *p, size_t s)
257 {
258 sfree ((char *)p, s);
259 }
260
261 void operator delete[] (void *p, size_t s)
262 {
263 sfree ((char *)p, s);
264 }
265};
266
267// makes dynamically allocated objects zero-initialised
268struct slice_allocated
269{
270 void *operator new (size_t s, void *p)
271 {
272 return p;
273 }
274
275 void *operator new (size_t s)
276 {
277 return salloc<char> (s);
278 }
279
280 void *operator new[] (size_t s)
281 {
282 return salloc<char> (s);
283 }
284
285 void operator delete (void *p, size_t s)
286 {
287 sfree ((char *)p, s);
288 }
289
290 void operator delete[] (void *p, size_t s)
291 {
292 sfree ((char *)p, s);
293 }
294};
198 295
199// a STL-compatible allocator that uses g_slice 296// a STL-compatible allocator that uses g_slice
200// boy, this is verbose 297// boy, this is verbose
201template<typename Tp> 298template<typename Tp>
202struct slice_allocator 299struct slice_allocator
… …
214 { 311 {
215 typedef slice_allocator<U> other; 312 typedef slice_allocator<U> other;
216 }; 313 };
217 314
218 slice_allocator () throw () { } 315 slice_allocator () throw () { }
219 slice_allocator (const slice_allocator &o) throw () { } 316 slice_allocator (const slice_allocator &) throw () { }
220 template<typename Tp2> 317 template<typename Tp2>
221 slice_allocator (const slice_allocator<Tp2> &) throw () { } 318 slice_allocator (const slice_allocator<Tp2> &) throw () { }
222 319
223 ~slice_allocator () { } 320 ~slice_allocator () { }
224 321
… …
233 void deallocate (pointer p, size_type n) 330 void deallocate (pointer p, size_type n)
234 { 331 {
235 sfree<Tp> (p, n); 332 sfree<Tp> (p, n);
236 } 333 }
237 334
238 size_type max_size ()const throw () 335 size_type max_size () const throw ()
239 { 336 {
240 return size_t (-1) / sizeof (Tp); 337 return size_t (-1) / sizeof (Tp);
241 } 338 }
242 339
243 void construct (pointer p, const Tp &val) 340 void construct (pointer p, const Tp &val)
… …
298 395
299typedef tausworthe_random_generator rand_gen; 396typedef tausworthe_random_generator rand_gen;
300 397
301extern rand_gen rndm; 398extern rand_gen rndm;
302 399
400INTERFACE_CLASS (attachable)
401struct refcnt_base
402{
403 typedef int refcnt_t;
404 mutable refcnt_t ACC (RW, refcnt);
405
406 MTH void refcnt_inc () const { ++refcnt; }
407 MTH void refcnt_dec () const { --refcnt; }
408
409 refcnt_base () : refcnt (0) { }
410};
411
412// to avoid branches with more advanced compilers
413extern refcnt_base::refcnt_t refcnt_dummy;
414
303template<class T> 415template<class T>
304struct refptr 416struct refptr
305{ 417{
418 // p if not null
419 refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
420
421 void refcnt_dec ()
422 {
423 if (!is_constant (p))
424 --*refcnt_ref ();
425 else if (p)
426 --p->refcnt;
427 }
428
429 void refcnt_inc ()
430 {
431 if (!is_constant (p))
432 ++*refcnt_ref ();
433 else if (p)
434 ++p->refcnt;
435 }
436
306 T *p; 437 T *p;
307 438
308 refptr () : p(0) { } 439 refptr () : p(0) { }
309 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 440 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
310 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 441 refptr (T *p) : p(p) { refcnt_inc (); }
311 ~refptr () { if (p) p->refcnt_dec (); } 442 ~refptr () { refcnt_dec (); }
312 443
313 const refptr<T> &operator =(T *o) 444 const refptr<T> &operator =(T *o)
314 { 445 {
446 // if decrementing ever destroys we need to reverse the order here
315 if (p) p->refcnt_dec (); 447 refcnt_dec ();
316 p = o; 448 p = o;
317 if (p) p->refcnt_inc (); 449 refcnt_inc ();
318
319 return *this; 450 return *this;
320 } 451 }
321 452
322 const refptr<T> &operator =(const refptr<T> o) 453 const refptr<T> &operator =(const refptr<T> &o)
323 { 454 {
324 *this = o.p; 455 *this = o.p;
325 return *this; 456 return *this;
326 } 457 }
327 458
328 T &operator * () const { return *p; } 459 T &operator * () const { return *p; }
329 T *operator ->() const { return p; } 460 T *operator ->() const { return p; }
330 461
331 operator T *() const { return p; } 462 operator T *() const { return p; }
332}; 463};
333 464
334typedef refptr<maptile> maptile_ptr; 465typedef refptr<maptile> maptile_ptr;
… …
369 { 500 {
370 return !strcmp (a, b); 501 return !strcmp (a, b);
371 } 502 }
372}; 503};
373 504
505// Mostly the same as std::vector, but insert/erase can reorder
506// the elements, making append(=insert)/remove O(1) instead of O(n).
507//
508// NOTE: only some forms of erase are available
374template<class T> 509template<class T>
375struct unordered_vector : std::vector<T, slice_allocator<T> > 510struct unordered_vector : std::vector<T, slice_allocator<T> >
376{ 511{
377 typedef typename unordered_vector::iterator iterator; 512 typedef typename unordered_vector::iterator iterator;
378 513
… …
388 { 523 {
389 erase ((unsigned int )(i - this->begin ())); 524 erase ((unsigned int )(i - this->begin ()));
390 } 525 }
391}; 526};
392 527
393template<class T, int T::* index> 528// This container blends advantages of linked lists
529// (efficiency) with vectors (random access) by
530// by using an unordered vector and storing the vector
531// index inside the object.
532//
533// + memory-efficient on most 64 bit archs
534// + O(1) insert/remove
535// + free unique (but varying) id for inserted objects
536// + cache-friendly iteration
537// - only works for pointers to structs
538//
539// NOTE: only some forms of erase/insert are available
540typedef int object_vector_index;
541
542template<class T, object_vector_index T::*indexmember>
394struct object_vector : std::vector<T *, slice_allocator<T *> > 543struct object_vector : std::vector<T *, slice_allocator<T *> >
395{ 544{
545 typedef typename object_vector::iterator iterator;
546
547 bool contains (const T *obj) const
548 {
549 return obj->*indexmember;
550 }
551
552 iterator find (const T *obj)
553 {
554 return obj->*indexmember
555 ? this->begin () + obj->*indexmember - 1
556 : this->end ();
557 }
558
559 void push_back (T *obj)
560 {
561 std::vector<T *, slice_allocator<T *> >::push_back (obj);
562 obj->*indexmember = this->size ();
563 }
564
396 void insert (T *obj) 565 void insert (T *obj)
397 { 566 {
398 assert (!(obj->*index));
399 push_back (obj); 567 push_back (obj);
400 obj->*index = this->size ();
401 } 568 }
402 569
403 void insert (T &obj) 570 void insert (T &obj)
404 { 571 {
405 insert (&obj); 572 insert (&obj);
406 } 573 }
407 574
408 void erase (T *obj) 575 void erase (T *obj)
409 { 576 {
410 assert (obj->*index);
411 unsigned int pos = obj->*index; 577 unsigned int pos = obj->*indexmember;
412 obj->*index = 0; 578 obj->*indexmember = 0;
413 579
414 if (pos < this->size ()) 580 if (pos < this->size ())
415 { 581 {
416 (*this)[pos - 1] = (*this)[this->size () - 1]; 582 (*this)[pos - 1] = (*this)[this->size () - 1];
417 (*this)[pos - 1]->*index = pos; 583 (*this)[pos - 1]->*indexmember = pos;
418 } 584 }
419 585
420 this->pop_back (); 586 this->pop_back ();
421 } 587 }
422 588
423 void erase (T &obj) 589 void erase (T &obj)
424 { 590 {
425 errase (&obj); 591 erase (&obj);
426 } 592 }
427}; 593};
428 594
429// basically does what strncpy should do, but appends "..." to strings exceeding length 595// basically does what strncpy should do, but appends "..." to strings exceeding length
430void assign (char *dst, const char *src, int maxlen); 596void assign (char *dst, const char *src, int maxlen);
… …
436 assign ((char *)&dst, src, N); 602 assign ((char *)&dst, src, N);
437} 603}
438 604
439typedef double tstamp; 605typedef double tstamp;
440 606
441// return current time as timestampe 607// return current time as timestamp
442tstamp now (); 608tstamp now ();
443 609
444int similar_direction (int a, int b); 610int similar_direction (int a, int b);
445 611
446// like printf, but returns a std::string 612// like sprintf, but returns a "static" buffer
447const std::string format (const char *format, ...); 613const char *format (const char *format, ...);
448 614
615/////////////////////////////////////////////////////////////////////////////
616// threads, very very thin wrappers around pthreads
617
618struct thread
619{
620 pthread_t id;
621
622 void start (void *(*start_routine)(void *), void *arg = 0);
623
624 void cancel ()
625 {
626 pthread_cancel (id);
627 }
628
629 void *join ()
630 {
631 void *ret;
632
633 if (pthread_join (id, &ret))
634 cleanup ("pthread_join failed", 1);
635
636 return ret;
637 }
638};
639
640// note that mutexes are not classes
641typedef pthread_mutex_t smutex;
642
643#if __linux && defined (PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP)
644 #define SMUTEX_INITIALISER PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
645#else
646 #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER
449#endif 647#endif
450 648
649#define SMUTEX(name) smutex name = SMUTEX_INITIALISER
650#define SMUTEX_LOCK(name) pthread_mutex_lock (&(name))
651#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name))
652
653typedef pthread_cond_t scond;
654
655#define SCOND(name) scond name = PTHREAD_COND_INITIALIZER
656#define SCOND_SIGNAL(name) pthread_cond_signal (&(name))
657#define SCOND_BROADCAST(name) pthread_cond_broadcast (&(name))
658#define SCOND_WAIT(name,mutex) pthread_cond_wait (&(name), &(mutex))
659
660#endif
661

Diff Legend

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