doc:kmsg: explictly state the return value in case of SEEK_CUR
PATCH v2 1/1 doc:kmsg: explictly state the return value in case of SEEK_CUR
The commit 625d3449788f ("Revert "kernel/printk: add kmsg SEEK_CUR handling"") reverted a change done to the return value in case a SEEK_CUR operation was performed for kmsg buffer based on the fact that different userspace apps were handling the new return value (-ESPIPE) in different ways, breaking them.
At the same time -ESPIPE was the wrong decision because kmsg /does support/ seek() but doesn't follow the "normal" behavior userspace is used to. Because of that and also considering the time -EINVAL has been used, it was decided to keep this way to avoid more userspace breakage.
This patch adds an official statement to the kmsg documentation pointing to the current return value for SEEK_CUR, -EINVAL, thus userspace libraries and apps can refer to it for a definitive guide on what to expect.
---
Changelog:
v2:
- Changed wording to Documentation/ file and also added some doc directly to the code (suggested by Petr)
Documentation/ABI/testing/dev-kmsg | 11 +++++++++++ kernel/printk/printk.c | 8 ++++++++ 2 files changed, 19 insertions(+)
Documentation/ABI/testing/dev-kmsg +11 -0
@@ -56,6 +56,17 @@ Description: The /dev/kmsg character device node provides userspace access seek after the last record available at the time the last SYSLOG_ACTION_CLEAR was issued. + Other seek operations or offsets are not supported because of + the special behavior this device has. The device allows to read + or write only whole variable lenght messages (records) that are + stored in a ring buffer. + + Because of the non-standard behavior also the error values are + non-standard. -ESPIPE is returned for non-zero offset. -EINVAL + is returned for other operations, e.g. SEEK_CUR. This behavior + and values are historical and could not be modified without the + risk of breaking userspace. + The output format consists of a prefix carrying the syslog prefix including priority and facility, the 64 bit message sequence number and the monotonic timestamp in microseconds,
kernel/printk/printk.c +8 -0
@@ -943,6 +943,14 @@ static ssize_t devkmsg_read(struct file *file, char __user *buf,return ret; } +/* +* Be careful when modifying this function!!! +* +* Only few operations are supported because the device works only with the +* entire variable length messages (records). Non-standard values are +* returned in the other cases and has been this way for quite some time. +* User space applications might depend on this behavior. +*/ static loff_t devkmsg_llseek (struct file *file,loff_t offset,int whence) {struct devkmsg_user *user = file->private_data;
Signature · 1 line
2.26.2
Quoted 11 lines · Bruno Meneguele
The commit
625d3449788f("Revert "kernel/printk: add kmsgSEEK_CURhandling"") reverted a change done to the return value in case aSEEK_CURoperation was performed for kmsg buffer based on the fact that different userspace apps were handling the new return value (-ESPIPE) in different ways, breaking them.At the same time
-ESPIPEwas the wrong decision because kmsg /does support/seek()but doesn't follow the "normal" behavior userspace is used to. Because of that and also considering the time-EINVALhas been used, it was decided to keep this way to avoid more userspace breakage.
Quoted 5 lines
This patch adds an official statement to the kmsg documentation pointing to the current return value for
SEEK_CUR,-EINVAL, thus userspace libraries and apps can refer to it for a definitive guide on what to expect.Signed-off-by Bruno Meneguele <[email protected]>
Looks good to me,
-ss
Petr Mladek
maintainerQuoted 12 lines · Sergey Senozhatsky
Quoted 11 lines · Bruno Meneguele
The commit
625d3449788f("Revert "kernel/printk: add kmsgSEEK_CURhandling"") reverted a change done to the return value in case aSEEK_CURoperation was performed for kmsg buffer based on the fact that different userspace apps were handling the new return value (-ESPIPE) in different ways, breaking them.At the same time
-ESPIPEwas the wrong decision because kmsg /does support/seek()but doesn't follow the "normal" behavior userspace is used to. Because of that and also considering the time-EINVALhas been used, it was decided to keep this way to avoid more userspace breakage.
Quoted 8 lines
Quoted 5 lines
This patch adds an official statement to the kmsg documentation pointing to the current return value for
SEEK_CUR,-EINVAL, thus userspace libraries and apps can refer to it for a definitive guide on what to expect.Signed-off-by Bruno Meneguele <[email protected]>Looks good to me,
Reviewed-by Sergey Senozhatsky <[email protected]>
The patch is committed in printk/linux.git, branch for-5.9.
Thanks for v2.
Best Regards,
Petr
Quoted 22 lines · Petr Mladek
Quoted 12 lines · Sergey Senozhatsky
Quoted 11 lines · Bruno Meneguele
The commit
625d3449788f("Revert "kernel/printk: add kmsgSEEK_CURhandling"") reverted a change done to the return value in case aSEEK_CURoperation was performed for kmsg buffer based on the fact that different userspace apps were handling the new return value (-ESPIPE) in different ways, breaking them.At the same time
-ESPIPEwas the wrong decision because kmsg /does support/seek()but doesn't follow the "normal" behavior userspace is used to. Because of that and also considering the time-EINVALhas been used, it was decided to keep this way to avoid more userspace breakage.Quoted 8 lines
Quoted 5 lines
This patch adds an official statement to the kmsg documentation pointing to the current return value for
SEEK_CUR,-EINVAL, thus userspace libraries and apps can refer to it for a definitive guide on what to expect.Signed-off-by Bruno Meneguele <[email protected]>Looks good to me,
Reviewed-by Sergey Senozhatsky <[email protected]>
Quoted 7 lines
The patch is committed in printk/linux.git, branch for-5.9.
Thanks for v2.
Best Regards,
Petr
Thanks Sergey and Petr.
Signature · 2 lines
bmeneg PGP Key: http://bmeneg.com/pubkey.txt