[SE-0368] StaticBigInt: add the Builtin functions

benrimmington · benrimmington · commit 8fb1ea27409e · 2022-08-25T00:49:45.000+01:00
diff --git a/include/swift/AST/Builtins.def b/include/swift/AST/Builtins.def
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -696,6 +696,18 @@ BUILTIN_MISC_OPERATION(UToUCheckedTrunc, "u_to_u_checked_trunc", "n", Special)
 /// IntToFPWithOverflow has type (Integer) -> Float
 BUILTIN_MISC_OPERATION(IntToFPWithOverflow, "itofp_with_overflow", "n", Special)
 
+/// Builtin.bitWidth_IntLiteral has type
+/// (_ value: Builtin.IntLiteral) -> Builtin.Word
+BUILTIN_MISC_OPERATION(BitWidth, "bitWidth", "n", Special)
+
+/// Builtin.isNegative_IntLiteral has type
+/// (_ value: Builtin.IntLiteral) -> Builtin.Int1
+BUILTIN_MISC_OPERATION(IsNegative, "isNegative", "n", Special)
+
+/// Builtin.wordAtIndex_IntLiteral has type
+/// (_ value: Builtin.IntLiteral, _ index: Builtin.Word) -> Builtin.Word
+BUILTIN_MISC_OPERATION(WordAtIndex, "wordAtIndex", "n", Special)
+
 /// zeroInitializer has type <T> () -> T
 BUILTIN_MISC_OPERATION(ZeroInitializer, "zeroInitializer", "n", Special)
 
diff --git a/lib/AST/Builtins.cpp b/lib/AST/Builtins.cpp
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -1821,6 +1821,33 @@ static ValueDecl *getIntToFPWithOverflowOperation(ASTContext &Context,
   return getBuiltinFunction(Id, { InTy }, OutTy);
 }
 
+static ValueDecl *getBitWidthOperation(
+  ASTContext &ctx,
+  Identifier id,
+  Type valueTy
+) {
+  if (!valueTy->getAs<BuiltinIntegerLiteralType>()) return nullptr;
+  return getBuiltinFunction(ctx, id, _thin, _parameters(valueTy), _word);
+}
+
+static ValueDecl *getIsNegativeOperation(
+  ASTContext &ctx,
+  Identifier id,
+  Type valueTy
+) {
+  if (!valueTy->getAs<BuiltinIntegerLiteralType>()) return nullptr;
+  return getBuiltinFunction(ctx, id, _thin, _parameters(valueTy), _int(1));
+}
+
+static ValueDecl *getWordAtIndexOperation(
+  ASTContext &ctx,
+  Identifier id,
+  Type valueTy
+) {
+  if (!valueTy->getAs<BuiltinIntegerLiteralType>()) return nullptr;
+  return getBuiltinFunction(ctx, id, _thin, _parameters(valueTy, _word), _word);
+}
+
 static ValueDecl *getUnreachableOperation(ASTContext &Context,
                                           Identifier Id) {
   auto NeverTy = Context.getNeverType();
@@ -2811,6 +2838,18 @@ ValueDecl *swift::getBuiltinValueDecl(ASTContext &Context, Identifier Id) {
     if (Types.size() != 2) return nullptr;
     return getIntToFPWithOverflowOperation(Context, Id, Types[0], Types[1]);
 
+  case BuiltinValueKind::BitWidth:
+    if (Types.size() != 1) return nullptr;
+    return getBitWidthOperation(Context, Id, Types[0]);
+
+  case BuiltinValueKind::IsNegative:
+    if (Types.size() != 1) return nullptr;
+    return getIsNegativeOperation(Context, Id, Types[0]);
+
+  case BuiltinValueKind::WordAtIndex:
+    if (Types.size() != 1) return nullptr;
+    return getWordAtIndexOperation(Context, Id, Types[0]);
+
   case BuiltinValueKind::GetObjCTypeEncoding:
     return getGetObjCTypeEncodingOperation(Context, Id);
 
diff --git a/lib/IRGen/GenBuiltin.cpp b/lib/IRGen/GenBuiltin.cpp
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -1016,6 +1016,24 @@ if (Builtin.ID == BuiltinValueKind::id) { \
     return;
   }
 
+  if (Builtin.ID == BuiltinValueKind::BitWidth) {
+    assert(Builtin.Types[0]->is<BuiltinIntegerLiteralType>());
+    out.add(emitIntLiteralBitWidth(IGF, args));
+    return;
+  }
+
+  if (Builtin.ID == BuiltinValueKind::IsNegative) {
+    assert(Builtin.Types[0]->is<BuiltinIntegerLiteralType>());
+    out.add(emitIntLiteralIsNegative(IGF, args));
+    return;
+  }
+
+  if (Builtin.ID == BuiltinValueKind::WordAtIndex) {
+    assert(Builtin.Types[0]->is<BuiltinIntegerLiteralType>());
+    out.add(emitIntLiteralWordAtIndex(IGF, args));
+    return;
+  }
+
   if (Builtin.ID == BuiltinValueKind::Once
       || Builtin.ID == BuiltinValueKind::OnceWithContext) {
     // The input type is statically (Builtin.RawPointer, @convention(thin) () -> ()).
diff --git a/lib/IRGen/GenIntegerLiteral.cpp b/lib/IRGen/GenIntegerLiteral.cpp
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -397,3 +397,44 @@ llvm::Value *irgen::emitIntegerLiteralToFP(IRGenFunction &IGF,
     llvm_unreachable("not a floating-point type");
   }
 }
+
+llvm::Value *irgen::emitIntLiteralBitWidth(
+  IRGenFunction &IGF,
+  Explosion &in
+) {
+  auto data = in.claimNext();
+  auto flags = in.claimNext();
+  (void)data; // [[maybe_unused]]
+  return IGF.Builder.CreateLShr(
+    flags,
+    IGF.IGM.getSize(Size(IntegerLiteralFlags::BitWidthShift))
+  );
+}
+
+llvm::Value *irgen::emitIntLiteralIsNegative(
+  IRGenFunction &IGF,
+  Explosion &in
+) {
+  auto data = in.claimNext();
+  auto flags = in.claimNext();
+  (void)data; // [[maybe_unused]]
+  static_assert(
+    IntegerLiteralFlags::IsNegativeFlag == 1,
+    "hardcoded in this truncation"
+  );
+  return IGF.Builder.CreateTrunc(flags, IGF.IGM.Int1Ty);
+}
+
+llvm::Value *irgen::emitIntLiteralWordAtIndex(
+  IRGenFunction &IGF,
+  Explosion &in
+) {
+  auto data = in.claimNext();
+  auto flags = in.claimNext();
+  auto index = in.claimNext();
+  (void)flags; // [[maybe_unused]]
+  return IGF.Builder.CreateLoad(
+    IGF.Builder.CreateInBoundsGEP(IGF.IGM.SizeTy, data, index),
+    IGF.IGM.getPointerAlignment()
+  );
+}
diff --git a/lib/IRGen/GenIntegerLiteral.h b/lib/IRGen/GenIntegerLiteral.h
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -67,6 +67,10 @@ llvm::Value *emitIntegerLiteralToFP(IRGenFunction &IGF,
                                     Explosion &in,
                                     llvm::Type *toType);
 
+llvm::Value *emitIntLiteralBitWidth(IRGenFunction &IGF, Explosion &in);
+llvm::Value *emitIntLiteralIsNegative(IRGenFunction &IGF, Explosion &in);
+llvm::Value *emitIntLiteralWordAtIndex(IRGenFunction &IGF, Explosion &in);
+
 }
 }
 
diff --git a/lib/SIL/IR/OperandOwnership.cpp b/lib/SIL/IR/OperandOwnership.cpp
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -726,6 +726,9 @@ BUILTIN_OPERAND_OWNERSHIP(InstantaneousUse, ICMP_ULE)
 BUILTIN_OPERAND_OWNERSHIP(InstantaneousUse, ICMP_ULT)
 BUILTIN_OPERAND_OWNERSHIP(InstantaneousUse, InsertElement)
 BUILTIN_OPERAND_OWNERSHIP(InstantaneousUse, IntToFPWithOverflow)
+BUILTIN_OPERAND_OWNERSHIP(InstantaneousUse, BitWidth)
+BUILTIN_OPERAND_OWNERSHIP(InstantaneousUse, IsNegative)
+BUILTIN_OPERAND_OWNERSHIP(InstantaneousUse, WordAtIndex)
 BUILTIN_OPERAND_OWNERSHIP(InstantaneousUse, IntToPtr)
 BUILTIN_OPERAND_OWNERSHIP(InstantaneousUse, IsOptionalType)
 BUILTIN_OPERAND_OWNERSHIP(InstantaneousUse, IsPOD)
diff --git a/lib/SIL/IR/ValueOwnership.cpp b/lib/SIL/IR/ValueOwnership.cpp
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -497,6 +497,9 @@ CONSTANT_OWNERSHIP_BUILTIN(None, SToSCheckedTrunc)
 CONSTANT_OWNERSHIP_BUILTIN(None, SToUCheckedTrunc)
 CONSTANT_OWNERSHIP_BUILTIN(None, UToUCheckedTrunc)
 CONSTANT_OWNERSHIP_BUILTIN(None, IntToFPWithOverflow)
+CONSTANT_OWNERSHIP_BUILTIN(None, BitWidth)
+CONSTANT_OWNERSHIP_BUILTIN(None, IsNegative)
+CONSTANT_OWNERSHIP_BUILTIN(None, WordAtIndex)
 
 // This is surprising, Builtin.unreachable returns a "Never" value which is
 // trivially typed.
diff --git a/lib/SILOptimizer/Transforms/AccessEnforcementReleaseSinking.cpp b/lib/SILOptimizer/Transforms/AccessEnforcementReleaseSinking.cpp
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -129,6 +129,9 @@ static bool isBarrier(SILInstruction *inst) {
     case BuiltinValueKind::SToSCheckedTrunc:
     case BuiltinValueKind::UToUCheckedTrunc:
     case BuiltinValueKind::IntToFPWithOverflow:
+    case BuiltinValueKind::BitWidth:
+    case BuiltinValueKind::IsNegative:
+    case BuiltinValueKind::WordAtIndex:
     case BuiltinValueKind::ZeroInitializer:
     case BuiltinValueKind::Once:
     case BuiltinValueKind::OnceWithContext:
diff --git a/test/IRGen/integer_literal.sil b/test/IRGen/integer_literal.sil
@@ -354,3 +354,37 @@ entry(%0 : $Builtin.IntLiteral):
   %result = builtin "itofp_with_overflow_IntLiteral_FPIEEE128"(%0 : $Builtin.IntLiteral) : $Builtin.FPIEEE128
   return %result : $Builtin.FPIEEE128
 }
+
+
+
+/***************************************************************************/
+/* bitWidth, isNegative, wordAtIndex                                       */
+/***************************************************************************/
+
+// CHECK-LABEL: define{{( dllexport)?}}{{( protected)?}} swiftcc i32 @test_bitWidth(i32* %0, i32 %1)
+sil @test_bitWidth : $(Builtin.IntLiteral) -> Builtin.Word {
+entry(%value : $Builtin.IntLiteral):
+  // CHECK:      %2 = lshr i32 %1, 8
+  // CHECK-NEXT: ret i32 %2
+  %result = builtin "bitWidth_IntLiteral"(%value : $Builtin.IntLiteral) : $Builtin.Word
+  return %result : $Builtin.Word
+}
+
+// CHECK-LABEL: define{{( dllexport)?}}{{( protected)?}} swiftcc i1 @test_isNegative(i32* %0, i32 %1)
+sil @test_isNegative : $(Builtin.IntLiteral) -> Builtin.Int1 {
+entry(%value : $Builtin.IntLiteral):
+  // CHECK:      %2 = trunc i32 %1 to i1
+  // CHECK-NEXT: ret i1 %2
+  %result = builtin "isNegative_IntLiteral"(%value : $Builtin.IntLiteral) : $Builtin.Int1
+  return %result : $Builtin.Int1
+}
+
+// CHECK-LABEL: define{{( dllexport)?}}{{( protected)?}} swiftcc i32 @test_wordAtIndex(i32* %0, i32 %1, i32 %2)
+sil @test_wordAtIndex : $(Builtin.IntLiteral, Builtin.Word) -> Builtin.Word {
+entry(%value : $Builtin.IntLiteral, %index : $Builtin.Word):
+  // CHECK:      %3 = getelementptr inbounds i32, i32* %0, i32 %2
+  // CHECK-NEXT: %4 = load i32, i32* %3, align 4
+  // CHECK-NEXT: ret i32 %4
+  %result = builtin "wordAtIndex_IntLiteral"(%value : $Builtin.IntLiteral, %index : $Builtin.Word) : $Builtin.Word
+  return %result : $Builtin.Word
+}
