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.31 by root, Tue Nov 7 16:30:55 2006 UTC vs.
Revision 1.67 by root, Sun May 27 23:14:37 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,
81 KLASS_CLIENT,
38 KLASS_PLAYER, 82 KLASS_PLAYER,
39 KLASS_OBJECT, 83 KLASS_OBJECT,
40 KLASS_MAP, 84 KLASS_MAP,
85 KLASS_COMMAND,
41}; 86};
42 87
43enum event_type 88enum event_type
44{ 89{
45# define def(klass,name) EVENT_ ## klass ## _ ## name, 90# define def(klass,name) EVENT_ ## klass ## _ ## name,
46# include "eventinc.h" 91# include "eventinc.h"
47# undef def 92# undef def
48 NUM_EVENT_TYPES 93 NUM_EVENT_TYPES
49}; 94};
50 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
51#define ARG_AV(o) DT_AV , static_cast<AV *> (o) 100#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
52#define ARG_INT(v) DT_INT , static_cast<int> (v) 101#define ARG_INT(v) DT_INT , static_cast<int> (v)
53#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v) 102#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
54#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v) 103#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
55#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v) 104#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
56#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)
57#define ARG_OBJECT(o) DT_OBJECT, (void *)static_cast<object *> (o) 106#define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o))
58#define ARG_MAP(o) DT_MAP , (void *)static_cast<maptile *> (o) 107#define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o))
59#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<player *> (o) 108#define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (o))
60#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))
61#define ARG_PARTY(o) DT_PARTY , (void *)static_cast<party *> (o) 111#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o))
62#define ARG_REGION(o) DT_REGION, (void *)static_cast<region *> (o) 112#define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o))
63 113
64// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension 114// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
65 115#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
66// all these return true when the normal event processing should be skipped (if any)
67#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
68
69#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
70#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__)
71#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__)
119#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
72#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__)
73#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__)
74 122
75//TODO should index into @result 123//TODO should index into @result
76#define RESULT(idx,type) cfperl_result_ ## type (idx) 124#define RESULT(idx,type) cfperl_result_ ## type (idx)
125#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
77#define RESULT_INT(idx) RESULT(idx, INT) 126#define RESULT_INT(idx) RESULT(idx, INT)
78#define RESULT_MAP(idx) RESULT(idx, MAP)
79 127
80bool cfperl_invoke (event_type event, ...); 128double cfperl_result_DOUBLE (int idx);
81int cfperl_result_INT (int idx); 129int cfperl_result_INT (int idx);
82int cfperl_result_MAP (int idx);
83 130
131//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
132
133INTERFACE_CLASS (attachable)
84struct attachable_base 134struct attachable
85{ 135{
86 SV *self; 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
173 HV *self; // CF+ perl self
87 AV *cb; // CF+ perl self and callback 174 AV *cb; // CF+ callbacks
88 shstr attach; // generic extension attachment information 175 shstr attach; // generic extension attachment information
89 176
90 void clear (); // called when free'ing objects 177 void sever_self (); // sever this object from its self, if it has one.
91 void optimise (); // possibly save some memory by destroying unneeded data 178 void optimise (); // possibly save some memory by destroying unneeded data
92 void instantiate (data_type type, void *obj);
93 179
94 void attachable_clear ()
95 {
96 self = 0;
97 cb = 0;
98 attach = 0;
99 }
100
101 attachable_base () 180 attachable ()
181 : flags (0), refcnt (0), self (0), cb (0), attach (0)
102 { 182 {
103 attachable_clear ();
104 } 183 }
105 184
106 ~attachable_base ()
107 {
108 clear ();
109 }
110
111 attachable_base (const attachable_base &src) 185 attachable (const attachable &src)
112 : self (0), cb (0), attach (src.attach) 186 : flags (0), refcnt (0), self (0), cb (0), attach (src.attach)
113 { 187 {
114 } 188 }
115 189
190 virtual ~attachable ();
191
116 attachable_base &operator = (const attachable_base &src) 192 attachable &operator =(const attachable &src);
117 {
118 clear ();
119 attach = src.attach;
120 return *this;
121 }
122};
123 193
124// objects attachable from perl (or any other extension) should include or 194 // used to _quickly_ device wether to shortcut the evaluation
125// derive using the curiously recurring template pattern, to avoid 195 bool should_invoke (event_type event)
126// virtual method calls etc. 196 {
127template<class subclass> 197 return ev_want_event [event] || cb;
128struct attachable : attachable_base 198 }
129{ 199
200 bool invoke (event_type event, ...);
201
130 void instantiate () 202 MTH void instantiate ();
131 { 203 void reattach ();
132 if (attach)
133 attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
134 }
135};
136 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
137struct object_freezer : dynbuf 223struct object_freezer : dynbuf_text
138{ 224{
139 AV *av; 225 AV *av;
140 226
141 object_freezer (); 227 object_freezer ();
142 ~object_freezer (); 228 ~object_freezer ();
143 229
144 void put (attachable_base *ext); 230 void put (attachable *ext);
145
146 template<class subclass>
147 void put (attachable<subclass> *obj)
148 {
149 put ((attachable_base *)obj);
150 }
151 231
152 // used only for user-defined key-value pairs 232 // used only for user-defined key-value pairs
153 void put (const shstr &k, const shstr &v) 233 void put (const shstr &k, const shstr &v)
154 { 234 {
155 add (k); 235 add (k);
156 236
157 if (v) 237 if (expect_true (v))
158 add (' '), add (v); 238 add (' '), add (v);
159 239
160 add ('\n'); 240 add ('\n');
161 } 241 }
162 242
177 257
178 char *p = (char *)alloc (klen + vlen + 1); 258 char *p = (char *)alloc (klen + vlen + 1);
179 259
180 memcpy (p, keyword_str [k], klen); p += klen; 260 memcpy (p, keyword_str [k], klen); p += klen;
181 261
182 if (v) 262 if (expect_true (v))
183 { 263 {
184 *p++ = ' '; vlen--; 264 *p++ = ' '; vlen--;
185 memcpy (p, v, vlen); p += vlen; 265 memcpy (p, v, vlen); p += vlen;
186 } 266 }
187 267
188 *p = '\n'; 268 *p = '\n';
189 } 269 }
190 270
191 void put (keyword k, const char *v) 271 void put (keyword k, const char *v = 0)
192 { 272 {
193 put_string (k, v); 273 put_string (k, v);
194 } 274 }
195 275
196 void put (keyword k, const shstr &v) 276 void put (keyword k, const shstr &v)
225 305
226 void put (keyword kbeg, keyword kend, const shstr &v) 306 void put (keyword kbeg, keyword kend, const shstr &v)
227 { 307 {
228 add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n'); 308 add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
229 309
230 if (v) 310 if (expect_true (v))
231 { 311 {
232 add (v); 312 add (v);
233 add ('\n'); 313 add ('\n');
234 } 314 }
235 315
247 void put (keyword k, unsigned long v) { put_(k, (sint64)v); } 327 void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
248 void put (keyword k, signed long long v) { put_(k, (sint64)v); } 328 void put (keyword k, signed long long v) { put_(k, (sint64)v); }
249 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); }
250 330
251 template<typename T> 331 template<typename T>
252 void put (keyword k, T *v) 332 void put (keyword k, const T *v)
253 { 333 {
254 if (v) 334 if (expect_true (v))
255 put (k, v->name); 335 put (k, v->name);
256 else 336 else
257 put (k, (const char *)0); 337 put (k, (const char *)0);
258 } 338 }
259 339
340 template<typename T>
341 void put (keyword k, const refptr<T> &v)
342 {
343 put (k, (T *)v);
344 }
345
260 bool save (const char *filename); 346 bool save (const char *path);
261 char *as_string (); // like strdup 347 char *as_string (); // like strdup
262 348
263 operator bool () { return !!av; } 349 operator bool () { return !!av; }
264}; 350};
265 351
266// compatibility support, should be removed when no longer needed
267int fprintf (object_freezer &freezer, const char *format, ...);
268int fputs (const char *s, object_freezer &freezer);
269
270struct object_thawer 352struct object_thawer
271{ 353{
354 char *line; // current beginning of line
272 SV *text; // text part 355 SV *text; // text part
273 AV *av; // perl part 356 AV *av; // perl part
274 char *line; // current beginning of line 357 int linenum;
275 char *last_value; 358 keyword kw;
359 char *kw_str; // the keyword parsed, as string
360 char *value; // the value, or 0 if no value
361 char *value_nn; // the value, or the empty string if no value
362 const char *name;
276 363
277 operator bool () { return !!text; } 364 operator bool () { return !!text; }
278 365
279 object_thawer (const char *filename = 0); 366 object_thawer (const char *path = 0);
280 object_thawer (const char *data, AV *perlav); 367 object_thawer (const char *data, AV *perlav);
281 ~object_thawer (); 368 ~object_thawer ();
282 369
283 void get (data_type type, void *obj, attachable_base *ext, int oid);
284
285 template<class subclass>
286 void get (attachable<subclass> *obj, int oid) 370 void get (attachable *obj, int oid);
287 {
288 if (av)
289 get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
290 }
291 371
292 keyword get_kv (); // also parse value for later use 372 // parse next line
373 void next ();
374 // skip the current key-value (usually fetch next line, for
375 // multiline-fields, skips untilt he corresponding end-kw
376 void skip ();
293 377
378 //TODO: remove, deprecated
379 keyword get_kv ()
380 {
381 next ();
382 return kw;
383 }
384
294 const char *get_str () { return last_value; } // may be 0 385 char *get_str () { return value; } // may be 0
295
296 void get (shstr &sh) const;
297 void get_ornull (shstr &sh) const { sh = last_value; }
298 void get_ml (keyword kend, shstr &sh); 386 void get_ml (keyword kend, shstr &sh);
299 387
388 void get_ornull (shstr &sh) const { sh = value; }
389 void get (shstr &sh) const { sh = value; } // might want to check for non-null here
390
391 bool get_bool () const { return *value_nn == '1'; }
300 sint32 get_sint32 () const; 392 sint32 get_sint32 () const;
301 sint64 get_sint64 () const; 393 sint64 get_sint64 () const { return atoll (value_nn); }
302 double get_double () const; 394 double get_double () const { return atof (value_nn); }
303 395
304 void get (float &v) { v = get_double (); } 396 void get (float &v) { v = get_double (); }
305 void get (double &v) { v = get_double (); } 397 void get (double &v) { v = get_double (); }
306 398
399 void get (bool &i) { i = get_bool (); }
307 void get (sint8 &i) { i = get_sint32 (); } 400 void get (sint8 &i) { i = get_sint32 (); }
308 void get (uint8 &i) { i = get_sint32 (); } 401 void get (uint8 &i) { i = get_sint32 (); }
309 void get (sint16 &i) { i = get_sint32 (); } 402 void get (sint16 &i) { i = get_sint32 (); }
310 void get (uint16 &i) { i = get_sint32 (); } 403 void get (uint16 &i) { i = get_sint32 (); }
311 void get (sint32 &i) { i = get_sint32 (); } 404 void get (sint32 &i) { i = get_sint32 (); }
312 405
313 void get (uint32 &i) { i = get_sint64 (); } 406 void get (uint32 &i) { i = get_sint64 (); }
314 void get (sint64 &i) { i = get_sint64 (); } 407 void get (sint64 &i) { i = get_sint64 (); }
315};
316 408
409 bool parse_error (const char *type = 0, const char *name = 0, bool skip = true);
410};
411
412//TODO: remove
317char *fgets (char *s, int n, object_thawer &thawer); 413char *fgets (char *s, int n, object_thawer &thawer);
318 414
415//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
416
417struct coroapi {
418 static struct CoroAPI *GCoroAPI;
419
420 static int nready () { return CORO_NREADY; }
421 static int cede () { return CORO_CEDE ; }
422
423 static double (*time)();
424 static double next_cede;
425 static int cede_counter;
426
427 static void do_cede_every ();
428 static void do_cede_to_tick ();
429 static void do_cede_to_tick_every ();
430
431 static void cede_every (int count)
432 {
433 if (expect_false (++cede_counter >= count))
434 do_cede_every ();
435 }
436
437 static void cede_to_tick ()
438 {
439 if (expect_false (time () >= next_cede))
440 do_cede_to_tick ();
441 }
442
443 static void cede_to_tick_every (int count)
444 {
445 if (expect_false (++cede_counter >= count))
446 cede_to_tick ();
447 }
448
449 static void wait_for_tick ();
450 static void wait_for_tick_begin ();
451};
452
453struct watcher_base
454{
455 static struct EventAPI *GEventAPI;
456};
457
458template<class base>
459struct watcher : watcher_base
460{
461 base *pe;
462
463 void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); }
464 void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); }
465 void now () { GEventAPI->now ((pe_watcher *)pe); }
466 void suspend () { GEventAPI->suspend ((pe_watcher *)pe); }
467 void resume () { GEventAPI->resume ((pe_watcher *)pe); }
468
469 void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; }
470
471 ~watcher ()
472 {
473 cancel ();
474 }
475
476private:
477 void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private
478};
479
480struct iw : watcher<pe_idle>, callback<void (iw &)>
481{
482 template<class O, class M>
483 iw (O object, M method)
484 : callback<void (iw &)> (object, method)
485 {
486 alloc ();
487 }
488
489private:
490 void alloc ();
491};
492
493struct iow : watcher<pe_io>, callback<void (iow &, int)>
494{
495 template<class O, class M>
496 iow (O object, M method)
497 : callback<void (iow &, int)> (object, method)
498 {
499 alloc ();
500 }
501
502 void fd (int fd);
503 int poll ();
504 void poll (int events);
505
506private:
507 void alloc ();
508};
509
319#endif 510#endif
320 511

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines