Clean up order of includes

.clang-format

@@ -19,5 +19,48 @@ BinPackParameters: false
 # Open brace goes on new line only when starting a new struct, enum, or func.
 BreakBeforeBraces: Mozilla
 #
-# Don't sort includes in alphabetical order because Windows headers are odd.
-SortIncludes: false
+# Special include file sort ordering rules.
+# Priority indicates the "group" (where groups are separated by a blank line).
+# SortPriority indicates the overall order when we need to override alphabetical
+# order due to Windows header dependencies.
+SortIncludes: 'true'
+IncludeBlocks: Regroup
+IncludeIsMainRegex: "UNUSED$"
+IncludeCategories:
+  # winsock2.h must be before in6addr.h or windows.h
+  - Regex: '^<[Ww]insock2.h>'
+    Priority: 2
+    SortPriority: 2
+  - Regex: '^<in6addr.h>'
+    Priority: 2
+    SortPriority: 3
+  # windows.h must be before ElfWrapper.h or netsh.h
+  - Regex: '^<[Ww]indows.h>'
+    Priority: 2
+    SortPriority: 3
+  # ws2def.h and ws2ipdef.h must be before iphlpapi.h
+  - Regex: '^<(ws2def|ws2ipdef).h>'
+    Priority: 2
+    SortPriority: 3
+  # ws2tcpip.h must be before mstcpip.h
+  - Regex: '^<ws2tcpip.h>'
+    Priority: 2
+    SortPriority: 3
+  - Regex: '^(<|")ElfWrapper.h'
+    Priority: 2
+    SortPriority: 4
+  # ntifs.h must be before ntddk.h
+  - Regex: '^<ntifs.h'
+    Priority: 2
+    SortPriority: 4
+  # ndis.h must be before fwpsk.h
+  - Regex: '^<ndis.h'
+    Priority: 2
+    SortPriority: 4
+  - Regex: '\.c"'
+    Priority: 6
+  - Regex: '^"'
+    Priority: 1
+  - Regex: '^<'
+    Priority: 2
+    SortPriority: 5

.gitignore

@@ -11,6 +11,7 @@
 /**/.[Gg]radle/**
 /**/[Rr]elease/**
 /**/[Dd]ebug/**
+/**/FuzzerDebug/**
 /**/[Tt]arget/**
 
 # All kinds of output and temporary files that should not be checked in.
@@ -24,6 +25,7 @@
 /**/*.beam
 /**/*.trx
 /**/*.log
+/**/*.tlog
 /**/.vs/
 /**/*.bak
 /**/*.suo

docs/DevelopmentGuide.md

@@ -39,8 +39,12 @@ Header Files
   headers to be included first.  That is, any dependencies should be included within
   the header file itself.
 
-* **DO** include system headers (with `<>`) before local headers (with `""`), and list them
-  in alphabetical order where possible.  This helps ensure there are not duplicate includes,
+* **DO** include local headers (with `""`) before system headers (with `<>`). This
+  helps ensure that local headers don't have dependencies on other things being
+  included first, and is also consistent with the use of a local header for precompiled
+  headers.
+
+* **DO** list headers in alphabetical order where possible.  This helps ensure there are not duplicate includes,
   and also helps ensure that headers are usable directly.
 
 * **DO** use `#pragma once` in all header files, rather than using ifdefs to test for duplicate inclusion.

ebpfapi/CMakeLists.txt

@@ -4,7 +4,6 @@
 add_library("EbpfApi" SHARED
   Source.def
 
-  pch.h
   resource.h
 
   dllmain.cpp

ebpfapi/dllmain.cpp

@@ -1,9 +1,12 @@
 // Copyright (c) Microsoft Corporation
 // SPDX-License-Identifier: MIT
 
-// dllmain.cpp : Defines the entry point for the DLL application.
-#include "pch.h"
+/**
+ * @file
+ * @brief Defines the entry point for the DLL application.
+ */
 #include "api_internal.h"
+#include "framework.h"
 
 bool use_ebpf_store = true;
 

ebpfapi/ebpfapi.vcxproj

@@ -102,7 +102,6 @@
     <ClInclude Include="..\libs\api\platform.h">
       <DeploymentContent Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">true</DeploymentContent>
     </ClInclude>
-    <ClInclude Include="pch.h" />
     <ClInclude Include="resource.h" />
   </ItemGroup>
   <ItemGroup>

ebpfapi/ebpfapi.vcxproj.filters

@@ -19,9 +19,6 @@
     </Filter>
   </ItemGroup>
   <ItemGroup>
-    <ClInclude Include="pch.h">
-      <Filter>Header Files</Filter>
-    </ClInclude>
     <ClInclude Include="..\libs\api\platform.h">
       <Filter>Header Files</Filter>
     </ClInclude>

ebpfapi/rpc_client.cpp

@@ -1,20 +1,21 @@
 // Copyright (c) Microsoft Corporation
 // SPDX-License-Identifier: MIT
 
+#include "ebpf_api.h"
+#include "ebpf_platform.h"
+
+#include "rpc_interface_c.c"
+
 // Windows.h needs to be included before other headers.
 // It has a #define for WINAPI_FAMILY_PARTITION among others that control
 // the behavior of other Windows headers.
 #include <winsock2.h>
 #include <windows.h>
-
 #include <ctype.h>
 #include <iostream>
 #include <sddl.h>
 #include <stdio.h>
 #include <stdlib.h>
-#include "ebpf_api.h"
-#include "ebpf_platform.h"
-#include "rpc_interface_c.c"
 
 #pragma comment(lib, "Rpcrt4.lib")
 
@@ -136,4 +137,4 @@ void __RPC_USER
 MIDL_user_free(_Pre_maybenull_ _Post_invalid_ void* p)
 {
     ebpf_free(p);
-}
+}

ebpfcore/ebpf_drv.c

@@ -1,28 +1,18 @@
 // Copyright (c) Microsoft Corporation
 // SPDX-License-Identifier: MIT
 
-/*++
-
-Abstract:
-WDF based driver that does the following:
-1. Initializes the eBPF execution context.
-2. Opens an IOCTL surface that forwards commands to ebpf_core.
-
-Environment:
-
-    Kernel mode
-
---*/
-
-// ntddk.h needs to be included first due to inter header dependencies on Windows.
-#include <ntddk.h>
-
-#include <netiodef.h>
-#include <wdf.h>
+/**
+ * @file
+ * WDF based driver that does the following:
+ * 1. Initializes the eBPF execution context.
+ * 2. Opens an IOCTL surface that forwards commands to ebpf_core.
+ */
 
 #include "ebpf_core.h"
 #include "ebpf_object.h"
 
+#include <wdf.h>
+
 // Driver global variables
 static DEVICE_OBJECT* _ebpf_driver_device_object;
 static BOOLEAN _ebpf_driver_unloading_flag = FALSE;

ebpfsvc/rpc_api.cpp

@@ -1,13 +1,14 @@
 // Copyright (c) Microsoft Corporation
 // SPDX-License-Identifier: MIT
 
+#include "api_service.h"
+#include "rpc_interface_h.h"
+#include "svc_common.h"
+
 #include <mutex>
 #include <stdexcept>
 #include <stdio.h>
 #include <vector>
-#include "api_service.h"
-#include "rpc_interface_h.h"
-#include "svc_common.h"
 
 bool use_ebpf_store = false;
 

ebpfsvc/rpc_util.cpp

@@ -1,16 +1,14 @@
 // Copyright (c) Microsoft Corporation
 // SPDX-License-Identifier: MIT
 
-// Windows.h needs to be included before other headers.
-// It has a #define for WINAPI_FAMILY_PARTITION among others that control
-// the behavior of other Windows headers.
+#include "svc_common.h"
+
 #include <winsock2.h>
 #include <windows.h>
-
 #include <malloc.h>
 #include <sddl.h>
+
 #include "rpc_interface_s.c"
-#include "svc_common.h"
 
 #pragma comment(lib, "Rpcrt4.lib")
 
@@ -126,4 +124,4 @@ void __RPC_USER
 MIDL_user_free(_Pre_maybenull_ _Post_invalid_ void* p)
 {
     free(p);
-}
+}

ebpfsvc/svc_common.h

@@ -10,4 +10,5 @@
 #pragma once
 
 #include "framework.h"
+
 #include <Windows.h>

include/bpf/bpf.h

@@ -325,7 +325,7 @@ bpf_prog_load(
 
 #else
 #pragma warning(push)
-#include "libbpf/src/bpf.h"
 #include "bpf_legacy.h"
+#include "libbpf/src/bpf.h"
 #pragma warning(pop)
 #endif

include/bpf/bpf_legacy.h

@@ -2,6 +2,8 @@
 // SPDX-License-Identifier: MIT
 #pragma once
 
+#include "libbpf.h"
+
 #pragma warning(push)
 #pragma warning(disable : 4201) // nonstandard extension used: nameless struct/union
 

include/bpf2c.h

@@ -1,7 +1,9 @@
 // Copyright (c) Microsoft Corporation
 // SPDX-License-Identifier: MIT
-
 #pragma once
+
+#include "ebpf_structs.h"
+
 #if defined(NO_CRT)
 typedef signed char int8_t;
 typedef short int16_t;
@@ -22,8 +24,6 @@ typedef unsigned long long uint64_t;
 #include <stdint.h>
 #endif
 
-#include "ebpf_structs.h"
-
 #ifdef __cplusplus
 extern "C"
 {

include/bpf_helpers.h

@@ -9,8 +9,8 @@
 // this version of bpf_helpers.h is already cross-platform.
 
 // Include platform-specific definitions.
-#include "ebpf_structs.h"
 #include "bpf_helpers_platform.h"
+#include "ebpf_structs.h"
 
 // If we're compiling an actual eBPF program, then include
 // libbpf's bpf_helpers.h for the rest of the platform-agnostic

include/bpf_helpers_platform.h

@@ -2,7 +2,12 @@
 // SPDX-License-Identifier: MIT
 #pragma once
 
-// This file contains platform-specific defines used by eBPF programs.
+/**
+ * @file
+ * @brief This file contains platform specific defines used by eBPF programs.
+ */
+
+#include <stdint.h>
 
 // For eBPF programs, struct bpf_map means struct _ebpf_map_definition_in_file,
 // since they use inner_map_idx and pass pointers to such structures to the various

include/ebpf_api.h

@@ -3,14 +3,15 @@
 
 #pragma once
 
-#include <specstrings.h>
-#include <stdbool.h>
-#include <stdint.h>
 #include "ebpf_core_structs.h"
 #include "ebpf_execution_type.h"
 #include "ebpf_program_attach_type_guids.h"
 #include "ebpf_result.h"
 
+#include <specstrings.h>
+#include <stdbool.h>
+#include <stdint.h>
+
 #ifdef __cplusplus
 #include <stdexcept>
 #define EBPF_NO_EXCEPT noexcept

include/ebpf_core_structs.h

@@ -1,14 +1,17 @@
 // Copyright (c) Microsoft Corporation
 // SPDX-License-Identifier: MIT
+#pragma once
 
-// This file contains eBPF definitions common to eBPF core libraries as well as
-// the eBPF API library.
+/**
+ * @file
+ * @brief This file contains eBPF definitions common to eBPF core libraries as well as
+ * the eBPF API library.
+ */
 
-#pragma once
+#include "ebpf_structs.h"
 
 #include <sal.h>
 #include <stdint.h>
-#include "ebpf_structs.h"
 
 #define EBPF_MAX_PIN_PATH_LENGTH 256
 

include/ebpf_extension_uuids.h

@@ -1,11 +1,11 @@
 // Copyright (c) Microsoft Corporation
 // SPDX-License-Identifier: MIT
-
 #pragma once
 
-#include <stdint.h>
 #include "ebpf_windows.h"
 
+#include <stdint.h>
+
 #ifdef __cplusplus
 extern "C"
 {

include/ebpf_program_attach_type_guids.h

@@ -1,11 +1,11 @@
 // Copyright (c) Microsoft Corporation
 // SPDX-License-Identifier: MIT
-
 #pragma once
 
+#include "ebpf_windows.h"
+
 #include <stdbool.h>
 #include <stdint.h>
-#include "ebpf_windows.h"
 
 #ifdef __cplusplus
 extern "C"