]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
printk_ringbuffer: Fix get_data() size sanity check
authorJohn Ogness <john.ogness@linutronix.de>
Thu, 26 Mar 2026 13:38:01 +0000 (14:44 +0106)
committerPetr Mladek <pmladek@suse.com>
Fri, 27 Mar 2026 16:12:37 +0000 (17:12 +0100)
Commit cc3bad11de6e ("printk_ringbuffer: Fix check of valid data
size when blk_lpos overflows") added sanity checking to get_data()
to avoid returning data of illegal sizes (too large or too small).
It uses the helper function data_check_size() for the check.
However, data_check_size() expects the size of the data, not the
size of the data block. get_data() is providing the size of the
data block.  This means that if the data size (text_buf_size) is
at or near the maximum legal size:

sizeof(prb_data_block) + text_buf_size == DATA_SIZE(data_ring) / 2

data_check_size() will report failure because it adds
sizeof(prb_data_block) to the provided size. The sanity check in
get_data() is counting the data block header twice. The result is
that the reader fails to read the legal record.

Since get_data() subtracts the data block header size before returning,
move the sanity check to after the subtraction.

Luckily printk() is not vulnerable to this problem because
truncate_msg() limits printk-messages to 1/4 of the ringbuffer.
Indeed, by adjusting the printk_ringbuffer KUnit test, which does not
use printk() and its truncate_msg() check, it is easy to see that the
reader fails and the WARN_ON is triggered.

Fixes: cc3bad11de6e ("printk_ringbuffer: Fix check of valid data size when blk_lpos overflows")
Signed-off-by: John Ogness <john.ogness@linutronix.de>
Reviewed-by: Petr Mladek <pmladek@suse.com>
Tested-by: Petr Mladek <pmladek@suse.com>
Link: https://patch.msgid.link/20260326133809.8045-1-john.ogness@linutronix.de
Signed-off-by: Petr Mladek <pmladek@suse.com>
kernel/printk/printk_ringbuffer.c

index 56c8e3d031f4984e2edc6d47d542d09591bd9d9d..a3526bdd4e10d413d77bdedb2c27b2a0c017f6ad 100644 (file)
@@ -1302,10 +1302,6 @@ static const char *get_data(struct prb_data_ring *data_ring,
                return NULL;
        }
 
-       /* Sanity check. Data-less blocks were handled earlier. */
-       if (WARN_ON_ONCE(!data_check_size(data_ring, *data_size) || !*data_size))
-               return NULL;
-
        /* A valid data block will always be aligned to the ID size. */
        if (WARN_ON_ONCE(blk_lpos->begin != ALIGN(blk_lpos->begin, sizeof(db->id))) ||
            WARN_ON_ONCE(blk_lpos->next != ALIGN(blk_lpos->next, sizeof(db->id)))) {
@@ -1319,6 +1315,10 @@ static const char *get_data(struct prb_data_ring *data_ring,
        /* Subtract block ID space from size to reflect data size. */
        *data_size -= sizeof(db->id);
 
+       /* Sanity check the max size of the regular data block. */
+       if (WARN_ON_ONCE(!data_check_size(data_ring, *data_size)))
+               return NULL;
+
        return &db->data[0];
 }