Linux設備驅動的調試之BUG_ON()和WARN_ON()


Copy form:https://blog.csdn.net/xiezhi123456/article/details/80665059

21.7 BUG_ON()和WARN_ON()

    內核中有許多地方調用類似BUG()的語句,它非常像一個內核運行時的斷言,意味着本來不該執行到BUG()這條語句,一旦執行即拋出Oops。BUG()的定義為:

include/asm-generic/bug.h

#define BUG() do { \
       printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
       panic("BUG!"); \
} while (0)

其中panic()定義在kernel/panic.c中,會導致內核崩潰,並打印Oops。

/**
 * panic - halt the system
 * @fmt: The text string to print
 *
 * Display a message, then perform cleanups.
 *
 * This function never returns.
 */
void panic(const char *fmt, ...)
{
static char buf[1024];
va_list args;
long i, i_next = 0;
int state = 0;
int old_cpu, this_cpu;
bool _crash_kexec_post_notifiers = crash_kexec_post_notifiers;

/*
 * Disable local interrupts. This will prevent panic_smp_self_stop
 * from deadlocking the first cpu that invokes the panic, since
 * there is nothing to prevent an interrupt handler (that runs
 * after setting panic_cpu) from invoking panic() again.
 */
local_irq_disable();

/*
 * It's possible to come here directly from a panic-assertion and
 * not have preempt disabled. Some functions called from here want
 * preempt to be disabled. No point enabling it later though...
 *
 * Only one CPU is allowed to execute the panic code from here. For
 * multiple parallel invocations of panic, all other CPUs either
 * stop themself or will wait until they are stopped by the 1st CPU
 * with smp_send_stop().
 *
 * `old_cpu == PANIC_CPU_INVALID' means this is the 1st CPU which
 * comes here, so go ahead.
 * `old_cpu == this_cpu' means we came from nmi_panic() which sets
 * panic_cpu to this CPU.  In this case, this is also the 1st CPU.
 */
this_cpu = raw_smp_processor_id();
old_cpu  = atomic_cmpxchg(&panic_cpu, PANIC_CPU_INVALID, this_cpu);

if (old_cpu != PANIC_CPU_INVALID && old_cpu != this_cpu)
panic_smp_self_stop();

console_verbose();
bust_spinlocks(1);
va_start(args, fmt);
vsnprintf(buf, sizeof(buf), fmt, args);
va_end(args);
pr_emerg("Kernel panic - not syncing: %s\n", buf);
#ifdef CONFIG_DEBUG_BUGVERBOSE
/*
 * Avoid nested stack-dumping if a panic occurs during oops processing
 */
if (!test_taint(TAINT_DIE) && oops_in_progress <= 1)
dump_stack();
#endif

/*
 * If we have crashed and we have a crash kernel loaded let it handle
 * everything else.
 * If we want to run this after calling panic_notifiers, pass
 * the "crash_kexec_post_notifiers" option to the kernel.
 *
 * Bypass the panic_cpu check and call __crash_kexec directly.
 */
if (!_crash_kexec_post_notifiers) {
printk_safe_flush_on_panic();
__crash_kexec(NULL);

/*
 * Note smp_send_stop is the usual smp shutdown function, which
 * unfortunately means it may not be hardened to work in a
 * panic situation.
 */
smp_send_stop();
} else {
/*
 * If we want to do crash dump after notifier calls and
 * kmsg_dump, we will need architecture dependent extra
 * works in addition to stopping other CPUs.
 */
crash_smp_send_stop();
}

/*
 * Run any panic handlers, including those that might need to
 * add information to the kmsg dump output.
 */
atomic_notifier_call_chain(&panic_notifier_list, 0, buf);


/* Call flush even twice. It tries harder with a single online CPU */
printk_safe_flush_on_panic();
kmsg_dump(KMSG_DUMP_PANIC);

/*
 * If you doubt kdump always works fine in any situation,
 * "crash_kexec_post_notifiers" offers you a chance to run
 * panic_notifiers and dumping kmsg before kdump.
 * Note: since some panic_notifiers can make crashed kernel
 * more unstable, it can increase risks of the kdump failure too.
 *
 * Bypass the panic_cpu check and call __crash_kexec directly.
 */
if (_crash_kexec_post_notifiers)
__crash_kexec(NULL);

bust_spinlocks(0);

/*
 * We may have ended up stopping the CPU holding the lock (in
 * smp_send_stop()) while still having some valuable data in the console
 * buffer.  Try to acquire the lock then release it regardless of the
 * result.  The release will also print the buffers out.  Locks debug
 * should be disabled to avoid reporting bad unlock balance when
 * panic() is not being callled from OOPS.
 */
debug_locks_off();
console_flush_on_panic();

if (!panic_blink)
panic_blink = no_blink;

if (panic_timeout > 0) {
/*
 * Delay timeout seconds before rebooting the machine.
 * We can't use the "normal" timers since we just panicked.
 */
pr_emerg("Rebooting in %d seconds..\n", panic_timeout);

for (i = 0; i < panic_timeout * 1000; i += PANIC_TIMER_STEP) {
touch_nmi_watchdog();
if (i >= i_next) {
i += panic_blink(state ^= 1);
i_next = i + 3600 / PANIC_BLINK_SPD;
}
mdelay(PANIC_TIMER_STEP);
}
}
if (panic_timeout != 0) {
/*
 * This will not be a clean reboot, with everything
 * shutting down.  But if there is a chance of
 * rebooting the system it will be rebooted.
 */
emergency_restart();
}
#ifdef __sparc__
{
extern int stop_a_enabled;
/* Make sure the user can actually press Stop-A (L1-A) */
stop_a_enabled = 1;
pr_emerg("Press Stop-A (L1-A) from sun keyboard or send break\n"
 "twice on console to return to the boot prom\n");
}
#endif
#if defined(CONFIG_S390)
{
unsigned long caller;

caller = (unsigned long)__builtin_return_address(0);
disabled_wait(caller);
}
#endif
pr_emerg("---[ end Kernel panic - not syncing: %s\n", buf);
local_irq_enable();
for (i = 0; ; i += PANIC_TIMER_STEP) {
touch_softlockup_watchdog();
if (i >= i_next) {
i += panic_blink(state ^= 1);
i_next = i + 3600 / PANIC_BLINK_SPD;
}
mdelay(PANIC_TIMER_STEP);
}
}

EXPORT_SYMBOL(panic);

比如arch/arm/kernel/dma.c中的enable_dma()函數:

void enable_dma (unsigned int chan)
{
dma_t *dma = dma_channel(chan);

if (!dma->lock)
goto free_dma;

if (dma->active == 0) {
dma->active = 1;
dma->d_ops->enable(chan, dma);
}
return;

free_dma:
pr_err("dma%d: trying to enable free DMA\n", chan);
BUG();
}
EXPORT_SYMBOL(enable_dma);

分析:

    上述代碼的含義是,如果在dma->lock不成立的情況下,驅動直接調用了enable_dma(),實際上意味
着內核的一個bug。

    BUG()還有一個變體叫BUG_ON(),其內部會引用BUG(),形式為:

include/asm-generic/bug.h

#define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0)

對於BUG_ON(),只有當括號內的條件成立時,才拋出Oops。

比如drivers/char/random.c中的類似代碼:

/*
 * Used as a workqueue function so that when the input pool is getting
 * full, we can "spill over" some entropy to the output pools.  That
 * way the output pools can store some of the excess entropy instead
 * of letting it go to waste.
 */
static void push_to_pool(struct work_struct *work)
{
struct entropy_store *r = container_of(work, struct entropy_store, push_work);
BUG_ON(!r); /* 當括號內的條件成立時,才拋出Oops */
_xfer_secondary_pool(r, random_read_wakeup_bits/8);
trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
   r->pull->entropy_count >> ENTROPY_SHIFT);
}

    除了BUG_ON()外,內核有個稍微弱一些WARN_ON(),在括號中的條件成立時,內核會拋出棧回溯,但是不會panic(),這通常用於內核拋出一個警告,暗示某種不太合理的事情發生了。

    如在kernel/locking/mutex-debug.c中的debug_mutex_unlock()函數發現:

    mutex_unlock()的調用者和mutex_lock()的調用者不是同一個線程的時候或者mutex的owner為空的時候,會拋出警告信息:

void debug_mutex_unlock(struct mutex *lock)
{
      if (likely(debug_locks)) {
             DEBUG_LOCKS_WARN_ON(lock->magic != lock);
             if (!lock->owner)
                   DEBUG_LOCKS_WARN_ON(!lock->owner);
             else
                   DEBUG_LOCKS_WARN_ON(lock->owner != current);
             DEBUG_LOCKS_WARN_ON(!lock->wait_list.prev && !lock->wait_list.next);
             mutex_clear_owner(lock);
     }
}

備注:

    有時,WARN_ON()也可以作為一個調試技巧。比如,進到內核某個函數后,不知道這個函數是怎么一級一級被調用進來的,可以在該函數中加入一個WARN_ON(1)。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM