aboutsummaryrefslogtreecommitdiffstats
path: root/tools/testing/selftests/powerpc/papr_vpd/papr_vpd.c
blob: d6f99eb9be659d3c9bb60b922e4f81102ac7f918 (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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
// SPDX-License-Identifier: GPL-2.0-only
#define _GNU_SOURCE
#include <errno.h>
#include <fcntl.h>
#include <stdlib.h>
#include <string.h>
#include <sys/ioctl.h>
#include <unistd.h>

#include <asm/papr-vpd.h>

#include "utils.h"

#define DEVPATH "/dev/papr-vpd"

static int dev_papr_vpd_open_close(void)
{
	const int devfd = open(DEVPATH, O_RDONLY);

	SKIP_IF_MSG(devfd < 0 && errno == ENOENT,
		    DEVPATH " not present");

	FAIL_IF(devfd < 0);
	FAIL_IF(close(devfd) != 0);

	return 0;
}

static int dev_papr_vpd_get_handle_all(void)
{
	const int devfd = open(DEVPATH, O_RDONLY);
	struct papr_location_code lc = { .str = "", };
	off_t size;
	int fd;

	SKIP_IF_MSG(devfd < 0 && errno == ENOENT,
		    DEVPATH " not present");

	FAIL_IF(devfd < 0);

	errno = 0;
	fd = ioctl(devfd, PAPR_VPD_IOC_CREATE_HANDLE, &lc);
	FAIL_IF(errno != 0);
	FAIL_IF(fd < 0);

	FAIL_IF(close(devfd) != 0);

	size = lseek(fd, 0, SEEK_END);
	FAIL_IF(size <= 0);

	void *buf = malloc((size_t)size);
	FAIL_IF(!buf);

	ssize_t consumed = pread(fd, buf, size, 0);
	FAIL_IF(consumed != size);

	/* Ensure EOF */
	FAIL_IF(read(fd, buf, size) != 0);
	FAIL_IF(close(fd));

	/* Verify that the buffer looks like VPD */
	static const char needle[] = "System VPD";
	FAIL_IF(!memmem(buf, size, needle, strlen(needle)));

	return 0;
}

static int dev_papr_vpd_get_handle_byte_at_a_time(void)
{
	const int devfd = open(DEVPATH, O_RDONLY);
	struct papr_location_code lc = { .str = "", };
	int fd;

	SKIP_IF_MSG(devfd < 0 && errno == ENOENT,
		    DEVPATH " not present");

	FAIL_IF(devfd < 0);

	errno = 0;
	fd = ioctl(devfd, PAPR_VPD_IOC_CREATE_HANDLE, &lc);
	FAIL_IF(errno != 0);
	FAIL_IF(fd < 0);

	FAIL_IF(close(devfd) != 0);

	size_t consumed = 0;
	while (1) {
		ssize_t res;
		char c;

		errno = 0;
		res = read(fd, &c, sizeof(c));
		FAIL_IF(res > sizeof(c));
		FAIL_IF(res < 0);
		FAIL_IF(errno != 0);
		consumed += res;
		if (res == 0)
			break;
	}

	FAIL_IF(consumed != lseek(fd, 0, SEEK_END));

	FAIL_IF(close(fd));

	return 0;
}


static int dev_papr_vpd_unterm_loc_code(void)
{
	const int devfd = open(DEVPATH, O_RDONLY);
	struct papr_location_code lc = {};
	int fd;

	SKIP_IF_MSG(devfd < 0 && errno == ENOENT,
		    DEVPATH " not present");

	FAIL_IF(devfd < 0);

	/*
	 * Place a non-null byte in every element of loc_code; the
	 * driver should reject this input.
	 */
	memset(lc.str, 'x', ARRAY_SIZE(lc.str));

	errno = 0;
	fd = ioctl(devfd, PAPR_VPD_IOC_CREATE_HANDLE, &lc);
	FAIL_IF(fd != -1);
	FAIL_IF(errno != EINVAL);

	FAIL_IF(close(devfd) != 0);
	return 0;
}

static int dev_papr_vpd_null_handle(void)
{
	const int devfd = open(DEVPATH, O_RDONLY);
	int rc;

	SKIP_IF_MSG(devfd < 0 && errno == ENOENT,
		    DEVPATH " not present");

	FAIL_IF(devfd < 0);

	errno = 0;
	rc = ioctl(devfd, PAPR_VPD_IOC_CREATE_HANDLE, NULL);
	FAIL_IF(rc != -1);
	FAIL_IF(errno != EFAULT);

	FAIL_IF(close(devfd) != 0);
	return 0;
}

static int papr_vpd_close_handle_without_reading(void)
{
	const int devfd = open(DEVPATH, O_RDONLY);
	struct papr_location_code lc = { .str = "", };
	int fd;

	SKIP_IF_MSG(devfd < 0 && errno == ENOENT,
		    DEVPATH " not present");

	FAIL_IF(devfd < 0);

	errno = 0;
	fd = ioctl(devfd, PAPR_VPD_IOC_CREATE_HANDLE, &lc);
	FAIL_IF(errno != 0);
	FAIL_IF(fd < 0);

	/* close the handle without reading it */
	FAIL_IF(close(fd) != 0);

	FAIL_IF(close(devfd) != 0);
	return 0;
}

static int papr_vpd_reread(void)
{
	const int devfd = open(DEVPATH, O_RDONLY);
	struct papr_location_code lc = { .str = "", };
	int fd;

	SKIP_IF_MSG(devfd < 0 && errno == ENOENT,
		    DEVPATH " not present");

	FAIL_IF(devfd < 0);

	errno = 0;
	fd = ioctl(devfd, PAPR_VPD_IOC_CREATE_HANDLE, &lc);
	FAIL_IF(errno != 0);
	FAIL_IF(fd < 0);

	FAIL_IF(close(devfd) != 0);

	const off_t size = lseek(fd, 0, SEEK_END);
	FAIL_IF(size <= 0);

	char *bufs[2];

	for (size_t i = 0; i < ARRAY_SIZE(bufs); ++i) {
		bufs[i] = malloc(size);
		FAIL_IF(!bufs[i]);
		ssize_t consumed = pread(fd, bufs[i], size, 0);
		FAIL_IF(consumed != size);
	}

	FAIL_IF(memcmp(bufs[0], bufs[1], size));

	FAIL_IF(close(fd) != 0);

	return 0;
}

static int get_system_loc_code(struct papr_location_code *lc)
{
	static const char system_id_path[] = "/sys/firmware/devicetree/base/system-id";
	static const char model_path[] = "/sys/firmware/devicetree/base/model";
	char *system_id;
	char *model;
	int err = -1;

	if (read_file_alloc(model_path, &model, NULL))
		return err;

	if (read_file_alloc(system_id_path, &system_id, NULL))
		goto free_model;

	char *mtm;
	int sscanf_ret = sscanf(model, "IBM,%ms", &mtm);
	if (sscanf_ret != 1)
		goto free_system_id;

	char *plant_and_seq;
	if (sscanf(system_id, "IBM,%*c%*c%ms", &plant_and_seq) != 1)
		goto free_mtm;
	/*
	 * Replace - with . to build location code.
	 */
	char *sep = strchr(mtm, '-');
	if (!sep)
		goto free_mtm;
	else
		*sep = '.';

	snprintf(lc->str, sizeof(lc->str),
		 "U%s.%s", mtm, plant_and_seq);
	err = 0;

	free(plant_and_seq);
free_mtm:
	free(mtm);
free_system_id:
	free(system_id);
free_model:
	free(model);
	return err;
}

static int papr_vpd_system_loc_code(void)
{
	struct papr_location_code lc;
	const int devfd = open(DEVPATH, O_RDONLY);
	off_t size;
	int fd;

	SKIP_IF_MSG(devfd < 0 && errno == ENOENT,
		    DEVPATH " not present");
	SKIP_IF_MSG(get_system_loc_code(&lc),
		    "Cannot determine system location code");

	FAIL_IF(devfd < 0);

	errno = 0;
	fd = ioctl(devfd, PAPR_VPD_IOC_CREATE_HANDLE, &lc);
	FAIL_IF(errno != 0);
	FAIL_IF(fd < 0);

	FAIL_IF(close(devfd) != 0);

	size = lseek(fd, 0, SEEK_END);
	FAIL_IF(size <= 0);

	void *buf = malloc((size_t)size);
	FAIL_IF(!buf);

	ssize_t consumed = pread(fd, buf, size, 0);
	FAIL_IF(consumed != size);

	/* Ensure EOF */
	FAIL_IF(read(fd, buf, size) != 0);
	FAIL_IF(close(fd));

	/* Verify that the buffer looks like VPD */
	static const char needle[] = "System VPD";
	FAIL_IF(!memmem(buf, size, needle, strlen(needle)));

	return 0;
}

struct vpd_test {
	int (*function)(void);
	const char *description;
};

static const struct vpd_test vpd_tests[] = {
	{
		.function = dev_papr_vpd_open_close,
		.description = "open/close " DEVPATH,
	},
	{
		.function = dev_papr_vpd_unterm_loc_code,
		.description = "ensure EINVAL on unterminated location code",
	},
	{
		.function = dev_papr_vpd_null_handle,
		.description = "ensure EFAULT on bad handle addr",
	},
	{
		.function = dev_papr_vpd_get_handle_all,
		.description = "get handle for all VPD"
	},
	{
		.function = papr_vpd_close_handle_without_reading,
		.description = "close handle without consuming VPD"
	},
	{
		.function = dev_papr_vpd_get_handle_byte_at_a_time,
		.description = "read all VPD one byte at a time"
	},
	{
		.function = papr_vpd_reread,
		.description = "ensure re-read yields same results"
	},
	{
		.function = papr_vpd_system_loc_code,
		.description = "get handle for system VPD"
	},
};

int main(void)
{
	size_t fails = 0;

	for (size_t i = 0; i < ARRAY_SIZE(vpd_tests); ++i) {
		const struct vpd_test *t = &vpd_tests[i];

		if (test_harness(t->function, t->description))
			++fails;
	}

	return fails == 0 ? EXIT_SUCCESS : EXIT_FAILURE;
}