Convert usersim to a DLL (#2683)

* Use usersim as DLL Signed-off-by: Dave Thaler <[email protected]> * Convert usersim to a DLL Signed-off-by: Dave Thaler <[email protected]> * Make cmake build clear program info state like VS build does PR #1192 updated the vcxproj file but not the corresponding CMakeLists.txt file for export_program_info Signed-off-by: Dave Thaler <[email protected]> * Pick up latest usersim fix Signed-off-by: Dave Thaler <[email protected]> * Fix deadlock in epoch_test_stale_items test Signed-off-by: Dave Thaler <[email protected]> * Don't throw exceptions in unit tests Signed-off-by: Dave Thaler <[email protected]> * Fix single instance hook initialization in test cases Signed-off-by: Dave Thaler <[email protected]> * Fix deadlock in performance test Signed-off-by: Dave Thaler <[email protected]> * Add usersim.dll to installer files Signed-off-by: Dave Thaler <[email protected]> --------- Signed-off-by: Dave Thaler <[email protected]>
microsoft · Jul 27, 2023 · a29064a · a29064a
1 parent d5e52ae
commit a29064a
Show file tree

Hide file tree

Showing 19 changed files with 123 additions and 78 deletions.
diff --git a/external/usersim b/external/usersim
diff --git a/installer/Product.wxs b/installer/Product.wxs
@@ -218,6 +218,15 @@ SPDX-License-Identifier: MIT
 			<Component Id="EXPORT_PROGRAM_INFO.PDB" DiskId="1" Guid="{88356FE4-6247-4876-BA14-42EDA88CC5C7}">
 				<File Id="EXPORT_PROGRAM_INFO.PDB" Name="export_program_info.pdb" Source="$(var.export_program_info.TargetDir)export_program_info.pdb" />
 			</Component>
+			<!-- TODO(#2677): move usersim.dll down to the testing component.  Until that issue is addressed,
+			     export_program_info.exe requires it.
+			-->
+			<Component Id="USERSIM.DLL" DiskId="1" Guid="{739017F0-9E33-48FF-A33F-C1434AC757BE}">
+				<File Id="USERSIM.DLL" Name="usersim.dll" Source="$(var.SolutionDir)$(var.Platform)\$(var.Configuration)\usersim.dll" />
+			</Component>
+			<Component Id="USERSIM.PDB" DiskId="1" Guid="{BCE1BF99-6A3D-48A6-A382-4E87A2B20FB2}">
+				<File Id="USERSIM.PDB" Name="usersim.pdb" Source="$(var.SolutionDir)$(var.Platform)\$(var.Configuration)\usersim.pdb" />
+			</Component>
 		</ComponentGroup>
 
 		<!--Clear/Setup the eBPF store-->

diff --git a/libs/execution_context/unit/execution_context_unit_test.cpp b/libs/execution_context/unit/execution_context_unit_test.cpp
@@ -790,6 +790,7 @@ TEST_CASE("program", "[execution_context]")
     // Correct attach type, but wrong program type.
     {
         single_instance_hook_t hook(EBPF_PROGRAM_TYPE_BIND, EBPF_ATTACH_TYPE_XDP);
+        REQUIRE(hook.initialize() == EBPF_SUCCESS);
         ebpf_link_t* local_link = nullptr;
         REQUIRE(ebpf_link_create(EBPF_ATTACH_TYPE_XDP, nullptr, 0, &local_link) == EBPF_SUCCESS);
         link.reset(local_link);
@@ -799,6 +800,7 @@ TEST_CASE("program", "[execution_context]")
     // Wrong attach type, but correct program type.
     {
         single_instance_hook_t hook(EBPF_PROGRAM_TYPE_XDP, EBPF_ATTACH_TYPE_BIND);
+        REQUIRE(hook.initialize() == EBPF_SUCCESS);
         ebpf_link_t* local_link = nullptr;
         REQUIRE(ebpf_link_create(EBPF_ATTACH_TYPE_XDP, nullptr, 0, &local_link) == EBPF_SUCCESS);
         link.reset(local_link);
@@ -808,6 +810,7 @@ TEST_CASE("program", "[execution_context]")
     // Correct attach type and correct program type.
     {
         single_instance_hook_t hook(EBPF_PROGRAM_TYPE_XDP, EBPF_ATTACH_TYPE_XDP);
+        REQUIRE(hook.initialize() == EBPF_SUCCESS);
         ebpf_link_t* local_link = nullptr;
         REQUIRE(ebpf_link_create(EBPF_ATTACH_TYPE_XDP, nullptr, 0, &local_link) == EBPF_SUCCESS);
         link.reset(local_link);

diff --git a/libs/platform/ebpf_platform.c b/libs/platform/ebpf_platform.c
@@ -559,3 +559,16 @@ ebpf_free_timer_work_item(_Frees_ptr_opt_ ebpf_timer_work_item_t* work_item)
     KeFlushQueuedDpcs();
     ebpf_free(work_item);
 }
+
+_Must_inspect_result_ ebpf_result_t
+ebpf_platform_initiate()
+{
+    ebpf_initialize_cpu_count();
+    return EBPF_SUCCESS;
+}
+
+void
+ebpf_platform_terminate()
+{
+    KeFlushQueuedDpcs();
+}
diff --git a/libs/platform/kernel/ebpf_platform_kernel.c b/libs/platform/kernel/ebpf_platform_kernel.c
@@ -21,19 +21,6 @@ typedef struct _ebpf_ring_descriptor ebpf_ring_descriptor_t;
 static KDEFERRED_ROUTINE _ebpf_deferred_routine;
 static KDEFERRED_ROUTINE _ebpf_timer_routine;
 
-_Must_inspect_result_ ebpf_result_t
-ebpf_platform_initiate()
-{
-    ebpf_initialize_cpu_count();
-    return EBPF_SUCCESS;
-}
-
-void
-ebpf_platform_terminate()
-{
-    KeFlushQueuedDpcs();
-}
-
 __drv_allocatesMem(Mem) _Must_inspect_result_
     _Ret_writes_maybenull_(size) void* ebpf_allocate_cache_aligned_with_tag(size_t size, uint32_t tag)
 {

diff --git a/libs/platform/unit/platform_unit_test.cpp b/libs/platform/unit/platform_unit_test.cpp
@@ -450,9 +450,6 @@ TEST_CASE("epoch_test_stale_items", "[platform]")
         return;
     }
 
-    KIRQL old_irql;
-    KeRaiseIrql(DISPATCH_LEVEL, &old_irql);
-
     size_t const test_iterations = 100;
     for (size_t test_iteration = 0; test_iteration < test_iterations; test_iteration++) {
 
@@ -491,8 +488,6 @@ TEST_CASE("epoch_test_stale_items", "[platform]")
         REQUIRE(ebpf_epoch_is_free_list_empty(0));
         REQUIRE(ebpf_epoch_is_free_list_empty(1));
     }
-
-    KeLowerIrql(old_irql);
 }
 
 static auto provider_function = []() { return EBPF_SUCCESS; };

diff --git a/libs/platform/user/ebpf_platform_user.cpp b/libs/platform/user/ebpf_platform_user.cpp
@@ -24,29 +24,6 @@ bool _ebpf_platform_code_integrity_enabled = false;
 
 extern "C" size_t ebpf_fuzzing_memory_limit = MAXSIZE_T;
 
-static bool _usersim_platform_initiated = false;
-
-_Must_inspect_result_ ebpf_result_t
-ebpf_platform_initiate()
-{
-    ebpf_initialize_cpu_count();
-    if (!NT_SUCCESS(usersim_platform_initiate())) {
-        return EBPF_NO_MEMORY;
-    }
-    _usersim_platform_initiated = true;
-    return EBPF_SUCCESS;
-}
-
-void
-ebpf_platform_terminate()
-{
-    if (_usersim_platform_initiated) {
-        KeFlushQueuedDpcs();
-        usersim_platform_terminate();
-        _usersim_platform_initiated = false;
-    }
-}
-
 _Must_inspect_result_ ebpf_result_t
 ebpf_get_code_integrity_state(_Out_ ebpf_code_integrity_state_t* state)
 {

diff --git a/scripts/deploy-ebpf.ps1.in b/scripts/deploy-ebpf.ps1.in
@@ -7,6 +7,8 @@
 $source_directory="."
 
 # The following files should be installed on all platforms.
+# TODO(#2677): export_program_info.exe temporarily requires usersim.dll,
+# usersim.dll should get moved down to the test files list.
 [System.Collections.ArrayList]$built_runtime_files=@(
     "bpftool.exe",
     "bpftool.pdb",
@@ -24,7 +26,9 @@ $source_directory="."
     "NetEbpfExt.sys",
     "NetEbpfExt.pdb",
     "net-ebpf-ext.guid",
-    "ucrtbased.dll")
+    "ucrtbased.dll",
+    "usersim.dll",
+    "usersim.pdb")
 
 [System.Collections.ArrayList]$built_runtime_jit_files=@(
     "ebpfsvc.exe",
+3 −0		inc/TraceLoggingProvider.h
+13 −13		inc/ndis.h
+10 −0		inc/usersim/common.h
+33 −10		inc/usersim/ex.h
+54 −0		inc/usersim/fwp_test.h
+7 −0		inc/usersim/io.h
+79 −15		inc/usersim/ke.h
+8 −0		inc/usersim/mm.h
+2 −0		inc/usersim/ps.h
+20 −1		inc/usersim/rtl.h
+17 −12		inc/usersim/se.h
+32 −0		inc/wdf.h
+5 −4		src/CMakeLists.txt
+47 −0		src/Source.def
+0 −32		src/dll_skeleton.c
+22 −0		src/dllmain.cpp
+1 −0		src/fault_injection.h
+156 −89		src/fwp_um.cpp
+1 −18		src/fwp_um.h
+115 −20		src/ke.cpp
+3 −0		src/kernel_um.h
+8 −3		src/platform.h
+40 −50		src/platform_user.cpp
+10 −7		src/rtl.cpp
+94 −23		src/se.cpp
+15 −7		src/usersim.vcxproj
+12 −1		src/usersim.vcxproj.filters
+7 −1		tests/CMakeLists.txt
+51 −0		tests/ex_test.cpp
+55 −121		tests/ke_test.cpp
+53 −0		tests/mm_test.cpp
+325 −0		tests/nmr_test.cpp
+18 −0		tests/rtl_test.cpp
+54 −0		tests/se_test.cpp
+7 −1		tests/tests.vcxproj
+19 −1		tests/tests.vcxproj.filters
+17 −0		tests/wdf_test.cpp