[Profile] deprecate __llvm_profile_override_default_filename [part-2]

[davidxl]

Summary

This is the runtime part.

[vsk]

Minor nits.

lib/profile/InstrProfilingFile.c

473

Nit, might be easier to read as an if-stmt + ternary.

test/profile/instrprof-override-filename-with-env.c

2

Does this test anything useful now? Can we just delete this file?

test/profile/instrprof-override-filename.c

2

Ditto, we should just be able to delete this file.

[davidxl]

test/profile/instrprof-override-filename-with-env.c

2

This one still has value to test path precedence.

test/profile/instrprof-override-filename.c

2

Same here -- it can serve as a basic test that = form of the option override the default.

[davidxl]

Addressed review feedback

[vsk]

Looks good.

test/profile/instrprof-override-filename-with-env.c

2

Ok

lib/profile/InstrProfData.inc

  * bits (i.e. bit 56) to 1 to indicate if this is an IR-level instrumentaiton
  * generated profile, and 0 if this is a Clang FE generated profile.
  */
 #define VARIANT_MASKS_ALL 0xff00000000000000ULL
 #define GET_VERSION(V) ((V) & ~VARIANT_MASKS_ALL)
 #define VARIANT_MASK_IR_PROF (0x1ULL << 56)
 #define IR_LEVEL_PROF_VERSION_VAR __llvm_profile_raw_version
 
+/* The variable that holds the name of the profile data
+ * specified via command line. */
+#define INSTR_PROF_PROFILE_NAME_VAR __llvm_profile_filename
+
 /* Runtime section names and name strings.  */
 #define INSTR_PROF_DATA_SECT_NAME __llvm_prf_data
 #define INSTR_PROF_NAME_SECT_NAME __llvm_prf_names
 #define INSTR_PROF_CNTS_SECT_NAME __llvm_prf_cnts
 /* Array of pointers. Each pointer points to a list
  * of value nodes associated with one value site.
  */
 #define INSTR_PROF_VALS_SECT_NAME __llvm_prf_vals

lib/profile/InstrProfiling.h

#include "InstrProfData.inc"
     );
 
 /*!
  * \brief Write instrumentation data to the current file.
  *
  * Writes to the file with the last name given to \a *
  * __llvm_profile_set_filename(),
  * or if it hasn't been called, the \c LLVM_PROFILE_FILE environment variable,
- * or if that's not set, the last name given to
- * \a __llvm_profile_override_default_filename(), or if that's not set,
- * \c "default.profraw".
+ * or if that's not set, the last name set to INSTR_PROF_PROFILE_NAME_VAR,
+ * or if that's not set,  \c "default.profraw".
  */
 int __llvm_profile_write_file(void);
 
 /*!
  * \brief Set the filename for writing instrumentation data.
  *
  * Sets the filename to be used for subsequent calls to
  * \a __llvm_profile_write_file().
  *
  * \c Name is not copied, so it must remain valid.  Passing NULL resets the
  * filename logic to the default behaviour.
  */
 void __llvm_profile_set_filename(const char *Name);
 
-/*!
- * \brief Set the filename for writing instrumentation data, unless the
- * \c LLVM_PROFILE_FILE environment variable was set.
- *
- * Unless overridden, sets the filename to be used for subsequent calls to
- * \a __llvm_profile_write_file().
- *
- * \c Name is not copied, so it must remain valid.  Passing NULL resets the
- * filename logic to the default behaviour (unless the \c LLVM_PROFILE_FILE
- * was set in which case it has no effect).
- */
-void __llvm_profile_override_default_filename(const char *Name);
-
 /*! \brief Register to write instrumentation data to file at exit. */
 int __llvm_profile_register_write_file_atexit(void);
 
 /*! \brief Initialize file handling. */
 void __llvm_profile_initialize_file(void);
 
 /*!
  * \brief Return path prefix (excluding the base filename) of the profile data.

  * is defined as weak so that compiler can emit an overriding definition
  * depending on user option.  Since we don't support mixing FE and IR based
  * data in the same raw profile data file (in other words, shared libs and
  * main program are expected to be instrumented in the same way), there is
  * no need for this variable to be hidden.
  */
 extern uint64_t __llvm_profile_raw_version;
 
+/*!
+ * This variable is a weak symbol defined in InstrProfiling.c. It allows
+ * compiler instrumentation to provide overriding definition with value
+ * from compiler command line. This variable has default visibility.
+ */
+extern char INSTR_PROF_PROFILE_NAME_VAR[1]; /* __llvm_profile_filename. */
+
 #endif /* PROFILE_INSTRPROFILING_H_ */

lib/profile/InstrProfiling.c

 #include <string.h>
 #define INSTR_PROF_VALUE_PROF_DATA
 #include "InstrProfData.inc"
 
 COMPILER_RT_VISIBILITY char *(*GetEnvHook)(const char *) = 0;
 
 COMPILER_RT_WEAK uint64_t __llvm_profile_raw_version = INSTR_PROF_RAW_VERSION;
 
+COMPILER_RT_WEAK char INSTR_PROF_PROFILE_NAME_VAR[1] = {0};
+
 COMPILER_RT_VISIBILITY uint64_t __llvm_profile_get_magic(void) {
   return sizeof(void *) == sizeof(uint64_t) ? (INSTR_PROF_RAW_MAGIC_64)
                                             : (INSTR_PROF_RAW_MAGIC_32);
 }
 
 /* Return the number of bytes needed to add to SizeInBytes to make it
  *   the result a multiple of 8.
  */

lib/profile/InstrProfilingFile.c

static void parseAndSetFilename(const char *FilenamePat,
   ProfileNameSpecifier OldPNS = lprofCurFilename.PNS;
 
   if (PNS < OldPNS)
     return;
 
   if (!FilenamePat)
     FilenamePat = DefaultProfileName;
 
-  /* When -fprofile-instr-generate=<path> is specified on the
-   * command line, each module will be instrumented with runtime
-   * init call to __llvm_profile_init function which calls
-   * __llvm_profile_override_default_filename. In most of the cases,
-   * the path will be identical, so bypass the parsing completely.
-   */
   if (OldFilenamePat && !strcmp(OldFilenamePat, FilenamePat)) {
     lprofCurFilename.PNS = PNS;
     return;
   }
 
   /* When PNS >= OldPNS, the last one wins. */
   if (!FilenamePat || parseFilenamePattern(FilenamePat))
     resetFilenameToDefault();

 
 /* This method is invoked by the runtime initialization hook
  * InstrProfilingRuntime.o if it is linked in. Both user specified
  * profile path via -fprofile-instr-generate= and LLVM_PROFILE_FILE
  * environment variable can override this default value. */
 COMPILER_RT_VISIBILITY
 void __llvm_profile_initialize_file(void) {
   const char *FilenamePat;
+  int hasCommandLineOverrider = (INSTR_PROF_PROFILE_NAME_VAR[0] != 0);
 
   FilenamePat = getFilenamePatFromEnv();
-  parseAndSetFilename(FilenamePat, FilenamePat ? PNS_environment : PNS_default);
+  parseAndSetFilename(
+      FilenamePat
+          ? FilenamePat
+          : (hasCommandLineOverrider ? INSTR_PROF_PROFILE_NAME_VAR : NULL),
+      FilenamePat ? PNS_environment
+                  : (hasCommandLineOverrider ? PNS_command_line : PNS_default));
 }
 
 /* This API is directly called by the user application code. It has the
  * highest precedence compared with LLVM_PROFILE_FILE environment variable
  * and command line option -fprofile-instr-generate=<profile_name>.
  */
 COMPILER_RT_VISIBILITY
 void __llvm_profile_set_filename(const char *FilenamePat) {
   parseAndSetFilename(FilenamePat, PNS_runtime_api);
 }
 
-/*
- * This API is invoked by the global initializers emitted by Clang/LLVM when
- * -fprofile-instr-generate=<..> is specified (vs -fprofile-instr-generate
- *  without an argument). This option has lower precedence than the
- *  LLVM_PROFILE_FILE environment variable.
- */
-COMPILER_RT_VISIBILITY
-void __llvm_profile_override_default_filename(const char *FilenamePat) {
-  parseAndSetFilename(FilenamePat, PNS_command_line);
-}
-
 /* The public API for writing profile data into the file with name
  * set by previous calls to __llvm_profile_set_filename or
  * __llvm_profile_override_default_filename or
  * __llvm_profile_initialize_file. */
 COMPILER_RT_VISIBILITY
 int __llvm_profile_write_file(void) {
   int rc, Length;
   const char *Filename;

test/profile/instrprof-override-filename-then-reset-default.c

 // RUN: rm -rf %t.d
 // RUN: mkdir -p %t.d
 // RUN: cd %t.d
 // RUN: %clang_profgen -O3 %s -o %t.out
 // RUN: %run %t.out %t.d/bad.profraw
 // RUN: llvm-profdata merge -o %t.d/default.profdata %t.d/default.profraw
 // RUN: %clang_profuse=%t.d/default.profdata -o - -S -emit-llvm %s | FileCheck %s
 
 
-void __llvm_profile_override_default_filename(const char *);
+void __llvm_profile_set_filename(const char *);
 int main(int argc, const char *argv[]) {
   // CHECK: br i1 %{{.*}}, label %{{.*}}, label %{{.*}}, !prof ![[PD1:[0-9]+]]
   if (argc < 2)
     return 1;
-  __llvm_profile_override_default_filename(argv[1]);
-  __llvm_profile_override_default_filename(0);
+  __llvm_profile_set_filename(argv[1]);
+  __llvm_profile_set_filename(0);
   return 0;
 }
 // CHECK: ![[PD1]] = !{!"branch_weights", i32 1, i32 2}

test/profile/instrprof-override-filename-with-env.c

-// RUN: %clang_profgen -o %t -O3 %s
+// RUN: %clang_profgen=%t.bad.profraw -o %t -O3 %s
 // RUN: env LLVM_PROFILE_FILE=%t.good.profraw %run %t %t.bad.profraw
 // RUN: llvm-profdata merge -o %t.profdata %t.good.profraw
 // RUN: %clang_profuse=%t.profdata -o - -S -emit-llvm %s | FileCheck %s
 
-void __llvm_profile_override_default_filename(const char *);
+void bar () {}
 int main(int argc, const char *argv[]) {
   // CHECK: br i1 %{{.*}}, label %{{.*}}, label %{{.*}}, !prof ![[PD1:[0-9]+]]
   if (argc < 2)
     return 1;
-  __llvm_profile_override_default_filename(argv[1]);
+  bar();
   return 0;
 }
 // CHECK: ![[PD1]] = !{!"branch_weights", i32 1, i32 2}

test/profile/instrprof-override-filename.c

-// RUN: %clang_profgen -o %t -O3 %s
+// RUN: %clang_profgen=%t.profraw -o %t -O3 %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
 
-void __llvm_profile_override_default_filename(const char *);
+void bar() {}
 int main(int argc, const char *argv[]) {
   // CHECK: br i1 %{{.*}}, label %{{.*}}, label %{{.*}}, !prof ![[PD1:[0-9]+]]
   if (argc < 2)
     return 1;
-  __llvm_profile_override_default_filename(argv[1]);
+  bar();
   return 0;
 }
 // CHECK: ![[PD1]] = !{!"branch_weights", i32 1, i32 2}