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