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.78 by root, Thu Dec 4 03:48:19 2008 UTC

1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 *
4 * Copyright (©) 2005,2006,2007,2008 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
101template<typename T> static inline void min_it (T &v, T m) { v = min (v, m); }
102template<typename T> static inline void max_it (T &v, T m) { v = max (v, m); }
103template<typename T> static inline void clamp_it (T &v, T a, T b) { v = clamp (v, a, b); }
104
48template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } 105template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
106
107template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); }
108template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
109
110// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
111template<typename T> static inline T div (T val, T div) { return (val + div / 2) / div; }
112// div, round-up
113template<typename T> static inline T div_ru (T val, T div) { return (val + div - 1) / div; }
114// div, round-down
115template<typename T> static inline T div_rd (T val, T div) { return (val ) / div; }
49 116
50template<typename T> 117template<typename T>
51static inline T 118static inline T
52lerp (T val, T min_in, T max_in, T min_out, T max_out) 119lerp (T val, T min_in, T max_in, T min_out, T max_out)
53{ 120{
54 return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; 121 return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in);
122}
123
124// lerp, round-down
125template<typename T>
126static inline T
127lerp_rd (T val, T min_in, T max_in, T min_out, T max_out)
128{
129 return min_out + div_rd<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
130}
131
132// lerp, round-up
133template<typename T>
134static inline T
135lerp_ru (T val, T min_in, T max_in, T min_out, T max_out)
136{
137 return min_out + div_ru<T> ((val - min_in) * (max_out - min_out), max_in - min_in);
55} 138}
56 139
57// lots of stuff taken from FXT 140// lots of stuff taken from FXT
58 141
59/* Rotate right. This is used in various places for checksumming */ 142/* Rotate right. This is used in various places for checksumming */
… …
137absdir (int d) 220absdir (int d)
138{ 221{
139 return ((d - 1) & 7) + 1; 222 return ((d - 1) & 7) + 1;
140} 223}
141 224
225extern ssize_t slice_alloc; // statistics
226
227void *salloc_ (int n) throw (std::bad_alloc);
228void *salloc_ (int n, void *src) throw (std::bad_alloc);
229
230// strictly the same as g_slice_alloc, but never returns 0
231template<typename T>
232inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); }
233
234// also copies src into the new area, like "memdup"
235// if src is 0, clears the memory
236template<typename T>
237inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
238
239// clears the memory
240template<typename T>
241inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); }
242
243// for symmetry
244template<typename T>
245inline void sfree (T *ptr, int n = 1) throw ()
246{
247 if (expect_true (ptr))
248 {
249 slice_alloc -= n * sizeof (T);
250 if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
251 g_slice_free1 (n * sizeof (T), (void *)ptr);
252 assert (slice_alloc >= 0);//D
253 }
254}
255
256// nulls the pointer
257template<typename T>
258inline void sfree0 (T *&ptr, int n = 1) throw ()
259{
260 sfree<T> (ptr, n);
261 ptr = 0;
262}
263
142// makes dynamically allocated objects zero-initialised 264// makes dynamically allocated objects zero-initialised
143struct zero_initialised 265struct zero_initialised
144{ 266{
145 void *operator new (size_t s, void *p) 267 void *operator new (size_t s, void *p)
146 { 268 {
… …
148 return p; 270 return p;
149 } 271 }
150 272
151 void *operator new (size_t s) 273 void *operator new (size_t s)
152 { 274 {
153 return g_slice_alloc0 (s); 275 return salloc0<char> (s);
154 } 276 }
155 277
156 void *operator new[] (size_t s) 278 void *operator new[] (size_t s)
157 { 279 {
158 return g_slice_alloc0 (s); 280 return salloc0<char> (s);
159 } 281 }
160 282
161 void operator delete (void *p, size_t s) 283 void operator delete (void *p, size_t s)
162 { 284 {
163 g_slice_free1 (s, p); 285 sfree ((char *)p, s);
164 } 286 }
165 287
166 void operator delete[] (void *p, size_t s) 288 void operator delete[] (void *p, size_t s)
167 { 289 {
168 g_slice_free1 (s, p); 290 sfree ((char *)p, s);
169 } 291 }
170}; 292};
171 293
172void *salloc_ (int n) throw (std::bad_alloc); 294// makes dynamically allocated objects zero-initialised
173void *salloc_ (int n, void *src) throw (std::bad_alloc); 295struct slice_allocated
174
175// strictly the same as g_slice_alloc, but never returns 0
176template<typename T>
177inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); }
178
179// also copies src into the new area, like "memdup"
180// if src is 0, clears the memory
181template<typename T>
182inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
183
184// clears the memory
185template<typename T>
186inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); }
187
188// for symmetry
189template<typename T>
190inline void sfree (T *ptr, int n = 1) throw ()
191{ 296{
192#ifdef PREFER_MALLOC 297 void *operator new (size_t s, void *p)
193 free (ptr); 298 {
194#else 299 return p;
195 g_slice_free1 (n * sizeof (T), (void *)ptr); 300 }
196#endif 301
197} 302 void *operator new (size_t s)
303 {
304 return salloc<char> (s);
305 }
306
307 void *operator new[] (size_t s)
308 {
309 return salloc<char> (s);
310 }
311
312 void operator delete (void *p, size_t s)
313 {
314 sfree ((char *)p, s);
315 }
316
317 void operator delete[] (void *p, size_t s)
318 {
319 sfree ((char *)p, s);
320 }
321};
198 322
199// a STL-compatible allocator that uses g_slice 323// a STL-compatible allocator that uses g_slice
200// boy, this is verbose 324// boy, this is verbose
201template<typename Tp> 325template<typename Tp>
202struct slice_allocator 326struct slice_allocator
… …
214 { 338 {
215 typedef slice_allocator<U> other; 339 typedef slice_allocator<U> other;
216 }; 340 };
217 341
218 slice_allocator () throw () { } 342 slice_allocator () throw () { }
219 slice_allocator (const slice_allocator &o) throw () { } 343 slice_allocator (const slice_allocator &) throw () { }
220 template<typename Tp2> 344 template<typename Tp2>
221 slice_allocator (const slice_allocator<Tp2> &) throw () { } 345 slice_allocator (const slice_allocator<Tp2> &) throw () { }
222 346
223 ~slice_allocator () { } 347 ~slice_allocator () { }
224 348
… …
233 void deallocate (pointer p, size_type n) 357 void deallocate (pointer p, size_type n)
234 { 358 {
235 sfree<Tp> (p, n); 359 sfree<Tp> (p, n);
236 } 360 }
237 361
238 size_type max_size ()const throw () 362 size_type max_size () const throw ()
239 { 363 {
240 return size_t (-1) / sizeof (Tp); 364 return size_t (-1) / sizeof (Tp);
241 } 365 }
242 366
243 void construct (pointer p, const Tp &val) 367 void construct (pointer p, const Tp &val)
… …
268 } 392 }
269 393
270 void seed (uint32_t seed); 394 void seed (uint32_t seed);
271 uint32_t next (); 395 uint32_t next ();
272 396
273 // uniform distribution 397 // uniform distribution, 0 .. max (0, num - 1)
274 uint32_t operator ()(uint32_t num) 398 uint32_t operator ()(uint32_t num)
275 { 399 {
276 return is_constant (num) 400 return is_constant (num)
277 ? (next () * (uint64_t)num) >> 32U 401 ? (next () * (uint64_t)num) >> 32U
278 : get_range (num); 402 : get_range (num);
… …
296 int get_range (int r_min, int r_max); 420 int get_range (int r_min, int r_max);
297}; 421};
298 422
299typedef tausworthe_random_generator rand_gen; 423typedef tausworthe_random_generator rand_gen;
300 424
301extern rand_gen rndm; 425extern rand_gen rndm, rmg_rndm;
426
427INTERFACE_CLASS (attachable)
428struct refcnt_base
429{
430 typedef int refcnt_t;
431 mutable refcnt_t ACC (RW, refcnt);
432
433 MTH void refcnt_inc () const { ++refcnt; }
434 MTH void refcnt_dec () const { --refcnt; }
435
436 refcnt_base () : refcnt (0) { }
437};
438
439// to avoid branches with more advanced compilers
440extern refcnt_base::refcnt_t refcnt_dummy;
302 441
303template<class T> 442template<class T>
304struct refptr 443struct refptr
305{ 444{
445 // p if not null
446 refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
447
448 void refcnt_dec ()
449 {
450 if (!is_constant (p))
451 --*refcnt_ref ();
452 else if (p)
453 --p->refcnt;
454 }
455
456 void refcnt_inc ()
457 {
458 if (!is_constant (p))
459 ++*refcnt_ref ();
460 else if (p)
461 ++p->refcnt;
462 }
463
306 T *p; 464 T *p;
307 465
308 refptr () : p(0) { } 466 refptr () : p(0) { }
309 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 467 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
310 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 468 refptr (T *p) : p(p) { refcnt_inc (); }
311 ~refptr () { if (p) p->refcnt_dec (); } 469 ~refptr () { refcnt_dec (); }
312 470
313 const refptr<T> &operator =(T *o) 471 const refptr<T> &operator =(T *o)
314 { 472 {
473 // if decrementing ever destroys we need to reverse the order here
315 if (p) p->refcnt_dec (); 474 refcnt_dec ();
316 p = o; 475 p = o;
317 if (p) p->refcnt_inc (); 476 refcnt_inc ();
318
319 return *this; 477 return *this;
320 } 478 }
321 479
322 const refptr<T> &operator =(const refptr<T> o) 480 const refptr<T> &operator =(const refptr<T> &o)
323 { 481 {
324 *this = o.p; 482 *this = o.p;
325 return *this; 483 return *this;
326 } 484 }
327 485
328 T &operator * () const { return *p; } 486 T &operator * () const { return *p; }
329 T *operator ->() const { return p; } 487 T *operator ->() const { return p; }
330 488
331 operator T *() const { return p; } 489 operator T *() const { return p; }
332}; 490};
333 491
334typedef refptr<maptile> maptile_ptr; 492typedef refptr<maptile> maptile_ptr;
… …
369 { 527 {
370 return !strcmp (a, b); 528 return !strcmp (a, b);
371 } 529 }
372}; 530};
373 531
532// Mostly the same as std::vector, but insert/erase can reorder
533// the elements, making append(=insert)/remove O(1) instead of O(n).
534//
535// NOTE: only some forms of erase are available
374template<class T> 536template<class T>
375struct unordered_vector : std::vector<T, slice_allocator<T> > 537struct unordered_vector : std::vector<T, slice_allocator<T> >
376{ 538{
377 typedef typename unordered_vector::iterator iterator; 539 typedef typename unordered_vector::iterator iterator;
378 540
… …
388 { 550 {
389 erase ((unsigned int )(i - this->begin ())); 551 erase ((unsigned int )(i - this->begin ()));
390 } 552 }
391}; 553};
392 554
393template<class T, int T::* index> 555// This container blends advantages of linked lists
556// (efficiency) with vectors (random access) by
557// by using an unordered vector and storing the vector
558// index inside the object.
559//
560// + memory-efficient on most 64 bit archs
561// + O(1) insert/remove
562// + free unique (but varying) id for inserted objects
563// + cache-friendly iteration
564// - only works for pointers to structs
565//
566// NOTE: only some forms of erase/insert are available
567typedef int object_vector_index;
568
569template<class T, object_vector_index T::*indexmember>
394struct object_vector : std::vector<T *, slice_allocator<T *> > 570struct object_vector : std::vector<T *, slice_allocator<T *> >
395{ 571{
572 typedef typename object_vector::iterator iterator;
573
574 bool contains (const T *obj) const
575 {
576 return obj->*indexmember;
577 }
578
579 iterator find (const T *obj)
580 {
581 return obj->*indexmember
582 ? this->begin () + obj->*indexmember - 1
583 : this->end ();
584 }
585
586 void push_back (T *obj)
587 {
588 std::vector<T *, slice_allocator<T *> >::push_back (obj);
589 obj->*indexmember = this->size ();
590 }
591
396 void insert (T *obj) 592 void insert (T *obj)
397 { 593 {
398 assert (!(obj->*index));
399 push_back (obj); 594 push_back (obj);
400 obj->*index = this->size ();
401 } 595 }
402 596
403 void insert (T &obj) 597 void insert (T &obj)
404 { 598 {
405 insert (&obj); 599 insert (&obj);
406 } 600 }
407 601
408 void erase (T *obj) 602 void erase (T *obj)
409 { 603 {
410 assert (obj->*index);
411 unsigned int pos = obj->*index; 604 unsigned int pos = obj->*indexmember;
412 obj->*index = 0; 605 obj->*indexmember = 0;
413 606
414 if (pos < this->size ()) 607 if (pos < this->size ())
415 { 608 {
416 (*this)[pos - 1] = (*this)[this->size () - 1]; 609 (*this)[pos - 1] = (*this)[this->size () - 1];
417 (*this)[pos - 1]->*index = pos; 610 (*this)[pos - 1]->*indexmember = pos;
418 } 611 }
419 612
420 this->pop_back (); 613 this->pop_back ();
421 } 614 }
422 615
423 void erase (T &obj) 616 void erase (T &obj)
424 { 617 {
425 errase (&obj); 618 erase (&obj);
426 } 619 }
427}; 620};
428 621
429// basically does what strncpy should do, but appends "..." to strings exceeding length 622// basically does what strncpy should do, but appends "..." to strings exceeding length
430void assign (char *dst, const char *src, int maxlen); 623void assign (char *dst, const char *src, int maxlen);
… …
436 assign ((char *)&dst, src, N); 629 assign ((char *)&dst, src, N);
437} 630}
438 631
439typedef double tstamp; 632typedef double tstamp;
440 633
441// return current time as timestampe 634// return current time as timestamp
442tstamp now (); 635tstamp now ();
443 636
444int similar_direction (int a, int b); 637int similar_direction (int a, int b);
445 638
446// like printf, but returns a std::string 639// like sprintf, but returns a "static" buffer
447const std::string format (const char *format, ...); 640const char *format (const char *format, ...);
448 641
642/////////////////////////////////////////////////////////////////////////////
643// threads, very very thin wrappers around pthreads
644
645struct thread
646{
647 pthread_t id;
648
649 void start (void *(*start_routine)(void *), void *arg = 0);
650
651 void cancel ()
652 {
653 pthread_cancel (id);
654 }
655
656 void *join ()
657 {
658 void *ret;
659
660 if (pthread_join (id, &ret))
661 cleanup ("pthread_join failed", 1);
662
663 return ret;
664 }
665};
666
667// note that mutexes are not classes
668typedef pthread_mutex_t smutex;
669
670#if __linux && defined (PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP)
671 #define SMUTEX_INITIALISER PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
672#else
673 #define SMUTEX_INITIALISER PTHREAD_MUTEX_INITIALIZER
449#endif 674#endif
450 675
676#define SMUTEX(name) smutex name = SMUTEX_INITIALISER
677#define SMUTEX_LOCK(name) pthread_mutex_lock (&(name))
678#define SMUTEX_UNLOCK(name) pthread_mutex_unlock (&(name))
679
680typedef pthread_cond_t scond;
681
682#define SCOND(name) scond name = PTHREAD_COND_INITIALIZER
683#define SCOND_SIGNAL(name) pthread_cond_signal (&(name))
684#define SCOND_BROADCAST(name) pthread_cond_broadcast (&(name))
685#define SCOND_WAIT(name,mutex) pthread_cond_wait (&(name), &(mutex))
686
687#endif
688

Diff Legend

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