ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/cfperl.h
Revision: 1.122
Committed: Thu Apr 15 04:02:38 2010 UTC (14 years, 1 month ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-3_0
Changes since 1.121: +1 -209 lines
Log Message:
create freezethaw.h

File Contents

# User Rev Content
1 root 1.74 /*
2 root 1.90 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 root 1.74 *
4 root 1.116 * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 root 1.74 *
6 root 1.108 * 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 root 1.74 *
11 root 1.81 * 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 root 1.74 *
16 root 1.108 * 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 root 1.74 *
20 root 1.90 * The authors can be reached via e-mail to <support@deliantra.net>
21 root 1.74 */
22    
23 root 1.1 //
24     // cfperl.h perl interface
25     //
26 root 1.2 #ifndef CFPERL_H__
27     #define CFPERL_H__
28    
29 root 1.16 using namespace std;
30    
31     #include <EXTERN.h>
32     #include <perl.h>
33 root 1.20 #include <XSUB.h>
34 root 1.16
35 root 1.91 #include <EVAPI.h>
36 root 1.42 #include <CoroAPI.h>
37 root 1.36
38 root 1.42 #include "util.h"
39     #include "keyword.h"
40     #include "dynbuf.h"
41 root 1.36 #include "callback.h"
42    
43 root 1.42 //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
44    
45 root 1.16 // optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
46     #undef localtime
47     #undef srand48
48     #undef drand48
49     #undef srandom
50 root 1.98 #undef opendir
51 root 1.16 #undef readdir
52 root 1.98 #undef closedir
53 root 1.16 #undef getprotobyname
54     #undef gethostbyname
55     #undef ctime
56     #undef strerror
57 root 1.87 #undef _
58 root 1.16
59 root 1.39 // same here, massive symbol spamming
60     #undef do_open
61     #undef do_close
62 root 1.42 #undef ref
63 root 1.44 #undef seed
64 root 1.39
65 root 1.16 // perl bug #40256: perl does overwrite those with reentrant versions
66     // but does not initialise their state structures.
67     #undef random
68     #undef crypt
69    
70 root 1.42 //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
71    
72 root 1.87 #define _(msg) (msg)
73     #define N_(msg) (msg)
74    
75     //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
76    
77 root 1.42 // some macros to simplify perl in-calls
78    
79     #define CHECK_ERROR \
80     if (SvTRUE (ERRSV)) \
81 root 1.95 LOG (llevError, "runtime error in %s: %s", __func__, SvPVutf8_nolen (ERRSV));
82 root 1.42
83 root 1.107 inline int call_pvsv (const char *ob, I32 flags) { return call_pv (ob, flags); }
84     inline int call_pvsv (SV *ob, I32 flags) { return call_sv (ob, flags); }
85    
86 root 1.119 // 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 root 1.42 #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 root 1.107 #define CALL_CALL(name, flags) PUTBACK; int count = call_pvsv (name, (flags) | G_EVAL); SPAGAIN;
93 root 1.119 #define CALL_END PUTBACK; CHECK_ERROR; FREETMPS; LEAVE; CALL_POP
94 root 1.42
95     //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
96    
97 root 1.7 void cfperl_init ();
98     void cfperl_main ();
99 root 1.94 void cfperl_tick ();
100 root 1.50 void cfperl_emergency_save ();
101 root 1.55 void cfperl_cleanup (int make_core);
102 root 1.65 void cfperl_make_book (object *book, int level);
103 root 1.114 void cfperl_send_msg (client *ns, int color, const_utf8_string type, const_utf8_string msg);
104 root 1.84 int cfperl_can_merge (object *ob1, object *ob2);
105 root 1.105 void cfperl_mapscript_activate (object *ob, int state, object *activator, object *originator = 0);
106 root 1.7
107 root 1.114 bool is_match_expr (const_utf8_string expr);
108 root 1.110 // applies the match expression and returns true if it matches
109 root 1.114 bool match (const_utf8_string expr, object *ob, object *self = 0, object *source = 0, object *originator = 0);
110 root 1.110 // same as above, but returns the first object found, or 0
111 root 1.114 object *match_one (const_utf8_string expr, object *ob, object *self = 0, object *source = 0, object *originator = 0);
112 root 1.106
113 root 1.42 //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
114    
115 root 1.95 #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 root 1.96 typedef double uval64;
125 root 1.95 # define newSVval64 newSVnv
126     # define SvVAL64 SvNV
127     # define newSVuval64 newSVnv
128     # define SvUVAL64 SvNV
129     #endif
130    
131 root 1.79 extern tstamp runtime; // virtual server time, excluding time jumps and lag
132     extern tstamp NOW; // real time of current server tick
133 root 1.42
134 root 1.6 enum event_klass
135     {
136 root 1.11 KLASS_NONE,
137 root 1.3 KLASS_GLOBAL,
138 root 1.41 KLASS_ATTACHABLE,
139 root 1.40 KLASS_CLIENT,
140 root 1.3 KLASS_PLAYER,
141     KLASS_OBJECT,
142     KLASS_MAP,
143 root 1.33 KLASS_COMMAND,
144 root 1.3 };
145    
146 root 1.6 enum event_type
147     {
148 root 1.7 # define def(klass,name) EVENT_ ## klass ## _ ## name,
149 root 1.2 # include "eventinc.h"
150     # undef def
151 root 1.4 NUM_EVENT_TYPES
152 root 1.2 };
153    
154 root 1.64 // in which global events or per-type events are we interested
155     extern bitset<NUM_EVENT_TYPES> ev_want_event;
156     extern bitset<NUM_TYPES> ev_want_type;
157    
158 root 1.41 #define ARG_AV(o) DT_AV , static_cast<AV *> (o)
159     #define ARG_INT(v) DT_INT , static_cast<int> (v)
160     #define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
161     #define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
162     #define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
163     #define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
164     #define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o))
165     #define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o))
166     #define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (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))
169     #define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o))
170     #define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o))
171 root 1.3
172     // the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
173 root 1.66 #define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
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__)
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__)
178     #define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__)
179     #define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
180 root 1.3
181 root 1.7 //TODO should index into @result
182     #define RESULT(idx,type) cfperl_result_ ## type (idx)
183 root 1.33 #define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
184     #define RESULT_INT(idx) RESULT(idx, INT)
185 root 1.7
186 root 1.34 double cfperl_result_DOUBLE (int idx);
187     int cfperl_result_INT (int idx);
188 root 1.7
189 root 1.42 //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
190    
191 root 1.47 INTERFACE_CLASS (attachable)
192 root 1.86 struct attachable : refcnt_base
193 root 1.6 {
194 root 1.42 static MGVTBL vtbl;
195    
196 root 1.41 enum {
197 root 1.54 F_DESTROYED = 0x01,
198     F_DEBUG_TRACE = 0x02,
199 root 1.41 };
200 root 1.111 uint8 ACC (RW, attachable_flags);
201 root 1.100
202     static unordered_vector<attachable *> mortals;
203     MTH static void check_mortals ();
204 root 1.41
205     // object is delete'd after the refcount reaches 0
206 root 1.49 MTH int refcnt_cnt () const;
207 root 1.41 // check wether the object has died and destroy
208 root 1.75 MTH void refcnt_chk () { if (expect_false (refcnt <= 0)) do_check (); }
209 root 1.41
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 root 1.47 MTH void destroy ();
214 root 1.41
215     // return wether an object was destroyed already
216 root 1.111 MTH bool destroyed () const { return attachable_flags & F_DESTROYED; }
217 root 1.41
218 root 1.120 // destruct and free the memory for this object
219     virtual void do_delete ();
220    
221 root 1.41 virtual void gather_callbacks (AV *&callbacks, event_type event) const;
222    
223     #if 0
224     private:
225     static refcounted *rc_first;
226     refcounted *rc_next;
227     #endif
228    
229     HV *self; // CF+ perl self
230 root 1.35 AV *cb; // CF+ callbacks
231 root 1.21 shstr attach; // generic extension attachment information
232 root 1.6
233 root 1.52 void sever_self (); // sever this object from its self, if it has one.
234     void optimise (); // possibly save some memory by destroying unneeded data
235 root 1.8
236 root 1.41 attachable ()
237 root 1.111 : attachable_flags (0), self (0), cb (0), attach (0)
238 root 1.8 {
239     }
240 root 1.22
241 root 1.41 attachable (const attachable &src)
242 root 1.111 : attachable_flags (0), self (0), cb (0), attach (src.attach)
243 root 1.22 {
244     }
245    
246 root 1.82 // set a custom key to the given value, or delete it if value = 0
247 root 1.114 void set_key (const_utf8_string key, const_utf8_string value = 0, bool is_utf8 = 0);
248 root 1.88
249 root 1.114 void set_key_text (const_utf8_string key, const_utf8_string value = 0)
250 root 1.88 {
251     set_key (key, value, 1);
252     }
253    
254 root 1.114 void set_key_data (const_utf8_string key, const_utf8_string value = 0)
255 root 1.88 {
256     set_key (key, value, 0);
257     }
258 root 1.82
259 root 1.41 attachable &operator =(const attachable &src);
260    
261 root 1.117 // used to _quickly_ decide wether to shortcut the evaluation
262 root 1.66 bool should_invoke (event_type event)
263 root 1.64 {
264 root 1.66 return ev_want_event [event] || cb;
265 root 1.64 }
266    
267 root 1.66 bool invoke (event_type event, ...);
268    
269 root 1.48 MTH void instantiate ();
270 root 1.41 void reattach ();
271 root 1.24
272 root 1.41 protected:
273     // do the real refcount checking work
274     void do_check ();
275 root 1.25
276 root 1.41 // the method that does the real destroy work
277     virtual void do_destroy ();
278 root 1.83
279     // destructor is protected, should not be called by anybody
280     virtual ~attachable ();
281 root 1.6 };
282    
283 root 1.41 // the global object is a pseudo object that cares for the global events
284     struct global : attachable
285 root 1.6 {
286 root 1.41 void gather_callbacks (AV *&callbacks, event_type event) const;
287 root 1.6 };
288    
289 root 1.41 extern struct global gbl_ev;
290    
291 root 1.42 //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
292    
293 root 1.122 #include "freezethaw.h"
294 root 1.21
295 root 1.42 //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
296    
297     struct coroapi {
298     static struct CoroAPI *GCoroAPI;
299    
300 root 1.94 static EV_ATOMIC_T cede_pending;
301 root 1.46
302 root 1.94 static int nready () { return CORO_NREADY; }
303     static int cede () { cede_pending = 0; return CORO_CEDE ; }
304 root 1.46
305 root 1.62 static void do_cede_to_tick ();
306 root 1.46
307 root 1.94 // actually cede's far more often
308 root 1.77 static bool cede_to_tick ()
309 root 1.62 {
310 root 1.94 if (expect_true (!cede_pending))
311 root 1.77 return false;
312    
313     do_cede_to_tick ();
314     return true;
315 root 1.62 }
316    
317 root 1.61 static void wait_for_tick ();
318     static void wait_for_tick_begin ();
319 root 1.42 };
320    
321 root 1.91 struct evapi
322 root 1.36 {
323 root 1.91 static struct EVAPI *GEVAPI;
324 root 1.36 };
325    
326 root 1.91 struct iow : ev_io, evapi, callback<void (iow &, int)>
327 root 1.36 {
328 root 1.92 static void thunk (EV_P_ struct ev_io *w_, int revents)
329 root 1.91 {
330     iow &w = *static_cast<iow *>(w_);
331    
332     w (w, revents);
333     }
334 root 1.36
335 root 1.91 template<class O, class M>
336     iow (O object, M method)
337     : callback<void (iow &, int)> (object, method)
338     {
339     ev_init ((ev_io *)this, thunk);
340     }
341 root 1.36
342 root 1.94 void prio (int prio)
343     {
344     ev_set_priority ((ev_io *)this, prio);
345     }
346    
347 root 1.91 void set (int fd, int events)
348 root 1.36 {
349 root 1.91 ev_io_set ((ev_io *)this, fd, events);
350 root 1.36 }
351    
352 root 1.91 int poll () const { return events; }
353    
354     void poll (int events);
355 root 1.36
356 root 1.91 void start ()
357 root 1.38 {
358 root 1.92 ev_io_start (EV_DEFAULT, (ev_io *)this);
359 root 1.38 }
360    
361 root 1.91 void stop ()
362     {
363 root 1.92 ev_io_stop (EV_DEFAULT, (ev_io *)this);
364 root 1.91 }
365 root 1.38
366 root 1.91 ~iow ()
367 root 1.36 {
368 root 1.91 stop ();
369 root 1.36 }
370     };
371    
372 root 1.94 struct asyncw : ev_async, evapi, callback<void (ev_async &, int)>
373     {
374     static void thunk (EV_P_ struct ev_async *w_, int revents)
375     {
376     asyncw &w = *static_cast<asyncw *>(w_);
377    
378     w (w, revents);
379     }
380    
381     template<class O, class M>
382     asyncw (O object, M method)
383     : callback<void (asyncw &, int)> (object, method)
384     {
385     ev_init ((ev_async *)this, thunk);
386     }
387    
388     void start ()
389     {
390     ev_async_start (EV_DEFAULT, (ev_async *)this);
391     }
392    
393     void stop ()
394     {
395     ev_async_stop (EV_DEFAULT, (ev_async *)this);
396     }
397    
398     ~asyncw ()
399     {
400     stop ();
401     }
402     };
403    
404 root 1.2 #endif
405 root 1.3