mirror of
https://github.com/opensim/opensim.git
synced 2026-06-01 15:35:44 +08:00
b1c26a56b3
The root cause was that v2 was only closing neighbour agents if the root connection also needed a close. However, fixing this requires the neighbour regions also detect when they should not close due to re-teleports re-establishing the child connection. This involves restructuring the code to introduce a scene presence state machine that can serialize the different add and remove client calls that are now possible with the late close of the This commit appears to fix these issues and improve teleport, but still has holes on at least quick reteleporting (and possibly occasionally on ordinary teleports). Also, has not been completely tested yet in scenarios where regions are running on different simulators
321 lines
13 KiB
C#
321 lines
13 KiB
C#
/*
|
|
* 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.Net;
|
|
using log4net.Config;
|
|
using Nini.Config;
|
|
using NUnit.Framework;
|
|
using OpenMetaverse;
|
|
using OpenMetaverse.Packets;
|
|
using OpenSim.Framework;
|
|
using OpenSim.Framework.Monitoring;
|
|
using OpenSim.Region.Framework.Scenes;
|
|
using OpenSim.Tests.Common;
|
|
using OpenSim.Tests.Common.Mock;
|
|
|
|
namespace OpenSim.Region.ClientStack.LindenUDP.Tests
|
|
{
|
|
/// <summary>
|
|
/// This will contain basic tests for the LindenUDP client stack
|
|
/// </summary>
|
|
[TestFixture]
|
|
public class BasicCircuitTests : OpenSimTestCase
|
|
{
|
|
private Scene m_scene;
|
|
private TestLLUDPServer m_udpServer;
|
|
|
|
[TestFixtureSetUp]
|
|
public void FixtureInit()
|
|
{
|
|
// Don't allow tests to be bamboozled by asynchronous events. Execute everything on the same thread.
|
|
Util.FireAndForgetMethod = FireAndForgetMethod.RegressionTest;
|
|
}
|
|
|
|
[TestFixtureTearDown]
|
|
public void TearDown()
|
|
{
|
|
// We must set this back afterwards, otherwise later tests will fail since they're expecting multiple
|
|
// threads. Possibly, later tests should be rewritten so none of them require async stuff (which regression
|
|
// tests really shouldn't).
|
|
Util.FireAndForgetMethod = Util.DefaultFireAndForgetMethod;
|
|
}
|
|
|
|
[SetUp]
|
|
public override void SetUp()
|
|
{
|
|
base.SetUp();
|
|
m_scene = new SceneHelpers().SetupScene();
|
|
StatsManager.SimExtraStats = new SimExtraStatsCollector();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Build an object name packet for test purposes
|
|
/// </summary>
|
|
/// <param name="objectLocalId"></param>
|
|
/// <param name="objectName"></param>
|
|
private ObjectNamePacket BuildTestObjectNamePacket(uint objectLocalId, string objectName)
|
|
{
|
|
ObjectNamePacket onp = new ObjectNamePacket();
|
|
ObjectNamePacket.ObjectDataBlock odb = new ObjectNamePacket.ObjectDataBlock();
|
|
odb.LocalID = objectLocalId;
|
|
odb.Name = Utils.StringToBytes(objectName);
|
|
onp.ObjectData = new ObjectNamePacket.ObjectDataBlock[] { odb };
|
|
onp.Header.Zerocoded = false;
|
|
|
|
return onp;
|
|
}
|
|
|
|
private void AddUdpServer()
|
|
{
|
|
AddUdpServer(new IniConfigSource());
|
|
}
|
|
|
|
private void AddUdpServer(IniConfigSource configSource)
|
|
{
|
|
uint port = 0;
|
|
AgentCircuitManager acm = m_scene.AuthenticateHandler;
|
|
|
|
m_udpServer = new TestLLUDPServer(IPAddress.Any, ref port, 0, false, configSource, acm);
|
|
m_udpServer.AddScene(m_scene);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Used by tests that aren't testing this stage.
|
|
/// </summary>
|
|
private ScenePresence AddClient()
|
|
{
|
|
UUID myAgentUuid = TestHelpers.ParseTail(0x1);
|
|
UUID mySessionUuid = TestHelpers.ParseTail(0x2);
|
|
uint myCircuitCode = 123456;
|
|
IPEndPoint testEp = new IPEndPoint(IPAddress.Loopback, 999);
|
|
|
|
UseCircuitCodePacket uccp = new UseCircuitCodePacket();
|
|
|
|
UseCircuitCodePacket.CircuitCodeBlock uccpCcBlock
|
|
= new UseCircuitCodePacket.CircuitCodeBlock();
|
|
uccpCcBlock.Code = myCircuitCode;
|
|
uccpCcBlock.ID = myAgentUuid;
|
|
uccpCcBlock.SessionID = mySessionUuid;
|
|
uccp.CircuitCode = uccpCcBlock;
|
|
|
|
byte[] uccpBytes = uccp.ToBytes();
|
|
UDPPacketBuffer upb = new UDPPacketBuffer(testEp, uccpBytes.Length);
|
|
upb.DataLength = uccpBytes.Length; // God knows why this isn't set by the constructor.
|
|
Buffer.BlockCopy(uccpBytes, 0, upb.Data, 0, uccpBytes.Length);
|
|
|
|
AgentCircuitData acd = new AgentCircuitData();
|
|
acd.AgentID = myAgentUuid;
|
|
acd.SessionID = mySessionUuid;
|
|
|
|
m_scene.AuthenticateHandler.AddNewCircuit(myCircuitCode, acd);
|
|
|
|
m_udpServer.PacketReceived(upb);
|
|
|
|
return m_scene.GetScenePresence(myAgentUuid);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Test adding a client to the stack
|
|
/// </summary>
|
|
[Test]
|
|
public void TestAddClient()
|
|
{
|
|
TestHelpers.InMethod();
|
|
// TestHelpers.EnableLogging();
|
|
|
|
AddUdpServer();
|
|
|
|
UUID myAgentUuid = TestHelpers.ParseTail(0x1);
|
|
UUID mySessionUuid = TestHelpers.ParseTail(0x2);
|
|
uint myCircuitCode = 123456;
|
|
IPEndPoint testEp = new IPEndPoint(IPAddress.Loopback, 999);
|
|
|
|
UseCircuitCodePacket uccp = new UseCircuitCodePacket();
|
|
|
|
UseCircuitCodePacket.CircuitCodeBlock uccpCcBlock
|
|
= new UseCircuitCodePacket.CircuitCodeBlock();
|
|
uccpCcBlock.Code = myCircuitCode;
|
|
uccpCcBlock.ID = myAgentUuid;
|
|
uccpCcBlock.SessionID = mySessionUuid;
|
|
uccp.CircuitCode = uccpCcBlock;
|
|
|
|
byte[] uccpBytes = uccp.ToBytes();
|
|
UDPPacketBuffer upb = new UDPPacketBuffer(testEp, uccpBytes.Length);
|
|
upb.DataLength = uccpBytes.Length; // God knows why this isn't set by the constructor.
|
|
Buffer.BlockCopy(uccpBytes, 0, upb.Data, 0, uccpBytes.Length);
|
|
|
|
m_udpServer.PacketReceived(upb);
|
|
|
|
// Presence shouldn't exist since the circuit manager doesn't know about this circuit for authentication yet
|
|
Assert.That(m_scene.GetScenePresence(myAgentUuid), Is.Null);
|
|
|
|
AgentCircuitData acd = new AgentCircuitData();
|
|
acd.AgentID = myAgentUuid;
|
|
acd.SessionID = mySessionUuid;
|
|
|
|
m_scene.AuthenticateHandler.AddNewCircuit(myCircuitCode, acd);
|
|
|
|
m_udpServer.PacketReceived(upb);
|
|
|
|
// Should succeed now
|
|
ScenePresence sp = m_scene.GetScenePresence(myAgentUuid);
|
|
Assert.That(sp.UUID, Is.EqualTo(myAgentUuid));
|
|
|
|
Assert.That(m_udpServer.PacketsSent.Count, Is.EqualTo(1));
|
|
|
|
Packet packet = m_udpServer.PacketsSent[0];
|
|
Assert.That(packet, Is.InstanceOf(typeof(PacketAckPacket)));
|
|
|
|
PacketAckPacket ackPacket = packet as PacketAckPacket;
|
|
Assert.That(ackPacket.Packets.Length, Is.EqualTo(1));
|
|
Assert.That(ackPacket.Packets[0].ID, Is.EqualTo(0));
|
|
}
|
|
|
|
[Test]
|
|
public void TestLogoutClientDueToAck()
|
|
{
|
|
TestHelpers.InMethod();
|
|
TestHelpers.EnableLogging();
|
|
|
|
IniConfigSource ics = new IniConfigSource();
|
|
IConfig config = ics.AddConfig("ClientStack.LindenUDP");
|
|
config.Set("AckTimeout", -1);
|
|
AddUdpServer(ics);
|
|
|
|
ScenePresence sp = AddClient();
|
|
m_udpServer.ClientOutgoingPacketHandler(sp.ControllingClient, true, false, false);
|
|
|
|
ScenePresence spAfterAckTimeout = m_scene.GetScenePresence(sp.UUID);
|
|
Assert.That(spAfterAckTimeout, Is.Null);
|
|
}
|
|
|
|
// /// <summary>
|
|
// /// Test removing a client from the stack
|
|
// /// </summary>
|
|
// [Test]
|
|
// public void TestRemoveClient()
|
|
// {
|
|
// TestHelper.InMethod();
|
|
//
|
|
// uint myCircuitCode = 123457;
|
|
//
|
|
// TestLLUDPServer testLLUDPServer;
|
|
// TestLLPacketServer testLLPacketServer;
|
|
// AgentCircuitManager acm;
|
|
// SetupStack(new MockScene(), out testLLUDPServer, out testLLPacketServer, out acm);
|
|
// AddClient(myCircuitCode, new IPEndPoint(IPAddress.Loopback, 1000), testLLUDPServer, acm);
|
|
//
|
|
// testLLUDPServer.RemoveClientCircuit(myCircuitCode);
|
|
// Assert.IsFalse(testLLUDPServer.HasCircuit(myCircuitCode));
|
|
//
|
|
// // Check that removing a non-existant circuit doesn't have any bad effects
|
|
// testLLUDPServer.RemoveClientCircuit(101);
|
|
// Assert.IsFalse(testLLUDPServer.HasCircuit(101));
|
|
// }
|
|
//
|
|
// /// <summary>
|
|
// /// Make sure that the client stack reacts okay to malformed packets
|
|
// /// </summary>
|
|
// [Test]
|
|
// public void TestMalformedPacketSend()
|
|
// {
|
|
// TestHelper.InMethod();
|
|
//
|
|
// uint myCircuitCode = 123458;
|
|
// EndPoint testEp = new IPEndPoint(IPAddress.Loopback, 1001);
|
|
// MockScene scene = new MockScene();
|
|
//
|
|
// TestLLUDPServer testLLUDPServer;
|
|
// TestLLPacketServer testLLPacketServer;
|
|
// AgentCircuitManager acm;
|
|
// SetupStack(scene, out testLLUDPServer, out testLLPacketServer, out acm);
|
|
// AddClient(myCircuitCode, testEp, testLLUDPServer, acm);
|
|
//
|
|
// byte[] data = new byte[] { 0x01, 0x02, 0x03, 0x04 };
|
|
//
|
|
// // Send two garbled 'packets' in succession
|
|
// testLLUDPServer.LoadReceive(data, testEp);
|
|
// testLLUDPServer.LoadReceive(data, testEp);
|
|
// testLLUDPServer.ReceiveData(null);
|
|
//
|
|
// // Check that we are still here
|
|
// Assert.IsTrue(testLLUDPServer.HasCircuit(myCircuitCode));
|
|
// Assert.That(testLLPacketServer.GetTotalPacketsReceived(), Is.EqualTo(0));
|
|
//
|
|
// // Check that sending a valid packet to same circuit still succeeds
|
|
// Assert.That(scene.ObjectNameCallsReceived, Is.EqualTo(0));
|
|
//
|
|
// testLLUDPServer.LoadReceive(BuildTestObjectNamePacket(1, "helloooo"), testEp);
|
|
// testLLUDPServer.ReceiveData(null);
|
|
//
|
|
// Assert.That(testLLPacketServer.GetTotalPacketsReceived(), Is.EqualTo(1));
|
|
// Assert.That(testLLPacketServer.GetPacketsReceivedFor(PacketType.ObjectName), Is.EqualTo(1));
|
|
// }
|
|
//
|
|
// /// <summary>
|
|
// /// Test that the stack continues to work even if some client has caused a
|
|
// /// SocketException on Socket.BeginReceive()
|
|
// /// </summary>
|
|
// [Test]
|
|
// public void TestExceptionOnBeginReceive()
|
|
// {
|
|
// TestHelper.InMethod();
|
|
//
|
|
// MockScene scene = new MockScene();
|
|
//
|
|
// uint circuitCodeA = 130000;
|
|
// EndPoint epA = new IPEndPoint(IPAddress.Loopback, 1300);
|
|
// UUID agentIdA = UUID.Parse("00000000-0000-0000-0000-000000001300");
|
|
// UUID sessionIdA = UUID.Parse("00000000-0000-0000-0000-000000002300");
|
|
//
|
|
// uint circuitCodeB = 130001;
|
|
// EndPoint epB = new IPEndPoint(IPAddress.Loopback, 1301);
|
|
// UUID agentIdB = UUID.Parse("00000000-0000-0000-0000-000000001301");
|
|
// UUID sessionIdB = UUID.Parse("00000000-0000-0000-0000-000000002301");
|
|
//
|
|
// TestLLUDPServer testLLUDPServer;
|
|
// TestLLPacketServer testLLPacketServer;
|
|
// AgentCircuitManager acm;
|
|
// SetupStack(scene, out testLLUDPServer, out testLLPacketServer, out acm);
|
|
// AddClient(circuitCodeA, epA, agentIdA, sessionIdA, testLLUDPServer, acm);
|
|
// AddClient(circuitCodeB, epB, agentIdB, sessionIdB, testLLUDPServer, acm);
|
|
//
|
|
// testLLUDPServer.LoadReceive(BuildTestObjectNamePacket(1, "packet1"), epA);
|
|
// testLLUDPServer.LoadReceive(BuildTestObjectNamePacket(1, "packet2"), epB);
|
|
// testLLUDPServer.LoadReceiveWithBeginException(epA);
|
|
// testLLUDPServer.LoadReceive(BuildTestObjectNamePacket(2, "packet3"), epB);
|
|
// testLLUDPServer.ReceiveData(null);
|
|
//
|
|
// Assert.IsFalse(testLLUDPServer.HasCircuit(circuitCodeA));
|
|
//
|
|
// Assert.That(testLLPacketServer.GetTotalPacketsReceived(), Is.EqualTo(3));
|
|
// Assert.That(testLLPacketServer.GetPacketsReceivedFor(PacketType.ObjectName), Is.EqualTo(3));
|
|
// }
|
|
}
|
|
}
|