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