Mark IntList as deprecated; add C10_DEPRECATED_USING (#16824)

Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/16824

There was a big wooly yak getting the deprecated macros to work.
Gory details are in Deprecated.h

Reviewed By: smessmer

Differential Revision: D13978429

fbshipit-source-id: f148e5935ac36eacc481789d22c7a9443164fe95

diff --git a/aten/src/ATen/function_wrapper.py b/aten/src/ATen/function_wrapper.py
index f550026..960bf82 100644 (file)
--- a/aten/src/ATen/function_wrapper.py
+++ b/aten/src/ATen/function_wrapper.py
@@ -63,8 +63,8 @@ PURE_VIRTUAL_TYPE_METHOD_DECLARATION = CodeTemplate("""\
 virtual ${return_type} ${method_prefix_derived}${api_name}(${type_method_formals}) const = 0;
 """)
 DEPRECATED_PURE_VIRTUAL_TYPE_METHOD_DECLARATION = CodeTemplate("""\
-C10_DEPRECATED(virtual ${return_type} \
-${method_prefix_derived}${api_name}(${type_method_formals}) const = 0);
+C10_DEPRECATED virtual ${return_type} \
+${method_prefix_derived}${api_name}(${type_method_formals}) const = 0;
 """)
 PURE_VIRTUAL_TYPE_METHOD_DECLARATION_BROADCAST = CodeTemplate("""\
 virtual ${return_type} ${api_name}(${type_method_formals}) const = 0;
@@ -139,7 +139,7 @@ static inline ${return_type} ${api_name}(${formals_with_defaults});
 """)
 # add a method declaration in Functions.h
 DEPRECATED_FUNCTION_DECLARATION = CodeTemplate("""\
-C10_DEPRECATED(static inline ${return_type} ${api_name}(${formals_with_defaults}));
+C10_DEPRECATED static inline ${return_type} ${api_name}(${formals_with_defaults});
 """)
 # add method definition in Functions.h
 FUNCTION_DEFINITION = CodeTemplate("""\

diff --git a/c10/util/ArrayRef.h b/c10/util/ArrayRef.h
index 5d1ea5c..6acb532 100644 (file)
--- a/c10/util/ArrayRef.h
+++ b/c10/util/ArrayRef.h
@@ -18,6 +18,7 @@
 #include <c10/util/SmallVector.h>
 #include <c10/util/C++17.h>
 #include <c10/util/Exception.h>
+#include <c10/util/Deprecated.h>
 
 #include <array>
 #include <iterator>
@@ -269,6 +270,6 @@ using IntArrayRef = ArrayRef<int64_t>;
 
 // This alias is deprecated because it doesn't make ownership
 // semantics obvious.  Use IntArrayRef instead!
-using IntList = ArrayRef<int64_t>;
+using IntList C10_DEPRECATED_USING = ArrayRef<int64_t>;
 
 } // namespace c10

diff --git a/c10/util/Deprecated.h b/c10/util/Deprecated.h
index 75c6ede..d2c3776 100644 (file)
--- a/c10/util/Deprecated.h
+++ b/c10/util/Deprecated.h
@@ -1,16 +1,69 @@
 #pragma once
 
-// Largely from https://stackoverflow.com/questions/295120/c-mark-as-deprecated
+/**
+ * This file provides portable macros for marking declarations
+ * as deprecated.  You should generally use C10_DEPRECATED,
+ * except when marking 'using' declarations as deprecated,
+ * in which case you should use C10_DEPRECATED_USING (due to
+ * portability concerns).
+ */
 
+// Sample usage:
+//
+//    C10_DEPRECATED void bad_func();
+//    struct C10_DEPRECATED BadStruct {
+//      ...
+//    };
+
+// NB: In PyTorch, this block is not actually used at the moment
+// because we are C++11.  However, aspirationally, we would like
+// to use this version, because as of C++14 it is the correct and
+// portable way to declare something deprecated.
 #if defined(__cplusplus) && __cplusplus > 201402L
-#define C10_DEPRECATED(function) [[deprecated]] function
+# define C10_DEPRECATED [[deprecated]]
+#elif defined(__GNUC__)
+# define C10_DEPRECATED __attribute__((deprecated))
+#elif defined(_MSC_VER)
+# define C10_DEPRECATED __declspec(deprecated)
 #else
-#if defined(__GNUC__)
-#define C10_DEPRECATED(function) __attribute__((deprecated)) function
+# warning "You need to implement C10_DEPRECATED for this compiler"
+# define C10_DEPRECATED
+#endif
+
+
+// Sample usage:
+//
+//    using BadType C10_DEPRECATED_USING = int;
+//
+
+#if defined(__cplusplus) && __cplusplus > 201402L
+# define C10_DEPRECATED_USING [[deprecated]]
+#elif defined(_MSC_VER) && defined(__CUDACC__)
+// Apparently, [[deprecated]] doesn't work on nvcc on Windows;
+// you get the error:
+//
+//    error: attribute does not apply to any entity
+//
+// So we just turn the macro off in this case.
+# define C10_DEPRECATED_USING
 #elif defined(_MSC_VER)
-#define C10_DEPRECATED(function) __declspec(deprecated) function
+// __declspec(deprecated) does not work in using declarations:
+//  https://godbolt.org/z/lOwe1h
+// but it seems that most of C++14 is available in MSVC even if you don't ask for
+// it. (It's also harmless to specify an attribute because it is C++11 supported
+// syntax; you mostly risk it not being understood).  Some more notes at
+// https://blogs.msdn.microsoft.com/vcblog/2016/06/07/standards-version-switches-in-the-compiler/
+# define C10_DEPRECATED_USING [[deprecated]]
+#elif defined(__CUDACC__)
+// nvcc has a bug where it doesn't understand __attribute__((deprecated))
+// declarations even when the host compiler supports it.  It's OK
+// with [[deprecated]] though (although, if you are on an old version
+// of gcc which doesn't understand attributes, you'll get a -Wattributes
+// error that it is ignored
+# define C10_DEPRECATED_USING [[deprecated]]
+#elif defined(__GNUC__)
+# define C10_DEPRECATED_USING __attribute__((deprecated))
 #else
-#warning "You need to implement C10_DEPRECATED for this compiler"
-#define C10_DEPRECATED(function) function
-#endif // defined(__GNUC__)
-#endif // defined(__cplusplus) && __cplusplus > 201402L
+# warning "You need to implement C10_DEPRECATED_USING for this compiler"
+# define C10_DEPRECATED_USING
+#endif