Reorganize and refine the Windows.h import in C++ files (pytorch#48009)

Summary: This PR aims to reduce the import overhead and symbol noises from the `windows.h` headers. Pull Request resolved: pytorch#48009 Reviewed By: gchanan Differential Revision: D25045840 Pulled By: ezyang fbshipit-source-id: 01fda70f433ba2dd0cd2d7cd676ab6ffe9d98b90
lcy-seso · Nov 20, 2020 · 8177f63 · 8177f63
1 parent 6d5d336
commit 8177f63
Show file tree

Hide file tree

Showing 12 changed files with 76 additions and 13 deletions.
diff --git a/aten/src/ATen/DynamicLibrary.cpp b/aten/src/ATen/DynamicLibrary.cpp
@@ -6,7 +6,7 @@
 #include <dlfcn.h>
 #include <libgen.h>
 #else
-#include <Windows.h>
+#include <c10/util/win32-headers.h>
 #endif
 
 namespace at {

diff --git a/aten/src/TH/THAllocator.cpp b/aten/src/TH/THAllocator.cpp
@@ -9,7 +9,7 @@
 
 /* stuff for mapped files */
 #ifdef _WIN32
-#include <windows.h>
+#include <c10/util/win32-headers.h>
 #endif
 
 #if defined(HAVE_MMAP)
@@ -333,7 +333,7 @@ typedef struct{
   HANDLE handle;
   HANDLE wait;
 } ReleaseContext;
-static VOID CALLBACK WaitForReleaseHandle(PVOID lpParam, BOOLEAN TimerOrWaitFired)
+static void CALLBACK WaitForReleaseHandle(PVOID lpParam, BOOLEAN TimerOrWaitFired)
 {
   if (lpParam) {
     ReleaseContext *ctx = (ReleaseContext *)lpParam;

diff --git a/binaries/benchmark_helper.cc b/binaries/benchmark_helper.cc
@@ -19,6 +19,9 @@
 #include <string>
 #include <thread>
 #ifdef _WIN32
+#ifndef WIN32_LEAN_AND_MEAN
+#define WIN32_LEAN_AND_MEAN
+#endif
 #include <windows.h>
 #include <psapi.h>
 #endif

diff --git a/c10/util/Backtrace.cpp b/c10/util/Backtrace.cpp
@@ -9,12 +9,8 @@
 #include <vector>
 
 #ifdef _MSC_VER
-#ifndef WIN32_LEAN_AND_MEAN
-#define WIN32_LEAN_AND_MEAN
-#endif
+#include <c10/util/win32-headers.h>
 #include <iomanip>
-#include <Windows.h>
-#include <dbghelp.h>
 #pragma comment(lib, "Dbghelp.lib")
 #endif
 

diff --git a/c10/util/C++17.h b/c10/util/C++17.h
@@ -24,6 +24,10 @@
 #error You need C++14 to compile PyTorch
 #endif
 
+#if defined(_WIN32) && (defined(min) || defined(max))
+#  error Macro clash with min and max -- define NOMINMAX when compiling your program on Windows
+#endif
+
 /*
  * This header adds some polyfills with C++17 functionality
  */

diff --git a/c10/util/win32-headers.h b/c10/util/win32-headers.h
@@ -0,0 +1,57 @@
+#pragma once
+
+#ifndef WIN32_LEAN_AND_MEAN
+#define WIN32_LEAN_AND_MEAN
+#endif
+#ifndef NOMINMAX
+#define NOMINMAX
+#endif
+#ifndef NOKERNEL
+#define NOKERNEL
+#endif
+#ifndef NOUSER
+#define NOUSER
+#endif
+#ifndef NOSERVICE
+#define NOSERVICE
+#endif
+#ifndef NOSOUND
+#define NOSOUND
+#endif
+#ifndef NOMCX
+#define NOMCX
+#endif
+#ifndef NOGDI
+#define NOGDI
+#endif
+#ifndef NOMSG
+#define NOMSG
+#endif
+#ifndef NOMB
+#define NOMB
+#endif
+#ifndef NOCLIPBOARD
+#define NOCLIPBOARD
+#endif
+
+#include <windows.h>
+#include <dbghelp.h>
+
+#undef VOID
+#undef DELETE
+#undef IN
+#undef THIS
+#undef CONST
+#undef NAN
+#undef UNKNOWN
+#undef NONE
+#undef ANY
+#undef IGNORE
+#undef STRICT
+#undef GetObject
+#undef CreateSemaphore
+#undef Yield
+#undef RotateRight32
+#undef RotateLeft32
+#undef RotateRight64
+#undef RotateLeft64
diff --git a/modules/observers/perf_observer.cc b/modules/observers/perf_observer.cc
@@ -18,6 +18,9 @@ defined(TARGET_IPHONE_SIMULATOR)
 #endif
 
 #ifdef _WIN32
+#ifndef WIN32_LEAN_AND_MEAN
+#define WIN32_LEAN_AND_MEAN
+#endif
 #include <windows.h>
 #endif
 

diff --git a/torch/csrc/CudaIPCTypes.cpp b/torch/csrc/CudaIPCTypes.cpp
@@ -6,7 +6,7 @@
 #include <random>
 
 #ifdef _MSC_VER
-#include <windows.h>
+#include <c10/util/win32-headers.h>
 #else
 #include <sys/types.h>
 #include <unistd.h>

diff --git a/torch/csrc/Storage.cpp b/torch/csrc/Storage.cpp
@@ -1,6 +1,6 @@
 #include <torch/csrc/python_headers.h>
 #ifdef _MSC_VER
-#include <Windows.h>
+#include <c10/util/win32-headers.h>
 #endif
 #include <structmember.h>
 

diff --git a/torch/csrc/jit/codegen/cuda/instrumentation.cpp b/torch/csrc/jit/codegen/cuda/instrumentation.cpp
@@ -3,7 +3,7 @@
 #include <torch/csrc/WindowsTorchApiMacro.h>
 
 #ifdef _WIN32
-#include <windows.h>
+#include <c10/util/win32-headers.h>
 #else
 #include <pthread.h>
 #include <unistd.h>

diff --git a/torch/csrc/jit/codegen/fuser/cpu/temp_file.h b/torch/csrc/jit/codegen/fuser/cpu/temp_file.h
@@ -7,7 +7,7 @@
 
 #ifdef _WIN32
 #include <WinError.h>
-#include <Windows.h>
+#include <c10/util/win32-headers.h>
 #include <fcntl.h>
 #include <io.h>
 #include <process.h>

diff --git a/torch/lib/c10d/FileStore.cpp b/torch/lib/c10d/FileStore.cpp
@@ -6,7 +6,7 @@
 #include <sys/stat.h>
 
 #ifdef _WIN32
-#include <windows.h>
+#include <c10/util/win32-headers.h>
 #include <fileapi.h>
 #include <io.h>
 #else