src/socketengine_iocp.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "socketengine_iocp.h"
  15 #include "exitcodes.h"
  16 #include <mswsock.h>
  17
  18 IOCPEngine::IOCPEngine(InspIRCd * Instance) : SocketEngine(Instance)
  19 {
  20         /* Create completion port */
  21         m_completionPort = CreateIoCompletionPort(INVALID_HANDLE_VALUE, NULL, (ULONG_PTR)0, 0);
  22
  23         if (!m_completionPort)
  24         {
  25                 ServerInstance->Log(SPARSE,"ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
  26                 ServerInstance->Log(SPARSE,"ERROR: this is a fatal error, exiting now.");
  27                 printf("ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
  28                 printf("ERROR: this is a fatal error, exiting now.");
  29                 ServerInstance->Exit(EXIT_STATUS_SOCKETENGINE);
  30         }
  31
  32         /* Null variables out. */
  33         CurrentSetSize = 0;
  34         EngineHandle = 0;
  35         memset(ref, 0, sizeof(EventHandler*) * MAX_DESCRIPTORS);
  36 }
  37
  38 IOCPEngine::~IOCPEngine()
  39 {
  40         /* Clean up winsock and close completion port */
  41         CloseHandle(m_completionPort);
  42         WSACleanup();
  43 }
  44
  45 bool IOCPEngine::AddFd(EventHandler* eh)
  46 {
  47         /* Does it at least look valid? */
  48         if (!eh)
  49                 return false;
  50
  51         int* fake_fd = new int(GenerateFd(eh->GetFd()));
  52         int is_accept = 0;
  53         int opt_len = sizeof(int);
  54
  55         /* In range? */
  56         if ((*fake_fd < 0) || (*fake_fd > MAX_DESCRIPTORS))
  57                 return false;
  58
  59         /* Already an entry here */
  60         if (ref[*fake_fd])
  61         {
  62                 delete fake_fd;
  63                 return false;
  64         }
  65
  66         /* are we a listen socket? */
  67         getsockopt(eh->GetFd(), SOL_SOCKET, SO_ACCEPTCONN, (char*)&is_accept, &opt_len);
  68
  69         /* set up the read event so the socket can actually receive data :P */
  70         eh->Extend("internal_fd", fake_fd);
  71
  72         unsigned long completion_key = (ULONG_PTR)*fake_fd;
  73         /* assign the socket to the completion port */
  74         if (!CreateIoCompletionPort((HANDLE)eh->GetFd(), m_completionPort, completion_key, 0))
  75                 return false;
  76
  77         /* set up binding, increase set size */
  78         ref[*fake_fd] = eh;
  79         ++CurrentSetSize;
  80
  81         /* setup initial events */
  82         if(is_accept)
  83                 PostAcceptEvent(eh);
  84         else
  85                 PostReadEvent(eh);
  86
  87         /* log message */
  88         ServerInstance->Log(DEBUG, "New fake fd: %u, real fd: %u, address 0x%p", *fake_fd, eh->GetFd(), eh);
  89
  90         /* post a write event if there is data to be written */
  91         if(eh->Writeable())
  92                 WantWrite(eh);
  93
  94         /* we're all good =) */
  95         try
  96         {
  97                 m_binding.insert( map<int, EventHandler*>::value_type( eh->GetFd(), eh ) );
  98         }
  99         catch (...)
 100         {
 101                 /* Ohshi-, map::insert failed :/ */
 102                 return false;
 103         }
 104
 105         return true;
 106 }
 107
 108 bool IOCPEngine::DelFd(EventHandler* eh, bool force /* = false */)
 109 {
 110         if (!eh)
 111                 return false;
 112
 113         int* fake_fd = NULL;
 114
 115         if (!eh->GetExt("internal_fd", fake_fd))
 116                 return false;
 117
 118         int fd = eh->GetFd();
 119
 120         if (!ref[*fake_fd])
 121                 return false;
 122
 123         void* m_readEvent = NULL;
 124         void* m_writeEvent = NULL;
 125         void* m_acceptEvent = NULL;
 126
 127         ServerInstance->Log(DEBUG, "Removing fake fd %u, real fd %u, address 0x%p", *fake_fd, eh->GetFd(), eh);
 128
 129         /* Cancel pending i/o operations. */
 130         if (CancelIo((HANDLE)fd) == FALSE)
 131                 return false;
 132
 133         /* Free the buffer, and delete the event. */
 134         if (eh->GetExt("windows_readevent", m_readEvent))
 135         {
 136                 if(((Overlapped*)m_readEvent)->m_params != 0)
 137                         delete ((udp_overlap*)((Overlapped*)m_readEvent)->m_params);
 138
 139                 delete ((Overlapped*)m_readEvent);
 140                 eh->Shrink("windows_readevent");
 141         }
 142
 143         if(eh->GetExt("windows_writeevent", m_writeEvent))
 144         {
 145                 delete ((Overlapped*)m_writeEvent);
 146                 eh->Shrink("windows_writeevent");
 147         }
 148
 149         if(eh->GetExt("windows_acceptevent", m_acceptEvent))
 150         {
 151                 delete ((accept_overlap*)((Overlapped*)m_acceptEvent)->m_params);
 152                 delete ((Overlapped*)m_acceptEvent);
 153                 eh->Shrink("windows_accepevent");
 154         }
 155
 156         /* Clear binding */
 157         ref[*fake_fd] = 0;
 158         m_binding.erase(eh->GetFd());
 159
 160         delete fake_fd;
 161         eh->Shrink("internal_fd");
 162
 163         /* decrement set size */
 164         --CurrentSetSize;
 165
 166         /* success */
 167         return true;
 168 }
 169
 170 void IOCPEngine::WantWrite(EventHandler* eh)
 171 {
 172         if (!eh)
 173                 return;
 174
 175         void* m_writeEvent = NULL;
 176
 177         int* fake_fd = NULL;
 178         if (!eh->GetExt("internal_fd", fake_fd))
 179                 return;
 180
 181         /* Post event - write begin */
 182         if(!eh->GetExt("windows_writeevent", m_writeEvent))
 183         {
 184                 ULONG_PTR completion_key = (ULONG_PTR)*fake_fd;
 185                 Overlapped * ov = new Overlapped(SOCKET_IO_EVENT_WRITE_READY, 0);
 186                 eh->Shrink("windows_writeevent");
 187                 eh->Extend("windows_writeevent",ov);
 188                 PostQueuedCompletionStatus(m_completionPort, 0, completion_key, &ov->m_overlap);
 189         }
 190 }
 191
 192 bool IOCPEngine::PostCompletionEvent(EventHandler * eh, SocketIOEvent type, int param)
 193 {
 194         if (!eh)
 195                 return false;
 196
 197         int* fake_fd = NULL;
 198         if (!eh->GetExt("internal_fd", fake_fd))
 199                 return false;
 200
 201         Overlapped * ov = new Overlapped(type, param);
 202         ULONG_PTR completion_key = (ULONG_PTR)*fake_fd;
 203         return PostQueuedCompletionStatus(m_completionPort, 0, completion_key, &ov->m_overlap);
 204 }
 205
 206 void IOCPEngine::PostReadEvent(EventHandler * eh)
 207 {
 208         if (!eh)
 209                 return;
 210
 211         Overlapped * ov = new Overlapped(SOCKET_IO_EVENT_READ_READY, 0);
 212         DWORD flags = 0;
 213         DWORD r_length = 0;
 214         WSABUF buf;
 215
 216         /* by passing a null buffer pointer, we can have this working in the same way as epoll..
 217          * its slower, but it saves modifying all network code.
 218          */
 219         buf.buf = 0;
 220         buf.len = 0;
 221
 222         /* determine socket type. */
 223         DWORD sock_type;
 224         int sock_len = sizeof(DWORD);
 225         if(getsockopt(eh->GetFd(), SOL_SOCKET, SO_TYPE, (char*)&sock_type, &sock_len) == -1)
 226         {
 227                 /* wtfhax? */
 228                 PostCompletionEvent(eh, SOCKET_IO_EVENT_ERROR, 0);
 229                 delete ov;
 230                 return;
 231         }
 232         switch(sock_type)
 233         {
 234                 case SOCK_DGRAM:                        /* UDP Socket */
 235                 {
 236                         udp_overlap * uv = new udp_overlap;
 237                         uv->udp_sockaddr_len = sizeof(sockaddr);
 238                         buf.buf = (char*)uv->udp_buffer;
 239                         buf.len = sizeof(uv->udp_buffer);
 240                         ov->m_params = (unsigned long)uv;
 241                         if(WSARecvFrom(eh->GetFd(), &buf, 1, &uv->udp_len, &flags, uv->udp_sockaddr, (LPINT)&uv->udp_sockaddr_len, &ov->m_overlap, 0))
 242                         {
 243                                 int err = WSAGetLastError();
 244                                 if(err != WSA_IO_PENDING)
 245                                 {
 246                                         delete ov;
 247                                         PostCompletionEvent(eh, SOCKET_IO_EVENT_ERROR, 0);
 248                                         return;
 249                                 }
 250                         }
 251                 }
 252                 break;
 253
 254                 case SOCK_STREAM:                       /* TCP Socket */
 255                 {
 256                         if(WSARecv(eh->GetFd(), &buf, 1, &r_length, &flags, &ov->m_overlap, 0) == SOCKET_ERROR)
 257                         {
 258                                 if(WSAGetLastError() != WSA_IO_PENDING)
 259                                 {
 260                                         delete ov;
 261                                         PostCompletionEvent(eh, SOCKET_IO_EVENT_ERROR, 0);
 262                                         return;
 263                                 }
 264                         }
 265                 }
 266                 break;
 267
 268                 default:
 269                 {
 270                         printf("unknwon socket type: %u\n", sock_type);
 271                         return;
 272                 }
 273                 break;
 274         }
 275         eh->Extend("windows_readevent", ov);
 276 }
 277
 278 int IOCPEngine::DispatchEvents()
 279 {
 280         DWORD len;
 281         LPOVERLAPPED overlap;
 282         Overlapped * ov;
 283         EventHandler * eh;
 284         ULONG_PTR intfd;
 285         int ret;
 286         unsigned long bytes_recv;
 287
 288         while (GetQueuedCompletionStatus(m_completionPort, &len, &intfd, &overlap, 1000))
 289         {
 290                 if (intfd < 0 || intfd > MAX_DESCRIPTORS)
 291                         continue;
 292
 293                 // woot, we got an event on a socket :P
 294                 eh = ref[intfd];
 295                 ov = CONTAINING_RECORD(overlap, Overlapped, m_overlap);
 296
 297                 if (eh == 0)
 298                         continue;
 299
 300                 void* m_readEvent = NULL;
 301                 void* m_writeEvent = NULL;
 302
 303                 eh->GetExt("windows_readevent", m_readEvent);
 304                 eh->GetExt("windows_writeevent", m_writeEvent);
 305
 306                 switch(ov->m_event)
 307                 {
 308                         case SOCKET_IO_EVENT_WRITE_READY:
 309                         {
 310                                 eh->Shrink("windows_writeevent");
 311                                 eh->HandleEvent(EVENT_WRITE, 0);
 312                         }
 313                         break;
 314
 315                         case SOCKET_IO_EVENT_READ_READY:
 316                         {
 317                                 if(ov->m_params)
 318                                 {
 319                                         // if we had params, it means we are a udp socket with a udp_overlap pointer in this long.
 320                                         udp_overlap * uv = (udp_overlap*)ov->m_params;
 321                                         uv->udp_len = len;
 322                                         this->udp_ov = uv;
 323                                         eh->Shrink("windows_readevent");
 324                                         eh->HandleEvent(EVENT_READ, 0);
 325                                         this->udp_ov = 0;
 326                                         delete uv;
 327                                         PostReadEvent(eh);
 328                                 }
 329                                 else
 330                                 {
 331                                         ret = ioctlsocket(eh->GetFd(), FIONREAD, &bytes_recv);
 332                                         eh->Shrink("windows_readevent");
 333                                         if(ret != 0 || bytes_recv == 0)
 334                                         {
 335                                                 /* end of file */
 336                                                 PostCompletionEvent(eh, SOCKET_IO_EVENT_ERROR, EIO); /* Old macdonald had an error, EIEIO. */
 337                                         }
 338                                         else
 339                                         {
 340                                                 eh->HandleEvent(EVENT_READ, 0);
 341                                                 PostReadEvent(eh);
 342                                         }
 343                                 }
 344                         }
 345                         break;
 346
 347                         case SOCKET_IO_EVENT_ACCEPT:
 348                         {
 349                                 /* this is kinda messy.. :/ */
 350                                 eh->HandleEvent(EVENT_READ, ov->m_params);
 351                                 delete ((accept_overlap*)ov->m_params);
 352                                 eh->Shrink("windows_acceptevent");
 353                                 PostAcceptEvent(eh);
 354                         }
 355                         break;
 356
 357                         case SOCKET_IO_EVENT_ERROR:
 358                         {
 359                                 eh->HandleEvent(EVENT_ERROR, ov->m_params);
 360                         }
 361                         break;
 362                 }
 363
 364                 delete ov;
 365         }
 366
 367         return 0;
 368 }
 369
 370 void IOCPEngine::PostAcceptEvent(EventHandler * eh)
 371 {
 372         if (!eh)
 373                 return;
 374
 375         int on = 1;
 376         u_long arg = 1;
 377         struct linger linger = { 0 };
 378
 379         int fd = WSASocket(AF_INET, SOCK_STREAM, 0, 0, 0, WSA_FLAG_OVERLAPPED);
 380
 381         setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char*)&on, sizeof(on));
 382         /* This is BSD compatible, setting l_onoff to 0 is *NOT* http://web.irc.org/mla/ircd-dev/msg02259.html */
 383         linger.l_onoff = 1;
 384         linger.l_linger = 1;
 385         setsockopt(fd, SOL_SOCKET, SO_LINGER, (char*)&linger,sizeof(linger));
 386         ioctlsocket(fd, FIONBIO, &arg);
 387
 388         int len = sizeof(sockaddr_in) + 16;
 389         DWORD dwBytes;
 390         accept_overlap* ao = new accept_overlap;
 391         memset(ao->buf, 0, 1024);
 392         ao->socket = fd;
 393
 394         Overlapped* ov = new Overlapped(SOCKET_IO_EVENT_ACCEPT, (int)ao);
 395         eh->Extend("windows_acceptevent", ov);
 396
 397         if(AcceptEx(eh->GetFd(), fd, ao->buf, 0, len, len, &dwBytes, &ov->m_overlap) == FALSE)
 398         {
 399                 int err = WSAGetLastError();
 400                 if(err != WSA_IO_PENDING)
 401                 {
 402                         printf("PostAcceptEvent err: %d\n", err);
 403                 }
 404         }
 405 }
 406
 407
 408 std::string IOCPEngine::GetName()
 409 {
 410         return "iocp";
 411 }
 412
 413 EventHandler * IOCPEngine::GetRef(int fd)
 414 {
 415         map<int, EventHandler*>::iterator itr = m_binding.find(fd);
 416         return (itr == m_binding.end()) ? 0 : itr->second;
 417 }
 418
 419 bool IOCPEngine::HasFd(int fd)
 420 {
 421         return (GetRef(fd) != 0);
 422 }
 423
 424 bool IOCPEngine::BoundsCheckFd(EventHandler* eh)
 425 {
 426         int * internal_fd;
 427         if (!eh || eh->GetFd() < 0)
 428                 return false;
 429
 430         if(!eh->GetExt("internal_fd", internal_fd))
 431                 return false;
 432
 433         if(*internal_fd > MAX_DESCRIPTORS)
 434                 return false;
 435
 436         return true;
 437 }
 438
 439 EventHandler * IOCPEngine::GetIntRef(int fd)
 440 {
 441         if(fd < 0 || fd > MAX_DESCRIPTORS)
 442                 return 0;
 443         return ref[fd];
 444 }
 445
 446 int IOCPEngine::Accept(EventHandler* fd, sockaddr *addr, socklen_t *addrlen)
 447 {
 448         SOCKET s = fd->GetFd();
 449
 450         Overlapped* acceptevent = NULL;
 451         if (!fd->GetExt("windows_acceptevent", acceptevent))
 452                 /* Shit, no accept event on this socket! :( */
 453                 return -1;
 454
 455         Overlapped* ovl = acceptevent;
 456         accept_overlap* ov = (accept_overlap*)ovl->m_params;
 457
 458         sockaddr_in* server_address = (sockaddr_in*)&ov->buf[10];
 459         sockaddr_in* client_address = (sockaddr_in*)&ov->buf[38];
 460
 461         memcpy(addr, client_address, sizeof(sockaddr_in));
 462         *addrlen = sizeof(sockaddr_in);
 463
 464         return ov->socket;
 465 }
 466
 467 int IOCPEngine::GetSockName(EventHandler* fd, sockaddr *name, socklen_t* name)
 468 {
 469         Overlapped* ovl = NULL;
 470
 471         if (!fd->GetExt("windows_acceptevent", acceptevent))
 472                 return -1;
 473
 474         accept_overlap* ov = (accept_overlap*)ovl->m_params;
 475
 476         sockaddr_in* server_address = (sockaddr_in*)&ov->buf[10];
 477         sockaddr_in* client_address = (sockaddr_in*)&ov->buf[38];
 478
 479         memcpy(name, server_address, sizeof(sockaddr_in));
 480         *namelen = sizeof(sockaddr_in);
 481
 482         return 0;
 483 }
 484
 485 int IOCPEngine::RecvFrom(EventHandler* fd, void *buf, size_t len, int flags, struct sockaddr *from, socklen_t *fromlen)
 486 {
 487         udp_overlap * ov = NULL;
 488         if (!fd->GetExt("windows_readevent", ov))
 489                 return -1;
 490         memcpy(buf, ov->udp_buffer, ov->udp_len);
 491         memcpy(from, ov->udp_sockaddr, *fromlen);
 492         return ov->udp_len;
 493 }
 494
 495 int IOCPEngine::Blocking(int fd)
 496 {
 497         unsigned long opt = 0;
 498         ioctlsocket(s, FIONBIO, &opt);
 499 }
 500
 501 int IOCPEngine::NonBlocking(int fd)
 502 {
 503         unsigned long opt = 1;
 504         ioctlsocket(s, FIONBIO, &opt);
 505 }
 506
 507 int IOCPEngine::Close(int fd)
 508 {
 509         return closesocket(socket);
 510 }
 511
 512 int IOCPEngine::Close(EventHandler* fd)
 513 {
 514         return this->Close(fd->GetFd());
 515 }
 516