From 111033e65625c435295cea500508a13e00a3d764 Mon Sep 17 00:00:00 2001 From: Wraith Date: Wed, 20 Sep 2023 19:18:19 +0100 Subject: [PATCH] move stateObj snapshot to a new class in shared (#2157) --- .../SqlClient/TdsParserStateObject.netcore.cs | 28 +--- .../SqlClient/TdsParserStateObject.netfx.cs | 25 +-- .../Data/SqlClient/TdsParserStateObject.cs | 147 ++++++++++++------ 3 files changed, 104 insertions(+), 96 deletions(-) diff --git a/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsParserStateObject.netcore.cs b/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsParserStateObject.netcore.cs index 54b6a88658..9ac485cbbb 100644 --- a/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsParserStateObject.netcore.cs +++ b/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsParserStateObject.netcore.cs @@ -3063,7 +3063,6 @@ private sealed partial class PacketData internal byte[] _plpBuffer; - private int _snapshotInBuffCount; #if DEBUG @@ -3138,34 +3137,11 @@ internal bool Replay() internal void Snap(TdsParserStateObject state) { - _stateObj = state; _snapshotInBuffList = null; _snapshotInBuffCount = 0; _snapshotInBuffCurrent = 0; - _snapshotInBytesUsed = _stateObj._inBytesUsed; - _snapshotInBytesPacket = _stateObj._inBytesPacket; - - _snapshotMessageStatus = _stateObj._messageStatus; - // _nullBitmapInfo must be cloned before it is updated - _snapshotNullBitmapInfo = _stateObj._nullBitmapInfo; - if (_stateObj._longlen != 0 || _stateObj._longlenleft != 0) - { - _plpData = new PLPData(_stateObj._longlen, _stateObj._longlenleft); - } - _snapshotCleanupMetaData = _stateObj._cleanupMetaData; - // _cleanupAltMetaDataSetArray must be cloned before it is updated - _snapshotCleanupAltMetaDataSetArray = _stateObj._cleanupAltMetaDataSetArray; - _state = _stateObj._snapshottedState; -#if DEBUG - _rollingPend = 0; - _rollingPendCount = 0; - _stateObj._lastStack = null; - Debug.Assert(_stateObj._bTmpRead == 0, "Has partially read data when snapshot taken"); - Debug.Assert(_stateObj._partialHeaderBytesRead == 0, "Has partially read header when snapshot taken"); -#endif - - PushBuffer(_stateObj._inBuff, _stateObj._inBytesRead); + CaptureAsStart(state); } internal void Clear() @@ -3173,8 +3149,6 @@ internal void Clear() PacketData packet = _snapshotInBuffList; _snapshotInBuffList = null; _snapshotInBuffCount = 0; - - _state = SnapshottedStateFlags.None; packet.Clear(); _sparePacket = packet; diff --git a/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsParserStateObject.netfx.cs b/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsParserStateObject.netfx.cs index 60b380d113..e64c25c523 100644 --- a/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsParserStateObject.netfx.cs +++ b/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsParserStateObject.netfx.cs @@ -3202,7 +3202,6 @@ sealed partial class StateSnapshot { private List _snapshotInBuffs; - public StateSnapshot() { _snapshotInBuffs = new List(); @@ -3270,32 +3269,10 @@ internal bool Replay() internal void Snap(TdsParserStateObject state) { - _stateObj = state; _snapshotInBuffs.Clear(); _snapshotInBuffCurrent = 0; - _snapshotInBytesUsed = _stateObj._inBytesUsed; - _snapshotInBytesPacket = _stateObj._inBytesPacket; - _snapshotMessageStatus = _stateObj._messageStatus; - // _nullBitmapInfo must be cloned before it is updated - _snapshotNullBitmapInfo = _stateObj._nullBitmapInfo; - if (_stateObj._longlen != 0 || _stateObj._longlenleft != 0) - { - _plpData = new PLPData(_stateObj._longlen, _stateObj._longlenleft); - } - _snapshotCleanupMetaData = _stateObj._cleanupMetaData; - // _cleanupAltMetaDataSetArray must be cloned bofore it is updated - _snapshotCleanupAltMetaDataSetArray = _stateObj._cleanupAltMetaDataSetArray; - - _state = _stateObj._snapshottedState; -#if DEBUG - _rollingPend = 0; - _rollingPendCount = 0; - _stateObj._lastStack = null; - Debug.Assert(_stateObj._bTmpRead == 0, "Has partially read data when snapshot taken"); - Debug.Assert(_stateObj._partialHeaderBytesRead == 0, "Has partially read header when snapshot taken"); -#endif - PushBuffer(_stateObj._inBuff, _stateObj._inBytesRead); + CaptureAsStart(state); } internal void Clear() diff --git a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/TdsParserStateObject.cs b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/TdsParserStateObject.cs index 377d3191c8..7147c10e5a 100644 --- a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/TdsParserStateObject.cs +++ b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/TdsParserStateObject.cs @@ -1193,20 +1193,92 @@ public PLPData(ulong snapshotLongLen, ulong snapshotLongLenLeft) } } - private int _snapshotInBuffCurrent; - private int _snapshotInBytesUsed; - private int _snapshotInBytesPacket; + private sealed class StateObjectData + { + private int _inBytesUsed; + private int _inBytesPacket; + private PLPData _plpData; + private byte _messageStatus; + internal NullBitmap _nullBitmapInfo; + private _SqlMetaDataSet _cleanupMetaData; + internal _SqlMetaDataSetCollection _cleanupAltMetaDataSetArray; + private SnapshottedStateFlags _state; + + internal void Capture(TdsParserStateObject stateObj, bool trackStack = true) + { + _inBytesUsed = stateObj._inBytesUsed; + _inBytesPacket = stateObj._inBytesPacket; + _messageStatus = stateObj._messageStatus; + _nullBitmapInfo = stateObj._nullBitmapInfo; // _nullBitmapInfo must be cloned before it is updated + if (stateObj._longlen != 0 || stateObj._longlenleft != 0) + { + _plpData = new PLPData(stateObj._longlen, stateObj._longlenleft); + } + _cleanupMetaData = stateObj._cleanupMetaData; + _cleanupAltMetaDataSetArray = stateObj._cleanupAltMetaDataSetArray; // _cleanupAltMetaDataSetArray must be cloned before it is updated + _state = stateObj._snapshottedState; +#if DEBUG + if (trackStack) + { + stateObj._lastStack = null; + } + Debug.Assert(stateObj._bTmpRead == 0, "Has partially read data when snapshot taken"); + Debug.Assert(stateObj._partialHeaderBytesRead == 0, "Has partially read header when snapshot taken"); +#endif + } - private PLPData _plpData; + internal void Clear(TdsParserStateObject stateObj, bool trackStack = true) + { + _inBytesUsed = 0; + _inBytesPacket = 0; + _messageStatus = 0; + _nullBitmapInfo = default; + _plpData = null; + _cleanupMetaData = null; + _cleanupAltMetaDataSetArray = null; + _state = SnapshottedStateFlags.None; +#if DEBUG + if (trackStack) + { + stateObj._lastStack = null; + } +#endif + } - private byte _snapshotMessageStatus; + internal void Restore(TdsParserStateObject stateObj) + { + stateObj._inBytesUsed = _inBytesUsed; + stateObj._inBytesPacket = _inBytesPacket; + stateObj._messageStatus = _messageStatus; + stateObj._nullBitmapInfo = _nullBitmapInfo; + stateObj._cleanupMetaData = _cleanupMetaData; + stateObj._cleanupAltMetaDataSetArray = _cleanupAltMetaDataSetArray; + + // Make sure to go through the appropriate increment/decrement methods if changing HasOpenResult + if (!stateObj.HasOpenResult && ((_state & SnapshottedStateFlags.OpenResult) == SnapshottedStateFlags.OpenResult)) + { + stateObj.IncrementAndObtainOpenResultCount(stateObj._executedUnderTransaction); + } + else if (stateObj.HasOpenResult && ((_state & SnapshottedStateFlags.OpenResult) != SnapshottedStateFlags.OpenResult)) + { + stateObj.DecrementOpenResultCount(); + } + //else _stateObj._hasOpenResult is already == _snapshotHasOpenResult + stateObj._snapshottedState = _state; - private NullBitmap _snapshotNullBitmapInfo; - private _SqlMetaDataSet _snapshotCleanupMetaData; - private _SqlMetaDataSetCollection _snapshotCleanupAltMetaDataSetArray; + // Reset partially read state (these only need to be maintained if doing async without snapshot) + stateObj._bTmpRead = 0; + stateObj._partialHeaderBytesRead = 0; + // reset plp state + stateObj._longlen = _plpData?.SnapshotLongLen ?? 0; + stateObj._longlenleft = _plpData?.SnapshotLongLenLeft ?? 0; + } + } + + private int _snapshotInBuffCurrent; private TdsParserStateObject _stateObj; - private SnapshottedStateFlags _state; + private StateObjectData _replayStateData; #if DEBUG private int _rollingPend = 0; @@ -1232,7 +1304,7 @@ internal bool DoPend() #endif internal void CloneNullBitmapInfo() { - if (_stateObj._nullBitmapInfo.ReferenceEquals(_snapshotNullBitmapInfo)) + if (_stateObj._nullBitmapInfo.ReferenceEquals(_replayStateData?._nullBitmapInfo ?? default)) { _stateObj._nullBitmapInfo = _stateObj._nullBitmapInfo.Clone(); } @@ -1240,7 +1312,7 @@ internal void CloneNullBitmapInfo() internal void CloneCleanupAltMetaDataSetArray() { - if (_stateObj._cleanupAltMetaDataSetArray != null && object.ReferenceEquals(_snapshotCleanupAltMetaDataSetArray, _stateObj._cleanupAltMetaDataSetArray)) + if (_stateObj._cleanupAltMetaDataSetArray != null && object.ReferenceEquals(_replayStateData?._cleanupAltMetaDataSetArray ?? default, _stateObj._cleanupAltMetaDataSetArray)) { _stateObj._cleanupAltMetaDataSetArray = (_SqlMetaDataSetCollection)_stateObj._cleanupAltMetaDataSetArray.Clone(); } @@ -1253,32 +1325,7 @@ internal void ResetSnapshotState() Replay(); - _stateObj._inBytesUsed = _snapshotInBytesUsed; - _stateObj._inBytesPacket = _snapshotInBytesPacket; - _stateObj._messageStatus = _snapshotMessageStatus; - _stateObj._nullBitmapInfo = _snapshotNullBitmapInfo; - _stateObj._cleanupMetaData = _snapshotCleanupMetaData; - _stateObj._cleanupAltMetaDataSetArray = _snapshotCleanupAltMetaDataSetArray; - - // Make sure to go through the appropriate increment/decrement methods if changing HasOpenResult - if (!_stateObj.HasOpenResult && ((_state & SnapshottedStateFlags.OpenResult) == SnapshottedStateFlags.OpenResult)) - { - _stateObj.IncrementAndObtainOpenResultCount(_stateObj._executedUnderTransaction); - } - else if (_stateObj.HasOpenResult && ((_state & SnapshottedStateFlags.OpenResult) != SnapshottedStateFlags.OpenResult)) - { - _stateObj.DecrementOpenResultCount(); - } - //else _stateObj._hasOpenResult is already == _snapshotHasOpenResult - _stateObj._snapshottedState = _state; - - // Reset partially read state (these only need to be maintained if doing async without snapshot) - _stateObj._bTmpRead = 0; - _stateObj._partialHeaderBytesRead = 0; - - // reset plp state - _stateObj._longlen = _plpData?.SnapshotLongLen ?? 0; - _stateObj._longlenleft = _plpData?.SnapshotLongLenLeft ?? 0; + _replayStateData.Restore(_stateObj); _stateObj._snapshotReplay = true; @@ -1290,17 +1337,27 @@ internal void PrepareReplay() ResetSnapshotState(); } + internal void CaptureAsStart(TdsParserStateObject stateObj) + { + _stateObj = stateObj; + _replayStateData ??= new StateObjectData(); + _replayStateData.Capture(stateObj); + +#if DEBUG + _rollingPend = 0; + _rollingPendCount = 0; + stateObj._lastStack = null; + Debug.Assert(stateObj._bTmpRead == 0, "Has partially read data when snapshot taken"); + Debug.Assert(stateObj._partialHeaderBytesRead == 0, "Has partially read header when snapshot taken"); +#endif + + PushBuffer(stateObj._inBuff, stateObj._inBytesRead); + } + internal void ClearCore() { _snapshotInBuffCurrent = 0; - _snapshotInBytesUsed = 0; - _snapshotInBytesPacket = 0; - _snapshotMessageStatus = 0; - _snapshotNullBitmapInfo = default; - _plpData = null; - _snapshotCleanupMetaData = null; - _snapshotCleanupAltMetaDataSetArray = null; - _state = SnapshottedStateFlags.None; + _replayStateData.Clear(_stateObj); #if DEBUG _rollingPend = 0; _rollingPendCount = 0;