[Qemu-devel] [5576] Clarify qemu_bh_schedule_idle() usage

[Anthony Liguori]

Revision: 5576
          http://svn.sv.gnu.org/viewvc/?view=rev&root=qemu&revision=5576
Author:   aliguori
Date:     2008-10-31 17:42:00 +0000 (Fri, 31 Oct 2008)

Log Message:
-----------
Clarify qemu_bh_schedule_idle() usage

Signed-off-by: Anthony Liguori <address@hidden>

Modified Paths:
--------------
    trunk/qemu-common.h

Modified: trunk/qemu-common.h
===================================================================
--- trunk/qemu-common.h 2008-10-31 17:31:29 UTC (rev 5575)
+++ trunk/qemu-common.h 2008-10-31 17:42:00 UTC (rev 5576)
@@ -70,6 +70,12 @@
 
 QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
 void qemu_bh_schedule(QEMUBH *bh);
+/* Bottom halfs that are scheduled from a bottom half handler are instantly
+ * invoked.  This can create an infinite loop if a bottom half handler
+ * schedules itself.  qemu_bh_schedule_idle() avoids this infinite loop by
+ * ensuring that the bottom half isn't executed until the next main loop
+ * iteration.
+ */
 void qemu_bh_schedule_idle(QEMUBH *bh);
 void qemu_bh_cancel(QEMUBH *bh);
 void qemu_bh_delete(QEMUBH *bh);