tests/unit/ust-elf/ust-elf.c

   1 /*
   2  * Copyright (C) 2015  Antoine Busque <abusque@efficios.com>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
  17  */
  18
  19 #include <limits.h>
  20 #include <stdint.h>
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24
  25 #include <lttng/ust-elf.h>
  26 #include "tap.h"
  27
  28 #define NUM_ARCH 4
  29 #define NUM_TESTS_PER_ARCH 11
  30 #define NUM_TESTS_PIC 3
  31 #define NUM_TESTS (NUM_ARCH * NUM_TESTS_PER_ARCH) + NUM_TESTS_PIC + 1
  32
  33 /*
  34  * Expected memsz were computed using libelf, build ID and debug link
  35  * were determined through readelf.
  36  */
  37 #define X86_MEMSZ 5732
  38 #define X86_64_MEMSZ 2099376
  39 #define ARMEB_MEMSZ 34196
  40 #define AARCH64_BE_MEMSZ 67632
  41
  42 #define X86_CRC 0x1531f73c
  43 #define X86_64_CRC 0xa048a98f
  44 #define ARMEB_CRC 0x9d40261b
  45 #define AARCH64_BE_CRC 0x2b8cedce
  46
  47 #define BUILD_ID_LEN 20
  48 #define DBG_FILE "main.elf.debug"
  49
  50 static const uint8_t x86_build_id[BUILD_ID_LEN] = {
  51         0x27, 0x79, 0x2a, 0xe7, 0xaa, 0xef, 0x72, 0x5c, 0x9c, 0x52,
  52         0x80, 0xec, 0x1e, 0x18, 0xd8, 0x09, 0x02, 0xba, 0xbc, 0x82
  53 };
  54 static const uint8_t x86_64_build_id[BUILD_ID_LEN] = {
  55         0x0f, 0x87, 0xb2, 0xe2, 0x24, 0x9c, 0xe1, 0xc2, 0x24, 0xb1,
  56         0xf8, 0xb6, 0x65, 0x83, 0xa3, 0xc1, 0xcb, 0x30, 0x5c, 0x63
  57 };
  58 static const uint8_t armeb_build_id[BUILD_ID_LEN] = {
  59         0x60, 0x5d, 0x26, 0xa0, 0x0e, 0x30, 0xa4, 0x29, 0xf4, 0xf1,
  60         0x85, 0x53, 0xda, 0x90, 0x68, 0xe1, 0xf5, 0x67, 0xbe, 0x42
  61 };
  62 static const uint8_t aarch64_be_build_id[BUILD_ID_LEN] = {
  63         0xb9, 0x0a, 0xa0, 0xed, 0xd1, 0x41, 0x42, 0xc3, 0x34, 0x85,
  64         0xfa, 0x27, 0x2e, 0xa9, 0x2f, 0xd2, 0xe4, 0xf7, 0xb6, 0x60
  65 };
  66
  67 static
  68 void test_elf(const char *test_dir, const char *arch, uint64_t exp_memsz,
  69                 const uint8_t *exp_build_id, uint32_t exp_crc)
  70 {
  71         char path[PATH_MAX];
  72         struct lttng_ust_elf *elf = NULL;
  73         int ret = 0;
  74         uint64_t memsz = 0;
  75         int has_build_id = 0;
  76         uint8_t *build_id = NULL;
  77         size_t build_id_len = 0;
  78         int has_debug_link = 0;
  79         char *dbg_file = NULL;
  80         uint32_t crc = 0;
  81
  82         diag("Testing %s support", arch);
  83
  84         snprintf(path, PATH_MAX, "%s/data/%s/main.elf", test_dir, arch);
  85         elf = lttng_ust_elf_create(path);
  86         ok(elf != NULL, "lttng_ust_elf_create");
  87
  88         ret = lttng_ust_elf_get_memsz(elf, &memsz);
  89         ok(ret == 0, "lttng_ust_elf_get_memsz returned successfully");
  90         ok(memsz == exp_memsz,
  91                 "memsz - expected: %lu, got: %lu",
  92                 exp_memsz, memsz);
  93
  94         ret = lttng_ust_elf_get_build_id(elf, &build_id, &build_id_len,
  95                                         &has_build_id);
  96         ok(ret == 0, "lttng_ust_elf_get_build_id returned successfully");
  97         ok(has_build_id == 1, "build id marked as found");
  98         ok(build_id_len == BUILD_ID_LEN,
  99                 "build_id_len - expected: %u, got: %u",
 100                 BUILD_ID_LEN, build_id_len);
 101         ok(memcmp(build_id, exp_build_id, build_id_len) == 0,
 102                 "build_id has expected value");
 103
 104         ret = lttng_ust_elf_get_debug_link(elf, &dbg_file, &crc,
 105                                         &has_debug_link);
 106         ok(ret == 0, "lttng_ust_elf_get_debug_link returned successfully");
 107         ok(has_debug_link == 1, "debug link marked as found");
 108         ok(dbg_file && strcmp(dbg_file, DBG_FILE) == 0,
 109                 "debug link filename - expected: %s, got: %s",
 110                 DBG_FILE, dbg_file);
 111         ok(crc == exp_crc,
 112                 "debug link crc - expected: %#x, got: %#x",
 113                 exp_crc, crc);
 114
 115         free(build_id);
 116         free(dbg_file);
 117         lttng_ust_elf_destroy(elf);
 118 }
 119
 120 static
 121 void test_pic(const char *test_dir)
 122 {
 123         char exec_path[PATH_MAX];
 124         char pie_path[PATH_MAX];
 125         char pic_path[PATH_MAX];
 126         struct lttng_ust_elf *elf = NULL;
 127         uint8_t is_pic;
 128
 129         snprintf(exec_path, PATH_MAX, "%s/data/pic/hello.exec", test_dir);
 130         snprintf(pie_path, PATH_MAX, "%s/data/pic/hello.pie", test_dir);
 131         snprintf(pic_path, PATH_MAX, "%s/data/pic/hello.pic", test_dir);
 132
 133         elf = lttng_ust_elf_create(exec_path);
 134         is_pic = lttng_ust_elf_is_pic(elf);
 135         ok(is_pic == 0, "hello.exec is not PIC");
 136         lttng_ust_elf_destroy(elf);
 137
 138         elf = lttng_ust_elf_create(pie_path);
 139         is_pic = lttng_ust_elf_is_pic(elf);
 140         ok(is_pic == 1, "hello.pie is PIC");
 141         lttng_ust_elf_destroy(elf);
 142
 143         elf = lttng_ust_elf_create(pic_path);
 144         is_pic = lttng_ust_elf_is_pic(elf);
 145         ok(is_pic == 1, "hello.pic is PIC");
 146         lttng_ust_elf_destroy(elf);
 147 }
 148
 149 int main(int argc, char **argv)
 150 {
 151         const char *test_dir;
 152
 153         plan_tests(NUM_TESTS);
 154
 155         ok(argc == 2, "Invoke as: %s <path>", argv[0]);
 156         if (argc != 2) {
 157                 return EXIT_FAILURE;
 158         } else {
 159                 test_dir = argv[1];
 160         }
 161
 162         test_elf(test_dir, "x86", X86_MEMSZ, x86_build_id, X86_CRC);
 163         test_elf(test_dir, "x86_64", X86_64_MEMSZ, x86_64_build_id, X86_64_CRC);
 164         test_elf(test_dir, "armeb", ARMEB_MEMSZ, armeb_build_id, ARMEB_CRC);
 165         test_elf(test_dir, "aarch64_be", AARCH64_BE_MEMSZ, aarch64_be_build_id,
 166                 AARCH64_BE_CRC);
 167         test_pic(test_dir);
 168
 169         return exit_status();
 170 }