ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/cfperl.h
Revision: 1.133
Committed: Wed Dec 5 19:13:21 2018 UTC (5 years, 5 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: HEAD
Changes since 1.132: +1 -1 lines
Log Message:
undefined behaviour, but now very ugly... https://groups.google.com/forum/#!topic/comp.std.c/3xa6qqiVXbc

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