1 /* SPDX-License-Identifier: GPL-2.0-or-later
2 * Copyright (c) 2010-2024 Linux Test Project
3 * Copyright (c) 2011-2015 Cyril Hrubis <[email protected]>
4 */
5
6 #ifndef TST_SAFE_MACROS_H__
7 #define TST_SAFE_MACROS_H__
8
9 #include <stdlib.h>
10 #include <sys/mman.h>
11 #include <sys/types.h>
12 #include <sys/time.h>
13 #include <sys/resource.h>
14 #include <sys/stat.h>
15 #include <sys/vfs.h>
16 #include <sys/sysinfo.h>
17 #include <fcntl.h>
18 #include <libgen.h>
19 #include <signal.h>
20 #include <stdarg.h>
21 #include <unistd.h>
22 #include <dirent.h>
23 #include <grp.h>
24
25 #include "safe_stdio_fn.h"
26 #include "safe_macros_fn.h"
27 #include "tst_cmd.h"
28 #include "tst_safe_macros_inline.h"
29
30 int safe_access(const char *filename, const int lineno, const char *pathname,
31 int mode);
32 #define SAFE_ACCESS(path, mode) \
33 safe_access(__FILE__, __LINE__, (path), (mode))
34
35 #define SAFE_BASENAME(path) \
36 safe_basename(__FILE__, __LINE__, NULL, (path))
37
38 #define SAFE_CHDIR(path) \
39 safe_chdir(__FILE__, __LINE__, NULL, (path))
40
41 #define SAFE_CLOSE(fd) do { \
42 safe_close(__FILE__, __LINE__, NULL, (fd)); \
43 fd = -1; \
44 } while (0)
45
46 #define SAFE_CREAT(pathname, mode) \
47 safe_creat(__FILE__, __LINE__, NULL, (pathname), (mode))
48
49 #define SAFE_CHROOT(path) \
50 safe_chroot(__FILE__, __LINE__, (path))
51 int safe_chroot(const char *file, const int lineno, const char *path);
52
53 #define SAFE_DIRNAME(path) \
54 safe_dirname(__FILE__, __LINE__, NULL, (path))
55
56 int safe_dup(const char *file, const int lineno, int oldfd);
57
58 #define SAFE_DUP(oldfd) \
59 safe_dup(__FILE__, __LINE__, (oldfd))
60
61 int safe_dup2(const char *file, const int lineno, int oldfd, int newfd);
62
63 #define SAFE_DUP2(oldfd, newfd) \
64 safe_dup2(__FILE__, __LINE__, (oldfd), (newfd))
65
66 #define SAFE_GETCWD(buf, size) \
67 safe_getcwd(__FILE__, __LINE__, NULL, (buf), (size))
68
69 #define SAFE_GETPWNAM(name) \
70 safe_getpwnam(__FILE__, __LINE__, NULL, (name))
71
72 #define SAFE_GETRUSAGE(who, usage) \
73 safe_getrusage(__FILE__, __LINE__, NULL, (who), (usage))
74
75 #define SAFE_MALLOC(size) \
76 safe_malloc(__FILE__, __LINE__, NULL, (size))
77
78 void *safe_calloc(const char *file, const int lineno, size_t nmemb, size_t size);
79
80 #define SAFE_CALLOC(nmemb, size) \
81 safe_calloc(__FILE__, __LINE__, (nmemb), (size))
82
83 void *safe_realloc(const char *file, const int lineno, void *ptr, size_t size);
84
85 #define SAFE_REALLOC(ptr, size) \
86 safe_realloc(__FILE__, __LINE__, (ptr), (size))
87
88 #define SAFE_MKDIR(pathname, mode) \
89 safe_mkdir(__FILE__, __LINE__, NULL, (pathname), (mode))
90
91 #define SAFE_RMDIR(pathname) \
92 safe_rmdir(__FILE__, __LINE__, NULL, (pathname))
93
94 #define SAFE_MUNMAP(addr, length) \
95 safe_munmap(__FILE__, __LINE__, NULL, (addr), (length))
96
97 int safe_msync(const char *file, const int lineno, void *addr,
98 size_t length, int flags);
99
100 #define SAFE_MSYNC(addr, length, flags) \
101 safe_msync(__FILE__, __LINE__, (addr), (length), (flags))
102
103 #define SAFE_OPEN(pathname, oflags, ...) \
104 safe_open(__FILE__, __LINE__, NULL, (pathname), (oflags), \
105 ##__VA_ARGS__)
106
107 #define SAFE_PIPE(fildes) \
108 safe_pipe(__FILE__, __LINE__, NULL, (fildes))
109
110 int safe_pipe2(const char *file, const int lineno, int fildes[2], int flags);
111
112 #define SAFE_PIPE2(fildes, flags) \
113 safe_pipe2(__FILE__, __LINE__, (fildes), (flags))
114
115 #define SAFE_READ(len_strict, fildes, buf, nbyte) \
116 safe_read(__FILE__, __LINE__, NULL, (len_strict), (fildes), (buf), (nbyte))
117
118 #define SAFE_SETEGID(egid) \
119 safe_setegid(__FILE__, __LINE__, NULL, (egid))
120
121 #define SAFE_SETEUID(euid) \
122 safe_seteuid(__FILE__, __LINE__, NULL, (euid))
123
124 #define SAFE_SETGID(gid) \
125 safe_setgid(__FILE__, __LINE__, NULL, (gid))
126
127 #define SAFE_SETUID(uid) \
128 safe_setuid(__FILE__, __LINE__, NULL, (uid))
129
130 int safe_setregid(const char *file, const int lineno,
131 gid_t rgid, gid_t egid);
132
133 #define SAFE_SETREGID(rgid, egid) \
134 safe_setregid(__FILE__, __LINE__, (rgid), (egid))
135
136 int safe_setreuid(const char *file, const int lineno,
137 uid_t ruid, uid_t euid);
138
139 #define SAFE_SETREUID(ruid, euid) \
140 safe_setreuid(__FILE__, __LINE__, (ruid), (euid))
141
142 int safe_setresgid(const char *file, const int lineno,
143 gid_t rgid, gid_t egid, gid_t sgid);
144 #define SAFE_SETRESGID(rgid, egid, sgid) \
145 safe_setresgid(__FILE__, __LINE__, (rgid), (egid), (sgid))
146
147 int safe_setresuid(const char *file, const int lineno,
148 uid_t ruid, uid_t euid, uid_t suid);
149 #define SAFE_SETRESUID(ruid, euid, suid) \
150 safe_setresuid(__FILE__, __LINE__, (ruid), (euid), (suid))
151
152 #define SAFE_GETRESUID(ruid, euid, suid) \
153 safe_getresuid(__FILE__, __LINE__, NULL, (ruid), (euid), (suid))
154
155 #define SAFE_GETRESGID(rgid, egid, sgid) \
156 safe_getresgid(__FILE__, __LINE__, NULL, (rgid), (egid), (sgid))
157
158 int safe_setpgid(const char *file, const int lineno, pid_t pid, pid_t pgid);
159
160 #define SAFE_SETPGID(pid, pgid) \
161 safe_setpgid(__FILE__, __LINE__, (pid), (pgid))
162
163 pid_t safe_getpgid(const char *file, const int lineno, pid_t pid);
164
165 #define SAFE_GETPGID(pid) \
166 safe_getpgid(__FILE__, __LINE__, (pid))
167
168 int safe_setgroups(const char *file, const int lineno, size_t size, const gid_t *list);
169
170 #define SAFE_SETGROUPS(size, list) \
171 safe_setgroups(__FILE__, __LINE__, (size), (list))
172
173 int safe_getgroups(const char *file, const int lineno, int size, gid_t list[]);
174
175 #define SAFE_GETGROUPS(size, list) \
176 safe_getgroups(__FILE__, __LINE__, (size), (list))
177
178 #define SAFE_UNLINK(pathname) \
179 safe_unlink(__FILE__, __LINE__, NULL, (pathname))
180
181 #define SAFE_LINK(oldpath, newpath) \
182 safe_link(__FILE__, __LINE__, NULL, (oldpath), (newpath))
183
184 #define SAFE_LINKAT(olddirfd, oldpath, newdirfd, newpath, flags) \
185 safe_linkat(__FILE__, __LINE__, NULL, (olddirfd), (oldpath), \
186 (newdirfd), (newpath), (flags))
187
188 #define SAFE_READLINK(path, buf, bufsize) \
189 safe_readlink(__FILE__, __LINE__, NULL, (path), (buf), (bufsize))
190
191 #define SAFE_SYMLINK(oldpath, newpath) \
192 safe_symlink(__FILE__, __LINE__, NULL, (oldpath), (newpath))
193
194 #define SAFE_WRITE(len_strict, fildes, buf, nbyte) \
195 safe_write(__FILE__, __LINE__, NULL, (len_strict), (fildes), (buf), (nbyte))
196
197 #define SAFE_STRTOL(str, min, max) \
198 safe_strtol(__FILE__, __LINE__, NULL, (str), (min), (max))
199
200 #define SAFE_STRTOUL(str, min, max) \
201 safe_strtoul(__FILE__, __LINE__, NULL, (str), (min), (max))
202
203 #define SAFE_STRTOF(str, min, max) \
204 safe_strtof(__FILE__, __LINE__, NULL, (str), (min), (max))
205
206 #define SAFE_SYSCONF(name) \
207 safe_sysconf(__FILE__, __LINE__, NULL, name)
208
209 #define SAFE_CHMOD(path, mode) \
210 safe_chmod(__FILE__, __LINE__, NULL, (path), (mode))
211
212 #define SAFE_FCHMOD(fd, mode) \
213 safe_fchmod(__FILE__, __LINE__, NULL, (fd), (mode))
214
215 #define SAFE_CHOWN(path, owner, group) \
216 safe_chown(__FILE__, __LINE__, NULL, (path), (owner), (group))
217
218 #define SAFE_FCHOWN(fd, owner, group) \
219 safe_fchown(__FILE__, __LINE__, NULL, (fd), (owner), (group))
220
221 #define SAFE_WAIT(status) \
222 safe_wait(__FILE__, __LINE__, NULL, (status))
223
224 #define SAFE_WAITPID(pid, status, opts) \
225 safe_waitpid(__FILE__, __LINE__, NULL, (pid), (status), (opts))
226
227 #define SAFE_KILL(pid, sig) \
228 safe_kill(__FILE__, __LINE__, NULL, (pid), (sig))
229
230 #define SAFE_MEMALIGN(alignment, size) \
231 safe_memalign(__FILE__, __LINE__, NULL, (alignment), (size))
232
233 #define SAFE_MKFIFO(pathname, mode) \
234 safe_mkfifo(__FILE__, __LINE__, NULL, (pathname), (mode))
235
236 #define SAFE_RENAME(oldpath, newpath) \
237 safe_rename(__FILE__, __LINE__, NULL, (oldpath), (newpath))
238
239 #define SAFE_MOUNT(source, target, filesystemtype, \
240 mountflags, data) \
241 safe_mount(__FILE__, __LINE__, NULL, (source), (target), \
242 (filesystemtype), (mountflags), (data))
243
244 #define SAFE_UMOUNT(target) \
245 safe_umount(__FILE__, __LINE__, NULL, (target))
246
247 #define SAFE_OPENDIR(name) \
248 safe_opendir(__FILE__, __LINE__, NULL, (name))
249
250 #define SAFE_CLOSEDIR(dirp) \
251 safe_closedir(__FILE__, __LINE__, NULL, (dirp))
252
253 #define SAFE_READDIR(dirp) \
254 safe_readdir(__FILE__, __LINE__, NULL, (dirp))
255
256 #define SAFE_IOCTL_(file, lineno, fd, request, ...) \
257 ({int tst_ret_ = ioctl(fd, request, ##__VA_ARGS__); \
258 tst_ret_ < 0 ? \
259 tst_brk_((file), (lineno), TBROK | TERRNO, \
260 "ioctl(%i,%s,...) failed", fd, #request), 0 \
261 : tst_ret_;})
262
263 #define SAFE_IOCTL(fd, request, ...) \
264 SAFE_IOCTL_(__FILE__, __LINE__, (fd), (request), ##__VA_ARGS__)
265
266 #define SAFE_FCNTL(fd, cmd, ...) \
267 ({int tst_ret_ = fcntl(fd, cmd, ##__VA_ARGS__); \
268 tst_ret_ == -1 ? \
269 tst_brk(TBROK | TERRNO, \
270 "fcntl(%i,%s,...) failed", fd, #cmd), 0 \
271 : tst_ret_;})
272
273 void tst_prot_to_str(const int prot, char *buf);
274
safe_mmap(const char * file,const int lineno,void * addr,size_t length,int prot,int flags,int fd,off_t offset)275 static inline void *safe_mmap(const char *file, const int lineno,
276 void *addr, size_t length, int prot, int flags, int fd, off_t offset)
277 {
278 void *rval;
279 char prot_buf[512];
280
281 tst_prot_to_str(prot, prot_buf);
282
283 tst_res_(file, lineno, TDEBUG,
284 "mmap(%p, %zu, %s(%x), %d, %d, %ld)",
285 addr, length, prot_buf, prot, flags, fd, offset);
286
287 rval = mmap(addr, length, prot, flags, fd, offset);
288 if (rval == MAP_FAILED) {
289 tst_brk_(file, lineno, TBROK | TERRNO,
290 "mmap(%p,%zu,%s(%x),%d,%d,%ld) failed",
291 addr, length, prot_buf, prot, flags, fd, (long) offset);
292 }
293
294 return rval;
295 }
296
297
298 #define SAFE_MMAP(addr, length, prot, flags, fd, offset) \
299 safe_mmap(__FILE__, __LINE__, (addr), (length), (prot), \
300 (flags), (fd), (offset))
301
302 int safe_mprotect(const char *file, const int lineno,
303 char *addr, size_t len, int prot);
304
305 #define SAFE_MPROTECT(addr, len, prot) \
306 safe_mprotect(__FILE__, __LINE__, (addr), (len), (prot))
307
308 typedef void (*sighandler_t)(int);
309 sighandler_t safe_signal(const char *file, const int lineno,
310 int signum, sighandler_t handler);
311
312 #define SAFE_SIGNAL(signum, handler) \
313 safe_signal(__FILE__, __LINE__, (signum), (handler))
314
315 int safe_sigaction(const char *file, const int lineno,
316 int signum, const struct sigaction *act,
317 struct sigaction *oldact);
318 #define SAFE_SIGACTION(signum, act, oldact) \
319 safe_sigaction(__FILE__, __LINE__, (signum), (act), (oldact))
320
321 int safe_sigaddset(const char *file, const int lineno,
322 sigset_t *sigs, int signo);
323 #define SAFE_SIGADDSET(sigs, signo) \
324 safe_sigaddset(__FILE__, __LINE__, (sigs), (signo))
325
326 int safe_sigdelset(const char *file, const int lineno,
327 sigset_t *sigs, int signo);
328 #define SAFE_SIGDELSET(sigs, signo) \
329 safe_sigdelset(__FILE__, __LINE__, (sigs), (signo))
330
331 int safe_sigemptyset(const char *file, const int lineno,
332 sigset_t *sigs);
333 #define SAFE_SIGEMPTYSET(sigs) \
334 safe_sigemptyset(__FILE__, __LINE__, (sigs))
335
336 int safe_sigfillset(const char *file, const int lineno,
337 sigset_t *sigs);
338 #define SAFE_SIGFILLSET(sigs) \
339 safe_sigfillset(__FILE__, __LINE__, (sigs))
340
341 int safe_sigprocmask(const char *file, const int lineno,
342 int how, sigset_t *set, sigset_t *oldset);
343 #define SAFE_SIGPROCMASK(how, set, oldset) \
344 safe_sigprocmask(__FILE__, __LINE__, (how), (set), (oldset))
345
346 int safe_sigwait(const char *file, const int lineno,
347 sigset_t *set, int *sig);
348 #define SAFE_SIGWAIT(set, sig) \
349 safe_sigwait(__FILE__, __LINE__, (set), (sig))
350
351 #define SAFE_EXECLP(file, arg, ...) do { \
352 execlp((file), (arg), ##__VA_ARGS__); \
353 tst_brk_(__FILE__, __LINE__, TBROK | TERRNO, \
354 "execlp(%s, %s, ...) failed", file, arg); \
355 } while (0)
356
357 #define SAFE_EXECL(file, arg, ...) do { \
358 execl((file), (arg), ##__VA_ARGS__); \
359 tst_brk_(__FILE__, __LINE__, TBROK | TERRNO, \
360 "execl(%s, %s, ...) failed", file, arg); \
361 } while (0)
362
363 #define SAFE_EXECVP(file, arg) do { \
364 execvp((file), (arg)); \
365 tst_brk_(__FILE__, __LINE__, TBROK | TERRNO, \
366 "execvp(%s, %p) failed", file, arg); \
367 } while (0)
368
369 int safe_getpriority(const char *file, const int lineno, int which, id_t who);
370 #define SAFE_GETPRIORITY(which, who) \
371 safe_getpriority(__FILE__, __LINE__, (which), (who))
372
373 struct group *safe_getgrnam(const char *file, const int lineno,
374 const char *name);
375 #define SAFE_GETGRNAM(name) \
376 safe_getgrnam(__FILE__, __LINE__, (name))
377
378 struct group *safe_getgrnam_fallback(const char *file, const int lineno,
379 const char *name, const char *fallback);
380 #define SAFE_GETGRNAM_FALLBACK(name, fallback) \
381 safe_getgrnam_fallback(__FILE__, __LINE__, (name), (fallback))
382
383 struct group *safe_getgrgid(const char *file, const int lineno, gid_t gid);
384 #define SAFE_GETGRGID(gid) \
385 safe_getgrgid(__FILE__, __LINE__, (gid))
386
387 ssize_t safe_getxattr(const char *file, const int lineno, const char *path,
388 const char *name, void *value, size_t size);
389 #define SAFE_GETXATTR(path, name, value, size) \
390 safe_getxattr(__FILE__, __LINE__, (path), (name), (value), (size))
391
392 int safe_setxattr(const char *file, const int lineno, const char *path,
393 const char *name, const void *value, size_t size, int flags);
394 #define SAFE_SETXATTR(path, name, value, size, flags) \
395 safe_setxattr(__FILE__, __LINE__, (path), (name), (value), (size), (flags))
396
397 int safe_lsetxattr(const char *file, const int lineno, const char *path,
398 const char *name, const void *value, size_t size, int flags);
399 #define SAFE_LSETXATTR(path, name, value, size, flags) \
400 safe_lsetxattr(__FILE__, __LINE__, (path), (name), (value), (size), (flags))
401
402 int safe_fsetxattr(const char *file, const int lineno, int fd, const char *name,
403 const void *value, size_t size, int flags);
404 #define SAFE_FSETXATTR(fd, name, value, size, flags) \
405 safe_fsetxattr(__FILE__, __LINE__, (fd), (name), (value), (size), (flags))
406
407 int safe_removexattr(const char *file, const int lineno, const char *path,
408 const char *name);
409 #define SAFE_REMOVEXATTR(path, name) \
410 safe_removexattr(__FILE__, __LINE__, (path), (name))
411
412 int safe_lremovexattr(const char *file, const int lineno, const char *path,
413 const char *name);
414 #define SAFE_LREMOVEXATTR(path, name) \
415 safe_lremovexattr(__FILE__, __LINE__, (path), (name))
416
417 int safe_fremovexattr(const char *file, const int lineno, int fd,
418 const char *name);
419 #define SAFE_FREMOVEXATTR(fd, name) \
420 safe_fremovexattr(__FILE__, __LINE__, (fd), (name))
421
422 int safe_fsync(const char *file, const int lineno, int fd);
423 #define SAFE_FSYNC(fd) safe_fsync(__FILE__, __LINE__, (fd))
424
425 int safe_setsid(const char *file, const int lineno);
426 #define SAFE_SETSID() safe_setsid(__FILE__, __LINE__)
427
428 int safe_mknod(const char *file, const int lineno, const char *pathname,
429 mode_t mode, dev_t dev);
430 #define SAFE_MKNOD(pathname, mode, dev) \
431 safe_mknod(__FILE__, __LINE__, (pathname), (mode), (dev))
432
433 int safe_mlock(const char *file, const int lineno, const char *addr,
434 size_t len);
435 #define SAFE_MLOCK(addr, len) safe_mlock(__FILE__, __LINE__, (addr), (len))
436
437 int safe_munlock(const char *file, const int lineno, const char *addr,
438 size_t len);
439 #define SAFE_MUNLOCK(addr, len) safe_munlock(__FILE__, __LINE__, (addr), (len))
440
441 int safe_mincore(const char *file, const int lineno, void *start,
442 size_t length, unsigned char *vec);
443 #define SAFE_MINCORE(start, length, vec) \
444 safe_mincore(__FILE__, __LINE__, (start), (length), (vec))
445
446 int safe_personality(const char *filename, unsigned int lineno,
447 unsigned long persona);
448 #define SAFE_PERSONALITY(persona) safe_personality(__FILE__, __LINE__, persona)
449
450 int safe_pidfd_open(const char *filename, const int lineno, pid_t pid,
451 unsigned int flags);
452 #define SAFE_PIDFD_OPEN(pid, flags) \
453 safe_pidfd_open(__FILE__, __LINE__, (pid), (flags))
454
455 #define SAFE_SETENV(name, value, overwrite) do { \
456 if (setenv(name, value, overwrite)) { \
457 tst_brk_(__FILE__, __LINE__, TBROK | TERRNO, \
458 "setenv(%s, %s, %d) failed", \
459 name, value, overwrite); \
460 } \
461 } while (0)
462
463 int safe_unshare(const char *file, const int lineno, int flags);
464 #define SAFE_UNSHARE(flags) safe_unshare(__FILE__, __LINE__, (flags))
465
466 int safe_setns(const char *file, const int lineno, int fd, int nstype);
467 #define SAFE_SETNS(fd, nstype) safe_setns(__FILE__, __LINE__, (fd), (nstype))
468
469 /*
470 * SAFE_CMD() is a wrapper for tst_cmd(). It runs a command passed via argv[]
471 * and handles non-zero exit (exits with 'TBROK') and 'ENOENT' (the program not
472 * in '$PATH', exits with 'TCONF').
473 *
474 * @param argv[] a 'NULL' terminated array of strings starting with the program
475 * name which is followed by optional arguments.
476 * @param stdout_path: path where to redirect stdout. Set NULL if redirection is
477 * not needed.
478 * @param stderr_path: path where to redirect stderr. Set NULL if redirection is
479 * not needed.
480 */
481 void safe_cmd(const char *file, const int lineno, const char *const argv[],
482 const char *stdout_path, const char *stderr_path);
483 #define SAFE_CMD(argv, stdout_path, stderr_path) \
484 safe_cmd(__FILE__, __LINE__, (argv), (stdout_path), (stderr_path))
485 /*
486 * SAFE_PTRACE() treats any non-zero return value as error. Don't use it
487 * for requests like PTRACE_PEEK* or PTRACE_SECCOMP_GET_FILTER which use
488 * the return value to pass arbitrary data.
489 */
490 long tst_safe_ptrace(const char *file, const int lineno, int req, pid_t pid,
491 void *addr, void *data);
492 #define SAFE_PTRACE(req, pid, addr, data) \
493 tst_safe_ptrace(__FILE__, __LINE__, req, pid, addr, data)
494
495 int safe_sysinfo(const char *file, const int lineno, struct sysinfo *info);
496 #define SAFE_SYSINFO(info) \
497 safe_sysinfo(__FILE__, __LINE__, (info))
498
499 void safe_print_file(const char *file, const int lineno, char *path);
500
501 int safe_sscanf(const char *file, const int lineno, const char *restrict buffer,
502 const char *restrict format, ...);
503 #define SAFE_SSCANF(buffer, format, ...) \
504 safe_sscanf(__FILE__, __LINE__, (buffer), (format), ##__VA_ARGS__)
505
506 #endif /* TST_SAFE_MACROS_H__ */
507