1 /*
2 * Copyright (c) 2016 GitHub, Inc.
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 #include <iostream>
17 #include <string>
18
19 #include "catch.hpp"
20 #include "usdt.h"
21
22 using std::experimental::optional;
23 using std::experimental::nullopt;
24
verify_register(USDT::ArgumentParser & parser,int arg_size,long long constant)25 static void verify_register(USDT::ArgumentParser &parser, int arg_size,
26 long long constant) {
27 USDT::Argument arg;
28 REQUIRE(parser.parse(&arg));
29 REQUIRE(arg.arg_size() == arg_size);
30
31 REQUIRE(arg.constant());
32 REQUIRE(arg.constant() == constant);
33 }
34
verify_register(USDT::ArgumentParser & parser,int arg_size,const std::string & regname,optional<int> deref_offset=nullopt,optional<std::string> deref_ident=nullopt,optional<std::string> index_regname=nullopt,optional<int> scale=nullopt)35 static void verify_register(USDT::ArgumentParser &parser, int arg_size,
36 const std::string ®name,
37 optional<int> deref_offset = nullopt,
38 optional<std::string> deref_ident = nullopt,
39 optional<std::string> index_regname = nullopt,
40 optional<int> scale = nullopt) {
41 USDT::Argument arg;
42 REQUIRE(parser.parse(&arg));
43 REQUIRE(arg.arg_size() == arg_size);
44
45 REQUIRE(arg.base_register_name());
46 REQUIRE(arg.base_register_name() == regname);
47
48 REQUIRE(arg.deref_offset() == deref_offset);
49 REQUIRE(arg.deref_ident() == deref_ident);
50
51 REQUIRE(arg.index_register_name() == index_regname);
52 REQUIRE(arg.scale() == scale);
53 }
54
55 /* supported arches only */
56 #if defined(__aarch64__) || defined(__loongarch64) || \
57 defined(__powerpc64__) || defined(__s390x__) || \
58 defined(__x86_64__)
59
60 TEST_CASE("test usdt argument parsing", "[usdt]") {
61 SECTION("parse failure") {
62 #ifdef __aarch64__
63 USDT::ArgumentParser_aarch64 parser("4@[x32,200]");
64 #elif __loongarch64
65 USDT::ArgumentParser_loongarch64 parser("4@[$r32,200]");
66 #elif __powerpc64__
67 USDT::ArgumentParser_powerpc64 parser("4@-12(42)");
68 #elif __s390x__
69 USDT::ArgumentParser_s390x parser("4@-12(%r42)");
70 #elif defined(__x86_64__)
71 USDT::ArgumentParser_x64 parser("4@i%ra+1r");
72 #endif
73 USDT::Argument arg;
74 REQUIRE(!parser.parse(&arg));
75 int i;
76 for (i = 0; i < 10 && !parser.done(); ++i) {
77 parser.parse(&arg);
78 }
79 // Make sure we reach termination
80 REQUIRE(i < 10);
81 }
82 SECTION("argument examples from the Python implementation") {
83 #ifdef __aarch64__
84 USDT::ArgumentParser_aarch64 parser(
85 "-1@x0 4@5 8@[x12] -4@[x30,-40] -4@[x31,-40] 8@[sp, 120]");
86 verify_register(parser, -1, "regs[0]");
87 verify_register(parser, 4, 5);
88 verify_register(parser, 8, "regs[12]", 0);
89 verify_register(parser, -4, "regs[30]", -40);
90 verify_register(parser, -4, "sp", -40);
91 verify_register(parser, 8, "sp", 120);
92 #elif __loongarch64
93 USDT::ArgumentParser_loongarch64 parser(
94 "-1@$r0 4@5 8@[$r12] -4@[$r30,-40] -4@[$r3,-40] 8@[sp, 120]");
95 verify_register(parser, -1, "regs[0]");
96 verify_register(parser, 4, 5);
97 verify_register(parser, 8, "regs[12]", 0);
98 verify_register(parser, -4, "regs[30]", -40);
99 verify_register(parser, -4, "sp", -40);
100 verify_register(parser, 8, "sp", 120);
101 #elif __powerpc64__
102 USDT::ArgumentParser_powerpc64 parser(
103 "-4@0 8@%r0 8@i0 4@0(%r0) -2@0(0) "
104 "1@0 -2@%r3 -8@i9 -1@0(%r4) -4@16(6) "
105 "2@7 4@%r11 4@i-67 8@-16(%r17) 1@-52(11) "
106 "-8@13 -8@%r25 2@i-11 -2@14(%r26) -8@-32(24) "
107 "4@29 2@%r17 -8@i-693 -1@-23(%r31) 4@28(30) "
108 "-2@31 -4@%r30 2@i1097 4@108(%r30) -2@-4(31)");
109
110 verify_register(parser, -4, "gpr[0]");
111 verify_register(parser, 8, "gpr[0]");
112 verify_register(parser, 8, 0);
113 verify_register(parser, 4, "gpr[0]", 0);
114 verify_register(parser, -2, "gpr[0]", 0);
115
116 verify_register(parser, 1, "gpr[0]");
117 verify_register(parser, -2, "gpr[3]");
118 verify_register(parser, -8, 9);
119 verify_register(parser, -1, "gpr[4]", 0);
120 verify_register(parser, -4, "gpr[6]", 16);
121
122 verify_register(parser, 2, "gpr[7]");
123 verify_register(parser, 4, "gpr[11]");
124 verify_register(parser, 4, -67);
125 verify_register(parser, 8, "gpr[17]", -16);
126 verify_register(parser, 1, "gpr[11]", -52);
127
128 verify_register(parser, -8, "gpr[13]");
129 verify_register(parser, -8, "gpr[25]");
130 verify_register(parser, 2, -11);
131 verify_register(parser, -2, "gpr[26]", 14);
132 verify_register(parser, -8, "gpr[24]", -32);
133
134 verify_register(parser, 4, "gpr[29]");
135 verify_register(parser, 2, "gpr[17]");
136 verify_register(parser, -8, -693);
137 verify_register(parser, -1, "gpr[31]", -23);
138 verify_register(parser, 4, "gpr[30]", 28);
139
140 verify_register(parser, -2, "gpr[31]");
141 verify_register(parser, -4, "gpr[30]");
142 verify_register(parser, 2, 1097);
143 verify_register(parser, 4, "gpr[30]", 108);
144 verify_register(parser, -2, "gpr[31]", -4);
145 #elif __s390x__
146 USDT::ArgumentParser_s390x parser(
147 "-4@%r0 8@%r0 8@0 4@0(%r0) -2@0(%r0) "
148 "1@%r0 -2@%r3 -8@9 -1@0(%r4) -4@16(%r6) "
149 "2@%r7 4@%r11 4@-67 8@-16(%r15) 1@-52(%r11) "
150 "-8@%r4 -8@%r14 2@-11 -2@14(%r13) -8@-32(%r12) "
151 "4@%r5 2@%r11 -8@-693 -1@-23(%r10) 4@28(%r9) "
152 "-2@%r3 -4@%r8 2@1097 4@108(%r7) -2@-4(%r6)");
153
154 verify_register(parser, -4, "gprs[0]");
155 verify_register(parser, 8, "gprs[0]");
156 verify_register(parser, 8, 0);
157 verify_register(parser, 4, "gprs[0]", 0);
158 verify_register(parser, -2, "gprs[0]", 0);
159
160 verify_register(parser, 1, "gprs[0]");
161 verify_register(parser, -2, "gprs[3]");
162 verify_register(parser, -8, 9);
163 verify_register(parser, -1, "gprs[4]", 0);
164 verify_register(parser, -4, "gprs[6]", 16);
165
166 verify_register(parser, 2, "gprs[7]");
167 verify_register(parser, 4, "gprs[11]");
168 verify_register(parser, 4, -67);
169 verify_register(parser, 8, "gprs[15]", -16);
170 verify_register(parser, 1, "gprs[11]", -52);
171
172 verify_register(parser, -8, "gprs[4]");
173 verify_register(parser, -8, "gprs[14]");
174 verify_register(parser, 2, -11);
175 verify_register(parser, -2, "gprs[13]", 14);
176 verify_register(parser, -8, "gprs[12]", -32);
177
178 verify_register(parser, 4, "gprs[5]");
179 verify_register(parser, 2, "gprs[11]");
180 verify_register(parser, -8, -693);
181 verify_register(parser, -1, "gprs[10]", -23);
182 verify_register(parser, 4, "gprs[9]", 28);
183
184 verify_register(parser, -2, "gprs[3]");
185 verify_register(parser, -4, "gprs[8]");
186 verify_register(parser, 2, 1097);
187 verify_register(parser, 4, "gprs[7]", 108);
188 verify_register(parser, -2, "gprs[6]", -4);
189 #elif defined(__x86_64__)
190 USDT::ArgumentParser_x64 parser(
191 "-4@$0 8@$1234 %rdi %rax %rsi "
192 "8@$9223372036854775806 8@$18446744073709551614 "
193 "-8@$-1 "
194 "-8@%rbx 4@%r12 8@-8(%rbp) 4@(%rax) "
195 "-4@global_max_action(%rip) "
196 "8@24+mp_(%rip) "
197 "-4@CheckpointStats+40(%rip) "
198 "4@glob-2(%rip) "
199 "8@(%rax,%rdx,8) "
200 "4@(%rbx,%rcx)");
201
202 verify_register(parser, -4, 0);
203 verify_register(parser, 8, 1234);
204
205 verify_register(parser, 8, "di");
206 verify_register(parser, 8, "ax");
207 verify_register(parser, 8, "si");
208 verify_register(parser, 8, 9223372036854775806ll);
209 verify_register(parser, 8, (long long)18446744073709551614ull);
210 verify_register(parser, -8, -1);
211 verify_register(parser, -8, "bx");
212 verify_register(parser, 4, "r12");
213
214 verify_register(parser, 8, "bp", -8);
215 verify_register(parser, 4, "ax", 0);
216
217 verify_register(parser, -4, "ip", 0, std::string("global_max_action"));
218 verify_register(parser, 8, "ip", 24, std::string("mp_"));
219 verify_register(parser, -4, "ip", 40, std::string("CheckpointStats"));
220 verify_register(parser, 4, "ip", -2, std::string("glob"));
221
222 verify_register(parser, 8, "ax", 0, nullopt, std::string("dx"), 8);
223 verify_register(parser, 4, "bx", 0, nullopt, std::string("cx"));
224 #endif
225
226 REQUIRE(parser.done());
227 }
228 }
229
230 #endif /* supported arches only */
231