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.72 by root, Wed Apr 30 16:26:28 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};
198 266
199// a STL-compatible allocator that uses g_slice 267// a STL-compatible allocator that uses g_slice
200// boy, this is verbose 268// boy, this is verbose
201template<typename Tp> 269template<typename Tp>
202struct slice_allocator 270struct slice_allocator
214 { 282 {
215 typedef slice_allocator<U> other; 283 typedef slice_allocator<U> other;
216 }; 284 };
217 285
218 slice_allocator () throw () { } 286 slice_allocator () throw () { }
219 slice_allocator (const slice_allocator &o) throw () { } 287 slice_allocator (const slice_allocator &) throw () { }
220 template<typename Tp2> 288 template<typename Tp2>
221 slice_allocator (const slice_allocator<Tp2> &) throw () { } 289 slice_allocator (const slice_allocator<Tp2> &) throw () { }
222 290
223 ~slice_allocator () { } 291 ~slice_allocator () { }
224 292
233 void deallocate (pointer p, size_type n) 301 void deallocate (pointer p, size_type n)
234 { 302 {
235 sfree<Tp> (p, n); 303 sfree<Tp> (p, n);
236 } 304 }
237 305
238 size_type max_size ()const throw () 306 size_type max_size () const throw ()
239 { 307 {
240 return size_t (-1) / sizeof (Tp); 308 return size_t (-1) / sizeof (Tp);
241 } 309 }
242 310
243 void construct (pointer p, const Tp &val) 311 void construct (pointer p, const Tp &val)
298 366
299typedef tausworthe_random_generator rand_gen; 367typedef tausworthe_random_generator rand_gen;
300 368
301extern rand_gen rndm; 369extern rand_gen rndm;
302 370
371INTERFACE_CLASS (attachable)
372struct refcnt_base
373{
374 typedef int refcnt_t;
375 mutable refcnt_t ACC (RW, refcnt);
376
377 MTH void refcnt_inc () const { ++refcnt; }
378 MTH void refcnt_dec () const { --refcnt; }
379
380 refcnt_base () : refcnt (0) { }
381};
382
383// to avoid branches with more advanced compilers
384extern refcnt_base::refcnt_t refcnt_dummy;
385
303template<class T> 386template<class T>
304struct refptr 387struct refptr
305{ 388{
389 // p if not null
390 refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
391
392 void refcnt_dec ()
393 {
394 if (!is_constant (p))
395 --*refcnt_ref ();
396 else if (p)
397 --p->refcnt;
398 }
399
400 void refcnt_inc ()
401 {
402 if (!is_constant (p))
403 ++*refcnt_ref ();
404 else if (p)
405 ++p->refcnt;
406 }
407
306 T *p; 408 T *p;
307 409
308 refptr () : p(0) { } 410 refptr () : p(0) { }
309 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 411 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
310 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 412 refptr (T *p) : p(p) { refcnt_inc (); }
311 ~refptr () { if (p) p->refcnt_dec (); } 413 ~refptr () { refcnt_dec (); }
312 414
313 const refptr<T> &operator =(T *o) 415 const refptr<T> &operator =(T *o)
314 { 416 {
417 // if decrementing ever destroys we need to reverse the order here
315 if (p) p->refcnt_dec (); 418 refcnt_dec ();
316 p = o; 419 p = o;
317 if (p) p->refcnt_inc (); 420 refcnt_inc ();
318
319 return *this; 421 return *this;
320 } 422 }
321 423
322 const refptr<T> &operator =(const refptr<T> o) 424 const refptr<T> &operator =(const refptr<T> &o)
323 { 425 {
324 *this = o.p; 426 *this = o.p;
325 return *this; 427 return *this;
326 } 428 }
327 429
328 T &operator * () const { return *p; } 430 T &operator * () const { return *p; }
329 T *operator ->() const { return p; } 431 T *operator ->() const { return p; }
330 432
331 operator T *() const { return p; } 433 operator T *() const { return p; }
332}; 434};
333 435
334typedef refptr<maptile> maptile_ptr; 436typedef refptr<maptile> maptile_ptr;
369 { 471 {
370 return !strcmp (a, b); 472 return !strcmp (a, b);
371 } 473 }
372}; 474};
373 475
476// Mostly the same as std::vector, but insert/erase can reorder
477// the elements, making append(=insert)/remove O(1) instead of O(n).
478//
479// NOTE: only some forms of erase are available
374template<class T> 480template<class T>
375struct unordered_vector : std::vector<T, slice_allocator<T> > 481struct unordered_vector : std::vector<T, slice_allocator<T> >
376{ 482{
377 typedef typename unordered_vector::iterator iterator; 483 typedef typename unordered_vector::iterator iterator;
378 484
388 { 494 {
389 erase ((unsigned int )(i - this->begin ())); 495 erase ((unsigned int )(i - this->begin ()));
390 } 496 }
391}; 497};
392 498
393template<class T, int T::* index> 499// This container blends advantages of linked lists
500// (efficiency) with vectors (random access) by
501// by using an unordered vector and storing the vector
502// index inside the object.
503//
504// + memory-efficient on most 64 bit archs
505// + O(1) insert/remove
506// + free unique (but varying) id for inserted objects
507// + cache-friendly iteration
508// - only works for pointers to structs
509//
510// NOTE: only some forms of erase/insert are available
511typedef int object_vector_index;
512
513template<class T, object_vector_index T::*indexmember>
394struct object_vector : std::vector<T *, slice_allocator<T *> > 514struct object_vector : std::vector<T *, slice_allocator<T *> >
395{ 515{
516 typedef typename object_vector::iterator iterator;
517
518 bool contains (const T *obj) const
519 {
520 return obj->*indexmember;
521 }
522
523 iterator find (const T *obj)
524 {
525 return obj->*indexmember
526 ? this->begin () + obj->*indexmember - 1
527 : this->end ();
528 }
529
530 void push_back (T *obj)
531 {
532 std::vector<T *, slice_allocator<T *> >::push_back (obj);
533 obj->*indexmember = this->size ();
534 }
535
396 void insert (T *obj) 536 void insert (T *obj)
397 { 537 {
398 assert (!(obj->*index));
399 push_back (obj); 538 push_back (obj);
400 obj->*index = this->size ();
401 } 539 }
402 540
403 void insert (T &obj) 541 void insert (T &obj)
404 { 542 {
405 insert (&obj); 543 insert (&obj);
406 } 544 }
407 545
408 void erase (T *obj) 546 void erase (T *obj)
409 { 547 {
410 assert (obj->*index);
411 unsigned int pos = obj->*index; 548 unsigned int pos = obj->*indexmember;
412 obj->*index = 0; 549 obj->*indexmember = 0;
413 550
414 if (pos < this->size ()) 551 if (pos < this->size ())
415 { 552 {
416 (*this)[pos - 1] = (*this)[this->size () - 1]; 553 (*this)[pos - 1] = (*this)[this->size () - 1];
417 (*this)[pos - 1]->*index = pos; 554 (*this)[pos - 1]->*indexmember = pos;
418 } 555 }
419 556
420 this->pop_back (); 557 this->pop_back ();
421 } 558 }
422 559
423 void erase (T &obj) 560 void erase (T &obj)
424 { 561 {
425 errase (&obj); 562 erase (&obj);
426 } 563 }
427}; 564};
428 565
429// basically does what strncpy should do, but appends "..." to strings exceeding length 566// basically does what strncpy should do, but appends "..." to strings exceeding length
430void assign (char *dst, const char *src, int maxlen); 567void assign (char *dst, const char *src, int maxlen);
436 assign ((char *)&dst, src, N); 573 assign ((char *)&dst, src, N);
437} 574}
438 575
439typedef double tstamp; 576typedef double tstamp;
440 577
441// return current time as timestampe 578// return current time as timestamp
442tstamp now (); 579tstamp now ();
443 580
444int similar_direction (int a, int b); 581int similar_direction (int a, int b);
445 582
446// like printf, but returns a std::string 583// like sprintf, but returns a "static" buffer
447const std::string format (const char *format, ...); 584const char *format (const char *format, ...);
448 585
586/////////////////////////////////////////////////////////////////////////////
587// threads, very very thin wrappers around pthreads
588
589struct thread
590{
591 pthread_t id;
592
593 void start (void *(*start_routine)(void *), void *arg = 0);
594
595 void cancel ()
596 {
597 pthread_cancel (id);
598 }
599
600 void *join ()
601 {
602 void *ret;
603
604 if (pthread_join (id, &ret))
605 cleanup ("pthread_join failed", 1);
606
607 return ret;
608 }
609};
610
611// note that mutexes are not classes
612typedef pthread_mutex_t smutex;
613
614#if __linux && defined (PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP)
615 #define SMUTEX_INITIALISER PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
616#else
617 #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER
449#endif 618#endif
450 619
620#define SMUTEX(name) smutex name = SMUTEX_INITIALISER
621#define SMUTEX_LOCK(name) pthread_mutex_lock (&(name))
622#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name))
623
624typedef pthread_cond_t scond;
625
626#define SCOND(name) scond name = PTHREAD_COND_INITIALIZER
627#define SCOND_SIGNAL(name) pthread_cond_signal (&(name))
628#define SCOND_BROADCAST(name) pthread_cond_broadcast (&(name))
629#define SCOND_WAIT(name,mutex) pthread_cond_wait (&(name), &(mutex))
630
631#endif
632

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines