src/socketengines/socketengine_iocp.cpp

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