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