From fccb03227e3f541a4c2f4e0e619074e4c1fb55dd Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Tue, 15 Jan 2013 21:13:22 +0000
Subject: Instead of passing separate engine, part and item components to
script APIs, pass down IScriptInstance instead.
This is to allow the future co-operative script thread terminate feature to detect and act upon termination requests.
This splits the assembly and state loading out from the ScriptInstance() constructor to a separate Load() method
in order to facilititate continued script logic regression testing.
---
.../Region/ScriptEngine/Interfaces/IScriptApi.cs | 10 ++---
.../ScriptEngine/Interfaces/IScriptInstance.cs | 12 +++++
.../Shared/Api/Implementation/LSL_Api.cs | 16 ++++---
.../Shared/Api/Implementation/LS_Api.cs | 13 +++---
.../Shared/Api/Implementation/MOD_Api.cs | 8 ++--
.../Shared/Api/Implementation/OSSL_Api.cs | 8 ++--
.../ScriptEngine/Shared/Instance/ScriptInstance.cs | 52 ++++++++++++----------
.../Shared/Tests/LSL_ApiInventoryTests.cs | 7 +--
.../Shared/Tests/LSL_ApiLinkingTests.cs | 5 ++-
.../ScriptEngine/Shared/Tests/LSL_ApiListTests.cs | 3 +-
.../ScriptEngine/Shared/Tests/LSL_ApiTest.cs | 3 +-
.../Shared/Tests/OSSL_ApiAppearanceTest.cs | 5 ++-
.../Shared/Tests/OSSL_ApiAttachmentTests.cs | 19 +++++---
.../ScriptEngine/Shared/Tests/OSSL_ApiNpcTests.cs | 17 +++----
OpenSim/Region/ScriptEngine/XEngine/XEngine.cs | 10 ++---
prebuild.xml | 1 +
16 files changed, 110 insertions(+), 79 deletions(-)
diff --git a/OpenSim/Region/ScriptEngine/Interfaces/IScriptApi.cs b/OpenSim/Region/ScriptEngine/Interfaces/IScriptApi.cs
index 2027ca6..e95cbd7 100644
--- a/OpenSim/Region/ScriptEngine/Interfaces/IScriptApi.cs
+++ b/OpenSim/Region/ScriptEngine/Interfaces/IScriptApi.cs
@@ -29,6 +29,7 @@ using System;
using OpenMetaverse;
using OpenSim.Framework;
using OpenSim.Region.Framework.Scenes;
+using OpenSim.Region.ScriptEngine.Shared;
namespace OpenSim.Region.ScriptEngine.Interfaces
{
@@ -38,11 +39,8 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
/// Initialize the API
/// </summary>
/// <remarks>
- /// Each API has an identifier, which is used to load the
- /// proper runtime assembly at load time.
- /// <param name='engine'>/param>
- /// <param name='part'></param>
- /// <param name='item'></param>
- void Initialize(IScriptEngine engine, SceneObjectPart part, TaskInventoryItem item);
+ /// Each API has an identifier, which is used to load the proper runtime assembly at load time.
+ /// <param name='scriptInstance'>/param>
+ void Initialize(IScriptInstance scriptInstance);
}
}
\ No newline at end of file
diff --git a/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs b/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
index 2f5b526..9de2d72 100644
--- a/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
+++ b/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
@@ -31,6 +31,7 @@ using System.Collections.Generic;
using OpenMetaverse;
using log4net;
using OpenSim.Framework;
+using OpenSim.Region.Framework.Scenes;
using OpenSim.Region.ScriptEngine.Shared;
using OpenSim.Region.ScriptEngine.Interfaces;
@@ -105,6 +106,11 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
/// </summary>
long MeasurementPeriodExecutionTime { get; }
+ /// <summary>
+ /// Scene part in which this script instance is contained.
+ /// </summary>
+ SceneObjectPart Part { get; }
+
IScriptEngine Engine { get; }
UUID AppDomain { get; set; }
string PrimName { get; }
@@ -124,6 +130,12 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
uint LocalID { get; }
UUID AssetID { get; }
+
+ /// <summary>
+ /// Inventory item containing the script used.
+ /// </summary>
+ TaskInventoryItem ScriptTask { get; }
+
Queue EventQueue { get; }
/// <summary>
diff --git a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs
index ea4e609..44072c6 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs
@@ -110,11 +110,11 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
protected int EMAIL_PAUSE_TIME = 20; // documented delay value for smtp.
protected ISoundModule m_SoundModule = null;
- public void Initialize(IScriptEngine ScriptEngine, SceneObjectPart host, TaskInventoryItem item)
+ public void Initialize(IScriptInstance scriptInstance)
{
- m_ScriptEngine = ScriptEngine;
- m_host = host;
- m_item = item;
+ m_ScriptEngine = scriptInstance.Engine;
+ m_host = scriptInstance.Part;
+ m_item = scriptInstance.ScriptTask;
LoadLimits(); // read script limits from config.
@@ -123,10 +123,12 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
m_UrlModule = m_ScriptEngine.World.RequestModuleInterface<IUrlModule>();
m_SoundModule = m_ScriptEngine.World.RequestModuleInterface<ISoundModule>();
- AsyncCommands = new AsyncCommandManager(ScriptEngine);
+ AsyncCommands = new AsyncCommandManager(m_ScriptEngine);
}
- /* load configuration items that affect script, object and run-time behavior. */
+ /// <summary>
+ /// Load configuration items that affect script, object and run-time behavior. */
+ /// </summary>
private void LoadLimits()
{
m_ScriptDelayFactor =
@@ -141,12 +143,14 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
m_ScriptEngine.Config.GetInt("NotecardLineReadCharsMax", 255);
if (m_notecardLineReadCharsMax > 65535)
m_notecardLineReadCharsMax = 65535;
+
// load limits for particular subsystems.
IConfig SMTPConfig;
if ((SMTPConfig = m_ScriptEngine.ConfigSource.Configs["SMTP"]) != null) {
// there's an smtp config, so load in the snooze time.
EMAIL_PAUSE_TIME = SMTPConfig.GetInt("email_pause_time", EMAIL_PAUSE_TIME);
}
+
// Rezzing an object with a velocity can create recoil. This feature seems to have been
// removed from recent versions of SL. The code computes recoil (vel*mass) and scales
// it by this factor. May be zero to turn off recoil all together.
diff --git a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LS_Api.cs b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LS_Api.cs
index ceb4660..071c60e 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LS_Api.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LS_Api.cs
@@ -61,10 +61,10 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
internal bool m_LSFunctionsEnabled = false;
internal IScriptModuleComms m_comms = null;
- public void Initialize(IScriptEngine ScriptEngine, SceneObjectPart host, TaskInventoryItem item)
+ public void Initialize(IScriptInstance scriptInstance)
{
- m_ScriptEngine = ScriptEngine;
- m_host = host;
+ m_ScriptEngine = scriptInstance.Engine;
+ m_host = scriptInstance.Part;
if (m_ScriptEngine.Config.GetBoolean("AllowLightShareFunctions", false))
m_LSFunctionsEnabled = true;
@@ -92,10 +92,9 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
get { return m_ScriptEngine.World; }
}
- //
- //Dumps an error message on the debug console.
- //
-
+ /// <summary>
+ /// Dumps an error message on the debug console.
+ /// </summary>
internal void LSShoutError(string message)
{
if (message.Length > 1023)
diff --git a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/MOD_Api.cs b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/MOD_Api.cs
index 8f34833..cbc69aa 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/MOD_Api.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/MOD_Api.cs
@@ -61,11 +61,11 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
internal bool m_MODFunctionsEnabled = false;
internal IScriptModuleComms m_comms = null;
- public void Initialize(IScriptEngine ScriptEngine, SceneObjectPart host, TaskInventoryItem item)
+ public void Initialize(IScriptInstance scriptInstance)
{
- m_ScriptEngine = ScriptEngine;
- m_host = host;
- m_item = item;
+ m_ScriptEngine = scriptInstance.Engine;
+ m_host = scriptInstance.Part;
+ m_item = scriptInstance.ScriptTask;
if (m_ScriptEngine.Config.GetBoolean("AllowMODFunctions", false))
m_MODFunctionsEnabled = true;
diff --git a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/OSSL_Api.cs b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/OSSL_Api.cs
index 958a448..33ae5f0 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/OSSL_Api.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/OSSL_Api.cs
@@ -142,11 +142,11 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
protected IUrlModule m_UrlModule = null;
- public void Initialize(IScriptEngine ScriptEngine, SceneObjectPart host, TaskInventoryItem item)
+ public void Initialize(IScriptInstance scriptInstance)
{
- m_ScriptEngine = ScriptEngine;
- m_host = host;
- m_item = item;
+ m_ScriptEngine = scriptInstance.Engine;
+ m_host = scriptInstance.Part;
+ m_item = scriptInstance.ScriptTask;
m_UrlModule = m_ScriptEngine.World.RequestModuleInterface<IUrlModule>();
diff --git a/OpenSim/Region/ScriptEngine/Shared/Instance/ScriptInstance.cs b/OpenSim/Region/ScriptEngine/Shared/Instance/ScriptInstance.cs
index f172216..a2ff51b 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Instance/ScriptInstance.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Instance/ScriptInstance.cs
@@ -157,9 +157,6 @@ namespace OpenSim.Region.ScriptEngine.Shared.Instance
public UUID AppDomain { get; set; }
- /// <summary>
- /// Scene part in which this script instance is contained.
- /// </summary>
public SceneObjectPart Part { get; private set; }
public string PrimName { get; private set; }
@@ -209,43 +206,52 @@ namespace OpenSim.Region.ScriptEngine.Shared.Instance
EventQueue.Clear();
}
- public ScriptInstance(IScriptEngine engine, SceneObjectPart part,
- UUID itemID, UUID assetID, string assembly,
- AppDomain dom, string primName, string scriptName,
- int startParam, bool postOnRez, StateSource stateSource,
- int maxScriptQueue)
+ public ScriptInstance(
+ IScriptEngine engine, SceneObjectPart part, TaskInventoryItem item,
+ int startParam, bool postOnRez,
+ int maxScriptQueue)
{
State = "default";
EventQueue = new Queue(32);
Engine = engine;
Part = part;
- ItemID = itemID;
- AssetID = assetID;
- PrimName = primName;
- ScriptName = scriptName;
- m_Assembly = assembly;
+ ScriptTask = item;
+
+ // This is currently only here to allow regression tests to get away without specifying any inventory
+ // item when they are testing script logic that doesn't require an item.
+ if (ScriptTask != null)
+ {
+ ScriptName = ScriptTask.Name;
+ ItemID = ScriptTask.ItemID;
+ AssetID = ScriptTask.AssetID;
+ }
+
+ PrimName = part.ParentGroup.Name;
StartParam = startParam;
m_MaxScriptQueue = maxScriptQueue;
- m_stateSource = stateSource;
m_postOnRez = postOnRez;
m_AttachedAvatar = Part.ParentGroup.AttachedAvatar;
m_RegionID = Part.ParentGroup.Scene.RegionInfo.RegionID;
+ }
- lock (Part.TaskInventory)
- {
- if (Part.TaskInventory.ContainsKey(ItemID))
- {
- ScriptTask = Part.TaskInventory[ItemID];
- }
- }
+ /// <summary>
+ /// Load the script from an assembly into an AppDomain.
+ /// </summary>
+ /// <param name='dom'></param>
+ /// <param name='assembly'></param>
+ /// <param name='stateSource'></param>
+ public void Load(AppDomain dom, string assembly, StateSource stateSource)
+ {
+ m_Assembly = assembly;
+ m_stateSource = stateSource;
ApiManager am = new ApiManager();
foreach (string api in am.GetApis())
{
m_Apis[api] = am.CreateApi(api);
- m_Apis[api].Initialize(engine, part, ScriptTask);
+ m_Apis[api].Initialize(this);
}
try
@@ -279,7 +285,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Instance
// // m_log.Debug("[Script] Script instance created");
- part.SetScriptEvents(ItemID,
+ Part.SetScriptEvents(ItemID,
(int)m_Script.GetStateEventFlags(State));
}
catch (Exception e)
diff --git a/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiInventoryTests.cs b/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiInventoryTests.cs
index cb7291a..36c7582 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiInventoryTests.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiInventoryTests.cs
@@ -41,6 +41,7 @@ using OpenSim.Region.OptionalModules.World.NPC;
using OpenSim.Region.Framework.Scenes;
using OpenSim.Region.ScriptEngine.Shared;
using OpenSim.Region.ScriptEngine.Shared.Api;
+using OpenSim.Region.ScriptEngine.Shared.Instance;
using OpenSim.Services.Interfaces;
using OpenSim.Tests.Common;
using OpenSim.Tests.Common.Mock;
@@ -93,7 +94,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
TaskInventoryHelpers.AddSceneObject(m_scene, so1.RootPart, inventoryItemName, itemId, userId);
LSL_Api api = new LSL_Api();
- api.Initialize(m_engine, so1.RootPart, null);
+ api.Initialize(new ScriptInstance(m_engine, so1.RootPart, null, 0, false, int.MaxValue));
// Create a second object
SceneObjectGroup so2 = SceneHelpers.CreateSceneObject(1, userId, "so2", 0x100);
@@ -126,7 +127,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
SceneObjectGroup so1 = SceneHelpers.CreateSceneObject(1, user1Id, "so1", 0x10);
m_scene.AddSceneObject(so1);
LSL_Api api = new LSL_Api();
- api.Initialize(m_engine, so1.RootPart, null);
+ api.Initialize(new ScriptInstance(m_engine, so1.RootPart, null, 0, false, int.MaxValue));
// Create an object embedded inside the first
UUID itemId = TestHelpers.ParseTail(0x20);
@@ -136,7 +137,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
SceneObjectGroup so2 = SceneHelpers.CreateSceneObject(1, user2Id, "so2", 0x100);
m_scene.AddSceneObject(so2);
LSL_Api api2 = new LSL_Api();
- api2.Initialize(m_engine, so2.RootPart, null);
+ api2.Initialize(new ScriptInstance(m_engine, so2.RootPart, null, 0, false, int.MaxValue));
// *** Firstly, we test where llAllowInventoryDrop() has not been called. ***
api.llGiveInventory(so2.UUID.ToString(), inventoryItemName);
diff --git a/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiLinkingTests.cs b/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiLinkingTests.cs
index d9b17d7..5121344 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiLinkingTests.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiLinkingTests.cs
@@ -41,6 +41,7 @@ using OpenSim.Region.OptionalModules.World.NPC;
using OpenSim.Region.Framework.Scenes;
using OpenSim.Region.ScriptEngine.Shared;
using OpenSim.Region.ScriptEngine.Shared.Api;
+using OpenSim.Region.ScriptEngine.Shared.Instance;
using OpenSim.Region.ScriptEngine.Shared.ScriptBase;
using OpenSim.Services.Interfaces;
using OpenSim.Tests.Common;
@@ -104,7 +105,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
m_scene.AddSceneObject(grp2);
LSL_Api apiGrp1 = new LSL_Api();
- apiGrp1.Initialize(m_engine, grp1.RootPart, grp1Item);
+ apiGrp1.Initialize(new ScriptInstance(m_engine, grp1.RootPart, grp1Item, 0, false, int.MaxValue));
apiGrp1.llCreateLink(grp2.UUID.ToString(), ScriptBaseClass.TRUE);
@@ -131,7 +132,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
grp1Item.PermsMask |= ScriptBaseClass.PERMISSION_CHANGE_LINKS;
LSL_Api apiGrp1 = new LSL_Api();
- apiGrp1.Initialize(m_engine, grp1.RootPart, grp1Item);
+ apiGrp1.Initialize(new ScriptInstance(m_engine, grp1.RootPart, grp1Item, 0, false, int.MaxValue));
apiGrp1.llBreakLink(2);
diff --git a/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiListTests.cs b/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiListTests.cs
index 98017d8..28e5831 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiListTests.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiListTests.cs
@@ -34,6 +34,7 @@ using OpenSim.Region.ScriptEngine.Shared;
using OpenSim.Region.Framework.Scenes;
using Nini.Config;
using OpenSim.Region.ScriptEngine.Shared.Api;
+using OpenSim.Region.ScriptEngine.Shared.Instance;
using OpenSim.Region.ScriptEngine.Shared.ScriptBase;
using OpenMetaverse;
using OpenSim.Tests.Common.Mock;
@@ -67,7 +68,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
engine.AddRegion(scene);
m_lslApi = new LSL_Api();
- m_lslApi.Initialize(engine, part, null);
+ m_lslApi.Initialize(new ScriptInstance(engine, part, null, 0, false, int.MaxValue));
}
[Test]
diff --git a/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiTest.cs b/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiTest.cs
index c41d1e7..48c2465 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiTest.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Tests/LSL_ApiTest.cs
@@ -33,6 +33,7 @@ using OpenSim.Region.ScriptEngine.Shared;
using OpenSim.Region.Framework.Scenes;
using Nini.Config;
using OpenSim.Region.ScriptEngine.Shared.Api;
+using OpenSim.Region.ScriptEngine.Shared.Instance;
using OpenSim.Region.ScriptEngine.Shared.ScriptBase;
using OpenMetaverse;
using System;
@@ -66,7 +67,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
engine.AddRegion(scene);
m_lslApi = new LSL_Api();
- m_lslApi.Initialize(engine, part, null);
+ m_lslApi.Initialize(new ScriptInstance(engine, part, null, 0, false, int.MaxValue));
}
[Test]
diff --git a/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiAppearanceTest.cs b/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiAppearanceTest.cs
index 1381d2b..5164d4e 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiAppearanceTest.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiAppearanceTest.cs
@@ -41,6 +41,7 @@ using OpenSim.Region.OptionalModules.World.NPC;
using OpenSim.Region.Framework.Scenes;
using OpenSim.Region.ScriptEngine.Shared;
using OpenSim.Region.ScriptEngine.Shared.Api;
+using OpenSim.Region.ScriptEngine.Shared.Instance;
using OpenSim.Services.Interfaces;
using OpenSim.Tests.Common;
using OpenSim.Tests.Common.Mock;
@@ -93,7 +94,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
m_scene.AddSceneObject(so);
OSSL_Api osslApi = new OSSL_Api();
- osslApi.Initialize(m_engine, part, null);
+ osslApi.Initialize(new ScriptInstance(m_engine, part, null, 0, false, int.MaxValue));
string notecardName = "appearanceNc";
@@ -134,7 +135,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
m_scene.AddSceneObject(so);
OSSL_Api osslApi = new OSSL_Api();
- osslApi.Initialize(m_engine, part, null);
+ osslApi.Initialize(new ScriptInstance(m_engine, part, null, 0, false, int.MaxValue));
string notecardName = "appearanceNc";
diff --git a/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiAttachmentTests.cs b/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiAttachmentTests.cs
index 5ed1f3d..e7b3319 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiAttachmentTests.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiAttachmentTests.cs
@@ -41,6 +41,7 @@ using OpenSim.Region.CoreModules.Framework.InventoryAccess;
using OpenSim.Region.Framework.Scenes;
using OpenSim.Region.ScriptEngine.Shared;
using OpenSim.Region.ScriptEngine.Shared.Api;
+using OpenSim.Region.ScriptEngine.Shared.Instance;
using OpenSim.Services.Interfaces;
using OpenSim.Tests.Common;
using OpenSim.Tests.Common.Mock;
@@ -98,9 +99,10 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
SceneObjectGroup inWorldObj = SceneHelpers.AddSceneObject(m_scene, "inWorldObj", ua1.PrincipalID);
TaskInventoryItem scriptItem = TaskInventoryHelpers.AddScript(m_scene, inWorldObj.RootPart);
- new LSL_Api().Initialize(m_engine, inWorldObj.RootPart, scriptItem);
+ ScriptInstance si = new ScriptInstance(m_engine, inWorldObj.RootPart, scriptItem, 0, false, int.MaxValue);
+ new LSL_Api().Initialize(si);
OSSL_Api osslApi = new OSSL_Api();
- osslApi.Initialize(m_engine, inWorldObj.RootPart, scriptItem);
+ osslApi.Initialize(si);
// SceneObjectGroup sog1 = SceneHelpers.CreateSceneObject(1, ua1.PrincipalID);
@@ -144,9 +146,10 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
SceneObjectGroup inWorldObj = SceneHelpers.AddSceneObject(m_scene, "inWorldObj", ua1.PrincipalID);
TaskInventoryItem scriptItem = TaskInventoryHelpers.AddScript(m_scene, inWorldObj.RootPart);
- new LSL_Api().Initialize(m_engine, inWorldObj.RootPart, scriptItem);
+ ScriptInstance si = new ScriptInstance(m_engine, inWorldObj.RootPart, scriptItem, 0, false, int.MaxValue);
+ new LSL_Api().Initialize(si);
OSSL_Api osslApi = new OSSL_Api();
- osslApi.Initialize(m_engine, inWorldObj.RootPart, scriptItem);
+ osslApi.Initialize(si);
// Create an object embedded inside the first
TaskInventoryHelpers.AddNotecard(
@@ -192,12 +195,14 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
SceneObjectGroup inWorldObj = SceneHelpers.AddSceneObject(m_scene, "inWorldObj", ua1.PrincipalID);
TaskInventoryItem scriptItem = TaskInventoryHelpers.AddScript(m_scene, inWorldObj.RootPart);
- new LSL_Api().Initialize(m_engine, inWorldObj.RootPart, scriptItem);
+ ScriptInstance si = new ScriptInstance(m_engine, inWorldObj.RootPart, scriptItem, 0, false, int.MaxValue);
+ new LSL_Api().Initialize(si);
OSSL_Api osslApi = new OSSL_Api();
- osslApi.Initialize(m_engine, inWorldObj.RootPart, scriptItem);
+ osslApi.Initialize(si);
// Create an object embedded inside the first
- TaskInventoryHelpers.AddSceneObject(m_scene, inWorldObj.RootPart, taskInvObjItemName, taskInvObjItemId, ua1.PrincipalID);
+ TaskInventoryHelpers.AddSceneObject(
+ m_scene, inWorldObj.RootPart, taskInvObjItemName, taskInvObjItemId, ua1.PrincipalID);
ScenePresence sp2 = SceneHelpers.AddScenePresence(m_scene, ua2);
diff --git a/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiNpcTests.cs b/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiNpcTests.cs
index d6c82f1..584f44f 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiNpcTests.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Tests/OSSL_ApiNpcTests.cs
@@ -42,6 +42,7 @@ using OpenSim.Region.OptionalModules.World.NPC;
using OpenSim.Region.Framework.Scenes;
using OpenSim.Region.ScriptEngine.Shared;
using OpenSim.Region.ScriptEngine.Shared.Api;
+using OpenSim.Region.ScriptEngine.Shared.Instance;
using OpenSim.Region.ScriptEngine.Shared.ScriptBase;
using OpenSim.Services.Interfaces;
using OpenSim.Tests.Common;
@@ -99,7 +100,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
m_scene.AddSceneObject(so);
OSSL_Api osslApi = new OSSL_Api();
- osslApi.Initialize(m_engine, part, null);
+ osslApi.Initialize(new ScriptInstance(m_engine, part, null, 0, false, int.MaxValue));
string notecardName = "appearanceNc";
osslApi.osOwnerSaveAppearance(notecardName);
@@ -125,7 +126,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
m_scene.AddSceneObject(so);
OSSL_Api osslApi = new OSSL_Api();
- osslApi.Initialize(m_engine, so.RootPart, null);
+ osslApi.Initialize(new ScriptInstance(m_engine, so.RootPart, null, 0, false, int.MaxValue));
bool gotExpectedException = false;
try
@@ -160,7 +161,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
m_scene.AddSceneObject(so);
OSSL_Api osslApi = new OSSL_Api();
- osslApi.Initialize(m_engine, part, null);
+ osslApi.Initialize(new ScriptInstance(m_engine, part, null, 0, false, int.MaxValue));
string notecardName = "appearanceNc";
osslApi.osOwnerSaveAppearance(notecardName);
@@ -194,7 +195,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
m_scene.AddSceneObject(so);
OSSL_Api osslApi = new OSSL_Api();
- osslApi.Initialize(m_engine, part, null);
+ osslApi.Initialize(new ScriptInstance(m_engine, part, null, 0, false, int.MaxValue));
osslApi.osOwnerSaveAppearance(firstAppearanceNcName);
@@ -232,7 +233,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
m_scene.AddSceneObject(so);
OSSL_Api osslApi = new OSSL_Api();
- osslApi.Initialize(m_engine, part, null);
+ osslApi.Initialize(new ScriptInstance(m_engine, part, null, 0, false, int.MaxValue));
osslApi.osOwnerSaveAppearance(firstAppearanceNcName);
@@ -284,10 +285,10 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
m_scene.AddSceneObject(otherSo);
OSSL_Api osslApi = new OSSL_Api();
- osslApi.Initialize(m_engine, part, null);
+ osslApi.Initialize(new ScriptInstance(m_engine, part, null, 0, false, int.MaxValue));
OSSL_Api otherOsslApi = new OSSL_Api();
- otherOsslApi.Initialize(m_engine, otherPart, null);
+ otherOsslApi.Initialize(new ScriptInstance(m_engine, otherPart, null, 0, false, int.MaxValue));
string notecardName = "appearanceNc";
osslApi.osOwnerSaveAppearance(notecardName);
@@ -331,7 +332,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Tests
m_scene.AddSceneObject(so);
OSSL_Api osslApi = new OSSL_Api();
- osslApi.Initialize(m_engine, part, null);
+ osslApi.Initialize(new ScriptInstance(m_engine, part, null, 0, false, int.MaxValue));
string notecardName = "appearanceNc";
osslApi.osOwnerSaveAppearance(notecardName);
diff --git a/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs b/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs
index 8c3bb5b..186ae04 100644
--- a/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs
+++ b/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs
@@ -1284,11 +1284,11 @@ namespace OpenSim.Region.ScriptEngine.XEngine
m_DomainScripts[appDomain].Add(itemID);
instance = new ScriptInstance(this, part,
- itemID, assetID, assembly,
- m_AppDomains[appDomain],
- part.ParentGroup.RootPart.Name,
- item.Name, startParam, postOnRez,
- stateSource, m_MaxScriptQueue);
+ item,
+ startParam, postOnRez,
+ m_MaxScriptQueue);
+
+ instance.Load(m_AppDomains[appDomain], assembly, stateSource);
// if (DebugLevel >= 1)
// m_log.DebugFormat(
diff --git a/prebuild.xml b/prebuild.xml
index 4c18aa8..c6bef5c 100644
--- a/prebuild.xml
+++ b/prebuild.xml
@@ -3285,6 +3285,7 @@
<Reference name="OpenSim.Region.ScriptEngine.Shared"/>
<Reference name="OpenSim.Region.ScriptEngine.Shared.Api"/>
<Reference name="OpenSim.Region.ScriptEngine.Shared.Api.Runtime"/>
+ <Reference name="OpenSim.Region.ScriptEngine.Shared.Instance"/>
<Reference name="OpenSim.Region.ScriptEngine.XEngine"/>
<Reference name="OpenSim.Services.Interfaces"/>
<Reference name="OpenSim.Tests.Common"/>
--
cgit v1.1
From 1b5c41c14ad11325be249ea1cce3c65d4d6a89be Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Wed, 16 Jan 2013 00:12:40 +0000
Subject: Implement co-operative script termination if termination comes during
a script wait event (llSleep(), etc.)
This makes use of EventWaitHandles since various web references indicate that Thread.Interrupt() can also cause runtime instability.
If co-op termination is enabled, then termination sets the wait handle instead of waiting for a timeout before possibly aborting the thread.
This allows the script to cleanly terminate if it's in a llSleep/LL function delay or the next time it enters such a wait without any timeout period.
Co-op termination is not yet testable since checking for termination request within loops that never trigger a wait is not yet implemented.
---
OpenSim/Region/Framework/Scenes/Scene.Inventory.cs | 26 +++-
.../ScriptEngine/Interfaces/IScriptInstance.cs | 13 ++
.../Shared/Api/Implementation/LSL_Api.cs | 31 +++-
OpenSim/Region/ScriptEngine/Shared/Helpers.cs | 18 +++
.../ScriptEngine/Shared/Instance/ScriptInstance.cs | 52 ++++++-
.../Shared/Instance/Tests/CoopTerminationTests.cs | 157 +++++++++++++++++++++
OpenSim/Region/ScriptEngine/XEngine/XEngine.cs | 5 +
prebuild.xml | 5 +-
8 files changed, 293 insertions(+), 14 deletions(-)
create mode 100644 OpenSim/Region/ScriptEngine/Shared/Instance/Tests/CoopTerminationTests.cs
diff --git a/OpenSim/Region/Framework/Scenes/Scene.Inventory.cs b/OpenSim/Region/Framework/Scenes/Scene.Inventory.cs
index 5c8b097..92bf85a 100644
--- a/OpenSim/Region/Framework/Scenes/Scene.Inventory.cs
+++ b/OpenSim/Region/Framework/Scenes/Scene.Inventory.cs
@@ -1738,6 +1738,21 @@ namespace OpenSim.Region.Framework.Scenes
/// <returns>The part where the script was rezzed if successful. False otherwise.</returns>
public SceneObjectPart RezNewScript(UUID agentID, InventoryItemBase itemBase)
{
+ return RezNewScript(
+ agentID,
+ itemBase,
+ "default\n{\n state_entry()\n {\n llSay(0, \"Script running\");\n }\n}");
+ }
+
+ /// <summary>
+ /// Rez a new script from nothing with given script text.
+ /// </summary>
+ /// <param name="remoteClient"></param>
+ /// <param name="itemBase">Template item.</param>
+ /// <param name="scriptText"></param>
+ /// <returns>The part where the script was rezzed if successful. False otherwise.</returns>
+ public SceneObjectPart RezNewScript(UUID agentID, InventoryItemBase itemBase, string scriptText)
+ {
// The part ID is the folder ID!
SceneObjectPart part = GetSceneObjectPart(itemBase.Folder);
if (part == null)
@@ -1757,9 +1772,14 @@ namespace OpenSim.Region.Framework.Scenes
return null;
}
- AssetBase asset = CreateAsset(itemBase.Name, itemBase.Description, (sbyte)itemBase.AssetType,
- Encoding.ASCII.GetBytes("default\n{\n state_entry()\n {\n llSay(0, \"Script running\");\n }\n}"),
- agentID);
+ AssetBase asset
+ = CreateAsset(
+ itemBase.Name,
+ itemBase.Description,
+ (sbyte)itemBase.AssetType,
+ Encoding.ASCII.GetBytes(scriptText),
+ agentID);
+
AssetService.Store(asset);
TaskInventoryItem taskItem = new TaskInventoryItem();
diff --git a/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs b/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
index 9de2d72..38fff52 100644
--- a/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
+++ b/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
@@ -28,6 +28,7 @@
using System;
using System.Collections;
using System.Collections.Generic;
+using System.Threading;
using OpenMetaverse;
using log4net;
using OpenSim.Framework;
@@ -181,6 +182,18 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
void Resume();
/// <summary>
+ /// If true then scripts should look to terminate their threads in co-operation with the script engine rather
+ /// than through Thread.Abort()
+ /// </summary>
+ bool CoopTermination { get; }
+
+ /// <summary>
+ /// Used for script sleeps when we are using co-operative script termination.
+ /// </summary>
+ /// <remarks>null if CoopTermination is not active</remarks>
+ EventWaitHandle CoopSleepHandle { get; }
+
+ /// <summary>
/// Process the next event queued for this script instance.
/// </summary>
/// <returns></returns>
diff --git a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs
index 44072c6..b992efa 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs
@@ -83,6 +83,12 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
public class LSL_Api : MarshalByRefObject, ILSL_Api, IScriptApi
{
private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+ /// <summary>
+ /// Instance of this script.
+ /// </summary>
+ protected IScriptInstance m_scriptInstance;
+
protected IScriptEngine m_ScriptEngine;
protected SceneObjectPart m_host;
@@ -112,11 +118,12 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
public void Initialize(IScriptInstance scriptInstance)
{
- m_ScriptEngine = scriptInstance.Engine;
- m_host = scriptInstance.Part;
- m_item = scriptInstance.ScriptTask;
+ m_scriptInstance = scriptInstance;
+ m_ScriptEngine = m_scriptInstance.Engine;
+ m_host = m_scriptInstance.Part;
+ m_item = m_scriptInstance.ScriptTask;
- LoadLimits(); // read script limits from config.
+ LoadConfig();
m_TransferModule =
m_ScriptEngine.World.RequestModuleInterface<IMessageTransferModule>();
@@ -129,7 +136,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
/// <summary>
/// Load configuration items that affect script, object and run-time behavior. */
/// </summary>
- private void LoadLimits()
+ private void LoadConfig()
{
m_ScriptDelayFactor =
m_ScriptEngine.Config.GetFloat("ScriptDelayFactor", 1.0f);
@@ -175,7 +182,16 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
delay = (int)((float)delay * m_ScriptDelayFactor);
if (delay == 0)
return;
- System.Threading.Thread.Sleep(delay);
+
+ Sleep(delay);
+ }
+
+ protected virtual void Sleep(int delay)
+ {
+ if (!m_scriptInstance.CoopTermination)
+ System.Threading.Thread.Sleep(delay);
+ else if (m_scriptInstance.CoopSleepHandle.WaitOne(delay))
+ throw new ScriptCoopStopException();
}
public Scene World
@@ -2914,7 +2930,8 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
{
// m_log.Info("llSleep snoozing " + sec + "s.");
m_host.AddScriptLPS(1);
- Thread.Sleep((int)(sec * 1000));
+
+ Sleep((int)(sec * 1000));
}
public LSL_Float llGetMass()
diff --git a/OpenSim/Region/ScriptEngine/Shared/Helpers.cs b/OpenSim/Region/ScriptEngine/Shared/Helpers.cs
index 5a58f73..e02d35e 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Helpers.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Helpers.cs
@@ -81,6 +81,24 @@ namespace OpenSim.Region.ScriptEngine.Shared
}
}
+ /// <summary>
+ /// Used to signal when the script is stopping in co-operation with the script engine
+ /// (instead of through Thread.Abort()).
+ /// </summary>
+ [Serializable]
+ public class ScriptCoopStopException : Exception
+ {
+ public ScriptCoopStopException()
+ {
+ }
+
+ protected ScriptCoopStopException(
+ SerializationInfo info,
+ StreamingContext context)
+ {
+ }
+ }
+
public class DetectParams
{
public const int AGENT = 1;
diff --git a/OpenSim/Region/ScriptEngine/Shared/Instance/ScriptInstance.cs b/OpenSim/Region/ScriptEngine/Shared/Instance/ScriptInstance.cs
index a2ff51b..00048a1 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Instance/ScriptInstance.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Instance/ScriptInstance.cs
@@ -200,6 +200,10 @@ namespace OpenSim.Region.ScriptEngine.Shared.Instance
public static readonly long MaxMeasurementPeriod = 30 * TimeSpan.TicksPerMinute;
+ public bool CoopTermination { get; private set; }
+
+ public EventWaitHandle CoopSleepHandle { get; private set; }
+
public void ClearQueue()
{
m_TimerQueued = false;
@@ -233,6 +237,12 @@ namespace OpenSim.Region.ScriptEngine.Shared.Instance
m_postOnRez = postOnRez;
m_AttachedAvatar = Part.ParentGroup.AttachedAvatar;
m_RegionID = Part.ParentGroup.Scene.RegionInfo.RegionID;
+
+ if (Engine.Config.GetString("ScriptStopStrategy", "abort") == "co-op")
+ {
+ CoopTermination = true;
+ CoopSleepHandle = new AutoResetEvent(false);
+ }
}
/// <summary>
@@ -532,9 +542,34 @@ namespace OpenSim.Region.ScriptEngine.Shared.Instance
}
// Wait for the current event to complete.
- if (!m_InSelfDelete && workItem.Wait(new TimeSpan((long)timeout * 100000)))
+ if (!m_InSelfDelete)
{
- return true;
+ if (!CoopTermination)
+ {
+ // If we're not co-operative terminating then try and wait for the event to complete before stopping
+ if (workItem.Wait(new TimeSpan((long)timeout * 100000)))
+ return true;
+ }
+ else
+ {
+ m_log.DebugFormat(
+ "[SCRIPT INSTANCE]: Co-operatively stopping script {0} {1} in {2} {3}",
+ ScriptName, ItemID, PrimName, ObjectID);
+
+ // This will terminate the event on next handle check by the script.
+ CoopSleepHandle.Set();
+
+ // For now, we will wait forever since the event should always cleanly terminate once LSL loop
+ // checking is implemented. May want to allow a shorter timeout option later.
+ if (workItem.Wait(TimeSpan.MaxValue))
+ {
+ m_log.DebugFormat(
+ "[SCRIPT INSTANCE]: Co-operatively stopped script {0} {1} in {2} {3}",
+ ScriptName, ItemID, PrimName, ObjectID);
+
+ return true;
+ }
+ }
}
lock (EventQueue)
@@ -547,6 +582,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Instance
// If the event still hasn't stopped and we the stop isn't the result of script or object removal, then
// forcibly abort the work item (this aborts the underlying thread).
+ // Co-operative termination should never reach this point.
if (!m_InSelfDelete)
{
m_log.DebugFormat(
@@ -786,7 +822,11 @@ namespace OpenSim.Region.ScriptEngine.Shared.Instance
m_InEvent = false;
m_CurrentEvent = String.Empty;
- if ((!(e is TargetInvocationException) || (!(e.InnerException is SelfDeleteException) && !(e.InnerException is ScriptDeleteException))) && !(e is ThreadAbortException))
+ if ((!(e is TargetInvocationException)
+ || (!(e.InnerException is SelfDeleteException)
+ && !(e.InnerException is ScriptDeleteException)
+ && !(e.InnerException is ScriptCoopStopException)))
+ && !(e is ThreadAbortException))
{
try
{
@@ -834,6 +874,12 @@ namespace OpenSim.Region.ScriptEngine.Shared.Instance
m_InSelfDelete = true;
Part.Inventory.RemoveInventoryItem(ItemID);
}
+ else if ((e is TargetInvocationException) && (e.InnerException is ScriptCoopStopException))
+ {
+ m_log.DebugFormat(
+ "[SCRIPT INSTANCE]: Script {0}.{1} in event {2}, state {3} stopped co-operatively.",
+ PrimName, ScriptName, data.EventName, State);
+ }
}
}
}
diff --git a/OpenSim/Region/ScriptEngine/Shared/Instance/Tests/CoopTerminationTests.cs b/OpenSim/Region/ScriptEngine/Shared/Instance/Tests/CoopTerminationTests.cs
new file mode 100644
index 0000000..f3a6cc9
--- /dev/null
+++ b/OpenSim/Region/ScriptEngine/Shared/Instance/Tests/CoopTerminationTests.cs
@@ -0,0 +1,157 @@
+/*
+ * 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 OpenSimulator 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.Threading;
+using Nini.Config;
+using NUnit.Framework;
+using OpenMetaverse;
+using OpenSim.Framework;
+using OpenSim.Region.CoreModules.Scripting.WorldComm;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.ScriptEngine.XEngine;
+using OpenSim.Tests.Common;
+using OpenSim.Tests.Common.Mock;
+
+namespace OpenSim.Region.ScriptEngine.Shared.Instance.Tests
+{
+ /// <summary>
+ /// Test that co-operative script thread termination is working correctly.
+ /// </summary>
+ [TestFixture]
+ public class CoopTerminationTests : OpenSimTestCase
+ {
+ private TestScene m_scene;
+ private OpenSim.Region.ScriptEngine.XEngine.XEngine m_xEngine;
+
+ private AutoResetEvent m_chatEvent = new AutoResetEvent(false);
+ private AutoResetEvent m_stoppedEvent = new AutoResetEvent(false);
+
+ private OSChatMessage m_osChatMessageReceived;
+
+ [TestFixtureSetUp]
+ public void Init()
+ {
+ //AppDomain.CurrentDomain.SetData("APPBASE", Environment.CurrentDirectory + "/bin");
+// Console.WriteLine(AppDomain.CurrentDomain.BaseDirectory);
+ m_xEngine = new OpenSim.Region.ScriptEngine.XEngine.XEngine();
+
+ IniConfigSource configSource = new IniConfigSource();
+
+ IConfig startupConfig = configSource.AddConfig("Startup");
+ startupConfig.Set("DefaultScriptEngine", "XEngine");
+
+ IConfig xEngineConfig = configSource.AddConfig("XEngine");
+ xEngineConfig.Set("Enabled", "true");
+ xEngineConfig.Set("StartDelay", "0");
+
+ // These tests will not run with AppDomainLoading = true, at least on mono. For unknown reasons, the call
+ // to AssemblyResolver.OnAssemblyResolve fails.
+ xEngineConfig.Set("AppDomainLoading", "false");
+
+ xEngineConfig.Set("ScriptStopStrategy", "co-op");
+
+ m_scene = new SceneHelpers().SetupScene("My Test", UUID.Random(), 1000, 1000, configSource);
+ SceneHelpers.SetupSceneModules(m_scene, configSource, m_xEngine);
+ m_scene.StartScripts();
+ }
+
+ /// <summary>
+ /// Test co-operative termination on derez of an object containing a script with a long-running event.
+ /// </summary>
+ /// <remarks>
+ /// TODO: Actually compiling the script is incidental to this test. Really want a way to compile test scripts
+ /// within the build itself.
+ /// </remarks>
+ [Test]
+ public void TestStopOnLongSleep()
+ {
+ TestHelpers.InMethod();
+ TestHelpers.EnableLogging();
+
+ UUID userId = TestHelpers.ParseTail(0x1);
+// UUID objectId = TestHelpers.ParseTail(0x100);
+// UUID itemId = TestHelpers.ParseTail(0x3);
+ string itemName = "TestStopOnObjectDerezLongSleep() Item";
+
+ SceneObjectGroup so = SceneHelpers.CreateSceneObject(1, userId, "TestStopOnObjectDerezLongSleep", 0x100);
+ m_scene.AddNewSceneObject(so, true);
+
+ InventoryItemBase itemTemplate = new InventoryItemBase();
+// itemTemplate.ID = itemId;
+ itemTemplate.Name = itemName;
+ itemTemplate.Folder = so.UUID;
+ itemTemplate.InvType = (int)InventoryType.LSL;
+
+ m_scene.EventManager.OnChatFromWorld += OnChatFromWorld;
+
+ SceneObjectPart partWhereRezzed = m_scene.RezNewScript(userId, itemTemplate,
+@"default
+{
+ state_entry()
+ {
+ llSay(0, ""Thin Lizzy"");
+ llSleep(60);
+ }
+}");
+
+ TaskInventoryItem rezzedItem = partWhereRezzed.Inventory.GetInventoryItem(itemName);
+
+ // Wait for the script to start the event before we try stopping it.
+ m_chatEvent.WaitOne(60000);
+
+ Console.WriteLine("Script started with message [{0}]", m_osChatMessageReceived.Message);
+
+ // FIXME: This is a very poor way of trying to avoid a low-probability race condition where the script
+ // executes llSay() but has not started the sleep before we try to stop it.
+ Thread.Sleep(1000);
+
+ // We need a way of carrying on if StopScript() fail, since it won't return if the script isn't actually
+ // stopped. This kind of multi-threading is far from ideal in a regression test.
+ new Thread(() => { m_xEngine.StopScript(rezzedItem.ItemID); m_stoppedEvent.Set(); }).Start();
+
+ if (!m_stoppedEvent.WaitOne(30000))
+ Assert.Fail("Script did not co-operatively stop.");
+
+ bool running;
+ TaskInventoryItem scriptItem = partWhereRezzed.Inventory.GetInventoryItem(itemName);
+ Assert.That(
+ SceneObjectPartInventory.TryGetScriptInstanceRunning(m_scene, scriptItem, out running), Is.True);
+ Assert.That(running, Is.False);
+ }
+
+ private void OnChatFromWorld(object sender, OSChatMessage oscm)
+ {
+// Console.WriteLine("Got chat [{0}]", oscm.Message);
+
+ m_osChatMessageReceived = oscm;
+ m_chatEvent.Set();
+ }
+ }
+}
\ No newline at end of file
diff --git a/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs b/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs
index 186ae04..a17a018 100644
--- a/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs
+++ b/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs
@@ -1716,9 +1716,14 @@ namespace OpenSim.Region.ScriptEngine.XEngine
IScriptInstance instance = GetInstance(itemID);
if (instance != null)
+ {
instance.Stop(m_WaitForEventCompletionOnScriptStop);
+ }
else
+ {
+// m_log.DebugFormat("[XENGINE]: Could not find script with ID {0} to stop in {1}", itemID, World.Name);
m_runFlags.AddOrUpdate(itemID, false, 240);
+ }
}
public DetectParams GetDetectParams(UUID itemID, int idx)
diff --git a/prebuild.xml b/prebuild.xml
index c6bef5c..abf8f36 100644
--- a/prebuild.xml
+++ b/prebuild.xml
@@ -2417,7 +2417,9 @@
<Reference name="log4net" path="../../../../../bin/"/>
<Files>
- <Match pattern="*.cs" recurse="true"/>
+ <Match pattern="*.cs" recurse="true">
+ <Exclude name="Tests" pattern="Tests"/>
+ </Match>
</Files>
</Project>
@@ -3309,6 +3311,7 @@
<!-- SADLY the way this works means you need to keep adding these paths -->
<Match path="Shared/Tests" pattern="*.cs" recurse="true"/>
<Match path="Shared/CodeTools/Tests" pattern="*.cs" recurse="true"/>
+ <Match path="Shared/Instance/Tests" pattern="*.cs" recurse="true"/>
<Match path="XEngine/Tests" pattern="*.cs" recurse="true"/>
</Files>
</Project>
--
cgit v1.1