summaryrefslogtreecommitdiff
path: root/src/base/loader/exec_ecoff.test.cc
blob: f43b956dce433a52c7ab837f57bbad17c0c67115 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
/*
 * Copyright (c) 2019 The Regents of the University of California
 * All rights reserved
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Bobby R. Bruce
 */


#include <gtest/gtest.h>

#include "base/loader/exec_ecoff.h"

#define OMAGIC_STRUCT (*((const ecoff_exechdr *)omagic))
#define NMAGIC_STRUCT (*((const ecoff_exechdr *)nmagic))
#define ZMAGIC_STRUCT (*((const ecoff_exechdr *)zmagic))
#define NO_MAGIC_STRUCT (*((const ecoff_exechdr *)no_magic))

#if (defined(_BIG_ENDIAN) || !defined(_LITTLE_ENDIAN))\
    && BYTE_ORDER==BIG_ENDIAN
const uint8_t zmagic[] = {
    // ecoff_filehdr
    0x01, 0x0B, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,

    // ecoff_aouthdr
    0x01, 0x0B, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x0A, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00
};

const uint8_t nmagic[] = {
    //ecoff_filehdr
    0x01, 0x08, 0x00, 0x0F, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02,

    //ecoff_aouthdr
    0x01, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x0A, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00
};

const uint8_t omagic[] = {
    //ecoff_filehdr
    0x01, 0x07, 0x00, 0x0A, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,

    //ecoff_aouthdr
    0x01, 0x07, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00
};
#elif defined(_LITTLE_ENDIAN) || BYTE_ORDER==LITTLE_ENDIAN
const uint8_t zmagic[] = {
    // ecoff_filehdr
    0x0B, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,

    // ecoff_aouthdr
    0x0B, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x0F, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00
};

const uint8_t nmagic[] = {
    //ecoff_filehdr
    0x08, 0x01, 0x0F, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00,

    //ecoff_aouthdr
    0x08, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x0A, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00
};

const uint8_t omagic[] = {
    //ecoff_filehdr
    0x07, 0x01, 0x0A, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,

    //ecoff_aouthdr
    0x07, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00
};
#else
    #error Invalid Endianess
#endif



TEST(ExecEcoffTest, Round)
{
    /*
     * Note: ECOFF_ROUND always rounds up.
     */
    EXPECT_EQ((1 << 10) + (1 << 8) + (1 << 6),
        ECOFF_ROUND((1 << 10) + (1 << 8) + (1 << 5) + (1 << 4) + (1 << 1),
                    (1 << 5)));

    EXPECT_EQ((1 << 10) + (1 << 8) + (1 << 5),
        ECOFF_ROUND((1 << 10) + (1 << 8) + (1 << 4) + (1 << 1),
                    (1 << 5)));

    EXPECT_EQ((1 << 10) + (1 << 8) + (1 << 6),
        ECOFF_ROUND((1 << 10) + (1 << 8) + (1 << 5) + (1 << 1),
                    (1 << 5)));
}

TEST(ExecEcoffTest, NoRounding)
{
    EXPECT_EQ((1 << 10) + (1 << 8) + (1 << 5),
        ECOFF_ROUND((1 << 10) + (1 << 8) + (1 << 5),
                    (1 << 5)));
}

TEST(ExecEcoffTest, BlockAlignWithoutZmagic)
{
    /*
     * ECOFF_BLOCK_ALIGN will return "value" if "ep->a.magic" is not
     * ECOFF_ZMAGIC.
     */
    u_int64_t value = 0XFFFF;

    EXPECT_EQ(value, ECOFF_BLOCK_ALIGN(&OMAGIC_STRUCT, value));
    EXPECT_EQ(value, ECOFF_BLOCK_ALIGN(&OMAGIC_STRUCT, value));
}

TEST(ExecEcoffTest, BlockAlignWithZmagic)
{
    /*
     * ECOFF_BLOCK_ALIGN will return "value" rounded ECOFF_LDPGSZ (1 << 12)
     * if "ep->a.magic" is ECOFF_ZMAGIC. This uses ECOFF_ROUND, so will only
     * round up.
     */
    u_int64_t value1 = (1 << 14) + (1 << 13) + (1 << 10) + (1 << 8);
    u_int64_t expected_output1 = (1 << 14) + (1 << 13) + (1 << 12);
    EXPECT_EQ(expected_output1, ECOFF_BLOCK_ALIGN(&ZMAGIC_STRUCT, value1));

    u_int64_t value2 = (1 << 10) + (1 << 8);
    u_int64_t expected_output2 = (1 << 12) ;
    EXPECT_EQ(expected_output2, ECOFF_BLOCK_ALIGN(&ZMAGIC_STRUCT, value2));
}

TEST(ExecEcoffTest, SegmentAlignWithZmagic)
{
    /*
     * ECOFF_SEGMENT_ALIGN will round "value" rounded by ECOFF_LDPGZ (1 << 12)
     * if "ep->amagic" is ECOFF_ZMAGIC.
     */
    u_int64_t value1 = (1 << 14) + (1 << 13) + (1 << 10) + (1 << 8);
    u_int64_t expected_output1 = (1 << 14) + (1 << 13) + (1 << 12);
    EXPECT_EQ(expected_output1, ECOFF_SEGMENT_ALIGN(&ZMAGIC_STRUCT, value1));

    u_int64_t value2 = (1 << 10) + (1 << 8);
    u_int64_t expected_output2 = (1 << 12) ;
    EXPECT_EQ(expected_output2, ECOFF_SEGMENT_ALIGN(&ZMAGIC_STRUCT, value2));
}

TEST(ExecEcoffTest, SegmentAlignWithoutZmagic)
{
    /*
     * ECOFF_SEGMENT_ALIGN will return value rounded by the
     * ECOFF_SEGMENT_ALIGNMENT of ep (ECOFF_SEGMENT_ALIGNMENT is defined in
     * "arch/alpha/ecoff_machdep.h") if "ep->amagic" is not ECOFF_ZMAGIC.
     *
     * ECOFF_SEGMENT_ALIGNMENT(ep) will return 8 if the 2nd LSB in
     * "(ep)->f.f_flags" is 0 and 16 if it is 1.
     *
     * "(nmagic)->f.f_flags" is 0x2, and therefore ECOFF_SEGMENT_ALIGN will
     * round value by (1 << 4). "(omagic)->f.f_flags" is 0x0 and, in this
     * case, ECOFF_SEGMENT_ALIGN will round value by (1 << 3).
     */

    u_int64_t value = (1 << 14) + (1 << 13) + (1 << 8) + (1 << 4) + (1 << 2)
                     + (1 << 1);

    EXPECT_EQ((1 << 14) + (1 << 13) + (1 << 8) + (1 << 5),
        ECOFF_SEGMENT_ALIGN(&NMAGIC_STRUCT, value)); // Round by (1 << 4).
    EXPECT_EQ((1 << 14) + (1 << 13) + (1 << 8) + (1 << 4) + (1 << 3),
        ECOFF_SEGMENT_ALIGN(&OMAGIC_STRUCT, value)); // Round by (1 << 3).
}

TEST(ExecEcoffTest, TxtOffWithMagic)
{
    /*
     * ECOFF_TXTOFF will return 0 if "(ep)->a.magic" is ECOFF_ZMAGIC
     */
    EXPECT_EQ(0, ECOFF_TXTOFF(&ZMAGIC_STRUCT));
}

TEST(ExecEcoffTest, TxtOffWithoutMagic)
{
    /*
     * If "(ep)->a.magic" is not ECOFF_ZMAGIC, ECOFF_TXTOFF will return
     * "(ep)->f.f_nscns" multiplied by ECOFF_HDR_SIZE (sizeof ecoff_scnhdr)
     * plus the size of ecoff_exechdr, roundeded by ECOFF_SEGMENT_ALIGNMENT.
     * The value of ECOFF_SEGMENT_ALIGNMENT will return (1 << 3) if the 2nd
     * LSB in "(ep)->f.f_flags" is 0 and (1 << 4) if it's one.
     *
     * In our setup (omagic)->f.f_flags is 0x0 and (nmagic)->f.f_flags is 0x2.
     * (omagic)->f.f_nscns is 0xA, and (nmagic)->f.f_nscns is 0xF.
     */

    /*
     * (sizeof omagic) * 0xA + (sizeof omagic), rounded by (1 << 3).
     */
    u_int64_t expected_output_omagic = ECOFF_ROUND(
                                        (sizeof(struct ecoff_scnhdr)) * 0xA
                                        + (sizeof(struct ecoff_exechdr)),
                                        (1 << 3));
    EXPECT_EQ(expected_output_omagic, ECOFF_TXTOFF(&OMAGIC_STRUCT));

    /*
     * (sizeof nmagic) * 0xF + (sizeof nmagic), rounded by (1 << 4).
     */
    u_int64_t expected_output_nmagic = ECOFF_ROUND(
                                        (sizeof(struct ecoff_scnhdr) * 0xF
                                        + (sizeof(struct ecoff_exechdr))),
                                        (1 << 4));
    EXPECT_EQ(expected_output_nmagic, ECOFF_TXTOFF(&NMAGIC_STRUCT));
}

TEST(ExecEcoffTest, DatOffWithMagic)
{
    /*
     * f (ep)->a.magic is ECOFF_ZMAGIC, ECOFF_DATOFF will return
     * (ep)->a.tsize plus ECOFF_TXT(ep), rounded by ECOFF_LDPGSZ (1 << 12).
     *
     * (zmagic)->a.tsize is 0xF.
     */

    u_int64_t expected_output = ECOFF_ROUND(
                            0xF + ECOFF_TXTOFF(&ZMAGIC_STRUCT), (1 << 12));
    EXPECT_EQ(expected_output, ECOFF_DATOFF(&ZMAGIC_STRUCT));
}

TEST(ExecEcoffTest, DatOffWithoutMagic)
{
    /*
     * ECOFF_DATOFF will return (ep)->a.tsize plus ECOFF_TXTOFF(ep) if
     * (ep)->a.magic is not ECOFF_ZMAGIC.
     *
     * (nmagic)->a.tsize is 0xA.
     * (omagic)->a.tsize is 0x1.
     */

    u_int64_t expected_output_nmagic = 0xA + ECOFF_TXTOFF(&NMAGIC_STRUCT);
    EXPECT_EQ(expected_output_nmagic, ECOFF_DATOFF(&NMAGIC_STRUCT));

    u_int64_t expected_output_omagic = 0x1 + ECOFF_TXTOFF(&OMAGIC_STRUCT);
    EXPECT_EQ(expected_output_omagic, ECOFF_DATOFF(&OMAGIC_STRUCT));
}