Support more debugger commands in the wire protocol

runtime/bin/dbg_connection.cc

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #include "bin/dbg_connection.h"
 #include "bin/dartutils.h"
 #include "bin/socket.h"
 #include "bin/thread.h"
 #include "bin/utils.h"
 
 #include "platform/globals.h"
 #include "platform/json.h"
 #include "platform/thread.h"
 #include "platform/utils.h"
 
 #include "include/dart_api.h"
 
 
 int DebuggerConnectionHandler::listener_fd_ = -1;
 int DebuggerConnectionHandler::debugger_fd_ = -1;
 dart::Monitor DebuggerConnectionHandler::is_connected_;
 MessageBuffer* DebuggerConnectionHandler::msgbuf_ = NULL;
 
 bool DebuggerConnectionHandler::handler_started_ = false;
+bool DebuggerConnectionHandler::request_resume_ = false;
 
 
 // TODO(hausner): Need better error handling.
 #define ASSERT_NOT_ERROR(handle)                                               \
   ASSERT(!Dart_IsError(handle))
 
+typedef void (*CommandHandler)(const char* json_cmd);
+
+struct JSONDebuggerCommand {
+  const char* cmd_string;
+  CommandHandler handler_function;
+};
+
 
 class MessageBuffer {
  public:
   explicit MessageBuffer(int fd);
   ~MessageBuffer();
   void ReadData();
   bool IsValidMessage() const;
   void PopMessage();
   int MessageId() const;
+  const char* Params() const;
   char* buf() const { return buf_; }
   bool Alive() const { return connection_is_alive_; }
 
  private:
   static const int kInitialBufferSize = 256;
   char* buf_;
   int buf_length_;
   int fd_;
   int data_length_;
   bool connection_is_alive_;
@@ skipping 38 matching lines @@
   dart::JSONReader r(buf_);
   r.Seek("id");
   if (r.Type() == dart::JSONReader::kInteger) {
     return atoi(r.ValueChars());
   } else {
     return -1;
   }
 }
 
 
+const char* MessageBuffer::Params() const {
+  dart::JSONReader r(buf_);
+  r.Seek("param");
+  if (r.Type() == dart::JSONReader::kObject) {
+    return r.ValueChars();
+  } else {
+    return NULL;
+  }
+}
+
+
 void MessageBuffer::ReadData() {
   ASSERT(data_length_ >= 0);
   ASSERT(data_length_ < buf_length_);
   int max_read = buf_length_ - data_length_ - 1;
   if (max_read == 0) {
     // TODO(hausner):
     // Buffer is full. What should we do if there is no valid message
     // in the buffer? This might be possible if the client sends a message
     // that's larger than the buffer, of if the client sends malformed
     // messages that keep piling up.
@@ skipping 30 matching lines @@
   }
 }
 
 
 static bool IsValidJSON(const char* msg) {
   dart::JSONReader r(msg);
   return r.EndOfObject() != NULL;
 }
 
 
-void DebuggerConnectionHandler::HandleResumeCmd() {
+void DebuggerConnectionHandler::SendError(int msg_id,
+                                          const char* format, ...) {
+  dart::TextBuffer msg(64);
+  msg.Printf("{\"id\": %d, \"error\": \"", msg_id);
+  va_list args;
+  va_start(args, format);
+  msg.Printf(format, args);
+  va_end(args);
+  msg.Printf("\"}");
+  Socket::Write(debugger_fd_, msg.buf(), msg.length());
+  // TODO(hausner): Error checking. Probably just shut down the debugger
+  // session if we there is an error while writing.
+}
+
+
+void DebuggerConnectionHandler::HandleResumeCmd(const char* json_msg) {
+  int msg_id = msgbuf_->MessageId();
+  dart::JSONReader r(json_msg);

[siva, 2012/05/10 20:08:36]

This r object appears to be unused.

[hausner, 2012/05/10 22:36:28]

Done.

+  dart::TextBuffer msg(64);
+  msg.Printf("{ \"id\": %d }", msg_id);
+  Socket::Write(debugger_fd_, msg.buf(), msg.length());
+  // TODO(hausner): Error checking. Probably just shut down the debugger
+  // session if we there is an error while writing.
+  request_resume_ = true;
+}
+
+
+void DebuggerConnectionHandler::HandleStepIntoCmd(const char* json_msg) {
+  Dart_Handle res = Dart_SetStepInto();
+  ASSERT_NOT_ERROR(res);
+  HandleResumeCmd(json_msg);
+}
+
+
+void DebuggerConnectionHandler::HandleStepOutCmd(const char* json_msg) {
+  Dart_Handle res = Dart_SetStepOut();
+  ASSERT_NOT_ERROR(res);
+  HandleResumeCmd(json_msg);
+}
+
+
+void DebuggerConnectionHandler::HandleStepOverCmd(const char* json_msg) {
+  Dart_Handle res = Dart_SetStepOver();
+  ASSERT_NOT_ERROR(res);
+  HandleResumeCmd(json_msg);
+}
+
+
+void DebuggerConnectionHandler::HandleGetScriptURLsCmd(const char* json_msg) {
   int msg_id = msgbuf_->MessageId();
   dart::TextBuffer msg(64);
-  msg.Printf("{ \"id\": %d }", msg_id);
+  const char* params = msgbuf_->Params();
+  ASSERT(params != NULL);
+  dart::JSONReader pr(params);
+  pr.Seek("library");
+  ASSERT(pr.Type() == dart::JSONReader::kString);
+  char lib_url_chars[128];
+  pr.GetValueChars(lib_url_chars, sizeof(lib_url_chars));
+  Dart_Handle lib_url = Dart_NewString(lib_url_chars);

[siva, 2012/05/10 20:08:36]

ASSERT(!Dart_IsError(lib_url));

[hausner, 2012/05/10 22:36:28]

Done.

+  Dart_Handle urls = Dart_GetScriptURLs(lib_url);
+  if (Dart_IsError(urls)) {
+    SendError(msg_id, "Error: '%s'.", Dart_GetError(urls));
+    return;
+  }
+  ASSERT(Dart_IsList(urls));
+  intptr_t num_urls = 0;
+  Dart_ListLength(urls, &num_urls);
+  msg.Printf("{ \"id\": %d, ", msg_id);
+  msg.Printf("\"result\": { \"urls\": [");
+  for (int i = 0; i < num_urls; i++) {
+    Dart_Handle script_url = Dart_ListGetAt(urls, i);
+    ASSERT(Dart_IsString(script_url));
+    char const* chars;
+    Dart_StringToCString(lib_url, &chars);

[siva, 2012/05/10 20:08:36]

See comments below about allocation of chars.

[hausner, 2012/05/10 22:36:28]

Done.

+    msg.Printf("%s\"%s\"", (i == 0) ? "" : ", ", chars);
+  }
+  msg.Printf("] }}");
+  Socket::Write(debugger_fd_, msg.buf(), msg.length());
+  // TODO(hausner): Error checking. Probably just shut down the debugger
+  // session if we there is an error while writing.
+}
+
+
+void DebuggerConnectionHandler::HandleGetLibraryURLsCmd(const char* json_msg) {
+  int msg_id = msgbuf_->MessageId();
+  dart::TextBuffer msg(64);
+  msg.Printf("{ \"id\": %d, \"result\": { \"urls\": [", msg_id);

[siva, 2012/05/10 20:08:36]

Does msg.Printf handle buffer overruns?

[hausner, 2012/05/10 22:36:28]

Yes, it dynamically reallocs buffer space.

+  Dart_Handle urls = Dart_GetLibraryURLs();

[siva, 2012/05/10 20:08:36]

ASSERT(!Dart_IsError(urls));

[hausner, 2012/05/10 22:36:28]

Done.

+  intptr_t num_libs;
+  Dart_ListLength(urls, &num_libs);
+  for (int i = 0; i < num_libs; i++) {
+    Dart_Handle lib_url = Dart_ListGetAt(urls, i);
+    ASSERT(Dart_IsString(lib_url));
+    char const* chars;
+    Dart_StringToCString(lib_url, &chars);

[siva, 2012/05/10 20:08:36]

chars is allocated in the ApiScope, do you create a new ApiScope and exit the
ApiScope every time the breakpoint handler is called?

Otherwise we will be accumulating this in the main ApiScope and could be
considered a leak.

[hausner, 2012/05/10 22:36:28]

Thanks for this tip. Added a scope around the callback.

On 2012/05/10 20:08:36, asiva wrote:

+    msg.Printf("%s\"%s\"", (i == 0) ? "" : ", ", chars);
+  }
+  msg.Printf("] }}");
   Socket::Write(debugger_fd_, msg.buf(), msg.length());
   // TODO(hausner): Error checking. Probably just shut down the debugger
   // session if we there is an error while writing.
 }
 
 
 void DebuggerConnectionHandler::HandleMessages() {
+  static JSONDebuggerCommand debugger_commands[] = {
+    { "resume", HandleResumeCmd },
+    { "getLibraryURLs", HandleGetLibraryURLsCmd},
+    { "getScriptURLs", HandleGetScriptURLsCmd },
+    { "stepInto", HandleStepIntoCmd },
+    { "stepOut", HandleStepOutCmd },
+    { "stepOver", HandleStepOverCmd },
+    { NULL, NULL }
+  };
+
   for (;;) {
     while (!msgbuf_->IsValidMessage() && msgbuf_->Alive()) {
       msgbuf_->ReadData();
     }
     if (!msgbuf_->Alive()) {
       return;
     }
     dart::JSONReader r(msgbuf_->buf());
     bool found = r.Seek("command");
     if (r.Error()) {
       FATAL("Illegal JSON message received");
     }
     if (!found) {
       printf("'command' not found in JSON message: '%s'\n", msgbuf_->buf());
       msgbuf_->PopMessage();
-    } else if (r.IsStringLiteral("resume")) {
-      HandleResumeCmd();
-      msgbuf_->PopMessage();
-      return;
-    } else {
+    }
+    int i = 0;
+    bool is_handled = false;
+    request_resume_ = false;
+    while (debugger_commands[i].cmd_string != NULL) {
+      if (r.IsStringLiteral(debugger_commands[i].cmd_string)) {
+        is_handled = true;
+        (*debugger_commands[i].handler_function)(msgbuf_->buf());
+        msgbuf_->PopMessage();
+        if (request_resume_) {
+          return;
+        }
+        break;
+      }
+      i++;
+    }
+    if (!is_handled) {

[siva, 2012/05/10 20:08:36]

It appears that the loop above could handle multiple commands. If the first
command is handled and the next one
is not recognized we will not get this "unrecognized command" message.

[hausner, 2012/05/10 22:36:28]

If a message is handled, the break statement in line 310 terminates the while
loop. The following message is then handled (or not handled) in a new iteration
of the outer loop. Thus, it appears to me that the case you describe can't
happen.

On 2012/05/10 20:08:36, asiva wrote:

       printf("unrecognized command received: '%s'\n", msgbuf_->buf());
       msgbuf_->PopMessage();
     }
   }
 }
 
 
 void DebuggerConnectionHandler::SendBreakpointEvent(Dart_Breakpoint bpt,
                                                     Dart_StackTrace trace) {
   dart::TextBuffer msg(128);
   intptr_t trace_len = 0;
   Dart_Handle res = Dart_StackTraceLength(trace, &trace_len);
   ASSERT_NOT_ERROR(res);
-  msg.Printf("{ \"command\" : \"paused\", \"params\" : ");
+  msg.Printf("{ \"event\": \"paused\", \"params\": ");
   msg.Printf("{ \"callFrames\" : [ ");
   for (int i = 0; i < trace_len; i++) {
     Dart_ActivationFrame frame;
     res = Dart_GetActivationFrame(trace, i, &frame);
     ASSERT_NOT_ERROR(res);
     Dart_Handle func_name;
     Dart_Handle script_url;
     intptr_t line_number = 0;
     res = Dart_ActivationFrameInfo(
               frame, &func_name, &script_url, &line_number);
     ASSERT_NOT_ERROR(res);
     ASSERT(Dart_IsString(func_name));
     const char* func_name_chars;
     Dart_StringToCString(func_name, &func_name_chars);
-    msg.Printf("%s { \"functionName\" : \"%s\" , ",
+    msg.Printf("%s { \"functionName\": \"%s\" , ",
               i > 0 ? "," : "",
               func_name_chars);
     ASSERT(Dart_IsString(script_url));
     const char* script_url_chars;
     Dart_StringToCString(script_url, &script_url_chars);
     msg.Printf("\"location\": { \"url\": \"%s\", \"lineNumber\": %d }}",
                script_url_chars, line_number);
   }
   msg.Printf("]}}");
   Socket::Write(debugger_fd_, msg.buf(), msg.length());
@@ skipping 51 matching lines @@
 
   handler_started_ = true;
   DebuggerConnectionImpl::StartHandler(port_number);
   Dart_SetBreakpointHandler(BreakpointHandler);
 }
 
 
 DebuggerConnectionHandler::~DebuggerConnectionHandler() {
   CloseDbgConnection();
 }