Disable LibFuncs for stpcpy and stpncpy for Android < 21

[lanza]

Summary

These functions don't exist in android API levels < 21. A change in
llvm-12 (rG6dbf0cfcf789) caused Oz builds to emit this symbol
assuming it's available and thus is causing link errors. Simply
disable the LibFunc here.

[smeenai]

Might be helpful to mention rG6dbf0cfcf789 in the commit message.

Is there any way to add a test to this (especially for the triple version conditional), similar to what rGc5638a71d805 did? I imagine it might be complicated because I think our original test case triggered two transforms (sprintf -> strcpy and then strcpy -> stpcpy), but hopefully there's some test for the stpcpy transform that we can piggy-back off.

EDIT: looks like the test modified by rGc5638a71d805 also has segments for the stpcpy transform, so we should just be able to use it.

Adding a bunch of Android folks as reviewers.

[lanza]

Add test

[smeenai]

llvm/test/Transforms/InstCombine/sprintf-1.ll

113–118

This is identical to the Windows case, right? Can we just combine the cases and use a more generic label (e.g. NOSTPCPY or something)?

You should also add a test using an Android 21 triple and verify that the stpcpy transform triggers for it.

[rprichard]

Yes, Android did add stpcpy and stpncpy in API 21:
https://android.googlesource.com/platform/bionic/+/refs/heads/android11-dev/libc/libc.map.txt

llvm/lib/Analysis/TargetLibraryInfo.cpp

595

I assume the problem is that LibFunc_stpcpy is available by default, and we need to override the default, marking it unavailable.

I wondered why the *_unlocked functions (D45736, D75933) seemed to assume the opposite default, but that's because there's code at the start of this function marking them unavailable. It took me a while to find it because LibFunc_getc_unlocked isn't initialized. (LibFunc_getchar_unlocked and various others are, though.) I'll upload a patch if it still looks broken after digging some more.

[lanza]

@tstellar This could get picked to llvm-13. It's a bug that was first found with us rolling out llvm-12 internally and is still present in 13.

[tstellar]

@lanza Can you file a bug for this and but release-13.0.0 in the blocks field.

[probinson]

llvm/test/Transforms/InstCombine/sprintf-1.ll

113–118

Yes, please make this a generic label; PS4 is going to have to do the same thing, we just had somebody trip over it. (Not asking you to do the PS4 change, just make the test easier for us to add our case later.)

[probinson]

llvm/test/Transforms/InstCombine/sprintf-1.ll

113–118

Ah nvm somehow hadn't noticed this already landed. We'll deal with it.

[smeenai]

llvm/test/Transforms/InstCombine/sprintf-1.ll

113–118

This was addressed post-commit by https://reviews.llvm.org/D107526.

llvm/lib/Analysis/TargetLibraryInfo.cpp

if ((T.isOSLinux() && T.isGNUEnvironment()) ||
     TLI.setAvailable(LibFunc_fputc_unlocked);
     TLI.setAvailable(LibFunc_fgetc_unlocked);
     TLI.setAvailable(LibFunc_fread_unlocked);
     TLI.setAvailable(LibFunc_fwrite_unlocked);
     TLI.setAvailable(LibFunc_fputs_unlocked);
     TLI.setAvailable(LibFunc_fgets_unlocked);
   }
 
+  if (T.isAndroid() && T.isAndroidVersionLT(21)) {
+    TLI.setUnavailable(LibFunc_stpcpy);
+    TLI.setUnavailable(LibFunc_stpncpy);
+  }
+
   // As currently implemented in clang, NVPTX code has no standard library to
   // speak of.  Headers provide a standard-ish library implementation, but many
   // of the signatures are wrong -- for example, many libm functions are not
   // extern "C".
   //
   // libdevice, an IR library provided by nvidia, is linked in by the front-end,
   // but only used functions are provided to llvm.  Moreover, most of the
   // functions in libdevice don't map precisely to standard library functions.

llvm/test/Transforms/InstCombine/sprintf-1.ll

 ; NOTE: Assertions have been autogenerated by utils/update_test_checks.py
 ; Test that the sprintf library call simplifier works correctly.
 ;
 ; RUN: opt < %s -instcombine -S | FileCheck %s
 ; RUN: opt < %s -mtriple xcore-xmos-elf -instcombine -S | FileCheck %s -check-prefixes=CHECK,CHECK-IPRINTF
 ; RUN: opt < %s -mtriple=i386-pc-windows-msvc -instcombine -S | FileCheck %s --check-prefixes=CHECK,WIN
 ; RUN: opt < %s -mtriple=i386-mingw32 -instcombine -S | FileCheck %s --check-prefixes=CHECK,WIN
+; RUN: opt < %s -mtriple=armv7-none-linux-android16 -instcombine -S | FileCheck %s --check-prefixes=CHECK,ANDROID
 
 target datalayout = "e-p:32:32:32-i1:8:8-i8:8:8-i16:16:16-i32:32:32-i64:32:64-f32:32:32-f64:32:64-v64:64:64-v128:128:128-a0:0:64-f80:128:128"
 
 @hello_world = constant [13 x i8] c"hello world\0A\00"
 @null = constant [1 x i8] zeroinitializer
 @null_hello = constant [7 x i8] c"\00hello\00"
 @h = constant [2 x i8] c"h\00"
 @percent_c = constant [3 x i8] c"%c\00"

 ; CHECK-IPRINTF-NEXT:    ret i32 [[TMP3]]
 ;
 ; WIN-LABEL: @test_simplify7(
 ; WIN-NEXT:    [[STRLEN:%.*]] = call i32 @strlen(i8* noundef nonnull dereferenceable(1) [[STR:%.*]])
 ; WIN-NEXT:    [[LENINC:%.*]] = add i32 [[STRLEN]], 1
 ; WIN-NEXT:    call void @llvm.memcpy.p0i8.p0i8.i32(i8* align 1 [[DST:%.*]], i8* align 1 [[STR]], i32 [[LENINC]], i1 false)
 ; WIN-NEXT:    ret i32 [[STRLEN]]
 ;
+; ANDROID-LABEL: @test_simplify7(
+; ANDROID-NEXT:    [[STRLEN:%.*]] = call i32 @strlen(i8* noundef nonnull dereferenceable(1) [[STR:%.*]])
+; ANDROID-NEXT:    [[LENINC:%.*]] = add i32 [[STRLEN]], 1
+; ANDROID-NEXT:    call void @llvm.memcpy.p0i8.p0i8.i32(i8* align 1 [[DST:%.*]], i8* align 1 [[STR]], i32 [[LENINC]], i1 false)
+; ANDROID-NEXT:    ret i32 [[STRLEN]]
+;
   %fmt = getelementptr [3 x i8], [3 x i8]* @percent_s, i32 0, i32 0
   %r = call i32 (i8*, i8*, ...) @sprintf(i8* %dst, i8* %fmt, i8* %str)
   ret i32 %r
 }
 
 ; Check sprintf(dst, "%s", str) -> llvm.memcpy(dest, str, strlen(str) + 1, 1).
 define i32 @test_simplify8(i8* %dst) {
 ; CHECK-LABEL: @test_simplify8(