Refactor Executor into the script app domain and IScript. This changes

an implicit reference into a proxied one and further reduces memory
consumption of XEngine

OpenSim/Region/ScriptEngine/Interfaces/IScript.cs

@@ -29,6 +29,7 @@ using System;
 using System.Collections;
 using System.Collections.Generic;
 using OpenSim.Region.ScriptEngine.Interfaces;
+using OpenSim.Region.ScriptEngine.Shared.ScriptBase;
 
 namespace OpenSim.Region.ScriptEngine.Shared.ScriptBase
 {
@@ -37,6 +38,8 @@ namespace OpenSim.Region.ScriptEngine.Shared.ScriptBase
         string[] GetApis();
         void InitApi(string name, IScriptApi data);
 
+        int GetStateEventFlags(string state);
+        void ExecuteEvent(string state, string FunctionName, object[] args);
         Dictionary<string,Object> GetVars();
         void SetVars(Dictionary<string,Object> vars);
         void ResetVars();

OpenSim/Region/ScriptEngine/Shared/Api/Runtime/Executor.cs

@@ -27,14 +27,14 @@
 
 using System;
 using System.Collections.Generic;
+using System.Reflection;
 using System.Runtime.Remoting.Lifetime;
 using OpenSim.Region.ScriptEngine.Shared;
 using OpenSim.Region.ScriptEngine.Shared.ScriptBase;
-using OpenSim.Region.ScriptEngine.Interfaces;
 
-namespace OpenSim.Region.ScriptEngine.XEngine
+namespace OpenSim.Region.ScriptEngine.Shared.ScriptBase
 {
-    public abstract class ExecutorBase : MarshalByRefObject
+    public class Executor : MarshalByRefObject
     {
         /// <summary>
         /// Contains the script to execute functions in.
@@ -76,13 +76,13 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             object_rez = 4194304
         }
 
-        /// <summary>
+        // Cache functions by keeping a reference to them in a dictionary
-        /// Create a new instance of ExecutorBase
+        private Dictionary<string, MethodInfo> Events = new Dictionary<string, MethodInfo>();
-        /// </summary>
+        private Dictionary<string, scriptEvents> m_stateEvents = new Dictionary<string, scriptEvents>();
-        /// <param name="Script"></param>
+
-        public ExecutorBase(IScript Script)
+        public Executor(IScript script)
         {
-            m_Script = Script;
+            m_Script = script;
             initEventFlags();
         }
 
@@ -90,7 +90,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
         /// Make sure our object does not timeout when in AppDomain. (Called by ILease base class)
         /// </summary>
         /// <returns></returns>
-        public override Object InitializeLifetimeService()
+        public Object InitializeLifetimeService()
         {
             //Console.WriteLine("Executor: InitializeLifetimeService()");
             //            return null;
@@ -105,37 +105,94 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             return lease;
         }
 
-        /// <summary>
-        /// Get current AppDomain
-        /// </summary>
-        /// <returns>Current AppDomain</returns>
-        public AppDomain GetAppDomain()
-        {
-            return AppDomain.CurrentDomain;
-        }
 
-        /// <summary>
-        /// Execute a specific function/event in script.
-        /// </summary>
-        /// <param name="FunctionName">Name of function to execute</param>
-        /// <param name="args">Arguments to pass to function</param>
-        public void ExecuteEvent(string state, string FunctionName, object[] args)
-        {
-            DoExecuteEvent(state, FunctionName, args);
-        }
-
-        protected abstract void DoExecuteEvent(string state, string FunctionName, object[] args);
-
-        /// <summary>
-        ///  Compute the events handled by the current state of the script
-        /// </summary>
-        /// <returns>state mask</returns>
         public scriptEvents GetStateEventFlags(string state)
         {
-            return DoGetStateEventFlags(state);
+            //Console.WriteLine("Get event flags for " + state);
+
+            // Check to see if we've already computed the flags for this state
+            scriptEvents eventFlags = scriptEvents.None;
+            if (m_stateEvents.ContainsKey(state))
+            {
+                m_stateEvents.TryGetValue(state, out eventFlags);
+                return eventFlags;
+            }
+
+            Type type=m_Script.GetType();
+
+            // Fill in the events for this state, cache the results in the map
+            foreach (KeyValuePair<string, scriptEvents> kvp in m_eventFlagsMap)
+            {
+                string evname = state + "_event_" + kvp.Key;
+                //Console.WriteLine("Trying event "+evname);
+                try
+                {
+                    MethodInfo mi = type.GetMethod(evname);
+                    if (mi != null)
+                    {
+                        //Console.WriteLine("Found handler for " + kvp.Key);
+                        eventFlags |= kvp.Value;
+                    }
+                }
+                catch(Exception)
+                {
+                    //Console.WriteLine("Exeption in GetMethod:\n"+e.ToString());
+                }
+            }
+
+            // Save the flags we just computed and return the result
+            if (eventFlags != 0)
+                m_stateEvents.Add(state, eventFlags);
+
+            //Console.WriteLine("Returning {0:x}", eventFlags);
+            return (eventFlags);
         }
 
-        protected abstract scriptEvents DoGetStateEventFlags(string state);
+        public void ExecuteEvent(string state, string FunctionName, object[] args)
+        {
+            // IMPORTANT: Types and MemberInfo-derived objects require a LOT of memory.
+            // Instead use RuntimeTypeHandle, RuntimeFieldHandle and RunTimeHandle (IntPtr) instead!
+
+            string EventName = state + "_event_" + FunctionName;
+
+//#if DEBUG
+//            Console.WriteLine("ScriptEngine: Script event function name: " + EventName);
+//#endif
+
+            if (Events.ContainsKey(EventName) == false)
+            {
+                // Not found, create
+                Type type = m_Script.GetType();
+                try
+                {
+                    MethodInfo mi = type.GetMethod(EventName);
+                    Events.Add(EventName, mi);
+                }
+                catch
+                {
+                    Console.WriteLine("Event {0}not found", EventName);
+                    // Event name not found, cache it as not found
+                    Events.Add(EventName, null);
+                }
+            }
+
+            // Get event
+            MethodInfo ev = null;
+            Events.TryGetValue(EventName, out ev);
+
+            if (ev == null) // No event by that name!
+            {
+                //Console.WriteLine("ScriptEngine Can not find any event named: \String.Empty + EventName + "\String.Empty);
+                return;
+            }
+
+//cfk 2-7-08 dont need this right now and the default Linux build has DEBUG defined
+#if DEBUG
+            //Console.WriteLine("ScriptEngine: Executing function name: " + EventName);
+#endif
+            // Found
+            ev.Invoke(m_Script, args);
+        }
 
         protected void initEventFlags()
         {

OpenSim/Region/ScriptEngine/Shared/Api/Runtime/OpenSim.Region.ScriptEngine.Shared.Api.Runtime.mdp

@@ -17,6 +17,7 @@
     <excludeFiles />
   </DeploymentInformation>
   <Contents>
+    <File name="./Executor.cs" subtype="Code" buildaction="Compile" dependson="" data="" />
     <File name="./LSL_Constants.cs" subtype="Code" buildaction="Compile" dependson="" data="" />
     <File name="./LSL_Stub.cs" subtype="Code" buildaction="Compile" dependson="" data="" />
     <File name="./OSSL_Stub.cs" subtype="Code" buildaction="Compile" dependson="" data="" />

OpenSim/Region/ScriptEngine/Shared/Api/Runtime/ScriptBase.cs

@@ -56,6 +56,8 @@ namespace OpenSim.Region.ScriptEngine.Shared.ScriptBase
 
         public ScriptBaseClass()
         {
+            m_Executor = new Executor(this);
+
             MethodInfo[] myArrayMethodInfo = GetType().GetMethods(BindingFlags.Public|BindingFlags.Instance);
 
             foreach (MethodInfo mi in myArrayMethodInfo)
@@ -68,6 +70,18 @@ namespace OpenSim.Region.ScriptEngine.Shared.ScriptBase
             }
         }
 
+        private Executor m_Executor = null;
+
+        public int GetStateEventFlags(string state)
+        {
+            return (int)m_Executor.GetStateEventFlags(state);
+        }
+
+        public void ExecuteEvent(string state, string FunctionName, object[] args)
+        {
+            m_Executor.ExecuteEvent(state, FunctionName, args);
+        }
+
         public string[] GetApis()
         {
             string[] apis = new string[inits.Count];

OpenSim/Region/ScriptEngine/XEngine/Executor.cs

@@ -1,136 +0,0 @@
-/*
- * Copyright (c) Contributors, http://opensimulator.org/
- * See CONTRIBUTORS.TXT for a full list of copyright holders.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in the
- *       documentation and/or other materials provided with the distribution.
- *     * Neither the name of the OpenSim Project nor the
- *       names of its contributors may be used to endorse or promote products
- *       derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-using System;
-using System.Collections.Generic;
-using System.Reflection;
-using OpenSim.Region.ScriptEngine.Shared;
-using OpenSim.Region.ScriptEngine.Shared.ScriptBase;
-
-namespace OpenSim.Region.ScriptEngine.XEngine
-{
-    public class Executor : ExecutorBase
-    {
-        // Cache functions by keeping a reference to them in a dictionary
-        private Dictionary<string, MethodInfo> Events = new Dictionary<string, MethodInfo>();
-        private Dictionary<string, scriptEvents> m_stateEvents = new Dictionary<string, scriptEvents>();
-
-        public Executor(IScript script) : base(script)
-        {
-            initEventFlags();
-        }
-
-
-        protected override scriptEvents DoGetStateEventFlags(string state)
-        {
-            //Console.WriteLine("Get event flags for " + state);
-
-            // Check to see if we've already computed the flags for this state
-            scriptEvents eventFlags = scriptEvents.None;
-            if (m_stateEvents.ContainsKey(state))
-            {
-                m_stateEvents.TryGetValue(state, out eventFlags);
-                return eventFlags;
-            }
-
-            Type type=m_Script.GetType();
-
-            // Fill in the events for this state, cache the results in the map
-            foreach (KeyValuePair<string, scriptEvents> kvp in m_eventFlagsMap)
-            {
-                string evname = state + "_event_" + kvp.Key;
-                //Console.WriteLine("Trying event "+evname);
-                try
-                {
-                    MethodInfo mi = type.GetMethod(evname);
-                    if (mi != null)
-                    {
-                        //Console.WriteLine("Found handler for " + kvp.Key);
-                        eventFlags |= kvp.Value;
-                    }
-                }
-                catch(Exception)
-                {
-                    //Console.WriteLine("Exeption in GetMethod:\n"+e.ToString());
-                }
-            }
-
-            // Save the flags we just computed and return the result
-            if (eventFlags != 0)
-                m_stateEvents.Add(state, eventFlags);
-
-            //Console.WriteLine("Returning {0:x}", eventFlags);
-            return (eventFlags);
-        }
-
-        protected override void DoExecuteEvent(string state, string FunctionName, object[] args)
-        {
-            // IMPORTANT: Types and MemberInfo-derived objects require a LOT of memory.
-            // Instead use RuntimeTypeHandle, RuntimeFieldHandle and RunTimeHandle (IntPtr) instead!
-
-            string EventName = state + "_event_" + FunctionName;
-
-//#if DEBUG
-//            Console.WriteLine("ScriptEngine: Script event function name: " + EventName);
-//#endif
-
-            if (Events.ContainsKey(EventName) == false)
-            {
-                // Not found, create
-                Type type = m_Script.GetType();
-                try
-                {
-                    MethodInfo mi = type.GetMethod(EventName);
-                    Events.Add(EventName, mi);
-                }
-                catch
-                {
-                    Console.WriteLine("Event {0}not found", EventName);
-                    // Event name not found, cache it as not found
-                    Events.Add(EventName, null);
-                }
-            }
-
-            // Get event
-            MethodInfo ev = null;
-            Events.TryGetValue(EventName, out ev);
-
-            if (ev == null) // No event by that name!
-            {
-                //Console.WriteLine("ScriptEngine Can not find any event named: \String.Empty + EventName + "\String.Empty);
-                return;
-            }
-
-//cfk 2-7-08 dont need this right now and the default Linux build has DEBUG defined
-#if DEBUG
-            //Console.WriteLine("ScriptEngine: Executing function name: " + EventName);
-#endif
-            // Found
-            ev.Invoke(m_Script, args);
-        }
-    }
-}

OpenSim/Region/ScriptEngine/XEngine/XEngine.cs

@@ -863,7 +863,6 @@ namespace OpenSim.Region.ScriptEngine.XEngine
         private LLUUID m_ObjectID;
         private LLUUID m_AssetID;
         private IScript m_Script;
-        private Executor m_Executor;
         private LLUUID m_AppDomain;
         private DetectParams[] m_DetectParams;
         private bool m_TimerQueued;
@@ -1009,12 +1008,10 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                     m_Script.InitApi(kv.Key, kv.Value);
                 }
 
-                m_Executor = new Executor(m_Script);
-
 //                m_Engine.Log.Debug("[XEngine] Script instance created");
 
                 part.SetScriptEvents(m_ItemID,
-                                     (int)m_Executor.GetStateEventFlags(State));
+                                     (int)m_Script.GetStateEventFlags(State));
             }
             catch (Exception e)
             {
@@ -1274,7 +1271,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                 if (part != null)
                 {
                     part.SetScriptEvents(m_ItemID,
-                                         (int)m_Executor.GetStateEventFlags(State));
+                                         (int)m_Script.GetStateEventFlags(State));
                 }
             }
             else
@@ -1290,7 +1287,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                     m_EventStart = DateTime.Now;
                     m_InEvent = true;
 
-                    m_Executor.ExecuteEvent(State, data.EventName, data.Params);
+                    m_Script.ExecuteEvent(State, data.EventName, data.Params);
 
                     m_InEvent = false;
                     m_CurrentEvent = String.Empty;