[profile] Add %b LLVM_PROFILE_FILE option for binary ID
#123963
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be notified. If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers. If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
llvmbot
added
clang
|
@llvm/pr-subscribers-clang Author: Sinkevich Artem (ArtSin) ChangesAdd support for expanding This is supported on all platforms where writing binary IDs into profiles is implemented, as the Fixes #51560. Full diff: https://github.com/llvm/llvm-project/pull/123963.diff 4 Files Affected:
diff --git a/clang/docs/SourceBasedCodeCoverage.rst b/clang/docs/SourceBasedCodeCoverage.rst
index 73910e134a5891..49bce3b72b45aa 100644
--- a/clang/docs/SourceBasedCodeCoverage.rst
+++ b/clang/docs/SourceBasedCodeCoverage.rst
@@ -94,6 +94,11 @@ directory structure will be created. Additionally, the following special
not specified (i.e the pattern is "%m"), it's assumed that ``N = 1``. The
merge pool specifier can only occur once per filename pattern.
+* "%b" expands out to the binary ID (build ID). It can be used with "%Nm" to
+ avoid binary signature collisions. To use it, the program should be compiled
+ with the build ID linker option (``--build-id`` for GNU ld or LLD). Linux,
+ Windows and AIX are supported.
+
* "%c" expands out to nothing, but enables a mode in which profile counter
updates are continuously synced to a file. This means that if the
instrumented program crashes, or is killed by a signal, perfect coverage
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst
index 260e84910c6f78..bc0ce3f3ccad07 100644
--- a/clang/docs/UsersManual.rst
+++ b/clang/docs/UsersManual.rst
@@ -2880,7 +2880,8 @@ instrumentation:
environment variable to specify an alternate file. If non-default file name
is specified by both the environment variable and the command line option,
the environment variable takes precedence. The file name pattern specified
- can include different modifiers: ``%p``, ``%h``, ``%m``, ``%t``, and ``%c``.
+ can include different modifiers: ``%p``, ``%h``, ``%m``, ``%b``, ``%t``, and
+ ``%c``.
Any instance of ``%p`` in that file name will be replaced by the process
ID, so that you can easily distinguish the profile output from multiple
@@ -2917,7 +2918,7 @@ instrumentation:
$ LLVM_PROFILE_FILE="code-%m.profraw" ./code
See `this <SourceBasedCodeCoverage.html#running-the-instrumented-program>`_ section
- about the ``%t``, and ``%c`` modifiers.
+ about the ``%b``, ``%t``, and ``%c`` modifiers.
3. Combine profiles from multiple runs and convert the "raw" profile format to
the input expected by clang. Use the ``merge`` command of the
diff --git a/compiler-rt/lib/profile/InstrProfilingFile.c b/compiler-rt/lib/profile/InstrProfilingFile.c
index bad4cc71801ec4..01fd314e577f76 100644
--- a/compiler-rt/lib/profile/InstrProfilingFile.c
+++ b/compiler-rt/lib/profile/InstrProfilingFile.c
@@ -77,6 +77,7 @@ typedef struct lprofFilename {
char Hostname[COMPILER_RT_MAX_HOSTLEN];
unsigned NumPids;
unsigned NumHosts;
+ unsigned NumBinaryIds;
/* When in-process merging is enabled, this parameter specifies
* the total number of profile data files shared by all the processes
* spawned from the same binary. By default the value is 1. If merging
@@ -88,8 +89,8 @@ typedef struct lprofFilename {
ProfileNameSpecifier PNS;
} lprofFilename;
-static lprofFilename lprofCurFilename = {0, 0, 0, {0}, NULL,
- {0}, 0, 0, 0, PNS_unknown};
+static lprofFilename lprofCurFilename = {0, 0, 0, {0}, NULL, {0},
+ 0, 0, 0, 0, PNS_unknown};
static int ProfileMergeRequested = 0;
static int getProfileFileSizeForMerging(FILE *ProfileFile,
@@ -790,7 +791,7 @@ static int checkBounds(int Idx, int Strlen) {
* lprofcurFilename structure. */
static int parseFilenamePattern(const char *FilenamePat,
unsigned CopyFilenamePat) {
- int NumPids = 0, NumHosts = 0, I;
+ int NumPids = 0, NumHosts = 0, NumBinaryIds = 0, I;
char *PidChars = &lprofCurFilename.PidChars[0];
char *Hostname = &lprofCurFilename.Hostname[0];
int MergingEnabled = 0;
@@ -855,6 +856,15 @@ static int parseFilenamePattern(const char *FilenamePat,
FilenamePat);
return -1;
}
+ } else if (FilenamePat[I] == 'b') {
+ if (!NumBinaryIds++) {
+ if (__llvm_write_binary_ids(NULL) <= 0) {
+ PROF_WARN("Unable to get binary ID for filename pattern %s. Using "
+ "the default name.",
+ FilenamePat);
+ return -1;
+ }
+ }
} else if (FilenamePat[I] == 'c') {
if (__llvm_profile_is_continuous_mode_enabled()) {
PROF_WARN("%%c specifier can only be specified once in %s.\n",
@@ -887,6 +897,7 @@ static int parseFilenamePattern(const char *FilenamePat,
lprofCurFilename.NumPids = NumPids;
lprofCurFilename.NumHosts = NumHosts;
+ lprofCurFilename.NumBinaryIds = NumBinaryIds;
return 0;
}
@@ -934,24 +945,53 @@ static void parseAndSetFilename(const char *FilenamePat,
* filename with PID and hostname substitutions. */
/* The length to hold uint64_t followed by 3 digits pool id including '_' */
#define SIGLEN 24
+/* The length to hold 160-bit hash in hexadecimal form */
+#define BINARY_ID_LEN 40
static int getCurFilenameLength(void) {
int Len;
if (!lprofCurFilename.FilenamePat || !lprofCurFilename.FilenamePat[0])
return 0;
if (!(lprofCurFilename.NumPids || lprofCurFilename.NumHosts ||
- lprofCurFilename.TmpDir || lprofCurFilename.MergePoolSize))
+ lprofCurFilename.NumBinaryIds || lprofCurFilename.TmpDir ||
+ lprofCurFilename.MergePoolSize))
return strlen(lprofCurFilename.FilenamePat);
Len = strlen(lprofCurFilename.FilenamePat) +
lprofCurFilename.NumPids * (strlen(lprofCurFilename.PidChars) - 2) +
lprofCurFilename.NumHosts * (strlen(lprofCurFilename.Hostname) - 2) +
+ lprofCurFilename.NumBinaryIds * BINARY_ID_LEN +
(lprofCurFilename.TmpDir ? (strlen(lprofCurFilename.TmpDir) - 1) : 0);
if (lprofCurFilename.MergePoolSize)
Len += SIGLEN;
return Len;
}
+typedef struct lprofBinaryIdsBuffer {
+ char String[BINARY_ID_LEN + 1];
+ int Length;
+} lprofBinaryIdsBuffer;
+
+/* Reads binary ID length and then its data, writes it into lprofBinaryIdsBuffer
+ * in hexadecimal form. */
+static uint32_t binaryIdsStringWriter(ProfDataWriter *This,
+ ProfDataIOVec *IOVecs,
+ uint32_t NumIOVecs) {
+ if (NumIOVecs < 2 || IOVecs[0].ElmSize != sizeof(uint64_t))
+ return -1;
+ uint64_t BinaryIdLen = *(const uint64_t *)IOVecs[0].Data;
+ if (IOVecs[1].ElmSize != sizeof(uint8_t) || IOVecs[1].NumElm != BinaryIdLen)
+ return -1;
+ const uint8_t *BinaryIdData = (const uint8_t *)IOVecs[1].Data;
+ lprofBinaryIdsBuffer *Data = (lprofBinaryIdsBuffer *)This->WriterCtx;
+ for (uint64_t I = 0; I < BinaryIdLen; I++) {
+ Data->Length +=
+ snprintf(Data->String + Data->Length, BINARY_ID_LEN + 1 - Data->Length,
+ "%02hhx", BinaryIdData[I]);
+ }
+ return 0;
+}
+
/* Return the pointer to the current profile file name (after substituting
* PIDs and Hostnames in filename pattern. \p FilenameBuf is the buffer
* to store the resulting filename. If no substitution is needed, the
@@ -965,7 +1005,8 @@ static const char *getCurFilename(char *FilenameBuf, int ForceUseBuf) {
return 0;
if (!(lprofCurFilename.NumPids || lprofCurFilename.NumHosts ||
- lprofCurFilename.TmpDir || lprofCurFilename.MergePoolSize ||
+ lprofCurFilename.NumBinaryIds || lprofCurFilename.TmpDir ||
+ lprofCurFilename.MergePoolSize ||
__llvm_profile_is_continuous_mode_enabled())) {
if (!ForceUseBuf)
return lprofCurFilename.FilenamePat;
@@ -992,6 +1033,12 @@ static const char *getCurFilename(char *FilenameBuf, int ForceUseBuf) {
memcpy(FilenameBuf + J, lprofCurFilename.TmpDir, TmpDirLength);
FilenameBuf[J + TmpDirLength] = DIR_SEPARATOR;
J += TmpDirLength + 1;
+ } else if (FilenamePat[I] == 'b') {
+ lprofBinaryIdsBuffer Data = {{0}, 0};
+ ProfDataWriter Writer = {binaryIdsStringWriter, &Data};
+ __llvm_write_binary_ids(&Writer);
+ memcpy(FilenameBuf + J, Data.String, Data.Length);
+ J += Data.Length;
} else {
if (!getMergePoolSize(FilenamePat, &I))
continue;
diff --git a/compiler-rt/test/profile/Linux/binary-id-path.c b/compiler-rt/test/profile/Linux/binary-id-path.c
new file mode 100644
index 00000000000000..7dce409d2e8f91
--- /dev/null
+++ b/compiler-rt/test/profile/Linux/binary-id-path.c
@@ -0,0 +1,37 @@
+// REQUIRES: linux
+// RUN: split-file %s %t.dir
+// RUN: %clang_profgen -Wl,--build-id=sha1 -o %t.dir/foo %t.dir/foo.c
+// RUN: %clang_profgen -Wl,--build-id=sha1 -o %t.dir/bar %t.dir/bar.c
+
+// Check that foo and bar have the same signatures.
+// RUN: rm -rf %t.profdir
+// RUN: env LLVM_PROFILE_FILE=%t.profdir/%m.profraw %run %t.dir/foo
+// RUN: env LLVM_PROFILE_FILE=%t.profdir/%m.profraw %run %t.dir/bar 2>&1 | FileCheck %s --check-prefix=MERGE-ERROR
+
+// Check that foo and bar have different binary IDs.
+// RUN: rm -rf %t.profdir %t.profdata
+// RUN: env LLVM_PROFILE_FILE=%t.profdir/%b.profraw %run %t.dir/foo
+// RUN: env LLVM_PROFILE_FILE=%t.profdir/%b.profraw %run %t.dir/bar
+// RUN: llvm-profdata merge -o %t.profdata %t.profdir
+// RUN: llvm-profdata show %t.profdata | FileCheck %s --check-prefix=BINARY-ID
+
+// Check fallback to the default name if binary ID is missing.
+// RUN: %clang_profgen -Wl,--build-id=none -o %t.dir/foo %t.dir/foo.c
+// RUN: env LLVM_PROFILE_FILE=%t.profdir/%b.profraw %run %t.dir/foo 2>&1 | FileCheck %s --check-prefix=MISSING
+
+// MERGE-ERROR: LLVM Profile Error: Profile Merging of file {{.*}}.profraw failed: File exists
+
+// BINARY-ID: Instrumentation level: Front-end
+// BINARY-ID-NEXT: Total functions: 3
+// BINARY-ID-NEXT: Maximum function count: 2
+// BINARY-ID-NEXT: Maximum internal block count: 0
+
+// MISSING: Unable to get binary ID for filename pattern {{.*}}.profraw. Using the default name.
+
+//--- foo.c
+int main(void) { return 0; }
+void foo(void) {}
+
+//--- bar.c
+int main(void) { return 0; }
+void bar(int *a) { *a += 10; }
|
|
@llvm/pr-subscribers-pgo Author: Sinkevich Artem (ArtSin) ChangesAdd support for expanding This is supported on all platforms where writing binary IDs into profiles is implemented, as the Fixes #51560. Full diff: https://github.com/llvm/llvm-project/pull/123963.diff 4 Files Affected:
diff --git a/clang/docs/SourceBasedCodeCoverage.rst b/clang/docs/SourceBasedCodeCoverage.rst
index 73910e134a5891..49bce3b72b45aa 100644
--- a/clang/docs/SourceBasedCodeCoverage.rst
+++ b/clang/docs/SourceBasedCodeCoverage.rst
@@ -94,6 +94,11 @@ directory structure will be created. Additionally, the following special
not specified (i.e the pattern is "%m"), it's assumed that ``N = 1``. The
merge pool specifier can only occur once per filename pattern.
+* "%b" expands out to the binary ID (build ID). It can be used with "%Nm" to
+ avoid binary signature collisions. To use it, the program should be compiled
+ with the build ID linker option (``--build-id`` for GNU ld or LLD). Linux,
+ Windows and AIX are supported.
+
* "%c" expands out to nothing, but enables a mode in which profile counter
updates are continuously synced to a file. This means that if the
instrumented program crashes, or is killed by a signal, perfect coverage
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst
index 260e84910c6f78..bc0ce3f3ccad07 100644
--- a/clang/docs/UsersManual.rst
+++ b/clang/docs/UsersManual.rst
@@ -2880,7 +2880,8 @@ instrumentation:
environment variable to specify an alternate file. If non-default file name
is specified by both the environment variable and the command line option,
the environment variable takes precedence. The file name pattern specified
- can include different modifiers: ``%p``, ``%h``, ``%m``, ``%t``, and ``%c``.
+ can include different modifiers: ``%p``, ``%h``, ``%m``, ``%b``, ``%t``, and
+ ``%c``.
Any instance of ``%p`` in that file name will be replaced by the process
ID, so that you can easily distinguish the profile output from multiple
@@ -2917,7 +2918,7 @@ instrumentation:
$ LLVM_PROFILE_FILE="code-%m.profraw" ./code
See `this <SourceBasedCodeCoverage.html#running-the-instrumented-program>`_ section
- about the ``%t``, and ``%c`` modifiers.
+ about the ``%b``, ``%t``, and ``%c`` modifiers.
3. Combine profiles from multiple runs and convert the "raw" profile format to
the input expected by clang. Use the ``merge`` command of the
diff --git a/compiler-rt/lib/profile/InstrProfilingFile.c b/compiler-rt/lib/profile/InstrProfilingFile.c
index bad4cc71801ec4..01fd314e577f76 100644
--- a/compiler-rt/lib/profile/InstrProfilingFile.c
+++ b/compiler-rt/lib/profile/InstrProfilingFile.c
@@ -77,6 +77,7 @@ typedef struct lprofFilename {
char Hostname[COMPILER_RT_MAX_HOSTLEN];
unsigned NumPids;
unsigned NumHosts;
+ unsigned NumBinaryIds;
/* When in-process merging is enabled, this parameter specifies
* the total number of profile data files shared by all the processes
* spawned from the same binary. By default the value is 1. If merging
@@ -88,8 +89,8 @@ typedef struct lprofFilename {
ProfileNameSpecifier PNS;
} lprofFilename;
-static lprofFilename lprofCurFilename = {0, 0, 0, {0}, NULL,
- {0}, 0, 0, 0, PNS_unknown};
+static lprofFilename lprofCurFilename = {0, 0, 0, {0}, NULL, {0},
+ 0, 0, 0, 0, PNS_unknown};
static int ProfileMergeRequested = 0;
static int getProfileFileSizeForMerging(FILE *ProfileFile,
@@ -790,7 +791,7 @@ static int checkBounds(int Idx, int Strlen) {
* lprofcurFilename structure. */
static int parseFilenamePattern(const char *FilenamePat,
unsigned CopyFilenamePat) {
- int NumPids = 0, NumHosts = 0, I;
+ int NumPids = 0, NumHosts = 0, NumBinaryIds = 0, I;
char *PidChars = &lprofCurFilename.PidChars[0];
char *Hostname = &lprofCurFilename.Hostname[0];
int MergingEnabled = 0;
@@ -855,6 +856,15 @@ static int parseFilenamePattern(const char *FilenamePat,
FilenamePat);
return -1;
}
+ } else if (FilenamePat[I] == 'b') {
+ if (!NumBinaryIds++) {
+ if (__llvm_write_binary_ids(NULL) <= 0) {
+ PROF_WARN("Unable to get binary ID for filename pattern %s. Using "
+ "the default name.",
+ FilenamePat);
+ return -1;
+ }
+ }
} else if (FilenamePat[I] == 'c') {
if (__llvm_profile_is_continuous_mode_enabled()) {
PROF_WARN("%%c specifier can only be specified once in %s.\n",
@@ -887,6 +897,7 @@ static int parseFilenamePattern(const char *FilenamePat,
lprofCurFilename.NumPids = NumPids;
lprofCurFilename.NumHosts = NumHosts;
+ lprofCurFilename.NumBinaryIds = NumBinaryIds;
return 0;
}
@@ -934,24 +945,53 @@ static void parseAndSetFilename(const char *FilenamePat,
* filename with PID and hostname substitutions. */
/* The length to hold uint64_t followed by 3 digits pool id including '_' */
#define SIGLEN 24
+/* The length to hold 160-bit hash in hexadecimal form */
+#define BINARY_ID_LEN 40
static int getCurFilenameLength(void) {
int Len;
if (!lprofCurFilename.FilenamePat || !lprofCurFilename.FilenamePat[0])
return 0;
if (!(lprofCurFilename.NumPids || lprofCurFilename.NumHosts ||
- lprofCurFilename.TmpDir || lprofCurFilename.MergePoolSize))
+ lprofCurFilename.NumBinaryIds || lprofCurFilename.TmpDir ||
+ lprofCurFilename.MergePoolSize))
return strlen(lprofCurFilename.FilenamePat);
Len = strlen(lprofCurFilename.FilenamePat) +
lprofCurFilename.NumPids * (strlen(lprofCurFilename.PidChars) - 2) +
lprofCurFilename.NumHosts * (strlen(lprofCurFilename.Hostname) - 2) +
+ lprofCurFilename.NumBinaryIds * BINARY_ID_LEN +
(lprofCurFilename.TmpDir ? (strlen(lprofCurFilename.TmpDir) - 1) : 0);
if (lprofCurFilename.MergePoolSize)
Len += SIGLEN;
return Len;
}
+typedef struct lprofBinaryIdsBuffer {
+ char String[BINARY_ID_LEN + 1];
+ int Length;
+} lprofBinaryIdsBuffer;
+
+/* Reads binary ID length and then its data, writes it into lprofBinaryIdsBuffer
+ * in hexadecimal form. */
+static uint32_t binaryIdsStringWriter(ProfDataWriter *This,
+ ProfDataIOVec *IOVecs,
+ uint32_t NumIOVecs) {
+ if (NumIOVecs < 2 || IOVecs[0].ElmSize != sizeof(uint64_t))
+ return -1;
+ uint64_t BinaryIdLen = *(const uint64_t *)IOVecs[0].Data;
+ if (IOVecs[1].ElmSize != sizeof(uint8_t) || IOVecs[1].NumElm != BinaryIdLen)
+ return -1;
+ const uint8_t *BinaryIdData = (const uint8_t *)IOVecs[1].Data;
+ lprofBinaryIdsBuffer *Data = (lprofBinaryIdsBuffer *)This->WriterCtx;
+ for (uint64_t I = 0; I < BinaryIdLen; I++) {
+ Data->Length +=
+ snprintf(Data->String + Data->Length, BINARY_ID_LEN + 1 - Data->Length,
+ "%02hhx", BinaryIdData[I]);
+ }
+ return 0;
+}
+
/* Return the pointer to the current profile file name (after substituting
* PIDs and Hostnames in filename pattern. \p FilenameBuf is the buffer
* to store the resulting filename. If no substitution is needed, the
@@ -965,7 +1005,8 @@ static const char *getCurFilename(char *FilenameBuf, int ForceUseBuf) {
return 0;
if (!(lprofCurFilename.NumPids || lprofCurFilename.NumHosts ||
- lprofCurFilename.TmpDir || lprofCurFilename.MergePoolSize ||
+ lprofCurFilename.NumBinaryIds || lprofCurFilename.TmpDir ||
+ lprofCurFilename.MergePoolSize ||
__llvm_profile_is_continuous_mode_enabled())) {
if (!ForceUseBuf)
return lprofCurFilename.FilenamePat;
@@ -992,6 +1033,12 @@ static const char *getCurFilename(char *FilenameBuf, int ForceUseBuf) {
memcpy(FilenameBuf + J, lprofCurFilename.TmpDir, TmpDirLength);
FilenameBuf[J + TmpDirLength] = DIR_SEPARATOR;
J += TmpDirLength + 1;
+ } else if (FilenamePat[I] == 'b') {
+ lprofBinaryIdsBuffer Data = {{0}, 0};
+ ProfDataWriter Writer = {binaryIdsStringWriter, &Data};
+ __llvm_write_binary_ids(&Writer);
+ memcpy(FilenameBuf + J, Data.String, Data.Length);
+ J += Data.Length;
} else {
if (!getMergePoolSize(FilenamePat, &I))
continue;
diff --git a/compiler-rt/test/profile/Linux/binary-id-path.c b/compiler-rt/test/profile/Linux/binary-id-path.c
new file mode 100644
index 00000000000000..7dce409d2e8f91
--- /dev/null
+++ b/compiler-rt/test/profile/Linux/binary-id-path.c
@@ -0,0 +1,37 @@
+// REQUIRES: linux
+// RUN: split-file %s %t.dir
+// RUN: %clang_profgen -Wl,--build-id=sha1 -o %t.dir/foo %t.dir/foo.c
+// RUN: %clang_profgen -Wl,--build-id=sha1 -o %t.dir/bar %t.dir/bar.c
+
+// Check that foo and bar have the same signatures.
+// RUN: rm -rf %t.profdir
+// RUN: env LLVM_PROFILE_FILE=%t.profdir/%m.profraw %run %t.dir/foo
+// RUN: env LLVM_PROFILE_FILE=%t.profdir/%m.profraw %run %t.dir/bar 2>&1 | FileCheck %s --check-prefix=MERGE-ERROR
+
+// Check that foo and bar have different binary IDs.
+// RUN: rm -rf %t.profdir %t.profdata
+// RUN: env LLVM_PROFILE_FILE=%t.profdir/%b.profraw %run %t.dir/foo
+// RUN: env LLVM_PROFILE_FILE=%t.profdir/%b.profraw %run %t.dir/bar
+// RUN: llvm-profdata merge -o %t.profdata %t.profdir
+// RUN: llvm-profdata show %t.profdata | FileCheck %s --check-prefix=BINARY-ID
+
+// Check fallback to the default name if binary ID is missing.
+// RUN: %clang_profgen -Wl,--build-id=none -o %t.dir/foo %t.dir/foo.c
+// RUN: env LLVM_PROFILE_FILE=%t.profdir/%b.profraw %run %t.dir/foo 2>&1 | FileCheck %s --check-prefix=MISSING
+
+// MERGE-ERROR: LLVM Profile Error: Profile Merging of file {{.*}}.profraw failed: File exists
+
+// BINARY-ID: Instrumentation level: Front-end
+// BINARY-ID-NEXT: Total functions: 3
+// BINARY-ID-NEXT: Maximum function count: 2
+// BINARY-ID-NEXT: Maximum internal block count: 0
+
+// MISSING: Unable to get binary ID for filename pattern {{.*}}.profraw. Using the default name.
+
+//--- foo.c
+int main(void) { return 0; }
+void foo(void) {}
+
+//--- bar.c
+int main(void) { return 0; }
+void bar(int *a) { *a += 10; }
|
ArtSin
force-pushed
the
add-binary-id-llvm_profile_file
branch
from
cd11146 to
e7f3e39
Compare
david-xl
reviewed
Feb 3, 2025
| @@ -855,6 +856,15 @@ static int parseFilenamePattern(const char *FilenamePat, | |||
| FilenamePat); | |||
| return -1; | |||
| } | |||
| } else if (FilenamePat[I] == 'b') { | |||
| if (!NumBinaryIds++) { | |||
| if (__llvm_write_binary_ids(NULL) <= 0) { | |||
There was a problem hiding this comment.
Add a code comment to indicate it reads the size of the binary ids.
| // RUN: env LLVM_PROFILE_FILE=%t.profdir/%b.profraw %run %t.dir/foo | ||
| // RUN: env LLVM_PROFILE_FILE=%t.profdir/%b.profraw %run %t.dir/bar | ||
| // RUN: llvm-profdata merge -o %t.profdata %t.profdir | ||
| // RUN: llvm-profdata show %t.profdata | FileCheck %s --check-prefix=BINARY-ID |
There was a problem hiding this comment.
check the binary ids after merging?
There was a problem hiding this comment.
Added check for 2 binary IDs in merged profdata
ArtSin
force-pushed
the
add-binary-id-llvm_profile_file
branch
from
e7f3e39 to
462b70c
Compare
david-xl
reviewed
Feb 5, 2025
clang/docs/UsersManual.rst
Outdated
| @@ -2917,7 +2918,7 @@ instrumentation: | |||
| $ LLVM_PROFILE_FILE="code-%m.profraw" ./code | |||
|
|
|||
| See `this <SourceBasedCodeCoverage.html#running-the-instrumented-program>`_ section | |||
| about the ``%t``, and ``%c`` modifiers. | |||
| about the ``%b``, ``%t``, and ``%c`` modifiers. | |||
There was a problem hiding this comment.
better add an %b use example here too.
ArtSin
force-pushed
the
add-binary-id-llvm_profile_file
branch
from
462b70c to
1d1b66d
Compare
david-xl
approved these changes
Feb 5, 2025
petrhosek
reviewed
Feb 6, 2025
clang/docs/UsersManual.rst
Outdated
| @@ -2916,6 +2917,12 @@ instrumentation: | |||
|
|
|||
| $ LLVM_PROFILE_FILE="code-%m.profraw" ./code | |||
|
|
|||
| Although rare, binary signatures used by the ``%m`` specifier can have | |||
| collisions. In this case, the ``%b`` specifier, which expands to the binary | |||
| ID (build ID), can be added. To use it, the program should be compiled with | |||
There was a problem hiding this comment.
Suggested change
| ID (build ID), can be added. To use it, the program should be compiled with | |
| ID (build ID in ELF and COFF), can be added. To use it, the program should be compiled with |
petrhosek
approved these changes
Feb 6, 2025
ArtSin
force-pushed
the
add-binary-id-llvm_profile_file
branch
from
1d1b66d to
3ebeb7b
Compare
ZequanWu
reviewed
Feb 6, 2025
clang/docs/UsersManual.rst
Outdated
| Although rare, binary signatures used by the ``%m`` specifier can have | ||
| collisions. In this case, the ``%b`` specifier, which expands to the binary | ||
| ID (build ID in ELF and COFF), can be added. To use it, the program should be | ||
| compiled with the build ID linker option (``--build-id`` for GNU ld or LLD). |
There was a problem hiding this comment.
--build-idfor GNU ld or LLD
Also /build-id for lld-link on windows.
Add support for expanding `%b` in `LLVM_PROFILE_FILE` to the binary ID (build ID). It can be used with `%m` to avoid its signature collisions. This is supported on all platforms where writing binary IDs into profiles is implemented, as the `__llvm_write_binary_ids` function is used. Fixes llvm#51560.
ArtSin
force-pushed
the
add-binary-id-llvm_profile_file
branch
from
3ebeb7b to
d14f781
Compare
ZequanWu
approved these changes
Feb 6, 2025
|
@ZequanWu can you please merge this? |
|
@ArtSin Congratulations on having your first Pull Request (PR) merged into the LLVM Project! Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR. Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues. How to do this, and the rest of the post-merge process, is covered in detail here. If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again. If you don't get any reports, no action is required from you. Your changes are working as expected, well done! |
|
@ArtSin the test you added seems to be failing on at least one build bot https://lab.llvm.org/buildbot/#/builders/174/builds/12664. Can you take a look and revert if you need time to investigate? |
|
That should be fixed by 8d925a1. |
|
Hi! I see this patch is already merged, but sine the most testing work is already done, I will still write my report here. I am original reporter of #51560. TL;TR: I met problem with coverage while building coverage while running PostgreSQL tests. Tried How dif I test: I built two branches of llvm: I've configured them with command and then Then I've cloned PostgreSQL Using Then I tried running tests for both builds using
|
|
Reported |
Icohedron
pushed a commit
to Icohedron/llvm-project
that referenced
this pull request
Feb 11, 2025
) Add support for expanding `%b` in `LLVM_PROFILE_FILE` to the binary ID (build ID). It can be used with `%m` to avoid its signature collisions. This is supported on all platforms where writing binary IDs into profiles is implemented, as the `__llvm_write_binary_ids` function is used. Fixes llvm#51560.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add support for expanding
%binLLVM_PROFILE_FILEto the binary ID (build ID). It can be used with%mto avoid its signature collisions.This is supported on all platforms where writing binary IDs into profiles is implemented, as the
__llvm_write_binary_idsfunction is used.Fixes #51560.