Skip to content

remoting: Handle DLLImport failure of libpsrpclient #5622

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
TravisEz13 merged 4 commits into from
Jan 4, 2018
Merged

remoting: Handle DLLImport failure of libpsrpclient #5622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
996ac53
Issue https://github.com/PowerShell/PowerShell/issues/4029 exposed tw…
dantraMSFT Dec 4, 2017
8e69dde
Fix coding error in Clear() - setting _dataToBeSent to null too early.
dantraMSFT Dec 4, 2017
61ab380
rename _syncObjects to _dataSyncObjects and add comments for clarity
dantraMSFT Dec 5, 2017
4d04401
Remove _dataSyncObject
dantraMSFT Jan 2, 2018
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
44 changes: 32 additions & 12 deletions src/System.Management.Automation/engine/remoting/fanin/PriorityCollection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,11 @@ internal class PrioritySendDataCollection
// actual data store(s) to store priority based data and its
// corresponding sync objects to provide thread safety.
private SerializedDataStream[] _dataToBeSent;
// array of sync objects, one for each element in _dataToBeSent
private object[] _dataSyncObjects;

// fragmentor used to serialize & fragment objects added to this collection.
private Fragmentor _fragmentor;
private object[] _syncObjects;

// callbacks used if no data is available at any time.
// these callbacks are used to notify when data becomes available under
Expand Down Expand Up @@ -95,11 +97,11 @@ internal Fragmentor Fragmentor
// create serialized streams using fragment size.
string[] names = Enum.GetNames(typeof(DataPriorityType));
_dataToBeSent = new SerializedDataStream[names.Length];
_syncObjects = new object[names.Length];
_dataSyncObjects = new object[names.Length];
for (int i = 0; i < names.Length; i++)
{
_dataToBeSent[i] = new SerializedDataStream(_fragmentor.FragmentSize);
_syncObjects[i] = new object();
_dataSyncObjects[i] = new object();
}
}
}
Expand All @@ -126,7 +128,7 @@ internal void Add<T>(RemoteDataObject<T> data, DataPriorityType priority)
// make sure the only one object is fragmented and added to the collection
// at any give time. This way the order of fragment is maintained
// in the SendDataCollection(s).
lock (_syncObjects[(int)priority])
lock (_dataSyncObjects[(int)priority])
{
_fragmentor.Fragment<T>(data, _dataToBeSent[(int)priority]);
}
Expand Down Expand Up @@ -154,15 +156,33 @@ internal void Add<T>(RemoteDataObject<T> data)
/// </summary>
internal void Clear()
{
Dbg.Assert(null != _dataToBeSent, "Serialized streams are not initialized");
lock (_syncObjects[(int)DataPriorityType.PromptResponse])
/*
NOTE: Error paths during initialization can cause _dataSyncObjects to be null
causing an unhandled exception in finalize and a process crash.
Verify arrays and dataToBeSent objects before referencing.
*/
if (null != _dataSyncObjects && null != _dataToBeSent)
{
_dataToBeSent[(int)DataPriorityType.PromptResponse].Dispose();
}
int promptResponseIndex = (int)DataPriorityType.PromptResponse;
int defaultIndex = (int)DataPriorityType.Default;

lock (_syncObjects[(int)DataPriorityType.Default])
{
_dataToBeSent[(int)DataPriorityType.Default].Dispose();
lock (_dataSyncObjects[promptResponseIndex])
Copy link
Contributor

@PaulHigin PaulHigin Jan 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the late review. I am not familiar with the error path but if _dataToBeSent array can contain null entries then it seems like so can _dataSyncObjects (_dataSyncObjects[promptResponseIndex] == null ?).

It seems like these arrays should be created in the PrioritySendDataCollection constructor...

Copy link
Contributor Author

@dantraMSFT dantraMSFT Jan 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PaulHigin: _dataSyncObjects is populated when it is created. The entries are not null if the array is not null.
As far as when it is created, it appears the intent was to create both arrays at the same point. I saw no strong reason to change it.

Copy link
Contributor

@PaulHigin PaulHigin Jan 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But the _dataSyncObjects array is filled within a loop:

for (int i = 0; i < names.Length; i++)
    {
        _dataToBeSent[i] = new SerializedDataStream(_fragmentor.FragmentSize);
        _dataSyncObjects[i] = new object();
    }

If an exception is thrown within the loop then it is possible an array element is null. Is this not the error path we are worried about?

Copy link
Contributor Author

@dantraMSFT dantraMSFT Jan 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SerializedDataStream's ctor does not currently throw.

Note that it should (it relies on Dbg.Assert) and I opened an issue for this: #5800

{
if (null != _dataToBeSent[promptResponseIndex])
{
_dataToBeSent[promptResponseIndex].Dispose();
_dataToBeSent[promptResponseIndex] = null;
}
}

lock (_dataSyncObjects[defaultIndex])
{
if (null != _dataToBeSent[defaultIndex])
{
_dataToBeSent[defaultIndex].Dispose();
_dataToBeSent[defaultIndex] = null;
}
}
}
}

Expand Down Expand Up @@ -895,4 +915,4 @@ internal virtual void Dispose(bool isDisposing)
}

#endregion
}
}
16 changes: 13 additions & 3 deletions src/System.Management.Automation/engine/remoting/fanin/WSManTransportManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2602,9 +2602,19 @@ internal WSManAPIDataCommon()
{
ErrorCode = WSManNativeApi.WSManInitialize(WSManNativeApi.WSMAN_FLAG_REQUESTED_API_VERSION_1_1, ref _handle);
}
catch (DllNotFoundException)
{
throw new PSRemotingTransportException(RemotingErrorIdStrings.WSManClientDllNotAvailable);
catch (DllNotFoundException ex)
{
PSEtwLog.LogOperationalError(
PSEventId.TransportError,
PSOpcode.Open,
PSTask.None,
PSKeyword.UseAlwaysOperational,
"WSManAPIDataCommon.ctor",
"WSManInitialize",
ex.HResult.ToString(CultureInfo.InvariantCulture),
ex.Message,
ex.StackTrace);
throw new PSRemotingTransportException(RemotingErrorIdStrings.WSManClientDllNotAvailable, ex);
}

// input / output streams common to all connections
Expand Down