SWDEV-222423 - Add HIP Sample 2_Cookbook/15_static_library

HIP supports emitting two types of static libraries. One type
will export host functions and is compatible with host linkers.
The second type exports device functions, but is generated with
ar manually. Also, add a README with steps on how to run these
samples with Makefile or CMake.

Change-Id: I1be15c2884583b370092bc8e4bf04f726f8f5a27

samples/2_Cookbook/15_static_library/host_functions/CMakeLists.txt

@@ -0,0 +1,39 @@
+project(static_lib)
+
+cmake_minimum_required(VERSION 3.10)
+
+# Search for rocm in common locations
+list(APPEND CMAKE_PREFIX_PATH /opt/rocm/hip /opt/rocm)
+
+# Find hip
+find_package(hip REQUIRED)
+
+# Set compiler and linker
+set(CMAKE_CXX_COMPILER ${HIP_HIPCC_EXECUTABLE})
+set(CMAKE_CXX_LINKER   ${HIP_HIPCC_EXECUTABLE})
+set(CMAKE_AR           ${HIP_HIPCC_EXECUTABLE})
+set(CMAKE_BUILD_TYPE Release)
+
+# Turn static library generation ON
+option(BUILD_SHARED_LIBS "Build as a shared library" OFF)
+
+set(CPP_SOURCES hipOptLibrary.cpp)
+
+# Generate static lib libHipOptLibrary.a.
+add_library(HipOptLibrary STATIC ${CPP_SOURCES})
+
+# Set-up the correct flags to generate the static library.
+target_link_libraries(HipOptLibrary PRIVATE --emit-static-lib)
+target_include_directories(HipOptLibrary PRIVATE /opt/rocm/hsa/include)
+get_property(link_libraries TARGET HipOptLibrary PROPERTY LINK_LIBRARIES)
+string (REPLACE ";" " " LINK_PROPS "${link_libraries}")
+set(CMAKE_CXX_ARCHIVE_CREATE "<CMAKE_AR> -o <TARGET> ${LINK_PROPS} <LINK_FLAGS> <OBJECTS>")
+
+# Create test executable that uses libHipOptLibrary.a
+set(TEST_SOURCES ${CMAKE_SOURCE_DIR}/hipMain1.cpp)
+
+add_executable(test_opt_static ${TEST_SOURCES})
+add_dependencies(test_opt_static HipOptLibrary)
+target_link_libraries(test_opt_static PRIVATE -lHipOptLibrary -L${CMAKE_BINARY_DIR})
+target_link_libraries(test_opt_static PRIVATE amdhip64 amd_comgr hsa-runtime64::hsa-runtime64)
+

samples/2_Cookbook/15_static_library/host_functions/Makefile

@@ -0,0 +1,38 @@
+HIP_PATH?= $(wildcard /opt/rocm/hip)
+ifeq (,$(HIP_PATH))
+	HIP_PATH=../../..
+endif
+
+HIPCC=$(HIP_PATH)/bin/hipcc
+GXX=g++
+
+EMIT_STATIC_LIB_SRC=hipOptLibrary.cpp
+EMIT_STATIC_LIB=./libHipOptLibrary.a
+EMIT_STATIC_MAIN_SRC=hipMain1.cpp
+HIPCC_EXE=./test_emit_static_hipcc_linker.out
+HOST_EXE=./test_emit_static_host_linker.out
+
+.PHONY: test
+
+all: $(HIPCC_EXE) $(HOST_EXE) test
+
+$(EMIT_STATIC_LIB):
+	$(HIPCC) $(EMIT_STATIC_LIB_SRC) --emit-static-lib -fPIC -o $@
+
+# Compiles hipMain1 with hipcc and links with libHipOptLibrary.a which contains host function.
+$(HIPCC_EXE): $(EMIT_STATIC_LIB)
+	$(HIPCC) $(EMIT_STATIC_MAIN_SRC) -L. -lHipOptLibrary -o $@
+
+# Compiles hipMain1 with g++ and links with libHipOptLibrary.a which contains host function.
+$(HOST_EXE): $(EMIT_STATIC_LIB)
+	$(GXX) $(EMIT_STATIC_MAIN_SRC) -L. -lHipOptLibrary -L$(HIP_PATH)/lib -lamdhip64 -o $@
+
+test: $(HIPCC_EXE) $(HOST_EXE)
+	$(HIPCC_EXE)
+	$(HOST_EXE)
+
+clean:
+	rm -f $(HIPCC_EXE)
+	rm -f $(HOST_EXE)
+	rm -f $(EMIT_STATIC_LIB)
+	rm -f *.o

samples/2_Cookbook/15_static_library/host_functions/hipMain1.cpp

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2020-present 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.
+ * */
+
+extern void run_test1();
+
+int main(){
+  // Run test that generates static lib with -emit-static-lib
+  run_test1();
+}

samples/2_Cookbook/15_static_library/host_functions/hipOptLibrary.cpp

@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2020-present 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.
+ * */
+
+#include <hip/hip_runtime.h>
+#include <hip/hip_runtime_api.h>
+#include <iostream>
+
+#define HIP_ASSERT(status) assert(status == hipSuccess)
+#define LEN 512
+
+__global__ void copy(uint32_t* A, uint32_t* B) {
+    size_t tid = threadIdx.x + blockIdx.x * blockDim.x;
+    B[tid] = A[tid];
+}
+
+void run_test1() {
+    uint32_t *A_h, *B_h, *A_d, *B_d;
+    size_t valbytes = LEN * sizeof(uint32_t);
+
+    A_h = (uint32_t*)malloc(valbytes);
+    B_h = (uint32_t*)malloc(valbytes);
+    for (uint32_t i = 0; i < LEN; i++) {
+        A_h[i] = i;
+        B_h[i] = 0;
+    }
+
+    HIP_ASSERT(hipMalloc((void**)&A_d, valbytes));
+    HIP_ASSERT(hipMalloc((void**)&B_d, valbytes));
+
+    HIP_ASSERT(hipMemcpy(A_d, A_h, valbytes, hipMemcpyHostToDevice));
+    hipLaunchKernelGGL(copy, dim3(LEN/64), dim3(64), 0, 0, A_d, B_d);
+    HIP_ASSERT(hipMemcpy(B_h, B_d, valbytes, hipMemcpyDeviceToHost));
+
+    for (uint32_t i = 0; i < LEN; i++) {
+        assert(A_h[i] == B_h[i]);
+    }
+
+    HIP_ASSERT(hipFree(A_d));
+    HIP_ASSERT(hipFree(B_d));
+    free(A_h);
+    free(B_h);
+    std::cout << "Test Passed!\n";
+}