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