[comgr] Add test for multiple note sections in a code object

Pierre-vh · Pierre-vh · commit 5bd76b2c4ddb · 2024-03-27T04:13:44.000-04:00
Change-Id: I4599afcc56cb31c766784bca787df163ea003911
diff --git a/amd/comgr/docs/ReleaseNotes.md b/amd/comgr/docs/ReleaseNotes.md
@@ -152,6 +152,7 @@ where reporters provide Comgr logs.
 - Update default arch for test binaries from gfx830 to gfx900
 - Refactor nested kernel behavior into new test, as this behavior is less common
 and shouldn't be featured in the baseline tests
+- Add metadata parsing tests for code objects with multiple AMDGPU metadata note entries.
 
 New Targets
 -----------
diff --git a/amd/comgr/test/CMakeLists.txt b/amd/comgr/test/CMakeLists.txt
@@ -2,6 +2,8 @@ set(TEST_INPUT_BINARIES)
 set(TEST_INPUT_BITCODES)
 set(TEST_INPUT_BUNDLES)
 set(TEST_INPUT_ARCHIVES)
+set(TEST_INPUT_LINKED_OBJS)
+
 # Create target ${name} which depends on a clang command to compile ${input} to
 # ${output}, with any additional arguments from ${ARGN}, and add it to the
 # TEST_INPUT_BINARIES target list.
@@ -86,13 +88,40 @@ macro(add_test_archive name target input output)
   list(APPEND TEST_INPUT_ARCHIVES "${name}")
 endmacro()
 
+# Creates target ${name} which depends on 2 clang commands to compile
+# ${input0} and ${input1} and then links them to create ${output}
+#  with any additional arguments from ${ARGN}, and add it to the
+# TEST_INPUT_LINKED_OBJS target list.
+macro(add_test_input_linked name input0 input1 output)
+  add_custom_command(
+    OUTPUT "${output}"
+    COMMAND "$<TARGET_FILE:lld>" -flavor gnu ${ARGN} "${input0}"
+    "${input1}" -o "${output}"
+    VERBATIM
+    DEPENDS lld "${input0}" "${input1}")
+  add_custom_target("${name}"
+    DEPENDS "${output}"
+    SOURCES "${input0}" "${input1}")
+  list(APPEND TEST_INPUT_LINKED_OBJS "${name}")
+endmacro()
+
 add_test_input_binary(reloc1 source/reloc1.cl source/reloc1.o -c -mcode-object-version=4)
 add_test_input_binary(reloc2 source/reloc2.cl source/reloc2.o -c -mcode-object-version=4)
 add_test_input_binary(reloc-asm source/reloc-asm.s source/reloc-asm.o -c -mcode-object-version=4)
 add_test_input_binary(shared source/shared.cl source/shared.so -mcode-object-version=4)
 add_test_input_binary(shared-debug source/shared.cl source/shared-debug.so -g -mcode-object-version=4)
 add_test_input_bitcode(source1 source/source1.cl source/source1.bc)
 
+add_test_input_binary(linking-kernel0 source/linking/kernel0.cl source/linking/kernel0.o -c -mcode-object-version=4)
+add_test_input_binary(linking-kernel1 source/linking/kernel1.cl source/linking/kernel1.o -c -mcode-object-version=4)
+add_test_input_binary(linking-empty   source/linking/empty.cl   source/linking/empty.o   -c -mcode-object-version=4)
+
+add_test_input_linked(multiple-note-records source/linking/kernel0.o source/linking/kernel1.o source/multiple-note-records.out)
+add_test_input_linked(multiple-note-records-one-kernel source/linking/kernel0.o source/linking/empty.o source/multiple-note-records-one-kernel.out)
+
+configure_file("source/linking/kernel0.cl" "source/linking/kernel0.cl" COPYONLY)
+configure_file("source/linking/kernel1.cl" "source/linking/kernel1.cl" COPYONLY)
+configure_file("source/linking/empty.cl" "source/linking/empty.cl" COPYONLY)
 configure_file("source/source1.cl" "source/source1.cl" COPYONLY)
 configure_file("source/source2.cl" "source/source2.cl" COPYONLY)
 configure_file("source/nested-kernel1.cl" "source/nested-kernel1.cl" COPYONLY)
@@ -156,7 +185,7 @@ endif()
     amd_comgr)
   add_dependencies("${name}"
     ${TEST_INPUT_BINARIES};${TEST_INPUT_BITCODES};${TEST_INPUT_BUNDLES};
-    ${TEST_INPUT_ARCHIVES})
+    ${TEST_INPUT_ARCHIVES};${TEST_INPUT_LINKED_OBJS})
   add_test(NAME ${test_name}
     COMMAND "${name}")
   add_dependencies(check-comgr ${name})
@@ -178,6 +207,7 @@ add_comgr_test(disasm_options_test c)
 add_comgr_test(metadata_tp_test c)
 add_comgr_test(metadata_yaml_test c)
 add_comgr_test(metadata_msgpack_test c)
+add_comgr_test(metadata_multiple_msgpacks_test c)
 add_comgr_test(metadata_merge_test c)
 add_comgr_test(symbols_test c)
 add_comgr_test(symbols_iterate_test c)
diff --git a/amd/comgr/test/metadata_multiple_msgpacks_test.c b/amd/comgr/test/metadata_multiple_msgpacks_test.c
@@ -0,0 +1,93 @@
+
+#include "amd_comgr.h"
+#include "common.h"
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+typedef struct test_meta_data_s {
+  char *Buf;
+  amd_comgr_data_t Data;
+  amd_comgr_metadata_node_t Root;
+} test_meta_data_t;
+
+void read_metadata(test_meta_data_t *MetaData, const char *File, bool IsErr) {
+  long Size;
+  amd_comgr_status_t Status;
+  amd_comgr_metadata_kind_t Mkind = AMD_COMGR_METADATA_KIND_NULL;
+
+  // Read input file
+  char Buffer[1024];
+  snprintf(Buffer, 1024, "%s/%s", TEST_OBJ_DIR, File);
+  Size = setBuf(Buffer, &MetaData->Buf);
+
+  Status =
+      amd_comgr_create_data(AMD_COMGR_DATA_KIND_RELOCATABLE, &MetaData->Data);
+  checkError(Status, "amd_comgr_create_data");
+
+  Status = amd_comgr_set_data(MetaData->Data, Size, MetaData->Buf);
+  checkError(Status, "amd_comgr_set_data");
+
+  Status = amd_comgr_set_data_name(MetaData->Data, NULL);
+  checkError(Status, "amd_comgr_set_data_name");
+
+  // Get metadata from data object
+  printf("Get metadata from %s\n", File);
+
+  Status = amd_comgr_get_data_metadata(MetaData->Data, &MetaData->Root);
+  checkError(Status, "amd_comgr_get_data_metadata");
+
+  // the root must be map
+  Status = amd_comgr_get_metadata_kind(MetaData->Root, &Mkind);
+  checkError(Status, "amd_comgr_get_metadata_kind");
+  if (Mkind != AMD_COMGR_METADATA_KIND_MAP) {
+    printf("Root is not map\n");
+    exit(1);
+  }
+
+  // iterate code object metadata
+  int Indent = 0;
+  printf("Metadata for file %s : start\n", File);
+  Status = amd_comgr_iterate_map_metadata(MetaData->Root, printEntry,
+                                          (void *)&Indent);
+  if (Status) {
+    if (IsErr)
+      return;
+    checkError(Status, "amd_comgr_iterate_map_metadata");
+  } else if (IsErr) {
+    printf("Unexpected success from amd_comgr_iterate_map_metadata\n");
+    exit(1);
+  }
+  printf("Metadata for file %s : end\n\n", File);
+}
+
+void close_meta_data(test_meta_data_t *MetaData) {
+  amd_comgr_status_t Status;
+
+  Status = amd_comgr_destroy_metadata(MetaData->Root);
+  checkError(Status, "amd_comgr_destroy_metadata");
+
+  Status = amd_comgr_release_data(MetaData->Data);
+  checkError(Status, "amd_comgr_release_data");
+  free(MetaData->Buf);
+
+  memset(MetaData, 0, sizeof(test_meta_data_t));
+}
+
+int main(int argc, char *argv[]) {
+  test_meta_data_t MetaData;
+
+  memset(&MetaData, 0, sizeof(test_meta_data_t));
+
+#define READ_METADATA(meta, file, is_error)                                    \
+  do {                                                                         \
+    read_metadata(&meta, file, is_error);                                      \
+    close_meta_data(&meta);                                                    \
+  } while (0)
+
+  READ_METADATA(MetaData, "multiple-note-records.out", false);
+  READ_METADATA(MetaData, "multiple-note-records-one-kernel.out", false);
+
+  printf("Metadata Multiple MsgPacks tests : passed\n");
+  return 0;
+}
diff --git a/amd/comgr/test/source/linking/empty.cl b/amd/comgr/test/source/linking/empty.cl
@@ -0,0 +1,36 @@
+/*******************************************************************************
+ *
+ * University of Illinois/NCSA
+ * Open Source License
+ *
+ * Copyright (c) 2024 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
+ * with 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:
+ *
+ *     * Redistributions of source code must retain the above copyright notice,
+ *       this list of conditions and the following disclaimers.
+ *
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimers in the
+ *       documentation and/or other materials provided with the distribution.
+ *
+ *     * Neither the names of Advanced Micro Devices, Inc. nor the names of its
+ *       contributors may be used to endorse or promote products derived from
+ *       this Software without specific prior written permission.
+ *
+ * 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
+ * CONTRIBUTORS 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 WITH
+ * THE SOFTWARE.
+ *
+ *******************************************************************************/
+
+void foo() {}
diff --git a/amd/comgr/test/source/linking/kernel0.cl b/amd/comgr/test/source/linking/kernel0.cl
@@ -0,0 +1,38 @@
+/*******************************************************************************
+ *
+ * University of Illinois/NCSA
+ * Open Source License
+ *
+ * Copyright (c) 2024 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
+ * with 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:
+ *
+ *     * Redistributions of source code must retain the above copyright notice,
+ *       this list of conditions and the following disclaimers.
+ *
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimers in the
+ *       documentation and/or other materials provided with the distribution.
+ *
+ *     * Neither the names of Advanced Micro Devices, Inc. nor the names of its
+ *       contributors may be used to endorse or promote products derived from
+ *       this Software without specific prior written permission.
+ *
+ * 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
+ * CONTRIBUTORS 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 WITH
+ * THE SOFTWARE.
+ *
+ *******************************************************************************/
+
+void kernel kernel0(__global int *j) {
+  *j += 2;
+}
diff --git a/amd/comgr/test/source/linking/kernel1.cl b/amd/comgr/test/source/linking/kernel1.cl
@@ -0,0 +1,38 @@
+/*******************************************************************************
+ *
+ * University of Illinois/NCSA
+ * Open Source License
+ *
+ * Copyright (c) 2024 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
+ * with 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:
+ *
+ *     * Redistributions of source code must retain the above copyright notice,
+ *       this list of conditions and the following disclaimers.
+ *
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimers in the
+ *       documentation and/or other materials provided with the distribution.
+ *
+ *     * Neither the names of Advanced Micro Devices, Inc. nor the names of its
+ *       contributors may be used to endorse or promote products derived from
+ *       this Software without specific prior written permission.
+ *
+ * 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
+ * CONTRIBUTORS 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 WITH
+ * THE SOFTWARE.
+ *
+ *******************************************************************************/
+
+void kernel kernel1(__global int *j) {
+  *j += 2;
+}
diff --git a/amd/comgr/test/source/multiple-note-records-one-kernel.s b/amd/comgr/test/source/multiple-note-records-one-kernel.s
diff --git a/amd/comgr/test/source/multiple-note-records.s b/amd/comgr/test/source/multiple-note-records.s
