--- deliantra/server/include/cfperl.h 2006/11/07 16:30:55 1.31 +++ deliantra/server/include/cfperl.h 2010/04/12 05:22:38 1.120 @@ -1,43 +1,146 @@ +/* + * This file is part of Deliantra, the Roguelike Realtime MMORPG. + * + * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team + * + * Deliantra is free software: you can redistribute it and/or modify it under + * the terms of the Affero GNU General Public License as published by the + * Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the Affero GNU General Public License + * and the GNU General Public License along with this program. If not, see + * . + * + * The authors can be reached via e-mail to + */ + // // cfperl.h perl interface // #ifndef CFPERL_H__ #define CFPERL_H__ -#include - using namespace std; #include #include #include +#include +#include + +#include "util.h" +#include "keyword.h" +#include "dynbuf.h" +#include "callback.h" + +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + // optimisations/workaround for functions requiring my_perl in scope (anti-bloat) #undef localtime #undef srand48 #undef drand48 #undef srandom +#undef opendir #undef readdir +#undef closedir #undef getprotobyname #undef gethostbyname #undef ctime #undef strerror +#undef _ + +// same here, massive symbol spamming +#undef do_open +#undef do_close +#undef ref +#undef seed // perl bug #40256: perl does overwrite those with reentrant versions // but does not initialise their state structures. #undef random #undef crypt +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +#define _(msg) (msg) +#define N_(msg) (msg) + +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +// some macros to simplify perl in-calls + +#define CHECK_ERROR \ + if (SvTRUE (ERRSV)) \ + LOG (llevError, "runtime error in %s: %s", __func__, SvPVutf8_nolen (ERRSV)); + +inline int call_pvsv (const char *ob, I32 flags) { return call_pv (ob, flags); } +inline int call_pvsv (SV *ob, I32 flags) { return call_sv (ob, flags); } + +// TODO: temporarily enabled pushstack/popstack for all calls from the core, to maybe fix object memleak? +#define CALL_PUSH PUSHSTACKi (PERLSI_UNKNOWN) +#define CALL_POP PUTBACK; POPSTACK; SPAGAIN +#define CALL_BEGIN(args) dSP; CALL_PUSH; ENTER; SAVETMPS; PUSHMARK (SP); EXTEND (SP, args) +#define CALL_ARG_SV(sv) PUSHs (sv_2mortal (sv)) // separate because no refcount inc +#define CALL_ARG(expr) PUSHs (sv_2mortal (to_sv (expr))) +#define CALL_CALL(name, flags) PUTBACK; int count = call_pvsv (name, (flags) | G_EVAL); SPAGAIN; +#define CALL_END PUTBACK; CHECK_ERROR; FREETMPS; LEAVE; CALL_POP + +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + void cfperl_init (); void cfperl_main (); +void cfperl_tick (); +void cfperl_emergency_save (); +void cfperl_cleanup (int make_core); +void cfperl_make_book (object *book, int level); +void cfperl_send_msg (client *ns, int color, const_utf8_string type, const_utf8_string msg); +int cfperl_can_merge (object *ob1, object *ob2); +void cfperl_mapscript_activate (object *ob, int state, object *activator, object *originator = 0); + +bool is_match_expr (const_utf8_string expr); +// applies the match expression and returns true if it matches +bool match (const_utf8_string expr, object *ob, object *self = 0, object *source = 0, object *originator = 0); +// same as above, but returns the first object found, or 0 +object *match_one (const_utf8_string expr, object *ob, object *self = 0, object *source = 0, object *originator = 0); + +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +#if IVSIZE >= 8 + typedef IV val64; + typedef IV uval64; +# define newSVval64 newSViv +# define SvVAL64 SvIV +# define newSVuval64 newSVuv +# define SvUVAL64 SvUV +#else + typedef double val64; + typedef double uval64; +# define newSVval64 newSVnv +# define SvVAL64 SvNV +# define newSVuval64 newSVnv +# define SvUVAL64 SvNV +#endif + +extern tstamp runtime; // virtual server time, excluding time jumps and lag +extern tstamp NOW; // real time of current server tick enum event_klass { KLASS_NONE, KLASS_GLOBAL, + KLASS_ATTACHABLE, + KLASS_CLIENT, KLASS_PLAYER, KLASS_OBJECT, KLASS_MAP, + KLASS_COMMAND, }; enum event_type @@ -48,262 +151,327 @@ NUM_EVENT_TYPES }; -#define ARG_AV(o) DT_AV , static_cast (o) -#define ARG_INT(v) DT_INT , static_cast (v) -#define ARG_INT64(v) DT_INT64 , static_cast (v) -#define ARG_DOUBLE(v) DT_DOUBLE, static_cast (v) -#define ARG_STRING(v) DT_STRING, static_cast (v) -#define ARG_DATA(s,l) DT_DATA , static_cast (s), int (l) -#define ARG_OBJECT(o) DT_OBJECT, (void *)static_cast (o) -#define ARG_MAP(o) DT_MAP , (void *)static_cast (o) -#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast (o) -#define ARG_ARCH(o) DT_ARCH , (void *)static_cast (o) -#define ARG_PARTY(o) DT_PARTY , (void *)static_cast (o) -#define ARG_REGION(o) DT_REGION, (void *)static_cast (o) +// in which global events or per-type events are we interested +extern bitset ev_want_event; +extern bitset ev_want_type; + +#define ARG_AV(o) DT_AV , static_cast (o) +#define ARG_INT(v) DT_INT , static_cast (v) +#define ARG_INT64(v) DT_INT64 , static_cast (v) +#define ARG_DOUBLE(v) DT_DOUBLE, static_cast (v) +#define ARG_STRING(v) DT_STRING, static_cast (v) +#define ARG_DATA(s,l) DT_DATA , static_cast (s), int (l) +#define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast (o)) +#define ARG_MAP(o) DT_MAP , (void *)(static_cast (o)) +#define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast (o)) +#define ARG_ARCH(o) DT_ARCH , (void *)(static_cast (o)) +#define ARG_CLIENT(o) DT_CLIENT, (void *)(static_cast (o)) +#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast (o)) +#define ARG_REGION(o) DT_REGION, (void *)(static_cast (o)) // the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension - -// all these return true when the normal event processing should be skipped (if any) -#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END) - -#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__) -#define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__) -#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__) -#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__) -#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__) +#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0) +#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__) +#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__) +#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__) +#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__) +#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__) +#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__) //TODO should index into @result #define RESULT(idx,type) cfperl_result_ ## type (idx) -#define RESULT_INT(idx) RESULT(idx, INT) -#define RESULT_MAP(idx) RESULT(idx, MAP) +#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE) +#define RESULT_INT(idx) RESULT(idx, INT) -bool cfperl_invoke (event_type event, ...); +double cfperl_result_DOUBLE (int idx); int cfperl_result_INT (int idx); -int cfperl_result_MAP (int idx); -struct attachable_base +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +INTERFACE_CLASS (attachable) +struct attachable : refcnt_base { - SV *self; - AV *cb; // CF+ perl self and callback + static MGVTBL vtbl; + + enum { + F_DESTROYED = 0x01, + F_DEBUG_TRACE = 0x02, + }; + uint8 ACC (RW, attachable_flags); + + static unordered_vector mortals; + MTH static void check_mortals (); + + // object is delete'd after the refcount reaches 0 + MTH int refcnt_cnt () const; + // check wether the object has died and destroy + MTH void refcnt_chk () { if (expect_false (refcnt <= 0)) do_check (); } + + // destroy the object unless it was already destroyed + // this politely asks everybody interested the reduce + // the refcount to 0 as soon as possible. + MTH void destroy (); + + // return wether an object was destroyed already + MTH bool destroyed () const { return attachable_flags & F_DESTROYED; } + + // destruct and free the memory for this object + virtual void do_delete (); + + virtual void gather_callbacks (AV *&callbacks, event_type event) const; + +#if 0 +private: + static refcounted *rc_first; + refcounted *rc_next; +#endif + + HV *self; // CF+ perl self + AV *cb; // CF+ callbacks shstr attach; // generic extension attachment information - void clear (); // called when free'ing objects - void optimise (); // possibly save some memory by destroying unneeded data - void instantiate (data_type type, void *obj); + void sever_self (); // sever this object from its self, if it has one. + void optimise (); // possibly save some memory by destroying unneeded data - void attachable_clear () + attachable () + : attachable_flags (0), self (0), cb (0), attach (0) { - self = 0; - cb = 0; - attach = 0; } - attachable_base () + attachable (const attachable &src) + : attachable_flags (0), self (0), cb (0), attach (src.attach) { - attachable_clear (); } - ~attachable_base () + // set a custom key to the given value, or delete it if value = 0 + void set_key (const_utf8_string key, const_utf8_string value = 0, bool is_utf8 = 0); + + void set_key_text (const_utf8_string key, const_utf8_string value = 0) { - clear (); + set_key (key, value, 1); } - attachable_base (const attachable_base &src) - : self (0), cb (0), attach (src.attach) + void set_key_data (const_utf8_string key, const_utf8_string value = 0) { + set_key (key, value, 0); } - attachable_base &operator = (const attachable_base &src) + attachable &operator =(const attachable &src); + + // used to _quickly_ decide wether to shortcut the evaluation + bool should_invoke (event_type event) { - clear (); - attach = src.attach; - return *this; + return ev_want_event [event] || cb; } + + bool invoke (event_type event, ...); + + MTH void instantiate (); + void reattach (); + +protected: + // do the real refcount checking work + void do_check (); + + // the method that does the real destroy work + virtual void do_destroy (); + + // destructor is protected, should not be called by anybody + virtual ~attachable (); }; -// objects attachable from perl (or any other extension) should include or -// derive using the curiously recurring template pattern, to avoid -// virtual method calls etc. -template -struct attachable : attachable_base +// the global object is a pseudo object that cares for the global events +struct global : attachable { - void instantiate () - { - if (attach) - attachable_base::instantiate ((data_type) cftype::dt, static_cast(this)); - } + void gather_callbacks (AV *&callbacks, event_type event) const; }; -struct object_freezer : dynbuf -{ - AV *av; +extern struct global gbl_ev; - object_freezer (); - ~object_freezer (); +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// - void put (attachable_base *ext); +// a little dirty hack, maybe unify with something else at a later time +struct keyword_string +{ + const char *s; + const int l; - template - void put (attachable *obj) - { - put ((attachable_base *)obj); - } + keyword_string (const char *s, int l) + : s(s), l(l) + { } - // used only for user-defined key-value pairs - void put (const shstr &k, const shstr &v) + keyword_string (keyword kw) + : s(keyword_str [kw]), l(keyword_len [kw]) { - add (k); - - if (v) - add (' '), add (v); - - add ('\n'); } - //TODO//temporary, used only for saving body locations - void put (const char *k, int v) + keyword_string (shstr_tmp sh) + : s(&sh), l(sh.length ()) { - add (k); - add (' '); - add (sint32 (v)); - add ('\n'); } +}; - template - void put_string (keyword k, const T &v) - { - int klen = keyword_len [k]; - int vlen = v ? strlen (v) + 1 : 0; - - char *p = (char *)alloc (klen + vlen + 1); +#define CS(keyword) keyword_string (# keyword, sizeof (# keyword) - 1) +#define KW(keyword) CS(keyword) - memcpy (p, keyword_str [k], klen); p += klen; +INTERFACE_CLASS(object_freezer) +struct object_freezer : dynbuf_text +{ + AV *av; - if (v) - { - *p++ = ' '; vlen--; - memcpy (p, v, vlen); p += vlen; - } + object_freezer (); + ~object_freezer (); - *p = '\n'; + // serialise perl part + void put_ (attachable *ext); + void put (attachable *ext) + { + if (expect_false (ext->self)) + put_ (ext); } - void put (keyword k, const char *v) + // null value (== no space after keyword) + void put (const keyword_string k) { - put_string (k, v); + char *p = force (k.l + 1); + memcpy (p, k.s, k.l); p += k.l; *p++ = '\n'; + alloc (p); } - void put (keyword k, const shstr &v) + void put (const keyword_string k, const keyword_string v) { - put_string (k, v); + char *p = force (k.l + 1 + v.l + 1); + memcpy (p, k.s, k.l); p += k.l; *p++ = ' '; + memcpy (p, v.s, v.l); p += v.l; *p++ = '\n'; + alloc (p); } - void put (keyword k, double v) + void put (const keyword_string k, const_utf8_string v) { - char buf [128]; + if (expect_true (v)) + put (k, keyword_string (v, strlen (v))); + else + put (k); + } - snprintf (buf, 128, "%.7g", v); + void put (const keyword_string k, shstr_tmp v) + { + put (k, keyword_string (v)); + } - put (k, (const char *)buf); + void put (const keyword_string k, double v) + { + char *p = force (MAX_KEYWORD_LEN + 2 + 32); + memcpy (p, k.s, k.l); p += k.l; *p++ = ' '; + p += sprintf (p, "%.7g", v); *p++ = '\n'; + alloc (p); } - void put_(keyword k, sint64 v) + void put_(const keyword_string k, sint64 v) { - add (keyword_str [k], keyword_len [k]); - add (' '); + force (MAX_KEYWORD_LEN + 2 + sint64_digits); + fadd (k.s, k.l); + fadd (' '); add (v); - add ('\n'); + fadd ('\n'); } - void put_(keyword k, sint32 v) + void put_(const keyword_string k, sint32 v) { - add (keyword_str [k], keyword_len [k]); - add (' '); + force (MAX_KEYWORD_LEN + 2 + sint32_digits); + fadd (k.s, k.l); + fadd (' '); add (v); - add ('\n'); + fadd ('\n'); } - void put (keyword kbeg, keyword kend, const shstr &v) + void put (const keyword_string k, float v) { put (k, (double)v); } + void put (const keyword_string k, signed char v) { put_(k, (sint32)v); } + void put (const keyword_string k, unsigned char v) { put_(k, (sint32)v); } + void put (const keyword_string k, signed short v) { put_(k, (sint32)v); } + void put (const keyword_string k, unsigned short v) { put_(k, (sint32)v); } + void put (const keyword_string k, signed int v) { put_(k, (sint32)v); } + void put (const keyword_string k, unsigned int v) { put_(k, (sint64)v); } + void put (const keyword_string k, signed long v) { put_(k, (sint64)v); } + void put (const keyword_string k, unsigned long v) { put_(k, (sint64)v); } + void put (const keyword_string k, signed long long v) { put_(k, (sint64)v); } + void put (const keyword_string k, unsigned long long v) { put_(k, (sint64)v); } + + void put (const keyword_string kbeg, const keyword_string kend, shstr_tmp v) { - add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n'); + force (MAX_KEYWORD_LEN + 1); + fadd (kbeg.s, kbeg.l); fadd ('\n'); - if (v) + if (expect_true (v)) { add (v); add ('\n'); } - add (keyword_str [kend], keyword_len [kend]); add ('\n'); + force (MAX_KEYWORD_LEN + 1); + fadd (kend.s, kend.l); fadd ('\n'); } - void put (keyword k, float v) { put (k, (double)v); } - void put (keyword k, signed char v) { put_(k, (sint32)v); } - void put (keyword k, unsigned char v) { put_(k, (sint32)v); } - void put (keyword k, signed short v) { put_(k, (sint32)v); } - void put (keyword k, unsigned short v) { put_(k, (sint32)v); } - void put (keyword k, signed int v) { put_(k, (sint32)v); } - void put (keyword k, unsigned int v) { put_(k, (sint64)v); } - void put (keyword k, signed long v) { put_(k, (sint64)v); } - void put (keyword k, unsigned long v) { put_(k, (sint64)v); } - void put (keyword k, signed long long v) { put_(k, (sint64)v); } - void put (keyword k, unsigned long long v) { put_(k, (sint64)v); } + void put (const keyword_string k, archetype *v); + void put (const keyword_string k, treasurelist *v); + void put (const keyword_string k, faceinfo *v); template - void put (keyword k, T *v) + void put (const keyword_string k, const refptr &v) { - if (v) - put (k, v->name); - else - put (k, (const char *)0); + put (k, (T *)v); } - bool save (const char *filename); - char *as_string (); // like strdup + MTH bool save (const_octet_string path); + utf8_string as_string (); // like strdup operator bool () { return !!av; } }; -// compatibility support, should be removed when no longer needed -int fprintf (object_freezer &freezer, const char *format, ...); -int fputs (const char *s, object_freezer &freezer); - +INTERFACE_CLASS(object_thawer) struct object_thawer { + char *line; // current beginning of line SV *text; // text part AV *av; // perl part - char *line; // current beginning of line - char *last_value; + int linenum; + keyword kw; + char *kw_str; // the keyword parsed, as string + char *value; // the value, or 0 if no value + const char *value_nn; // the value, or the empty string if no value + const char *name; - operator bool () { return !!text; } + operator bool () const { return !!text; } - object_thawer (const char *filename = 0); - object_thawer (const char *data, AV *perlav); + object_thawer (const_utf8_string path = 0); + object_thawer (const_utf8_string data, AV *perlav); ~object_thawer (); - void get (data_type type, void *obj, attachable_base *ext, int oid); + void get (attachable *obj, int oid); - template - void get (attachable *obj, int oid) - { - if (av) - get ((data_type) cftype::dt, (subclass *)obj, obj, oid); - } + // parse next line + MTH void next (); + // skip the current key-value (usually fetch next line, for + // multiline-fields, skips till the corresponding end-kw + MTH void skip (); + MTH void skip_block (); // skips till and over KW_end - keyword get_kv (); // also parse value for later use - - const char *get_str () { return last_value; } // may be 0 - - void get (shstr &sh) const; - void get_ornull (shstr &sh) const { sh = last_value; } + bool has_value () { return value; } + const_utf8_string get_str () { return value_nn; } // empty string when missing void get_ml (keyword kend, shstr &sh); + void get_ornull (shstr &sh) const { sh = value; } + void get (shstr &sh) const { sh = value; } // might want to check for non-null here + + bool get_bool () const { return *value_nn == '1'; } sint32 get_sint32 () const; - sint64 get_sint64 () const; - double get_double () const; + sint64 get_sint64 () const { return strtoll (value_nn, 0, 10); } + double get_double () const { return strtod (value_nn, 0); } - void get (float &v) { v = get_double (); } + void get (float &v) { v = get_double (); } void get (double &v) { v = get_double (); } + void get (bool &i) { i = get_bool (); } void get (sint8 &i) { i = get_sint32 (); } void get (uint8 &i) { i = get_sint32 (); } void get (sint16 &i) { i = get_sint32 (); } @@ -312,9 +480,132 @@ void get (uint32 &i) { i = get_sint64 (); } void get (sint64 &i) { i = get_sint64 (); } + + MTH void parse_warn (const_utf8_string msg); + MTH bool parse_error (const_utf8_string type = 0, const_utf8_string name = 0, bool skip = true); + + struct delayed_ref { + attachable *op; + object_ptr *ptr; + const_utf8_string ref; + }; + std::vector delrefs; + + void delayed_deref (attachable *op, object_ptr &ptr, const_utf8_string ref); + MTH void resolve_delayed_derefs (bool deref = true); }; +//TODO: remove char *fgets (char *s, int n, object_thawer &thawer); +////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +struct coroapi { + static struct CoroAPI *GCoroAPI; + + static EV_ATOMIC_T cede_pending; + + static int nready () { return CORO_NREADY; } + static int cede () { cede_pending = 0; return CORO_CEDE ; } + + static void do_cede_to_tick (); + + // actually cede's far more often + static bool cede_to_tick () + { + if (expect_true (!cede_pending)) + return false; + + do_cede_to_tick (); + return true; + } + + static void wait_for_tick (); + static void wait_for_tick_begin (); +}; + +struct evapi +{ + static struct EVAPI *GEVAPI; +}; + +struct iow : ev_io, evapi, callback +{ + static void thunk (EV_P_ struct ev_io *w_, int revents) + { + iow &w = *static_cast(w_); + + w (w, revents); + } + + template + iow (O object, M method) + : callback (object, method) + { + ev_init ((ev_io *)this, thunk); + } + + void prio (int prio) + { + ev_set_priority ((ev_io *)this, prio); + } + + void set (int fd, int events) + { + ev_io_set ((ev_io *)this, fd, events); + } + + int poll () const { return events; } + + void poll (int events); + + void start () + { + ev_io_start (EV_DEFAULT, (ev_io *)this); + } + + void stop () + { + ev_io_stop (EV_DEFAULT, (ev_io *)this); + } + + ~iow () + { + stop (); + } +}; + +struct asyncw : ev_async, evapi, callback +{ + static void thunk (EV_P_ struct ev_async *w_, int revents) + { + asyncw &w = *static_cast(w_); + + w (w, revents); + } + + template + asyncw (O object, M method) + : callback (object, method) + { + ev_init ((ev_async *)this, thunk); + } + + void start () + { + ev_async_start (EV_DEFAULT, (ev_async *)this); + } + + void stop () + { + ev_async_stop (EV_DEFAULT, (ev_async *)this); + } + + ~asyncw () + { + stop (); + } +}; + #endif