Skip to content
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.

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

EventPipe support for ProcessInfo #87562

Merged
merged 10 commits into from
Jul 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion eng/pipelines/runtime.yml
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ extends:
extraStepsTemplate: /eng/pipelines/coreclr/nativeaot-post-build-steps.yml
extraStepsParameters:
creator: dotnet-bot
testBuildArgs: 'nativeaot tree ";nativeaot;Loader;Interop;tracing/eventpipe/config;tracing/eventpipe/diagnosticport;tracing/eventpipe/reverse;tracing/eventpipe/processenvironment;tracing/eventpipe/simpleruntimeeventvalidation;" test tracing/eventcounter/runtimecounters.csproj /p:BuildNativeAotFrameworkObjects=true'
testBuildArgs: 'nativeaot tree ";nativeaot;Loader;Interop;tracing/eventpipe/config;tracing/eventpipe/diagnosticport;tracing/eventpipe/reverse;tracing/eventpipe/processenvironment;tracing/eventpipe/simpleruntimeeventvalidation;tracing/eventpipe/processinfo2;" test tracing/eventcounter/runtimecounters.csproj /p:BuildNativeAotFrameworkObjects=true'
liveLibrariesBuildConfig: Release
testRunNamePrefixSuffix: NativeAOT_$(_BuildConfig)
extraVariablesTemplates:
Expand Down
95 changes: 85 additions & 10 deletions src/coreclr/nativeaot/Runtime/eventpipe/ep-rt-aot.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@
#include "holder.h"
#include "SpinLock.h"

#ifndef DIRECTORY_SEPARATOR_CHAR
#ifdef TARGET_UNIX
#define DIRECTORY_SEPARATOR_CHAR '/'
#else // TARGET_UNIX
#define DIRECTORY_SEPARATOR_CHAR '\\'
#endif // TARGET_UNIX
#endif

#ifdef TARGET_UNIX
// Per module (1 for NativeAOT), key that will be used to implement TLS in Unix
pthread_key_t eventpipe_tls_key;
Expand All @@ -41,7 +49,6 @@ thread_local EventPipeAotThreadHolderTLS EventPipeAotThreadHolderTLS::g_threadHo
ep_rt_lock_handle_t _ep_rt_aot_config_lock_handle;
CrstStatic _ep_rt_aot_config_lock;

ep_char8_t *volatile _ep_rt_aot_diagnostics_cmd_line;

#ifndef TARGET_UNIX
uint32_t *_ep_rt_aot_proc_group_offsets;
Expand Down Expand Up @@ -88,9 +95,63 @@ ep_rt_aot_sample_profiler_write_sampling_event_for_threads (
const ep_char8_t *
ep_rt_aot_entrypoint_assembly_name_get_utf8 (void)
{
// shipping criteria: no EVENTPIPE-NATIVEAOT-TODO left in the codebase
// TODO: Implement EventPipe assembly name - return filename in nativeaot?
return reinterpret_cast<const ep_char8_t*>("");
// We are (intentionally for now) using the module name rather than entry assembly
// Cannot use __cpp_threadsafe_static_init feature since it will bring in the C++ runtime and need to use threadsafe way to initialize entrypoint_assembly_name
static const ep_char8_t * entrypoint_assembly_name = nullptr;
LakshanF marked this conversation as resolved.
Show resolved Hide resolved
if (entrypoint_assembly_name == nullptr) {
ep_char8_t * entrypoint_assembly_name_local;
const TCHAR * wszModuleFileName = NULL;
HANDLE moduleHandle = PalGetModuleHandleFromPointer((void*)&ep_rt_aot_entrypoint_assembly_name_get_utf8);
if(PalGetModuleFileName(&wszModuleFileName, moduleHandle) == 0) {
entrypoint_assembly_name_local = reinterpret_cast<ep_char8_t *>(malloc(1));
if(entrypoint_assembly_name_local==NULL) {
return NULL;
}
*entrypoint_assembly_name_local = '\0';
}
else {
#ifdef HOST_WINDOWS
const wchar_t* process_name_const = wcsrchr(wszModuleFileName, DIRECTORY_SEPARATOR_CHAR);
if (process_name_const != NULL) {
process_name_const++;
}
LakshanF marked this conversation as resolved.
Show resolved Hide resolved
else {
process_name_const = reinterpret_cast<const wchar_t *>(wszModuleFileName);
}
size_t len = -1;
const wchar_t* extension = wcsrchr(process_name_const, '.');
if (extension != NULL) {
len = extension - process_name_const;
}
entrypoint_assembly_name_local = ep_rt_utf16_to_utf8_string(reinterpret_cast<const ep_char16_t *>(process_name_const), len);
#else
const ep_char8_t* process_name_const = strrchr(wszModuleFileName, DIRECTORY_SEPARATOR_CHAR);
if (process_name_const != NULL) {
process_name_const++;
}
else {
process_name_const = reinterpret_cast<const ep_char8_t *>(wszModuleFileName);
}
size_t len = strlen(process_name_const);
const ep_char8_t *extension = strrchr(process_name_const, '.');
if (extension != NULL) {
len = extension - process_name_const;
}
ep_char8_t* process_name = reinterpret_cast<ep_char8_t *>(malloc(len + 1));
if (process_name == NULL) {
return NULL;
}
memcpy(process_name, process_name_const, len);
process_name[len] = '\0';
entrypoint_assembly_name_local = reinterpret_cast<ep_char8_t*>(process_name);
#endif // HOST_WINDOWS
}

if (PalInterlockedCompareExchangePointer((void**)(&entrypoint_assembly_name), (void*)(entrypoint_assembly_name_local), nullptr) != nullptr)
free(entrypoint_assembly_name_local);
}

return entrypoint_assembly_name;
}

const ep_char8_t *
Expand All @@ -101,6 +162,20 @@ ep_rt_aot_diagnostics_command_line_get (void)
#ifdef TARGET_WINDOWS
const ep_char16_t* command_line = reinterpret_cast<const ep_char16_t *>(::GetCommandLineW());
return ep_rt_utf16_to_utf8_string(command_line, -1);
#elif TARGET_LINUX
FILE *cmdline_file = ::fopen("/proc/self/cmdline", "r");
LakshanF marked this conversation as resolved.
Show resolved Hide resolved
if (cmdline_file == nullptr)
return "";

char *line = NULL;
size_t line_len = 0;
if (::getline (&line, &line_len, cmdline_file) == -1) {
::fclose (cmdline_file);
return "";
}

::fclose (cmdline_file);
return reinterpret_cast<const ep_char8_t*>(line);
#else
return "";
#endif
Expand Down Expand Up @@ -388,10 +463,10 @@ ep_rt_aot_file_close (ep_rt_file_handle_t file_handle)

bool
ep_rt_aot_file_write (
ep_rt_file_handle_t file_handle,
const uint8_t *buffer,
uint32_t bytes_to_write,
uint32_t *bytes_written)
ep_rt_file_handle_t file_handle,
const uint8_t *buffer,
uint32_t bytes_to_write,
uint32_t *bytes_written)
{
#ifdef TARGET_WINDOWS
return ::WriteFile (file_handle, buffer, bytes_to_write, reinterpret_cast<LPDWORD>(bytes_written), NULL) != FALSE;
Expand Down Expand Up @@ -722,12 +797,12 @@ void ep_rt_aot_lock_requires_lock_not_held (const ep_rt_lock_handle_t *lock)
void ep_rt_aot_spin_lock_requires_lock_held (const ep_rt_spin_lock_handle_t *spin_lock)
{
EP_ASSERT (ep_rt_spin_lock_is_valid (spin_lock));
EP_ASSERT (spin_lock->lock->OwnedByCurrentThread ());
EP_ASSERT (spin_lock->lock->OwnedByCurrentThread ());
}

void ep_rt_aot_spin_lock_requires_lock_not_held (const ep_rt_spin_lock_handle_t *spin_lock)
{
EP_ASSERT (spin_lock->lock == NULL || !spin_lock->lock->OwnedByCurrentThread ());
EP_ASSERT (spin_lock->lock == NULL || !spin_lock->lock->OwnedByCurrentThread ());
}

#endif /* EP_CHECKED_BUILD */
Expand Down
4 changes: 4 additions & 0 deletions src/tests/Common/CoreCLRTestLibrary/Utilities.cs
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,10 @@ public static bool IsWindowsIoTCore
public static bool IsMonoRuntime => Type.GetType("Mono.RuntimeStructs") != null;
public static bool IsNotMonoRuntime => !IsMonoRuntime;
public static bool IsNativeAot => IsNotMonoRuntime && !IsReflectionEmitSupported;

public static bool HasAssemblyFiles => !string.IsNullOrEmpty(typeof(Utilities).Assembly.Location);
public static bool IsSingleFile => !HasAssemblyFiles;

#if NETCOREAPP
public static bool IsReflectionEmitSupported => RuntimeFeature.IsDynamicCodeSupported;
public static bool IsNotReflectionEmitSupported => !IsReflectionEmitSupported;
Expand Down
7 changes: 3 additions & 4 deletions src/tests/tracing/eventpipe/diagnosticport/diagnosticport.cs
Original file line number Diff line number Diff line change
Expand Up @@ -403,10 +403,9 @@ public static async Task<bool> TEST_CanGetProcessInfo2WhileSuspended()
}
else if (TestLibrary.Utilities.IsNativeAot)
{
// shipping criteria: no EVENTPIPE-NATIVEAOT-TODO left in the codebase
// https://github.com/dotnet/runtime/issues/83051
// NativeAOT currently always returns empty string
Utils.Assert(processInfo2.ManagedEntrypointAssemblyName == string.Empty);
string expectedName = System.Reflection.Assembly.GetExecutingAssembly().GetName().Name;
LakshanF marked this conversation as resolved.
Show resolved Hide resolved
LakshanF marked this conversation as resolved.
Show resolved Hide resolved
Utils.Assert(expectedName.Equals(processInfo2.ManagedEntrypointAssemblyName),
$"ManagedEntrypointAssemblyName must match. Expected: {expectedName}, Received: {processInfo2.ManagedEntrypointAssemblyName}");
}
else
{
Expand Down
4 changes: 3 additions & 1 deletion src/tests/tracing/eventpipe/processinfo/processinfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,9 @@ public static int Main()
// /path/to/corerun /path/to/processinfo.dll
// or
// "C:\path\to\CoreRun.exe" C:\path\to\processinfo.dll
string currentProcessCommandLine = $"{currentProcess.MainModule.FileName} {System.Reflection.Assembly.GetExecutingAssembly().Location}";
string currentProcessCommandLine = TestLibrary.Utilities.IsSingleFile
? currentProcess.MainModule.FileName
: $"{currentProcess.MainModule.FileName} {System.Reflection.Assembly.GetExecutingAssembly().Location}";
string receivedCommandLine = NormalizeCommandLine(commandLine);
Utils.Assert(currentProcessCommandLine.Equals(receivedCommandLine, StringComparison.OrdinalIgnoreCase), $"CommandLine must match current process. Expected: {currentProcessCommandLine}, Received: {receivedCommandLine} (original: {commandLine})");
}
Expand Down
1 change: 1 addition & 0 deletions src/tests/tracing/eventpipe/processinfo/processinfo.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@
<ItemGroup>
<Compile Include="$(MSBuildProjectName).cs" />
<ProjectReference Include="../common/common.csproj" />
<ProjectReference Include="$(TestSourceDir)Common\CoreCLRTestLibrary\CoreCLRTestLibrary.csproj" />
</ItemGroup>
</Project>
4 changes: 3 additions & 1 deletion src/tests/tracing/eventpipe/processinfo2/processinfo2.cs
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,9 @@ public static int Main()
// /path/to/corerun /path/to/processinfo.dll
// or
// "C:\path\to\CoreRun.exe" C:\path\to\processinfo.dll
string currentProcessCommandLine = $"{currentProcess.MainModule.FileName} {System.Reflection.Assembly.GetExecutingAssembly().Location}";
string currentProcessCommandLine = TestLibrary.Utilities.IsSingleFile
? currentProcess.MainModule.FileName
: $"{currentProcess.MainModule.FileName} {System.Reflection.Assembly.GetExecutingAssembly().Location}";
string receivedCommandLine = NormalizeCommandLine(commandLine);
Utils.Assert(currentProcessCommandLine.Equals(receivedCommandLine, StringComparison.OrdinalIgnoreCase), $"CommandLine must match current process. Expected: {currentProcessCommandLine}, Received: {receivedCommandLine} (original: {commandLine})");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@
<ItemGroup>
<Compile Include="$(MSBuildProjectName).cs" />
<ProjectReference Include="../common/common.csproj" />
<ProjectReference Include="$(TestSourceDir)Common\CoreCLRTestLibrary\CoreCLRTestLibrary.csproj" />
</ItemGroup>
</Project>