ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/cfperl.h
(Generate patch)

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.35 by root, Thu Dec 14 05:09:32 2006 UTC vs.
Revision 1.66 by root, Sat May 26 15:44:03 2007 UTC

2// cfperl.h perl interface 2// cfperl.h perl interface
3// 3//
4#ifndef CFPERL_H__ 4#ifndef CFPERL_H__
5#define CFPERL_H__ 5#define CFPERL_H__
6 6
7#include <cstdarg>
7#include <cstdio> 8#include <cstdio>
9#include <bitset>
8 10
9using namespace std; 11using namespace std;
10 12
11#include <EXTERN.h> 13#include <EXTERN.h>
12#include <perl.h> 14#include <perl.h>
13#include <XSUB.h> 15#include <XSUB.h>
16
17#include <EventAPI.h>
18#include <CoroAPI.h>
19
20#include "util.h"
21#include "keyword.h"
22#include "dynbuf.h"
23#include "callback.h"
24
25//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
14 26
15// optimisations/workaround for functions requiring my_perl in scope (anti-bloat) 27// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
16#undef localtime 28#undef localtime
17#undef srand48 29#undef srand48
18#undef drand48 30#undef drand48
21#undef getprotobyname 33#undef getprotobyname
22#undef gethostbyname 34#undef gethostbyname
23#undef ctime 35#undef ctime
24#undef strerror 36#undef strerror
25 37
38// same here, massive symbol spamming
39#undef do_open
40#undef do_close
41#undef ref
42#undef seed
43
26// perl bug #40256: perl does overwrite those with reentrant versions 44// perl bug #40256: perl does overwrite those with reentrant versions
27// but does not initialise their state structures. 45// but does not initialise their state structures.
28#undef random 46#undef random
29#undef crypt 47#undef crypt
30 48
49//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
50
51// some macros to simplify perl in-calls
52
53#define CHECK_ERROR \
54 if (SvTRUE (ERRSV)) \
55 LOG (llevError, "runtime error in %s: %s\n", __func__, SvPVutf8_nolen (ERRSV));
56
57#define CALL_BEGIN(args) dSP; ENTER; SAVETMPS; PUSHMARK (SP); EXTEND (SP, args)
58#define CALL_ARG_SV(sv) PUSHs (sv_2mortal (sv)) // separate because no refcount inc
59#define CALL_ARG(expr) PUSHs (sv_2mortal (to_sv (expr)))
60#define CALL_CALL(name, flags) PUTBACK; int count = call_pv (name, (flags) | G_EVAL); SPAGAIN;
61#define CALL_END CHECK_ERROR; FREETMPS; LEAVE
62
63//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
64
31void cfperl_init (); 65void cfperl_init ();
32void cfperl_main (); 66void cfperl_main ();
67void cfperl_emergency_save ();
68void cfperl_cleanup (int make_core);
69void cfperl_make_book (object *book, int level);
70
71//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
72
73// virtual server time, excluding time jumps and lag
74extern double runtime;
33 75
34enum event_klass 76enum event_klass
35{ 77{
36 KLASS_NONE, 78 KLASS_NONE,
37 KLASS_GLOBAL, 79 KLASS_GLOBAL,
80 KLASS_ATTACHABLE,
38 KLASS_SOCKET, 81 KLASS_CLIENT,
39 KLASS_PLAYER, 82 KLASS_PLAYER,
40 KLASS_OBJECT, 83 KLASS_OBJECT,
41 KLASS_MAP, 84 KLASS_MAP,
42 KLASS_COMMAND, 85 KLASS_COMMAND,
43}; 86};
48# include "eventinc.h" 91# include "eventinc.h"
49# undef def 92# undef def
50 NUM_EVENT_TYPES 93 NUM_EVENT_TYPES
51}; 94};
52 95
96// in which global events or per-type events are we interested
97extern bitset<NUM_EVENT_TYPES> ev_want_event;
98extern bitset<NUM_TYPES> ev_want_type;
99
53#define ARG_AV(o) DT_AV , static_cast<AV *> (o) 100#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
54#define ARG_INT(v) DT_INT , static_cast<int> (v) 101#define ARG_INT(v) DT_INT , static_cast<int> (v)
55#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v) 102#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
56#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v) 103#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
57#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v) 104#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
58#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l) 105#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
59#define ARG_OBJECT(o) DT_OBJECT, (void *)static_cast<object *> (o) 106#define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o))
60#define ARG_MAP(o) DT_MAP , (void *)static_cast<maptile *> (o) 107#define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o))
61#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<player *> (o) 108#define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (o))
62#define ARG_ARCH(o) DT_ARCH , (void *)static_cast<archetype *> (o) 109#define ARG_ARCH(o) DT_ARCH , (void *)(static_cast<archetype *> (o))
110#define ARG_CLIENT(o) DT_CLIENT, (void *)(static_cast<client *> (o))
63#define ARG_PARTY(o) DT_PARTY , (void *)static_cast<party *> (o) 111#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o))
64#define ARG_REGION(o) DT_REGION, (void *)static_cast<region *> (o) 112#define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o))
65#define ARG_SOCKET(o) DT_SOCKET, (void *)static_cast<client_socket *> (o)
66 113
67// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension 114// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
68 115#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
69// all these return true when the normal event processing should be skipped (if any)
70#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
71
72#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
73#define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__) 116#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
117#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__)
74#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__) 118#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__)
75#define INVOKE_SOCKET(event, ns, ...) INVOKE_(EVENT_ ## SOCKET ## _ ## event, ARG_SOCKET (ns), ## __VA_ARGS__) 119#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
76#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__) 120#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__)
77#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__) 121#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
78 122
79//TODO should index into @result 123//TODO should index into @result
80#define RESULT(idx,type) cfperl_result_ ## type (idx) 124#define RESULT(idx,type) cfperl_result_ ## type (idx)
81#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE) 125#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
82#define RESULT_INT(idx) RESULT(idx, INT) 126#define RESULT_INT(idx) RESULT(idx, INT)
83 127
84bool cfperl_invoke (event_type event, ...);
85double cfperl_result_DOUBLE (int idx); 128double cfperl_result_DOUBLE (int idx);
86int cfperl_result_INT (int idx); 129int cfperl_result_INT (int idx);
87 130
131//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
132
133INTERFACE_CLASS (attachable)
88struct attachable_base 134struct attachable
89{ 135{
136 static MGVTBL vtbl;
137
138 static unordered_vector<attachable *> mortals;
139 MTH static void check_mortals ();
140
141 enum {
142 F_DESTROYED = 0x01,
143 F_DEBUG_TRACE = 0x02,
144 };
145
146 // object is delete'd after the refcount reaches 0
147 int ACC (RW, flags);
148 mutable int ACC (RW, refcnt);
149
150 MTH void refcnt_inc () const { ++refcnt; }
151 MTH void refcnt_dec () const { --refcnt; }
152
153 MTH int refcnt_cnt () const;
154 // check wether the object has died and destroy
155 MTH void refcnt_chk () { if (refcnt <= 0) do_check (); }
156
157 // destroy the object unless it was already destroyed
158 // this politely asks everybody interested the reduce
159 // the refcount to 0 as soon as possible.
160 MTH void destroy ();
161
162 // return wether an object was destroyed already
163 MTH bool destroyed () const { return flags & F_DESTROYED; }
164
165 virtual void gather_callbacks (AV *&callbacks, event_type event) const;
166
167#if 0
168private:
169 static refcounted *rc_first;
170 refcounted *rc_next;
171#endif
172
90 SV *self; // CF+ perl self 173 HV *self; // CF+ perl self
91 AV *cb; // CF+ callbacks 174 AV *cb; // CF+ callbacks
92 shstr attach; // generic extension attachment information 175 shstr attach; // generic extension attachment information
93 176
94 void clear (); // called when free'ing objects 177 void sever_self (); // sever this object from its self, if it has one.
95 void optimise (); // possibly save some memory by destroying unneeded data 178 void optimise (); // possibly save some memory by destroying unneeded data
96 void instantiate (data_type type, void *obj);
97 179
98 void attachable_clear ()
99 {
100 self = 0;
101 cb = 0;
102 attach = 0;
103 }
104
105 attachable_base () 180 attachable ()
181 : flags (0), refcnt (0), self (0), cb (0), attach (0)
106 { 182 {
107 attachable_clear ();
108 } 183 }
109 184
110 ~attachable_base ()
111 {
112 clear ();
113 }
114
115 attachable_base (const attachable_base &src) 185 attachable (const attachable &src)
116 : self (0), cb (0), attach (src.attach) 186 : flags (0), refcnt (0), self (0), cb (0), attach (src.attach)
117 { 187 {
118 } 188 }
119 189
190 virtual ~attachable ();
191
120 attachable_base &operator =(const attachable_base &src) 192 attachable &operator =(const attachable &src);
121 {
122 clear ();
123 attach = src.attach;
124 return *this;
125 }
126};
127 193
128// objects attachable from perl (or any other extension) should include or 194 // used to _quickly_ device wether to shortcut the evaluation
129// derive using the curiously recurring template pattern, to avoid 195 bool should_invoke (event_type event)
130// virtual method calls etc. 196 {
131template<class subclass> 197 return ev_want_event [event] || cb;
132struct attachable : attachable_base 198 }
133{ 199
200 bool invoke (event_type event, ...);
201
134 void instantiate () 202 MTH void instantiate ();
135 { 203 void reattach ();
136 if (attach)
137 attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
138 }
139};
140 204
205protected:
206 // do the real refcount checking work
207 void do_check ();
208
209 // the method that does the real destroy work
210 virtual void do_destroy ();
211};
212
213// the global object is a pseudo object that cares for the global events
214struct global : attachable
215{
216 void gather_callbacks (AV *&callbacks, event_type event) const;
217};
218
219extern struct global gbl_ev;
220
221//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
222
141struct object_freezer : dynbuf 223struct object_freezer : dynbuf_text
142{ 224{
143 AV *av; 225 AV *av;
144 226
145 object_freezer (); 227 object_freezer ();
146 ~object_freezer (); 228 ~object_freezer ();
147 229
148 void put (attachable_base *ext); 230 void put (attachable *ext);
149
150 template<class subclass>
151 void put (attachable<subclass> *obj)
152 {
153 put ((attachable_base *)obj);
154 }
155 231
156 // used only for user-defined key-value pairs 232 // used only for user-defined key-value pairs
157 void put (const shstr &k, const shstr &v) 233 void put (const shstr &k, const shstr &v)
158 { 234 {
159 add (k); 235 add (k);
160 236
161 if (v) 237 if (expect_true (v))
162 add (' '), add (v); 238 add (' '), add (v);
163 239
164 add ('\n'); 240 add ('\n');
165 } 241 }
166 242
181 257
182 char *p = (char *)alloc (klen + vlen + 1); 258 char *p = (char *)alloc (klen + vlen + 1);
183 259
184 memcpy (p, keyword_str [k], klen); p += klen; 260 memcpy (p, keyword_str [k], klen); p += klen;
185 261
186 if (v) 262 if (expect_true (v))
187 { 263 {
188 *p++ = ' '; vlen--; 264 *p++ = ' '; vlen--;
189 memcpy (p, v, vlen); p += vlen; 265 memcpy (p, v, vlen); p += vlen;
190 } 266 }
191 267
192 *p = '\n'; 268 *p = '\n';
193 } 269 }
194 270
195 void put (keyword k, const char *v) 271 void put (keyword k, const char *v = 0)
196 { 272 {
197 put_string (k, v); 273 put_string (k, v);
198 } 274 }
199 275
200 void put (keyword k, const shstr &v) 276 void put (keyword k, const shstr &v)
229 305
230 void put (keyword kbeg, keyword kend, const shstr &v) 306 void put (keyword kbeg, keyword kend, const shstr &v)
231 { 307 {
232 add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n'); 308 add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
233 309
234 if (v) 310 if (expect_true (v))
235 { 311 {
236 add (v); 312 add (v);
237 add ('\n'); 313 add ('\n');
238 } 314 }
239 315
253 void put (keyword k, unsigned long long v) { put_(k, (sint64)v); } 329 void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
254 330
255 template<typename T> 331 template<typename T>
256 void put (keyword k, const T *v) 332 void put (keyword k, const T *v)
257 { 333 {
258 if (v) 334 if (expect_true (v))
259 put (k, v->name); 335 put (k, v->name);
260 else 336 else
261 put (k, (const char *)0); 337 put (k, (const char *)0);
262 } 338 }
263 339
265 void put (keyword k, const refptr<T> &v) 341 void put (keyword k, const refptr<T> &v)
266 { 342 {
267 put (k, (T *)v); 343 put (k, (T *)v);
268 } 344 }
269 345
270 bool save (const char *filename); 346 bool save (const char *path);
271 char *as_string (); // like strdup 347 char *as_string (); // like strdup
272 348
273 operator bool () { return !!av; } 349 operator bool () { return !!av; }
274}; 350};
275 351
276// compatibility support, should be removed when no longer needed 352// compatibility support, should be removed when no longer needed
277int fprintf (object_freezer &freezer, const char *format, ...); 353void fprintf (object_freezer &freezer, const char *format, ...);
278int fputs (const char *s, object_freezer &freezer); 354void fputs (const char *s, object_freezer &freezer);
279 355
280struct object_thawer 356struct object_thawer
281{ 357{
358 char *line; // current beginning of line
282 SV *text; // text part 359 SV *text; // text part
283 AV *av; // perl part 360 AV *av; // perl part
284 char *line; // current beginning of line 361 int linenum;
285 char *last_value; 362 keyword kw;
363 char *kw_str; // the keyword parsed, as string
364 char *value; // the value, or 0 if no value
365 char *value_nn; // the value, or the empty string if no value
366 const char *name;
286 367
287 operator bool () { return !!text; } 368 operator bool () { return !!text; }
288 369
289 object_thawer (const char *filename = 0); 370 object_thawer (const char *path = 0);
290 object_thawer (const char *data, AV *perlav); 371 object_thawer (const char *data, AV *perlav);
291 ~object_thawer (); 372 ~object_thawer ();
292 373
293 void get (data_type type, void *obj, attachable_base *ext, int oid);
294
295 template<class subclass>
296 void get (attachable<subclass> *obj, int oid) 374 void get (attachable *obj, int oid);
297 {
298 if (av)
299 get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
300 }
301 375
302 keyword get_kv (); // also parse value for later use 376 // parse next line
377 void next ();
378 // skip the current key-value (usually fetch next line, for
379 // multiline-fields, skips untilt he corresponding end-kw
380 void skip ();
303 381
382 //TODO: remove, deprecated
383 keyword get_kv ()
384 {
385 next ();
386 return kw;
387 }
388
304 const char *get_str () { return last_value; } // may be 0 389 char *get_str () { return value; } // may be 0
305
306 void get (shstr &sh) const;
307 void get_ornull (shstr &sh) const { sh = last_value; }
308 void get_ml (keyword kend, shstr &sh); 390 void get_ml (keyword kend, shstr &sh);
309 391
392 void get_ornull (shstr &sh) const { sh = value; }
393 void get (shstr &sh) const { sh = value; } // might want to check for non-null here
394
395 bool get_bool () const { return *value_nn == '1'; }
310 sint32 get_sint32 () const; 396 sint32 get_sint32 () const;
311 sint64 get_sint64 () const; 397 sint64 get_sint64 () const { return atoll (value_nn); }
312 double get_double () const; 398 double get_double () const { return atof (value_nn); }
313 399
314 void get (float &v) { v = get_double (); } 400 void get (float &v) { v = get_double (); }
315 void get (double &v) { v = get_double (); } 401 void get (double &v) { v = get_double (); }
316 402
403 void get (bool &i) { i = get_bool (); }
317 void get (sint8 &i) { i = get_sint32 (); } 404 void get (sint8 &i) { i = get_sint32 (); }
318 void get (uint8 &i) { i = get_sint32 (); } 405 void get (uint8 &i) { i = get_sint32 (); }
319 void get (sint16 &i) { i = get_sint32 (); } 406 void get (sint16 &i) { i = get_sint32 (); }
320 void get (uint16 &i) { i = get_sint32 (); } 407 void get (uint16 &i) { i = get_sint32 (); }
321 void get (sint32 &i) { i = get_sint32 (); } 408 void get (sint32 &i) { i = get_sint32 (); }
322 409
323 void get (uint32 &i) { i = get_sint64 (); } 410 void get (uint32 &i) { i = get_sint64 (); }
324 void get (sint64 &i) { i = get_sint64 (); } 411 void get (sint64 &i) { i = get_sint64 (); }
325};
326 412
413 bool parse_error (const char *type = 0, const char *name = 0, bool skip = true);
414};
415
416//TODO: remove
327char *fgets (char *s, int n, object_thawer &thawer); 417char *fgets (char *s, int n, object_thawer &thawer);
328 418
419//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
420
421struct coroapi {
422 static struct CoroAPI *GCoroAPI;
423
424 static int nready () { return CORO_NREADY; }
425 static int cede () { return CORO_CEDE ; }
426
427 static double (*time)();
428 static double next_cede;
429 static int cede_counter;
430
431 static void do_cede_every ();
432 static void do_cede_to_tick ();
433 static void do_cede_to_tick_every ();
434
435 static void cede_every (int count)
436 {
437 if (expect_false (++cede_counter >= count))
438 do_cede_every ();
439 }
440
441 static void cede_to_tick ()
442 {
443 if (expect_false (time () >= next_cede))
444 do_cede_to_tick ();
445 }
446
447 static void cede_to_tick_every (int count)
448 {
449 if (expect_false (++cede_counter >= count))
450 cede_to_tick ();
451 }
452
453 static void wait_for_tick ();
454 static void wait_for_tick_begin ();
455};
456
457struct watcher_base
458{
459 static struct EventAPI *GEventAPI;
460};
461
462template<class base>
463struct watcher : watcher_base
464{
465 base *pe;
466
467 void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); }
468 void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); }
469 void now () { GEventAPI->now ((pe_watcher *)pe); }
470 void suspend () { GEventAPI->suspend ((pe_watcher *)pe); }
471 void resume () { GEventAPI->resume ((pe_watcher *)pe); }
472
473 void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; }
474
475 ~watcher ()
476 {
477 cancel ();
478 }
479
480private:
481 void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private
482};
483
484struct iw : watcher<pe_idle>, callback<void (iw &)>
485{
486 template<class O, class M>
487 iw (O object, M method)
488 : callback<void (iw &)> (object, method)
489 {
490 alloc ();
491 }
492
493private:
494 void alloc ();
495};
496
497struct iow : watcher<pe_io>, callback<void (iow &, int)>
498{
499 template<class O, class M>
500 iow (O object, M method)
501 : callback<void (iow &, int)> (object, method)
502 {
503 alloc ();
504 }
505
506 void fd (int fd);
507 int poll ();
508 void poll (int events);
509
510private:
511 void alloc ();
512};
513
329#endif 514#endif
330 515

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines