Implements RTP header dumping.

chrome/browser/media/webrtc_logging_handler_host.cc

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/media/webrtc_logging_handler_host.h"
 
 #include <string>
 
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/cpu.h"
 #include "base/file_util.h"
 #include "base/logging.h"
 #include "base/prefs/pref_service.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/sys_info.h"
 #include "base/time/time.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/chromeos/settings/cros_settings.h"
 #include "chrome/browser/media/webrtc_log_list.h"
 #include "chrome/browser/media/webrtc_log_uploader.h"
+#include "chrome/browser/media/webrtc_rtp_dump_handler.h"
+#include "chrome/browser/media/webrtc_rtp_dump_writer.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/media/webrtc_logging_messages.h"
 #include "chrome/common/partial_circular_buffer.h"
 #include "chrome/common/pref_names.h"
 #include "chromeos/settings/cros_settings_names.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/content_browser_client.h"
 #include "content/public/browser/gpu_data_manager.h"
 #include "content/public/browser/render_process_host.h"
 #include "gpu/config/gpu_info.h"
 #include "net/base/address_family.h"
 #include "net/url_request/url_request_context_getter.h"
 
 #if defined(OS_LINUX)
 #include "base/linux_util.h"
 #endif
 
 #if defined(OS_MACOSX)
 #include "base/mac/mac_util.h"
 #endif
 
 #if defined(OS_CHROMEOS)
 #include "chromeos/system/statistics_provider.h"
 #endif
 
 using base::IntToString;
 using content::BrowserThread;
 
+namespace {
 
 #if defined(OS_ANDROID)
 const size_t kWebRtcLogSize = 1 * 1024 * 1024;  // 1 MB
 #else
-const size_t kWebRtcLogSize = 6 * 1024 * 1024;  // 6 MB
+const size_t kWebRtcLogSize = 4 * 1024 * 1024;  // 4 MB

[Henrik Grunell, 2014/05/13 09:12:31]

What's the rationale for decreasing this?

[jiayl, 2014/05/13 21:48:17]

The max upload size including log and dumps is 10,000KB. So I changed it to make
the total max size below 10MB. But I forgot that this is the uncompressed size.
So 6MB should be fine. I changed it back.

[Henrik Grunell, 2014/05/14 12:14:12]

OK.

 #endif
 
-namespace {
-
 const char kLogNotStoppedOrNoLogOpen[] =
     "Logging not stopped or no log open.";
 
 // For privacy reasons when logging IP addresses. The returned "sensitive
 // string" is for release builds a string with the end stripped away. Last
 // octet for IPv4 and last 80 bits (5 groups) for IPv6. String will be
 // "1.2.3.x" and "1.2.3::" respectively. For debug builds, the string is
 // not stripped.
 std::string IPAddressToSensitiveString(const net::IPAddressNumber& address) {
 #if defined(NDEBUG)
@@ skipping 113 matching lines @@
     }
     return;
   }
   upload_callback_ = callback;
   logging_state_ = UPLOADING;
   content::BrowserThread::PostTaskAndReplyWithResult(
       content::BrowserThread::FILE,
       FROM_HERE,
       base::Bind(&WebRtcLoggingHandlerHost::GetLogDirectoryAndEnsureExists,
                  this),
-      base::Bind(&WebRtcLoggingHandlerHost::TriggerUploadLog, this));
+      base::Bind(&WebRtcLoggingHandlerHost::TriggerUploadLogAndRtpDump, this));
 }
 
 void WebRtcLoggingHandlerHost::UploadLogDone() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
   logging_state_ = CLOSED;
 }
 
 void WebRtcLoggingHandlerHost::DiscardLog(const GenericDoneCallback& callback) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
   DCHECK(!callback.is_null());
 
   GenericDoneCallback discard_callback = callback;
   if (logging_state_ != STOPPED) {
     FireGenericDoneCallback(&discard_callback, false,
                             kLogNotStoppedOrNoLogOpen);
     return;
   }
   g_browser_process->webrtc_log_uploader()->LoggingStoppedDontUpload();
   circular_buffer_.reset();
   log_buffer_.reset();
   logging_state_ = CLOSED;
+  rtp_dump_handler_.reset();
   FireGenericDoneCallback(&discard_callback, true, "");
 }
 
 void WebRtcLoggingHandlerHost::LogMessage(const std::string& message) {
   BrowserThread::PostTask(
       BrowserThread::IO,
       FROM_HERE,
       base::Bind(
           &WebRtcLoggingHandlerHost::AddLogMessageFromBrowser,
           this,
           WebRtcLoggingMessageData(base::Time::Now(), message)));
 }
 
 void WebRtcLoggingHandlerHost::StartRtpDump(
     bool incoming,
     bool outgoing,
     const GenericDoneCallback& callback) {
-  NOTIMPLEMENTED();
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
+  DCHECK(!callback.is_null());
+
+  GenericDoneCallback start_callback = callback;
+  if (!incoming && !outgoing) {
+    FireGenericDoneCallback(&start_callback, false, "");

[Henrik Grunell, 2014/05/13 09:12:31]

Add an error message (third argument) for all places and cases were an error is
returned.

[jiayl, 2014/05/13 21:48:17]

Done.

+    return;
+  }
+
+  if (!rtp_dump_handler_) {
+    content::BrowserThread::PostTaskAndReplyWithResult(

[Henrik Grunell, 2014/05/13 09:12:31]

What happens if there's another call to StartRtpDump while on the file thread?
Seems like a potential problem.

[jiayl, 2014/05/13 21:48:17]

Changed CreateRtpDumpHandlerAndStart to check if rtp_dump_handler_ is NULL. If
it's not NULL, do not re-create it.

[Henrik Grunell, 2014/05/14 12:14:12]

So, it's safe to call multiple times?

[jiayl, 2014/05/14 16:07:58]

yes, it's safe.

+        content::BrowserThread::FILE,
+        FROM_HERE,
+        base::Bind(&WebRtcLoggingHandlerHost::GetLogDirectoryAndEnsureExists,
+                   this),
+        base::Bind(&WebRtcLoggingHandlerHost::CreateRtpDumpHandlerAndStart,
+                   this,
+                   incoming,
+                   outgoing,
+                   callback));
+    return;
+  }
+
+  WebRtcRtpDumpHandler::PacketType type = {incoming, outgoing};

[Henrik Grunell, 2014/05/13 09:12:31]

I think this part should be moved to it's own function and
CreateRtpDumpHandlerAndStart calls that function instead of calling StartRtpDump
again.

[jiayl, 2014/05/13 21:48:17]

Done.

+  bool result = rtp_dump_handler_->StartDump(type);
+  FireGenericDoneCallback(&start_callback, result, "");
 }
 
 void WebRtcLoggingHandlerHost::StopRtpDump(
     bool incoming,
     bool outgoing,
     const GenericDoneCallback& callback) {
-  NOTIMPLEMENTED();
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
+  DCHECK(!callback.is_null());
+
+  GenericDoneCallback stop_callback = callback;
+  if (!(incoming || outgoing) || !rtp_dump_handler_) {
+    FireGenericDoneCallback(&stop_callback, false, "");
+    return;
+  }
+
+  WebRtcRtpDumpHandler::PacketType type = {incoming, outgoing};
+  bool result = rtp_dump_handler_->StopDump(type);
+  FireGenericDoneCallback(&stop_callback, result, "");
+}
+
+void WebRtcLoggingHandlerHost::OnRtpPacket(const uint8* packet_header,

[Henrik Grunell, 2014/05/13 09:12:31]

Which thread should this be called on? Thread check?

[jiayl, 2014/05/13 21:48:17]

In practice it called on the browser UI thread. Since it always posts to the IO
thread, the interface does not enforce the thread it's called on. 

+                                           size_t header_length,
+                                           size_t packet_length,
+                                           bool incoming) {
+  scoped_ptr<uint8[]> header_data(new uint8[header_length]);
+  memcpy(header_data.get(), packet_header, header_length);
+
+  BrowserThread::PostTask(
+      BrowserThread::IO,
+      FROM_HERE,
+      base::Bind(&WebRtcLoggingHandlerHost::DumpRtpPacketOnIOThread,
+                 this,
+                 base::Passed(&header_data),
+                 header_length,
+                 packet_length,
+                 incoming));
+}
+
+void WebRtcLoggingHandlerHost::DumpRtpPacketOnIOThread(
+    scoped_ptr<uint8[]> packet_header,
+    size_t header_length,
+    size_t packet_length,
+    bool incoming) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
+
+  if (rtp_dump_handler_) {

[Henrik Grunell, 2014/05/13 09:12:31]

Is |rtp_dump_handler_| expected to be NULL sometimes? When? If not, DCHECK that
is exists instead.

[jiayl, 2014/05/13 21:48:17]

The call is triggered by P2PSocketHost, which lives in a different module (i.e.
content) and running on different threads. So I want to be defensive even in the
current implementation it should be not NULL. 

[Henrik Grunell, 2014/05/14 12:14:12]

This sounds dangerous. Do you mean it can be a race when stopping? The callback
to this object shouldn't be set if not enabled, right? If you suspect a race,
make sure there isn't one.

[jiayl, 2014/05/14 16:07:58]

There is no race in the impl. What I mean is that the client is not required to
maintain the dumping state, instead
WebRtcLoggingHandlerHost/WebRtcRtpDumpHandler should ignore the packet if
dumping is not started or stopped.

+    rtp_dump_handler_->OnRtpPacket(
+        packet_header.get(), header_length, packet_length, incoming);
+  }
 }
 
 void WebRtcLoggingHandlerHost::OnChannelClosing() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
   if (logging_state_ == STARTED || logging_state_ == STOPPED) {
     if (upload_log_on_render_close_) {
       logging_state_ = UPLOADING;
       logging_started_time_ = base::Time();
       content::BrowserThread::PostTaskAndReplyWithResult(
           content::BrowserThread::FILE,
           FROM_HERE,
           base::Bind(&WebRtcLoggingHandlerHost::GetLogDirectoryAndEnsureExists,
                      this),
-          base::Bind(&WebRtcLoggingHandlerHost::TriggerUploadLog, this));
+          base::Bind(&WebRtcLoggingHandlerHost::TriggerUploadLogAndRtpDump,
+                     this));
     } else {
       g_browser_process->webrtc_log_uploader()->LoggingStoppedDontUpload();
     }
   }
   content::BrowserMessageFilter::OnChannelClosing();
 }
 
 void WebRtcLoggingHandlerHost::OnDestruct() const {
   BrowserThread::DeleteOnIOThread::Destruct(this);
 }
@@ skipping 177 matching lines @@
   base::FilePath log_dir_path =
       WebRtcLogList::GetWebRtcLogDirectoryForProfile(profile_->GetPath());
   base::File::Error error;
   if (!base::CreateDirectoryAndGetError(log_dir_path, &error)) {
     DLOG(ERROR) << "Could not create WebRTC log directory, error: " << error;
     return base::FilePath();
   }
   return log_dir_path;
 }
 
-void WebRtcLoggingHandlerHost::TriggerUploadLog(
+void WebRtcLoggingHandlerHost::TriggerUploadLogAndRtpDump(
     const base::FilePath& log_directory) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
   DCHECK_EQ(logging_state_, UPLOADING);
 
+  if (rtp_dump_handler_ &&

[Henrik Grunell, 2014/05/13 09:12:31]

Same here, can it be NULL?

[jiayl, 2014/05/13 21:48:17]

It can be NULL if rtp dump is never started.

+      rtp_dump_handler_->ReleaseDump(base::Bind(

[Henrik Grunell, 2014/05/13 09:12:31]

So the dump handler will call DoUpload in ReleaseDump. Seems unnecessarily
complicated. Can it be simplified (return dumps?) or why is this needed?

[jiayl, 2014/05/13 21:48:17]

Now Refactored to end the dump on StopDump. So ReleaseDump returns the file
paths directly.

+          &WebRtcLoggingHandlerHost::DoUpload, this, log_directory))) {
+    return;
+  }
+
+  DoUpload(log_directory, WebRtcRtpDumpHandler::ReleasedDumps());
+}
+
+void WebRtcLoggingHandlerHost::FireGenericDoneCallback(
+    GenericDoneCallback* callback,
+    bool success,
+    const std::string& error_message) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
+  DCHECK(!(*callback).is_null());
+  content::BrowserThread::PostTask(
+      content::BrowserThread::UI,
+      FROM_HERE,
+      base::Bind(*callback, success, error_message));
+  (*callback).Reset();
+}
+
+void WebRtcLoggingHandlerHost::CreateRtpDumpHandlerAndStart(
+    bool incoming,
+    bool outgoing,
+    GenericDoneCallback callback,
+    const base::FilePath& dump_dir) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
+  DCHECK(!rtp_dump_handler_);
+
+  rtp_dump_handler_.reset(new WebRtcRtpDumpHandler(dump_dir));
+
+  StartRtpDump(incoming, outgoing, callback);
+}
+
+void WebRtcLoggingHandlerHost::DoUpload(
+    const base::FilePath& log_directory,
+    const WebRtcRtpDumpHandler::ReleasedDumps& rtp_dumps) {
   WebRtcLogUploadDoneData upload_done_data;
   upload_done_data.log_path = log_directory;
+
+  if (!rtp_dumps.incoming_dump_path.empty()) {
+    upload_done_data.rtp_dumps.push_back(
+        WebRtcRtpDumpDescription("rtpdump_recv", rtp_dumps.incoming_dump_path));
+  }
+  if (!rtp_dumps.outgoing_dump_path.empty()) {
+    upload_done_data.rtp_dumps.push_back(
+        WebRtcRtpDumpDescription("rtpdump_send", rtp_dumps.outgoing_dump_path));
+  }
+
   upload_done_data.callback = upload_callback_;
   upload_done_data.host = this;
   upload_callback_.Reset();
 
   BrowserThread::PostTask(BrowserThread::FILE, FROM_HERE, base::Bind(
       &WebRtcLogUploader::LoggingStoppedDoUpload,
       base::Unretained(g_browser_process->webrtc_log_uploader()),
       Passed(&log_buffer_),
       kWebRtcLogSize,
       meta_data_,
       upload_done_data));
 
   meta_data_.clear();
   circular_buffer_.reset();
 }
-
-void WebRtcLoggingHandlerHost::FireGenericDoneCallback(
-    GenericDoneCallback* callback, bool success,
-    const std::string& error_message) {
-  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
-  DCHECK(!(*callback).is_null());
-  content::BrowserThread::PostTask(content::BrowserThread::UI, FROM_HERE,
-                                   base::Bind(*callback, success,
-                                              error_message));
-  (*callback).Reset();
-}