Skip to content

Rebrand Diagnostics Server to DiagnosticPort #40499

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
josalem merged 19 commits into from
Aug 14, 2020
Merged

Rebrand Diagnostics Server to DiagnosticPort #40499

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
b4e32e1
Rebrand Diagnostic Server to Diagnostic Port
Aug 6, 2020
000142d
Update tests to use new config switches
Aug 7, 2020
af9b4cc
Update diagnosticserver.cpp
Aug 7, 2020
5fafe42
Appease gcc warning
Aug 7, 2020
4144d1a
Merge branch 'dev/josalem/diagnostic-port' of github.com:josalem/runt…
Aug 7, 2020
b76cf6c
Const shenanigans
Aug 7, 2020
51c7377
Add tests for DiagnosticPort functionality
Aug 7, 2020
e3cb293
Attempting to appease GCC
Aug 7, 2020
335f959
Defer disable till after streaming starts
Aug 8, 2020
693d91a
Rename ConnectionMode enum values
Aug 11, 2020
c3e5b84
PR feedback
Aug 11, 2020
e5c8a06
Merge branch 'dev/josalem/diagnostic-port' of github.com:josalem/runt…
Aug 11, 2020
9efac34
Merge branch 'master' into dev/josalem/diagnostic-port
Aug 11, 2020
bb70ca7
Fix #40696 and add test to cover that
Aug 12, 2020
6a84b6f
Merge branch 'dev/josalem/diagnostic-port' of github.com:josalem/runt…
Aug 12, 2020
2c4f0de
Fix scope of runtime cookie
Aug 12, 2020
c5134d0
Ignore listen ports for now
Aug 13, 2020
bcf4506
default port type is connect
Aug 13, 2020
f97f77a
PR feedback
Aug 13, 2020
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
Prev Previous commit
Next Next commit
Update tests to use new config switches 
* small bug fixes in config parsing code
  • Loading branch information
John Salem committed Aug 7, 2020
commit 000142d2876d424ad9e7b0e1f67f4fb5ca4d5a69
2 changes: 1 addition & 1 deletion src/coreclr/src/inc/clrconfigvalues.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -712,7 +712,7 @@ RETAIL_CONFIG_DWORD_INFO(INTERNAL_EventPipeProcNumbers, W("EventPipeProcNumbers"
//
// Diagnostics Ports
//
RRETAIL_CONFIG_DWORD_INFO_EX(EXTERNAL_DOTNET_DiagnosticPortSuspend, W("DOTNET_DiagnosticPortSuspend"), 1, "This will cause the runtime to pause during startup before major subsystems are started. Resume using the Diagnostics IPC ResumeStartup command.", CLRConfig::DontPrependCOMPlus_);
RETAIL_CONFIG_DWORD_INFO_EX(EXTERNAL_DOTNET_DiagnosticPortSuspend, W("DOTNET_DiagnosticPortSuspend"), 0, "This will cause the runtime to pause during startup before major subsystems are started. Resume using the Diagnostics IPC ResumeStartup command.", CLRConfig::DontPrependCOMPlus_);
RETAIL_CONFIG_STRING_INFO_EX(EXTERNAL_DOTNET_DiagnosticPorts, W("DOTNET_DiagnosticPorts"), "A semicolon delimited list of additional Diagnostic Ports, where a Diagnostic Port is a NamedPipe path without '\\\\.\\pipe\\' on Windows or the full path of Unix Domain Socket on Linux/Unix followed by optional tags, e.g., '<path>,listen,nosuspend;<path>,connect'", CLRConfig::DontPrependCOMPlus_);

//
Expand Down
13 changes: 8 additions & 5 deletions src/coreclr/src/vm/ipcstreamfactory.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ CQuickArrayList<LPSTR> split(LPSTR string, LPCSTR delimiters)
{
CQuickArrayList<LPSTR> parts;
char *context;
char *portConfig = nullptr;
char *part = nullptr;
for (char *cursor = string; ; cursor = nullptr)
{
if ((portConfig = strtok_s(cursor, delimiters, &context)) != nullptr)
parts.Push(portConfig);
if ((part = strtok_s(cursor, delimiters, &context)) != nullptr)
parts.Push(part);
else
break;
}
Expand Down Expand Up @@ -110,11 +110,14 @@ bool IpcStreamFactory::Configure(ErrorCallback callback)

ASSERT(portConfigParts.Size() >= 1);
if (portConfigParts.Size() == 0)
{
fSuccess &= false;
continue;
}

builder.WithPath(portConfigParts.Pop());
while (portConfigParts.Size() > 0)
while (portConfigParts.Size() > 1)
builder.WithTag(portConfigParts.Pop());
builder.WithPath(portConfigParts.Pop());

const bool fBuildSuccess = BuildAndAddPort(builder, callback);
STRESS_LOG1(LF_DIAGNOSTICS_PORT, LL_INFO10, "IpcStreamFactory::Configure - Diagnostic Port creation succeeded? %d \n", fBuildSuccess);
Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/src/vm/ipcstreamfactory.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class IpcStreamFactory
DiagnosticPortType Type = DiagnosticPortType::LISTEN;
DiagnosticPortSuspendMode SuspendMode = DiagnosticPortSuspendMode::NOSUSPEND;

DiagnosticPortBuilder WithPath(LPSTR path) { Path = _strdup(path); return *this; }
DiagnosticPortBuilder WithPath(LPSTR path) { Path = path != nullptr ? _strdup(path) : nullptr; return *this; }
DiagnosticPortBuilder WithType(DiagnosticPortType type) { Type = type; return *this; }
DiagnosticPortBuilder WithSuspendMode(DiagnosticPortSuspendMode mode) { SuspendMode = mode; return *this; }
DiagnosticPortBuilder WithTag(LPSTR tag)
Expand Down
4 changes: 2 additions & 2 deletions src/tests/tracing/eventpipe/common/IpcUtils.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ namespace Tracing.Tests.Common
{
public static class Utils
{
public static readonly string DiagnosticsMonitorAddressEnvKey = "DOTNET_DiagnosticsMonitorAddress";
public static readonly string DiagnosticsMonitorPauseOnStartEnvKey = "DOTNET_DiagnosticsMonitorPauseOnStart";
public static readonly string DiagnosticPortsEnvKey = "DOTNET_DiagnosticPorts";
public static readonly string DiagnosticPortSuspend = "DOTNET_DiagnosticPortSuspend";

public static async Task<T> WaitTillTimeout<T>(Task<T> task, TimeSpan timeout)
{
Expand Down
10 changes: 5 additions & 5 deletions src/tests/tracing/eventpipe/pauseonstart/pauseonstart.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public static async Task<bool> TEST_RuntimeResumesExecutionWithCommand()
var server = new ReverseServer(serverName);
Task<bool> subprocessTask = Utils.RunSubprocess(
currentAssembly: Assembly.GetExecutingAssembly(),
environment: new Dictionary<string,string> { { Utils.DiagnosticsMonitorAddressEnvKey, serverName } },
environment: new Dictionary<string,string> { { Utils.DiagnosticPortsEnvKey, $"{serverName},connect,suspend" } },
duringExecution: async (_) =>
{
Stream stream = await server.AcceptAsync();
Expand Down Expand Up @@ -56,7 +56,7 @@ public static async Task<bool> TEST_TracesHaveRelevantEvents()
using var memoryStream = new MemoryStream();
Task<bool> subprocessTask = Utils.RunSubprocess(
currentAssembly: Assembly.GetExecutingAssembly(),
environment: new Dictionary<string,string> { { Utils.DiagnosticsMonitorAddressEnvKey, serverName } },
environment: new Dictionary<string,string> { { Utils.DiagnosticPortsEnvKey, $"{serverName},connect,suspend" } },
duringExecution: async (pid) =>
{
Stream stream = await server.AcceptAsync();
Expand Down Expand Up @@ -114,7 +114,7 @@ public static async Task<bool> TEST_MultipleSessionsCanBeStartedWhilepaused()
using var memoryStream3 = new MemoryStream();
Task<bool> subprocessTask = Utils.RunSubprocess(
currentAssembly: Assembly.GetExecutingAssembly(),
environment: new Dictionary<string,string> { { Utils.DiagnosticsMonitorAddressEnvKey, serverName } },
environment: new Dictionary<string,string> { { Utils.DiagnosticPortsEnvKey, $"{serverName},connect,suspend" } },
duringExecution: async (pid) =>
{
Stream stream = await server.AcceptAsync();
Expand Down Expand Up @@ -207,7 +207,7 @@ public static async Task<bool> TEST_CanStartAndStopSessionWhilepaused()
using var memoryStream3 = new MemoryStream();
Task<bool> subprocessTask = Utils.RunSubprocess(
currentAssembly: Assembly.GetExecutingAssembly(),
environment: new Dictionary<string,string> { { Utils.DiagnosticsMonitorAddressEnvKey, serverName } },
environment: new Dictionary<string,string> { { Utils.DiagnosticPortsEnvKey, $"{serverName},connect,suspend" } },
duringExecution: async (pid) =>
{
Stream stream = await server.AcceptAsync();
Expand Down Expand Up @@ -271,7 +271,7 @@ public static async Task<bool> TEST_DisabledCommandsError()
using var memoryStream3 = new MemoryStream();
Task<bool> subprocessTask = Utils.RunSubprocess(
currentAssembly: Assembly.GetExecutingAssembly(),
environment: new Dictionary<string,string> { { Utils.DiagnosticsMonitorAddressEnvKey, serverName } },
environment: new Dictionary<string,string> { { Utils.DiagnosticPortsEnvKey, $"{serverName},connect,suspend" } },
duringExecution: async (pid) =>
{
Stream stream = await server.AcceptAsync();
Expand Down
18 changes: 6 additions & 12 deletions src/tests/tracing/eventpipe/reverse/reverse.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ public static async Task<bool> TEST_RuntimeIsResilientToServerClosing()
currentAssembly: Assembly.GetExecutingAssembly(),
environment: new Dictionary<string,string>
{
{ Utils.DiagnosticsMonitorAddressEnvKey, serverName },
{ Utils.DiagnosticsMonitorPauseOnStartEnvKey, "0" }
{ Utils.DiagnosticPortsEnvKey, $"{serverName},connect,nosuspend" }
},
duringExecution: async (_) =>
{
Expand Down Expand Up @@ -59,8 +58,7 @@ public static async Task<bool> TEST_RuntimeConnectsToExistingServer()
currentAssembly: Assembly.GetExecutingAssembly(),
environment: new Dictionary<string,string>
{
{ Utils.DiagnosticsMonitorAddressEnvKey, serverName },
{ Utils.DiagnosticsMonitorPauseOnStartEnvKey, "0" }
{ Utils.DiagnosticPortsEnvKey, $"{serverName},connect,nosuspend" }
},
duringExecution: async (_) =>
{
Expand All @@ -85,8 +83,7 @@ public static async Task<bool> TEST_CanConnectServerAndClientAtSameTime()
currentAssembly: Assembly.GetExecutingAssembly(),
environment: new Dictionary<string,string>
{
{ Utils.DiagnosticsMonitorAddressEnvKey, serverName },
{ Utils.DiagnosticsMonitorPauseOnStartEnvKey, "0" }
{ Utils.DiagnosticPortsEnvKey, $"{serverName},connect,nosuspend" }
},
duringExecution: async (int pid) =>
{
Expand Down Expand Up @@ -139,8 +136,7 @@ public static async Task<bool> TEST_ServerWorksIfClientDoesntAccept()
currentAssembly: Assembly.GetExecutingAssembly(),
environment: new Dictionary<string,string>
{
{ Utils.DiagnosticsMonitorAddressEnvKey, serverName },
{ Utils.DiagnosticsMonitorPauseOnStartEnvKey, "0" }
{ Utils.DiagnosticPortsEnvKey, $"{serverName},connect,nosuspend" }
},
duringExecution: async (int pid) =>
{
Expand Down Expand Up @@ -181,8 +177,7 @@ public static async Task<bool> TEST_ServerIsResilientToNoBufferAgent()
currentAssembly: Assembly.GetExecutingAssembly(),
environment: new Dictionary<string,string>
{
{ Utils.DiagnosticsMonitorAddressEnvKey, serverName },
{ Utils.DiagnosticsMonitorPauseOnStartEnvKey, "0" }
{ Utils.DiagnosticPortsEnvKey, $"{serverName},connect,nosuspend" }
},
duringExecution: async (int pid) =>
{
Expand Down Expand Up @@ -220,8 +215,7 @@ public static async Task<bool> TEST_StandardConnectionStillWorksIfReverseConnect
currentAssembly: Assembly.GetExecutingAssembly(),
environment: new Dictionary<string,string>
{
{ Utils.DiagnosticsMonitorAddressEnvKey, serverName },
{ Utils.DiagnosticsMonitorPauseOnStartEnvKey, "0" }
{ Utils.DiagnosticPortsEnvKey, $"{serverName},connect,nosuspend" }
},
duringExecution: async (int pid) =>
{
Expand Down
3 changes: 1 addition & 2 deletions src/tests/tracing/eventpipe/reverseouter/reverseouter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ public static async Task<bool> TEST_ReverseConnectionCanRecycleWhileTracing()
currentAssembly: Assembly.GetExecutingAssembly(),
environment: new Dictionary<string,string>
{
{ Utils.DiagnosticsMonitorAddressEnvKey, serverName },
{ Utils.DiagnosticsMonitorPauseOnStartEnvKey, "0" }
{ Utils.DiagnosticPortsEnvKey, $"{serverName},connect,nosuspend" }
},
duringExecution: async (int pid) =>
{
Expand Down