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.46 by root, Mon May 28 21:15:56 2007 UTC vs.
Revision 1.70 by root, Sun Apr 20 05:24:55 2008 UTC

1/* 1/*
2 * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team 4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * 5 *
6 * Crossfire TRT is free software; you can redistribute it and/or modify it 6 * Deliantra is free software: you can redistribute it and/or modify
7 * under the terms of the GNU General Public License as published by the Free 7 * it under the terms of the GNU General Public License as published by
8 * Software Foundation; either version 2 of the License, or (at your option) 8 * the Free Software Foundation, either version 3 of the License, or
9 * any later version. 9 * (at your option) any later version.
10 * 10 *
11 * This program is distributed in the hope that it will be useful, but 11 * This program is distributed in the hope that it will be useful,
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * for more details. 14 * GNU General Public License for more details.
15 * 15 *
16 * You should have received a copy of the GNU General Public License along 16 * You should have received a copy of the GNU General Public License
17 * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51 17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 * 18 *
20 * The authors can be reached via e-mail to <crossfire@schmorp.de> 19 * The authors can be reached via e-mail to <support@deliantra.net>
21 */ 20 */
22 21
23#ifndef UTIL_H__ 22#ifndef UTIL_H__
24#define UTIL_H__ 23#define UTIL_H__
25 24
26//#define PREFER_MALLOC 25#define DEBUG_POISON 0xaa // 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
27 28
28#if __GNUC__ >= 3 29#if __GNUC__ >= 3
29# define is_constant(c) __builtin_constant_p (c) 30# define is_constant(c) __builtin_constant_p (c)
30# define expect(expr,value) __builtin_expect ((expr),(value)) 31# define expect(expr,value) __builtin_expect ((expr),(value))
31# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality) 32# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
… …
33# define is_constant(c) 0 34# define is_constant(c) 0
34# define expect(expr,value) (expr) 35# define expect(expr,value) (expr)
35# define prefetch(addr,rw,locality) 36# define prefetch(addr,rw,locality)
36#endif 37#endif
37 38
39#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
40# define decltype(x) typeof(x)
41#endif
42
38// put into ifs if you are very sure that the expression 43// put into ifs if you are very sure that the expression
39// is mostly true or mosty false. note that these return 44// is mostly true or mosty false. note that these return
40// booleans, not the expression. 45// booleans, not the expression.
41#define expect_false(expr) expect ((expr) != 0, 0) 46#define expect_false(expr) expect ((expr) != 0, 0)
42#define expect_true(expr) expect ((expr) != 0, 1) 47#define expect_true(expr) expect ((expr) != 0, 1)
43 48
49#include <pthread.h>
50
44#include <cstddef> 51#include <cstddef>
45#include <cmath> 52#include <cmath>
46#include <new> 53#include <new>
47#include <vector> 54#include <vector>
48 55
49#include <glib.h> 56#include <glib.h>
50 57
51#include <shstr.h> 58#include <shstr.h>
52#include <traits.h> 59#include <traits.h>
53 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
54// 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)
55#define auto(var,expr) typeof(expr) var = (expr) 75#define auto(var,expr) decltype(expr) var = (expr)
56 76
57// very ugly macro that basicaly declares and initialises a variable 77// very ugly macro that basicaly declares and initialises a variable
58// that is in scope for the next statement only 78// that is in scope for the next statement only
59// 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
60// (note: works great for pointers) 80// (note: works great for pointers)
61// most ugly macro I ever wrote 81// most ugly macro I ever wrote
62#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)
63 83
64// in range including end 84// in range including end
65#define IN_RANGE_INC(val,beg,end) \ 85#define IN_RANGE_INC(val,beg,end) \
66 ((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))
67 87
68// in range excluding end 88// in range excluding end
69#define IN_RANGE_EXC(val,beg,end) \ 89#define IN_RANGE_EXC(val,beg,end) \
70 ((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))
71 91
92void cleanup (const char *cause, bool make_core = false);
72void fork_abort (const char *msg); 93void fork_abort (const char *msg);
73 94
74// 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,
75// 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.
76template<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; }
77template<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; }
78template<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; }
79 100
80template<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)); }
81 105
82template<typename T> 106template<typename T>
83static inline T 107static inline T
84lerp (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)
85{ 109{
… …
169absdir (int d) 193absdir (int d)
170{ 194{
171 return ((d - 1) & 7) + 1; 195 return ((d - 1) & 7) + 1;
172} 196}
173 197
174// makes dynamically allocated objects zero-initialised 198extern ssize_t slice_alloc; // statistics
175struct zero_initialised
176{
177 void *operator new (size_t s, void *p)
178 {
179 memset (p, 0, s);
180 return p;
181 }
182
183 void *operator new (size_t s)
184 {
185 return g_slice_alloc0 (s);
186 }
187
188 void *operator new[] (size_t s)
189 {
190 return g_slice_alloc0 (s);
191 }
192
193 void operator delete (void *p, size_t s)
194 {
195 g_slice_free1 (s, p);
196 }
197
198 void operator delete[] (void *p, size_t s)
199 {
200 g_slice_free1 (s, p);
201 }
202};
203 199
204void *salloc_ (int n) throw (std::bad_alloc); 200void *salloc_ (int n) throw (std::bad_alloc);
205void *salloc_ (int n, void *src) throw (std::bad_alloc); 201void *salloc_ (int n, void *src) throw (std::bad_alloc);
206 202
207// strictly the same as g_slice_alloc, but never returns 0 203// strictly the same as g_slice_alloc, but never returns 0
… …
219 215
220// for symmetry 216// for symmetry
221template<typename T> 217template<typename T>
222inline void sfree (T *ptr, int n = 1) throw () 218inline void sfree (T *ptr, int n = 1) throw ()
223{ 219{
224#ifdef PREFER_MALLOC 220 if (expect_true (ptr))
225 free (ptr); 221 {
226#else 222 slice_alloc -= n * sizeof (T);
223 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
227 g_slice_free1 (n * sizeof (T), (void *)ptr); 224 g_slice_free1 (n * sizeof (T), (void *)ptr);
228#endif 225 assert (slice_alloc >= 0);//D
226 }
229} 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};
230 258
231// a STL-compatible allocator that uses g_slice 259// a STL-compatible allocator that uses g_slice
232// boy, this is verbose 260// boy, this is verbose
233template<typename Tp> 261template<typename Tp>
234struct slice_allocator 262struct slice_allocator
… …
246 { 274 {
247 typedef slice_allocator<U> other; 275 typedef slice_allocator<U> other;
248 }; 276 };
249 277
250 slice_allocator () throw () { } 278 slice_allocator () throw () { }
251 slice_allocator (const slice_allocator &o) throw () { } 279 slice_allocator (const slice_allocator &) throw () { }
252 template<typename Tp2> 280 template<typename Tp2>
253 slice_allocator (const slice_allocator<Tp2> &) throw () { } 281 slice_allocator (const slice_allocator<Tp2> &) throw () { }
254 282
255 ~slice_allocator () { } 283 ~slice_allocator () { }
256 284
… …
265 void deallocate (pointer p, size_type n) 293 void deallocate (pointer p, size_type n)
266 { 294 {
267 sfree<Tp> (p, n); 295 sfree<Tp> (p, n);
268 } 296 }
269 297
270 size_type max_size ()const throw () 298 size_type max_size () const throw ()
271 { 299 {
272 return size_t (-1) / sizeof (Tp); 300 return size_t (-1) / sizeof (Tp);
273 } 301 }
274 302
275 void construct (pointer p, const Tp &val) 303 void construct (pointer p, const Tp &val)
… …
330 358
331typedef tausworthe_random_generator rand_gen; 359typedef tausworthe_random_generator rand_gen;
332 360
333extern rand_gen rndm; 361extern rand_gen rndm;
334 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
335template<class T> 378template<class T>
336struct refptr 379struct refptr
337{ 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
338 T *p; 400 T *p;
339 401
340 refptr () : p(0) { } 402 refptr () : p(0) { }
341 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 403 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
342 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 404 refptr (T *p) : p(p) { refcnt_inc (); }
343 ~refptr () { if (p) p->refcnt_dec (); } 405 ~refptr () { refcnt_dec (); }
344 406
345 const refptr<T> &operator =(T *o) 407 const refptr<T> &operator =(T *o)
346 { 408 {
409 // if decrementing ever destroys we need to reverse the order here
347 if (p) p->refcnt_dec (); 410 refcnt_dec ();
348 p = o; 411 p = o;
349 if (p) p->refcnt_inc (); 412 refcnt_inc ();
350
351 return *this; 413 return *this;
352 } 414 }
353 415
354 const refptr<T> &operator =(const refptr<T> o) 416 const refptr<T> &operator =(const refptr<T> &o)
355 { 417 {
356 *this = o.p; 418 *this = o.p;
357 return *this; 419 return *this;
358 } 420 }
359 421
360 T &operator * () const { return *p; } 422 T &operator * () const { return *p; }
361 T *operator ->() const { return p; } 423 T *operator ->() const { return p; }
362 424
363 operator T *() const { return p; } 425 operator T *() const { return p; }
364}; 426};
365 427
366typedef refptr<maptile> maptile_ptr; 428typedef refptr<maptile> maptile_ptr;
… …
401 { 463 {
402 return !strcmp (a, b); 464 return !strcmp (a, b);
403 } 465 }
404}; 466};
405 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
406template<class T> 472template<class T>
407struct unordered_vector : std::vector<T, slice_allocator<T> > 473struct unordered_vector : std::vector<T, slice_allocator<T> >
408{ 474{
409 typedef typename unordered_vector::iterator iterator; 475 typedef typename unordered_vector::iterator iterator;
410 476
… …
420 { 486 {
421 erase ((unsigned int )(i - this->begin ())); 487 erase ((unsigned int )(i - this->begin ()));
422 } 488 }
423}; 489};
424 490
425template<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>
426struct object_vector : std::vector<T *, slice_allocator<T *> > 506struct object_vector : std::vector<T *, slice_allocator<T *> >
427{ 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
428 void insert (T *obj) 528 void insert (T *obj)
429 { 529 {
430 assert (!(obj->*index));
431 push_back (obj); 530 push_back (obj);
432 obj->*index = this->size ();
433 } 531 }
434 532
435 void insert (T &obj) 533 void insert (T &obj)
436 { 534 {
437 insert (&obj); 535 insert (&obj);
438 } 536 }
439 537
440 void erase (T *obj) 538 void erase (T *obj)
441 { 539 {
442 assert (obj->*index);
443 unsigned int pos = obj->*index; 540 unsigned int pos = obj->*indexmember;
444 obj->*index = 0; 541 obj->*indexmember = 0;
445 542
446 if (pos < this->size ()) 543 if (pos < this->size ())
447 { 544 {
448 (*this)[pos - 1] = (*this)[this->size () - 1]; 545 (*this)[pos - 1] = (*this)[this->size () - 1];
449 (*this)[pos - 1]->*index = pos; 546 (*this)[pos - 1]->*indexmember = pos;
450 } 547 }
451 548
452 this->pop_back (); 549 this->pop_back ();
453 } 550 }
454 551
455 void erase (T &obj) 552 void erase (T &obj)
456 { 553 {
457 errase (&obj); 554 erase (&obj);
458 } 555 }
459}; 556};
460 557
461// 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
462void assign (char *dst, const char *src, int maxlen); 559void assign (char *dst, const char *src, int maxlen);
… …
468 assign ((char *)&dst, src, N); 565 assign ((char *)&dst, src, N);
469} 566}
470 567
471typedef double tstamp; 568typedef double tstamp;
472 569
473// return current time as timestampe 570// return current time as timestamp
474tstamp now (); 571tstamp now ();
475 572
476int similar_direction (int a, int b); 573int similar_direction (int a, int b);
477 574
478// like printf, but returns a std::string 575// like sprintf, but returns a "static" buffer
479const std::string format (const char *format, ...); 576const char *format (const char *format, ...);
480 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
481#endif 610#endif
482 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