Skip to contentSkip to conversation

man2/openat2.2: add RESOLVE_CACHED

PATCH Superseded Jens Axboe 2 participants 3 messages Feb 20, 2021 – Feb 21, 2021 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Jens Axboe

author
#0 lore raw

PATCH v2 1/1 man2/openat2.2: add RESOLVE_CACHED

RESOLVE_CACHED allows an application to attempt a cache-only open of a file. If this isn't possible, the request will fail with -1/EAGAIN and the caller should retry without RESOLVE_CACHED set. This will generally happen from a different context, where a slower open operation can be performed.

---

Sending a v2 of this one, as the kernel side patches are queued up for 5.12 inclusion.

man2/openat2.2 +19 -0
index 3bda20620574..37e70c43de6d 100644
@@ -385,6 +385,17 @@ This may occur if, for example,
 a system pathname that is used by an application is modified
 (e.g., in a new distribution release)
 so that a pathname component (now) contains a bind mount.
+.TP
+.B RESOLVE_CACHED
+Make the open operation fail unless all path components are already present
+in the kernels lookup cache.
+If any kind of revalidation or I/O is needed to satisfy the lookup,
+.BR openat2 ()
+fails with the error
+.B EAGAIN.
+This is useful in providing a fast path open that can be performed without
+resorting to thread offload, or other mechanisms that an application might
+use to offload slower operations.
 .RE
 .IP
 If any bits other than those listed above are set in
@@ -421,6 +432,14 @@ The caller may choose to retry the
 .BR openat2 ()
 call.
 .TP
+.B EAGAIN
+.BR RESOLVE_CACHED
+was set, and the open operation cannot be performed cached.
+The caller should retry without
+.B RESOLVE_CACHED
+set in
+.I how.resolve
+.TP
 .B EINVAL
 An unknown flag or invalid value was specified in
 .IR how .
Signature · 1 line
Jens Axboe
#1 lore raw

Hello Jens

Thanks for the revised patch. Just some minor comments below.

Quoted 18 lines · Jens Axboe

RESOLVE_CACHED allows an application to attempt a cache-only open of a file. If this isn't possible, the request will fail with -1/EAGAIN and the caller should retry without RESOLVE_CACHED set. This will generally happen from a different context, where a slower open operation can be performed.

---

Sending a v2 of this one, as the kernel side patches are queued up for 5.12 inclusion.

man2/openat2.2 +0 -0
index 3bda20620574..37e70c43de6d 100644

man2/openat2.2 This may occur if, for example, · line 391

Quoted 7 lines
man2/openat2.2 +4 -0
@@ -385,6 +385,17 @@ This may occur if, for example,
 a system pathname that is used by an application is modified
 (e.g., in a new distribution release)
 so that a pathname component (now) contains a bind mount.
+.TP
+.B RESOLVE_CACHED
+Make the open operation fail unless all path components are already present
+in the kernels lookup cache.

s/kernels/kernel's/

man2/openat2.2 This may occur if, for example, · line 395

Quoted 4 lines
man2/openat2.2 +4 -0
+If any kind of revalidation or I/O is needed to satisfy the lookup,
+.BR openat2 ()
+fails with the error
+.B EAGAIN.

.BR EAGAIN .

man2/openat2.2 This may occur if, for example, · line 396

Quoted 1 line
man2/openat2.2 +1 -0
+This is useful in providing a fast path open that can be performed without

s/fast path open/fast-path open/

man2/openat2.2 The caller may choose to retry the · line 437

Quoted 12 lines
man2/openat2.2 +5 -0
+resorting to thread offload, or other mechanisms that an application might
+use to offload slower operations.
 .RE
 .IP
 If any bits other than those listed above are set in
@@ -421,6 +432,14 @@ The caller may choose to retry the
 .BR openat2 ()
 call.
 .TP
+.B EAGAIN
+.BR RESOLVE_CACHED
+was set, and the open operation cannot be performed cached.

Maybe:
s/cached
/using only cached information/
?

man2/openat2.2 The caller may choose to retry the · line 441

Quoted 4 lines
man2/openat2.2 +4 -0
+The caller should retry without
+.B RESOLVE_CACHED
+set in
+.I how.resolve

.IR how.resolve .

man2/openat2.2 The caller may choose to retry the · line 445

Quoted 4 lines
man2/openat2.2 +1 -0
+.TP
 .B EINVAL
 An unknown flag or invalid value was specified in
 .IR how .

Thanks,

Michael

Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
author
#2 lore raw
Quoted 3 lines · Michael Kerrisk (man-pages)

Hello Jens

Thanks for the revised patch. Just some minor comments below.

Thanks, all look good to me. I'll send out v3.

Signature · 1 line
Jens Axboe