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.29 by root, Thu Sep 21 00:05:25 2006 UTC vs.
Revision 1.122 by root, Thu Apr 15 04:02:38 2010 UTC

1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 *
4 * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 *
6 * Deliantra is free software: you can redistribute it and/or modify it under
7 * the terms of the Affero GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * 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 Affero GNU General Public License
17 * and the GNU General Public License along with this program. If not, see
18 * <http://www.gnu.org/licenses/>.
19 *
20 * The authors can be reached via e-mail to <support@deliantra.net>
21 */
22
1// 23//
2// cfperl.h perl interface 24// cfperl.h perl interface
3// 25//
4#ifndef CFPERL_H__ 26#ifndef CFPERL_H__
5#define CFPERL_H__ 27#define CFPERL_H__
6 28
7#include <cstdio>
8
9using namespace std; 29using namespace std;
10 30
11#include <EXTERN.h> 31#include <EXTERN.h>
12#include <perl.h> 32#include <perl.h>
13#include <XSUB.h> 33#include <XSUB.h>
34
35#include <EVAPI.h>
36#include <CoroAPI.h>
37
38#include "util.h"
39#include "keyword.h"
40#include "dynbuf.h"
41#include "callback.h"
42
43//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
14 44
15// optimisations/workaround for functions requiring my_perl in scope (anti-bloat) 45// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
16#undef localtime 46#undef localtime
17#undef srand48 47#undef srand48
18#undef drand48 48#undef drand48
19#undef srandom 49#undef srandom
50#undef opendir
20#undef readdir 51#undef readdir
52#undef closedir
21#undef getprotobyname 53#undef getprotobyname
22#undef gethostbyname 54#undef gethostbyname
23#undef ctime 55#undef ctime
24#undef strerror 56#undef strerror
57#undef _
58
59// same here, massive symbol spamming
60#undef do_open
61#undef do_close
62#undef ref
63#undef seed
25 64
26// perl bug #40256: perl does overwrite those with reentrant versions 65// perl bug #40256: perl does overwrite those with reentrant versions
27// but does not initialise their state structures. 66// but does not initialise their state structures.
28#undef random 67#undef random
29#undef crypt 68#undef crypt
30 69
70//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
71
72#define _(msg) (msg)
73#define N_(msg) (msg)
74
75//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
76
77// some macros to simplify perl in-calls
78
79#define CHECK_ERROR \
80 if (SvTRUE (ERRSV)) \
81 LOG (llevError, "runtime error in %s: %s", __func__, SvPVutf8_nolen (ERRSV));
82
83inline int call_pvsv (const char *ob, I32 flags) { return call_pv (ob, flags); }
84inline int call_pvsv (SV *ob, I32 flags) { return call_sv (ob, flags); }
85
86// TODO: temporarily enabled pushstack/popstack for all calls from the core, to maybe fix object memleak?
87#define CALL_PUSH PUSHSTACKi (PERLSI_UNKNOWN)
88#define CALL_POP PUTBACK; POPSTACK; SPAGAIN
89#define CALL_BEGIN(args) dSP; CALL_PUSH; ENTER; SAVETMPS; PUSHMARK (SP); EXTEND (SP, args)
90#define CALL_ARG_SV(sv) PUSHs (sv_2mortal (sv)) // separate because no refcount inc
91#define CALL_ARG(expr) PUSHs (sv_2mortal (to_sv (expr)))
92#define CALL_CALL(name, flags) PUTBACK; int count = call_pvsv (name, (flags) | G_EVAL); SPAGAIN;
93#define CALL_END PUTBACK; CHECK_ERROR; FREETMPS; LEAVE; CALL_POP
94
95//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
96
31void cfperl_init (); 97void cfperl_init ();
32void cfperl_main (); 98void cfperl_main ();
99void cfperl_tick ();
100void cfperl_emergency_save ();
101void cfperl_cleanup (int make_core);
102void cfperl_make_book (object *book, int level);
103void cfperl_send_msg (client *ns, int color, const_utf8_string type, const_utf8_string msg);
104int cfperl_can_merge (object *ob1, object *ob2);
105void cfperl_mapscript_activate (object *ob, int state, object *activator, object *originator = 0);
106
107bool is_match_expr (const_utf8_string expr);
108// applies the match expression and returns true if it matches
109bool match (const_utf8_string expr, object *ob, object *self = 0, object *source = 0, object *originator = 0);
110// same as above, but returns the first object found, or 0
111object *match_one (const_utf8_string expr, object *ob, object *self = 0, object *source = 0, object *originator = 0);
112
113//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
114
115#if IVSIZE >= 8
116 typedef IV val64;
117 typedef IV uval64;
118# define newSVval64 newSViv
119# define SvVAL64 SvIV
120# define newSVuval64 newSVuv
121# define SvUVAL64 SvUV
122#else
123 typedef double val64;
124 typedef double uval64;
125# define newSVval64 newSVnv
126# define SvVAL64 SvNV
127# define newSVuval64 newSVnv
128# define SvUVAL64 SvNV
129#endif
130
131extern tstamp runtime; // virtual server time, excluding time jumps and lag
132extern tstamp NOW; // real time of current server tick
33 133
34enum event_klass 134enum event_klass
35{ 135{
36 KLASS_NONE, 136 KLASS_NONE,
37 KLASS_GLOBAL, 137 KLASS_GLOBAL,
138 KLASS_ATTACHABLE,
139 KLASS_CLIENT,
38 KLASS_PLAYER, 140 KLASS_PLAYER,
39 KLASS_OBJECT, 141 KLASS_OBJECT,
40 KLASS_MAP, 142 KLASS_MAP,
143 KLASS_COMMAND,
41}; 144};
42 145
43enum event_type 146enum event_type
44{ 147{
45# define def(klass,name) EVENT_ ## klass ## _ ## name, 148# define def(klass,name) EVENT_ ## klass ## _ ## name,
46# include "eventinc.h" 149# include "eventinc.h"
47# undef def 150# undef def
48 NUM_EVENT_TYPES 151 NUM_EVENT_TYPES
49}; 152};
50 153
154// in which global events or per-type events are we interested
155extern bitset<NUM_EVENT_TYPES> ev_want_event;
156extern bitset<NUM_TYPES> ev_want_type;
157
51#define ARG_AV(o) DT_AV , static_cast<AV *> (o) 158#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
52#define ARG_INT(v) DT_INT , static_cast<int> (v) 159#define ARG_INT(v) DT_INT , static_cast<int> (v)
53#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v) 160#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
54#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v) 161#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
55#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v) 162#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) 163#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) 164#define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o))
58#define ARG_MAP(o) DT_MAP , (void *)static_cast<maptile *> (o) 165#define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o))
59#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<player *> (o) 166#define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (o))
60#define ARG_ARCH(o) DT_ARCH , (void *)static_cast<archetype *> (o) 167#define ARG_ARCH(o) DT_ARCH , (void *)(static_cast<archetype *> (o))
168#define ARG_CLIENT(o) DT_CLIENT, (void *)(static_cast<client *> (o))
61#define ARG_PARTY(o) DT_PARTY , (void *)static_cast<party *> (o) 169#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o))
62#define ARG_REGION(o) DT_REGION, (void *)static_cast<region *> (o) 170#define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o))
63 171
64// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension 172// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
65 173#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__) 174#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
175#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__) 176#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__)
177#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__) 178#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__) 179#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
74 180
75//TODO should index into @result 181//TODO should index into @result
76#define RESULT(idx,type) cfperl_result_ ## type (idx) 182#define RESULT(idx,type) cfperl_result_ ## type (idx)
183#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
77#define RESULT_INT(idx) RESULT(idx, INT) 184#define RESULT_INT(idx) RESULT(idx, INT)
78#define RESULT_MAP(idx) RESULT(idx, MAP)
79 185
80bool cfperl_invoke (event_type event, ...); 186double cfperl_result_DOUBLE (int idx);
81int cfperl_result_INT (int idx); 187int cfperl_result_INT (int idx);
82int cfperl_result_MAP (int idx);
83 188
189//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
190
191INTERFACE_CLASS (attachable)
84struct attachable_base 192struct attachable : refcnt_base
85{ 193{
86 SV *self; 194 static MGVTBL vtbl;
195
196 enum {
197 F_DESTROYED = 0x01,
198 F_DEBUG_TRACE = 0x02,
199 };
200 uint8 ACC (RW, attachable_flags);
201
202 static unordered_vector<attachable *> mortals;
203 MTH static void check_mortals ();
204
205 // object is delete'd after the refcount reaches 0
206 MTH int refcnt_cnt () const;
207 // check wether the object has died and destroy
208 MTH void refcnt_chk () { if (expect_false (refcnt <= 0)) do_check (); }
209
210 // destroy the object unless it was already destroyed
211 // this politely asks everybody interested the reduce
212 // the refcount to 0 as soon as possible.
213 MTH void destroy ();
214
215 // return wether an object was destroyed already
216 MTH bool destroyed () const { return attachable_flags & F_DESTROYED; }
217
218 // destruct and free the memory for this object
219 virtual void do_delete ();
220
221 virtual void gather_callbacks (AV *&callbacks, event_type event) const;
222
223#if 0
224private:
225 static refcounted *rc_first;
226 refcounted *rc_next;
227#endif
228
229 HV *self; // CF+ perl self
87 AV *cb; // CF+ perl self and callback 230 AV *cb; // CF+ callbacks
88 shstr attach; // generic extension attachment information 231 shstr attach; // generic extension attachment information
89 232
90 void clear (); // called when free'ing objects 233 void sever_self (); // sever this object from its self, if it has one.
91 void optimise (); // possibly save some memory by destroying unneeded data 234 void optimise (); // possibly save some memory by destroying unneeded data
92 void instantiate (data_type type, void *obj);
93 235
94 void attachable_clear ()
95 {
96 self = 0;
97 cb = 0;
98 attach = 0;
99 }
100
101 attachable_base () 236 attachable ()
237 : attachable_flags (0), self (0), cb (0), attach (0)
102 { 238 {
103 attachable_clear ();
104 } 239 }
105 240
106 ~attachable_base ()
107 {
108 clear ();
109 }
110
111 attachable_base (const attachable_base &src) 241 attachable (const attachable &src)
112 : self (0), cb (0), attach (src.attach) 242 : attachable_flags (0), self (0), cb (0), attach (src.attach)
113 { 243 {
114 } 244 }
115 245
246 // set a custom key to the given value, or delete it if value = 0
247 void set_key (const_utf8_string key, const_utf8_string value = 0, bool is_utf8 = 0);
248
249 void set_key_text (const_utf8_string key, const_utf8_string value = 0)
250 {
251 set_key (key, value, 1);
252 }
253
254 void set_key_data (const_utf8_string key, const_utf8_string value = 0)
255 {
256 set_key (key, value, 0);
257 }
258
116 attachable_base &operator = (const attachable_base &src) 259 attachable &operator =(const attachable &src);
117 {
118 clear ();
119 attach = src.attach;
120 return *this;
121 }
122};
123 260
124// objects attachable from perl (or any other extension) should include or 261 // used to _quickly_ decide wether to shortcut the evaluation
125// derive using the curiously recurring template pattern, to avoid 262 bool should_invoke (event_type event)
126// virtual method calls etc. 263 {
127template<class subclass> 264 return ev_want_event [event] || cb;
128struct attachable : attachable_base 265 }
129{ 266
267 bool invoke (event_type event, ...);
268
130 void instantiate () 269 MTH void instantiate ();
131 { 270 void reattach ();
132 if (attach)
133 attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
134 }
135};
136 271
137struct object_freezer : dynbuf 272protected:
138{ 273 // do the real refcount checking work
139 AV *av; 274 void do_check ();
140 275
141 object_freezer (); 276 // the method that does the real destroy work
142 ~object_freezer (); 277 virtual void do_destroy ();
143 278
144 void put (attachable_base *ext); 279 // destructor is protected, should not be called by anybody
280 virtual ~attachable ();
281};
145 282
283// the global object is a pseudo object that cares for the global events
284struct global : attachable
285{
286 void gather_callbacks (AV *&callbacks, event_type event) const;
287};
288
289extern struct global gbl_ev;
290
291//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
292
293#include "freezethaw.h"
294
295//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
296
297struct coroapi {
298 static struct CoroAPI *GCoroAPI;
299
300 static EV_ATOMIC_T cede_pending;
301
302 static int nready () { return CORO_NREADY; }
303 static int cede () { cede_pending = 0; return CORO_CEDE ; }
304
305 static void do_cede_to_tick ();
306
307 // actually cede's far more often
308 static bool cede_to_tick ()
309 {
310 if (expect_true (!cede_pending))
311 return false;
312
313 do_cede_to_tick ();
314 return true;
315 }
316
317 static void wait_for_tick ();
318 static void wait_for_tick_begin ();
319};
320
321struct evapi
322{
323 static struct EVAPI *GEVAPI;
324};
325
326struct iow : ev_io, evapi, callback<void (iow &, int)>
327{
328 static void thunk (EV_P_ struct ev_io *w_, int revents)
329 {
330 iow &w = *static_cast<iow *>(w_);
331
332 w (w, revents);
333 }
334
146 template<class subclass> 335 template<class O, class M>
147 void put (attachable<subclass> *obj) 336 iow (O object, M method)
337 : callback<void (iow &, int)> (object, method)
148 { 338 {
149 put ((attachable_base *)obj); 339 ev_init ((ev_io *)this, thunk);
150 } 340 }
151 341
152 // used only for user-defined key-value pairs 342 void prio (int prio)
153 void put (const shstr &k, const shstr &v)
154 { 343 {
155 add (k); 344 ev_set_priority ((ev_io *)this, prio);
156
157 if (v)
158 add (' '), add (v);
159
160 add ('\n');
161 } 345 }
162 346
163 //TODO//temporary, used only for saving body locations 347 void set (int fd, int events)
164 void put (const char *k, int v)
165 { 348 {
166 add (k); 349 ev_io_set ((ev_io *)this, fd, events);
167 add (' ');
168 add (sint32 (v));
169 add ('\n');
170 } 350 }
171 351
172 template<typename T> 352 int poll () const { return events; }
173 void put_string (keyword k, const T &v)
174 {
175 int klen = keyword_len [k];
176 int vlen = v ? strlen (v) + 1 : 0;
177 353
178 char *p = (char *)alloc (klen + vlen + 1); 354 void poll (int events);
179 355
180 memcpy (p, keyword_str [k], klen); p += klen; 356 void start ()
181
182 if (v)
183 {
184 *p++ = ' '; vlen--;
185 memcpy (p, v, vlen); p += vlen;
186 }
187
188 *p = '\n';
189 }
190
191 void put (keyword k, const char *v)
192 { 357 {
193 put_string (k, v); 358 ev_io_start (EV_DEFAULT, (ev_io *)this);
194 } 359 }
195 360
196 void put (keyword k, const shstr &v) 361 void stop ()
197 { 362 {
198 put_string (k, v); 363 ev_io_stop (EV_DEFAULT, (ev_io *)this);
199 } 364 }
200 365
201 void put (keyword k, double v) 366 ~iow ()
202 { 367 {
203 char buf [128]; 368 stop ();
204
205 snprintf (buf, 128, "%.7g", v);
206
207 put (k, (const char *)buf);
208 } 369 }
209
210 void put_(keyword k, sint64 v)
211 {
212 add (keyword_str [k], keyword_len [k]);
213 add (' ');
214 add (v);
215 add ('\n');
216 }
217
218 void put_(keyword k, sint32 v)
219 {
220 add (keyword_str [k], keyword_len [k]);
221 add (' ');
222 add (v);
223 add ('\n');
224 }
225
226 void put (keyword kbeg, keyword kend, const shstr &v)
227 {
228 add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
229
230 if (v)
231 {
232 add (v);
233 add ('\n');
234 }
235
236 add (keyword_str [kend], keyword_len [kend]); add ('\n');
237 }
238
239 void put (keyword k, float v) { put (k, (double)v); }
240 void put (keyword k, signed char v) { put_(k, (sint32)v); }
241 void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
242 void put (keyword k, signed short v) { put_(k, (sint32)v); }
243 void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
244 void put (keyword k, signed int v) { put_(k, (sint32)v); }
245 void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
246 void put (keyword k, signed long v) { put_(k, (sint64)v); }
247 void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
248 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); }
250
251 template<typename T>
252 void put (keyword k, T *v)
253 {
254 if (v)
255 put (k, v->name);
256 else
257 put (k, (const char *)0);
258 }
259
260 bool save (const char *filename);
261
262 operator bool () { return !!av; }
263}; 370};
264 371
265// compatibility support, should be removed when no longer needed 372struct asyncw : ev_async, evapi, callback<void (ev_async &, int)>
266int fprintf (object_freezer &freezer, const char *format, ...);
267int fputs (const char *s, object_freezer &freezer);
268
269struct object_thawer
270{ 373{
271 SV *text; // text part 374 static void thunk (EV_P_ struct ev_async *w_, int revents)
272 AV *av; // perl part 375 {
273 char *line; // current beginning of line 376 asyncw &w = *static_cast<asyncw *>(w_);
274 char *last_value; 377
378 w (w, revents);
379 }
275 380
276 operator bool () { return !!text; }
277
278 object_thawer (const char *filename = 0);
279 ~object_thawer ();
280
281 void get (data_type type, void *obj, attachable_base *ext, int oid);
282
283 template<class subclass> 381 template<class O, class M>
284 void get (attachable<subclass> *obj, int oid) 382 asyncw (O object, M method)
383 : callback<void (asyncw &, int)> (object, method)
285 { 384 {
286 if (av) 385 ev_init ((ev_async *)this, thunk);
287 get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
288 } 386 }
289 387
290 keyword get_kv (); // also parse value for later use 388 void start ()
389 {
390 ev_async_start (EV_DEFAULT, (ev_async *)this);
391 }
291 392
292 const char *get_str () { return last_value; } // may be 0 393 void stop ()
394 {
395 ev_async_stop (EV_DEFAULT, (ev_async *)this);
396 }
293 397
294 void get (shstr &sh) const; 398 ~asyncw ()
295 void get_ornull (shstr &sh) const { sh = last_value; } 399 {
296 void get_ml (keyword kend, shstr &sh); 400 stop ();
297 401 }
298 sint32 get_sint32 () const;
299 sint64 get_sint64 () const;
300 double get_double () const;
301
302 void get (float &v) { v = get_double (); }
303 void get (double &v) { v = get_double (); }
304
305 void get (sint8 &i) { i = get_sint32 (); }
306 void get (uint8 &i) { i = get_sint32 (); }
307 void get (sint16 &i) { i = get_sint32 (); }
308 void get (uint16 &i) { i = get_sint32 (); }
309 void get (sint32 &i) { i = get_sint32 (); }
310
311 void get (uint32 &i) { i = get_sint64 (); }
312 void get (sint64 &i) { i = get_sint64 (); }
313}; 402};
314
315char *fgets (char *s, int n, object_thawer &thawer);
316 403
317#endif 404#endif
318 405

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines