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