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

Diff Legend

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