3 * Copyright (c) 2007 - 2010, Blue Static <http://www.bluestatic.org>
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.
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.
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
17 #import "DebuggerConnection.h"
19 #import <sys/socket.h>
20 #import <netinet/in.h>
22 #import "AppDelegate.h"
23 #import "LoggingController.h"
25 // DebuggerConnection (Private) ////////////////////////////////////////////////
27 @interface DebuggerConnection ()
29 @property (assign
) CFSocketRef socket
;
30 @property (assign
) CFReadStreamRef readStream
;
31 @property NSUInteger lastReadTransaction
;
32 @property (retain
) NSMutableString
* currentPacket
;
33 @property (assign
) CFWriteStreamRef writeStream
;
34 @property NSUInteger lastWrittenTransaction
;
35 @property (retain
) NSMutableArray
* queuedWrites
;
37 - (void)connectInternal
;
39 - (void)socketDidAccept
;
40 - (void)socketDisconnected
;
41 - (void)readStreamHasData
;
43 - (void)performSend
:(NSString
*)command
;
44 - (void)sendQueuedWrites
;
46 - (void)handleResponse
:(NSXMLDocument
*)response
;
47 - (void)handlePacket
:(NSString
*)packet
;
49 - (void)errorEncountered
:(NSString
*)error
;
53 // CFNetwork Callbacks /////////////////////////////////////////////////////////
55 void ReadStreamCallback(CFReadStreamRef stream
, CFStreamEventType eventType
, void* connectionRaw
)
57 DebuggerConnection
* connection
= (DebuggerConnection
*)connectionRaw
;
60 case kCFStreamEventHasBytesAvailable
:
61 [connection readStreamHasData
];
64 case kCFStreamEventErrorOccurred
:
66 CFErrorRef error
= CFReadStreamCopyError(stream
);
67 CFReadStreamUnscheduleFromRunLoop(stream
, CFRunLoopGetCurrent(), kCFRunLoopCommonModes
);
68 CFReadStreamClose(stream
);
70 [connection errorEncountered
:[[(NSError
*)error autorelease
] description
]];
74 case kCFStreamEventEndEncountered
:
75 CFReadStreamUnscheduleFromRunLoop(stream
, CFRunLoopGetCurrent(), kCFRunLoopCommonModes
);
76 CFReadStreamClose(stream
);
78 [connection socketDisconnected
];
83 void WriteStreamCallback(CFWriteStreamRef stream
, CFStreamEventType eventType
, void* connectionRaw
)
85 DebuggerConnection
* connection
= (DebuggerConnection
*)connectionRaw
;
88 case kCFStreamEventCanAcceptBytes
:
89 [connection sendQueuedWrites
];
92 case kCFStreamEventErrorOccurred
:
94 CFErrorRef error
= CFWriteStreamCopyError(stream
);
95 CFWriteStreamUnscheduleFromRunLoop(stream
, CFRunLoopGetCurrent(), kCFRunLoopCommonModes
);
96 CFWriteStreamClose(stream
);
98 [connection errorEncountered
:[[(NSError
*)error autorelease
] description
]];
102 case kCFStreamEventEndEncountered
:
103 CFWriteStreamUnscheduleFromRunLoop(stream
, CFRunLoopGetCurrent(), kCFRunLoopCommonModes
);
104 CFWriteStreamClose(stream
);
106 [connection socketDisconnected
];
111 void SocketAcceptCallback(CFSocketRef socket
,
112 CFSocketCallBackType callbackType
,
117 assert(callbackType
== kCFSocketAcceptCallBack
);
118 NSLog(@
"SocketAcceptCallback()");
120 DebuggerConnection
* connection
= (DebuggerConnection
*)connectionRaw
;
122 CFReadStreamRef readStream
;
123 CFWriteStreamRef writeStream
;
125 // Create the streams on the socket.
126 CFStreamCreatePairWithSocket(kCFAllocatorDefault
,
127 *(CFSocketNativeHandle
*)data
, // Socket handle.
128 &readStream
, // Read stream in-pointer.
129 &writeStream
); // Write stream in-pointer.
131 // Create struct to register callbacks for the stream.
132 CFStreamClientContext context
;
134 context.info
= connection
;
135 context.retain
= NULL
;
136 context.release
= NULL
;
137 context.copyDescription
= NULL
;
139 // Set the client of the read stream.
140 CFOptionFlags readFlags
=
141 kCFStreamEventOpenCompleted |
142 kCFStreamEventHasBytesAvailable |
143 kCFStreamEventErrorOccurred |
144 kCFStreamEventEndEncountered
;
145 if (CFReadStreamSetClient(readStream
, readFlags
, ReadStreamCallback
, &context
))
146 // Schedule in run loop to do asynchronous communication with the engine.
147 CFReadStreamScheduleWithRunLoop(readStream
, CFRunLoopGetCurrent(), kCFRunLoopCommonModes
);
151 // Open the stream now that it's scheduled on the run loop.
152 if (!CFReadStreamOpen(readStream
))
154 CFStreamError error
= CFReadStreamGetError(readStream
);
155 NSLog(@
"error! %@", error
);
159 // Set the client of the write stream.
160 CFOptionFlags writeFlags
=
161 kCFStreamEventOpenCompleted |
162 kCFStreamEventCanAcceptBytes |
163 kCFStreamEventErrorOccurred |
164 kCFStreamEventEndEncountered
;
165 if (CFWriteStreamSetClient(writeStream
, writeFlags
, WriteStreamCallback
, &context
))
166 // Schedule it in the run loop to receive error information.
167 CFWriteStreamScheduleWithRunLoop(writeStream
, CFRunLoopGetCurrent(), kCFRunLoopCommonModes
);
171 // Open the write stream.
172 if (!CFWriteStreamOpen(writeStream
))
174 CFStreamError error
= CFWriteStreamGetError(writeStream
);
175 NSLog(@
"error! %@", error
);
179 connection.readStream
= readStream
;
180 connection.writeStream
= writeStream
;
181 [connection socketDidAccept
];
184 ////////////////////////////////////////////////////////////////////////////////
186 @implementation DebuggerConnection
188 @synthesize port
= port_
;
189 @synthesize connected
= connected_
;
190 @synthesize delegate
= delegate_
;
192 @synthesize socket
= socket_
;
193 @synthesize readStream
= readStream_
;
194 @synthesize lastReadTransaction
= lastReadTransaction_
;
195 @synthesize currentPacket
= currentPacket_
;
196 @synthesize writeStream
= writeStream_
;
197 @synthesize lastWrittenTransaction
= lastWrittenTransaction_
;
198 @synthesize queuedWrites
= queuedWrites_
;
200 - (id)initWithPort
:(NSUInteger
)aPort
202 if (self = [super init
])
211 self.currentPacket
= nil;
216 * Kicks off the socket on another thread.
220 [NSThread detachNewThreadSelector
:@selector(connectInternal
) toTarget
:self withObject
:nil];
224 * Creates, connects to, and schedules a CFSocket.
226 - (void)connectInternal
228 runLoop_
= [NSRunLoop currentRunLoop
];
230 // Pass ourselves to the callback so we don't have to use ugly globals.
231 CFSocketContext context
;
234 context.retain
= NULL
;
235 context.release
= NULL
;
236 context.copyDescription
= NULL
;
238 // Create the address structure.
239 struct sockaddr_in address
;
240 memset(&address
, 0, sizeof(address
));
241 address.sin_len
= sizeof(address
);
242 address.sin_family
= AF_INET
;
243 address.sin_port
= htons(port_
);
244 address.sin_addr.s_addr
= htonl(INADDR_ANY
);
246 // Create the socket signature.
247 CFSocketSignature signature
;
248 signature.protocolFamily
= PF_INET
;
249 signature.socketType
= SOCK_STREAM
;
250 signature.protocol
= IPPROTO_TCP
;
251 signature.address
= (CFDataRef
)[NSData dataWithBytes
:&address length
:sizeof(address
)];
253 socket_
= CFSocketCreateWithSocketSignature(kCFAllocatorDefault
,
254 &signature
, // Socket signature.
255 kCFSocketAcceptCallBack
, // Callback types.
256 SocketAcceptCallback
, // Callout function pointer.
257 &context
); // Context to pass to callout.
260 [self errorEncountered
:@
"Could not open socket."];
264 // Allow old, yet-to-be recycled sockets to be reused.
266 setsockopt(CFSocketGetNative(socket_
), SOL_SOCKET
, SO_REUSEADDR
, &yes
, sizeof(BOOL));
268 // Schedule the socket on the run loop.
269 CFRunLoopSourceRef source
= CFSocketCreateRunLoopSource(kCFAllocatorDefault
, socket_
, 0);
270 CFRunLoopAddSource([runLoop_ getCFRunLoop
], source
, kCFRunLoopCommonModes
);
277 * Called by SocketWrapper after the connection is successful. This immediately calls
278 * -[SocketWrapper receive] to clear the way for communication, though the information
279 * could be useful server information that we don't use right now.
281 - (void)socketDidAccept
285 self.queuedWrites
= [NSMutableArray array
];
286 writeQueueLock_
= [NSRecursiveLock
new];
290 * Closes a socket and releases the ref.
295 CFRunLoopStop([runLoop_ getCFRunLoop
]);
298 // The socket goes down, so do the streams, which clean themselves up.
300 CFSocketInvalidate(socket_
);
303 self.queuedWrites
= nil;
304 [writeQueueLock_ release
];
308 * Notification that the socket disconnected.
310 - (void)socketDisconnected
313 [delegate_ connectionDidClose
:self];
317 * Writes a command into the write stream. If the stream is ready for writing,
318 * we do so immediately. If not, the command is queued and will be written
319 * when the stream is ready.
321 - (void)send
:(NSString
*)command
323 if (lastReadTransaction_
>= lastWrittenTransaction_
&& CFWriteStreamCanAcceptBytes(writeStream_
)) {
324 [self performSend
:command
];
326 [writeQueueLock_ lock
];
327 [queuedWrites_ addObject
:command
];
328 [writeQueueLock_ unlock
];
330 [self sendQueuedWrites
];
334 * This will send a command to the debugger engine. It will append the
335 * transaction ID automatically. It accepts a NSString command along with a
336 * a variable number of arguments to substitute into the command, a la
337 * +[NSString stringWithFormat:]. Returns the transaction ID as a NSNumber.
339 - (NSNumber
*)sendCommandWithFormat
:(NSString
*)format
, ...
341 // Collect varargs and format command.
343 va_start(args
, format
);
344 NSString
* command
= [[NSString alloc
] initWithFormat
:format arguments
:args
];
347 NSNumber
* callbackKey
= [NSNumber numberWithInt
:transactionID
++];
348 [self send
:[NSString stringWithFormat
:@
"%@ -i %@", [command autorelease
], callbackKey
]];
354 * Given a file path, this returns a file:// URI and escapes any spaces for the
357 - (NSString
*)escapedURIPath
:(NSString
*)path
359 // Custon GDBp paths are fine.
360 if ([[path substringToIndex
:4] isEqualToString
:@
"gdbp"])
363 // Create a temporary URL that will escape all the nasty characters.
364 NSURL
* url
= [NSURL fileURLWithPath
:path
];
365 NSString
* urlString
= [url absoluteString
];
367 // Remove the host because this is a file:// URL;
368 urlString
= [urlString stringByReplacingOccurrencesOfString
:[url host
] withString
:@
""];
370 // Escape % for use in printf-style NSString formatters.
371 urlString
= [urlString stringByReplacingOccurrencesOfString
:@
"%" withString
:@
"%%"];
376 * Returns the transaction_id from an NSXMLDocument.
378 - (NSInteger
)transactionIDFromResponse
:(NSXMLDocument
*)response
380 return [[[[response rootElement
] attributeForName
:@
"transaction_id"] stringValue
] intValue
];
384 * Scans a command string for the transaction ID component. If it is not found,
385 * returns NSNotFound.
387 - (NSInteger
)transactionIDFromCommand
:(NSString
*)command
389 NSRange occurrence
= [command rangeOfString
:@
"-i "];
390 if (occurrence.location
== NSNotFound
)
392 NSString
* transaction
= [command substringFromIndex
:occurrence.location
+ occurrence.length
];
393 return [transaction intValue
];
396 // Private /////////////////////////////////////////////////////////////////////
400 * Receives errors from the SocketWrapper and updates the display
402 - (void)errorEncountered
:(NSString
*)error
404 [delegate_ errorEncountered
:error
];
408 * Callback from the CFReadStream that there is data waiting to be read.
410 - (void)readStreamHasData
412 const NSUInteger kBufferSize
= 1024;
413 UInt8 buffer
[kBufferSize
];
414 CFIndex bufferOffset
= 0; // Starting point in |buffer| to work with.
415 CFIndex bytesRead
= CFReadStreamRead(readStream_
, buffer
, kBufferSize
);
416 const char* charBuffer
= (const char*)buffer
;
418 // The read loop works by going through the buffer until all the bytes have
420 while (bufferOffset
< bytesRead
)
422 // Find the NULL separator, or the end of the string.
423 NSUInteger partLength
= 0;
424 for (NSUInteger i
= bufferOffset
; i
< bytesRead
&& charBuffer
[i
] != '\0'; ++i
, ++partLength
) ;
426 // If there is not a current packet, set some state.
427 if (!self.currentPacket
)
429 // Read the message header: the size. This will be |partLength| bytes.
430 packetSize_
= atoi(charBuffer
+ bufferOffset
);
431 currentPacketIndex_
= 0;
432 self.currentPacket
= [NSMutableString stringWithCapacity
:packetSize_
];
433 bufferOffset
+= partLength
+ 1; // Pass over the NULL byte.
434 continue; // Spin the loop to begin reading actual data.
437 // Substring the byte stream and append it to the packet string.
438 CFStringRef bufferString
= CFStringCreateWithBytes(kCFAllocatorDefault
,
439 buffer
+ bufferOffset
, // Byte pointer, offset by start index.
440 partLength
, // Length.
441 kCFStringEncodingUTF8
,
443 [self.currentPacket appendString
:(NSString
*)bufferString
];
444 CFRelease(bufferString
);
447 currentPacketIndex_
+= partLength
;
448 bufferOffset
+= partLength
+ 1;
450 // If this read finished the packet, handle it and reset.
451 NSLog(@
"cpi %d ps %d br %d ds %d", currentPacketIndex_
, packetSize_
, bytesRead
, partLength
);
452 if (currentPacketIndex_
>= packetSize_
)
454 [self handlePacket
:[[currentPacket_ retain
] autorelease
]];
455 self.currentPacket
= nil;
457 currentPacketIndex_
= 0;
463 * Performs the packet handling of a raw string XML packet. From this point on,
464 * the packets are associated with a transaction and are then dispatched.
466 - (void)handlePacket
:(NSString
*)packet
468 // Test if we can convert it into an NSXMLDocument.
469 NSError
* error
= nil;
470 NSXMLDocument
* xmlTest
= [[NSXMLDocument alloc
] initWithXMLString
:currentPacket_ options
:NSXMLDocumentTidyXML error
:&error
];
472 // Try to recover if we encountered an error.
475 // We do not want to starve the write queue, so manually parse out the
477 NSRange location
= [currentPacket_ rangeOfString
:@
"transaction_id"];
478 if (location.location
!= NSNotFound
)
480 NSUInteger start
= location.location
+ location.length
;
481 NSUInteger end
= start
;
483 NSCharacterSet
* numericSet
= [NSCharacterSet decimalDigitCharacterSet
];
485 // Loop over the characters after the attribute name to extract the ID.
486 while (end
< [currentPacket_ length
])
488 unichar c
= [currentPacket_ characterAtIndex
:end
];
489 if ([numericSet characterIsMember
:c
])
491 // If this character is numeric, extend the range to substring.
498 // If this character is nonnumeric and we have nothing in the
499 // range, skip this character.
505 // We've moved past the numeric ID so we should stop searching.
511 // If we were able to extract the transaction ID, update the last read.
512 NSRange substringRange
= NSMakeRange(start
, end
- start
);
513 NSString
* transactionStr
= [currentPacket_ substringWithRange
:substringRange
];
514 if ([transactionStr length
])
515 lastReadTransaction_
= [transactionStr intValue
];
518 // Otherwise, assume +1 and hope it works.
519 ++lastReadTransaction_
;
523 // See if the transaction can be parsed out.
524 NSInteger transaction
= [self transactionIDFromResponse
:xmlTest
];
525 if (transaction
< lastReadTransaction_
)
527 NSLog(@
"tx = %d vs %d", transaction
, lastReadTransaction_
);
528 NSLog(@
"out of date transaction %@", packet
);
532 if (transaction
!= lastWrittenTransaction_
)
533 NSLog(@
"txn %d <> %d last written, %d last read", transaction
, lastWrittenTransaction_
, lastReadTransaction_
);
535 lastReadTransaction_
= transaction
;
538 // Log this receive event.
539 LoggingController
* logger
= [(AppDelegate
*)[NSApp delegate
] loggingController
];
540 LogEntry
* log
= [logger recordReceive
:currentPacket_
];
542 log.lastWrittenTransactionID
= lastWrittenTransaction_
;
543 log.lastReadTransactionID
= lastReadTransaction_
;
545 // Finally, dispatch the handler for this response.
546 [self handleResponse
:[xmlTest autorelease
]];
549 - (void)handleResponse
:(NSXMLDocument
*)response
551 // Check and see if there's an error.
552 NSArray
* error
= [[response rootElement
] elementsForName
:@
"error"];
553 if ([error count
] > 0)
555 NSLog(@
"Xdebug error: %@", error
);
556 [delegate_ errorEncountered
:[[[[error objectAtIndex
:0] children
] objectAtIndex
:0] stringValue
]];
559 if ([[[response rootElement
] name
] isEqualToString
:@
"init"])
561 [delegate_ handleInitialResponse
:response
];
565 if ([delegate_ respondsToSelector
:@selector(handleResponse
:)])
566 [(NSObject
*)delegate_ performSelectorOnMainThread
:@selector(handleResponse
:) withObject
:response waitUntilDone
:NO
];
568 [self sendQueuedWrites
];
572 * This performs a blocking send. This should ONLY be called when we know we
573 * have write access to the stream. We will busy wait in case we don't do a full
576 - (void)performSend
:(NSString
*)command
578 // If this is an out-of-date transaction, do not bother sending it.
579 NSInteger transaction
= [self transactionIDFromCommand
:command
];
580 if (transaction
!= NSNotFound
&& transaction
< lastWrittenTransaction_
)
585 char* string
= (char*)[command UTF8String
];
586 int stringLength
= strlen(string
);
588 // Busy wait while writing. BAADD. Should background this operation.
591 if (CFWriteStreamCanAcceptBytes(writeStream_
))
593 // Include the NULL byte in the string when we write.
594 int bytesWritten
= CFWriteStreamWrite(writeStream_
, (UInt8
*)string
, stringLength
+ 1);
595 if (bytesWritten
< 0)
597 NSLog(@
"write error");
600 else if (bytesWritten
< strlen(string
))
602 // Adjust the buffer and wait for another chance to write.
603 stringLength
-= bytesWritten
;
604 memmove(string
, string
+ bytesWritten
, stringLength
);
610 // We need to scan the string to find the transactionID.
611 if (transaction
== NSNotFound
)
613 NSLog(@
"sent %@ without a transaction ID", command
);
616 lastWrittenTransaction_
= transaction
;
621 // Log this trancation.
622 LoggingController
* logger
= [(AppDelegate
*)[NSApp delegate
] loggingController
];
623 LogEntry
* log
= [logger recordSend
:command
];
624 log.lastWrittenTransactionID
= lastWrittenTransaction_
;
625 log.lastReadTransactionID
= lastReadTransaction_
;
629 * Checks if there are unsent commands in the |queuedWrites_| queue and sends
630 * them if it's OK to do so. This will not block.
632 - (void)sendQueuedWrites
637 [writeQueueLock_ lock
];
638 if (lastReadTransaction_
>= lastWrittenTransaction_
&& [queuedWrites_ count
] > 0)
640 NSString
* command
= [queuedWrites_ objectAtIndex
:0];
642 // We don't want to block because this is called from the main thread.
643 // |-performSend:| busy waits when the stream is not ready. Bail out
644 // before we do that becuase busy waiting is BAD.
645 if (CFWriteStreamCanAcceptBytes(writeStream_
))
647 [self performSend
:command
];
648 [queuedWrites_ removeObjectAtIndex
:0];
651 [writeQueueLock_ unlock
];