Skip to content

Merge AAsyncCallContext, cleanup for SqlDataReader merge #2383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Oct 8, 2024
Merged

Merge AAsyncCallContext, cleanup for SqlDataReader merge #2383

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4b71c0a
Merged AAsyncCallContext.
edwardneal Mar 2, 2024
eef42c8
Expanding use of CallerMemberName in SqlDataReader
edwardneal Mar 2, 2024
05b0bc7
Adjusted comments and variable names, added conditional compilation b…
edwardneal Mar 2, 2024
69f19c7
Reverted change to ObjectID following compilation and testing
edwardneal Mar 2, 2024
1678d04
Corrected a failing manual test
edwardneal Mar 2, 2024
fe7ce15
Merge remote-tracking branch 'upstream/main' into issue-1261-sqldatar…
edwardneal Oct 7, 2024
7363f37
Further post-merge changes
edwardneal Oct 7, 2024
1f59f80
Code review comments
edwardneal Oct 7, 2024
36187c3
Corrected conditional compilation directive
edwardneal Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/Microsoft.Data.SqlClient/netcore/src/Microsoft.Data.SqlClient.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,9 @@
<Compile Include="$(CommonSourceRoot)Microsoft\Data\Sql\SqlNotificationRequest.cs">
<Link>Microsoft\Data\Sql\SqlNotificationRequest.cs</Link>
</Compile>
<Compile Include="$(CommonSourceRoot)Microsoft\Data\SqlClient\AAsyncCallContext.cs">
<Link>Microsoft\Data\SqlClient\AAsyncCallContext.cs</Link>
</Compile>
<Compile Include="$(CommonSourceRoot)Microsoft\Data\SqlClient\ActiveDirectoryAuthenticationProvider.cs">
<Link>Microsoft\Data\SqlClient\ActiveDirectoryAuthenticationProvider.cs</Link>
</Compile>
Expand Down Expand Up @@ -647,7 +650,6 @@
<Compile Include="Microsoft\Data\Common\DbConnectionOptions.cs" />
<Compile Include="Microsoft\Data\ProviderBase\DbConnectionInternal.cs" />
<Compile Include="Microsoft\Data\ProviderBase\DbConnectionPool.cs" />
<Compile Include="Microsoft\Data\SqlClient\AAsyncCallContext.cs" />
<Compile Include="Microsoft\Data\SqlClient\LocalDBAPI.cs" />
<Compile Include="Microsoft\Data\SqlClient\Reliability\SqlConfigurableRetryLogicManager.NetCoreApp.cs" />
<Compile Include="Microsoft\Data\SqlClient\SNI\ConcurrentQueueSemaphore.cs" />
Expand Down
99 changes: 68 additions & 31 deletions src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlDataReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,9 +323,9 @@ internal virtual SmiExtendedMetaData[] GetInternalSmiMetaData()
collation != null ? collation.LCID : _defaultLCID,
collation != null ? collation.SqlCompareOptions : SqlCompareOptions.None,
colMetaData.udt?.Type,
false, // isMultiValued
null, // fieldmetadata
null, // extended properties
isMultiValued: false,
fieldMetaData: null,
extendedProperties: null,
colMetaData.column,
typeSpecificNamePart1,
typeSpecificNamePart2,
Expand Down Expand Up @@ -443,7 +443,7 @@ internal void Bind(TdsParserStateObject stateObj)
_defaultLCID = _parser.DefaultLCID;
}

#if NET6_0_OR_GREATER
#if !NETFRAMEWORK
[SuppressMessage("ReflectionAnalysis", "IL2111",
Justification = "System.Type.TypeInitializer would not be used in dataType and providerSpecificDataType columns.")]
#endif
Expand Down Expand Up @@ -763,11 +763,10 @@ private TdsOperationStatus TryCleanPartialRead()
{
AssertReaderState(requireData: true, permitAsync: true);

TdsOperationStatus result;

// VSTS DEVDIV2 380446: It is possible that read attempt we are cleaning after ended with partially
// processed header (if it falls between network packets). In this case the first thing to do is to
// finish reading the header, otherwise code will start treating unread header as TDS payload.
TdsOperationStatus result;
if (_stateObj._partialHeaderBytesRead > 0)
{
result = _stateObj.TryProcessHeader();
Expand Down Expand Up @@ -1154,7 +1153,9 @@ private TdsOperationStatus TryConsumeMetaData()
// NOTE: We doom connection for TdsParserState.Closed since it indicates that it is in some abnormal and unstable state, probably as a result of
// closing from another thread. In general, TdsParserState.Closed does not necessitate dooming the connection.
if (_parser.Connection != null)
{
_parser.Connection.DoomThisConnection();
}
throw SQL.ConnectionDoomed();
}
bool ignored;
Expand Down Expand Up @@ -1252,7 +1253,7 @@ override public IEnumerator GetEnumerator()
}

/// <include file='../../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml' path='docs/members[@name="SqlDataReader"]/GetFieldType/*' />
#if NET6_0_OR_GREATER
#if !NETFRAMEWORK
[SuppressMessage("ReflectionAnalysis", "IL2093:MismatchOnMethodReturnValueBetweenOverrides",
Justification = "Annotations for DbDataReader was not shipped in net6.0")]
[return: DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicFields)]
Expand All @@ -1273,7 +1274,7 @@ override public Type GetFieldType(int i)
}
}

#if NET6_0_OR_GREATER
#if !NETFRAMEWORK
[return: DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicFields)]
#endif
private Type GetFieldTypeInternal(_SqlMetaData metaData)
Expand Down Expand Up @@ -1368,7 +1369,7 @@ override public string GetName(int i)
}

/// <include file='../../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml' path='docs/members[@name="SqlDataReader"]/GetProviderSpecificFieldType/*' />
#if NET8_0_OR_GREATER
#if !NETFRAMEWORK && !NET6_0
[return: DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicFields)]
#endif
override public Type GetProviderSpecificFieldType(int i)
Expand All @@ -1387,7 +1388,7 @@ override public Type GetProviderSpecificFieldType(int i)
}
}

#if NET6_0_OR_GREATER
#if !NETFRAMEWORK
[return: DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicFields)]
#endif
private Type GetProviderSpecificFieldTypeInternal(_SqlMetaData metaData)
Expand Down Expand Up @@ -1712,7 +1713,9 @@ private TdsOperationStatus TryGetBytesInternal(int i, long dataIndex, byte[] buf
}

if (dataIndex < 0)
{
throw ADP.NegativeParameter(nameof(dataIndex));
}

if (dataIndex < _columnDataBytesRead)
{
Expand All @@ -1730,14 +1733,20 @@ private TdsOperationStatus TryGetBytesInternal(int i, long dataIndex, byte[] buf

// if bad buffer index, throw
if (bufferIndex < 0 || bufferIndex >= buffer.Length)
{
throw ADP.InvalidDestinationBufferIndex(buffer.Length, bufferIndex, nameof(bufferIndex));
}

// if there is not enough room in the buffer for data
if (length + bufferIndex > buffer.Length)
{
throw ADP.InvalidBufferSizeOrIndex(length, bufferIndex);
}

if (length < 0)
{
throw ADP.InvalidDataLength(length);
}

// Skip if needed
if (cb > 0)
Expand Down Expand Up @@ -1774,7 +1783,9 @@ private TdsOperationStatus TryGetBytesInternal(int i, long dataIndex, byte[] buf
// note that since we are caching in an array, and arrays aren't 64 bit ready yet,
// we need can cast to int if the dataIndex is in range
if (dataIndex < 0)
{
throw ADP.NegativeParameter(nameof(dataIndex));
}

if (dataIndex > int.MaxValue)
{
Expand Down Expand Up @@ -1828,9 +1839,13 @@ private TdsOperationStatus TryGetBytesInternal(int i, long dataIndex, byte[] buf
{
// help the user out in the case where there's less data than requested
if ((ndataIndex + length) > cbytes)
{
cbytes = cbytes - ndataIndex;
}
else
{
cbytes = length;
}
}

Buffer.BlockCopy(data, ndataIndex, buffer, bufferIndex, cbytes);
Expand All @@ -1844,15 +1859,21 @@ private TdsOperationStatus TryGetBytesInternal(int i, long dataIndex, byte[] buf
cbytes = data.Length;

if (length < 0)
{
throw ADP.InvalidDataLength(length);
}

// if bad buffer index, throw
if (bufferIndex < 0 || bufferIndex >= buffer.Length)
{
throw ADP.InvalidDestinationBufferIndex(buffer.Length, bufferIndex, nameof(bufferIndex));
}

// if there is not enough room in the buffer for data
if (cbytes + bufferIndex > buffer.Length)
{
throw ADP.InvalidBufferSizeOrIndex(cbytes, bufferIndex);
}

throw;
}
Expand All @@ -1868,7 +1889,6 @@ internal int GetBytesInternalSequential(int i, byte[] buffer, int index, int len
throw ADP.AsyncOperationPending();
}

TdsOperationStatus result;
int value;
SqlStatistics statistics = null;
Debug.Assert(_stateObj._syncOverAsync, "Should not attempt pends in a synchronous call");
Expand All @@ -1877,7 +1897,7 @@ internal int GetBytesInternalSequential(int i, byte[] buffer, int index, int len
statistics = SqlStatistics.StartTimer(Statistics);
SetTimeout(timeoutMilliseconds ?? _defaultTimeoutMilliseconds);

result = TryReadColumnHeader(i);
TdsOperationStatus result = TryReadColumnHeader(i);
if (result != TdsOperationStatus.Done)
{
throw SQL.SynchronousCallMayNotPend();
Expand Down Expand Up @@ -2161,17 +2181,23 @@ override public long GetChars(int i, long dataIndex, char[] buffer, int bufferIn

// if dataIndex outside of data range, return 0
if (ndataIndex < 0 || ndataIndex >= cchars)
{
return 0;
}

try
{
if (ndataIndex < cchars)
{
// help the user out in the case where there's less data than requested
if ((ndataIndex + length) > cchars)
{
cchars = cchars - ndataIndex;
}
else
{
cchars = length;
}
}

Array.Copy(_columnDataChars, ndataIndex, buffer, bufferIndex, cchars);
Expand All @@ -2186,15 +2212,21 @@ override public long GetChars(int i, long dataIndex, char[] buffer, int bufferIn
cchars = _columnDataChars.Length;

if (length < 0)
{
throw ADP.InvalidDataLength(length);
}

// if bad buffer index, throw
if (bufferIndex < 0 || bufferIndex >= buffer.Length)
{
throw ADP.InvalidDestinationBufferIndex(buffer.Length, bufferIndex, nameof(bufferIndex));
}

// if there is not enough room in the buffer for data
if (cchars + bufferIndex > buffer.Length)
{
throw ADP.InvalidBufferSizeOrIndex(cchars, bufferIndex);
}

throw;
}
Expand Down Expand Up @@ -2244,7 +2276,9 @@ private long GetCharsFromPlpData(int i, long dataIndex, char[] buffer, int buffe
// _columnDataCharsRead is 0 and dataIndex > _columnDataCharsRead is true below.
// In both cases we will clean decoder
if (dataIndex == 0)
{
_stateObj._plpdecoder = null;
}

bool isUnicode = _metaData[i].metaType.IsNCharType;

Expand Down Expand Up @@ -2617,7 +2651,7 @@ private object GetSqlValueFromSqlBufferInternal(SqlBuffer data, _SqlMetaData met
}
else
{
throw ADP.DataReaderClosed(nameof(GetSqlValueFromSqlBufferInternal));
throw ADP.DataReaderClosed();
}
}
else
Expand Down Expand Up @@ -2817,7 +2851,7 @@ private object GetValueFromSqlBufferInternal(SqlBuffer data, _SqlMetaData metaDa
}
else
{
throw ADP.DataReaderClosed(nameof(GetValueFromSqlBufferInternal));
throw ADP.DataReaderClosed();
}
}
}
Expand Down Expand Up @@ -2896,7 +2930,7 @@ private T GetFieldValueFromSqlBufferInternal<T>(SqlBuffer data, _SqlMetaData met
{
return (T)(object)data.DateTime;
}
#if NET6_0_OR_GREATER
#if !NETFRAMEWORK
else if (typeof(T) == typeof(DateOnly) && dataType == typeof(DateTime) && _typeSystem > SqlConnectionString.TypeSystem.SQLServer2005)
{
return (T)(object)data.DateOnly;
Expand Down Expand Up @@ -3557,7 +3591,7 @@ private TdsOperationStatus TryReadInternal(bool setTimeout, out bool more)
SqlStatistics statistics = null;
using (TryEventScope.Create("SqlDataReader.TryReadInternal | API | Object Id {0}", ObjectID))
{
#if !NET6_0_OR_GREATER
#if NETFRAMEWORK
RuntimeHelpers.PrepareConstrainedRegions();
#endif

Expand Down Expand Up @@ -3708,10 +3742,10 @@ private TdsOperationStatus TryReadInternal(bool setTimeout, out bool more)
if ((!_sharedState._dataReady) && (_stateObj.HasPendingData))
{
byte token;
TdsOperationStatus debugResult = _stateObj.TryPeekByte(out token);
if (debugResult != TdsOperationStatus.Done)
result = _stateObj.TryPeekByte(out token);
if (result != TdsOperationStatus.Done)
{
return debugResult;
return result;
}

Debug.Assert(TdsParser.IsValidTdsToken(token), $"DataReady is false, but next token is invalid: {token,-2:X2}");
Expand Down Expand Up @@ -3808,7 +3842,7 @@ private TdsOperationStatus TryReadColumnData()

TdsOperationStatus result = _parser.TryReadSqlValue(_data[_sharedState._nextColumnDataToRead], columnMetaData, (int)_sharedState._columnDataBytesRemaining, _stateObj,
_command != null ? _command.ColumnEncryptionSetting : SqlCommandColumnEncryptionSetting.UseConnectionSetting,
columnMetaData.column);
columnMetaData.column, _command);
if (result != TdsOperationStatus.Done)
{
// will read UDTs as VARBINARY.
Expand Down Expand Up @@ -3970,7 +4004,6 @@ internal TdsOperationStatus TryReadColumnInternal(int i, bool readHeaderOnly = f
}
else
{
// we have read past the column somehow, this is an error
Debug.Assert(false, "We have read past the column somehow, this is an error");
}
}
Expand Down Expand Up @@ -4310,7 +4343,6 @@ internal TdsOperationStatus TrySetMetaData(_SqlMetaDataSet metaData, bool moreIn

if (metaData != null)
{
TdsOperationStatus result;
// we are done consuming metadata only if there is no moreInfo
if (!moreInfo)
{
Expand All @@ -4321,7 +4353,7 @@ internal TdsOperationStatus TrySetMetaData(_SqlMetaDataSet metaData, bool moreIn
// Peek, and if row token present, set _hasRows true since there is a
// row in the result
byte b;
result = _stateObj.TryPeekByte(out b);
TdsOperationStatus result = _stateObj.TryPeekByte(out b);
if (result != TdsOperationStatus.Done)
{
return result;
Expand Down Expand Up @@ -5201,7 +5233,7 @@ override public Task<T> GetFieldValueAsync<T>(int i, CancellationToken cancellat
var metaData = _metaData;
if ((data != null) && (metaData != null))
{
return Task.FromResult<T>(GetFieldValueFromSqlBufferInternal<T>(data[i], metaData[i], isAsync:false));
return Task.FromResult<T>(GetFieldValueFromSqlBufferInternal<T>(data[i], metaData[i], isAsync: false));
}
else
{
Expand Down Expand Up @@ -5241,7 +5273,7 @@ override public Task<T> GetFieldValueAsync<T>(int i, CancellationToken cancellat
{
_stateObj._shouldHaveEnoughData = true;
#endif
return Task.FromResult(GetFieldValueInternal<T>(i, isAsync:true));
return Task.FromResult(GetFieldValueInternal<T>(i, isAsync: true));
#if DEBUG
}
finally
Expand Down Expand Up @@ -5305,19 +5337,24 @@ private static Task<T> GetFieldValueAsyncExecute<T>(Task task, object state)
reader.PrepareForAsyncContinuation();
}

TdsOperationStatus result;
if (typeof(T) == typeof(Stream) || typeof(T) == typeof(TextReader) || typeof(T) == typeof(XmlReader))
{
if (reader.IsCommandBehavior(CommandBehavior.SequentialAccess) && reader._sharedState._dataReady && reader.TryReadColumnInternal(context._columnIndex, readHeaderOnly: true) == TdsOperationStatus.Done)
if (reader.IsCommandBehavior(CommandBehavior.SequentialAccess) && reader._sharedState._dataReady)
{
return Task.FromResult<T>(reader.GetFieldValueFromSqlBufferInternal<T>(reader._data[columnIndex], reader._metaData[columnIndex], isAsync: true));
bool internalReadSuccess = false;
internalReadSuccess = reader.TryReadColumnInternal(context._columnIndex, readHeaderOnly: true) == TdsOperationStatus.Done;

if (internalReadSuccess)
{
return Task.FromResult<T>(reader.GetFieldValueFromSqlBufferInternal<T>(reader._data[columnIndex], reader._metaData[columnIndex], isAsync: true));
}
}
}

result = reader.TryReadColumn(columnIndex, setTimeout: false);
TdsOperationStatus result = reader.TryReadColumn(columnIndex, setTimeout: false);
if (result == TdsOperationStatus.Done)
{
return Task.FromResult<T>(reader.GetFieldValueFromSqlBufferInternal<T>(reader._data[columnIndex], reader._metaData[columnIndex], isAsync:false));
return Task.FromResult<T>(reader.GetFieldValueFromSqlBufferInternal<T>(reader._data[columnIndex], reader._metaData[columnIndex], isAsync: false));
}
else
{
Expand Down Expand Up @@ -5683,7 +5720,7 @@ private void CompleteAsyncCall<T>(Task<T> task, SqlDataReaderBaseAsyncCallContex
}


internal class Snapshot
internal sealed class Snapshot
{
public bool _dataReady;
public bool _haltRead;
Expand Down
3 changes: 3 additions & 0 deletions src/Microsoft.Data.SqlClient/netfx/src/Microsoft.Data.SqlClient.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,9 @@
<Compile Include="$(CommonSourceRoot)Microsoft\Data\Sql\SqlNotificationRequest.cs">
<Link>Microsoft\Data\Sql\SqlNotificationRequest.cs</Link>
</Compile>
<Compile Include="$(CommonSourceRoot)Microsoft\Data\SqlClient\AAsyncCallContext.cs">
<Link>Microsoft\Data\SqlClient\AAsyncCallContext.cs</Link>
</Compile>
<Compile Include="$(CommonSourceRoot)Microsoft\Data\SqlClient\ActiveDirectoryAuthenticationTimeoutRetryHelper.cs">
<Link>Microsoft\Data\SqlClient\ActiveDirectoryAuthenticationTimeoutRetryHelper.cs</Link>
</Compile>
Expand Down
Loading
Loading