main-loop.c

   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 #include "qemu-common.h"
  26 #include "qemu/timer.h"
  27 #include "qemu/sockets.h"       // struct in_addr needed for libslirp.h
  28 #include "sysemu/qtest.h"
  29 #include "slirp/libslirp.h"
  30 #include "qemu/main-loop.h"
  31 #include "block/aio.h"
  32
  33 #include "sysemu/hax.h"
  34
  35 #ifndef _WIN32
  36
  37 #include "qemu/compatfd.h"
  38
  39 /* If we have signalfd, we mask out the signals we want to handle and then
  40  * use signalfd to listen for them.  We rely on whatever the current signal
  41  * handler is to dispatch the signals when we receive them.
  42  */
  43 static void sigfd_handler(void *opaque)
  44 {
  45     int fd = (intptr_t)opaque;
  46     struct qemu_signalfd_siginfo info;
  47     struct sigaction action;
  48     ssize_t len;
  49
  50     while (1) {
  51         do {
  52             len = read(fd, &info, sizeof(info));
  53         } while (len == -1 && errno == EINTR);
  54
  55         if (len == -1 && errno == EAGAIN) {
  56             break;
  57         }
  58
  59         if (len != sizeof(info)) {
  60             printf("read from sigfd returned %zd: %m\n", len);
  61             return;
  62         }
  63
  64         sigaction(info.ssi_signo, NULL, &action);
  65         if ((action.sa_flags & SA_SIGINFO) && action.sa_sigaction) {
  66             action.sa_sigaction(info.ssi_signo,
  67                                 (siginfo_t *)&info, NULL);
  68         } else if (action.sa_handler) {
  69             action.sa_handler(info.ssi_signo);
  70         }
  71     }
  72 }
  73
  74 static int qemu_signal_init(void)
  75 {
  76     int sigfd;
  77     sigset_t set;
  78
  79     /*
  80      * SIG_IPI must be blocked in the main thread and must not be caught
  81      * by sigwait() in the signal thread. Otherwise, the cpu thread will
  82      * not catch it reliably.
  83      */
  84     sigemptyset(&set);
  85     sigaddset(&set, SIG_IPI);
  86     sigaddset(&set, SIGIO);
  87     sigaddset(&set, SIGALRM);
  88     sigaddset(&set, SIGBUS);
  89     /* SIGINT cannot be handled via signalfd, so that ^C can be used
  90      * to interrupt QEMU when it is being run under gdb.  SIGHUP and
  91      * SIGTERM are also handled asynchronously, even though it is not
  92      * strictly necessary, because they use the same handler as SIGINT.
  93      */
  94     pthread_sigmask(SIG_BLOCK, &set, NULL);
  95
  96     sigdelset(&set, SIG_IPI);
  97     sigfd = qemu_signalfd(&set);
  98     if (sigfd == -1) {
  99         fprintf(stderr, "failed to create signalfd\n");
 100         return -errno;
 101     }
 102
 103     fcntl_setfl(sigfd, O_NONBLOCK);
 104
 105     qemu_set_fd_handler2(sigfd, NULL, sigfd_handler, NULL,
 106                          (void *)(intptr_t)sigfd);
 107
 108     return 0;
 109 }
 110
 111 #else /* _WIN32 */
 112
 113 static int qemu_signal_init(void)
 114 {
 115     return 0;
 116 }
 117 #endif
 118
 119 static AioContext *qemu_aio_context;
 120
 121 AioContext *qemu_get_aio_context(void)
 122 {
 123     return qemu_aio_context;
 124 }
 125
 126 void qemu_notify_event(void)
 127 {
 128     if (!qemu_aio_context) {
 129         return;
 130     }
 131     aio_notify(qemu_aio_context);
 132 }
 133
 134 static GArray *gpollfds;
 135
 136 int qemu_init_main_loop(Error **errp)
 137 {
 138     int ret;
 139     GSource *src;
 140     Error *local_error = NULL;
 141
 142     init_clocks();
 143
 144     ret = qemu_signal_init();
 145     if (ret) {
 146         return ret;
 147     }
 148
 149     qemu_aio_context = aio_context_new(&local_error);
 150     if (!qemu_aio_context) {
 151         error_propagate(errp, local_error);
 152         return -EMFILE;
 153     }
 154     gpollfds = g_array_new(FALSE, FALSE, sizeof(GPollFD));
 155     src = aio_get_g_source(qemu_aio_context);
 156     g_source_attach(src, NULL);
 157     g_source_unref(src);
 158     return 0;
 159 }
 160
 161 static int max_priority;
 162
 163 #ifndef _WIN32
 164 static int glib_pollfds_idx;
 165 static int glib_n_poll_fds;
 166
 167 static void glib_pollfds_fill(int64_t *cur_timeout)
 168 {
 169     GMainContext *context = g_main_context_default();
 170     int timeout = 0;
 171     int64_t timeout_ns;
 172     int n;
 173
 174     g_main_context_prepare(context, &max_priority);
 175
 176     glib_pollfds_idx = gpollfds->len;
 177     n = glib_n_poll_fds;
 178     do {
 179         GPollFD *pfds;
 180         glib_n_poll_fds = n;
 181         g_array_set_size(gpollfds, glib_pollfds_idx + glib_n_poll_fds);
 182         pfds = &g_array_index(gpollfds, GPollFD, glib_pollfds_idx);
 183         n = g_main_context_query(context, max_priority, &timeout, pfds,
 184                                  glib_n_poll_fds);
 185     } while (n != glib_n_poll_fds);
 186
 187     if (timeout < 0) {
 188         timeout_ns = -1;
 189     } else {
 190         timeout_ns = (int64_t)timeout * (int64_t)SCALE_MS;
 191     }
 192
 193     *cur_timeout = qemu_soonest_timeout(timeout_ns, *cur_timeout);
 194 }
 195
 196 static void glib_pollfds_poll(void)
 197 {
 198     GMainContext *context = g_main_context_default();
 199     GPollFD *pfds = &g_array_index(gpollfds, GPollFD, glib_pollfds_idx);
 200
 201     if (g_main_context_check(context, max_priority, pfds, glib_n_poll_fds)) {
 202         g_main_context_dispatch(context);
 203     }
 204 }
 205
 206 #define MAX_MAIN_LOOP_SPIN (1000)
 207
 208 static int os_host_main_loop_wait(int64_t timeout)
 209 {
 210     int ret;
 211     static int spin_counter;
 212
 213     glib_pollfds_fill(&timeout);
 214
 215     /* If the I/O thread is very busy or we are incorrectly busy waiting in
 216      * the I/O thread, this can lead to starvation of the BQL such that the
 217      * VCPU threads never run.  To make sure we can detect the later case,
 218      * print a message to the screen.  If we run into this condition, create
 219      * a fake timeout in order to give the VCPU threads a chance to run.
 220      */
 221     if (!timeout && (spin_counter > MAX_MAIN_LOOP_SPIN)) {
 222         static bool notified;
 223
 224         if (!notified && !qtest_enabled()) {
 225             fprintf(stderr,
 226                     "main-loop: WARNING: I/O thread spun for %d iterations\n",
 227                     MAX_MAIN_LOOP_SPIN);
 228             notified = true;
 229         }
 230
 231         timeout = SCALE_MS;
 232     }
 233
 234     if (timeout) {
 235         spin_counter = 0;
 236         qemu_mutex_unlock_iothread();
 237     } else {
 238         spin_counter++;
 239     }
 240
 241     ret = qemu_poll_ns((GPollFD *)gpollfds->data, gpollfds->len, timeout);
 242
 243     if (timeout) {
 244         qemu_mutex_lock_iothread();
 245     }
 246
 247     glib_pollfds_poll();
 248     return ret;
 249 }
 250 #else
 251 /***********************************************************/
 252 /* Polling handling */
 253
 254 typedef struct PollingEntry {
 255     PollingFunc *func;
 256     void *opaque;
 257     struct PollingEntry *next;
 258 } PollingEntry;
 259
 260 static PollingEntry *first_polling_entry;
 261
 262 int qemu_add_polling_cb(PollingFunc *func, void *opaque)
 263 {
 264     PollingEntry **ppe, *pe;
 265     pe = g_malloc0(sizeof(PollingEntry));
 266     pe->func = func;
 267     pe->opaque = opaque;
 268     for(ppe = &first_polling_entry; *ppe != NULL; ppe = &(*ppe)->next);
 269     *ppe = pe;
 270     return 0;
 271 }
 272
 273 void qemu_del_polling_cb(PollingFunc *func, void *opaque)
 274 {
 275     PollingEntry **ppe, *pe;
 276     for(ppe = &first_polling_entry; *ppe != NULL; ppe = &(*ppe)->next) {
 277         pe = *ppe;
 278         if (pe->func == func && pe->opaque == opaque) {
 279             *ppe = pe->next;
 280             g_free(pe);
 281             break;
 282         }
 283     }
 284 }
 285
 286 /***********************************************************/
 287 /* Wait objects support */
 288 typedef struct WaitObjects {
 289     int num;
 290     int revents[MAXIMUM_WAIT_OBJECTS + 1];
 291     HANDLE events[MAXIMUM_WAIT_OBJECTS + 1];
 292     WaitObjectFunc *func[MAXIMUM_WAIT_OBJECTS + 1];
 293     void *opaque[MAXIMUM_WAIT_OBJECTS + 1];
 294 } WaitObjects;
 295
 296 static WaitObjects wait_objects = {0};
 297
 298 int qemu_add_wait_object(HANDLE handle, WaitObjectFunc *func, void *opaque)
 299 {
 300     WaitObjects *w = &wait_objects;
 301     if (w->num >= MAXIMUM_WAIT_OBJECTS) {
 302         return -1;
 303     }
 304     w->events[w->num] = handle;
 305     w->func[w->num] = func;
 306     w->opaque[w->num] = opaque;
 307     w->revents[w->num] = 0;
 308     w->num++;
 309     return 0;
 310 }
 311
 312 void qemu_del_wait_object(HANDLE handle, WaitObjectFunc *func, void *opaque)
 313 {
 314     int i, found;
 315     WaitObjects *w = &wait_objects;
 316
 317     found = 0;
 318     for (i = 0; i < w->num; i++) {
 319         if (w->events[i] == handle) {
 320             found = 1;
 321         }
 322         if (found) {
 323             w->events[i] = w->events[i + 1];
 324             w->func[i] = w->func[i + 1];
 325             w->opaque[i] = w->opaque[i + 1];
 326             w->revents[i] = w->revents[i + 1];
 327         }
 328     }
 329     if (found) {
 330         w->num--;
 331     }
 332 }
 333
 334 void qemu_fd_register(int fd)
 335 {
 336     WSAEventSelect(fd, event_notifier_get_handle(&qemu_aio_context->notifier),
 337                    FD_READ | FD_ACCEPT | FD_CLOSE |
 338                    FD_CONNECT | FD_WRITE | FD_OOB);
 339 }
 340
 341 static int pollfds_fill(GArray *pollfds, fd_set *rfds, fd_set *wfds,
 342                         fd_set *xfds)
 343 {
 344     int nfds = -1;
 345     int i;
 346
 347     for (i = 0; i < pollfds->len; i++) {
 348         GPollFD *pfd = &g_array_index(pollfds, GPollFD, i);
 349         int fd = pfd->fd;
 350         int events = pfd->events;
 351         if (events & G_IO_IN) {
 352             FD_SET(fd, rfds);
 353             nfds = MAX(nfds, fd);
 354         }
 355         if (events & G_IO_OUT) {
 356             FD_SET(fd, wfds);
 357             nfds = MAX(nfds, fd);
 358         }
 359         if (events & G_IO_PRI) {
 360             FD_SET(fd, xfds);
 361             nfds = MAX(nfds, fd);
 362         }
 363     }
 364     return nfds;
 365 }
 366
 367 static void pollfds_poll(GArray *pollfds, int nfds, fd_set *rfds,
 368                          fd_set *wfds, fd_set *xfds)
 369 {
 370     int i;
 371
 372     for (i = 0; i < pollfds->len; i++) {
 373         GPollFD *pfd = &g_array_index(pollfds, GPollFD, i);
 374         int fd = pfd->fd;
 375         int revents = 0;
 376
 377         if (FD_ISSET(fd, rfds)) {
 378             revents |= G_IO_IN;
 379         }
 380         if (FD_ISSET(fd, wfds)) {
 381             revents |= G_IO_OUT;
 382         }
 383         if (FD_ISSET(fd, xfds)) {
 384             revents |= G_IO_PRI;
 385         }
 386         pfd->revents = revents & pfd->events;
 387     }
 388 }
 389
 390 static int os_host_main_loop_wait(int64_t timeout)
 391 {
 392     GMainContext *context = g_main_context_default();
 393     GPollFD poll_fds[1024 * 2]; /* this is probably overkill */
 394     int select_ret = 0;
 395     int g_poll_ret, ret, i, n_poll_fds;
 396     PollingEntry *pe;
 397     WaitObjects *w = &wait_objects;
 398     gint poll_timeout;
 399     int64_t poll_timeout_ns;
 400     static struct timeval tv0;
 401     fd_set rfds, wfds, xfds;
 402     int nfds;
 403
 404     /* XXX: need to suppress polling by better using win32 events */
 405     ret = 0;
 406     for (pe = first_polling_entry; pe != NULL; pe = pe->next) {
 407         ret |= pe->func(pe->opaque);
 408     }
 409     if (ret != 0) {
 410         return ret;
 411     }
 412
 413     FD_ZERO(&rfds);
 414     FD_ZERO(&wfds);
 415     FD_ZERO(&xfds);
 416     nfds = pollfds_fill(gpollfds, &rfds, &wfds, &xfds);
 417     if (nfds >= 0) {
 418         select_ret = select(nfds + 1, &rfds, &wfds, &xfds, &tv0);
 419         if (select_ret != 0) {
 420             timeout = 0;
 421         }
 422         if (select_ret > 0) {
 423             pollfds_poll(gpollfds, nfds, &rfds, &wfds, &xfds);
 424         }
 425     }
 426
 427     g_main_context_prepare(context, &max_priority);
 428     n_poll_fds = g_main_context_query(context, max_priority, &poll_timeout,
 429                                       poll_fds, ARRAY_SIZE(poll_fds));
 430     g_assert(n_poll_fds <= ARRAY_SIZE(poll_fds));
 431
 432     for (i = 0; i < w->num; i++) {
 433         poll_fds[n_poll_fds + i].fd = (DWORD_PTR)w->events[i];
 434         poll_fds[n_poll_fds + i].events = G_IO_IN;
 435     }
 436
 437     if (poll_timeout < 0) {
 438         poll_timeout_ns = -1;
 439     } else {
 440         poll_timeout_ns = (int64_t)poll_timeout * (int64_t)SCALE_MS;
 441     }
 442
 443     poll_timeout_ns = qemu_soonest_timeout(poll_timeout_ns, timeout);
 444
 445     qemu_mutex_unlock_iothread();
 446     g_poll_ret = qemu_poll_ns(poll_fds, n_poll_fds + w->num, poll_timeout_ns);
 447
 448     qemu_mutex_lock_iothread();
 449     if (g_poll_ret > 0) {
 450         for (i = 0; i < w->num; i++) {
 451             w->revents[i] = poll_fds[n_poll_fds + i].revents;
 452         }
 453         for (i = 0; i < w->num; i++) {
 454             if (w->revents[i] && w->func[i]) {
 455                 w->func[i](w->opaque[i]);
 456             }
 457         }
 458     }
 459
 460     if (g_main_context_check(context, max_priority, poll_fds, n_poll_fds)) {
 461         g_main_context_dispatch(context);
 462     }
 463
 464     return select_ret || g_poll_ret;
 465 }
 466 #endif
 467
 468 int main_loop_wait(int nonblocking)
 469 {
 470     int ret;
 471     uint32_t timeout = UINT32_MAX;
 472     int64_t timeout_ns;
 473
 474     if (nonblocking) {
 475         timeout = 0;
 476     }
 477
 478     /* poll any events */
 479     g_array_set_size(gpollfds, 0); /* reset for new iteration */
 480     /* XXX: separate device handlers from system ones */
 481 #ifdef CONFIG_SLIRP
 482     slirp_pollfds_fill(gpollfds, &timeout);
 483 #endif
 484     qemu_iohandler_fill(gpollfds);
 485
 486     if (timeout == UINT32_MAX) {
 487         timeout_ns = -1;
 488     } else {
 489         timeout_ns = (uint64_t)timeout * (int64_t)(SCALE_MS);
 490     }
 491
 492     timeout_ns = qemu_soonest_timeout(timeout_ns,
 493                                       timerlistgroup_deadline_ns(
 494                                           &main_loop_tlg));
 495
 496     ret = os_host_main_loop_wait(timeout_ns);
 497     qemu_iohandler_poll(gpollfds, ret);
 498 #ifdef CONFIG_SLIRP
 499     slirp_pollfds_poll(gpollfds, (ret < 0));
 500 #endif
 501
 502     qemu_clock_run_all_timers();
 503
 504     return ret;
 505 }
 506
 507 /* Functions to operate on the main QEMU AioContext.  */
 508
 509 QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque)
 510 {
 511     return aio_bh_new(qemu_aio_context, cb, opaque);
 512 }