Source/NetworkCallbackController.mm

   1 /*
   2  * MacGDBp
   3  * Copyright (c) 2007 - 2011, Blue Static <http://www.bluestatic.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
   6  * General Public License as published by the Free Software Foundation; either version 2 of the
   7  * License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
  10  * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with this program; if not,
  14  * write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  15  */
  16
  17 #import "NetworkCallbackController.h"
  18
  19 #import <sys/socket.h>
  20 #import <netinet/in.h>
  21
  22 #import "NetworkConnection.h"
  23 #import "NetworkConnectionPrivate.h"
  24
  25 NetworkCallbackController::NetworkCallbackController(NetworkConnection* connection)
  26     : listeningSocket_(NULL),
  27       socketHandle_(NULL),
  28       readStream_(NULL),
  29       writeStream_(NULL),
  30       connection_(connection),
  31       runLoop_(CFRunLoopGetCurrent())
  32 {
  33 }
  34
  35 void NetworkCallbackController::OpenConnection(NSUInteger port)
  36 {
  37   // Pass ourselves to the callback so we don't have to use ugly globals.
  38   CFSocketContext context = { 0 };
  39   context.info = this;
  40
  41   // Create the address structure.
  42   struct sockaddr_in address;
  43   memset(&address, 0, sizeof(address));
  44   address.sin_len = sizeof(address);
  45   address.sin_family = AF_INET;
  46   address.sin_port = htons(port);
  47   address.sin_addr.s_addr = htonl(INADDR_ANY);
  48
  49   // Create the socket signature.
  50   CFSocketSignature signature;
  51   signature.protocolFamily = PF_INET;
  52   signature.socketType = SOCK_STREAM;
  53   signature.protocol = IPPROTO_TCP;
  54   signature.address = (CFDataRef)[NSData dataWithBytes:&address length:sizeof(address)];
  55
  56   do {
  57     listeningSocket_ =
  58         CFSocketCreateWithSocketSignature(kCFAllocatorDefault,
  59                                           &signature,  // Socket signature.
  60                                           kCFSocketAcceptCallBack,  // Callback types.
  61                                           &NetworkCallbackController::SocketAcceptCallback,  // Callout function pointer.
  62                                           &context);  // Context to pass to callout.
  63     if (!listeningSocket_) {
  64       [connection_ errorEncountered:@"Could not open socket."];
  65       sleep(1);
  66     }
  67   } while (!listeningSocket_);
  68
  69   // Allow old, yet-to-be recycled sockets to be reused.
  70   BOOL yes = YES;
  71   setsockopt(CFSocketGetNative(listeningSocket_), SOL_SOCKET, SO_REUSEADDR, &yes, sizeof(BOOL));
  72   setsockopt(CFSocketGetNative(listeningSocket_), SOL_SOCKET, SO_REUSEPORT, &yes, sizeof(BOOL));
  73
  74   // Schedule the socket on the run loop.
  75   CFRunLoopSourceRef source = CFSocketCreateRunLoopSource(kCFAllocatorDefault, listeningSocket_, 0);
  76   CFRunLoopAddSource(runLoop_, source, kCFRunLoopCommonModes);
  77   CFRelease(source);
  78 }
  79
  80 void NetworkCallbackController::CloseConnection()
  81 {
  82   if (socketHandle_) {
  83     close(socketHandle_);
  84     //socketHandle_ = NULL;
  85   }
  86   UnscheduleReadStream();
  87   UnscheduleWriteStream();
  88 }
  89
  90 BOOL NetworkCallbackController::WriteStreamCanAcceptBytes()
  91 {
  92   return writeStream_ && CFWriteStreamCanAcceptBytes(writeStream_);
  93 }
  94
  95 BOOL NetworkCallbackController::WriteString(NSString* string)
  96 {
  97   BOOL done = NO;
  98
  99   char* cString = const_cast<char*>([string UTF8String]);
 100   size_t stringLength = strlen(cString);
 101
 102   // Busy wait while writing. BAADD. Should background this operation.
 103   while (!done) {
 104     if (WriteStreamCanAcceptBytes()) {
 105       // Include the NULL byte in the string when we write.
 106       CFIndex bytesWritten = CFWriteStreamWrite(writeStream_, (UInt8*)cString, stringLength + 1);
 107       if (bytesWritten < 0) {
 108         CFErrorRef error = CFWriteStreamCopyError(writeStream_);
 109         ReportError(error);
 110         break;
 111       }
 112       // Incomplete write.
 113       else if (bytesWritten < static_cast<CFIndex>(strlen(cString))) {
 114         // Adjust the buffer and wait for another chance to write.
 115         stringLength -= bytesWritten;
 116         memmove(string, string + bytesWritten, stringLength);
 117       }
 118       else {
 119         done = YES;
 120       }
 121     }
 122   }
 123
 124   return done;
 125 }
 126
 127 // Static Methods //////////////////////////////////////////////////////////////
 128
 129 void NetworkCallbackController::SocketAcceptCallback(CFSocketRef socket,
 130                                                      CFSocketCallBackType callbackType,
 131                                                      CFDataRef address,
 132                                                      const void* data,
 133                                                      void* self)
 134 {
 135   assert(callbackType == kCFSocketAcceptCallBack);
 136   static_cast<NetworkCallbackController*>(self)->OnSocketAccept(socket, address, data);
 137 }
 138
 139 void NetworkCallbackController::ReadStreamCallback(CFReadStreamRef stream,
 140                                                    CFStreamEventType eventType,
 141                                                    void* self)
 142 {
 143   static_cast<NetworkCallbackController*>(self)->OnReadStreamEvent(stream, eventType);
 144 }
 145
 146 void NetworkCallbackController::WriteStreamCallback(CFWriteStreamRef stream,
 147                                                     CFStreamEventType eventType,
 148                                                     void* self)
 149 {
 150   static_cast<NetworkCallbackController*>(self)->OnWriteStreamEvent(stream, eventType);
 151 }
 152
 153
 154 // Private Instance Methods ////////////////////////////////////////////////////
 155
 156 void NetworkCallbackController::OnSocketAccept(CFSocketRef socket,
 157                                                CFDataRef address,
 158                                                const void* data)
 159 {
 160   socketHandle_ = *(CFSocketNativeHandle*)data;
 161
 162   // Create the streams on the socket.
 163   CFStreamCreatePairWithSocket(kCFAllocatorDefault,
 164                                socketHandle_,  // Socket handle.
 165                                &readStream_,  // Read stream in-pointer.
 166                                &writeStream_);  // Write stream in-pointer.
 167
 168   // Create struct to register callbacks for the stream.
 169   CFStreamClientContext context = { 0 };
 170   context.info = this;
 171
 172   // Set the client of the read stream.
 173   CFOptionFlags readFlags = kCFStreamEventOpenCompleted |
 174                             kCFStreamEventHasBytesAvailable |
 175                             kCFStreamEventErrorOccurred |
 176                             kCFStreamEventEndEncountered;
 177   if (CFReadStreamSetClient(readStream_, readFlags, &NetworkCallbackController::ReadStreamCallback, &context))
 178     // Schedule in run loop to do asynchronous communication with the engine.
 179     CFReadStreamScheduleWithRunLoop(readStream_, runLoop_, kCFRunLoopCommonModes);
 180   else
 181     return;
 182
 183   // Open the stream now that it's scheduled on the run loop.
 184   if (!CFReadStreamOpen(readStream_)) {
 185     ReportError(CFReadStreamCopyError(readStream_));
 186     return;
 187   }
 188
 189   // Set the client of the write stream.
 190   CFOptionFlags writeFlags = kCFStreamEventOpenCompleted |
 191                              kCFStreamEventCanAcceptBytes |
 192                              kCFStreamEventErrorOccurred |
 193                              kCFStreamEventEndEncountered;
 194   if (CFWriteStreamSetClient(writeStream_, writeFlags, &NetworkCallbackController::WriteStreamCallback, &context))
 195     // Schedule it in the run loop to receive error information.
 196     CFWriteStreamScheduleWithRunLoop(writeStream_, runLoop_, kCFRunLoopCommonModes);
 197   else
 198     return;
 199
 200   // Open the write stream.
 201   if (!CFWriteStreamOpen(writeStream_)) {
 202     ReportError(CFWriteStreamCopyError(writeStream_));
 203     return;
 204   }
 205
 206   [connection_ socketDidAccept];
 207
 208   CloseSocket();
 209 }
 210
 211 void NetworkCallbackController::OnReadStreamEvent(CFReadStreamRef stream,
 212                                                   CFStreamEventType eventType)
 213 {
 214   switch (eventType)
 215   {
 216     case kCFStreamEventHasBytesAvailable:
 217       if (readStream_)
 218         [connection_ readStreamHasData:stream];
 219       break;
 220
 221     case kCFStreamEventErrorOccurred:
 222       ReportError(CFReadStreamCopyError(stream));
 223       UnscheduleReadStream();
 224       break;
 225
 226     case kCFStreamEventEndEncountered:
 227       UnscheduleReadStream();
 228       CloseConnection();
 229       [connection_ socketDisconnected];
 230       break;
 231   };
 232 }
 233
 234 void NetworkCallbackController::OnWriteStreamEvent(CFWriteStreamRef stream,
 235                                                    CFStreamEventType eventType)
 236 {
 237   switch (eventType)
 238   {
 239     case kCFStreamEventCanAcceptBytes:
 240       [connection_ sendQueuedWrites];
 241       break;
 242
 243     case kCFStreamEventErrorOccurred:
 244       ReportError(CFWriteStreamCopyError(stream));
 245       UnscheduleWriteStream();
 246       break;
 247
 248     case kCFStreamEventEndEncountered:
 249       UnscheduleReadStream();
 250       [connection_ socketDisconnected];
 251       break;
 252   }
 253 }
 254
 255 void NetworkCallbackController::CloseSocket()
 256 {
 257   if (listeningSocket_) {
 258     CFSocketInvalidate(listeningSocket_);
 259     CFRelease(listeningSocket_);
 260     listeningSocket_ = NULL;
 261   }
 262 }
 263
 264 void NetworkCallbackController::UnscheduleReadStream()
 265 {
 266   if (!readStream_)
 267     return;
 268   CFReadStreamUnscheduleFromRunLoop(readStream_, runLoop_, kCFRunLoopCommonModes);
 269   CFReadStreamClose(readStream_);
 270   CFRelease(readStream_);
 271   readStream_ = NULL;
 272 }
 273
 274 void NetworkCallbackController::UnscheduleWriteStream()
 275 {
 276   if (!writeStream_)
 277     return;
 278   CFWriteStreamUnscheduleFromRunLoop(writeStream_, runLoop_, kCFRunLoopCommonModes);
 279   CFWriteStreamClose(writeStream_);
 280   CFRelease(writeStream_);
 281   writeStream_ = NULL;
 282 }
 283
 284 void NetworkCallbackController::ReportError(CFErrorRef error)
 285 {
 286   [connection_ errorEncountered:[(NSError*)error description]];
 287   CFRelease(error);
 288 }