Commit Graph

5 Commits

Author SHA1 Message Date
Andrew Halaney 91693bfd4c kernel/printk/index.c: fix memory leak with using debugfs_lookup()
JIRA: https://issues.redhat.com/browse/RHEL-3987

commit 55bf243c514553e907efcf2bda92ba090eca8c64
Author: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Date:   Thu Feb 2 16:14:11 2023 +0100

    kernel/printk/index.c: fix memory leak with using debugfs_lookup()

    When calling debugfs_lookup() the result must have dput() called on it,
    otherwise the memory will leak over time.  To make things simpler, just
    call debugfs_lookup_and_remove() instead which handles all of the logic
    at once.

    Cc: Chris Down <chris@chrisdown.name>
    Cc: Petr Mladek <pmladek@suse.com>
    Cc: Sergey Senozhatsky <senozhatsky@chromium.org>
    Cc: Steven Rostedt <rostedt@goodmis.org>
    Cc: John Ogness <john.ogness@linutronix.de>
    Cc: linux-kernel@vger.kernel.org
    Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
    Reviewed-by: Sergey Senozhatsky <senozhatsky@chromium.org>
    Reviewed-by: John Ogness <john.ogness@linutronix.de>
    Reviewed-by: Petr Mladek <pmladek@suse.com>
    Signed-off-by: Petr Mladek <pmladek@suse.com>
    Link: https://lore.kernel.org/r/20230202151411.2308576-1-gregkh@linuxfoundation.org

Signed-off-by: Andrew Halaney <ahalaney@redhat.com>
2024-05-09 11:26:20 -04:00
David Arcari 4fdd66d510 printk: avoid -Wsometimes-uninitialized warning
Bugzilla: https://bugzilla.redhat.com/2117494

commit 5aa7eea9316ceb4b57175ce04b39e498105b7e92
Author: Arnd Bergmann <arnd@arndb.de>
Date:   Tue Sep 28 11:34:33 2021 +0200

    printk: avoid -Wsometimes-uninitialized warning

    clang notices that the pi_get_entry() function would use
    uninitialized data if it was called with a non-NULL module
    pointer on a kernel that does not support modules:

    kernel/printk/index.c:32:6: error: variable 'nr_entries' is used uninitialized whenever 'if' condition is false [-Werror,-Wsometimes-uninitialized]
            if (!mod) {
                ^~~~
    kernel/printk/index.c:38:13: note: uninitialized use occurs here
            if (pos >= nr_entries)
                       ^~~~~~~~~~
    kernel/printk/index.c:32:2: note: remove the 'if' if its condition is always true
            if (!mod) {

    Rework the condition to make it clear to the compiler that we are always
    in the second case. Unfortunately the #ifdef is still required as the
    definition of 'struct module' is hidden when modules are disabled.

    Fixes: 337015573718 ("printk: Userspace format indexing support")
    Suggested-by: Steven Rostedt <rostedt@goodmis.org>
    Signed-off-by: Arnd Bergmann <arnd@arndb.de>
    Signed-off-by: Petr Mladek <pmladek@suse.com>
    Link: https://lore.kernel.org/r/20210928093456.2438109-1-arnd@kernel.org

Signed-off-by: David Arcari <darcari@redhat.com>
2022-09-13 14:58:42 -04:00
David Arcari f434550bfd printk/index: Fix -Wunused-function warning
Bugzilla: https://bugzilla.redhat.com/2117494

commit bc17bed5fd73ef1a9aed39f3b0ea26936dad60b8
Author: YueHaibing <yuehaibing@huawei.com>
Date:   Wed Aug 4 21:01:05 2021 +0800

    printk/index: Fix -Wunused-function warning

    If CONFIG_MODULES is n, we got this:

    kernel/printk/index.c:146:13: warning: ‘pi_remove_file’ defined but not used [-Wunused-function]

    Move it inside #ifdef block to fix this warning.

    Reported-by: Hulk Robot <hulkci@huawei.com>
    Signed-off-by: YueHaibing <yuehaibing@huawei.com>
    Signed-off-by: Petr Mladek <pmladek@suse.com>
    Link: https://lore.kernel.org/r/20210804130105.18732-1-yuehaibing@huawei.com

Signed-off-by: David Arcari <darcari@redhat.com>
2022-09-13 14:58:42 -04:00
David Arcari 6a81104d84 printk/index: Fix warning about missing prototypes
Bugzilla: https://bugzilla.redhat.com/2117494

commit 0f0aa84850a4105401723c6c0eeb61c2e67c869a
Author: Petr Mladek <pmladek@suse.com>
Date:   Fri Jul 23 09:47:07 2021 +0200

    printk/index: Fix warning about missing prototypes

    The commit 337015573718b161 ("printk: Userspace format indexing support")
    triggered the following build failure:

    kernel/printk/index.c:140:6: warning: no previous prototype for ‘pi_create_file’ [-Wmissing-prototypes]
     void pi_create_file(struct module *mod)
          ^~~~~~~~~~~~~~
    kernel/printk/index.c:146:6: warning: no previous prototype for ‘pi_remove_file’ [-Wmissing-prototypes]
     void pi_remove_file(struct module *mod)
          ^~~~~~~~~~~~~~

    Fixes: 337015573718b161 ("printk: Userspace format indexing support")
    Reported-by: kernel test robot <lkp@intel.com>
    Suggested-by: Chris Down <chris@chrisdown.name>
    [pmladek@suse.com: Let the compiler decide about inlining.]
    Signed-off-by: Petr Mladek <pmladek@suse.com>
    Link: https://lore.kernel.org/lkml/YPql089IwSpudw%2F1@alley/

Signed-off-by: David Arcari <darcari@redhat.com>
2022-09-13 14:58:42 -04:00
David Arcari e02edc71cf printk: Userspace format indexing support
Bugzilla: https://bugzilla.redhat.com/2117494

commit 337015573718b161891a3473d25f59273f2e626b
Author: Chris Down <chris@chrisdown.name>
Date:   Tue Jun 15 17:52:53 2021 +0100

    printk: Userspace format indexing support

    We have a number of systems industry-wide that have a subset of their
    functionality that works as follows:

    1. Receive a message from local kmsg, serial console, or netconsole;
    2. Apply a set of rules to classify the message;
    3. Do something based on this classification (like scheduling a
       remediation for the machine), rinse, and repeat.

    As a couple of examples of places we have this implemented just inside
    Facebook, although this isn't a Facebook-specific problem, we have this
    inside our netconsole processing (for alarm classification), and as part
    of our machine health checking. We use these messages to determine
    fairly important metrics around production health, and it's important
    that we get them right.

    While for some kinds of issues we have counters, tracepoints, or metrics
    with a stable interface which can reliably indicate the issue, in order
    to react to production issues quickly we need to work with the interface
    which most kernel developers naturally use when developing: printk.

    Most production issues come from unexpected phenomena, and as such
    usually the code in question doesn't have easily usable tracepoints or
    other counters available for the specific problem being mitigated. We
    have a number of lines of monitoring defence against problems in
    production (host metrics, process metrics, service metrics, etc), and
    where it's not feasible to reliably monitor at another level, this kind
    of pragmatic netconsole monitoring is essential.

    As one would expect, monitoring using printk is rather brittle for a
    number of reasons -- most notably that the message might disappear
    entirely in a new version of the kernel, or that the message may change
    in some way that the regex or other classification methods start to
    silently fail.

    One factor that makes this even harder is that, under normal operation,
    many of these messages are never expected to be hit. For example, there
    may be a rare hardware bug which one wants to detect if it was to ever
    happen again, but its recurrence is not likely or anticipated. This
    precludes using something like checking whether the printk in question
    was printed somewhere fleetwide recently to determine whether the
    message in question is still present or not, since we don't anticipate
    that it should be printed anywhere, but still need to monitor for its
    future presence in the long-term.

    This class of issue has happened on a number of occasions, causing
    unhealthy machines with hardware issues to remain in production for
    longer than ideal. As a recent example, some monitoring around
    blk_update_request fell out of date and caused semi-broken machines to
    remain in production for longer than would be desirable.

    Searching through the codebase to find the message is also extremely
    fragile, because many of the messages are further constructed beyond
    their callsite (eg. btrfs_printk and other module-specific wrappers,
    each with their own functionality). Even if they aren't, guessing the
    format and formulation of the underlying message based on the aesthetics
    of the message emitted is not a recipe for success at scale, and our
    previous issues with fleetwide machine health checking demonstrate as
    much.

    This provides a solution to the issue of silently changed or deleted
    printks: we record pointers to all printk format strings known at
    compile time into a new .printk_index section, both in vmlinux and
    modules. At runtime, this can then be iterated by looking at
    <debugfs>/printk/index/<module>, which emits the following format, both
    readable by humans and able to be parsed by machines:

        $ head -1 vmlinux; shuf -n 5 vmlinux
        # <level[,flags]> filename:line function "format"
        <5> block/blk-settings.c:661 disk_stack_limits "%s: Warning: Device %s is misaligned\n"
        <4> kernel/trace/trace.c:8296 trace_create_file "Could not create tracefs '%s' entry\n"
        <6> arch/x86/kernel/hpet.c:144 _hpet_print_config "hpet: %s(%d):\n"
        <6> init/do_mounts.c:605 prepare_namespace "Waiting for root device %s...\n"
        <6> drivers/acpi/osl.c:1410 acpi_no_auto_serialize_setup "ACPI: auto-serialization disabled\n"

    This mitigates the majority of cases where we have a highly-specific
    printk which we want to match on, as we can now enumerate and check
    whether the format changed or the printk callsite disappeared entirely
    in userspace. This allows us to catch changes to printks we monitor
    earlier and decide what to do about it before it becomes problematic.

    There is no additional runtime cost for printk callers or printk itself,
    and the assembly generated is exactly the same.

    Signed-off-by: Chris Down <chris@chrisdown.name>
    Cc: Petr Mladek <pmladek@suse.com>
    Cc: Jessica Yu <jeyu@kernel.org>
    Cc: Sergey Senozhatsky <sergey.senozhatsky@gmail.com>
    Cc: John Ogness <john.ogness@linutronix.de>
    Cc: Steven Rostedt <rostedt@goodmis.org>
    Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
    Cc: Johannes Weiner <hannes@cmpxchg.org>
    Cc: Kees Cook <keescook@chromium.org>
    Reviewed-by: Petr Mladek <pmladek@suse.com>
    Tested-by: Petr Mladek <pmladek@suse.com>
    Reported-by: kernel test robot <lkp@intel.com>
    Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>
    Acked-by: Jessica Yu <jeyu@kernel.org> # for module.{c,h}
    Signed-off-by: Petr Mladek <pmladek@suse.com>
    Link: https://lore.kernel.org/r/e42070983637ac5e384f17fbdbe86d19c7b212a5.1623775748.git.chris@chrisdown.name

Signed-off-by: David Arcari <darcari@redhat.com>
2022-09-12 13:19:06 -04:00