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.49 by root, Mon Jun 4 13:04:00 2007 UTC vs.
Revision 1.72 by root, Wed Apr 30 16:26:28 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 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
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)
… …
43// is mostly true or mosty false. note that these return 44// is mostly true or mosty false. note that these return
44// booleans, not the expression. 45// booleans, not the expression.
45#define expect_false(expr) expect ((expr) != 0, 0) 46#define expect_false(expr) expect ((expr) != 0, 0)
46#define expect_true(expr) expect ((expr) != 0, 1) 47#define expect_true(expr) expect ((expr) != 0, 1)
47 48
49#include <pthread.h>
50
48#include <cstddef> 51#include <cstddef>
49#include <cmath> 52#include <cmath>
50#include <new> 53#include <new>
51#include <vector> 54#include <vector>
52 55
53#include <glib.h> 56#include <glib.h>
54 57
55#include <shstr.h> 58#include <shstr.h>
56#include <traits.h> 59#include <traits.h>
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
57 73
58// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever) 74// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever)
59#define auto(var,expr) decltype(expr) var = (expr) 75#define auto(var,expr) decltype(expr) var = (expr)
60 76
61// very ugly macro that basicaly declares and initialises a variable 77// very ugly macro that basicaly declares and initialises a variable
… …
71 87
72// in range excluding end 88// in range excluding end
73#define IN_RANGE_EXC(val,beg,end) \ 89#define IN_RANGE_EXC(val,beg,end) \
74 ((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))
75 91
92void cleanup (const char *cause, bool make_core = false);
76void fork_abort (const char *msg); 93void fork_abort (const char *msg);
77 94
78// 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,
79// 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.
80template<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; }
81template<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; }
82template<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; }
83 100
84template<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)); }
85 105
86template<typename T> 106template<typename T>
87static inline T 107static inline T
88lerp (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)
89{ 109{
… …
173absdir (int d) 193absdir (int d)
174{ 194{
175 return ((d - 1) & 7) + 1; 195 return ((d - 1) & 7) + 1;
176} 196}
177 197
178// makes dynamically allocated objects zero-initialised 198extern ssize_t slice_alloc; // statistics
179struct zero_initialised
180{
181 void *operator new (size_t s, void *p)
182 {
183 memset (p, 0, s);
184 return p;
185 }
186
187 void *operator new (size_t s)
188 {
189 return g_slice_alloc0 (s);
190 }
191
192 void *operator new[] (size_t s)
193 {
194 return g_slice_alloc0 (s);
195 }
196
197 void operator delete (void *p, size_t s)
198 {
199 g_slice_free1 (s, p);
200 }
201
202 void operator delete[] (void *p, size_t s)
203 {
204 g_slice_free1 (s, p);
205 }
206};
207 199
208void *salloc_ (int n) throw (std::bad_alloc); 200void *salloc_ (int n) throw (std::bad_alloc);
209void *salloc_ (int n, void *src) throw (std::bad_alloc); 201void *salloc_ (int n, void *src) throw (std::bad_alloc);
210 202
211// strictly the same as g_slice_alloc, but never returns 0 203// strictly the same as g_slice_alloc, but never returns 0
… …
223 215
224// for symmetry 216// for symmetry
225template<typename T> 217template<typename T>
226inline void sfree (T *ptr, int n = 1) throw () 218inline void sfree (T *ptr, int n = 1) throw ()
227{ 219{
228#ifdef PREFER_MALLOC 220 if (expect_true (ptr))
229 free (ptr); 221 {
230#else 222 slice_alloc -= n * sizeof (T);
223 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
231 g_slice_free1 (n * sizeof (T), (void *)ptr); 224 g_slice_free1 (n * sizeof (T), (void *)ptr);
232#endif 225 assert (slice_alloc >= 0);//D
226 }
233} 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};
234 266
235// a STL-compatible allocator that uses g_slice 267// a STL-compatible allocator that uses g_slice
236// boy, this is verbose 268// boy, this is verbose
237template<typename Tp> 269template<typename Tp>
238struct slice_allocator 270struct slice_allocator
… …
250 { 282 {
251 typedef slice_allocator<U> other; 283 typedef slice_allocator<U> other;
252 }; 284 };
253 285
254 slice_allocator () throw () { } 286 slice_allocator () throw () { }
255 slice_allocator (const slice_allocator &o) throw () { } 287 slice_allocator (const slice_allocator &) throw () { }
256 template<typename Tp2> 288 template<typename Tp2>
257 slice_allocator (const slice_allocator<Tp2> &) throw () { } 289 slice_allocator (const slice_allocator<Tp2> &) throw () { }
258 290
259 ~slice_allocator () { } 291 ~slice_allocator () { }
260 292
… …
269 void deallocate (pointer p, size_type n) 301 void deallocate (pointer p, size_type n)
270 { 302 {
271 sfree<Tp> (p, n); 303 sfree<Tp> (p, n);
272 } 304 }
273 305
274 size_type max_size ()const throw () 306 size_type max_size () const throw ()
275 { 307 {
276 return size_t (-1) / sizeof (Tp); 308 return size_t (-1) / sizeof (Tp);
277 } 309 }
278 310
279 void construct (pointer p, const Tp &val) 311 void construct (pointer p, const Tp &val)
… …
334 366
335typedef tausworthe_random_generator rand_gen; 367typedef tausworthe_random_generator rand_gen;
336 368
337extern rand_gen rndm; 369extern rand_gen rndm;
338 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
339template<class T> 386template<class T>
340struct refptr 387struct refptr
341{ 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
342 T *p; 408 T *p;
343 409
344 refptr () : p(0) { } 410 refptr () : p(0) { }
345 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 411 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
346 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 412 refptr (T *p) : p(p) { refcnt_inc (); }
347 ~refptr () { if (p) p->refcnt_dec (); } 413 ~refptr () { refcnt_dec (); }
348 414
349 const refptr<T> &operator =(T *o) 415 const refptr<T> &operator =(T *o)
350 { 416 {
417 // if decrementing ever destroys we need to reverse the order here
351 if (p) p->refcnt_dec (); 418 refcnt_dec ();
352 p = o; 419 p = o;
353 if (p) p->refcnt_inc (); 420 refcnt_inc ();
354
355 return *this; 421 return *this;
356 } 422 }
357 423
358 const refptr<T> &operator =(const refptr<T> o) 424 const refptr<T> &operator =(const refptr<T> &o)
359 { 425 {
360 *this = o.p; 426 *this = o.p;
361 return *this; 427 return *this;
362 } 428 }
363 429
364 T &operator * () const { return *p; } 430 T &operator * () const { return *p; }
365 T *operator ->() const { return p; } 431 T *operator ->() const { return p; }
366 432
367 operator T *() const { return p; } 433 operator T *() const { return p; }
368}; 434};
369 435
370typedef refptr<maptile> maptile_ptr; 436typedef refptr<maptile> maptile_ptr;
… …
406 return !strcmp (a, b); 472 return !strcmp (a, b);
407 } 473 }
408}; 474};
409 475
410// Mostly the same as std::vector, but insert/erase can reorder 476// Mostly the same as std::vector, but insert/erase can reorder
411// the elements, making insret/remove O(1) instead of O(n). 477// the elements, making append(=insert)/remove O(1) instead of O(n).
412// 478//
413// NOTE: only some forms of erase/insert are available 479// NOTE: only some forms of erase are available
414template<class T> 480template<class T>
415struct unordered_vector : std::vector<T, slice_allocator<T> > 481struct unordered_vector : std::vector<T, slice_allocator<T> >
416{ 482{
417 typedef typename unordered_vector::iterator iterator; 483 typedef typename unordered_vector::iterator iterator;
418 484
… …
440// + free unique (but varying) id for inserted objects 506// + free unique (but varying) id for inserted objects
441// + cache-friendly iteration 507// + cache-friendly iteration
442// - only works for pointers to structs 508// - only works for pointers to structs
443// 509//
444// NOTE: only some forms of erase/insert are available 510// NOTE: only some forms of erase/insert are available
445template<class T, int T::* index> 511typedef int object_vector_index;
512
513template<class T, object_vector_index T::*indexmember>
446struct object_vector : std::vector<T *, slice_allocator<T *> > 514struct object_vector : std::vector<T *, slice_allocator<T *> >
447{ 515{
448 typedef typename object_vector::iterator iterator; 516 typedef typename object_vector::iterator iterator;
449 517
450 bool contains (const T *obj) const 518 bool contains (const T *obj) const
451 { 519 {
452 return obj->*index; 520 return obj->*indexmember;
453 } 521 }
454 522
455 iterator find (const T *obj) 523 iterator find (const T *obj)
456 { 524 {
457 return obj->*index 525 return obj->*indexmember
458 ? this->begin () + obj->*index - 1 526 ? this->begin () + obj->*indexmember - 1
459 : this->end (); 527 : this->end ();
460 } 528 }
461 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
462 void insert (T *obj) 536 void insert (T *obj)
463 { 537 {
464 push_back (obj); 538 push_back (obj);
465 obj->*index = this->size ();
466 } 539 }
467 540
468 void insert (T &obj) 541 void insert (T &obj)
469 { 542 {
470 insert (&obj); 543 insert (&obj);
471 } 544 }
472 545
473 void erase (T *obj) 546 void erase (T *obj)
474 { 547 {
475 unsigned int pos = obj->*index; 548 unsigned int pos = obj->*indexmember;
476 obj->*index = 0; 549 obj->*indexmember = 0;
477 550
478 if (pos < this->size ()) 551 if (pos < this->size ())
479 { 552 {
480 (*this)[pos - 1] = (*this)[this->size () - 1]; 553 (*this)[pos - 1] = (*this)[this->size () - 1];
481 (*this)[pos - 1]->*index = pos; 554 (*this)[pos - 1]->*indexmember = pos;
482 } 555 }
483 556
484 this->pop_back (); 557 this->pop_back ();
485 } 558 }
486 559
487 void erase (T &obj) 560 void erase (T &obj)
488 { 561 {
489 errase (&obj); 562 erase (&obj);
490 } 563 }
491}; 564};
492 565
493// 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
494void assign (char *dst, const char *src, int maxlen); 567void assign (char *dst, const char *src, int maxlen);
… …
500 assign ((char *)&dst, src, N); 573 assign ((char *)&dst, src, N);
501} 574}
502 575
503typedef double tstamp; 576typedef double tstamp;
504 577
505// return current time as timestampe 578// return current time as timestamp
506tstamp now (); 579tstamp now ();
507 580
508int similar_direction (int a, int b); 581int similar_direction (int a, int b);
509 582
510// like printf, but returns a std::string 583// like sprintf, but returns a "static" buffer
511const std::string format (const char *format, ...); 584const char *format (const char *format, ...);
512 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
513#endif 618#endif
514 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