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