[builtins] __builtin_dump_struct : added more types format

[paulsemel]

Summary

There was missing some basic types format (like uint8_t..). This patch is meant to print them the correct way.

[lebedev.ri]

Tests?

[paulsemel]

In D45615#1066973, @lebedev.ri wrote:

Tests?

I can do this. But currently, I am not testing the formats in the tests..

[aaron.ballman]

In D45615#1066975, @paulsemel wrote:

In D45615#1066973, @lebedev.ri wrote:

Tests?

I can do this. But currently, I am not testing the formats in the tests..

Now might be a good time to test that, because this patch almost added a bug by missing the length modifiers. Also, all patches should come with some tests to demonstrate the behavioral differences from the current trunk.

lib/CodeGen/CGBuiltin.cpp

954–955

Can you keep the signed/unsigned ordering?

Also, I think these should have the length modifiers added (hh for char).

Finally: ShortTy and UnsignedShortTy were already handled (see lines 962-963 in this patch), so I don't think those need to be added.

[paulsemel]

In D45615#1067068, @aaron.ballman wrote:

In D45615#1066975, @paulsemel wrote:

In D45615#1066973, @lebedev.ri wrote:

Tests?

I can do this. But currently, I am not testing the formats in the tests..

Now might be a good time to test that, because this patch almost added a bug by missing the length modifiers. Also, all patches should come with some tests to demonstrate the behavioral differences from the current trunk.

Sure. I will do another review for the existing format testing, and then go back to this one to finish the type handling !

[paulsemel]

Removed the two existing types.
Added the correct format sizing.
Added tests for those formats.
These version is now relying on the previous patch : https://reviews.llvm.org/D45665

[aaron.ballman]

LGTM! I will go ahead and commit on your behalf. Btw, if you're thinking of making additional patches, now might be a good time to ask for commit privileges (https://llvm.org/docs/DeveloperPolicy.html#obtaining-commit-access).

[aaron.ballman]

Committed in r330188, thank you for the patch!

[paulsemel]

In D45615#1069755, @aaron.ballman wrote:

LGTM! I will go ahead and commit on your behalf. Btw, if you're thinking of making additional patches, now might be a good time to ask for commit privileges (https://llvm.org/docs/DeveloperPolicy.html#obtaining-commit-access).

Thanks ! I actually really want to continue improving the builtin, so yes, I will make additional patches ! I just asked for accesses today :)

lib/CodeGen/CGBuiltin.cpp

static llvm::Value *dumpRecord(CodeGenFunction &CGF, QualType RType,
   Value *GString =
       CGF.Builder.CreateGlobalStringPtr(RType.getAsString() + " {\n");
   Value *Res = CGF.Builder.CreateCall(Func, {GString});
 
   static llvm::DenseMap<QualType, const char *> Types;
   if (Types.empty()) {
     Types[Context.CharTy] = "%c";
     Types[Context.BoolTy] = "%d";
+    Types[Context.SignedCharTy] = "%hhd";
+    Types[Context.UnsignedCharTy] = "%hhu";
     Types[Context.IntTy] = "%d";
     Types[Context.UnsignedIntTy] = "%u";
     Types[Context.LongTy] = "%ld";
     Types[Context.UnsignedLongTy] = "%lu";
     Types[Context.LongLongTy] = "%lld";
     Types[Context.UnsignedLongLongTy] = "%llu";
     Types[Context.ShortTy] = "%hd";
     Types[Context.UnsignedShortTy] = "%hu";
     Types[Context.VoidPtrTy] = "%p";
     Types[Context.FloatTy] = "%f";

test/CodeGen/dump-struct-builtin.c

 // RUN: %clang_cc1 -triple x86_64-unknown-unknown -emit-llvm %s -o - | FileCheck %s
 
 #include "Inputs/stdio.h"
+#include <stdint.h>
 
 // CHECK: @unit1.a = private unnamed_addr constant %struct.U1A { i16 12 }, align 2
 // CHECK-NEXT: [[STRUCT_STR_U1:@[0-9]+]] = private unnamed_addr constant [14 x i8] c"struct U1A {\0A\00"
 // CHECK-NEXT: [[FIELD_U1:@[0-9]+]] = private unnamed_addr constant [11 x i8] c"short a : \00"
 // CHECK-NEXT: [[FORMAT_U1:@[0-9]+]] = private unnamed_addr constant [5 x i8] c"%hd\0A\00"
 // CHECK-NEXT: [[END_STRUCT_U1:@[0-9]+]] = private unnamed_addr constant [3 x i8] c"}\0A\00"
 
 // CHECK: @unit2.a = private unnamed_addr constant %struct.U2A { i16 12 }, align 2

 // CHECK-NEXT: [[END_STRUCT_U14:@[0-9]+]] = private unnamed_addr constant [3 x i8] c"}\0A\00"
 
 // CHECK: @unit15.a = private unnamed_addr constant %struct.U15A { [3 x i32] [i32 1, i32 2, i32 3] }, align 4
 // CHECK-NEXT: [[STRUCT_STR_U15:@[0-9]+]] = private unnamed_addr constant [15 x i8] c"struct U15A {\0A\00"
 // CHECK-NEXT: [[FIELD_U15:@[0-9]+]] = private unnamed_addr constant [13 x i8] c"int [3] a : \00"
 // CHECK-NEXT: [[FORMAT_U15:@[0-9]+]] = private unnamed_addr constant [4 x i8] c"%p\0A\00"
 // CHECK-NEXT: [[END_STRUCT_U15:@[0-9]+]] = private unnamed_addr constant [3 x i8] c"}\0A\00"
 
+// CHECK: @unit16.a = private unnamed_addr constant %struct.U16A { i8 12 }, align 1
+// CHECK-NEXT: [[STRUCT_STR_U16:@[0-9]+]] = private unnamed_addr constant [15 x i8] c"struct U16A {\0A\00"
+// CHECK-NEXT: [[FIELD_U16:@[0-9]+]] = private unnamed_addr constant [13 x i8] c"uint8_t a : \00"
+// CHECK-NEXT: [[FORMAT_U16:@[0-9]+]] = private unnamed_addr constant [6 x i8] c"%hhu\0A\00"
+// CHECK-NEXT: [[END_STRUCT_U16:@[0-9]+]] = private unnamed_addr constant [3 x i8] c"}\0A\00"
+
+// CHECK: @unit17.a = private unnamed_addr constant %struct.U17A { i8 12 }, align 1
+// CHECK-NEXT: [[STRUCT_STR_U17:@[0-9]+]] = private unnamed_addr constant [15 x i8] c"struct U17A {\0A\00"
+// CHECK-NEXT: [[FIELD_U17:@[0-9]+]] = private unnamed_addr constant [12 x i8] c"int8_t a : \00"
+// CHECK-NEXT: [[FORMAT_U17:@[0-9]+]] = private unnamed_addr constant [6 x i8] c"%hhd\0A\00"
+// CHECK-NEXT: [[END_STRUCT_U17:@[0-9]+]] = private unnamed_addr constant [3 x i8] c"}\0A\00"
+
 int printf(const char *fmt, ...) {
     return 0;
 }
 
 void unit1() {
   struct U1A {
     short a;
   };
void unit15() {
   // CHECK: [[RES1:%[0-9]+]] = getelementptr inbounds %struct.U15A, %struct.U15A* %a, i32 0, i32 0
   // CHECK: call i32 (i8*, ...) @printf(i8* getelementptr inbounds ([13 x i8], [13 x i8]* [[FIELD_U15]], i32 0, i32 0))
   // CHECK: [[LOAD1:%[0-9]+]] = load [3 x i32], [3 x i32]* [[RES1]],
   // CHECK: call i32 (i8*, ...) @printf(i8* getelementptr inbounds ([4 x i8], [4 x i8]* [[FORMAT_U15]], i32 0, i32 0), [3 x i32] [[LOAD1]])
   // CHECK: call i32 (i8*, ...) @printf(i8* getelementptr inbounds ([3 x i8], [3 x i8]* [[END_STRUCT_U15]], i32 0, i32 0)
   __builtin_dump_struct(&a, &printf);
 }
 
+void unit16() {
+  struct U16A {
+    uint8_t a;
+  };
+
+  struct U16A a = {
+      .a = 12,
+  };
+
+  // CHECK: call i32 (i8*, ...) @printf(i8* getelementptr inbounds ([15 x i8], [15 x i8]* [[STRUCT_STR_U16]], i32 0, i32 0))
+  // CHECK: [[RES1:%[0-9]+]] = getelementptr inbounds %struct.U16A, %struct.U16A* %a, i32 0, i32 0
+  // CHECK: call i32 (i8*, ...) @printf(i8* getelementptr inbounds ([13 x i8], [13 x i8]* [[FIELD_U16]], i32 0, i32 0))
+  // CHECK: [[LOAD1:%[0-9]+]] = load i8, i8* [[RES1]],
+  // CHECK: call i32 (i8*, ...) @printf(i8* getelementptr inbounds ([6 x i8], [6 x i8]* [[FORMAT_U16]], i32 0, i32 0), i8 [[LOAD1]])
+  // CHECK: call i32 (i8*, ...) @printf(i8* getelementptr inbounds ([3 x i8], [3 x i8]* [[END_STRUCT_U16]], i32 0, i32 0)
+  __builtin_dump_struct(&a, &printf);
+}
+
+void unit17() {
+  struct U17A {
+    int8_t a;
+  };
+
+  struct U17A a = {
+      .a = 12,
+  };
+
+  // CHECK: call i32 (i8*, ...) @printf(i8* getelementptr inbounds ([15 x i8], [15 x i8]* [[STRUCT_STR_U17]], i32 0, i32 0))
+  // CHECK: [[RES1:%[0-9]+]] = getelementptr inbounds %struct.U17A, %struct.U17A* %a, i32 0, i32 0
+  // CHECK: call i32 (i8*, ...) @printf(i8* getelementptr inbounds ([12 x i8], [12 x i8]* [[FIELD_U17]], i32 0, i32 0))
+  // CHECK: [[LOAD1:%[0-9]+]] = load i8, i8* [[RES1]],
+  // CHECK: call i32 (i8*, ...) @printf(i8* getelementptr inbounds ([6 x i8], [6 x i8]* [[FORMAT_U17]], i32 0, i32 0), i8 [[LOAD1]])
+  // CHECK: call i32 (i8*, ...) @printf(i8* getelementptr inbounds ([3 x i8], [3 x i8]* [[END_STRUCT_U17]], i32 0, i32 0)
+  __builtin_dump_struct(&a, &printf);
+}
+
 void test1() {
   struct T1A {
     int a;
     char *b;
   };
 
   struct T1A a = {
       .a = 12,