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.45 by root, Sat May 26 15:44:05 2007 UTC vs.
Revision 1.71 by root, Sun Apr 20 06:20: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
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)
8# define expect(expr,value) __builtin_expect ((expr),(value)) 31# define expect(expr,value) __builtin_expect ((expr),(value))
9# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality) 32# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
… …
11# define is_constant(c) 0 34# define is_constant(c) 0
12# define expect(expr,value) (expr) 35# define expect(expr,value) (expr)
13# define prefetch(addr,rw,locality) 36# define prefetch(addr,rw,locality)
14#endif 37#endif
15 38
39#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
40# define decltype(x) typeof(x)
41#endif
42
16// put into ifs if you are very sure that the expression 43// put into ifs if you are very sure that the expression
17// is mostly true or mosty false. note that these return 44// is mostly true or mosty false. note that these return
18// booleans, not the expression. 45// booleans, not the expression.
19#define expect_false(expr) expect ((expr) != 0, 0) 46#define expect_false(expr) expect ((expr) != 0, 0)
20#define expect_true(expr) expect ((expr) != 0, 1) 47#define expect_true(expr) expect ((expr) != 0, 1)
21 48
49#include <pthread.h>
50
22#include <cstddef> 51#include <cstddef>
23#include <cmath> 52#include <cmath>
24#include <new> 53#include <new>
25#include <vector> 54#include <vector>
26 55
27#include <glib.h> 56#include <glib.h>
28 57
29#include <shstr.h> 58#include <shstr.h>
30#include <traits.h> 59#include <traits.h>
31 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
32// 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)
33#define auto(var,expr) typeof(expr) var = (expr) 75#define auto(var,expr) decltype(expr) var = (expr)
34 76
35// very ugly macro that basicaly declares and initialises a variable 77// very ugly macro that basicaly declares and initialises a variable
36// that is in scope for the next statement only 78// that is in scope for the next statement only
37// 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
38// (note: works great for pointers) 80// (note: works great for pointers)
39// most ugly macro I ever wrote 81// most ugly macro I ever wrote
40#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)
41 83
42// in range including end 84// in range including end
43#define IN_RANGE_INC(val,beg,end) \ 85#define IN_RANGE_INC(val,beg,end) \
44 ((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))
45 87
46// in range excluding end 88// in range excluding end
47#define IN_RANGE_EXC(val,beg,end) \ 89#define IN_RANGE_EXC(val,beg,end) \
48 ((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))
49 91
92void cleanup (const char *cause, bool make_core = false);
50void fork_abort (const char *msg); 93void fork_abort (const char *msg);
51 94
52// 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,
53// 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.
54template<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; }
55template<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; }
56template<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; }
57 100
58template<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)); }
59 105
60template<typename T> 106template<typename T>
61static inline T 107static inline T
62lerp (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)
63{ 109{
… …
147absdir (int d) 193absdir (int d)
148{ 194{
149 return ((d - 1) & 7) + 1; 195 return ((d - 1) & 7) + 1;
150} 196}
151 197
152// makes dynamically allocated objects zero-initialised 198extern ssize_t slice_alloc; // statistics
153struct zero_initialised
154{
155 void *operator new (size_t s, void *p)
156 {
157 memset (p, 0, s);
158 return p;
159 }
160
161 void *operator new (size_t s)
162 {
163 return g_slice_alloc0 (s);
164 }
165
166 void *operator new[] (size_t s)
167 {
168 return g_slice_alloc0 (s);
169 }
170
171 void operator delete (void *p, size_t s)
172 {
173 g_slice_free1 (s, p);
174 }
175
176 void operator delete[] (void *p, size_t s)
177 {
178 g_slice_free1 (s, p);
179 }
180};
181 199
182void *salloc_ (int n) throw (std::bad_alloc); 200void *salloc_ (int n) throw (std::bad_alloc);
183void *salloc_ (int n, void *src) throw (std::bad_alloc); 201void *salloc_ (int n, void *src) throw (std::bad_alloc);
184 202
185// strictly the same as g_slice_alloc, but never returns 0 203// strictly the same as g_slice_alloc, but never returns 0
… …
197 215
198// for symmetry 216// for symmetry
199template<typename T> 217template<typename T>
200inline void sfree (T *ptr, int n = 1) throw () 218inline void sfree (T *ptr, int n = 1) throw ()
201{ 219{
202#ifdef PREFER_MALLOC 220 if (expect_true (ptr))
203 free (ptr); 221 {
204#else 222 slice_alloc -= n * sizeof (T);
223 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
205 g_slice_free1 (n * sizeof (T), (void *)ptr); 224 g_slice_free1 (n * sizeof (T), (void *)ptr);
206#endif 225 assert (slice_alloc >= 0);//D
226 }
207} 227}
228
229// makes dynamically allocated objects zero-initialised
230struct zero_initialised
231{
232 void *operator new (size_t s, void *p)
233 {
234 memset (p, 0, s);
235 return p;
236 }
237
238 void *operator new (size_t s)
239 {
240 return salloc0<char> (s);
241 }
242
243 void *operator new[] (size_t s)
244 {
245 return salloc0<char> (s);
246 }
247
248 void operator delete (void *p, size_t s)
249 {
250 sfree ((char *)p, s);
251 }
252
253 void operator delete[] (void *p, size_t s)
254 {
255 sfree ((char *)p, s);
256 }
257};
208 258
209// a STL-compatible allocator that uses g_slice 259// a STL-compatible allocator that uses g_slice
210// boy, this is verbose 260// boy, this is verbose
211template<typename Tp> 261template<typename Tp>
212struct slice_allocator 262struct slice_allocator
… …
224 { 274 {
225 typedef slice_allocator<U> other; 275 typedef slice_allocator<U> other;
226 }; 276 };
227 277
228 slice_allocator () throw () { } 278 slice_allocator () throw () { }
229 slice_allocator (const slice_allocator &o) throw () { } 279 slice_allocator (const slice_allocator &) throw () { }
230 template<typename Tp2> 280 template<typename Tp2>
231 slice_allocator (const slice_allocator<Tp2> &) throw () { } 281 slice_allocator (const slice_allocator<Tp2> &) throw () { }
232 282
233 ~slice_allocator () { } 283 ~slice_allocator () { }
234 284
… …
243 void deallocate (pointer p, size_type n) 293 void deallocate (pointer p, size_type n)
244 { 294 {
245 sfree<Tp> (p, n); 295 sfree<Tp> (p, n);
246 } 296 }
247 297
248 size_type max_size ()const throw () 298 size_type max_size () const throw ()
249 { 299 {
250 return size_t (-1) / sizeof (Tp); 300 return size_t (-1) / sizeof (Tp);
251 } 301 }
252 302
253 void construct (pointer p, const Tp &val) 303 void construct (pointer p, const Tp &val)
… …
308 358
309typedef tausworthe_random_generator rand_gen; 359typedef tausworthe_random_generator rand_gen;
310 360
311extern rand_gen rndm; 361extern rand_gen rndm;
312 362
363INTERFACE_CLASS (attachable)
364struct refcnt_base
365{
366 typedef int refcnt_t;
367 mutable refcnt_t ACC (RW, refcnt);
368
369 MTH void refcnt_inc () const { ++refcnt; }
370 MTH void refcnt_dec () const { --refcnt; }
371
372 refcnt_base () : refcnt (0) { }
373};
374
375// to avoid branches with more advanced compilers
376extern refcnt_base::refcnt_t refcnt_dummy;
377
313template<class T> 378template<class T>
314struct refptr 379struct refptr
315{ 380{
381 // p if not null
382 refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
383
384 void refcnt_dec ()
385 {
386 if (!is_constant (p))
387 --*refcnt_ref ();
388 else if (p)
389 --p->refcnt;
390 }
391
392 void refcnt_inc ()
393 {
394 if (!is_constant (p))
395 ++*refcnt_ref ();
396 else if (p)
397 ++p->refcnt;
398 }
399
316 T *p; 400 T *p;
317 401
318 refptr () : p(0) { } 402 refptr () : p(0) { }
319 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 403 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
320 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 404 refptr (T *p) : p(p) { refcnt_inc (); }
321 ~refptr () { if (p) p->refcnt_dec (); } 405 ~refptr () { refcnt_dec (); }
322 406
323 const refptr<T> &operator =(T *o) 407 const refptr<T> &operator =(T *o)
324 { 408 {
409 // if decrementing ever destroys we need to reverse the order here
325 if (p) p->refcnt_dec (); 410 refcnt_dec ();
326 p = o; 411 p = o;
327 if (p) p->refcnt_inc (); 412 refcnt_inc ();
328
329 return *this; 413 return *this;
330 } 414 }
331 415
332 const refptr<T> &operator =(const refptr<T> o) 416 const refptr<T> &operator =(const refptr<T> &o)
333 { 417 {
334 *this = o.p; 418 *this = o.p;
335 return *this; 419 return *this;
336 } 420 }
337 421
338 T &operator * () const { return *p; } 422 T &operator * () const { return *p; }
339 T *operator ->() const { return p; } 423 T *operator ->() const { return p; }
340 424
341 operator T *() const { return p; } 425 operator T *() const { return p; }
342}; 426};
343 427
344typedef refptr<maptile> maptile_ptr; 428typedef refptr<maptile> maptile_ptr;
… …
379 { 463 {
380 return !strcmp (a, b); 464 return !strcmp (a, b);
381 } 465 }
382}; 466};
383 467
468// Mostly the same as std::vector, but insert/erase can reorder
469// the elements, making append(=insert)/remove O(1) instead of O(n).
470//
471// NOTE: only some forms of erase are available
384template<class T> 472template<class T>
385struct unordered_vector : std::vector<T, slice_allocator<T> > 473struct unordered_vector : std::vector<T, slice_allocator<T> >
386{ 474{
387 typedef typename unordered_vector::iterator iterator; 475 typedef typename unordered_vector::iterator iterator;
388 476
… …
398 { 486 {
399 erase ((unsigned int )(i - this->begin ())); 487 erase ((unsigned int )(i - this->begin ()));
400 } 488 }
401}; 489};
402 490
403template<class T, int T::* index> 491// This container blends advantages of linked lists
492// (efficiency) with vectors (random access) by
493// by using an unordered vector and storing the vector
494// index inside the object.
495//
496// + memory-efficient on most 64 bit archs
497// + O(1) insert/remove
498// + free unique (but varying) id for inserted objects
499// + cache-friendly iteration
500// - only works for pointers to structs
501//
502// NOTE: only some forms of erase/insert are available
503typedef int object_vector_index;
504
505template<class T, object_vector_index T::*indexmember>
404struct object_vector : std::vector<T *, slice_allocator<T *> > 506struct object_vector : std::vector<T *, slice_allocator<T *> >
405{ 507{
508 typedef typename object_vector::iterator iterator;
509
510 bool contains (const T *obj) const
511 {
512 return obj->*indexmember;
513 }
514
515 iterator find (const T *obj)
516 {
517 return obj->*indexmember
518 ? this->begin () + obj->*indexmember - 1
519 : this->end ();
520 }
521
522 void push_back (T *obj)
523 {
524 std::vector<T *, slice_allocator<T *> >::push_back (obj);
525 obj->*indexmember = this->size ();
526 }
527
406 void insert (T *obj) 528 void insert (T *obj)
407 { 529 {
408 assert (!(obj->*index));
409 push_back (obj); 530 push_back (obj);
410 obj->*index = this->size ();
411 } 531 }
412 532
413 void insert (T &obj) 533 void insert (T &obj)
414 { 534 {
415 insert (&obj); 535 insert (&obj);
416 } 536 }
417 537
418 void erase (T *obj) 538 void erase (T *obj)
419 { 539 {
420 assert (obj->*index);
421 unsigned int pos = obj->*index; 540 unsigned int pos = obj->*indexmember;
422 obj->*index = 0; 541 obj->*indexmember = 0;
423 542
424 if (pos < this->size ()) 543 if (pos < this->size ())
425 { 544 {
426 (*this)[pos - 1] = (*this)[this->size () - 1]; 545 (*this)[pos - 1] = (*this)[this->size () - 1];
427 (*this)[pos - 1]->*index = pos; 546 (*this)[pos - 1]->*indexmember = pos;
428 } 547 }
429 548
430 this->pop_back (); 549 this->pop_back ();
431 } 550 }
432 551
433 void erase (T &obj) 552 void erase (T &obj)
434 { 553 {
435 errase (&obj); 554 erase (&obj);
436 } 555 }
437}; 556};
438 557
439// basically does what strncpy should do, but appends "..." to strings exceeding length 558// basically does what strncpy should do, but appends "..." to strings exceeding length
440void assign (char *dst, const char *src, int maxlen); 559void assign (char *dst, const char *src, int maxlen);
… …
446 assign ((char *)&dst, src, N); 565 assign ((char *)&dst, src, N);
447} 566}
448 567
449typedef double tstamp; 568typedef double tstamp;
450 569
451// return current time as timestampe 570// return current time as timestamp
452tstamp now (); 571tstamp now ();
453 572
454int similar_direction (int a, int b); 573int similar_direction (int a, int b);
455 574
456// like printf, but returns a std::string 575// like sprintf, but returns a "static" buffer
457const std::string format (const char *format, ...); 576const char *format (const char *format, ...);
458 577
578/////////////////////////////////////////////////////////////////////////////
579// threads, very very thin wrappers around pthreads
580
581struct thread
582{
583 pthread_t id;
584
585 void start (void *(*start_routine)(void *), void *arg = 0);
586
587 void cancel ()
588 {
589 pthread_cancel (id);
590 }
591
592 void *join ()
593 {
594 void *ret;
595
596 if (pthread_join (id, &ret))
597 cleanup ("pthread_join failed", 1);
598
599 return ret;
600 }
601};
602
603// note that mutexes are not classes
604typedef pthread_mutex_t smutex;
605
606#if __linux && defined (PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP)
607 #define SMUTEX_INITIALISER PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
608#else
609 #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER
459#endif 610#endif
460 611
612#define SMUTEX(name) smutex name = SMUTEX_INITIALISER
613#define SMUTEX_LOCK(name) pthread_mutex_lock (&(name))
614#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name))
615
616typedef pthread_cond_t scond;
617
618#define SCOND(name) scond name = PTHREAD_COND_INITIALIZER
619#define SCOND_SIGNAL(name) pthread_cond_signal (&(name))
620#define SCOND_BROADCAST(name) pthread_cond_broadcast (&(name))
621#define SCOND_WAIT(name,mutex) pthread_cond_wait (&(name), &(mutex))
622
623#endif
624

Diff Legend

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