1 /*
2 * Copyright (C) 2020 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 #include <gtest/gtest.h>
18
19 #include <stdio.h>
20
21 #if defined(__BIONIC__)
22 #include "bionic/pthread_internal.h"
23
24 // Ensure that the layout of these data structures is architecture independent and only depends on
25 // the bitness of the architecture.
26 template <typename CheckSize, typename CheckOffset>
tests(CheckSize check_size,CheckOffset check_offset)27 void tests(CheckSize check_size, CheckOffset check_offset) {
28 #define CHECK_SIZE(name, size) \
29 check_size(#name, sizeof(name), size);
30 #define CHECK_OFFSET(name, field, offset) \
31 check_offset(#name, #field, offsetof(name, field), offset);
32 #ifdef __LP64__
33 CHECK_SIZE(pthread_internal_t, 824);
34 CHECK_OFFSET(pthread_internal_t, next, 0);
35 CHECK_OFFSET(pthread_internal_t, prev, 8);
36 CHECK_OFFSET(pthread_internal_t, tid, 16);
37 CHECK_OFFSET(pthread_internal_t, attr, 24);
38 CHECK_OFFSET(pthread_internal_t, join_state, 80);
39 CHECK_OFFSET(pthread_internal_t, cleanup_stack, 88);
40 CHECK_OFFSET(pthread_internal_t, start_routine, 96);
41 CHECK_OFFSET(pthread_internal_t, start_routine_arg, 104);
42 CHECK_OFFSET(pthread_internal_t, return_value, 112);
43 CHECK_OFFSET(pthread_internal_t, start_mask, 120);
44 CHECK_OFFSET(pthread_internal_t, alternate_signal_stack, 128);
45 CHECK_OFFSET(pthread_internal_t, shadow_call_stack_guard_region, 136);
46 CHECK_OFFSET(pthread_internal_t, stack_top, 144);
47 CHECK_OFFSET(pthread_internal_t, startup_handshake_lock, 156);
48 CHECK_OFFSET(pthread_internal_t, mmap_base, 168);
49 CHECK_OFFSET(pthread_internal_t, mmap_size, 176);
50 CHECK_OFFSET(pthread_internal_t, mmap_base_unguarded, 184);
51 CHECK_OFFSET(pthread_internal_t, mmap_size_unguarded, 192);
52 CHECK_OFFSET(pthread_internal_t, vma_name_buffer, 200);
53 CHECK_OFFSET(pthread_internal_t, thread_local_dtors, 232);
54 CHECK_OFFSET(pthread_internal_t, current_dlerror, 240);
55 CHECK_OFFSET(pthread_internal_t, dlerror_buffer, 248);
56 CHECK_OFFSET(pthread_internal_t, bionic_tls, 760);
57 CHECK_OFFSET(pthread_internal_t, errno_value, 768);
58 CHECK_OFFSET(pthread_internal_t, bionic_tcb, 776);
59 CHECK_OFFSET(pthread_internal_t, stack_mte_ringbuffer_vma_name_buffer, 784);
60 CHECK_OFFSET(pthread_internal_t, should_allocate_stack_mte_ringbuffer, 816);
61 CHECK_SIZE(bionic_tls, 12200);
62 CHECK_OFFSET(bionic_tls, key_data, 0);
63 CHECK_OFFSET(bionic_tls, locale, 2080);
64 CHECK_OFFSET(bionic_tls, basename_buf, 2088);
65 CHECK_OFFSET(bionic_tls, dirname_buf, 6184);
66 CHECK_OFFSET(bionic_tls, mntent_buf, 10280);
67 CHECK_OFFSET(bionic_tls, mntent_strings, 10320);
68 CHECK_OFFSET(bionic_tls, ptsname_buf, 11344);
69 CHECK_OFFSET(bionic_tls, ttyname_buf, 11376);
70 CHECK_OFFSET(bionic_tls, strerror_buf, 11440);
71 CHECK_OFFSET(bionic_tls, strsignal_buf, 11695);
72 CHECK_OFFSET(bionic_tls, group, 11952);
73 CHECK_OFFSET(bionic_tls, passwd, 12040);
74 CHECK_OFFSET(bionic_tls, fdtrack_disabled, 12192);
75 CHECK_OFFSET(bionic_tls, bionic_systrace_disabled, 12193);
76 CHECK_OFFSET(bionic_tls, padding, 12194);
77 #else
78 CHECK_SIZE(pthread_internal_t, 708);
79 CHECK_OFFSET(pthread_internal_t, next, 0);
80 CHECK_OFFSET(pthread_internal_t, prev, 4);
81 CHECK_OFFSET(pthread_internal_t, tid, 8);
82 CHECK_OFFSET(pthread_internal_t, attr, 16);
83 CHECK_OFFSET(pthread_internal_t, join_state, 40);
84 CHECK_OFFSET(pthread_internal_t, cleanup_stack, 44);
85 CHECK_OFFSET(pthread_internal_t, start_routine, 48);
86 CHECK_OFFSET(pthread_internal_t, start_routine_arg, 52);
87 CHECK_OFFSET(pthread_internal_t, return_value, 56);
88 CHECK_OFFSET(pthread_internal_t, start_mask, 60);
89 CHECK_OFFSET(pthread_internal_t, alternate_signal_stack, 68);
90 CHECK_OFFSET(pthread_internal_t, shadow_call_stack_guard_region, 72);
91 CHECK_OFFSET(pthread_internal_t, stack_top, 76);
92 CHECK_OFFSET(pthread_internal_t, startup_handshake_lock, 84);
93 CHECK_OFFSET(pthread_internal_t, mmap_base, 92);
94 CHECK_OFFSET(pthread_internal_t, mmap_size, 96);
95 CHECK_OFFSET(pthread_internal_t, mmap_base_unguarded, 100);
96 CHECK_OFFSET(pthread_internal_t, mmap_size_unguarded, 104);
97 CHECK_OFFSET(pthread_internal_t, vma_name_buffer, 108);
98 CHECK_OFFSET(pthread_internal_t, thread_local_dtors, 140);
99 CHECK_OFFSET(pthread_internal_t, current_dlerror, 144);
100 CHECK_OFFSET(pthread_internal_t, dlerror_buffer, 148);
101 CHECK_OFFSET(pthread_internal_t, bionic_tls, 660);
102 CHECK_OFFSET(pthread_internal_t, errno_value, 664);
103 CHECK_OFFSET(pthread_internal_t, bionic_tcb, 668);
104 CHECK_OFFSET(pthread_internal_t, stack_mte_ringbuffer_vma_name_buffer, 672);
105 CHECK_OFFSET(pthread_internal_t, should_allocate_stack_mte_ringbuffer, 704);
106 CHECK_SIZE(bionic_tls, 11080);
107 CHECK_OFFSET(bionic_tls, key_data, 0);
108 CHECK_OFFSET(bionic_tls, locale, 1040);
109 CHECK_OFFSET(bionic_tls, basename_buf, 1044);
110 CHECK_OFFSET(bionic_tls, dirname_buf, 5140);
111 CHECK_OFFSET(bionic_tls, mntent_buf, 9236);
112 CHECK_OFFSET(bionic_tls, mntent_strings, 9260);
113 CHECK_OFFSET(bionic_tls, ptsname_buf, 10284);
114 CHECK_OFFSET(bionic_tls, ttyname_buf, 10316);
115 CHECK_OFFSET(bionic_tls, strerror_buf, 10380);
116 CHECK_OFFSET(bionic_tls, strsignal_buf, 10635);
117 CHECK_OFFSET(bionic_tls, group, 10892);
118 CHECK_OFFSET(bionic_tls, passwd, 10952);
119 CHECK_OFFSET(bionic_tls, fdtrack_disabled, 11076);
120 CHECK_OFFSET(bionic_tls, bionic_systrace_disabled, 11077);
121 CHECK_OFFSET(bionic_tls, padding, 11078);
122 #endif // __LP64__
123 #undef CHECK_SIZE
124 #undef CHECK_OFFSET
125 }
126 #endif // defined(__BIONIC__)
127
TEST(struct_layout,sizes_offsets)128 TEST(struct_layout, sizes_offsets) {
129 #if defined(__BIONIC__)
130 bool failed = false;
131
132 auto check_size = [&](const char* name, size_t size, size_t expected_size) {
133 EXPECT_EQ(expected_size, size) << "sizeof(" << name << ")";
134 if (size != expected_size) {
135 failed = true;
136 }
137 };
138 auto check_offset = [&](const char* name, const char* field, size_t offset,
139 size_t expected_offset) {
140 EXPECT_EQ(expected_offset, offset) << "offsetof(" << name << ", " << field << ")";
141 if (offset != expected_offset) {
142 failed = true;
143 }
144 };
145 tests(check_size, check_offset);
146
147 if (failed) {
148 printf(
149 "Please update the tests function in bionic/tests/struct_layout_test.cpp with the "
150 "following contents:\n");
151
152 auto print_size = [&](const char* name, size_t size, size_t expected_size) {
153 (void)expected_size;
154 printf(" CHECK_SIZE(%s, %zu);\n", name, size);
155 };
156 auto print_offset = [&](const char* name, const char* field, size_t offset,
157 size_t expected_offset) {
158 (void)expected_offset;
159 printf(" CHECK_OFFSET(%s, %s, %zu);\n", name, field, offset);
160 };
161 tests(print_size, print_offset);
162 }
163 #else
164 GTEST_SKIP() << "bionic-only test";
165 #endif
166 }
167