xref: /aosp_15_r20/external/ltp/include/tst_safe_file_ops.h (revision 49cdfc7efb34551c7342be41a7384b9c40d7cab7)
1*49cdfc7eSAndroid Build Coastguard Worker /* SPDX-License-Identifier: GPL-2.0-or-later
2*49cdfc7eSAndroid Build Coastguard Worker  * Copyright (C) 2012 Cyril Hrubis [email protected]
3*49cdfc7eSAndroid Build Coastguard Worker  */
4*49cdfc7eSAndroid Build Coastguard Worker 
5*49cdfc7eSAndroid Build Coastguard Worker #ifndef TST_SAFE_FILE_OPS
6*49cdfc7eSAndroid Build Coastguard Worker #define TST_SAFE_FILE_OPS
7*49cdfc7eSAndroid Build Coastguard Worker 
8*49cdfc7eSAndroid Build Coastguard Worker #include "safe_file_ops_fn.h"
9*49cdfc7eSAndroid Build Coastguard Worker 
10*49cdfc7eSAndroid Build Coastguard Worker #define FILE_SCANF(path, fmt, ...) \
11*49cdfc7eSAndroid Build Coastguard Worker 	file_scanf(__FILE__, __LINE__, (path), (fmt), ## __VA_ARGS__)
12*49cdfc7eSAndroid Build Coastguard Worker 
13*49cdfc7eSAndroid Build Coastguard Worker #define SAFE_FILE_SCANF(path, fmt, ...) \
14*49cdfc7eSAndroid Build Coastguard Worker 	safe_file_scanf(__FILE__, __LINE__, NULL, \
15*49cdfc7eSAndroid Build Coastguard Worker 	                (path), (fmt), ## __VA_ARGS__)
16*49cdfc7eSAndroid Build Coastguard Worker 
17*49cdfc7eSAndroid Build Coastguard Worker #define FILE_LINES_SCANF(path, fmt, ...) \
18*49cdfc7eSAndroid Build Coastguard Worker 	file_lines_scanf(__FILE__, __LINE__, NULL, 0,\
19*49cdfc7eSAndroid Build Coastguard Worker 			(path), (fmt), ## __VA_ARGS__)
20*49cdfc7eSAndroid Build Coastguard Worker 
21*49cdfc7eSAndroid Build Coastguard Worker #define SAFE_FILE_LINES_SCANF(path, fmt, ...) \
22*49cdfc7eSAndroid Build Coastguard Worker 	file_lines_scanf(__FILE__, __LINE__, NULL, 1,\
23*49cdfc7eSAndroid Build Coastguard Worker 			(path), (fmt), ## __VA_ARGS__)
24*49cdfc7eSAndroid Build Coastguard Worker 
25*49cdfc7eSAndroid Build Coastguard Worker #define SAFE_READ_MEMINFO(item) \
26*49cdfc7eSAndroid Build Coastguard Worker        ({long tst_rval; \
27*49cdfc7eSAndroid Build Coastguard Worker         SAFE_FILE_LINES_SCANF("/proc/meminfo", item " %ld", \
28*49cdfc7eSAndroid Build Coastguard Worker                         &tst_rval); \
29*49cdfc7eSAndroid Build Coastguard Worker         tst_rval;})
30*49cdfc7eSAndroid Build Coastguard Worker 
31*49cdfc7eSAndroid Build Coastguard Worker #define SAFE_READ_PROC_STATUS(pid, item) \
32*49cdfc7eSAndroid Build Coastguard Worker        ({long tst_rval_; \
33*49cdfc7eSAndroid Build Coastguard Worker         char tst_path_[128]; \
34*49cdfc7eSAndroid Build Coastguard Worker         sprintf(tst_path_, "/proc/%d/status", pid); \
35*49cdfc7eSAndroid Build Coastguard Worker         SAFE_FILE_LINES_SCANF(tst_path_, item " %ld", \
36*49cdfc7eSAndroid Build Coastguard Worker                         &tst_rval_); \
37*49cdfc7eSAndroid Build Coastguard Worker         tst_rval_;})
38*49cdfc7eSAndroid Build Coastguard Worker 
39*49cdfc7eSAndroid Build Coastguard Worker #define FILE_PRINTF(path, fmt, ...) \
40*49cdfc7eSAndroid Build Coastguard Worker 	file_printf(__FILE__, __LINE__, \
41*49cdfc7eSAndroid Build Coastguard Worker 		    (path), (fmt), ## __VA_ARGS__)
42*49cdfc7eSAndroid Build Coastguard Worker 
43*49cdfc7eSAndroid Build Coastguard Worker #define SAFE_FILE_PRINTF(path, fmt, ...) \
44*49cdfc7eSAndroid Build Coastguard Worker 	safe_file_printf(__FILE__, __LINE__, NULL, \
45*49cdfc7eSAndroid Build Coastguard Worker 	                 (path), (fmt), ## __VA_ARGS__)
46*49cdfc7eSAndroid Build Coastguard Worker 
47*49cdfc7eSAndroid Build Coastguard Worker /* Same as SAFE_FILE_PRINTF() but returns quietly if the path doesn't exist */
48*49cdfc7eSAndroid Build Coastguard Worker #define SAFE_TRY_FILE_PRINTF(path, fmt, ...) \
49*49cdfc7eSAndroid Build Coastguard Worker 	safe_try_file_printf(__FILE__, __LINE__, NULL, \
50*49cdfc7eSAndroid Build Coastguard Worker 		(path), (fmt), ## __VA_ARGS__)
51*49cdfc7eSAndroid Build Coastguard Worker 
52*49cdfc7eSAndroid Build Coastguard Worker #define SAFE_CP(src, dst) \
53*49cdfc7eSAndroid Build Coastguard Worker 	safe_cp(__FILE__, __LINE__, NULL, (src), (dst))
54*49cdfc7eSAndroid Build Coastguard Worker 
55*49cdfc7eSAndroid Build Coastguard Worker #define SAFE_TOUCH(pathname, mode, times) \
56*49cdfc7eSAndroid Build Coastguard Worker 	safe_touch(__FILE__, __LINE__, NULL, \
57*49cdfc7eSAndroid Build Coastguard Worker 			(pathname), (mode), (times))
58*49cdfc7eSAndroid Build Coastguard Worker 
59*49cdfc7eSAndroid Build Coastguard Worker /* New API only functions */
60*49cdfc7eSAndroid Build Coastguard Worker 
61*49cdfc7eSAndroid Build Coastguard Worker /* helper functions to setup overlayfs mountpoint */
62*49cdfc7eSAndroid Build Coastguard Worker void tst_create_overlay_dirs(void);
63*49cdfc7eSAndroid Build Coastguard Worker int tst_mount_overlay(const char *file, const int lineno, int strict);
64*49cdfc7eSAndroid Build Coastguard Worker 
65*49cdfc7eSAndroid Build Coastguard Worker #define SAFE_MOUNT_OVERLAY() \
66*49cdfc7eSAndroid Build Coastguard Worker 	((void) tst_mount_overlay(__FILE__, __LINE__, 1))
67*49cdfc7eSAndroid Build Coastguard Worker 
68*49cdfc7eSAndroid Build Coastguard Worker #define TST_MOUNT_OVERLAY() \
69*49cdfc7eSAndroid Build Coastguard Worker 	(tst_mount_overlay(__FILE__, __LINE__, 0) == 0)
70*49cdfc7eSAndroid Build Coastguard Worker 
71*49cdfc7eSAndroid Build Coastguard Worker #endif /* TST_SAFE_FILE_OPS */
72