File: ioctl_rtc.c

package info (click to toggle)
strace 6.13%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 71,488 kB
  • sloc: ansic: 176,497; sh: 9,675; makefile: 4,133; cpp: 885; awk: 353; perl: 267; exp: 62; sed: 9
file content (419 lines) | stat: -rw-r--r-- 12,609 bytes parent folder | download | duplicates (9)
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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
/*
 * Check decoding of RTC ioctl commands.
 *
 * Copyright (c) 2016 Dmitry V. Levin <ldv@strace.io>
 * Copyright (c) 2016-2022 The strace developers.
 * All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */

#include "tests.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/ioctl.h>
#include <linux/types.h>
#include <linux/rtc.h>

#ifndef RTC_VL_READ
# define RTC_VL_READ _IOR('p', 0x13, unsigned int)
#endif
#ifndef RTC_VL_CLR
# define RTC_VL_CLR _IO ('p', 0x14)
#endif

#ifndef RTC_PARAM_GET
struct rtc_param {
	__u64 param;
	union {
		__u64 uvalue;
		__s64 svalue;
		__u64 ptr;
	};
	__u32 index;
	__u32 __pad;
};
# define RTC_PARAM_GET _IOW('p', 0x13, struct rtc_param)
#endif /* !TC_PARAM_GET */
#ifndef RTC_PARAM_SET
# define RTC_PARAM_SET _IOW('p', 0x14, struct rtc_param)
#endif

static const unsigned long lmagic = (unsigned long) 0xdeadbeefbadc0dedULL;

static const char *errstr;

static int
do_ioctl(kernel_ulong_t cmd, kernel_ulong_t arg)
{
	int rc = ioctl(-1, cmd, arg);
	errstr = sprintrc(rc);

#ifdef INJECT_RETVAL
	if (rc != INJECT_RETVAL)
		error_msg_and_fail("Return value [%d] does not match"
				   " expectations [%d]", rc, INJECT_RETVAL);

	static char inj_errstr[4096];

	snprintf(inj_errstr, sizeof(inj_errstr), "%s (INJECTED)", errstr);
	errstr = inj_errstr;
#endif

	return rc;
}

static int
do_ioctl_ptr(kernel_ulong_t cmd, const void *arg)
{
	return do_ioctl(cmd, (uintptr_t) arg);
}

#ifdef INJECT_RETVAL
static void
skip_ioctls(int argc, const char *argv[])
{
	if (argc < 2)
		error_msg_and_fail("Usage: %s NUM_SKIP", argv[0]);

	unsigned long num_skip = strtoul(argv[1], NULL, 0);

	for (size_t i = 0; i < num_skip; ++i) {
		int rc = ioctl(-1, RTC_AIE_OFF, 0);
		printf("ioctl(-1, RTC_AIE_OFF) = %s%s\n", sprintrc(rc),
		       rc == INJECT_RETVAL ? " (INJECTED)" : "");
		if (rc == INJECT_RETVAL)
			return;
	}

	error_msg_and_fail("Issued %lu ioctl syscalls but failed"
			   " to detect an injected return code %d",
			   num_skip, INJECT_RETVAL);
}
#endif /* INJECT_RETVAL */

static void
print_rtc_time(const struct rtc_time *rt)
{
	printf("{tm_sec=%d, tm_min=%d, tm_hour=%d"
	       ", tm_mday=%d, tm_mon=%d, tm_year=%d",
	       rt->tm_sec, rt->tm_min, rt->tm_hour,
	       rt->tm_mday, rt->tm_mon, rt->tm_year);
#if VERBOSE
	printf(", tm_wday=%d, tm_yday=%d, tm_isdst=%d}",
	       rt->tm_wday, rt->tm_yday, rt->tm_isdst);
#else
	printf(", ...}");
#endif
}

int
main(int argc, const char *argv[])
{
#ifdef INJECT_RETVAL
	skip_ioctls(argc, argv);
#endif

	static const struct {
		unsigned int cmd;
		const char *str;
	} noarg_cmds[] = {
		{ ARG_STR(RTC_AIE_OFF) },
#ifdef HPPA
		{ RTC_AIE_ON, "PA_PERF_ON or RTC_AIE_ON" },
#else
		{ ARG_STR(RTC_AIE_ON) },
#endif
		{ ARG_STR(RTC_PIE_OFF) },
		{ ARG_STR(RTC_PIE_ON) },
		{ RTC_UIE_OFF, "PHN_NOT_OH or RTC_UIE_OFF" },
		{ ARG_STR(RTC_UIE_ON) },
		{ ARG_STR(RTC_VL_CLR), },
		{ ARG_STR(RTC_WIE_OFF) },
		{ ARG_STR(RTC_WIE_ON) },
	}, long_cmds[] = {
		{ ARG_STR(RTC_EPOCH_SET) },
		{ ARG_STR(RTC_IRQP_SET) },
	}, plong_cmds[] = {
		{ ARG_STR(RTC_EPOCH_READ) },
		{ ARG_STR(RTC_IRQP_READ) },
	}, ptr_cmds[] = {
		{ ARG_STR(RTC_ALM_READ) },
		{ ARG_STR(RTC_ALM_SET) },
		{ ARG_STR(RTC_EPOCH_READ) },
		{ ARG_STR(RTC_IRQP_READ) },
		{ ARG_STR(RTC_PLL_GET) },
		{ ARG_STR(RTC_PLL_SET) },
		{ ARG_STR(RTC_RD_TIME) },
		{ ARG_STR(RTC_SET_TIME) },
		{ ARG_STR(RTC_VL_READ) },
		{ ARG_STR(RTC_WKALM_RD) },
		{ ARG_STR(RTC_WKALM_SET) },
	}, r_time_cmds[] = {
		{ ARG_STR(RTC_ALM_READ) },
		{ ARG_STR(RTC_RD_TIME) },
	}, w_time_cmds[] = {
		{ ARG_STR(RTC_ALM_SET) },
		{ ARG_STR(RTC_SET_TIME) },
	}, r_wkalrm_cmds[] = {
		{ ARG_STR(RTC_WKALM_RD) },
	}, w_wkalrm_cmds[] = {
		{ ARG_STR(RTC_WKALM_SET) },
	}, r_pll_cmds[] = {
		{ ARG_STR(RTC_PLL_GET) },
	}, w_pll_cmds[] = {
		{ ARG_STR(RTC_PLL_SET) },
	};

	for (size_t i = 0; i < ARRAY_SIZE(noarg_cmds); ++i) {
		do_ioctl(noarg_cmds[i].cmd, lmagic);
		printf("ioctl(-1, %s) = %s\n",
		       noarg_cmds[i].str, errstr);
	}

	for (size_t i = 0; i < ARRAY_SIZE(long_cmds); ++i) {
		do_ioctl(long_cmds[i].cmd, lmagic);
		printf("ioctl(-1, %s, %lu) = %s\n",
		       long_cmds[i].str, lmagic, errstr);
	}

	TAIL_ALLOC_OBJECT_CONST_PTR(unsigned long, plong);
	*plong = lmagic;

	for (size_t i = 0; i < ARRAY_SIZE(plong_cmds); ++i) {
		if (do_ioctl_ptr(plong_cmds[i].cmd, plong) < 0) {
			printf("ioctl(-1, %s, %p) = %s\n",
			       plong_cmds[i].str, plong, errstr);
		} else {
			printf("ioctl(-1, %s, [%lu]) = %s\n",
			       plong_cmds[i].str, *plong, errstr);
		}
	}

	void *const efault = tail_alloc(1);

	for (size_t i = 0; i < ARRAY_SIZE(ptr_cmds); ++i) {
		do_ioctl(ptr_cmds[i].cmd, 0);
		printf("ioctl(-1, %s, NULL) = %s\n",
		       ptr_cmds[i].str, errstr);
		do_ioctl_ptr(ptr_cmds[i].cmd, efault);
		printf("ioctl(-1, %s, %p) = %s\n",
		       ptr_cmds[i].str, efault, errstr);
	}

	TAIL_ALLOC_OBJECT_CONST_PTR(struct rtc_time, rt);
	fill_memory(rt, sizeof(*rt));

	for (size_t i = 0; i < ARRAY_SIZE(w_time_cmds); ++i) {
		do_ioctl_ptr(w_time_cmds[i].cmd, rt);
		printf("ioctl(-1, %s, ", w_time_cmds[i].str);
		print_rtc_time(rt);
		printf(") = %s\n", errstr);
	}

	for (size_t i = 0; i < ARRAY_SIZE(r_time_cmds); ++i) {
		if (do_ioctl_ptr(r_time_cmds[i].cmd, rt) < 0) {
			printf("ioctl(-1, %s, %p) = %s\n",
			       r_time_cmds[i].str, rt, errstr);
		} else {
			printf("ioctl(-1, %s, ", r_time_cmds[i].str);
			print_rtc_time(rt);
			printf(") = %s\n", errstr);
		}
	}

	TAIL_ALLOC_OBJECT_CONST_PTR(struct rtc_wkalrm, wk);
	fill_memory(wk, sizeof(*wk));

	for (size_t i = 0; i < ARRAY_SIZE(w_wkalrm_cmds); ++i) {
		do_ioctl_ptr(w_wkalrm_cmds[i].cmd, wk);
		printf("ioctl(-1, %s, {enabled=%hhu, pending=%hhu, time=",
		       w_wkalrm_cmds[i].str, wk->enabled, wk->pending);
		print_rtc_time(&wk->time);
		printf("}) = %s\n", errstr);
	}

	for (size_t i = 0; i < ARRAY_SIZE(r_wkalrm_cmds); ++i) {
		if (do_ioctl_ptr(r_wkalrm_cmds[i].cmd, wk) < 0) {
			printf("ioctl(-1, %s, %p) = %s\n",
			       r_wkalrm_cmds[i].str, wk, errstr);
		} else {
			printf("ioctl(-1, %s, {enabled=%hhu, pending=%hhu, time=",
			       r_wkalrm_cmds[i].str, wk->enabled, wk->pending);
			print_rtc_time(&wk->time);
			printf("}) = %s\n", errstr);
		}
	}

	TAIL_ALLOC_OBJECT_CONST_PTR(struct rtc_pll_info, pll);
	fill_memory(pll, sizeof(*pll));

	for (size_t i = 0; i < ARRAY_SIZE(w_pll_cmds); ++i) {
		do_ioctl_ptr(w_pll_cmds[i].cmd, pll);
		printf("ioctl(-1, %s, {pll_ctrl=%d, pll_value=%d"
		       ", pll_max=%d, pll_min=%d, pll_posmult=%d"
		       ", pll_negmult=%d, pll_clock=%ld}) = %s\n",
		       w_pll_cmds[i].str, pll->pll_ctrl, pll->pll_value,
		       pll->pll_max, pll->pll_min, pll->pll_posmult,
		       pll->pll_negmult, pll->pll_clock, errstr);
	}

	for (size_t i = 0; i < ARRAY_SIZE(r_pll_cmds); ++i) {
		if (do_ioctl_ptr(r_pll_cmds[i].cmd, pll) < 0) {
			printf("ioctl(-1, %s, %p) = %s\n",
			       r_pll_cmds[i].str, pll, errstr);
		} else {
			printf("ioctl(-1, %s, {pll_ctrl=%d, pll_value=%d"
			       ", pll_max=%d, pll_min=%d, pll_posmult=%d"
			       ", pll_negmult=%d, pll_clock=%ld}) = %s\n",
			       r_pll_cmds[i].str, pll->pll_ctrl, pll->pll_value,
			       pll->pll_max, pll->pll_min, pll->pll_posmult,
			       pll->pll_negmult, pll->pll_clock, errstr);
		}
	}

	static const struct strval32 vl_vecs[] = {
		{ ARG_STR(0) },
		{ ARG_XLAT_KNOWN(0x10, "RTC_VL_BACKUP_SWITCH") },
		{ ARG_XLAT_KNOWN(0xbeef, "RTC_VL_DATA_INVALID"
					 "|RTC_VL_BACKUP_LOW"
					 "|RTC_VL_BACKUP_EMPTY"
					 "|RTC_VL_ACCURACY_LOW|0xbee0") },
		{ ARG_XLAT_UNKNOWN(0xbadc0de0, "RTC_VL_???") },
	};
	TAIL_ALLOC_OBJECT_CONST_PTR(unsigned int, pint);

	for (size_t i = 0; i < ARRAY_SIZE(vl_vecs); i++) {
		*pint = vl_vecs[i].val;

		if (do_ioctl_ptr(RTC_VL_READ, pint) < 0) {
			printf("ioctl(-1, RTC_VL_READ, %p) = %s\n",
			       pint, errstr);
		} else {
			printf("ioctl(-1, RTC_VL_READ, [%s]) = %s\n",
			       vl_vecs[i].str, errstr);
		}
	}

	do_ioctl(_IO(0x70, 0x40), lmagic);
	printf("ioctl(-1, %s, %#lx) = %s\n", "NVRAM_INIT", lmagic, errstr);

	static const struct strval32 param_cmds[] = {
		{ ARG_STR(RTC_PARAM_GET) },
		{ ARG_STR(RTC_PARAM_SET) },
	};
	static const struct {
		struct rtc_param val;
		const char *get_in;
		const char *get_out;
		const char *set;
	} param_vecs[] = {
		{ { 0 },
		  "{param=RTC_PARAM_FEATURES, index=0}",
		  "{uvalue=0}",
		  "{param=RTC_PARAM_FEATURES, uvalue=0, index=0}" },
		{ { .param = 0, .uvalue = (__u64) 0xdeadfacebeeffeedULL,
		    .index= 0xfacecafe, .__pad = 0xbadc0ded },
		  "{param=RTC_PARAM_FEATURES, index=4207856382"
		  ", __pad=0xbadc0ded}",
		  "{uvalue=1<<RTC_FEATURE_ALARM|1<<RTC_FEATURE_NEED_WEEK_DAY"
		  "|1<<RTC_FEATURE_ALARM_RES_2S|1<<RTC_FEATURE_CORRECTION"
		  "|1<<RTC_FEATURE_BACKUP_SWITCH_MODE"
		  "|1<<RTC_FEATURE_ALARM_WAKEUP_ONLY|0xdeadfacebeeffe00"
		  ", __pad=0xbadc0ded}",
		  "{param=RTC_PARAM_FEATURES, uvalue=1<<RTC_FEATURE_ALARM"
		  "|1<<RTC_FEATURE_NEED_WEEK_DAY|1<<RTC_FEATURE_ALARM_RES_2S"
		  "|1<<RTC_FEATURE_CORRECTION|1<<RTC_FEATURE_BACKUP_SWITCH_MODE"
		  "|1<<RTC_FEATURE_ALARM_WAKEUP_ONLY|0xdeadfacebeeffe00"
		  ", index=4207856382, __pad=0xbadc0ded}" },
		{ { .param = 0, .uvalue = 0xbeef00, .__pad = 1 },
		  "{param=RTC_PARAM_FEATURES, index=0, __pad=0x1}",
		  "{uvalue=0xbeef00 /* 1<<RTC_FEATURE_??? */, __pad=0x1}",
		  "{param=RTC_PARAM_FEATURES"
		  ", uvalue=0xbeef00 /* 1<<RTC_FEATURE_??? */, index=0"
		  ", __pad=0x1}" },
		{ { .param = 1 },
		  "{param=RTC_PARAM_CORRECTION, index=0}",
		  "{svalue=0}",
		  "{param=RTC_PARAM_CORRECTION, svalue=0, index=0}" },
		{ { .param = 1, .svalue = (__s64) 0xfacefeeddeadcafeULL,
		    .index = 0xdeffaced, .__pad = 0xcafeface },
		  "{param=RTC_PARAM_CORRECTION, index=3741297901"
		  ", __pad=0xcafeface}",
		  "{svalue=-374081421428536578, __pad=0xcafeface}",
		  "{param=RTC_PARAM_CORRECTION, svalue=-374081421428536578"
		  ", index=3741297901, __pad=0xcafeface}" },
		{ { .param = 1, .svalue = -1337, .index = 0x42 },
		  "{param=RTC_PARAM_CORRECTION, index=66}",
		  "{svalue=-1337}",
		  "{param=RTC_PARAM_CORRECTION, svalue=-1337, index=66}" },
		{ { .param = 2 },
		  "{param=RTC_PARAM_BACKUP_SWITCH_MODE, index=0}",
		  "{uvalue=RTC_BSM_DISABLED}",
		  "{param=RTC_PARAM_BACKUP_SWITCH_MODE, uvalue=RTC_BSM_DISABLED"
		  ", index=0}" },
		{ { .param = 2, .uvalue = 3, .index = 0xdecaffed,
		    .__pad = 0xfacebeef },
		  "{param=RTC_PARAM_BACKUP_SWITCH_MODE, index=3737845741"
		  ", __pad=0xfacebeef}",
		  "{uvalue=RTC_BSM_STANDBY, __pad=0xfacebeef}",
		  "{param=RTC_PARAM_BACKUP_SWITCH_MODE, uvalue=RTC_BSM_STANDBY"
		  ", index=3737845741, __pad=0xfacebeef}" },
		{ { .param = 2, .uvalue = 4, .__pad = 23 },
		  "{param=RTC_PARAM_BACKUP_SWITCH_MODE, index=0, __pad=0x17}",
		  "{uvalue=0x4 /* RTC_BSM_??? */, __pad=0x17}",
		  "{param=RTC_PARAM_BACKUP_SWITCH_MODE"
		  ", uvalue=0x4 /* RTC_BSM_??? */, index=0, __pad=0x17}" },
		{ { .param = 2, .uvalue = (__u64) 0xface1e55beefcafeULL,
		    .index = 42 },
		  "{param=RTC_PARAM_BACKUP_SWITCH_MODE, index=42}",
		  "{uvalue=0xface1e55beefcafe /* RTC_BSM_??? */}",
		  "{param=RTC_PARAM_BACKUP_SWITCH_MODE"
		  ", uvalue=0xface1e55beefcafe /* RTC_BSM_??? */"
		  ", index=42}" },
		{ { .param = 3 },
		  "{param=0x3 /* RTC_PARAM_??? */, index=0}",
		  "{uvalue=0}",
		  "{param=0x3 /* RTC_PARAM_??? */, uvalue=0, index=0}" },
		{ { .param = (__u64) 0xbeeffacedeadc0deULL,
		    .uvalue = (__u64) 0xdefc0dedbadfacedULL,
		    .index = 3141592653, .__pad = 2718281828 },
		  "{param=0xbeeffacedeadc0de /* RTC_PARAM_??? */"
		  ", index=3141592653, __pad=0xa205b064}",
		  "{uvalue=0xdefc0dedbadfaced, __pad=0xa205b064}",
		  "{param=0xbeeffacedeadc0de /* RTC_PARAM_??? */"
		  ", uvalue=0xdefc0dedbadfaced, index=3141592653"
		  ", __pad=0xa205b064}" },
	};
	TAIL_ALLOC_OBJECT_CONST_PTR(struct rtc_param, pparam);

	for (size_t i = 0; i < ARRAY_SIZE(param_cmds); i++) {
		do_ioctl(param_cmds[i].val, 0);
		printf("ioctl(-1, %s, NULL) = %s\n",
		       param_cmds[i].str, errstr);

		do_ioctl_ptr(param_cmds[i].val, pparam + 1);
		printf("ioctl(-1, %s, %p) = %s\n",
		       param_cmds[i].str, pparam + 1, errstr);
	}

	for (size_t i = 0; i < ARRAY_SIZE(param_vecs); i++) {
		*pparam = param_vecs[i].val;

		int ret = do_ioctl_ptr(RTC_PARAM_GET, pparam);
		printf("ioctl(-1, RTC_PARAM_GET, %s => ", param_vecs[i].get_in);
		if (ret < 0)
			printf("%p", pparam);
		else
			printf("%s", param_vecs[i].get_out);
		printf(") = %s\n", errstr);

		do_ioctl_ptr(RTC_PARAM_SET, pparam);
		printf("ioctl(-1, RTC_PARAM_SET, %s) = %s\n",
		       param_vecs[i].set, errstr);
	}

	puts("+++ exited with 0 +++");
	return 0;
}