OpenSim
/
OpenSimMirror
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Implement non-wait co-operative termination of scripts for XEngine in addition to termination on wait. 

This involves inserting opensim_reserved_CheckForCoopTermination() calls in lsl -> c# translation at any place where the script could be in a loop with no wait calls.
These places are for, while, do-while, label, user function call and manual event function call.
Call goes through to an XEngineScriptBase which extends ScriptBase.
IEngine is extended to supply necessary engine-specific parent class references and constructor parameters to Compiler.
Unfortunately, since XEngineScriptBase has to be passed WaitHandle in its constructor, older compiled scripts will fail to load with an error on the OpenSim console.
Such scripts will need to be recompiled, either by removing all *.dll files from the bin/ScriptEngines/<region-id> or by setting DeleteScriptsOnStartup = true in [XEngine] for one run.
Automatic recompilation may be implemented in a later commit.
This feature should not yet be used, default remains termination with Thread.Abort() which will work as normal once scripts are recompiled.
user_profiles
Justin Clark-Casey (justincc) 2013-01-17 23:39:09 +00:00
parent 9c99ed26eb
commit c8afc8523b
8 changed files with 307 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs
View File

@ -25,16 +25,17 @@
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
using log4net;
using System; using System;
using OpenSim.Region.ScriptEngine.Shared; using System.Reflection;
using OpenSim.Framework;
using OpenSim.Region.Framework.Scenes; using OpenSim.Region.Framework.Scenes;
using OpenSim.Region.Framework.Interfaces; using OpenSim.Region.Framework.Interfaces;
using OpenMetaverse;
using Nini.Config;
using OpenSim.Region.ScriptEngine.Interfaces; using OpenSim.Region.ScriptEngine.Interfaces;
using OpenSim.Region.ScriptEngine.Shared;
using Amib.Threading; using Amib.Threading;
using OpenSim.Framework; using log4net;
using Nini.Config;
using OpenMetaverse;
namespace OpenSim.Region.ScriptEngine.Interfaces namespace OpenSim.Region.ScriptEngine.Interfaces
{ {
@ -76,6 +77,30 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
IConfigSource ConfigSource { get; } IConfigSource ConfigSource { get; }
string ScriptEngineName { get; } string ScriptEngineName { get; }
string ScriptEnginePath { get; } string ScriptEnginePath { get; }
/// <summary>
/// Return the name of the base class that will be used for all running scripts.
/// </summary>
string ScriptBaseClassName { get; }
/// <summary>
/// Assemblies that need to be referenced when compiling scripts.
/// </summary>
/// <remarks>
/// These are currently additional to those always referenced by the compiler, BUT THIS MAY CHANGE IN THE
/// FUTURE.
/// This can be null if there are no additional assemblies.
/// </remarks>
string[] ScriptReferencedAssemblies { get; }
/// <summary>
/// Parameters for the generated script's constructor.
/// </summary>
/// <remarks>
/// Can be null if there are no parameters
/// </remarks>
ParameterInfo[] ScriptBaseClassParameters { get; }
IScriptApi GetApi(UUID itemID, string name); IScriptApi GetApi(UUID itemID, string name);
} }
} }

12
OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs
View File

@ -192,7 +192,17 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
{ {
if (m_coopSleepHandle == null) if (m_coopSleepHandle == null)
System.Threading.Thread.Sleep(delay); System.Threading.Thread.Sleep(delay);
else if (m_coopSleepHandle.WaitOne(delay)) else
CheckForCoopTermination(delay);
}
/// <summary>
/// Check for co-operative termination.
/// </summary>
/// <param name='delay'>If called with 0, then just the check is performed with no wait.</param>
protected virtual void CheckForCoopTermination(int delay)
{
if (m_coopSleepHandle.WaitOne(delay))
throw new ScriptCoopStopException(); throw new ScriptCoopStopException();
} }

131
OpenSim/Region/ScriptEngine/Shared/CodeTools/CSCodeGenerator.cs
View File

@ -49,6 +49,18 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
private List<string> m_warnings = new List<string>(); private List<string> m_warnings = new List<string>();
private IScriptModuleComms m_comms = null; private IScriptModuleComms m_comms = null;
private bool m_insertCoopTerminationChecks;
private static string m_coopTerminationCheck = "opensim_reserved_CheckForCoopTermination();";
/// <summary>
/// Keep a record of the previous node when we do the parsing.
/// </summary>
/// <remarks>
/// We do this here because the parser generated by CSTools does not retain a reference to its parent node.
/// The previous node is required so we can correctly insert co-op termination checks when required.
/// </remarks>
// private SYMBOL m_previousNode;
/// <summary> /// <summary>
/// Creates an 'empty' CSCodeGenerator instance. /// Creates an 'empty' CSCodeGenerator instance.
/// </summary> /// </summary>
@ -58,9 +70,10 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
ResetCounters(); ResetCounters();
} }
public CSCodeGenerator(IScriptModuleComms comms) public CSCodeGenerator(IScriptModuleComms comms, bool insertCoopTerminationChecks)
{ {
m_comms = comms; m_comms = comms;
m_insertCoopTerminationChecks = insertCoopTerminationChecks;
ResetCounters(); ResetCounters();
} }
@ -155,7 +168,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
// here's the payload // here's the payload
retstr += GenerateLine(); retstr += GenerateLine();
foreach (SYMBOL s in m_astRoot.kids) foreach (SYMBOL s in m_astRoot.kids)
retstr += GenerateNode(s); retstr += GenerateNode(m_astRoot, s);
// close braces! // close braces!
m_braceCount--; m_braceCount--;
@ -191,9 +204,10 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
/// Recursively called to generate each type of node. Will generate this /// Recursively called to generate each type of node. Will generate this
/// node, then all it's children. /// node, then all it's children.
/// </summary> /// </summary>
/// <param name="previousSymbol">The parent node.</param>
/// <param name="s">The current node to generate code for.</param> /// <param name="s">The current node to generate code for.</param>
/// <returns>String containing C# code for SYMBOL s.</returns> /// <returns>String containing C# code for SYMBOL s.</returns>
private string GenerateNode(SYMBOL s) private string GenerateNode(SYMBOL previousSymbol, SYMBOL s)
{ {
string retstr = String.Empty; string retstr = String.Empty;
@ -207,11 +221,11 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
else if (s is State) else if (s is State)
retstr += GenerateState((State) s); retstr += GenerateState((State) s);
else if (s is CompoundStatement) else if (s is CompoundStatement)
retstr += GenerateCompoundStatement((CompoundStatement) s); retstr += GenerateCompoundStatement(previousSymbol, (CompoundStatement) s);
else if (s is Declaration) else if (s is Declaration)
retstr += GenerateDeclaration((Declaration) s); retstr += GenerateDeclaration((Declaration) s);
else if (s is Statement) else if (s is Statement)
retstr += GenerateStatement((Statement) s); retstr += GenerateStatement(previousSymbol, (Statement) s);
else if (s is ReturnStatement) else if (s is ReturnStatement)
retstr += GenerateReturnStatement((ReturnStatement) s); retstr += GenerateReturnStatement((ReturnStatement) s);
else if (s is JumpLabel) else if (s is JumpLabel)
@ -261,7 +275,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
else else
{ {
foreach (SYMBOL kid in s.kids) foreach (SYMBOL kid in s.kids)
retstr += GenerateNode(kid); retstr += GenerateNode(s, kid);
} }
return retstr; return retstr;
@ -295,7 +309,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
retstr += GenerateLine(")"); retstr += GenerateLine(")");
foreach (SYMBOL kid in remainingKids) foreach (SYMBOL kid in remainingKids)
retstr += GenerateNode(kid); retstr += GenerateNode(gf, kid);
return retstr; return retstr;
} }
@ -312,7 +326,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
foreach (SYMBOL s in gv.kids) foreach (SYMBOL s in gv.kids)
{ {
retstr += Indent(); retstr += Indent();
retstr += GenerateNode(s); retstr += GenerateNode(gv, s);
retstr += GenerateLine(";"); retstr += GenerateLine(";");
} }
@ -365,7 +379,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
retstr += GenerateLine(")"); retstr += GenerateLine(")");
foreach (SYMBOL kid in remainingKids) foreach (SYMBOL kid in remainingKids)
retstr += GenerateNode(kid); retstr += GenerateNode(se, kid);
return retstr; return retstr;
} }
@ -404,7 +418,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
foreach (SYMBOL s in al.kids) foreach (SYMBOL s in al.kids)
{ {
retstr += GenerateNode(s); retstr += GenerateNode(al, s);
if (0 < comma--) if (0 < comma--)
retstr += Generate(", "); retstr += Generate(", ");
} }
@ -417,7 +431,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
/// </summary> /// </summary>
/// <param name="cs">The CompoundStatement node.</param> /// <param name="cs">The CompoundStatement node.</param>
/// <returns>String containing C# code for CompoundStatement cs.</returns> /// <returns>String containing C# code for CompoundStatement cs.</returns>
private string GenerateCompoundStatement(CompoundStatement cs) private string GenerateCompoundStatement(SYMBOL previousSymbol, CompoundStatement cs)
{ {
string retstr = String.Empty; string retstr = String.Empty;
@ -425,8 +439,19 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
retstr += GenerateIndentedLine("{"); retstr += GenerateIndentedLine("{");
m_braceCount++; m_braceCount++;
if (m_insertCoopTerminationChecks)
{
// We have to check in event functions as well because the user can manually call these.
if (previousSymbol is GlobalFunctionDefinition
|| previousSymbol is WhileStatement
|| previousSymbol is DoWhileStatement
|| previousSymbol is ForLoopStatement
|| previousSymbol is StateEvent)
retstr += GenerateIndentedLine(m_coopTerminationCheck);
}
foreach (SYMBOL kid in cs.kids) foreach (SYMBOL kid in cs.kids)
retstr += GenerateNode(kid); retstr += GenerateNode(cs, kid);
// closing brace // closing brace
m_braceCount--; m_braceCount--;
@ -450,13 +475,24 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
/// </summary> /// </summary>
/// <param name="s">The Statement node.</param> /// <param name="s">The Statement node.</param>
/// <returns>String containing C# code for Statement s.</returns> /// <returns>String containing C# code for Statement s.</returns>
private string GenerateStatement(Statement s) private string GenerateStatement(SYMBOL previousSymbol, Statement s)
{ {
string retstr = String.Empty; string retstr = String.Empty;
bool printSemicolon = true; bool printSemicolon = true;
retstr += Indent(); retstr += Indent();
if (m_insertCoopTerminationChecks)
{
// We have to check in event functions as well because the user can manually call these.
if (previousSymbol is GlobalFunctionDefinition
|| previousSymbol is WhileStatement
|| previousSymbol is DoWhileStatement
|| previousSymbol is ForLoop
|| previousSymbol is StateEvent)
retstr += Generate(m_coopTerminationCheck);
}
if (0 < s.kids.Count) if (0 < s.kids.Count)
{ {
// Jump label prints its own colon, we don't need a semicolon. // Jump label prints its own colon, we don't need a semicolon.
@ -466,7 +502,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
// (MONO) error. // (MONO) error.
if (!(s.kids.Top is IdentExpression && 1 == s.kids.Count)) if (!(s.kids.Top is IdentExpression && 1 == s.kids.Count))
foreach (SYMBOL kid in s.kids) foreach (SYMBOL kid in s.kids)
retstr += GenerateNode(kid); retstr += GenerateNode(s, kid);
} }
if (printSemicolon) if (printSemicolon)
@ -487,10 +523,10 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
List<string> identifiers = new List<string>(); List<string> identifiers = new List<string>();
checkForMultipleAssignments(identifiers, a); checkForMultipleAssignments(identifiers, a);
retstr += GenerateNode((SYMBOL) a.kids.Pop()); retstr += GenerateNode(a, (SYMBOL) a.kids.Pop());
retstr += Generate(String.Format(" {0} ", a.AssignmentType), a); retstr += Generate(String.Format(" {0} ", a.AssignmentType), a);
foreach (SYMBOL kid in a.kids) foreach (SYMBOL kid in a.kids)
retstr += GenerateNode(kid); retstr += GenerateNode(a, kid);
return retstr; return retstr;
} }
@ -563,7 +599,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
retstr += Generate("return ", rs); retstr += Generate("return ", rs);
foreach (SYMBOL kid in rs.kids) foreach (SYMBOL kid in rs.kids)
retstr += GenerateNode(kid); retstr += GenerateNode(rs, kid);
return retstr; return retstr;
} }
@ -575,7 +611,14 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
/// <returns>String containing C# code for JumpLabel jl.</returns> /// <returns>String containing C# code for JumpLabel jl.</returns>
private string GenerateJumpLabel(JumpLabel jl) private string GenerateJumpLabel(JumpLabel jl)
{ {
return Generate(String.Format("{0}:", CheckName(jl.LabelName)), jl) + " NoOp();\n"; string labelStatement;
if (m_insertCoopTerminationChecks)
labelStatement = m_coopTerminationCheck + "\n";
else
labelStatement = "NoOp();\n";
return Generate(String.Format("{0}: ", CheckName(jl.LabelName)), jl) + labelStatement;
} }
/// <summary> /// <summary>
@ -598,14 +641,14 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
string retstr = String.Empty; string retstr = String.Empty;
retstr += GenerateIndented("if (", ifs); retstr += GenerateIndented("if (", ifs);
retstr += GenerateNode((SYMBOL) ifs.kids.Pop()); retstr += GenerateNode(ifs, (SYMBOL) ifs.kids.Pop());
retstr += GenerateLine(")"); retstr += GenerateLine(")");
// CompoundStatement handles indentation itself but we need to do it // CompoundStatement handles indentation itself but we need to do it
// otherwise. // otherwise.
bool indentHere = ifs.kids.Top is Statement; bool indentHere = ifs.kids.Top is Statement;
if (indentHere) m_braceCount++; if (indentHere) m_braceCount++;
retstr += GenerateNode((SYMBOL) ifs.kids.Pop()); retstr += GenerateNode(ifs, (SYMBOL) ifs.kids.Pop());
if (indentHere) m_braceCount--; if (indentHere) m_braceCount--;
if (0 < ifs.kids.Count) // do it again for an else if (0 < ifs.kids.Count) // do it again for an else
@ -614,7 +657,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
indentHere = ifs.kids.Top is Statement; indentHere = ifs.kids.Top is Statement;
if (indentHere) m_braceCount++; if (indentHere) m_braceCount++;
retstr += GenerateNode((SYMBOL) ifs.kids.Pop()); retstr += GenerateNode(ifs, (SYMBOL) ifs.kids.Pop());
if (indentHere) m_braceCount--; if (indentHere) m_braceCount--;
} }
@ -641,14 +684,14 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
string retstr = String.Empty; string retstr = String.Empty;
retstr += GenerateIndented("while (", ws); retstr += GenerateIndented("while (", ws);
retstr += GenerateNode((SYMBOL) ws.kids.Pop()); retstr += GenerateNode(ws, (SYMBOL) ws.kids.Pop());
retstr += GenerateLine(")"); retstr += GenerateLine(")");
// CompoundStatement handles indentation itself but we need to do it // CompoundStatement handles indentation itself but we need to do it
// otherwise. // otherwise.
bool indentHere = ws.kids.Top is Statement; bool indentHere = ws.kids.Top is Statement;
if (indentHere) m_braceCount++; if (indentHere) m_braceCount++;
retstr += GenerateNode((SYMBOL) ws.kids.Pop()); retstr += GenerateNode(ws, (SYMBOL) ws.kids.Pop());
if (indentHere) m_braceCount--; if (indentHere) m_braceCount--;
return retstr; return retstr;
@ -669,11 +712,11 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
// otherwise. // otherwise.
bool indentHere = dws.kids.Top is Statement; bool indentHere = dws.kids.Top is Statement;
if (indentHere) m_braceCount++; if (indentHere) m_braceCount++;
retstr += GenerateNode((SYMBOL) dws.kids.Pop()); retstr += GenerateNode(dws, (SYMBOL) dws.kids.Pop());
if (indentHere) m_braceCount--; if (indentHere) m_braceCount--;
retstr += GenerateIndented("while (", dws); retstr += GenerateIndented("while (", dws);
retstr += GenerateNode((SYMBOL) dws.kids.Pop()); retstr += GenerateNode(dws, (SYMBOL) dws.kids.Pop());
retstr += GenerateLine(");"); retstr += GenerateLine(");");
return retstr; return retstr;
@ -702,7 +745,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
retstr += Generate("; "); retstr += Generate("; ");
// for (x = 0; x < 10; x++) // for (x = 0; x < 10; x++)
// ^^^^^^ // ^^^^^^
retstr += GenerateNode((SYMBOL) fl.kids.Pop()); retstr += GenerateNode(fl, (SYMBOL) fl.kids.Pop());
retstr += Generate("; "); retstr += Generate("; ");
// for (x = 0; x < 10; x++) // for (x = 0; x < 10; x++)
// ^^^ // ^^^
@ -713,7 +756,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
// otherwise. // otherwise.
bool indentHere = fl.kids.Top is Statement; bool indentHere = fl.kids.Top is Statement;
if (indentHere) m_braceCount++; if (indentHere) m_braceCount++;
retstr += GenerateNode((SYMBOL) fl.kids.Pop()); retstr += GenerateNode(fl, (SYMBOL) fl.kids.Pop());
if (indentHere) m_braceCount--; if (indentHere) m_braceCount--;
return retstr; return retstr;
@ -758,7 +801,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
while (s is ParenthesisExpression) while (s is ParenthesisExpression)
s = (SYMBOL)s.kids.Pop(); s = (SYMBOL)s.kids.Pop();
retstr += GenerateNode(s); retstr += GenerateNode(fls, s);
if (0 < comma--) if (0 < comma--)
retstr += Generate(", "); retstr += Generate(", ");
} }
@ -779,20 +822,20 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
{ {
// special case handling for logical and/or, see Mantis 3174 // special case handling for logical and/or, see Mantis 3174
retstr += "((bool)("; retstr += "((bool)(";
retstr += GenerateNode((SYMBOL)be.kids.Pop()); retstr += GenerateNode(be, (SYMBOL)be.kids.Pop());
retstr += "))"; retstr += "))";
retstr += Generate(String.Format(" {0} ", be.ExpressionSymbol.Substring(0,1)), be); retstr += Generate(String.Format(" {0} ", be.ExpressionSymbol.Substring(0,1)), be);
retstr += "((bool)("; retstr += "((bool)(";
foreach (SYMBOL kid in be.kids) foreach (SYMBOL kid in be.kids)
retstr += GenerateNode(kid); retstr += GenerateNode(be, kid);
retstr += "))"; retstr += "))";
} }
else else
{ {
retstr += GenerateNode((SYMBOL)be.kids.Pop()); retstr += GenerateNode(be, (SYMBOL)be.kids.Pop());
retstr += Generate(String.Format(" {0} ", be.ExpressionSymbol), be); retstr += Generate(String.Format(" {0} ", be.ExpressionSymbol), be);
foreach (SYMBOL kid in be.kids) foreach (SYMBOL kid in be.kids)
retstr += GenerateNode(kid); retstr += GenerateNode(be, kid);
} }
return retstr; return retstr;
@ -808,7 +851,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
string retstr = String.Empty; string retstr = String.Empty;
retstr += Generate(ue.UnarySymbol, ue); retstr += Generate(ue.UnarySymbol, ue);
retstr += GenerateNode((SYMBOL) ue.kids.Pop()); retstr += GenerateNode(ue, (SYMBOL) ue.kids.Pop());
return retstr; return retstr;
} }
@ -824,7 +867,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
retstr += Generate("("); retstr += Generate("(");
foreach (SYMBOL kid in pe.kids) foreach (SYMBOL kid in pe.kids)
retstr += GenerateNode(kid); retstr += GenerateNode(pe, kid);
retstr += Generate(")"); retstr += Generate(")");
return retstr; return retstr;
@ -861,7 +904,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
// we wrap all typecasted statements in parentheses // we wrap all typecasted statements in parentheses
retstr += Generate(String.Format("({0}) (", te.TypecastType), te); retstr += Generate(String.Format("({0}) (", te.TypecastType), te);
retstr += GenerateNode((SYMBOL) te.kids.Pop()); retstr += GenerateNode(te, (SYMBOL) te.kids.Pop());
retstr += Generate(")"); retstr += Generate(")");
return retstr; return retstr;
@ -931,7 +974,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
} }
foreach (SYMBOL kid in fc.kids) foreach (SYMBOL kid in fc.kids)
retstr += GenerateNode(kid); retstr += GenerateNode(fc, kid);
retstr += Generate(")"); retstr += Generate(")");
@ -980,11 +1023,11 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
string retstr = String.Empty; string retstr = String.Empty;
retstr += Generate(String.Format("new {0}(", vc.Type), vc); retstr += Generate(String.Format("new {0}(", vc.Type), vc);
retstr += GenerateNode((SYMBOL) vc.kids.Pop()); retstr += GenerateNode(vc, (SYMBOL) vc.kids.Pop());
retstr += Generate(", "); retstr += Generate(", ");
retstr += GenerateNode((SYMBOL) vc.kids.Pop()); retstr += GenerateNode(vc, (SYMBOL) vc.kids.Pop());
retstr += Generate(", "); retstr += Generate(", ");
retstr += GenerateNode((SYMBOL) vc.kids.Pop()); retstr += GenerateNode(vc, (SYMBOL) vc.kids.Pop());
retstr += Generate(")"); retstr += Generate(")");
return retstr; return retstr;
@ -1000,13 +1043,13 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
string retstr = String.Empty; string retstr = String.Empty;
retstr += Generate(String.Format("new {0}(", rc.Type), rc); retstr += Generate(String.Format("new {0}(", rc.Type), rc);
retstr += GenerateNode((SYMBOL) rc.kids.Pop()); retstr += GenerateNode(rc, (SYMBOL) rc.kids.Pop());
retstr += Generate(", "); retstr += Generate(", ");
retstr += GenerateNode((SYMBOL) rc.kids.Pop()); retstr += GenerateNode(rc, (SYMBOL) rc.kids.Pop());
retstr += Generate(", "); retstr += Generate(", ");
retstr += GenerateNode((SYMBOL) rc.kids.Pop()); retstr += GenerateNode(rc, (SYMBOL) rc.kids.Pop());
retstr += Generate(", "); retstr += Generate(", ");
retstr += GenerateNode((SYMBOL) rc.kids.Pop()); retstr += GenerateNode(rc, (SYMBOL) rc.kids.Pop());
retstr += Generate(")"); retstr += Generate(")");
return retstr; return retstr;
@ -1024,7 +1067,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
retstr += Generate(String.Format("new {0}(", lc.Type), lc); retstr += Generate(String.Format("new {0}(", lc.Type), lc);
foreach (SYMBOL kid in lc.kids) foreach (SYMBOL kid in lc.kids)
retstr += GenerateNode(kid); retstr += GenerateNode(lc, kid);
retstr += Generate(")"); retstr += Generate(")");

66
OpenSim/Region/ScriptEngine/Shared/CodeTools/Compiler.cs
View File

@ -31,6 +31,7 @@ using System.Collections.Generic;
using System.Globalization; using System.Globalization;
using System.Reflection; using System.Reflection;
using System.IO; using System.IO;
using System.Linq;
using System.Text; using System.Text;
using Microsoft.CSharp; using Microsoft.CSharp;
//using Microsoft.JScript; //using Microsoft.JScript;
@ -72,6 +73,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
private bool CompileWithDebugInformation; private bool CompileWithDebugInformation;
private Dictionary<string, bool> AllowedCompilers = new Dictionary<string, bool>(StringComparer.CurrentCultureIgnoreCase); private Dictionary<string, bool> AllowedCompilers = new Dictionary<string, bool>(StringComparer.CurrentCultureIgnoreCase);
private Dictionary<string, enumCompileType> LanguageMapping = new Dictionary<string, enumCompileType>(StringComparer.CurrentCultureIgnoreCase); private Dictionary<string, enumCompileType> LanguageMapping = new Dictionary<string, enumCompileType>(StringComparer.CurrentCultureIgnoreCase);
private bool m_insertCoopTerminationCalls;
private string FilePrefix; private string FilePrefix;
private string ScriptEnginesPath = null; private string ScriptEnginesPath = null;
@ -95,20 +97,22 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
private Dictionary<string, Dictionary<KeyValuePair<int, int>, KeyValuePair<int, int>>> m_lineMaps = private Dictionary<string, Dictionary<KeyValuePair<int, int>, KeyValuePair<int, int>>> m_lineMaps =
new Dictionary<string, Dictionary<KeyValuePair<int, int>, KeyValuePair<int, int>>>(); new Dictionary<string, Dictionary<KeyValuePair<int, int>, KeyValuePair<int, int>>>();
public bool in_startup = true;
public Compiler(IScriptEngine scriptEngine) public Compiler(IScriptEngine scriptEngine)
{ {
m_scriptEngine = scriptEngine;; m_scriptEngine = scriptEngine;
ScriptEnginesPath = scriptEngine.ScriptEnginePath; ScriptEnginesPath = scriptEngine.ScriptEnginePath;
ReadConfig(); ReadConfig();
} }
public bool in_startup = true;
public void ReadConfig() public void ReadConfig()
{ {
// Get some config // Get some config
WriteScriptSourceToDebugFile = m_scriptEngine.Config.GetBoolean("WriteScriptSourceToDebugFile", false); WriteScriptSourceToDebugFile = m_scriptEngine.Config.GetBoolean("WriteScriptSourceToDebugFile", false);
CompileWithDebugInformation = m_scriptEngine.Config.GetBoolean("CompileWithDebugInformation", true); CompileWithDebugInformation = m_scriptEngine.Config.GetBoolean("CompileWithDebugInformation", true);
bool DeleteScriptsOnStartup = m_scriptEngine.Config.GetBoolean("DeleteScriptsOnStartup", true); bool DeleteScriptsOnStartup = m_scriptEngine.Config.GetBoolean("DeleteScriptsOnStartup", true);
m_insertCoopTerminationCalls = m_scriptEngine.Config.GetString("ScriptStopStrategy", "abort") == "co-op";
// Get file prefix from scriptengine name and make it file system safe: // Get file prefix from scriptengine name and make it file system safe:
FilePrefix = "CommonCompiler"; FilePrefix = "CommonCompiler";
@ -386,7 +390,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
if (language == enumCompileType.lsl) if (language == enumCompileType.lsl)
{ {
// Its LSL, convert it to C# // Its LSL, convert it to C#
LSL_Converter = (ICodeConverter)new CSCodeGenerator(comms); LSL_Converter = (ICodeConverter)new CSCodeGenerator(comms, m_insertCoopTerminationCalls);
compileScript = LSL_Converter.Convert(Script); compileScript = LSL_Converter.Convert(Script);
// copy converter warnings into our warnings. // copy converter warnings into our warnings.
@ -411,16 +415,17 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
{ {
case enumCompileType.cs: case enumCompileType.cs:
case enumCompileType.lsl: case enumCompileType.lsl:
compileScript = CreateCSCompilerScript(compileScript); compileScript = CreateCSCompilerScript(
compileScript, m_scriptEngine.ScriptBaseClassName, m_scriptEngine.ScriptBaseClassParameters);
break; break;
case enumCompileType.vb: case enumCompileType.vb:
compileScript = CreateVBCompilerScript(compileScript); compileScript = CreateVBCompilerScript(compileScript, m_scriptEngine.ScriptBaseClassName);
break; break;
// case enumCompileType.js: // case enumCompileType.js:
// compileScript = CreateJSCompilerScript(compileScript); // compileScript = CreateJSCompilerScript(compileScript, m_scriptEngine.ScriptBaseClassName);
// break; // break;
case enumCompileType.yp: case enumCompileType.yp:
compileScript = CreateYPCompilerScript(compileScript); compileScript = CreateYPCompilerScript(compileScript, m_scriptEngine.ScriptBaseClassName);
break; break;
} }
@ -451,43 +456,59 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
// return compileScript; // return compileScript;
// } // }
private static string CreateCSCompilerScript(string compileScript) private static string CreateCSCompilerScript(
string compileScript, string baseClassName, ParameterInfo[] constructorParameters)
{ {
compileScript = String.Empty + compileScript = string.Format(
"using OpenSim.Region.ScriptEngine.Shared; using System.Collections.Generic;\r\n" + @"using OpenSim.Region.ScriptEngine.Shared;
String.Empty + "namespace SecondLife { " + using System.Collections.Generic;
String.Empty + "public class Script : OpenSim.Region.ScriptEngine.Shared.ScriptBase.ScriptBaseClass { \r\n" +
@"public Script() { } " + namespace SecondLife
compileScript + {{
"} }\r\n"; public class Script : {0}
{{
public Script({1}) : base({2}) {{}}
{3}
}}
}}",
baseClassName,
constructorParameters != null
? string.Join(", ", Array.ConvertAll<ParameterInfo, string>(constructorParameters, pi => pi.ToString()))
: "",
constructorParameters != null
? string.Join(", ", Array.ConvertAll<ParameterInfo, string>(constructorParameters, pi => pi.Name))
: "",
compileScript);
return compileScript; return compileScript;
} }
private static string CreateYPCompilerScript(string compileScript) private static string CreateYPCompilerScript(string compileScript, string baseClassName)
{ {
compileScript = String.Empty + compileScript = String.Empty +
"using OpenSim.Region.ScriptEngine.Shared.YieldProlog; " + "using OpenSim.Region.ScriptEngine.Shared.YieldProlog; " +
"using OpenSim.Region.ScriptEngine.Shared; using System.Collections.Generic;\r\n" + "using OpenSim.Region.ScriptEngine.Shared; using System.Collections.Generic;\r\n" +
String.Empty + "namespace SecondLife { " + String.Empty + "namespace SecondLife { " +
String.Empty + "public class Script : OpenSim.Region.ScriptEngine.Shared.ScriptBase.ScriptBaseClass { \r\n" + String.Empty + "public class Script : " + baseClassName + " { \r\n" +
//@"public Script() { } " + //@"public Script() { } " +
@"static OpenSim.Region.ScriptEngine.Shared.YieldProlog.YP YP=null; " + @"static OpenSim.Region.ScriptEngine.Shared.YieldProlog.YP YP=null; " +
@"public Script() { YP= new OpenSim.Region.ScriptEngine.Shared.YieldProlog.YP(); } " + @"public Script() { YP= new OpenSim.Region.ScriptEngine.Shared.YieldProlog.YP(); } " +
compileScript + compileScript +
"} }\r\n"; "} }\r\n";
return compileScript; return compileScript;
} }
private static string CreateVBCompilerScript(string compileScript) private static string CreateVBCompilerScript(string compileScript, string baseClassName)
{ {
compileScript = String.Empty + compileScript = String.Empty +
"Imports OpenSim.Region.ScriptEngine.Shared: Imports System.Collections.Generic: " + "Imports OpenSim.Region.ScriptEngine.Shared: Imports System.Collections.Generic: " +
String.Empty + "NameSpace SecondLife:" + String.Empty + "NameSpace SecondLife:" +
String.Empty + "Public Class Script: Inherits OpenSim.Region.ScriptEngine.Shared.ScriptBase.ScriptBaseClass: " + String.Empty + "Public Class Script: Inherits " + baseClassName +
"\r\nPublic Sub New()\r\nEnd Sub: " + "\r\nPublic Sub New()\r\nEnd Sub: " +
compileScript + compileScript +
":End Class :End Namespace\r\n"; ":End Class :End Namespace\r\n";
return compileScript; return compileScript;
} }
@ -549,6 +570,11 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
parameters.ReferencedAssemblies.Add(Path.Combine(rootPath, parameters.ReferencedAssemblies.Add(Path.Combine(rootPath,
"OpenMetaverseTypes.dll")); "OpenMetaverseTypes.dll"));
if (m_scriptEngine.ScriptReferencedAssemblies != null)
Array.ForEach<string>(
m_scriptEngine.ScriptReferencedAssemblies,
a => parameters.ReferencedAssemblies.Add(Path.Combine(rootPath, a)));
if (lang == enumCompileType.yp) if (lang == enumCompileType.yp)
{ {
parameters.ReferencedAssemblies.Add(Path.Combine(rootPath, parameters.ReferencedAssemblies.Add(Path.Combine(rootPath,

24
OpenSim/Region/ScriptEngine/Shared/Instance/ScriptInstance.cs
View File

@ -267,13 +267,27 @@ namespace OpenSim.Region.ScriptEngine.Shared.Instance
try try
{ {
if (dom != System.AppDomain.CurrentDomain) if (dom != System.AppDomain.CurrentDomain)
m_Script = (IScript)dom.CreateInstanceAndUnwrap( m_Script
= (IScript)dom.CreateInstanceAndUnwrap(
Path.GetFileNameWithoutExtension(assembly), Path.GetFileNameWithoutExtension(assembly),
"SecondLife.Script"); "SecondLife.Script",
false,
BindingFlags.Default,
null,
new object[] { m_coopSleepHandle },
null,
null,
null);
else else
m_Script = (IScript)Assembly.Load( m_Script
Path.GetFileNameWithoutExtension(assembly)).CreateInstance( = (IScript)Assembly.Load(Path.GetFileNameWithoutExtension(assembly)).CreateInstance(
"SecondLife.Script"); "SecondLife.Script",
false,
BindingFlags.Default,
null,
new object[] { m_coopSleepHandle },
null,
null);
//ILease lease = (ILease)RemotingServices.GetLifetimeService(m_Script as ScriptBaseClass); //ILease lease = (ILease)RemotingServices.GetLifetimeService(m_Script as ScriptBaseClass);
//RemotingServices.GetLifetimeService(m_Script as ScriptBaseClass); //RemotingServices.GetLifetimeService(m_Script as ScriptBaseClass);

61
OpenSim/Region/ScriptEngine/XEngine/Api/Runtime/XEngineScriptBase.cs Normal file
View File

@ -0,0 +1,61 @@
/*
* 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.Runtime.Remoting;
using System.Runtime.Remoting.Lifetime;
using System.Security.Permissions;
using System.Threading;
using System.Reflection;
using System.Collections;
using System.Collections.Generic;
using OpenSim.Region.ScriptEngine.Interfaces;
using OpenSim.Region.ScriptEngine.Shared;
using OpenSim.Region.ScriptEngine.Shared.ScriptBase;
namespace OpenSim.Region.ScriptEngine.XEngine.ScriptBase
{
public class XEngineScriptBase : ScriptBaseClass
{
/// <summary>
/// Used for script sleeps when we are using co-operative script termination.
/// </summary>
/// <remarks>null if co-operative script termination is not active</remarks>
WaitHandle m_coopSleepHandle;
public XEngineScriptBase(WaitHandle coopSleepHandle) : base()
{
m_coopSleepHandle = coopSleepHandle;
}
public void opensim_reserved_CheckForCoopTermination()
{
if (m_coopSleepHandle != null && m_coopSleepHandle.WaitOne(0))
throw new ScriptCoopStopException();
}
}
}

17
OpenSim/Region/ScriptEngine/XEngine/XEngine.cs
View File

@ -53,6 +53,7 @@ using OpenSim.Region.ScriptEngine.Shared.Instance;
using OpenSim.Region.ScriptEngine.Shared.Api; using OpenSim.Region.ScriptEngine.Shared.Api;
using OpenSim.Region.ScriptEngine.Shared.Api.Plugins; using OpenSim.Region.ScriptEngine.Shared.Api.Plugins;
using OpenSim.Region.ScriptEngine.Interfaces; using OpenSim.Region.ScriptEngine.Interfaces;
using OpenSim.Region.ScriptEngine.XEngine.ScriptBase;
using Timer = OpenSim.Region.ScriptEngine.Shared.Api.Plugins.Timer; using Timer = OpenSim.Region.ScriptEngine.Shared.Api.Plugins.Timer;
using ScriptCompileQueue = OpenSim.Framework.LocklessQueue<object[]>; using ScriptCompileQueue = OpenSim.Framework.LocklessQueue<object[]>;
@ -176,6 +177,12 @@ namespace OpenSim.Region.ScriptEngine.XEngine
get { return "XEngine"; } get { return "XEngine"; }
} }
public string ScriptBaseClassName { get; private set; }
public ParameterInfo[] ScriptBaseClassParameters { get; private set; }
public string[] ScriptReferencedAssemblies { get; private set; }
public Scene World public Scene World
{ {
get { return m_Scene; } get { return m_Scene; }
@ -230,6 +237,12 @@ namespace OpenSim.Region.ScriptEngine.XEngine
m_ScriptConfig = configSource.Configs["XEngine"]; m_ScriptConfig = configSource.Configs["XEngine"];
m_ConfigSource = configSource; m_ConfigSource = configSource;
ScriptBaseClassName = typeof(XEngineScriptBase).FullName;
ScriptBaseClassParameters = typeof(XEngineScriptBase).GetConstructor(new Type[] { typeof(WaitHandle) }).GetParameters();
ScriptReferencedAssemblies = new string[] { Path.GetFileName(typeof(XEngineScriptBase).Assembly.Location) };
Console.WriteLine("ASSEMBLY NAME: {0}", ScriptReferencedAssemblies[0]);
} }
public void AddRegion(Scene scene) public void AddRegion(Scene scene)
@ -1179,7 +1192,9 @@ namespace OpenSim.Region.ScriptEngine.XEngine
} }
catch (Exception e) catch (Exception e)
{ {
// m_log.ErrorFormat("[XEngine]: Exception when rezzing script {0}{1}", e.Message, e.StackTrace); // m_log.ErrorFormat(
// "[XEngine]: Exception when rezzing script with item ID {0}, {1}{2}",
// itemID, e.Message, e.StackTrace);
// try // try
// { // {

36
prebuild.xml
View File

@ -2423,6 +2423,40 @@
</Files> </Files>
</Project> </Project>
<Project frameworkVersion="v3_5" name="OpenSim.Region.ScriptEngine.XEngine.Api.Runtime" path="OpenSim/Region/ScriptEngine/XEngine/Api/Runtime" type="Library">
<Configuration name="Debug">
<Options>
<OutputPath>../../../../../../bin/</OutputPath>
</Options>
</Configuration>
<Configuration name="Release">
<Options>
<OutputPath>../../../../../../bin/</OutputPath>
</Options>
</Configuration>
<ReferencePath>../../../../../../bin/</ReferencePath>
<Reference name="System"/>
<Reference name="System.Data"/>
<Reference name="System.Web"/>
<Reference name="System.Xml"/>
<Reference name="OpenMetaverseTypes" path="../../../../../../bin/"/>
<Reference name="OpenSim"/>
<Reference name="OpenSim.Framework"/>
<Reference name="OpenSim.Framework.Communications"/>
<Reference name="OpenSim.Region.Framework"/>
<Reference name="OpenSim.Region.CoreModules"/>
<Reference name="OpenSim.Framework.Console"/>
<Reference name="OpenSim.Region.ScriptEngine.Shared"/>
<Reference name="OpenSim.Region.ScriptEngine.Shared.Api.Runtime"/>
<Reference name="Nini" path="../../../../../../bin/"/>
<Reference name="log4net" path="../../../../../../bin/"/>
<Files>
<Match pattern="*.cs" recurse="true"/>
</Files>
</Project>
<Project frameworkVersion="v3_5" name="OpenSim.Region.ScriptEngine.XEngine" path="OpenSim/Region/ScriptEngine/XEngine" type="Library"> <Project frameworkVersion="v3_5" name="OpenSim.Region.ScriptEngine.XEngine" path="OpenSim/Region/ScriptEngine/XEngine" type="Library">
<Configuration name="Debug"> <Configuration name="Debug">
<Options> <Options>
@ -2453,6 +2487,7 @@
<Reference name="OpenSim.Region.ScriptEngine.Shared.CodeTools"/> <Reference name="OpenSim.Region.ScriptEngine.Shared.CodeTools"/>
<Reference name="OpenSim.Region.ScriptEngine.Shared.Instance"/> <Reference name="OpenSim.Region.ScriptEngine.Shared.Instance"/>
<Reference name="OpenSim.Region.ScriptEngine.Shared.Api"/> <Reference name="OpenSim.Region.ScriptEngine.Shared.Api"/>
<Reference name="OpenSim.Region.ScriptEngine.XEngine.Api.Runtime"/>
<Reference name="SmartThreadPool"/> <Reference name="SmartThreadPool"/>
<Reference name="Nini" path="../../../../bin/"/> <Reference name="Nini" path="../../../../bin/"/>
<Reference name="log4net" path="../../../../bin/"/> <Reference name="log4net" path="../../../../bin/"/>
@ -2460,6 +2495,7 @@
<Files> <Files>
<Match buildAction="EmbeddedResource" path="Resources" pattern="*.addin.xml" recurse="true"/> <Match buildAction="EmbeddedResource" path="Resources" pattern="*.addin.xml" recurse="true"/>
<Match pattern="*.cs" recurse="true"> <Match pattern="*.cs" recurse="true">
<Exclude name="Api"/>
<Exclude name="Tests" pattern="Tests"/> <Exclude name="Tests" pattern="Tests"/>
</Match> </Match>
</Files> </Files>