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
2021-04-23 14:14:13 +00:00
parent a3fd92ba5f
commit cfcf04d502
10 changed files with 527 additions and 0 deletions
@@ -0,0 +1,36 @@
+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_BUILD_TYPE Release)
+
+# Turn static library generation ON
+option(BUILD_SHARED_LIBS "Build as a shared library" OFF)
+
+set(CPP_SOURCES hipDevice.cpp)
+
+# Generate static lib libHipDevice.a
+add_library(HipDevice STATIC ${CPP_SOURCES})
+
+target_compile_options(HipDevice PRIVATE -fgpu-rdc)
+target_link_libraries(HipDevice PRIVATE -fgpu-rdc)
+target_include_directories(HipDevice PRIVATE /opt/rocm/hsa/include)
+
+# Create test executable that uses libHipDevice.a
+set(TEST_SOURCES ${CMAKE_SOURCE_DIR}/hipMain2.cpp)
+
+add_executable(test_device_static ${TEST_SOURCES})
+add_dependencies(test_device_static HipDevice)
+target_compile_options(test_device_static PRIVATE -fgpu-rdc)
+target_link_libraries(test_device_static PRIVATE HipDevice)
+target_link_libraries(test_device_static PRIVATE -fgpu-rdc hip::host)
+
@@ -0,0 +1,31 @@
+HIP_PATH?= $(wildcard /opt/rocm/hip)
+ifeq (,$(HIP_PATH))
+	HIP_PATH=../../..
+endif
+
+HIPCC=$(HIP_PATH)/bin/hipcc
+
+.PHONY: test
+
+all: $(RDC_EXE) test
+
+STATIC_LIB_SRC=hipDevice.cpp
+STATIC_LIB=./libHipDevice.a
+STATIC_MAIN_SRC=hipMain2.cpp
+RDC_EXE=./test_device_static.out
+
+$(STATIC_LIB):
+	$(HIPCC) $(STATIC_LIB_SRC) -c -fgpu-rdc -fPIC -o hipDevice.o
+	ar rcsD $@ hipDevice.o
+
+# Compiles hipMain2 with hipcc and links with libHipDevice.a which contains device function.
+$(RDC_EXE): $(STATIC_LIB)
+	$(HIPCC) $(STATIC_LIB) $(STATIC_MAIN_SRC) -fgpu-rdc -o $@
+
+test: $(RDC_EXE)
+	$(RDC_EXE)
+
+clean:
+	rm -f $(RDC_EXE)
+	rm -f $(STATIC_LIB)
+	rm -f *.o
@@ -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.
+ * */
+
+#include <hip/hip_runtime.h>
+
+__device__ int square_me(int A) {
+  return A*A;
+}
+
@@ -0,0 +1,69 @@
+/*
+ * 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
+
+extern __device__ int square_me(int);
+
+__global__ void square_and_save(int* A, int* B) {
+    int tid = threadIdx.x + blockIdx.x * blockDim.x;
+    B[tid] = square_me(A[tid]);
+}
+
+void run_test2() {
+    int *A_h, *B_h, *A_d, *B_d;
+    A_h = new int[LEN];
+    B_h = new int[LEN];
+    for (unsigned i = 0; i < LEN; i++) {
+        A_h[i] = i;
+        B_h[i] = 0;
+    }
+    size_t valbytes = LEN*sizeof(int);
+
+    HIP_ASSERT(hipMalloc((void**)&A_d, valbytes));
+    HIP_ASSERT(hipMalloc((void**)&B_d, valbytes));
+
+    HIP_ASSERT(hipMemcpy(A_d, A_h, valbytes, hipMemcpyHostToDevice));
+    hipLaunchKernelGGL(square_and_save, dim3(LEN/64), dim3(64),
+                       0, 0, A_d, B_d);
+    HIP_ASSERT(hipMemcpy(B_h, B_d, valbytes, hipMemcpyDeviceToHost));
+
+    for (unsigned i = 0; i < LEN; i++) {
+        assert(A_h[i]*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";
+}
+
+int main(){
+  // Run test that generates static lib with ar
+  run_test2();
+}