export API symbols from dynamic libraries (#1892)

Export API symbols for migraphx, migraphx_ref, migraphx_cpu, migrphx_gpu, migraphx_device, migraphx_tf, and migraphx_onnx. There is a separate PR for migrahx_c.

API symbol exporting affects only Windows. It is transparent on Linux.

cmake/ExportHeader.cmake

+#####################################################################################
+# The MIT License (MIT)
+#
+# Copyright (c) 2015-2022 Advanced Micro Devices, Inc. All rights reserved.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#####################################################################################
+
+if(COMMAND migraphx_generate_export_header)
+    return()
+endif()
+
+include(GenerateExportHeader)
+
+function(migraphx_generate_export_header TARGET)
+    cmake_parse_arguments(PARSE "" "DIRECTORY" "" ${ARGN})
+    if(PARSE_DIRECTORY)
+        set(__directory ${PARSE_DIRECTORY})
+    else()
+        string(REPLACE "_" "/" __directory ${TARGET})
+        string(TOLOWER ${__directory} __directory)
+    endif()
+    set(__file_name ${CMAKE_CURRENT_BINARY_DIR}/include/${__directory}/export.h)
+    generate_export_header(${TARGET} EXPORT_FILE_NAME ${__file_name})
+    target_include_directories(${TARGET} PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/include>)
+    rocm_install(FILES ${__file_name} DESTINATION include/${__directory})
+endfunction()

src/CMakeLists.txt

@@ -22,6 +22,8 @@
 # THE SOFTWARE.
 #####################################################################################
 
+include(ExportHeader)
+
 include(ROCMInstallTargets)
 include(ROCMPackageConfigHelpers)
 include(RegisterOp)
@@ -251,6 +253,7 @@ target_link_libraries(migraphx PUBLIC Threads::Threads)
 
 find_package(nlohmann_json 3.8.0 REQUIRED)
 target_link_libraries(migraphx PRIVATE nlohmann_json::nlohmann_json)
+migraphx_generate_export_header(migraphx)
 
 find_package(PkgConfig)
 pkg_check_modules(SQLITE3 REQUIRED IMPORTED_TARGET sqlite3)

src/include/migraphx/adjust_allocation.hpp

@@ -32,7 +32,7 @@ inline namespace MIGRAPHX_INLINE_NS {
 
 struct module;
 
-struct adjust_allocation
+struct MIGRAPHX_EXPORT adjust_allocation
 {
     allocation_model model;
     std::string name() const { return "adjust_allocation"; }

src/include/migraphx/allocation_model.hpp

@@ -60,7 +60,7 @@ struct allocation_model
 #ifdef TYPE_ERASED_DECLARATION
 
 // Type-erased interface for:
-struct allocation_model
+struct MIGRAPHX_EXPORT allocation_model
 {
     //
     std::string name() const;

src/include/migraphx/analyze_streams.hpp

@@ -39,7 +39,8 @@ struct stream_race
     instruction_ref before;
 };
 
-std::vector<stream_race> analyze_streams(const module& m, const stream_model& strmm);
+MIGRAPHX_EXPORT std::vector<stream_race> analyze_streams(const module& m,
+                                                         const stream_model& strmm);
 
 } // namespace MIGRAPHX_INLINE_NS
 } // namespace migraphx

src/include/migraphx/apply_alpha_beta.hpp

@@ -33,6 +33,7 @@
 namespace migraphx {
 inline namespace MIGRAPHX_INLINE_NS {
 
+MIGRAPHX_EXPORT
 instruction_ref insert_apply_alpha_beta(module& m,
                                         instruction_ref pos,
                                         const std::vector<instruction_ref>& args,

src/include/migraphx/argument.hpp

@@ -42,7 +42,7 @@ inline namespace MIGRAPHX_INLINE_NS {
  * or it can be owned by the argument.
  *
  */
-struct argument : raw_data<argument>
+struct MIGRAPHX_EXPORT argument : raw_data<argument>
 {
     argument() = default;
 
@@ -107,9 +107,9 @@ struct argument : raw_data<argument>
     data_t m_data{};
 };
 
-std::vector<shape> to_shapes(const std::vector<argument>& args);
-void migraphx_to_value(value& v, const argument& a);
-void migraphx_from_value(const value& v, argument& a);
+MIGRAPHX_EXPORT std::vector<shape> to_shapes(const std::vector<argument>& args);
+MIGRAPHX_EXPORT void migraphx_to_value(value& v, const argument& a);
+MIGRAPHX_EXPORT void migraphx_from_value(const value& v, argument& a);
 
 } // namespace MIGRAPHX_INLINE_NS
 } // namespace migraphx

src/include/migraphx/auto_contiguous.hpp

@@ -33,7 +33,7 @@ inline namespace MIGRAPHX_INLINE_NS {
 
 struct module;
 
-struct auto_contiguous
+struct MIGRAPHX_EXPORT auto_contiguous
 {
     std::string name() const { return "auto_contiguous"; }
     void apply(module& m) const;

src/include/migraphx/common.hpp

@@ -54,21 +54,26 @@ struct operation;
  * s0 = (4, 1, 1) and s1 = (3, 4)
  * output_lens = (4, 3, 4)
  */
+MIGRAPHX_EXPORT
 std::vector<std::size_t> compute_broadcasted_lens(std::vector<std::size_t> s0,
                                                   std::vector<std::size_t> s1);
 
+MIGRAPHX_EXPORT
 std::vector<shape::dynamic_dimension> compute_broadcasted_dyn_dims(shape s0, shape s1);
 
+MIGRAPHX_EXPORT
 shape common_shape(const std::vector<shape>& shapes);
 
 /**
  * @brief Compute the common (broadcasted) dimensions of a list of fixed shapes
  */
+MIGRAPHX_EXPORT
 std::vector<std::size_t> compute_common_lens(const std::vector<shape>& shapes);
 
 /**
  * @ brief Compute the common (broadcasted) dynamic dimensions of a list of dynamic shapes
  */
+MIGRAPHX_EXPORT
 std::vector<shape::dynamic_dimension> compute_common_dyn_dims(const std::vector<shape>& shapes);
 
 /**
@@ -83,11 +88,13 @@ std::vector<shape::dynamic_dimension> compute_common_dyn_dims(const std::vector<
  *                  attached to each instruction_ref are considered for broadcasting
  * @return std::vector<instruction_ref>   a modified argument list
  */
-std::vector<instruction_ref>
+MIGRAPHX_EXPORT std::vector<instruction_ref>
 insert_common_args(module& m, instruction_ref ins, std::vector<instruction_ref> inputs);
 
+MIGRAPHX_EXPORT
 std::vector<instruction_ref> add_common_args(module& m, std::vector<instruction_ref> inputs);
 
+MIGRAPHX_EXPORT
 instruction_ref insert_common_op(module& m,
                                  instruction_ref ins,
                                  const operation& op,
@@ -96,6 +103,7 @@ instruction_ref insert_common_op(module& m,
 /**
  * @brief Wrapper for insert_common_args() which inserts operation at the end of the module.
  */
+MIGRAPHX_EXPORT
 instruction_ref add_common_op(module& m, const operation& op, std::vector<instruction_ref> inputs);
 
 } // namespace MIGRAPHX_INLINE_NS

src/include/migraphx/compile_src.hpp

@@ -41,7 +41,7 @@ struct src_file
     std::size_t len() const { return content.second - content.first; }
 };
 
-struct src_compiler
+struct MIGRAPHX_EXPORT src_compiler
 {
     std::string compiler                      = "c++";
     std::string flags                         = "";

src/include/migraphx/concat_opt.hpp

@@ -56,7 +56,7 @@ struct concat_optimization
 #ifdef TYPE_ERASED_DECLARATION
 
 // Type-erased interface for:
-struct concat_optimization
+struct MIGRAPHX_EXPORT concat_optimization
 {
     //
     std::string name() const;

src/include/migraphx/config.hpp

@@ -24,6 +24,8 @@
 #ifndef MIGRAPHX_GUARD_CONFIG_HPP
 #define MIGRAPHX_GUARD_CONFIG_HPP
 
+#include <migraphx/export.h>
+
 #if !defined(MIGRAPHX_USE_CLANG_TIDY) && !defined(DOXYGEN)
 
 #ifdef BUILD_DEV

src/include/migraphx/context.hpp

@@ -80,7 +80,7 @@ void finish_on_context(T&, any_ptr)
 #ifdef TYPE_ERASED_DECLARATION
 
 // Type-erased interface for:
-struct context
+struct MIGRAPHX_EXPORT context
 {
     // (optional)
     value to_value() const;

src/include/migraphx/convert_to_json.hpp

@@ -30,7 +30,7 @@
 namespace migraphx {
 inline namespace MIGRAPHX_INLINE_NS {
 
-std::string convert_to_json(const std::string& str);
+MIGRAPHX_EXPORT std::string convert_to_json(const std::string& str);
 
 } // namespace MIGRAPHX_INLINE_NS
 } // namespace migraphx

src/include/migraphx/cpp_generator.hpp

@@ -40,7 +40,7 @@ struct shape;
 
 struct cpp_generator_impl;
 
-struct cpp_generator
+struct MIGRAPHX_EXPORT cpp_generator
 {
     using generate_module_callback = std::function<std::string(
         instruction_ref, const std::unordered_map<instruction_ref, std::string>&)>;
@@ -50,7 +50,7 @@ struct cpp_generator
         std::string type;
     };
 
-    struct function
+    struct MIGRAPHX_EXPORT function
     {
         std::vector<param> params           = {};
         std::string body                    = "";

src/include/migraphx/dead_code_elimination.hpp

@@ -37,7 +37,7 @@ struct program;
 /**
  * Remove instructions where the output is not used.
  */
-struct dead_code_elimination
+struct MIGRAPHX_EXPORT dead_code_elimination
 {
     std::string name() const { return "dead_code_elimination"; }
     void apply(module& m) const;

src/include/migraphx/dom_info.hpp

@@ -34,15 +34,15 @@ inline namespace MIGRAPHX_INLINE_NS {
 
 struct module;
 
-struct dominator_info
+struct MIGRAPHX_EXPORT dominator_info
 {
     bool strictly_dominate(instruction_ref ins1, instruction_ref ins2);
 
     std::unordered_map<instruction_ref, instruction_ref> ins2idom;
 };
 
-dominator_info compute_dominator(module& m);
-// dominator_info compute_dominator_naive(const module& m);
+MIGRAPHX_EXPORT dominator_info compute_dominator(module& m);
+// MIGRAPHX_EXPORT dominator_info compute_dominator_naive(const module& m);
 
 } // namespace MIGRAPHX_INLINE_NS
 } // namespace migraphx

src/include/migraphx/dynamic_loader.hpp

@@ -35,7 +35,7 @@ inline namespace MIGRAPHX_INLINE_NS {
 
 struct dynamic_loader_impl;
 
-struct dynamic_loader
+struct MIGRAPHX_EXPORT dynamic_loader
 {
     template <class T>
     static fs::path path(T* address)

src/include/migraphx/eliminate_allocation.hpp

@@ -37,7 +37,7 @@ struct module;
  * Remove memory allocations. This will create a parameter which is the max of all memory used in
  * the program.
  */
-struct eliminate_allocation
+struct MIGRAPHX_EXPORT eliminate_allocation
 {
     std::string allocation_op{};
     std::size_t alignment = 32;

src/include/migraphx/eliminate_common_subexpression.hpp

@@ -36,7 +36,7 @@ struct module;
 /**
  * Remove identical instructions.
  */
-struct eliminate_common_subexpression
+struct MIGRAPHX_EXPORT eliminate_common_subexpression
 {
     std::string name() const { return "eliminate_common_subexpression"; }
     void apply(module& m) const;