[Linux][EventPipe][UserEvents] Add user events eventpipe support (#115265)

* [DiagnosticServer] Refactor and Cleanup

Visual reorder of Diagnostics enum structs
Fix a couple naming typos
Spaces to tabs consistency

* [EventPipe] Add User_events structs

* [EventPipe] Add User_events eventpipe session

* [DiagnosticServer] Revamp Provider Config deserialization

To support the new user_events-based eventpipe session, add
a more modular and flexible EventPipeProviderConfiguration deserializer.

* [DiagnosticServer] Deprecate old deserializer

* [DiagnosticServer] Add CollectTracing5 command parser

* [DiagnosticServer] Deserialize file_descriptor from IPC Stream

The user_events_data file is required to register user_events tracepoints.
Require profilers to pass over the corresponding file descriptor with
SCM_RIGHTS in order to initialize the user_events EventPipe session.

* [EventPipe] Use Event_filter to set EventPipeEvent enabled mask

* [UserEvents] Register and unregister tracepoints

* [UserEvents] Write events to tracepoints

* Fixup CI build failures

* Cleanup missed CI build failures

* Address feedback

Fix parameter order
Use umap_ptr_uint32 macros for EventFilter
Remove tracepoint_name const qualifier
Prevent buffer overflow in tracepoint_format copying
Skip duplicate tracepoint config fini
Null out tracepoint after transferring ownership
Use dn_vector_ptr_t for provider configurations
Wrap entire functions under macro checks
Use int for file descriptor
Fix formatting
Add checks for ep_session_disable session specific logic
Use dn_vector_ptr for the tracepoints sets
Use switch case for event writing
Scope tracepoint registration to sessions
Remove ep prefix from static functions
Move includes to source
Define max tracepoint format length

* Address Feedback const EventPipeProviderConfiguration

Adhere to the standard where EventPipeProviderConfiguration is
read-only. Create event filter and tracepoint config duplication helpers
to give the SessionProvider its own copy.

* Address feedback Add string deserializer helper

* Revert provider_configs to vector of structs

* Dynamically allocate tracepoint format

* Fix CI Build failures

* Split ProviderConfiguration structs

* Reuse EventPipeSessionTypes

* Constrain tracepoint_config modification to session provider

* Fixup compilation error

* Move metadata into extensions portion

* Free default tracepoint format

* Address feedback

Use ep_provider_config_fini helper
Add session_type deserializing helper
Fix tabbing
Add dn_umap_uint32_ptr macro
Handle tracepoint registration failure
Change ep_session_write_event order
Use dn_list foreach
Add size check to extension activity ids construction
Add ep_rt_utf8_string_printf_alloc helper

* Address feedback

Refactor tracepoint writing logic
Use local constants
Rename provider config parser

* Consistently use addresses of struct fields

* Fix typo

* Address feedback

Make struct data ownership consistent by removing const
Make external source files use getters and internal source files
directly access data.
Add session_provider_tracepoint_free
Disallow null tracepoint_name in tracepoint_format_alloc
Remove redundant checks
Cleanup ep_rt_utf8_string_printf_alloc
Cleanup writing to tracepoint

* Address feedback

Update ep_provider_config_init/fini callsites
Make resource cleanup logic consistent
Account for early exit memory leaks
Various cleanup

* Address Feedback

Fix eventpipe_collect_tracing_command_free_tracepoint_sets logic
Clarify len variable names
Consistently use -1 as invalid file descriptor
Update event_pipe to use ep_rt_utf16_to_utf8_string/free

* Fix Sign mismatch build error

Author: mdh1418

src/coreclr/nativeaot/Runtime/eventpipeinternal.cpp

@@ -67,12 +67,16 @@ EXTERN_C uint64_t QCALLTYPE EventPipeInternal_Enable(
 
     if (configProviders) {
         for (uint32_t i = 0; i < numProviders; ++i) {
+            ep_char8_t *providerName = ep_rt_utf16_to_utf8_string (reinterpret_cast<const ep_char16_t *>(nativeProviders[i].pProviderName));
+            ep_char8_t *filterData = ep_rt_utf16_to_utf8_string (reinterpret_cast<const ep_char16_t *>(nativeProviders[i].pFilterData));
             ep_provider_config_init (
                 &configProviders[i],
-                ep_rt_utf16_to_utf8_string (reinterpret_cast<const ep_char16_t *>(nativeProviders[i].pProviderName)),
+                providerName,
                 nativeProviders[i].keywords,
                 static_cast<EventPipeEventLevel>(nativeProviders[i].loggingLevel),
-                ep_rt_utf16_to_utf8_string (reinterpret_cast<const ep_char16_t *>(nativeProviders[i].pFilterData)));
+                filterData);
+            ep_rt_utf8_string_free (providerName);
+            ep_rt_utf8_string_free (filterData);
         }
     }
 
@@ -95,10 +99,8 @@ EXTERN_C uint64_t QCALLTYPE EventPipeInternal_Enable(
     ep_start_streaming(result);
 
     if (configProviders) {
-        for (uint32_t i = 0; i < numProviders; ++i) {
-            ep_rt_utf8_string_free ((ep_char8_t *)ep_provider_config_get_provider_name (&configProviders[i]));
-            ep_rt_utf8_string_free ((ep_char8_t *)ep_provider_config_get_filter_data (&configProviders[i]));
-        }
+        for (uint32_t i = 0; i < numProviders; ++i)
+            ep_provider_config_fini (&configProviders[i]);
         free(configProviders);
     }
 

src/coreclr/vm/eventpipeadapter.h

@@ -40,12 +40,16 @@ class EventPipeProviderConfigurationAdapter final
 		m_providerConfigsLen = providerConfigsLen;
 		if (m_providerConfigs) {
 			for (uint32_t i = 0; i < providerConfigsLen; ++i) {
+				ep_char8_t *providerName = ep_rt_utf16_to_utf8_string (reinterpret_cast<const ep_char16_t *>(providerConfigs[i].providerName));
+				ep_char8_t *filterData = ep_rt_utf16_to_utf8_string (reinterpret_cast<const ep_char16_t *>(providerConfigs[i].filterData));
 				ep_provider_config_init (
 					&m_providerConfigs[i],
-					ep_rt_utf16_to_utf8_string (reinterpret_cast<const ep_char16_t *>(providerConfigs[i].providerName)),
+					providerName,
 					providerConfigs[i].keywords,
 					static_cast<EventPipeEventLevel>(providerConfigs[i].loggingLevel),
-					ep_rt_utf16_to_utf8_string (reinterpret_cast<const ep_char16_t *>(providerConfigs[i].filterData)));
+					filterData);
+				ep_rt_utf8_string_free (providerName);
+				ep_rt_utf8_string_free (filterData);
 			}
 		}
 	}
@@ -54,10 +58,8 @@ class EventPipeProviderConfigurationAdapter final
 	{
 		STATIC_CONTRACT_NOTHROW;
 		if (m_providerConfigs) {
-			for (uint32_t i = 0; i < m_providerConfigsLen; ++i) {
-				ep_rt_utf8_string_free ((ep_char8_t *)ep_provider_config_get_provider_name (&m_providerConfigs[i]));
-				ep_rt_utf8_string_free ((ep_char8_t *)ep_provider_config_get_filter_data (&m_providerConfigs[i]));
-			}
+			for (uint32_t i = 0; i < m_providerConfigsLen; ++i)
+				ep_provider_config_fini(&m_providerConfigs[i]);
 			delete [] m_providerConfigs;
 		}
 	}
@@ -385,7 +387,9 @@ class EventPipeAdapter final
 			ep_provider_config_get_provider_name (&config[0]),
 			ep_provider_config_get_keywords (&config[0]),
 			(EventPipeEventLevel)ep_provider_config_get_logging_level (&config[0]),
-			ep_provider_config_get_filter_data (&config[0]));
+			ep_provider_config_get_filter_data (&config[0]),
+			NULL,
+			NULL);
 	}
 
 	static HRESULT GetProviderName(const EventPipeProvider *provider, ULONG numNameChars, ULONG *numNameCharsOut, LPWSTR name)

src/mono/mono/component/event_pipe.c

@@ -151,19 +151,22 @@ event_pipe_enable (
 	IpcStream *stream,
 	EventPipeSessionSynchronousCallback sync_callback)
 {
-	ERROR_DECL (error);
 	EventPipeSessionID session_id = 0;
 
 	EventPipeProviderConfiguration *config_providers = g_new0 (EventPipeProviderConfiguration, providers_len);
 
 	if (config_providers) {
 		for (guint32 i = 0; i < providers_len; ++i) {
+			ep_char8_t *provider_name = ep_rt_utf16_to_utf8_string ((const ep_char16_t *)(providers[i].provider_name));
+			ep_char8_t *filter_data = ep_rt_utf16_to_utf8_string ((const ep_char16_t *)(providers[i].filter_data));
 			ep_provider_config_init (
 				&config_providers[i],
-				providers[i].provider_name ? mono_utf16_to_utf8 (providers[i].provider_name, g_utf16_len (providers[i].provider_name), error) : NULL,
+				provider_name,
 				providers [i].keywords,
 				(EventPipeEventLevel)providers [i].logging_level,
-				providers[i].filter_data ? mono_utf16_to_utf8 (providers[i].filter_data, g_utf16_len (providers[i].filter_data), error) : NULL);
+				filter_data);
+			ep_rt_utf8_string_free (provider_name);
+			ep_rt_utf8_string_free (filter_data);
 		}
 	}
 
@@ -180,11 +183,8 @@ event_pipe_enable (
 		NULL);
 
 	if (config_providers) {
-		for (guint32 i = 0; i < providers_len; ++i) {
+		for (guint32 i = 0; i < providers_len; ++i)
 			ep_provider_config_fini (&config_providers[i]);
-			g_free ((ep_char8_t *)ep_provider_config_get_provider_name (&config_providers[i]));
-			g_free ((ep_char8_t *)ep_provider_config_get_filter_data (&config_providers[i]));
-		}
 	}
 
 	return session_id;

src/mono/mono/eventpipe/test/ep-buffer-manager-tests.c

@@ -103,7 +103,8 @@ buffer_manager_init (
 			current_provider_config,
 			1,
 			NULL,
-			NULL);
+			NULL,
+			0);
 	EP_LOCK_EXIT (section1)
 
 	ep_raise_error_if_nok (*session != NULL);

src/mono/mono/eventpipe/test/ep-buffer-tests.c

@@ -91,7 +91,8 @@ load_buffer_with_events_init (
 			current_provider_config,
 			1,
 			NULL,
-			NULL);
+			NULL,
+			0);
 	EP_LOCK_EXIT (section1)
 
 	ep_raise_error_if_nok (*session != NULL);

src/mono/mono/eventpipe/test/ep-session-tests.c

@@ -51,7 +51,8 @@ test_create_delete_session (void)
 			current_provider_config,
 			1,
 			NULL,
-			NULL);
+			NULL,
+			0);
 	EP_LOCK_EXIT (section1)
 
 	ep_raise_error_if_nok (test_session != NULL);
@@ -93,7 +94,8 @@ test_add_session_providers (void)
 			current_provider_config,
 			1,
 			NULL,
-			NULL);
+			NULL,
+			0);
 
 		ep_raise_error_if_nok_holding_lock (test_session != NULL, section1);
 
@@ -111,7 +113,7 @@ test_add_session_providers (void)
 
 	test_location = 3;
 
-	test_session_provider = ep_session_provider_alloc (TEST_PROVIDER_NAME, 1, EP_EVENT_LEVEL_LOGALWAYS, "");
+	test_session_provider = ep_session_provider_alloc (TEST_PROVIDER_NAME, 1, EP_EVENT_LEVEL_LOGALWAYS, "", NULL, NULL);
 	ep_raise_error_if_nok (test_session_provider != NULL);
 
 	test_location = 4;
@@ -176,7 +178,8 @@ test_session_special_get_set (void)
 			current_provider_config,
 			1,
 			NULL,
-			NULL);
+			NULL,
+			0);
 	EP_LOCK_EXIT (section1)
 
 	ep_raise_error_if_nok (test_session != NULL);

src/mono/mono/eventpipe/test/ep-thread-tests.c

@@ -399,7 +399,8 @@ test_thread_session_state (void)
 			provider_config,
 			1,
 			NULL,
-			NULL);
+			NULL,
+			0);
 	EP_LOCK_EXIT (section1)
 
 	if (!session) {

src/native/containers/dn-umap-t.h

@@ -72,5 +72,6 @@ DN_UMAP_T (ptr, void *, int16, int16_t)
 DN_UMAP_T (ptr, void *, uint16, uint16_t)
 DN_UMAP_T (ptr, void *, int32, int32_t)
 DN_UMAP_T (ptr, void *, uint32, uint32_t)
+DN_UMAP_T (uint32, uint32_t, ptr, void *)
 
 #endif /* __DN_UMAP_T_H__ */

src/native/containers/dn-vector.c

@@ -268,6 +268,9 @@ dn_vector_custom_free (
 	dn_vector_t *vector,
 	dn_vector_dispose_func_t dispose_func)
 {
+	if (DN_UNLIKELY(!vector))
+		return;
+
 	dn_vector_custom_dispose (vector, dispose_func);
 	dn_allocator_free (vector->_internal._allocator, vector);
 }

src/native/eventpipe/configure.cmake

@@ -1,5 +1,6 @@
 include(CheckSymbolExists)
 include(CheckIncludeFile)
+include(CheckIncludeFiles)
 
 check_include_file(
     sys/socket.h
@@ -17,6 +18,31 @@ if (CLR_CMAKE_HOST_IOS OR CLR_CMAKE_HOST_TVOS OR CLR_CMAKE_HOST_ANDROID)
   set(FEATURE_PERFTRACING_DISABLE_DEFAULT_LISTEN_PORT 1)
 endif()
 
+check_include_file(
+    linux/user_events.h
+    HAVE_LINUX_USER_EVENTS_H
+)
+
+check_include_file(
+    sys/ioctl.h
+    HAVE_SYS_IOCTL_H
+)
+
+check_include_file(
+    unistd.h
+    HAVE_UNISTD_H
+)
+
+check_include_file(
+    "sys/uio.h"
+    HAVE_SYS_UIO_H
+)
+
+check_include_file(
+    errno.h
+    HAVE_ERRNO_H
+)
+
 if (NOT DEFINED EP_GENERATED_HEADER_PATH)
     message(FATAL_ERROR "Required configuration EP_GENERATED_HEADER_PATH not set.")
 endif (NOT DEFINED EP_GENERATED_HEADER_PATH)