github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-07-27 17:47:41 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

lib/bug: cleanup comment style, types and modernize logging

Browse Source 
Improve the overall code quality of lib/bug.c by:
- Reformatting the main documentation block to follow the standard
  kernel multi-line comment style.
- Replacing 'unsigned' with the preferred 'unsigned int'.
- Converting legacy printk() calls to modern pr_warn() and pr_info()
  macros to include proper facility levels and satisfy checkpatch.

Link: https://lore.kernel.org/20260504201607.56932-1-lucasp.linux@gmail.com
Signed-off-by: Lucas Poupeau <lucasp.linux@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
This commit is contained in:
Lucas Poupeau 2026-05-04 22:16:07 +02:00 committed by Andrew Morton
parent c210dfaa27
commit 1c56b9cb48
1 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
lib/bug.c
View File

@ -1,41 +1,41 @@
// SPDX-License-Identifier: GPL-2.0
/*
Generic support for BUG()
This respects the following config options:
CONFIG_BUG - emit BUG traps. Nothing happens without this.
CONFIG_GENERIC_BUG - enable this code.
CONFIG_GENERIC_BUG_RELATIVE_POINTERS - use 32-bit relative pointers for bug_addr and file
CONFIG_DEBUG_BUGVERBOSE - emit full file+line information for each BUG
CONFIG_BUG and CONFIG_DEBUG_BUGVERBOSE are potentially user-settable
(though they're generally always on).
CONFIG_GENERIC_BUG is set by each architecture using this code.
To use this, your architecture must:
1. Set up the config options:
- Enable CONFIG_GENERIC_BUG if CONFIG_BUG
2. Implement BUG (and optionally BUG_ON, WARN, WARN_ON)
- Define HAVE_ARCH_BUG
- Implement BUG() to generate a faulting instruction
- NOTE: struct bug_entry does not have "file" or "line" entries
when CONFIG_DEBUG_BUGVERBOSE is not enabled, so you must generate
the values accordingly.
3. Implement the trap
- In the illegal instruction trap handler (typically), verify
that the fault was in kernel mode, and call report_bug()
- report_bug() will return whether it was a false alarm, a warning,
or an actual bug.
- You must implement the is_valid_bugaddr(bugaddr) callback which
returns true if the eip is a real kernel address, and it points
to the expected BUG trap instruction.
Jeremy Fitzhardinge <jeremy@goop.org> 2006
* Generic support for BUG()
*
* This respects the following config options:
*
* CONFIG_BUG - emit BUG traps. Nothing happens without this.
* CONFIG_GENERIC_BUG - enable this code.
* CONFIG_GENERIC_BUG_RELATIVE_POINTERS - use 32-bit relative pointers for bug_addr and file
* CONFIG_DEBUG_BUGVERBOSE - emit full file+line information for each BUG
*
* CONFIG_BUG and CONFIG_DEBUG_BUGVERBOSE are potentially user-settable
* (though they're generally always on).
*
* CONFIG_GENERIC_BUG is set by each architecture using this code.
*
* To use this, your architecture must:
*
* 1. Set up the config options:
* - Enable CONFIG_GENERIC_BUG if CONFIG_BUG
*
* 2. Implement BUG (and optionally BUG_ON, WARN, WARN_ON)
* - Define HAVE_ARCH_BUG
* - Implement BUG() to generate a faulting instruction
* - NOTE: struct bug_entry does not have "file" or "line" entries
* when CONFIG_DEBUG_BUGVERBOSE is not enabled, so you must generate
* the values accordingly.
*
* 3. Implement the trap
* - In the illegal instruction trap handler (typically), verify
* that the fault was in kernel mode, and call report_bug()
* - report_bug() will return whether it was a false alarm, a warning,
* or an actual bug.
* - You must implement the is_valid_bugaddr(bugaddr) callback which
* returns true if the eip is a real kernel address, and it points
* to the expected BUG trap instruction.
*
* Jeremy Fitzhardinge <jeremy@goop.org> 2006
*/
#define pr_fmt(fmt) fmt
@ -71,7 +71,7 @@ static struct bug_entry *module_find_bug(unsigned long bugaddr)
guard(rcu)();
list_for_each_entry_rcu(mod, &module_bug_list, bug_list) {
unsigned i;
unsigned int i;
bug = mod->bug_table;
for (i = 0; i < mod->num_bugs; ++i, ++bug)
@ -191,14 +191,14 @@ void __warn_printf(const char *fmt, struct pt_regs *regs)
}
#endif
printk("%s", fmt);
pr_warn("%s", fmt);
}
static enum bug_trap_type __report_bug(struct bug_entry *bug, unsigned long bugaddr, struct pt_regs *regs)
{
bool warning, once, done, no_cut, has_args;
const char *file, *fmt;
unsigned line;
unsigned int line;
if (!bug) {
if (!is_valid_bugaddr(bugaddr))
@ -237,7 +237,7 @@ static enum bug_trap_type __report_bug(struct bug_entry *bug, unsigned long buga
* extra debugging message it writes before triggering the handler.
*/
if (!no_cut) {
printk(KERN_DEFAULT CUT_HERE);
pr_info(CUT_HERE);
__warn_printf(fmt, has_args ? regs : NULL);
}