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.20 by root, Thu Aug 31 18:59:24 2006 UTC vs.
Revision 1.125 by root, Tue Jan 3 11:25:31 2012 UTC

1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 *
4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 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_boot ();
33void 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
133
134noinline utf8_string cfSvPVutf8_nolen (SV *sv);
34 135
35enum event_klass 136enum event_klass
36{ 137{
37 KLASS_NONE, 138 KLASS_NONE,
38 KLASS_GLOBAL, 139 KLASS_GLOBAL,
140 KLASS_ATTACHABLE,
141 KLASS_CLIENT,
39 KLASS_PLAYER, 142 KLASS_PLAYER,
40 KLASS_OBJECT, 143 KLASS_OBJECT,
41 KLASS_MAP, 144 KLASS_MAP,
145 KLASS_COMMAND,
42}; 146};
43 147
44enum event_type 148enum event_type
45{ 149{
46# define def(klass,name) EVENT_ ## klass ## _ ## name, 150# define def(klass,name) EVENT_ ## klass ## _ ## name,
47# include "eventinc.h" 151# include "eventinc.h"
48# undef def 152# undef def
49 NUM_EVENT_TYPES 153 NUM_EVENT_TYPES
50}; 154};
51 155
156// in which global events or per-type events are we interested
157extern bitset<NUM_EVENT_TYPES> ev_want_event;
158extern bitset<NUM_TYPES> ev_want_type;
159
52#define ARG_AV(o) DT_AV , static_cast<AV *> (o) 160#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
53#define ARG_INT(v) DT_INT , static_cast<int> (v) 161#define ARG_INT(v) DT_INT , static_cast<int> (v)
54#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v) 162#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
55#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v) 163#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
56#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v) 164#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
57#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), (l) 165#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
58#define ARG_OBJECT(o) DT_OBJECT, (void *)static_cast<struct object *> (o) 166#define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o))
59#define ARG_MAP(o) DT_MAP , (void *)static_cast<struct mapstruct *> (o) 167#define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o))
60#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<struct pl *> (o) 168#define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (o))
61#define ARG_ARCH(o) DT_ARCH , (void *)static_cast<struct archetype *> (o) 169#define ARG_ARCH(o) DT_ARCH , (void *)(static_cast<archetype *> (o))
170#define ARG_CLIENT(o) DT_CLIENT, (void *)(static_cast<client *> (o))
62#define ARG_PARTY(o) DT_PARTY , (void *)static_cast<struct party *> (o) 171#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o))
63#define ARG_REGION(o) DT_REGION, (void *)static_cast<struct region *> (o) 172#define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o))
64 173
65// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension 174// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
66 175#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
67// all these return true when the normal event processing should be skipped (if any)
68#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
69
70#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
71#define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__) 176#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
177#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__)
72#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__) 178#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__)
179#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
73#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__) 180#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__)
74#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__) 181#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
75 182
76//TODO should index into @result 183//TODO should index into @result
77#define RESULT(idx,type) cfperl_result_ ## type (idx) 184#define RESULT(idx,type) cfperl_result_ ## type (idx)
185#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
78#define RESULT_INT(idx) RESULT(idx, INT) 186#define RESULT_INT(idx) RESULT(idx, INT)
79 187
80bool cfperl_invoke (event_type event, ...); 188double cfperl_result_DOUBLE (int idx);
81int cfperl_result_INT (int idx); 189int cfperl_result_INT (int idx);
82 190
191//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
192
193INTERFACE_CLASS (attachable)
83struct attachable_base 194struct attachable : refcnt_base
84{ 195{
85 SV *self; 196 static MGVTBL vtbl;
86 AV *cb; // CF+ perl self and callback
87 const char *attach; // generic extension attachment information
88 197
89 void clear (); // called when free'ing objects 198 enum {
90 void optimise (); // possibly save some memory by destroying unneeded data 199 F_DESTROYED = 0x01,
91 void instantiate (data_type type, void *obj); 200 F_DEBUG_TRACE = 0x02,
92
93 void attachable_init ()
94 {
95 self = 0;
96 cb = 0;
97 attach = 0;
98 } 201 };
99}; 202 uint8 ACC (RW, attachable_flags);
100 203
101// objects attachable from perl (or any other extension) should include or 204 static unordered_vector<attachable *> mortals;
102// derive using the curiously recurring template pattern, to avoid 205 MTH static void check_mortals ();
103// virtual method calls etc.
104template<class subclass>
105struct attachable : attachable_base
106{
107 void instantiate ()
108 {
109 if (attach)
110 attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
111 }
112};
113 206
114struct object_freezer : dynbuf 207 // object is delete'd after the refcount reaches 0
115{ 208 MTH int refcnt_cnt () const;
116 AV *av; 209 // check wether the object has died and destroy
210 MTH void refcnt_chk () { if (expect_false (refcnt <= 0)) do_check (); }
117 211
118 object_freezer (); 212 // destroy the object unless it was already destroyed
119 ~object_freezer (); 213 // this politely asks everybody interested the reduce
214 // the refcount to 0 as soon as possible.
215 MTH void destroy ();
120 216
121 void put (attachable_base *ext); 217 // return wether an object was destroyed already
218 MTH bool destroyed () const { return attachable_flags & F_DESTROYED; }
122 219
123 template<class subclass> 220 // destruct and free the memory for this object
124 void put (attachable<subclass> *obj) 221 virtual void do_delete ();
125 {
126 put ((attachable_base *)obj);
127 }
128 222
129 //TODO//temporary 223 virtual void gather_callbacks (AV *&callbacks, event_type event) const;
130 void put (const char *k, const char *v)
131 {
132 add (k);
133 224
134 //if (v) 225#if 0
135 add (' '); //TODO//cf compatibility always add space 226private:
136 if (v) 227 static refcounted *rc_first;
137 add (v); 228 refcounted *rc_next;
138
139 add ('\n');
140 }
141
142 //TODO//temporary
143 void put (const char *k, int v)
144 {
145 add (k);
146 add (' ');
147 add (sint32 (v));
148 add ('\n');
149 }
150
151 void put (keyword k, const char *v)
152 {
153 int klen = keyword_len [k];
154 int vlen = v ? strlen (v) : 0;
155
156 char *p = (char *)alloc (klen + 1 + vlen + 1);
157
158 memcpy (p, keyword_str [k], klen); p += klen;
159 *p++ = ' '; //TODO//cf compatibility always add space
160 memcpy (p, v, vlen); p += vlen;
161 *p = '\n';
162 }
163
164 void put (keyword k, double v)
165 {
166 char buf [128];
167
168 snprintf (buf, 128, "%.7g", v);
169
170 put (k, (const char *)buf);
171 }
172
173 void put_(keyword k, sint64 v)
174 {
175 add (keyword_str [k], keyword_len [k]);
176 add (' ');
177 add (v);
178 add ('\n');
179 }
180
181 void put_(keyword k, sint32 v)
182 {
183 add (keyword_str [k], keyword_len [k]);
184 add (' ');
185 add (v);
186 add ('\n');
187 }
188
189 void put (keyword kbeg, keyword kend, const char *v)
190 {
191 add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
192
193 if (v)
194 {
195 add (v);
196 add ('\n');
197 }
198
199 add (keyword_str [kend], keyword_len [kend]); add ('\n');
200 }
201
202 void put (keyword k, float v) { put (k, (double)v); }
203 void put (keyword k, signed char v) { put_(k, (sint32)v); }
204 void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
205 void put (keyword k, signed short v) { put_(k, (sint32)v); }
206 void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
207 void put (keyword k, signed int v) { put_(k, (sint32)v); }
208 void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
209 void put (keyword k, signed long v) { put_(k, (sint64)v); }
210 void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
211 void put (keyword k, signed long long v) { put_(k, (sint64)v); }
212 void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
213
214 template<typename T>
215 void put (keyword k, T *v)
216 {
217 put (k, v ? (const char *)v->name : 0);
218 }
219
220 bool save (const char *filename);
221
222 operator bool () { return !!av; }
223};
224
225// compatibility support, should be removed when no longer needed
226int fprintf (object_freezer &freezer, const char *format, ...);
227int fputs (const char *s, object_freezer &freezer);
228
229// a single key-value line from a file
230struct token {
231 keyword k;
232 const char *v;
233
234 token (keyword k, const char *v = 0) : k(k), v(v) { }
235};
236
237struct object_thawer
238{
239 AV *av;
240 FILE *fp;
241 char line[1024];
242
243 object_thawer (const char *filename = 0);
244 ~object_thawer ();
245
246 void get (data_type type, void *obj, attachable_base *ext, int oid);
247
248 template<class subclass>
249 void get (attachable<subclass> *obj, int oid)
250 {
251 if (av)
252 get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
253 }
254
255 token get_token ();
256
257 operator FILE *() { return fp; }
258};
259
260#endif 229#endif
261 230
231 HV *self; // CF+ perl self
232 AV *cb; // CF+ callbacks
233 shstr attach; // generic extension attachment information
234
235 void sever_self (); // sever this object from its self, if it has one.
236 void optimise (); // possibly save some memory by destroying unneeded data
237
238 attachable ()
239 : attachable_flags (0), self (0), cb (0), attach (0)
240 {
241 }
242
243 attachable (const attachable &src)
244 : attachable_flags (0), self (0), cb (0), attach (src.attach)
245 {
246 }
247
248 // set a custom key to the given value, or delete it if value = 0
249 void set_key (const_utf8_string key, const_utf8_string value = 0, bool is_utf8 = 0);
250
251 void set_key_text (const_utf8_string key, const_utf8_string value = 0)
252 {
253 set_key (key, value, 1);
254 }
255
256 void set_key_data (const_utf8_string key, const_utf8_string value = 0)
257 {
258 set_key (key, value, 0);
259 }
260
261 attachable &operator =(const attachable &src);
262
263 // used to _quickly_ decide wether to shortcut the evaluation
264 bool should_invoke (event_type event)
265 {
266 return ev_want_event [event] || cb;
267 }
268
269 bool invoke (event_type event, ...);
270
271 MTH void instantiate ();
272 void reattach ();
273
274protected:
275 // do the real refcount checking work
276 void do_check ();
277
278 // the method that does the real destroy work
279 virtual void do_destroy ();
280
281 // destructor is protected, should not be called by anybody
282 virtual ~attachable ();
283};
284
285// the global object is a pseudo object that cares for the global events
286struct global : attachable
287{
288 void gather_callbacks (AV *&callbacks, event_type event) const;
289};
290
291extern struct global gbl_ev;
292
293//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
294
295#include "freezethaw.h"
296
297//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
298
299struct coroapi {
300 static struct CoroAPI *GCoroAPI;
301
302 static EV_ATOMIC_T cede_pending;
303
304 static int nready () { return CORO_NREADY; }
305 static int cede () { cede_pending = 0; return CORO_CEDE ; }
306
307 static void do_cede_to_tick ();
308
309 // actually cede's far more often
310 static bool cede_to_tick ()
311 {
312 if (expect_true (!cede_pending))
313 return false;
314
315 do_cede_to_tick ();
316 return true;
317 }
318
319 static void wait_for_tick ();
320 static void wait_for_tick_begin ();
321};
322
323struct evapi
324{
325 static struct EVAPI *GEVAPI;
326};
327
328struct iow : ev_io, evapi, callback<void (iow &, int)>
329{
330 static void thunk (EV_P_ struct ev_io *w_, int revents)
331 {
332 iow &w = *static_cast<iow *>(w_);
333
334 w (w, revents);
335 }
336
337 template<class O, class M>
338 iow (O object, M method)
339 : callback<void (iow &, int)> (object, method)
340 {
341 ev_init ((ev_io *)this, thunk);
342 }
343
344 void prio (int prio)
345 {
346 ev_set_priority ((ev_io *)this, prio);
347 }
348
349 void set (int fd, int events)
350 {
351 ev_io_set ((ev_io *)this, fd, events);
352 }
353
354 int poll () const { return events; }
355
356 void poll (int events);
357
358 void start ()
359 {
360 ev_io_start (EV_DEFAULT, (ev_io *)this);
361 }
362
363 void stop ()
364 {
365 ev_io_stop (EV_DEFAULT, (ev_io *)this);
366 }
367
368 ~iow ()
369 {
370 stop ();
371 }
372};
373
374struct asyncw : ev_async, evapi, callback<void (ev_async &, int)>
375{
376 static void thunk (EV_P_ struct ev_async *w_, int revents)
377 {
378 asyncw &w = *static_cast<asyncw *>(w_);
379
380 w (w, revents);
381 }
382
383 template<class O, class M>
384 asyncw (O object, M method)
385 : callback<void (asyncw &, int)> (object, method)
386 {
387 ev_init ((ev_async *)this, thunk);
388 }
389
390 void start ()
391 {
392 ev_async_start (EV_DEFAULT, (ev_async *)this);
393 }
394
395 void stop ()
396 {
397 ev_async_stop (EV_DEFAULT, (ev_async *)this);
398 }
399
400 ~asyncw ()
401 {
402 stop ();
403 }
404};
405
406#endif
407

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines