[profile] Install headers for custom runtime maintainers

[vsk]

Summary

Some users maintain custom runtimes which provide support for
-fprofile-instr-generate instrumentation in non-standard environments
(e.g the kernel).

It may not be obvious which functions need to be implemented or what
their signatures are. Silent breakage is possible if the runtime's
internal interface changes.

This patch installs a few headers from the profiling runtime to serve as
a reference:

$ ninja install-compiler-rt-headers -v
...
-- Installing: /usr/local/lib/clang/10.0.0/include/profile/InstrProfiling.h
-- Installing: /usr/local/lib/clang/10.0.0/include/profile/InstrProfilingInternal.h
-- Installing: /usr/local/lib/clang/10.0.0/include/profile/InstrProfData.inc

rdar://44375648

[vsk]

Ping.

[beanz]

LGTM.

[delcypher]

@vsk I'm not entirely convinced this is correct but this might be because I don't understand how these header files are meant to be consumed.

Your implementation of add_compiler_rt_header() calls add_compiler_rt_resource_file() which installs into the Clang resource directory (<install_root>/share/). This is not the same path that other sanitizer interface headers get installed (see include/CMakeLists.txt in the compiler-rt source tree) which is <install_root>/include.

This means that clients of won't be able consume these header files in the same way that they consume other sanitizer header files. Perhaps this is intentional because these header files might be internal headers (I don't know. I've not really looked at the profile portion of compiler-rt before).
If that is your intention I really think you need to rename add_compiler_rt_header to something that expresses the intent more explicitly. The name add_compiler_rt_header could easily lead someone to believe it will get installed to <install_root>/include which doesn't appear to be the case.

[vsk]

@delcypher apologies for the massive delay, and thanks for pointing out that issue. This just came up again internally -- PTAL :)?

[vsk]

• Drop an extraneous lldb change.

[delcypher]

@vsk other than the minor nit LGTM.

compiler-rt/include/CMakeLists.txt

33

@vsk Minor nit. Any particular reason why those header files live under lib instead on under include/ in the source tree?

[vsk]

compiler-rt/include/CMakeLists.txt

33

Not that I'm aware of -- this could be a nice chance to clean things up.

Unfortunately I'm having a bear of a time figuring out why the rest of the sanitizers don't seem to pass -I ${COMPILER_RT_SOURCE_DIR}/include, but still manage to find the right headers. The profile runtime isn't built with this -I -- I suppose I could just add it in the profile runtime's CMakeLists.txt (and that works), but feel like I'm missing something. Any chance you've stumbled into this before?

[vsk]

compiler-rt/include/CMakeLists.txt

33

Oh, actually, it looks like the sanitizer implementations don't include their public interface headers on purpose. In light of that, it actually seems more consistent to keep the profile headers in lib.

[vsk]

Friendly ping

compiler-rt/include/CMakeLists.txt

 if (COMPILER_RT_BUILD_XRAY)
   set(XRAY_HEADERS
     xray/xray_interface.h
     xray/xray_log_interface.h
     xray/xray_records.h
     )
 endif(COMPILER_RT_BUILD_XRAY)
 
+if(COMPILER_RT_BUILD_PROFILE AND COMPILER_RT_HAS_PROFILE)
+  set(PROFILE_HEADERS
+    ../lib/profile/InstrProfiling.h
+    ../lib/profile/InstrProfilingInternal.h
+    ../lib/profile/InstrProfData.inc
+    )
+endif()
+
 set(COMPILER_RT_HEADERS
   ${SANITIZER_HEADERS}
   ${FUZZER_HEADERS}
-  ${XRAY_HEADERS})
+  ${XRAY_HEADERS}
+  ${PROFILE_HEADERS})
 
 set(output_dir ${COMPILER_RT_OUTPUT_DIR}/include)
 
 # Copy compiler-rt headers to the build tree.
 set(out_files)
 foreach( f ${COMPILER_RT_HEADERS} )
   set( src ${CMAKE_CURRENT_SOURCE_DIR}/${f} )
   set( dst ${output_dir}/${f} )
install(FILES ${FUZZER_HEADERS}
   COMPONENT compiler-rt-headers
   PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
   DESTINATION ${COMPILER_RT_INSTALL_PATH}/include/fuzzer)
 # Install xray headers.
 install(FILES ${XRAY_HEADERS}
   COMPONENT compiler-rt-headers
   PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
   DESTINATION ${COMPILER_RT_INSTALL_PATH}/include/xray)
+# Install profile headers.
+install(FILES ${PROFILE_HEADERS}
+  COMPONENT compiler-rt-headers
+  PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
+  DESTINATION ${COMPILER_RT_INSTALL_PATH}/include/profile)
 
 if (NOT CMAKE_CONFIGURATION_TYPES) # don't add this for IDEs.
   add_custom_target(install-compiler-rt-headers
                     DEPENDS compiler-rt-headers
                     COMMAND "${CMAKE_COMMAND}"
                             -DCMAKE_INSTALL_COMPONENT="compiler-rt-headers"
                             -P "${CMAKE_BINARY_DIR}/cmake_install.cmake"
                     USES_TERMINAL)
   add_custom_target(install-compiler-rt-headers-stripped
                     DEPENDS compiler-rt-headers
                     COMMAND "${CMAKE_COMMAND}"
                             -DCMAKE_INSTALL_COMPONENT="compiler-rt-headers"
                             -DCMAKE_INSTALL_DO_STRIP=1
                             -P "${CMAKE_BINARY_DIR}/cmake_install.cmake"
                     USES_TERMINAL)
 endif()