xref: /linux/include/uapi/linux/openat2.h (revision d0034a7a4ac7fae708146ac0059b9c47a1543f0d)
1fddb5d43SAleksa Sarai /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2fddb5d43SAleksa Sarai #ifndef _UAPI_LINUX_OPENAT2_H
3fddb5d43SAleksa Sarai #define _UAPI_LINUX_OPENAT2_H
4fddb5d43SAleksa Sarai 
5fddb5d43SAleksa Sarai #include <linux/types.h>
6fddb5d43SAleksa Sarai 
7fddb5d43SAleksa Sarai /*
8fddb5d43SAleksa Sarai  * Arguments for how openat2(2) should open the target path. If only @flags and
9fddb5d43SAleksa Sarai  * @mode are non-zero, then openat2(2) operates very similarly to openat(2).
10fddb5d43SAleksa Sarai  *
11fddb5d43SAleksa Sarai  * However, unlike openat(2), unknown or invalid bits in @flags result in
12fddb5d43SAleksa Sarai  * -EINVAL rather than being silently ignored. @mode must be zero unless one of
13fddb5d43SAleksa Sarai  * {O_CREAT, O_TMPFILE} are set.
14fddb5d43SAleksa Sarai  *
15fddb5d43SAleksa Sarai  * @flags: O_* flags.
16fddb5d43SAleksa Sarai  * @mode: O_CREAT/O_TMPFILE file mode.
17fddb5d43SAleksa Sarai  * @resolve: RESOLVE_* flags.
18fddb5d43SAleksa Sarai  */
19fddb5d43SAleksa Sarai struct open_how {
20fddb5d43SAleksa Sarai 	__u64 flags;
21fddb5d43SAleksa Sarai 	__u64 mode;
22fddb5d43SAleksa Sarai 	__u64 resolve;
23fddb5d43SAleksa Sarai };
24fddb5d43SAleksa Sarai 
25fddb5d43SAleksa Sarai /* how->resolve flags for openat2(2). */
26fddb5d43SAleksa Sarai #define RESOLVE_NO_XDEV		0x01 /* Block mount-point crossings
27fddb5d43SAleksa Sarai 					(includes bind-mounts). */
28fddb5d43SAleksa Sarai #define RESOLVE_NO_MAGICLINKS	0x02 /* Block traversal through procfs-style
29fddb5d43SAleksa Sarai 					"magic-links". */
30fddb5d43SAleksa Sarai #define RESOLVE_NO_SYMLINKS	0x04 /* Block traversal through all symlinks
31fddb5d43SAleksa Sarai 					(implies OEXT_NO_MAGICLINKS) */
32fddb5d43SAleksa Sarai #define RESOLVE_BENEATH		0x08 /* Block "lexical" trickery like
33fddb5d43SAleksa Sarai 					"..", symlinks, and absolute
34fddb5d43SAleksa Sarai 					paths which escape the dirfd. */
35fddb5d43SAleksa Sarai #define RESOLVE_IN_ROOT		0x10 /* Make all jumps to "/" and ".."
36fddb5d43SAleksa Sarai 					be scoped inside the dirfd
37fddb5d43SAleksa Sarai 					(similar to chroot(2)). */
38*99668f61SJens Axboe #define RESOLVE_CACHED		0x20 /* Only complete if resolution can be
39*99668f61SJens Axboe 					completed through cached lookup. May
40*99668f61SJens Axboe 					return -EAGAIN if that's not
41*99668f61SJens Axboe 					possible. */
42fddb5d43SAleksa Sarai 
43fddb5d43SAleksa Sarai #endif /* _UAPI_LINUX_OPENAT2_H */
44