[IR] Deprecate some old methods for getting typed pointer types

[bjope]

Summary

The convenience methods that now are marked as deprecated are no
long used in-tree. The getInt8PtrTy helper is however still used in
many places, so it is not marked as deprecated to make it possible
to build LLVM with -Werror.

[bjope]

Rebased, and cleaned up test_demangle.pass.cpp.

[bjope]

Any concerns about removing these helpers from Type? (@nikic I know you marked some other old API:s as deprecated rather than removing them directly, when dropping support for typed pointers. But I'm not sure if we need a deprecation period for this?)

[nikic]

In D156741#4574536, @bjope wrote:

Any concerns about removing these helpers from Type? (@nikic I know you marked some other old API:s as deprecated rather than removing them directly, when dropping support for typed pointers. But I'm not sure if we need a deprecation period for this?)

For typed pointer APIs I would usually go for deprecation, because some of them were quite widely used. I guess if you didn't need to remove many uses in preparation for this patch, then dropping them directly is fine.

libcxxabi/test/test_demangle.pass.cpp

22532 ↗

(On Diff #548768)

This test should not be modified. (It has no relation to LLVM; just uses our symbol names.)

[bjope]

Revert the changed made to libcxxabi/test/test_demangle.pass.cpp
Mark unused functions as deprecated rather than removing them
(but also make the inline wrappers of getInt8Ptr).

[nikic]

LG

[aeubanks]

llvm/include/llvm/IR/Type.h

491

these are no longer static, that looks unintentional. probably nobody is using these anymore because they're not static, might as well just remove them or make them static again

[bjope]

llvm/include/llvm/IR/Type.h

491

Since all of them are doing the same thing I made these unused versions inline wrappers of getInt8PtrTy (which still is static).
And for the "To enforce that no two equal instances are created" part I think the important thing is that PointerType::get is static, or am I missing something?

@aeubanks : I'm not sure I understand how it is a problem that they aren't static?

(But I'm not sure we need to keep lots of deprecated methods. Not much difference really in getting a Wdeprecated warning or a failed compilation due to a missing function, at least not if building with Werror.)

[aeubanks]

llvm/include/llvm/IR/Type.h

491

It's a non-static member function now, not a static class method. Previously you'd use PointerType::getFloatPtrTy(), now you need an instance of a Type to call it.

[bjope]

llvm/include/llvm/IR/Type.h

491

Ah right, ofcourse. Now I got it!

Great catch. But then I think I'll just follow up with at patch that removes these functions (no one has complained so far anyway, and right now it is broken).

llvm/include/llvm/IR/Type.h

 //===- llvm/Type.h - Classes for handling data types ------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // This file contains the declaration of the Type class.  For more "Type"
if (std::is_integral<ScalarTy>::value) {
         return Type::getDoubleTy(C);
       }
     }
     llvm_unreachable("Unsupported type in Type::getScalarTy");
   }
   static Type *getFloatingPointTy(LLVMContext &C, const fltSemantics &S);
 
   //===--------------------------------------------------------------------===//
-  // Convenience methods for getting pointer types with one of the above builtin
-  // types as pointee.
+  // Convenience methods for getting pointer types.
   //
-  static PointerType *getHalfPtrTy(LLVMContext &C, unsigned AS = 0);
-  static PointerType *getBFloatPtrTy(LLVMContext &C, unsigned AS = 0);
-  static PointerType *getFloatPtrTy(LLVMContext &C, unsigned AS = 0);
-  static PointerType *getDoublePtrTy(LLVMContext &C, unsigned AS = 0);
-  static PointerType *getX86_FP80PtrTy(LLVMContext &C, unsigned AS = 0);
-  static PointerType *getFP128PtrTy(LLVMContext &C, unsigned AS = 0);
-  static PointerType *getPPC_FP128PtrTy(LLVMContext &C, unsigned AS = 0);
-  static PointerType *getX86_MMXPtrTy(LLVMContext &C, unsigned AS = 0);
-  static PointerType *getX86_AMXPtrTy(LLVMContext &C, unsigned AS = 0);
-  static PointerType *getIntNPtrTy(LLVMContext &C, unsigned N, unsigned AS = 0);
-  static PointerType *getInt1PtrTy(LLVMContext &C, unsigned AS = 0);
+
+  // TODO: After opaque pointer transition these can be replaced by simply
+  //       calling PointerType::get(C, AS).
   static PointerType *getInt8PtrTy(LLVMContext &C, unsigned AS = 0);
-  static PointerType *getInt16PtrTy(LLVMContext &C, unsigned AS = 0);
-  static PointerType *getInt32PtrTy(LLVMContext &C, unsigned AS = 0);
-  static PointerType *getInt64PtrTy(LLVMContext &C, unsigned AS = 0);
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getHalfPtrTy(LLVMContext &C, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getBFloatPtrTy(LLVMContext &C, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getFloatPtrTy(LLVMContext &C, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getDoublePtrTy(LLVMContext &C, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getX86_FP80PtrTy(LLVMContext &C, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getFP128PtrTy(LLVMContext &C, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getPPC_FP128PtrTy(LLVMContext &C, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getX86_MMXPtrTy(LLVMContext &C, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getX86_AMXPtrTy(LLVMContext &C, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getIntNPtrTy(LLVMContext &C, unsigned N, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getInt1PtrTy(LLVMContext &C, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getInt16PtrTy(LLVMContext &C, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getInt32PtrTy(LLVMContext &C, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+  [[deprecated("Pointers no longer have element types")]]
+  inline PointerType *getInt64PtrTy(LLVMContext &C, unsigned AS = 0) {
+    return getInt8PtrTy(C, AS);
+  }
+
   static Type *getWasm_ExternrefTy(LLVMContext &C);
   static Type *getWasm_FuncrefTy(LLVMContext &C);
 
   /// Return a pointer to the current type. This is equivalent to
   /// PointerType::get(Foo, AddrSpace).
   /// TODO: Remove this after opaque pointer transition is complete.
   PointerType *getPointerTo(unsigned AddrSpace = 0) const;
 

llvm/lib/IR/Type.cpp

 IntegerType *Type::getInt32Ty(LLVMContext &C) { return &C.pImpl->Int32Ty; }
 IntegerType *Type::getInt64Ty(LLVMContext &C) { return &C.pImpl->Int64Ty; }
 IntegerType *Type::getInt128Ty(LLVMContext &C) { return &C.pImpl->Int128Ty; }
 
 IntegerType *Type::getIntNTy(LLVMContext &C, unsigned N) {
   return IntegerType::get(C, N);
 }
 
-PointerType *Type::getHalfPtrTy(LLVMContext &C, unsigned AS) {
-  return getHalfTy(C)->getPointerTo(AS);
-}
-
-PointerType *Type::getBFloatPtrTy(LLVMContext &C, unsigned AS) {
-  return getBFloatTy(C)->getPointerTo(AS);
-}
-
-PointerType *Type::getFloatPtrTy(LLVMContext &C, unsigned AS) {
-  return getFloatTy(C)->getPointerTo(AS);
-}
-
-PointerType *Type::getDoublePtrTy(LLVMContext &C, unsigned AS) {
-  return getDoubleTy(C)->getPointerTo(AS);
-}
-
-PointerType *Type::getX86_FP80PtrTy(LLVMContext &C, unsigned AS) {
-  return getX86_FP80Ty(C)->getPointerTo(AS);
-}
-
-PointerType *Type::getFP128PtrTy(LLVMContext &C, unsigned AS) {
-  return getFP128Ty(C)->getPointerTo(AS);
-}
-
-PointerType *Type::getPPC_FP128PtrTy(LLVMContext &C, unsigned AS) {
-  return getPPC_FP128Ty(C)->getPointerTo(AS);
-}
-
-PointerType *Type::getX86_MMXPtrTy(LLVMContext &C, unsigned AS) {
-  return getX86_MMXTy(C)->getPointerTo(AS);
-}
-
-PointerType *Type::getX86_AMXPtrTy(LLVMContext &C, unsigned AS) {
-  return getX86_AMXTy(C)->getPointerTo(AS);
-}
-
-PointerType *Type::getIntNPtrTy(LLVMContext &C, unsigned N, unsigned AS) {
-  return getIntNTy(C, N)->getPointerTo(AS);
-}
-
-PointerType *Type::getInt1PtrTy(LLVMContext &C, unsigned AS) {
-  return getInt1Ty(C)->getPointerTo(AS);
-}
-
 PointerType *Type::getInt8PtrTy(LLVMContext &C, unsigned AS) {
-  return getInt8Ty(C)->getPointerTo(AS);
-}
-
-PointerType *Type::getInt16PtrTy(LLVMContext &C, unsigned AS) {
-  return getInt16Ty(C)->getPointerTo(AS);
-}
-
-PointerType *Type::getInt32PtrTy(LLVMContext &C, unsigned AS) {
-  return getInt32Ty(C)->getPointerTo(AS);
-}
-
-PointerType *Type::getInt64PtrTy(LLVMContext &C, unsigned AS) {
-  return getInt64Ty(C)->getPointerTo(AS);
+  return PointerType::get(C, AS);
 }
 
 Type *Type::getWasm_ExternrefTy(LLVMContext &C) {
   // opaque pointer in addrspace(10)
   static PointerType *Ty = PointerType::get(C, 10);
   return Ty;
 }