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.34 by root, Fri Jan 19 15:15:50 2007 UTC vs.
Revision 1.66 by root, Wed Apr 2 11:13:55 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
26#define PREFER_MALLOC 0
27
4#if __GNUC__ >= 3 28#if __GNUC__ >= 3
5# define is_constant(c) __builtin_constant_p (c) 29# define is_constant(c) __builtin_constant_p (c)
30# define expect(expr,value) __builtin_expect ((expr),(value))
31# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
6#else 32#else
7# define is_constant(c) 0 33# define is_constant(c) 0
34# define expect(expr,value) (expr)
35# define prefetch(addr,rw,locality)
8#endif 36#endif
37
38#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
39# define decltype(x) typeof(x)
40#endif
41
42// put into ifs if you are very sure that the expression
43// is mostly true or mosty false. note that these return
44// booleans, not the expression.
45#define expect_false(expr) expect ((expr) != 0, 0)
46#define expect_true(expr) expect ((expr) != 0, 1)
47
48#include <pthread.h>
9 49
10#include <cstddef> 50#include <cstddef>
11#include <cmath> 51#include <cmath>
12#include <new> 52#include <new>
13#include <vector> 53#include <vector>
… …
15#include <glib.h> 55#include <glib.h>
16 56
17#include <shstr.h> 57#include <shstr.h>
18#include <traits.h> 58#include <traits.h>
19 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#endif
68
20// use a gcc extension for auto declarations until ISO C++ sanctifies them 69// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever)
21#define AUTODECL(var,expr) typeof(expr) var = (expr) 70#define auto(var,expr) decltype(expr) var = (expr)
22 71
23// very ugly macro that basicaly declares and initialises a variable 72// very ugly macro that basicaly declares and initialises a variable
24// that is in scope for the next statement only 73// that is in scope for the next statement only
25// works only for stuff that can be assigned 0 and converts to false 74// works only for stuff that can be assigned 0 and converts to false
26// (note: works great for pointers) 75// (note: works great for pointers)
27// most ugly macro I ever wrote 76// most ugly macro I ever wrote
28#define declvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) 77#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1)
29 78
30// in range including end 79// in range including end
31#define IN_RANGE_INC(val,beg,end) \ 80#define IN_RANGE_INC(val,beg,end) \
32 ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) 81 ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg))
33 82
34// in range excluding end 83// in range excluding end
35#define IN_RANGE_EXC(val,beg,end) \ 84#define IN_RANGE_EXC(val,beg,end) \
36 ((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))
37 86
87void cleanup (const char *cause, bool make_core = false);
38void fork_abort (const char *msg); 88void fork_abort (const char *msg);
39 89
90// rationale for using (U) not (T) is to reduce signed/unsigned issues,
91// as a is often a constant while b is the variable. it is still a bug, though.
40template<typename T, typename U> static inline T min (T a, U b) { return a < (T)b ? a : (T)b; } 92template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; }
41template<typename T, typename U> static inline T max (T a, U b) { return a > (T)b ? a : (T)b; } 93template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; }
42template<typename T, typename U, typename V> static inline T clamp (T v, U a, V b) { return v < (T)a ? a : v >(T)b ? b : v; } 94template<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; }
43 95
44template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } 96template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
97
98template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); }
99template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
100
101template<typename T>
102static inline T
103lerp (T val, T min_in, T max_in, T min_out, T max_out)
104{
105 return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out;
106}
107
108// lots of stuff taken from FXT
109
110/* Rotate right. This is used in various places for checksumming */
111//TODO: that sucks, use a better checksum algo
112static inline uint32_t
113rotate_right (uint32_t c, uint32_t count = 1)
114{
115 return (c << (32 - count)) | (c >> count);
116}
117
118static inline uint32_t
119rotate_left (uint32_t c, uint32_t count = 1)
120{
121 return (c >> (32 - count)) | (c << count);
122}
123
124// Return abs(a-b)
125// Both a and b must not have the most significant bit set
126static inline uint32_t
127upos_abs_diff (uint32_t a, uint32_t b)
128{
129 long d1 = b - a;
130 long d2 = (d1 & (d1 >> 31)) << 1;
131
132 return d1 - d2; // == (b - d) - (a + d);
133}
134
135// Both a and b must not have the most significant bit set
136static inline uint32_t
137upos_min (uint32_t a, uint32_t b)
138{
139 int32_t d = b - a;
140 d &= d >> 31;
141 return a + d;
142}
143
144// Both a and b must not have the most significant bit set
145static inline uint32_t
146upos_max (uint32_t a, uint32_t b)
147{
148 int32_t d = b - a;
149 d &= d >> 31;
150 return b - d;
151}
45 152
46// this is much faster than crossfires original algorithm 153// this is much faster than crossfires original algorithm
47// on modern cpus 154// on modern cpus
48inline int 155inline int
49isqrt (int n) 156isqrt (int n)
… …
81absdir (int d) 188absdir (int d)
82{ 189{
83 return ((d - 1) & 7) + 1; 190 return ((d - 1) & 7) + 1;
84} 191}
85 192
193extern size_t slice_alloc; // statistics
194
86// makes dynamically allocated objects zero-initialised 195// makes dynamically allocated objects zero-initialised
87struct zero_initialised 196struct zero_initialised
88{ 197{
89 void *operator new (size_t s, void *p) 198 void *operator new (size_t s, void *p)
90 { 199 {
… …
92 return p; 201 return p;
93 } 202 }
94 203
95 void *operator new (size_t s) 204 void *operator new (size_t s)
96 { 205 {
206 slice_alloc += s;
97 return g_slice_alloc0 (s); 207 return g_slice_alloc0 (s);
98 } 208 }
99 209
100 void *operator new[] (size_t s) 210 void *operator new[] (size_t s)
101 { 211 {
212 slice_alloc += s;
102 return g_slice_alloc0 (s); 213 return g_slice_alloc0 (s);
103 } 214 }
104 215
105 void operator delete (void *p, size_t s) 216 void operator delete (void *p, size_t s)
106 { 217 {
218 slice_alloc -= s;
107 g_slice_free1 (s, p); 219 g_slice_free1 (s, p);
108 } 220 }
109 221
110 void operator delete[] (void *p, size_t s) 222 void operator delete[] (void *p, size_t s)
111 { 223 {
224 slice_alloc -= s;
112 g_slice_free1 (s, p); 225 g_slice_free1 (s, p);
113 } 226 }
114}; 227};
115 228
116void *salloc_ (int n) throw (std::bad_alloc); 229void *salloc_ (int n) throw (std::bad_alloc);
… …
131 244
132// for symmetry 245// for symmetry
133template<typename T> 246template<typename T>
134inline void sfree (T *ptr, int n = 1) throw () 247inline void sfree (T *ptr, int n = 1) throw ()
135{ 248{
249#if PREFER_MALLOC
250 free (ptr);
251#else
252 slice_alloc -= n * sizeof (T);
136 g_slice_free1 (n * sizeof (T), (void *)ptr); 253 g_slice_free1 (n * sizeof (T), (void *)ptr);
254#endif
137} 255}
138 256
139// a STL-compatible allocator that uses g_slice 257// a STL-compatible allocator that uses g_slice
140// boy, this is verbose 258// boy, this is verbose
141template<typename Tp> 259template<typename Tp>
… …
154 { 272 {
155 typedef slice_allocator<U> other; 273 typedef slice_allocator<U> other;
156 }; 274 };
157 275
158 slice_allocator () throw () { } 276 slice_allocator () throw () { }
159 slice_allocator (const slice_allocator &o) throw () { } 277 slice_allocator (const slice_allocator &) throw () { }
160 template<typename Tp2> 278 template<typename Tp2>
161 slice_allocator (const slice_allocator<Tp2> &) throw () { } 279 slice_allocator (const slice_allocator<Tp2> &) throw () { }
162 280
163 ~slice_allocator () { } 281 ~slice_allocator () { }
164 282
… …
173 void deallocate (pointer p, size_type n) 291 void deallocate (pointer p, size_type n)
174 { 292 {
175 sfree<Tp> (p, n); 293 sfree<Tp> (p, n);
176 } 294 }
177 295
178 size_type max_size ()const throw () 296 size_type max_size () const throw ()
179 { 297 {
180 return size_t (-1) / sizeof (Tp); 298 return size_t (-1) / sizeof (Tp);
181 } 299 }
182 300
183 void construct (pointer p, const Tp &val) 301 void construct (pointer p, const Tp &val)
… …
209 327
210 void seed (uint32_t seed); 328 void seed (uint32_t seed);
211 uint32_t next (); 329 uint32_t next ();
212 330
213 // uniform distribution 331 // uniform distribution
214 uint32_t operator ()(uint32_t r_max) 332 uint32_t operator ()(uint32_t num)
215 { 333 {
216 return is_constant (r_max) 334 return is_constant (num)
217 ? this->next () % r_max 335 ? (next () * (uint64_t)num) >> 32U
218 : get_range (r_max); 336 : get_range (num);
219 } 337 }
220 338
221 // return a number within (min .. max) 339 // return a number within (min .. max)
222 int operator () (int r_min, int r_max) 340 int operator () (int r_min, int r_max)
223 { 341 {
224 return is_constant (r_min) && is_constant (r_max) 342 return is_constant (r_min) && is_constant (r_max) && r_min <= r_max
225 ? r_min + (*this) (max (r_max - r_min + 1, 1)) 343 ? r_min + operator ()(r_max - r_min + 1)
226 : get_range (r_min, r_max); 344 : get_range (r_min, r_max);
227 } 345 }
228 346
229 double operator ()() 347 double operator ()()
230 { 348 {
… …
238 356
239typedef tausworthe_random_generator rand_gen; 357typedef tausworthe_random_generator rand_gen;
240 358
241extern rand_gen rndm; 359extern rand_gen rndm;
242 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
243template<class T> 376template<class T>
244struct refptr 377struct refptr
245{ 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
246 T *p; 398 T *p;
247 399
248 refptr () : p(0) { } 400 refptr () : p(0) { }
249 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 401 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
250 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 402 refptr (T *p) : p(p) { refcnt_inc (); }
251 ~refptr () { if (p) p->refcnt_dec (); } 403 ~refptr () { refcnt_dec (); }
252 404
253 const refptr<T> &operator =(T *o) 405 const refptr<T> &operator =(T *o)
254 { 406 {
407 // if decrementing ever destroys we need to reverse the order here
255 if (p) p->refcnt_dec (); 408 refcnt_dec ();
256 p = o; 409 p = o;
257 if (p) p->refcnt_inc (); 410 refcnt_inc ();
258
259 return *this; 411 return *this;
260 } 412 }
261 413
262 const refptr<T> &operator =(const refptr<T> o) 414 const refptr<T> &operator =(const refptr<T> &o)
263 { 415 {
264 *this = o.p; 416 *this = o.p;
265 return *this; 417 return *this;
266 } 418 }
267 419
268 T &operator * () const { return *p; } 420 T &operator * () const { return *p; }
269 T *operator ->() const { return p; } 421 T *operator ->() const { return p; }
270 422
271 operator T *() const { return p; } 423 operator T *() const { return p; }
272}; 424};
273 425
274typedef refptr<maptile> maptile_ptr; 426typedef refptr<maptile> maptile_ptr;
… …
309 { 461 {
310 return !strcmp (a, b); 462 return !strcmp (a, b);
311 } 463 }
312}; 464};
313 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
314template<class T> 470template<class T>
315struct unordered_vector : std::vector<T, slice_allocator<T> > 471struct unordered_vector : std::vector<T, slice_allocator<T> >
316{ 472{
317 typedef typename unordered_vector::iterator iterator; 473 typedef typename unordered_vector::iterator iterator;
318 474
… …
328 { 484 {
329 erase ((unsigned int )(i - this->begin ())); 485 erase ((unsigned int )(i - this->begin ()));
330 } 486 }
331}; 487};
332 488
333template<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>
334struct object_vector : std::vector<T *, slice_allocator<T *> > 504struct object_vector : std::vector<T *, slice_allocator<T *> >
335{ 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
336 void insert (T *obj) 526 void insert (T *obj)
337 { 527 {
338 assert (!(obj->*index));
339 push_back (obj); 528 push_back (obj);
340 obj->*index = this->size ();
341 } 529 }
342 530
343 void insert (T &obj) 531 void insert (T &obj)
344 { 532 {
345 insert (&obj); 533 insert (&obj);
346 } 534 }
347 535
348 void erase (T *obj) 536 void erase (T *obj)
349 { 537 {
350 assert (obj->*index);
351 int pos = obj->*index; 538 unsigned int pos = obj->*indexmember;
352 obj->*index = 0; 539 obj->*indexmember = 0;
353 540
354 if (pos < this->size ()) 541 if (pos < this->size ())
355 { 542 {
356 (*this)[pos - 1] = (*this)[this->size () - 1]; 543 (*this)[pos - 1] = (*this)[this->size () - 1];
357 (*this)[pos - 1]->*index = pos; 544 (*this)[pos - 1]->*indexmember = pos;
358 } 545 }
359 546
360 this->pop_back (); 547 this->pop_back ();
361 } 548 }
362 549
363 void erase (T &obj) 550 void erase (T &obj)
364 { 551 {
365 errase (&obj); 552 erase (&obj);
366 } 553 }
367}; 554};
368 555
369// 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
370void assign (char *dst, const char *src, int maxlen); 557void assign (char *dst, const char *src, int maxlen);
… …
376 assign ((char *)&dst, src, N); 563 assign ((char *)&dst, src, N);
377} 564}
378 565
379typedef double tstamp; 566typedef double tstamp;
380 567
381// return current time as timestampe 568// return current time as timestamp
382tstamp now (); 569tstamp now ();
383 570
384int similar_direction (int a, int b); 571int similar_direction (int a, int b);
385 572
386#endif 573// like sprintf, but returns a "static" buffer
574const char *format (const char *format, ...);
387 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
608#endif
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
614#endif
615

Diff Legend

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