PR feedback

Signed-off-by: Alan Jowett <alan.jowett@microsoft.com>

Author: Alan Jowett

libs/api/ebpf_api.cpp

@@ -2600,7 +2600,7 @@ _ebpf_pe_get_map_definitions(
         // at other times, they are 16-byte-aligned. Skip over them looking for the
         // map_entry_t which starts with an 8-byte-aligned NULL pointer where the previous
         // byte (if any) is also 00, and the following 8 bytes are also NULL. The next 8 bytes
-        // are not not NULL though.
+        // are not NULL though.
         uint32_t map_offset = 0;
         uint64_t zero = 0;
         while (map_offset + 24 < section_header.Misc.VirtualSize &&
@@ -5256,7 +5256,7 @@ ebpf_map_set_wait_handle(fd_t map_fd, uint64_t index, ebpf_handle_t handle) NO_E
 }
 CATCH_NO_MEMORY_EBPF_RESULT
 
-// Context structure for section data extraction
+// Context structure for section data extraction.
 typedef struct _ebpf_section_data_context
 {
     const char* section_name;
@@ -5265,7 +5265,7 @@ typedef struct _ebpf_section_data_context
     const uint8_t* section_data;
 } ebpf_section_data_context_t;
 
-// Callback function for PE section iteration
+// Callback function for PE section iteration.
 static int
 _ebpf_pe_find_section(
     _Inout_ void* context,
@@ -5283,9 +5283,9 @@ _ebpf_pe_find_section(
         ctx->section_found = true;
         ctx->section_size = buffer->bufLen;
         ctx->section_data = buffer->buf;
-        return 1; // Stop iteration
+        return 1; // Stop iteration.
     }
-    return 0; // Continue iteration
+    return 0; // Continue iteration.
 }
 CATCH_NO_MEMORY_INT(1)
 
@@ -5302,7 +5302,7 @@ ebpf_api_get_data_section(
         EBPF_RETURN_RESULT(EBPF_INVALID_ARGUMENT);
     }
 
-    // Determine file type by extension
+    // Determine file type by extension.
     std::string path(file_path);
     bool is_pe_file = false;
     if (path.size() > 4) {
@@ -5316,14 +5316,14 @@ ebpf_api_get_data_section(
     ebpf_result_t result = EBPF_SUCCESS;
 
     if (is_pe_file) {
-        // Parse PE file using pe-parse library
+        // Parse PE file using pe-parse library.
         std::scoped_lock pe_parse_lock(_pe_parse_mutex);
         parsed_pe* pe = ParsePEFromFile(file_path);
         if (pe == nullptr) {
             EBPF_RETURN_RESULT(EBPF_INVALID_OBJECT);
         }
 
-        // Set up context for section search
+        // Set up context for section search.
         ebpf_section_data_context_t section_context = {
             .section_name = section_name, .section_found = false, .section_size = 0, .section_data = nullptr};
 
@@ -5334,47 +5334,47 @@ ebpf_api_get_data_section(
             EBPF_RETURN_RESULT(EBPF_OBJECT_NOT_FOUND);
         }
 
-        // Check buffer size
+        // Check buffer size.
         if (data == nullptr) {
-            // Just return the size
+            // Just return the size.
             *data_size = section_context.section_size;
         } else if (*data_size < section_context.section_size) {
-            // Buffer too small
+            // Buffer too small.
             *data_size = section_context.section_size;
             DestructParsedPE(pe);
             EBPF_RETURN_RESULT(EBPF_INSUFFICIENT_BUFFER);
         } else {
-            // Copy data to buffer
+            // Copy data to buffer.
             memcpy(data, section_context.section_data, section_context.section_size);
             *data_size = section_context.section_size;
         }
 
         DestructParsedPE(pe);
     } else {
-        // Parse ELF file using ELFIO library
+        // Parse ELF file using ELFIO library.
         ELFIO::elfio reader;
         if (!reader.load(file_path)) {
             EBPF_RETURN_RESULT(EBPF_INVALID_OBJECT);
         }
 
-        // Find the section by name
+        // Find the section by name.
         ELFIO::section* section = reader.sections[section_name];
         if (section == nullptr || section->get_data() == nullptr) {
             EBPF_RETURN_RESULT(EBPF_OBJECT_NOT_FOUND);
         }
 
         size_t section_size = section->get_size();
 
-        // Check buffer size
+        // Check buffer size.
         if (data == nullptr) {
-            // Just return the size
+            // Just return the size.
             *data_size = section_size;
         } else if (*data_size < section_size) {
-            // Buffer too small
+            // Buffer too small.
             *data_size = section_size;
             EBPF_RETURN_RESULT(EBPF_INSUFFICIENT_BUFFER);
         } else {
-            // Copy data to buffer
+            // Copy data to buffer.
             memcpy(data, section->get_data(), section_size);
             *data_size = section_size;
         }

libs/ebpfnetsh/netsh_hash.cpp

@@ -12,8 +12,8 @@
 #include <string>
 #include <vector>
 
-// The following function uses windows specific type as an input to match
-// definition of "FN_HANDLE_CMD" in public file of NetSh.h
+// The following function uses Windows-specific types as an input to match
+// definition of "FN_HANDLE_CMD" in public file of NetSh.h.
 unsigned long
 handle_ebpf_show_hash(
     IN LPCWSTR machine,
@@ -63,7 +63,7 @@ handle_ebpf_show_hash(
         return status;
     }
 
-    // First get the size of the hash section
+    // First get the size of the hash section.
     size_t hash_size = 0;
     ebpf_result_t result = ebpf_api_get_data_section(filename.c_str(), "hash", nullptr, &hash_size);
 
@@ -83,7 +83,7 @@ handle_ebpf_show_hash(
         return ERROR_SUPPRESS_OUTPUT;
     }
 
-    // Allocate buffer and get the hash data
+    // Allocate buffer and get the hash data.
     std::vector<uint8_t> hash_data(hash_size);
     result = ebpf_api_get_data_section(filename.c_str(), "hash", hash_data.data(), &hash_size);
 
@@ -92,28 +92,28 @@ handle_ebpf_show_hash(
         return ERROR_SUPPRESS_OUTPUT;
     }
 
-    // Truncate hash to size of a SHA-256 hash if larger
+    // Truncate hash to size of a SHA-256 hash if larger.
     if (hash_size > 32) {
         hash_size = 32;
     }
 
-    // Resize vector to actual hash size
+    // Resize vector to actual hash size.
     hash_data.resize(hash_size);
 
     if (hash_only) {
-        // Print hash in PowerShell Get-FileHash format (uppercase, no spaces)
+        // Print hash in PowerShell Get-FileHash format (uppercase, no spaces).
         for (size_t i = 0; i < hash_size; i++) {
             std::cout << std::hex << std::uppercase << std::setw(2) << std::setfill('0')
                       << static_cast<unsigned int>(hash_data[i]);
         }
-        std::cout << std::dec << std::nouppercase << std::endl; // Reset formatting
+        std::cout << std::dec << std::nouppercase << std::endl; // Reset formatting.
     } else {
-        // Print detailed hash information
+        // Print detailed hash information.
         std::cout << "Hash for " << filename << ":" << std::endl;
         std::cout << "Size: " << hash_size << " bytes" << std::endl;
         std::cout << "Data: ";
 
-        // Print hash in hexadecimal format with spaces
+        // Print hash in hexadecimal format with spaces.
         for (size_t i = 0; i < hash_size; i++) {
             if (i > 0 && i % 16 == 0) {
                 std::cout << std::endl << "      ";
@@ -123,7 +123,7 @@ handle_ebpf_show_hash(
                 std::cout << " ";
             }
         }
-        std::cout << std::dec << std::endl; // Reset to decimal format
+        std::cout << std::dec << std::endl; // Reset to decimal format.
     }
 
     return NO_ERROR;

tests/end_to_end/end_to_end.cpp

@@ -3578,66 +3578,66 @@ TEST_CASE("ebpf_api_get_data_section", "[end_to_end]")
     _test_helper_end_to_end test_helper;
     test_helper.initialize();
 
-    // Test with PE files that exists (from the build output)
+    // Test with PE files that exist (from the build output).
     const char* pe_file_path = "map.sys";
     std::vector<uint8_t> data;
     size_t data_size = 0;
     ebpf_result_t result;
 
-    // Test 1: Valid PE file with nonexistent section (should return EBF_SUCCESS with the size of > 0)
+    // Test 1: Valid PE file with existing section (should return EBPF_SUCCESS with the size > 0).
     result = ebpf_api_get_data_section(pe_file_path, "hash", nullptr, &data_size);
     REQUIRE(result == EBPF_SUCCESS);
     REQUIRE(data_size > 0);
 
-    // Allocate buffer and get the data
+    // Allocate buffer and get the data.
     data.resize(data_size);
     size_t buffer_size = data_size;
     result = ebpf_api_get_data_section(pe_file_path, "hash", data.data(), &buffer_size);
     REQUIRE(result == EBPF_SUCCESS);
     REQUIRE(buffer_size == data_size);
 
-    // Test 2: Invalid file path (should return EBPF_FILE_NOT_FOUND or EBPF_INVALID_OBJECT)
+    // Test 2: Invalid file path (should return EBPF_INVALID_OBJECT).
     result = ebpf_api_get_data_section("nonexistent_file.sys", "hash", nullptr, &data_size);
     REQUIRE(result == EBPF_INVALID_OBJECT);
 
-    // Test 3: Try another PE file with nonexistent section
+    // Test 3: Try another PE file with nonexistent section.
     const char* pe_file_path2 = "ebpfcore.sys";
     result = ebpf_api_get_data_section(pe_file_path2, "hash", nullptr, &data_size);
     REQUIRE(result == EBPF_OBJECT_NOT_FOUND);
 
-    // Test 4: Valid ELF file with valid section
+    // Test 4: Valid ELF file with valid section.
     const char* elf_file_path = "map.o";
     result = ebpf_api_get_data_section(elf_file_path, "maps", nullptr, &data_size);
     REQUIRE(result == EBPF_SUCCESS);
 
-    // Allocate buffer and get the data
+    // Allocate buffer and get the data.
     data.resize(data_size);
     buffer_size = data_size;
     result = ebpf_api_get_data_section(elf_file_path, "maps", data.data(), &buffer_size);
     REQUIRE(result == EBPF_SUCCESS);
     REQUIRE(buffer_size == data_size);
 
-    // Test 5: Valid ELF file with nonexistent section
+    // Test 5: Valid ELF file with nonexistent section.
     result = ebpf_api_get_data_section(elf_file_path, "nonexistent_section", nullptr, &data_size);
     REQUIRE(result == EBPF_OBJECT_NOT_FOUND);
 
-    // Test 6: Invalid ELF file path
+    // Test 6: Invalid ELF file path.
     result = ebpf_api_get_data_section("nonexistent_file.o", "maps", nullptr, &data_size);
     REQUIRE(result == EBPF_INVALID_OBJECT);
 
-    // Test 7: Input buffer too small (ELF)
+    // Test 7: Input buffer too small (ELF).
     result = ebpf_api_get_data_section(elf_file_path, "maps", nullptr, &data_size);
     REQUIRE(result == EBPF_SUCCESS);
 
-    data.resize(data_size - 1); // Intentionally make buffer smaller
+    data.resize(data_size - 1); // Intentionally make buffer smaller.
     buffer_size = data_size - 1;
     result = ebpf_api_get_data_section(elf_file_path, "maps", data.data(), &buffer_size);
     REQUIRE(result == EBPF_INSUFFICIENT_BUFFER);
 
-    // Test: 8 Input buffer too small (PE)
+    // Test 8: Input buffer too small (PE).
     result = ebpf_api_get_data_section(pe_file_path, "hash", nullptr, &data_size);
     REQUIRE(result == EBPF_SUCCESS);
-    data.resize(data_size - 1); // Intentionally make buffer smaller
+    data.resize(data_size - 1); // Intentionally make buffer smaller.
     buffer_size = data_size - 1;
     result = ebpf_api_get_data_section(pe_file_path, "hash", data.data(), &buffer_size);
     REQUIRE(result == EBPF_INSUFFICIENT_BUFFER);

tests/end_to_end/netsh_test.cpp

@@ -1035,7 +1035,7 @@ _test_pin_unpin_map(ebpf_execution_type_t execution_type)
 
 DECLARE_ALL_TEST_CASES("pin/unpin map", "[netsh][pin]", _test_pin_unpin_map);
 
-// Test cases for show hash functionality
+// Test cases for show hash functionality.
 TEST_CASE("show hash nosuchfile.o", "[netsh][hash]")
 {
     _test_helper_netsh test_helper;
@@ -1064,7 +1064,7 @@ TEST_CASE("show hash PE file with hash section", "[netsh][hash]")
     test_helper.initialize();
 
     int result;
-    // Test with a PE file that has a hash section
+    // Test with a PE file that has a hash section.
     std::string output = _run_netsh_command(handle_ebpf_show_hash, L"map_reuse_um.dll", nullptr, nullptr, &result);
     REQUIRE(result == ERROR_SUCCESS);
     REQUIRE(output.find("Hash for map_reuse_um.dll:") != std::string::npos);
@@ -1078,7 +1078,7 @@ TEST_CASE("show hash PE file without hash section", "[netsh][hash]")
     test_helper.initialize();
 
     int result;
-    // Test with a PE file that doesn't have a hash section
+    // Test with a PE file that doesn't have a hash section.
     std::string output = _run_netsh_command(handle_ebpf_show_hash, L"EbpfApi.dll", nullptr, nullptr, &result);
     REQUIRE(result == ERROR_SUPPRESS_OUTPUT);
     REQUIRE(output == "No hash section found in EbpfApi.dll\n");
@@ -1090,20 +1090,20 @@ TEST_CASE("show hash PE file with hash section hashonly", "[netsh][hash]")
     test_helper.initialize();
 
     int result;
-    // Test with a PE file that has a hash section, hashonly format
+    // Test with a PE file that has a hash section, hashonly format.
     std::string output = _run_netsh_command(handle_ebpf_show_hash, L"map_reuse_um.dll", L"hashonly", nullptr, &result);
     REQUIRE(result == ERROR_SUCCESS);
 
-    // Verify output is exactly 64 hex characters (32 bytes) + newline, all uppercase, no spaces
+    // Verify output is exactly 64 hex characters (32 bytes) + newline, all uppercase, no spaces.
     REQUIRE(output.length() == 65); // 64 characters + newline
     REQUIRE(output[64] == '\n');
 
-    // Check that all characters are uppercase hex
+    // Check that all characters are uppercase hex.
     for (int i = 0; i < 64; i++) {
         REQUIRE(((output[i] >= '0' && output[i] <= '9') || (output[i] >= 'A' && output[i] <= 'F')));
     }
 
-    // Verify no spaces in the hash
+    // Verify no spaces in the hash.
     REQUIRE(output.find(' ') == std::string::npos);
 }
 
@@ -1113,7 +1113,7 @@ TEST_CASE("show hash PE file without hash section hashonly", "[netsh][hash]")
     test_helper.initialize();
 
     int result;
-    // Test with a PE file that doesn't have a hash section, hashonly format
+    // Test with a PE file that doesn't have a hash section, hashonly format.
     std::string output = _run_netsh_command(handle_ebpf_show_hash, L"EbpfApi.dll", L"hashonly", nullptr, &result);
     REQUIRE(result == ERROR_SUPPRESS_OUTPUT);
     REQUIRE(output == "No hash section found in EbpfApi.dll\n");