main-loop.h

   1 /*
   2  * QEMU System Emulator
   3  *
   4  * Copyright (c) 2003-2008 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #ifndef QEMU_MAIN_LOOP_H
  26 #define QEMU_MAIN_LOOP_H 1
  27
  28 #define SIG_IPI SIGUSR1
  29
  30 /**
  31  * qemu_init_main_loop: Set up the process so that it can run the main loop.
  32  *
  33  * This includes setting up signal handlers.  It should be called before
  34  * any other threads are created.  In addition, threads other than the
  35  * main one should block signals that are trapped by the main loop.
  36  * For simplicity, you can consider these signals to be safe: SIGUSR1,
  37  * SIGUSR2, thread signals (SIGFPE, SIGILL, SIGSEGV, SIGBUS) and real-time
  38  * signals if available.  Remember that Windows in practice does not have
  39  * signals, though.
  40  *
  41  * In the case of QEMU tools, this will also start/initialize timers.
  42  */
  43 int qemu_init_main_loop(void);
  44
  45 /**
  46  * main_loop_init: Initializes main loop
  47  *
  48  * Internal (but shared for compatibility reasons) initialization routine
  49  * for the main loop. This should not be used by applications directly,
  50  * use qemu_init_main_loop() instead.
  51  *
  52  */
  53 int main_loop_init(void);
  54
  55 /**
  56  * main_loop_wait: Run one iteration of the main loop.
  57  *
  58  * If @nonblocking is true, poll for events, otherwise suspend until
  59  * one actually occurs.  The main loop usually consists of a loop that
  60  * repeatedly calls main_loop_wait(false).
  61  *
  62  * Main loop services include file descriptor callbacks, bottom halves
  63  * and timers (defined in qemu-timer.h).  Bottom halves are similar to timers
  64  * that execute immediately, but have a lower overhead and scheduling them
  65  * is wait-free, thread-safe and signal-safe.
  66  *
  67  * It is sometimes useful to put a whole program in a coroutine.  In this
  68  * case, the coroutine actually should be started from within the main loop,
  69  * so that the main loop can run whenever the coroutine yields.  To do this,
  70  * you can use a bottom half to enter the coroutine as soon as the main loop
  71  * starts:
  72  *
  73  *     void enter_co_bh(void *opaque) {
  74  *         QEMUCoroutine *co = opaque;
  75  *         qemu_coroutine_enter(co, NULL);
  76  *     }
  77  *
  78  *     ...
  79  *     QEMUCoroutine *co = qemu_coroutine_create(coroutine_entry);
  80  *     QEMUBH *start_bh = qemu_bh_new(enter_co_bh, co);
  81  *     qemu_bh_schedule(start_bh);
  82  *     while (...) {
  83  *         main_loop_wait(false);
  84  *     }
  85  *
  86  * (In the future we may provide a wrapper for this).
  87  *
  88  * @nonblocking: Whether the caller should block until an event occurs.
  89  */
  90 int main_loop_wait(int nonblocking);
  91
  92 /**
  93  * qemu_notify_event: Force processing of pending events.
  94  *
  95  * Similar to signaling a condition variable, qemu_notify_event forces
  96  * main_loop_wait to look at pending events and exit.  The caller of
  97  * main_loop_wait will usually call it again very soon, so qemu_notify_event
  98  * also has the side effect of recalculating the sets of file descriptors
  99  * that the main loop waits for.
 100  *
 101  * Calling qemu_notify_event is rarely necessary, because main loop
 102  * services (bottom halves and timers) call it themselves.  One notable
 103  * exception occurs when using qemu_set_fd_handler2 (see below).
 104  */
 105 void qemu_notify_event(void);
 106
 107 #ifdef CONFIG_HAX_BACKEND
 108 void qemu_notify_hax_event(void);
 109 #else
 110 static inline void qemu_notify_hax_event(void)
 111 {
 112 }
 113 #endif
 114
 115 #ifdef _WIN32
 116 /* return TRUE if no sleep should be done afterwards */
 117 typedef int PollingFunc(void *opaque);
 118
 119 /**
 120  * qemu_add_polling_cb: Register a Windows-specific polling callback
 121  *
 122  * Currently, under Windows some events are polled rather than waited for.
 123  * Polling callbacks do not ensure that @func is called timely, because
 124  * the main loop might wait for an arbitrarily long time.  If possible,
 125  * you should instead create a separate thread that does a blocking poll
 126  * and set a Win32 event object.  The event can then be passed to
 127  * qemu_add_wait_object.
 128  *
 129  * Polling callbacks really have nothing Windows specific in them, but
 130  * as they are a hack and are currently not necessary under POSIX systems,
 131  * they are only available when QEMU is running under Windows.
 132  *
 133  * @func: The function that does the polling, and returns 1 to force
 134  * immediate completion of main_loop_wait.
 135  * @opaque: A pointer-size value that is passed to @func.
 136  */
 137 int qemu_add_polling_cb(PollingFunc *func, void *opaque);
 138
 139 /**
 140  * qemu_del_polling_cb: Unregister a Windows-specific polling callback
 141  *
 142  * This function removes a callback that was registered with
 143  * qemu_add_polling_cb.
 144  *
 145  * @func: The function that was passed to qemu_add_polling_cb.
 146  * @opaque: A pointer-size value that was passed to qemu_add_polling_cb.
 147  */
 148 void qemu_del_polling_cb(PollingFunc *func, void *opaque);
 149
 150 /* Wait objects handling */
 151 typedef void WaitObjectFunc(void *opaque);
 152
 153 /**
 154  * qemu_add_wait_object: Register a callback for a Windows handle
 155  *
 156  * Under Windows, the iohandler mechanism can only be used with sockets.
 157  * QEMU must use the WaitForMultipleObjects API to wait on other handles.
 158  * This function registers a #HANDLE with QEMU, so that it will be included
 159  * in the main loop's calls to WaitForMultipleObjects.  When the handle
 160  * is in a signaled state, QEMU will call @func.
 161  *
 162  * @handle: The Windows handle to be observed.
 163  * @func: A function to be called when @handle is in a signaled state.
 164  * @opaque: A pointer-size value that is passed to @func.
 165  */
 166 int qemu_add_wait_object(HANDLE handle, WaitObjectFunc *func, void *opaque);
 167
 168 /**
 169  * qemu_del_wait_object: Unregister a callback for a Windows handle
 170  *
 171  * This function removes a callback that was registered with
 172  * qemu_add_wait_object.
 173  *
 174  * @func: The function that was passed to qemu_add_wait_object.
 175  * @opaque: A pointer-size value that was passed to qemu_add_wait_object.
 176  */
 177 void qemu_del_wait_object(HANDLE handle, WaitObjectFunc *func, void *opaque);
 178 #endif
 179
 180 /* async I/O support */
 181
 182 typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
 183 typedef int IOCanReadHandler(void *opaque);
 184 typedef void IOHandler(void *opaque);
 185
 186 /**
 187  * qemu_set_fd_handler2: Register a file descriptor with the main loop
 188  *
 189  * This function tells the main loop to wake up whenever one of the
 190  * following conditions is true:
 191  *
 192  * 1) if @fd_write is not %NULL, when the file descriptor is writable;
 193  *
 194  * 2) if @fd_read is not %NULL, when the file descriptor is readable.
 195  *
 196  * @fd_read_poll can be used to disable the @fd_read callback temporarily.
 197  * This is useful to avoid calling qemu_set_fd_handler2 every time the
 198  * client becomes interested in reading (or dually, stops being interested).
 199  * A typical example is when @fd is a listening socket and you want to bound
 200  * the number of active clients.  Remember to call qemu_notify_event whenever
 201  * the condition may change from %false to %true.
 202  *
 203  * The callbacks that are set up by qemu_set_fd_handler2 are level-triggered.
 204  * If @fd_read does not read from @fd, or @fd_write does not write to @fd
 205  * until its buffers are full, they will be called again on the next
 206  * iteration.
 207  *
 208  * @fd: The file descriptor to be observed.  Under Windows it must be
 209  * a #SOCKET.
 210  *
 211  * @fd_read_poll: A function that returns 1 if the @fd_read callback
 212  * should be fired.  If the function returns 0, the main loop will not
 213  * end its iteration even if @fd becomes readable.
 214  *
 215  * @fd_read: A level-triggered callback that is fired if @fd is readable
 216  * at the beginning of a main loop iteration, or if it becomes readable
 217  * during one.
 218  *
 219  * @fd_write: A level-triggered callback that is fired when @fd is writable
 220  * at the beginning of a main loop iteration, or if it becomes writable
 221  * during one.
 222  *
 223  * @opaque: A pointer-sized value that is passed to @fd_read_poll,
 224  * @fd_read and @fd_write.
 225  */
 226 int qemu_set_fd_handler2(int fd,
 227                          IOCanReadHandler *fd_read_poll,
 228                          IOHandler *fd_read,
 229                          IOHandler *fd_write,
 230                          void *opaque);
 231
 232 /**
 233  * qemu_set_fd_handler: Register a file descriptor with the main loop
 234  *
 235  * This function tells the main loop to wake up whenever one of the
 236  * following conditions is true:
 237  *
 238  * 1) if @fd_write is not %NULL, when the file descriptor is writable;
 239  *
 240  * 2) if @fd_read is not %NULL, when the file descriptor is readable.
 241  *
 242  * The callbacks that are set up by qemu_set_fd_handler are level-triggered.
 243  * If @fd_read does not read from @fd, or @fd_write does not write to @fd
 244  * until its buffers are full, they will be called again on the next
 245  * iteration.
 246  *
 247  * @fd: The file descriptor to be observed.  Under Windows it must be
 248  * a #SOCKET.
 249  *
 250  * @fd_read: A level-triggered callback that is fired if @fd is readable
 251  * at the beginning of a main loop iteration, or if it becomes readable
 252  * during one.
 253  *
 254  * @fd_write: A level-triggered callback that is fired when @fd is writable
 255  * at the beginning of a main loop iteration, or if it becomes writable
 256  * during one.
 257  *
 258  * @opaque: A pointer-sized value that is passed to @fd_read and @fd_write.
 259  */
 260 int qemu_set_fd_handler(int fd,
 261                         IOHandler *fd_read,
 262                         IOHandler *fd_write,
 263                         void *opaque);
 264
 265 typedef struct QEMUBH QEMUBH;
 266 typedef void QEMUBHFunc(void *opaque);
 267
 268 /**
 269  * qemu_bh_new: Allocate a new bottom half structure.
 270  *
 271  * Bottom halves are lightweight callbacks whose invocation is guaranteed
 272  * to be wait-free, thread-safe and signal-safe.  The #QEMUBH structure
 273  * is opaque and must be allocated prior to its use.
 274  */
 275 QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
 276
 277 /**
 278  * qemu_bh_schedule: Schedule a bottom half.
 279  *
 280  * Scheduling a bottom half interrupts the main loop and causes the
 281  * execution of the callback that was passed to qemu_bh_new.
 282  *
 283  * Bottom halves that are scheduled from a bottom half handler are instantly
 284  * invoked.  This can create an infinite loop if a bottom half handler
 285  * schedules itself.
 286  *
 287  * @bh: The bottom half to be scheduled.
 288  */
 289 void qemu_bh_schedule(QEMUBH *bh);
 290
 291 /**
 292  * qemu_bh_cancel: Cancel execution of a bottom half.
 293  *
 294  * Canceling execution of a bottom half undoes the effect of calls to
 295  * qemu_bh_schedule without freeing its resources yet.  While cancellation
 296  * itself is also wait-free and thread-safe, it can of course race with the
 297  * loop that executes bottom halves unless you are holding the iothread
 298  * mutex.  This makes it mostly useless if you are not holding the mutex.
 299  *
 300  * @bh: The bottom half to be canceled.
 301  */
 302 void qemu_bh_cancel(QEMUBH *bh);
 303
 304 /**
 305  *qemu_bh_delete: Cancel execution of a bottom half and free its resources.
 306  *
 307  * Deleting a bottom half frees the memory that was allocated for it by
 308  * qemu_bh_new.  It also implies canceling the bottom half if it was
 309  * scheduled.
 310  *
 311  * @bh: The bottom half to be deleted.
 312  */
 313 void qemu_bh_delete(QEMUBH *bh);
 314
 315 #ifdef CONFIG_POSIX
 316 /**
 317  * qemu_add_child_watch: Register a child process for reaping.
 318  *
 319  * Under POSIX systems, a parent process must read the exit status of
 320  * its child processes using waitpid, or the operating system will not
 321  * free some of the resources attached to that process.
 322  *
 323  * This function directs the QEMU main loop to observe a child process
 324  * and call waitpid as soon as it exits; the watch is then removed
 325  * automatically.  It is useful whenever QEMU forks a child process
 326  * but will find out about its termination by other means such as a
 327  * "broken pipe".
 328  *
 329  * @pid: The pid that QEMU should observe.
 330  */
 331 int qemu_add_child_watch(pid_t pid);
 332 #endif
 333
 334 /**
 335  * qemu_mutex_lock_iothread: Lock the main loop mutex.
 336  *
 337  * This function locks the main loop mutex.  The mutex is taken by
 338  * qemu_init_main_loop and always taken except while waiting on
 339  * external events (such as with select).  The mutex should be taken
 340  * by threads other than the main loop thread when calling
 341  * qemu_bh_new(), qemu_set_fd_handler() and basically all other
 342  * functions documented in this file.
 343  *
 344  * NOTE: tools currently are single-threaded and qemu_mutex_lock_iothread
 345  * is a no-op there.
 346  */
 347 void qemu_mutex_lock_iothread(void);
 348
 349 /**
 350  * qemu_mutex_unlock_iothread: Unlock the main loop mutex.
 351  *
 352  * This function unlocks the main loop mutex.  The mutex is taken by
 353  * qemu_init_main_loop and always taken except while waiting on
 354  * external events (such as with select).  The mutex should be unlocked
 355  * as soon as possible by threads other than the main loop thread,
 356  * because it prevents the main loop from processing callbacks,
 357  * including timers and bottom halves.
 358  *
 359  * NOTE: tools currently are single-threaded and qemu_mutex_unlock_iothread
 360  * is a no-op there.
 361  */
 362 void qemu_mutex_unlock_iothread(void);
 363
 364 /* internal interfaces */
 365
 366 void qemu_fd_register(int fd);
 367 void qemu_iohandler_fill(int *pnfds, fd_set *readfds, fd_set *writefds, fd_set *xfds);
 368 void qemu_iohandler_poll(fd_set *readfds, fd_set *writefds, fd_set *xfds, int rc);
 369
 370 void qemu_bh_schedule_idle(QEMUBH *bh);
 371 int qemu_bh_poll(void);
 372 void qemu_bh_update_timeout(uint32_t *timeout);
 373
 374 #endif