[compiler-rt] [compiler-rt] [profile] Add value profile in sampling data without-libc (PR #95639)
dong jianqiang via llvm-commits
llvm-commits at lists.llvm.org
Sat Jun 15 00:17:11 PDT 2024
https://github.com/dongjianqiang2 created https://github.com/llvm/llvm-project/pull/95639
Fix the 'truncated profile data' error: when the instrumented source code includes value profile instrumentation, the __llvm_profile_get_size_for_buffer does not include the size of value profile.
>From 382696022dbcc37301247ef52a723964de048ae1 Mon Sep 17 00:00:00 2001
From: dongjianqiang2 <dongjianqiang2 at huawei.com>
Date: Sat, 15 Jun 2024 14:54:04 +0800
Subject: [PATCH] [compiler-rt] [profile] Add value profile in sampling data
without-libc
Fix the 'truncated profile data' error: when the instrumented source code
includes value profile instrumentation, the __llvm_profile_get_size_for_buffer
does not include the size of value profile.
---
compiler-rt/lib/profile/InstrProfiling.h | 13 ++++
.../lib/profile/InstrProfilingBuffer.c | 21 ++++++
.../lib/profile/InstrProfilingInternal.h | 4 +
.../lib/profile/InstrProfilingWriter.c | 28 +++++++
.../test/profile/instrprof-all-without-libc.c | 75 +++++++++++++++++++
5 files changed, 141 insertions(+)
create mode 100644 compiler-rt/test/profile/instrprof-all-without-libc.c
diff --git a/compiler-rt/lib/profile/InstrProfiling.h b/compiler-rt/lib/profile/InstrProfiling.h
index d424a22c212c3..121860384eaf0 100644
--- a/compiler-rt/lib/profile/InstrProfiling.h
+++ b/compiler-rt/lib/profile/InstrProfiling.h
@@ -92,11 +92,24 @@ void __llvm_profile_set_page_size(unsigned PageSize);
*/
uint8_t __llvm_profile_get_num_padding_bytes(uint64_t SizeInBytes);
+/*!
+ * \brief Get all required size for profile buffer.
+ */
+uint64_t __llvm_profile_get_all_size_for_buffer(void);
+
/*!
* \brief Get required size for profile buffer.
*/
uint64_t __llvm_profile_get_size_for_buffer(void);
+/*!
+ * \brief Write all instrumentation data to the given buffer.
+ *
+ * \pre \c Buffer is the start of a buffer at least as big as \a
+ * __llvm_profile_get_all_size_for_buffer().
+ */
+int __llvm_profile_write_all_buffer(char *Buffer);
+
/*!
* \brief Write instrumentation data to the given buffer.
*
diff --git a/compiler-rt/lib/profile/InstrProfilingBuffer.c b/compiler-rt/lib/profile/InstrProfilingBuffer.c
index 1c451d7ec7563..aaf562595d37a 100644
--- a/compiler-rt/lib/profile/InstrProfilingBuffer.c
+++ b/compiler-rt/lib/profile/InstrProfilingBuffer.c
@@ -234,6 +234,27 @@ void initBufferWriter(ProfDataWriter *BufferWriter, char *Buffer) {
BufferWriter->WriterCtx = Buffer;
}
+/// Write all profile data size including value profile.
+COMPILER_RT_VISIBILITY int __llvm_profile_write_all_buffer(char *Buffer) {
+ ProfDataWriter BufferWriter;
+ initBufferWriter(&BufferWriter, Buffer);
+ return lprofWriteData(&BufferWriter, lprofGetVPDataReader(), 0);
+}
+
+/// Get all value profile data size. In this implementation,
+/// value profile data size is calculated with each function.
+COMPILER_RT_VISIBILITY
+uint64_t __llvm_profile_get_all_size_for_buffer(void) {
+ const __llvm_profile_data *DI = 0;
+ const __llvm_profile_data *DataBegin = __llvm_profile_begin_data();
+ const __llvm_profile_data *DataEnd = __llvm_profile_end_data();
+ uint64_t TotalSize = 0;
+ for (DI = DataBegin; DI < DataEnd; DI++) {
+ TotalSize += lprofgetValueProfDataSize(lprofGetVPDataReader(), DI);
+ }
+ return __llvm_profile_get_size_for_buffer() + TotalSize;
+}
+
COMPILER_RT_VISIBILITY int __llvm_profile_write_buffer(char *Buffer) {
ProfDataWriter BufferWriter;
initBufferWriter(&BufferWriter, Buffer);
diff --git a/compiler-rt/lib/profile/InstrProfilingInternal.h b/compiler-rt/lib/profile/InstrProfilingInternal.h
index d5bd0e41fb129..5e1d035677d50 100644
--- a/compiler-rt/lib/profile/InstrProfilingInternal.h
+++ b/compiler-rt/lib/profile/InstrProfilingInternal.h
@@ -148,6 +148,10 @@ typedef struct VPDataReaderType {
uint32_t N);
} VPDataReaderType;
+/* Get value profile data size including the header and padding. */
+uint64_t lprofgetValueProfDataSize(VPDataReaderType *VPDataReader,
+ const __llvm_profile_data *Data);
+
/* Write profile data to destination. If SkipNameDataWrite is set to 1,
the name data is already in destination, we just skip over it. */
int lprofWriteData(ProfDataWriter *Writer, VPDataReaderType *VPDataReader,
diff --git a/compiler-rt/lib/profile/InstrProfilingWriter.c b/compiler-rt/lib/profile/InstrProfilingWriter.c
index 8816a71155511..297397d12d396 100644
--- a/compiler-rt/lib/profile/InstrProfilingWriter.c
+++ b/compiler-rt/lib/profile/InstrProfilingWriter.c
@@ -238,6 +238,34 @@ static int writeValueProfData(ProfDataWriter *Writer,
return 0;
}
+/* Get value profile data size for function specified with \c Data.
+ * In this implementation, value profile data size is calculated with value
+ * profile header. */
+COMPILER_RT_VISIBILITY uint64_t
+lprofgetValueProfDataSize(VPDataReaderType *VPDataReader,
+ const __llvm_profile_data *Data) {
+ uint8_t *SiteCountArray[IPVK_Last + 1];
+
+ for (unsigned I = 0; I <= IPVK_Last; I++) {
+ if (!Data->NumValueSites[I])
+ SiteCountArray[I] = 0;
+ else {
+ uint32_t Sz =
+ VPDataReader->GetValueProfRecordHeaderSize(Data->NumValueSites[I]) -
+ offsetof(ValueProfRecord, SiteCountArray);
+ /* Only use alloca for this small byte array to avoid excessive
+ * stack growth. */
+ SiteCountArray[I] = (uint8_t *)COMPILER_RT_ALLOCA(Sz);
+ memset(SiteCountArray[I], 0, Sz);
+ }
+ }
+
+ if (!(VPDataReader->InitRTRecord(Data, SiteCountArray)))
+ return 0;
+
+ return VPDataReader->GetValueProfDataSize();
+}
+
COMPILER_RT_VISIBILITY int lprofWriteData(ProfDataWriter *Writer,
VPDataReaderType *VPDataReader,
int SkipNameDataWrite) {
diff --git a/compiler-rt/test/profile/instrprof-all-without-libc.c b/compiler-rt/test/profile/instrprof-all-without-libc.c
new file mode 100644
index 0000000000000..3bc5bf8368f53
--- /dev/null
+++ b/compiler-rt/test/profile/instrprof-all-without-libc.c
@@ -0,0 +1,75 @@
+// RUN: %clang_profgen -DCHECK_SYMBOLS -O3 -o %t.symbols %s
+// RUN: llvm-nm %t.symbols | FileCheck %s --check-prefix=CHECK-SYMBOLS
+// RUN: %clang_profgen -O3 -o %t %s
+// RUN: %run %t %t.profraw
+// RUN: llvm-profdata merge -o %t.profdata %t.profraw
+// RUN: %clang_profuse=%t.profdata -o - -S -emit-llvm %s | FileCheck %s
+
+// This usage of llvm-nm assumes executables have symbol tables. They do not in
+// an MSVC environment, so we can't make this test portable.
+// UNSUPPORTED: msvc
+
+#include <stdint.h>
+#include <stdlib.h>
+
+#ifndef CHECK_SYMBOLS
+#include <stdio.h>
+#endif
+
+int __llvm_profile_runtime = 0;
+uint64_t __llvm_profile_get_all_size_for_buffer(void);
+int __llvm_profile_write_all_buffer(char *);
+int __llvm_profile_merge_from_buffer(const char *, uint64_t Size);
+
+int write_buffer(uint64_t, const char *);
+int main(int argc, const char *argv[]) {
+ // CHECK-LABEL: define {{.*}} @main(
+ // CHECK: br i1 %{{.*}}, label %{{.*}}, label %{{.*}}, !prof ![[PD1:[0-9]+]]
+ if (argc < 2)
+ return 1;
+
+ const uint64_t MaxSize = 10000;
+ static char Buffer[MaxSize];
+
+ uint64_t Size = __llvm_profile_get_all_size_for_buffer();
+ if (Size > MaxSize)
+ return 1;
+ int Write = __llvm_profile_write_all_buffer(Buffer);
+ if (Write)
+ return Write;
+
+#ifdef CHECK_SYMBOLS
+ // Don't write it out. Since we're checking the symbols, we don't have libc
+ // available.
+ // Call merge function to make sure it does not bring in libc deps:
+ __llvm_profile_merge_from_buffer(Buffer, Size);
+ return 0;
+#else
+ // Actually write it out so we can FileCheck the output.
+ FILE *File = fopen(argv[1], "w");
+ if (!File)
+ return 1;
+ if (fwrite(Buffer, 1, Size, File) != Size)
+ return 1;
+ return fclose(File);
+#endif
+}
+// CHECK: ![[PD1]] = !{!"branch_weights", i32 1, i32 2}
+
+// CHECK-SYMBOLS-NOT: {{ }}___cxx_global_var_init
+// CHECK-SYMBOLS-NOT: {{ }}___llvm_profile_register_write_file_atexit
+// CHECK-SYMBOLS-NOT: {{ }}___llvm_profile_set_filename
+// CHECK-SYMBOLS-NOT: {{ }}___llvm_profile_write_file
+// CHECK-SYMBOLS-NOT: {{ }}_fdopen
+// CHECK-SYMBOLS-NOT: {{ }}_fopen
+// CHECK-SYMBOLS-NOT: {{ }}_fwrite
+// CHECK-SYMBOLS-NOT: {{ }}_getenv
+// CHECK-SYMBOLS-NOT: {{ }}getenv
+// CHECK-SYMBOLS-NOT: {{ }}_malloc
+// CHECK-SYMBOLS-NOT: {{ }}malloc
+// CHECK-SYMBOLS-NOT: {{ }}_calloc
+// CHECK-SYMBOLS-NOT: {{ }}calloc
+// CHECK-SYMBOLS-NOT: {{ }}_free
+// CHECK-SYMBOLS-NOT: {{ }}free
+// CHECK-SYMBOLS-NOT: {{ }}_open
+// CHECK-SYMBOLS-NOT: {{ }}_getpagesize
More information about the llvm-commits
mailing list