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