src/utils/eloop_win.c

   1 /*
   2  * Event loop based on Windows events and WaitForMultipleObjects
   3  * Copyright (c) 2002-2009, Jouni Malinen <j@w1.fi>
   4  *
   5  * This software may be distributed under the terms of the BSD license.
   6  * See README for more details.
   7  */
   8
   9 #include "includes.h"
  10 #include <winsock2.h>
  11
  12 #include "common.h"
  13 #include "list.h"
  14 #include "eloop.h"
  15
  16
  17 struct eloop_sock {
  18         int sock;
  19         void *eloop_data;
  20         void *user_data;
  21         eloop_sock_handler handler;
  22         WSAEVENT event;
  23 };
  24
  25 struct eloop_event {
  26         void *eloop_data;
  27         void *user_data;
  28         eloop_event_handler handler;
  29         HANDLE event;
  30 };
  31
  32 struct eloop_timeout {
  33         struct dl_list list;
  34         struct os_time time;
  35         void *eloop_data;
  36         void *user_data;
  37         eloop_timeout_handler handler;
  38 };
  39
  40 struct eloop_signal {
  41         int sig;
  42         void *user_data;
  43         eloop_signal_handler handler;
  44         int signaled;
  45 };
  46
  47 struct eloop_data {
  48         int max_sock;
  49         size_t reader_count;
  50         struct eloop_sock *readers;
  51
  52         size_t event_count;
  53         struct eloop_event *events;
  54
  55         struct dl_list timeout;
  56
  57         int signal_count;
  58         struct eloop_signal *signals;
  59         int signaled;
  60         int pending_terminate;
  61
  62         int terminate;
  63         int reader_table_changed;
  64
  65         struct eloop_signal term_signal;
  66         HANDLE term_event;
  67
  68         HANDLE *handles;
  69         size_t num_handles;
  70 };
  71
  72 static struct eloop_data eloop;
  73
  74
  75 int eloop_init(void)
  76 {
  77         os_memset(&eloop, 0, sizeof(eloop));
  78         dl_list_init(&eloop.timeout);
  79         eloop.num_handles = 1;
  80         eloop.handles = os_malloc(eloop.num_handles *
  81                                   sizeof(eloop.handles[0]));
  82         if (eloop.handles == NULL)
  83                 return -1;
  84
  85         eloop.term_event = CreateEvent(NULL, FALSE, FALSE, NULL);
  86         if (eloop.term_event == NULL) {
  87                 printf("CreateEvent() failed: %d\n",
  88                        (int) GetLastError());
  89                 os_free(eloop.handles);
  90                 return -1;
  91         }
  92
  93         return 0;
  94 }
  95
  96
  97 static int eloop_prepare_handles(void)
  98 {
  99         HANDLE *n;
 100
 101         if (eloop.num_handles > eloop.reader_count + eloop.event_count + 8)
 102                 return 0;
 103         n = os_realloc_array(eloop.handles, eloop.num_handles * 2,
 104                              sizeof(eloop.handles[0]));
 105         if (n == NULL)
 106                 return -1;
 107         eloop.handles = n;
 108         eloop.num_handles *= 2;
 109         return 0;
 110 }
 111
 112
 113 int eloop_register_read_sock(int sock, eloop_sock_handler handler,
 114                              void *eloop_data, void *user_data)
 115 {
 116         WSAEVENT event;
 117         struct eloop_sock *tmp;
 118
 119         if (eloop_prepare_handles())
 120                 return -1;
 121
 122         event = WSACreateEvent();
 123         if (event == WSA_INVALID_EVENT) {
 124                 printf("WSACreateEvent() failed: %d\n", WSAGetLastError());
 125                 return -1;
 126         }
 127
 128         if (WSAEventSelect(sock, event, FD_READ)) {
 129                 printf("WSAEventSelect() failed: %d\n", WSAGetLastError());
 130                 WSACloseEvent(event);
 131                 return -1;
 132         }
 133         tmp = os_realloc_array(eloop.readers, eloop.reader_count + 1,
 134                                sizeof(struct eloop_sock));
 135         if (tmp == NULL) {
 136                 WSAEventSelect(sock, event, 0);
 137                 WSACloseEvent(event);
 138                 return -1;
 139         }
 140
 141         tmp[eloop.reader_count].sock = sock;
 142         tmp[eloop.reader_count].eloop_data = eloop_data;
 143         tmp[eloop.reader_count].user_data = user_data;
 144         tmp[eloop.reader_count].handler = handler;
 145         tmp[eloop.reader_count].event = event;
 146         eloop.reader_count++;
 147         eloop.readers = tmp;
 148         if (sock > eloop.max_sock)
 149                 eloop.max_sock = sock;
 150         eloop.reader_table_changed = 1;
 151
 152         return 0;
 153 }
 154
 155
 156 void eloop_unregister_read_sock(int sock)
 157 {
 158         size_t i;
 159
 160         if (eloop.readers == NULL || eloop.reader_count == 0)
 161                 return;
 162
 163         for (i = 0; i < eloop.reader_count; i++) {
 164                 if (eloop.readers[i].sock == sock)
 165                         break;
 166         }
 167         if (i == eloop.reader_count)
 168                 return;
 169
 170         WSAEventSelect(eloop.readers[i].sock, eloop.readers[i].event, 0);
 171         WSACloseEvent(eloop.readers[i].event);
 172
 173         if (i != eloop.reader_count - 1) {
 174                 os_memmove(&eloop.readers[i], &eloop.readers[i + 1],
 175                            (eloop.reader_count - i - 1) *
 176                            sizeof(struct eloop_sock));
 177         }
 178         eloop.reader_count--;
 179         eloop.reader_table_changed = 1;
 180 }
 181
 182
 183 int eloop_register_event(void *event, size_t event_size,
 184                          eloop_event_handler handler,
 185                          void *eloop_data, void *user_data)
 186 {
 187         struct eloop_event *tmp;
 188         HANDLE h = event;
 189
 190         if (event_size != sizeof(HANDLE) || h == INVALID_HANDLE_VALUE)
 191                 return -1;
 192
 193         if (eloop_prepare_handles())
 194                 return -1;
 195
 196         tmp = os_realloc_array(eloop.events, eloop.event_count + 1,
 197                                sizeof(struct eloop_event));
 198         if (tmp == NULL)
 199                 return -1;
 200
 201         tmp[eloop.event_count].eloop_data = eloop_data;
 202         tmp[eloop.event_count].user_data = user_data;
 203         tmp[eloop.event_count].handler = handler;
 204         tmp[eloop.event_count].event = h;
 205         eloop.event_count++;
 206         eloop.events = tmp;
 207
 208         return 0;
 209 }
 210
 211
 212 void eloop_unregister_event(void *event, size_t event_size)
 213 {
 214         size_t i;
 215         HANDLE h = event;
 216
 217         if (eloop.events == NULL || eloop.event_count == 0 ||
 218             event_size != sizeof(HANDLE))
 219                 return;
 220
 221         for (i = 0; i < eloop.event_count; i++) {
 222                 if (eloop.events[i].event == h)
 223                         break;
 224         }
 225         if (i == eloop.event_count)
 226                 return;
 227
 228         if (i != eloop.event_count - 1) {
 229                 os_memmove(&eloop.events[i], &eloop.events[i + 1],
 230                            (eloop.event_count - i - 1) *
 231                            sizeof(struct eloop_event));
 232         }
 233         eloop.event_count--;
 234 }
 235
 236
 237 int eloop_register_timeout(unsigned int secs, unsigned int usecs,
 238                            eloop_timeout_handler handler,
 239                            void *eloop_data, void *user_data)
 240 {
 241         struct eloop_timeout *timeout, *tmp;
 242         os_time_t now_sec;
 243
 244         timeout = os_zalloc(sizeof(*timeout));
 245         if (timeout == NULL)
 246                 return -1;
 247         if (os_get_time(&timeout->time) < 0) {
 248                 os_free(timeout);
 249                 return -1;
 250         }
 251         now_sec = timeout->time.sec;
 252         timeout->time.sec += secs;
 253         if (timeout->time.sec < now_sec) {
 254                 /*
 255                  * Integer overflow - assume long enough timeout to be assumed
 256                  * to be infinite, i.e., the timeout would never happen.
 257                  */
 258                 wpa_printf(MSG_DEBUG, "ELOOP: Too long timeout (secs=%u) to "
 259                            "ever happen - ignore it", secs);
 260                 os_free(timeout);
 261                 return 0;
 262         }
 263         timeout->time.usec += usecs;
 264         while (timeout->time.usec >= 1000000) {
 265                 timeout->time.sec++;
 266                 timeout->time.usec -= 1000000;
 267         }
 268         timeout->eloop_data = eloop_data;
 269         timeout->user_data = user_data;
 270         timeout->handler = handler;
 271
 272         /* Maintain timeouts in order of increasing time */
 273         dl_list_for_each(tmp, &eloop.timeout, struct eloop_timeout, list) {
 274                 if (os_time_before(&timeout->time, &tmp->time)) {
 275                         dl_list_add(tmp->list.prev, &timeout->list);
 276                         return 0;
 277                 }
 278         }
 279         dl_list_add_tail(&eloop.timeout, &timeout->list);
 280
 281         return 0;
 282 }
 283
 284
 285 static void eloop_remove_timeout(struct eloop_timeout *timeout)
 286 {
 287         dl_list_del(&timeout->list);
 288         os_free(timeout);
 289 }
 290
 291
 292 int eloop_cancel_timeout(eloop_timeout_handler handler,
 293                          void *eloop_data, void *user_data)
 294 {
 295         struct eloop_timeout *timeout, *prev;
 296         int removed = 0;
 297
 298         dl_list_for_each_safe(timeout, prev, &eloop.timeout,
 299                               struct eloop_timeout, list) {
 300                 if (timeout->handler == handler &&
 301                     (timeout->eloop_data == eloop_data ||
 302                      eloop_data == ELOOP_ALL_CTX) &&
 303                     (timeout->user_data == user_data ||
 304                      user_data == ELOOP_ALL_CTX)) {
 305                         eloop_remove_timeout(timeout);
 306                         removed++;
 307                 }
 308         }
 309
 310         return removed;
 311 }
 312
 313
 314 int eloop_is_timeout_registered(eloop_timeout_handler handler,
 315                                 void *eloop_data, void *user_data)
 316 {
 317         struct eloop_timeout *tmp;
 318
 319         dl_list_for_each(tmp, &eloop.timeout, struct eloop_timeout, list) {
 320                 if (tmp->handler == handler &&
 321                     tmp->eloop_data == eloop_data &&
 322                     tmp->user_data == user_data)
 323                         return 1;
 324         }
 325
 326         return 0;
 327 }
 328
 329
 330 /* TODO: replace with suitable signal handler */
 331 #if 0
 332 static void eloop_handle_signal(int sig)
 333 {
 334         int i;
 335
 336         eloop.signaled++;
 337         for (i = 0; i < eloop.signal_count; i++) {
 338                 if (eloop.signals[i].sig == sig) {
 339                         eloop.signals[i].signaled++;
 340                         break;
 341                 }
 342         }
 343 }
 344 #endif
 345
 346
 347 static void eloop_process_pending_signals(void)
 348 {
 349         int i;
 350
 351         if (eloop.signaled == 0)
 352                 return;
 353         eloop.signaled = 0;
 354
 355         if (eloop.pending_terminate) {
 356                 eloop.pending_terminate = 0;
 357         }
 358
 359         for (i = 0; i < eloop.signal_count; i++) {
 360                 if (eloop.signals[i].signaled) {
 361                         eloop.signals[i].signaled = 0;
 362                         eloop.signals[i].handler(eloop.signals[i].sig,
 363                                                  eloop.signals[i].user_data);
 364                 }
 365         }
 366
 367         if (eloop.term_signal.signaled) {
 368                 eloop.term_signal.signaled = 0;
 369                 eloop.term_signal.handler(eloop.term_signal.sig,
 370                                           eloop.term_signal.user_data);
 371         }
 372 }
 373
 374
 375 int eloop_register_signal(int sig, eloop_signal_handler handler,
 376                           void *user_data)
 377 {
 378         struct eloop_signal *tmp;
 379
 380         tmp = os_realloc_array(eloop.signals, eloop.signal_count + 1,
 381                                sizeof(struct eloop_signal));
 382         if (tmp == NULL)
 383                 return -1;
 384
 385         tmp[eloop.signal_count].sig = sig;
 386         tmp[eloop.signal_count].user_data = user_data;
 387         tmp[eloop.signal_count].handler = handler;
 388         tmp[eloop.signal_count].signaled = 0;
 389         eloop.signal_count++;
 390         eloop.signals = tmp;
 391
 392         /* TODO: register signal handler */
 393
 394         return 0;
 395 }
 396
 397
 398 #ifndef _WIN32_WCE
 399 static BOOL eloop_handle_console_ctrl(DWORD type)
 400 {
 401         switch (type) {
 402         case CTRL_C_EVENT:
 403         case CTRL_BREAK_EVENT:
 404                 eloop.signaled++;
 405                 eloop.term_signal.signaled++;
 406                 SetEvent(eloop.term_event);
 407                 return TRUE;
 408         default:
 409                 return FALSE;
 410         }
 411 }
 412 #endif /* _WIN32_WCE */
 413
 414
 415 int eloop_register_signal_terminate(eloop_signal_handler handler,
 416                                     void *user_data)
 417 {
 418 #ifndef _WIN32_WCE
 419         if (SetConsoleCtrlHandler((PHANDLER_ROUTINE) eloop_handle_console_ctrl,
 420                                   TRUE) == 0) {
 421                 printf("SetConsoleCtrlHandler() failed: %d\n",
 422                        (int) GetLastError());
 423                 return -1;
 424         }
 425 #endif /* _WIN32_WCE */
 426
 427         eloop.term_signal.handler = handler;
 428         eloop.term_signal.user_data = user_data;
 429
 430         return 0;
 431 }
 432
 433
 434 int eloop_register_signal_reconfig(eloop_signal_handler handler,
 435                                    void *user_data)
 436 {
 437         /* TODO */
 438         return 0;
 439 }
 440
 441
 442 void eloop_run(void)
 443 {
 444         struct os_time tv, now;
 445         DWORD count, ret, timeout_val, err;
 446         size_t i;
 447
 448         while (!eloop.terminate &&
 449                (!dl_list_empty(&eloop.timeout) || eloop.reader_count > 0 ||
 450                 eloop.event_count > 0)) {
 451                 struct eloop_timeout *timeout;
 452                 tv.sec = tv.usec = 0;
 453                 timeout = dl_list_first(&eloop.timeout, struct eloop_timeout,
 454                                         list);
 455                 if (timeout) {
 456                         os_get_time(&now);
 457                         if (os_time_before(&now, &timeout->time))
 458                                 os_time_sub(&timeout->time, &now, &tv);
 459                 }
 460
 461                 count = 0;
 462                 for (i = 0; i < eloop.event_count; i++)
 463                         eloop.handles[count++] = eloop.events[i].event;
 464
 465                 for (i = 0; i < eloop.reader_count; i++)
 466                         eloop.handles[count++] = eloop.readers[i].event;
 467
 468                 if (eloop.term_event)
 469                         eloop.handles[count++] = eloop.term_event;
 470
 471                 if (timeout)
 472                         timeout_val = tv.sec * 1000 + tv.usec / 1000;
 473                 else
 474                         timeout_val = INFINITE;
 475
 476                 if (count > MAXIMUM_WAIT_OBJECTS) {
 477                         printf("WaitForMultipleObjects: Too many events: "
 478                                "%d > %d (ignoring extra events)\n",
 479                                (int) count, MAXIMUM_WAIT_OBJECTS);
 480                         count = MAXIMUM_WAIT_OBJECTS;
 481                 }
 482 #ifdef _WIN32_WCE
 483                 ret = WaitForMultipleObjects(count, eloop.handles, FALSE,
 484                                              timeout_val);
 485 #else /* _WIN32_WCE */
 486                 ret = WaitForMultipleObjectsEx(count, eloop.handles, FALSE,
 487                                                timeout_val, TRUE);
 488 #endif /* _WIN32_WCE */
 489                 err = GetLastError();
 490
 491                 eloop_process_pending_signals();
 492
 493                 /* check if some registered timeouts have occurred */
 494                 timeout = dl_list_first(&eloop.timeout, struct eloop_timeout,
 495                                         list);
 496                 if (timeout) {
 497                         os_get_time(&now);
 498                         if (!os_time_before(&now, &timeout->time)) {
 499                                 void *eloop_data = timeout->eloop_data;
 500                                 void *user_data = timeout->user_data;
 501                                 eloop_timeout_handler handler =
 502                                         timeout->handler;
 503                                 eloop_remove_timeout(timeout);
 504                                 handler(eloop_data, user_data);
 505                         }
 506
 507                 }
 508
 509                 if (ret == WAIT_FAILED) {
 510                         printf("WaitForMultipleObjects(count=%d) failed: %d\n",
 511                                (int) count, (int) err);
 512                         os_sleep(1, 0);
 513                         continue;
 514                 }
 515
 516 #ifndef _WIN32_WCE
 517                 if (ret == WAIT_IO_COMPLETION)
 518                         continue;
 519 #endif /* _WIN32_WCE */
 520
 521                 if (ret == WAIT_TIMEOUT)
 522                         continue;
 523
 524                 while (ret >= WAIT_OBJECT_0 &&
 525                        ret < WAIT_OBJECT_0 + eloop.event_count) {
 526                         eloop.events[ret].handler(
 527                                 eloop.events[ret].eloop_data,
 528                                 eloop.events[ret].user_data);
 529                         ret = WaitForMultipleObjects(eloop.event_count,
 530                                                      eloop.handles, FALSE, 0);
 531                 }
 532
 533                 eloop.reader_table_changed = 0;
 534                 for (i = 0; i < eloop.reader_count; i++) {
 535                         WSANETWORKEVENTS events;
 536                         if (WSAEnumNetworkEvents(eloop.readers[i].sock,
 537                                                  eloop.readers[i].event,
 538                                                  &events) == 0 &&
 539                             (events.lNetworkEvents & FD_READ)) {
 540                                 eloop.readers[i].handler(
 541                                         eloop.readers[i].sock,
 542                                         eloop.readers[i].eloop_data,
 543                                         eloop.readers[i].user_data);
 544                                 if (eloop.reader_table_changed)
 545                                         break;
 546                         }
 547                 }
 548         }
 549 }
 550
 551
 552 void eloop_terminate(void)
 553 {
 554         eloop.terminate = 1;
 555         SetEvent(eloop.term_event);
 556 }
 557
 558
 559 void eloop_destroy(void)
 560 {
 561         struct eloop_timeout *timeout, *prev;
 562
 563         dl_list_for_each_safe(timeout, prev, &eloop.timeout,
 564                               struct eloop_timeout, list) {
 565                 eloop_remove_timeout(timeout);
 566         }
 567         os_free(eloop.readers);
 568         os_free(eloop.signals);
 569         if (eloop.term_event)
 570                 CloseHandle(eloop.term_event);
 571         os_free(eloop.handles);
 572         eloop.handles = NULL;
 573         os_free(eloop.events);
 574         eloop.events = NULL;
 575 }
 576
 577
 578 int eloop_terminated(void)
 579 {
 580         return eloop.terminate;
 581 }
 582
 583
 584 void eloop_wait_for_read_sock(int sock)
 585 {
 586         WSAEVENT event;
 587
 588         event = WSACreateEvent();
 589         if (event == WSA_INVALID_EVENT) {
 590                 printf("WSACreateEvent() failed: %d\n", WSAGetLastError());
 591                 return;
 592         }
 593
 594         if (WSAEventSelect(sock, event, FD_READ)) {
 595                 printf("WSAEventSelect() failed: %d\n", WSAGetLastError());
 596                 WSACloseEvent(event);
 597                 return ;
 598         }
 599
 600         WaitForSingleObject(event, INFINITE);
 601         WSAEventSelect(sock, event, 0);
 602         WSACloseEvent(event);
 603 }