Generalize the net module's LoadLog facility from a passive container, to an event stream (NetLog).

net/socket/socks5_client_socket.cc

 // Copyright (c) 2009 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 "net/socket/socks5_client_socket.h"
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/format_macros.h"
 #include "base/string_util.h"
 #include "base/trace_event.h"
 #include "net/base/io_buffer.h"
-#include "net/base/load_log.h"
+#include "net/base/net_log.h"
 #include "net/base/net_util.h"
 #include "net/base/sys_addrinfo.h"
 
 namespace net {
 
 namespace {
 
 // Returns a string description of |socks_error|, or NULL if |socks_error| is
 // not a valid SOCKS reply.
 const char* MapSOCKSReplyToErrorString(char socks_error) {
@@ skipping 34 matching lines @@
       bytes_received_(0),
       read_header_size(kReadHeaderSize),
       host_request_info_(req_info) {
 }
 
 SOCKS5ClientSocket::~SOCKS5ClientSocket() {
   Disconnect();
 }
 
 int SOCKS5ClientSocket::Connect(CompletionCallback* callback,
-                                LoadLog* load_log) {
+                                const BoundNetLog& net_log) {
   DCHECK(transport_.get());
   DCHECK(transport_->IsConnected());
   DCHECK_EQ(STATE_NONE, next_state_);
   DCHECK(!user_callback_);
 
   // If already connected, then just return OK.
   if (completed_handshake_)
     return OK;
 
-  load_log_ = load_log;
-  LoadLog::BeginEvent(load_log, LoadLog::TYPE_SOCKS5_CONNECT);
+  net_log_ = net_log;
+  net_log.BeginEvent(NetLog::TYPE_SOCKS5_CONNECT);
 
   next_state_ = STATE_GREET_WRITE;
   buffer_.clear();
 
   int rv = DoLoop(OK);
   if (rv == ERR_IO_PENDING) {
     user_callback_ = callback;
   } else {
-    LoadLog::EndEvent(load_log, LoadLog::TYPE_SOCKS5_CONNECT);
-    load_log_ = NULL;
+    net_log.EndEvent(NetLog::TYPE_SOCKS5_CONNECT);
+    net_log_ = BoundNetLog();
   }
   return rv;
 }
 
 void SOCKS5ClientSocket::Disconnect() {
   completed_handshake_ = false;
   transport_->Disconnect();
 
   // Reset other states to make sure they aren't mistakenly used later.
   // These are the states initialized by Connect().
   next_state_ = STATE_NONE;
   user_callback_ = NULL;
-  load_log_ = NULL;
+  net_log_ = BoundNetLog();
 }
 
 bool SOCKS5ClientSocket::IsConnected() const {
   return completed_handshake_ && transport_->IsConnected();
 }
 
 bool SOCKS5ClientSocket::IsConnectedAndIdle() const {
   return completed_handshake_ && transport_->IsConnectedAndIdle();
 }
 
@@ skipping 35 matching lines @@
   // clear user_callback_ up front.
   CompletionCallback* c = user_callback_;
   user_callback_ = NULL;
   c->Run(result);
 }
 
 void SOCKS5ClientSocket::OnIOComplete(int result) {
   DCHECK_NE(STATE_NONE, next_state_);
   int rv = DoLoop(result);
   if (rv != ERR_IO_PENDING) {
-    LoadLog::EndEvent(load_log_, LoadLog::TYPE_SOCKS5_CONNECT);
-    load_log_ = NULL;
+    net_log_.EndEvent(NetLog::TYPE_SOCKS5_CONNECT);
+    net_log_ = BoundNetLog();
     DoCallback(rv);
   }
 }
 
 int SOCKS5ClientSocket::DoLoop(int last_io_result) {
   DCHECK_NE(next_state_, STATE_NONE);
   int rv = last_io_result;
   do {
     State state = next_state_;
     next_state_ = STATE_NONE;
     switch (state) {
       case STATE_GREET_WRITE:
         DCHECK_EQ(OK, rv);
-        LoadLog::BeginEvent(load_log_, LoadLog::TYPE_SOCKS5_GREET_WRITE);
+        net_log_.BeginEvent(NetLog::TYPE_SOCKS5_GREET_WRITE);
         rv = DoGreetWrite();
         break;
       case STATE_GREET_WRITE_COMPLETE:
         rv = DoGreetWriteComplete(rv);
-        LoadLog::EndEvent(load_log_, LoadLog::TYPE_SOCKS5_GREET_WRITE);
+        net_log_.EndEvent(NetLog::TYPE_SOCKS5_GREET_WRITE);
         break;
       case STATE_GREET_READ:
         DCHECK_EQ(OK, rv);
-        LoadLog::BeginEvent(load_log_, LoadLog::TYPE_SOCKS5_GREET_READ);
+        net_log_.BeginEvent(NetLog::TYPE_SOCKS5_GREET_READ);
         rv = DoGreetRead();
         break;
       case STATE_GREET_READ_COMPLETE:
         rv = DoGreetReadComplete(rv);
-        LoadLog::EndEvent(load_log_, LoadLog::TYPE_SOCKS5_GREET_READ);
+        net_log_.EndEvent(NetLog::TYPE_SOCKS5_GREET_READ);
         break;
       case STATE_HANDSHAKE_WRITE:
         DCHECK_EQ(OK, rv);
-        LoadLog::BeginEvent(load_log_, LoadLog::TYPE_SOCKS5_HANDSHAKE_WRITE);
+        net_log_.BeginEvent(NetLog::TYPE_SOCKS5_HANDSHAKE_WRITE);
         rv = DoHandshakeWrite();
         break;
       case STATE_HANDSHAKE_WRITE_COMPLETE:
         rv = DoHandshakeWriteComplete(rv);
-        LoadLog::EndEvent(load_log_, LoadLog::TYPE_SOCKS5_HANDSHAKE_WRITE);
+        net_log_.EndEvent(NetLog::TYPE_SOCKS5_HANDSHAKE_WRITE);
         break;
       case STATE_HANDSHAKE_READ:
         DCHECK_EQ(OK, rv);
-        LoadLog::BeginEvent(load_log_, LoadLog::TYPE_SOCKS5_HANDSHAKE_READ);
+        net_log_.BeginEvent(NetLog::TYPE_SOCKS5_HANDSHAKE_READ);
         rv = DoHandshakeRead();
         break;
       case STATE_HANDSHAKE_READ_COMPLETE:
         rv = DoHandshakeReadComplete(rv);
-        LoadLog::EndEvent(load_log_, LoadLog::TYPE_SOCKS5_HANDSHAKE_READ);
+        net_log_.EndEvent(NetLog::TYPE_SOCKS5_HANDSHAKE_READ);
         break;
       default:
         NOTREACHED() << "bad state";
         rv = ERR_UNEXPECTED;
         break;
     }
   } while (rv != ERR_IO_PENDING && next_state_ != STATE_NONE);
   return rv;
 }
 
 const char kSOCKS5GreetWriteData[] = { 0x05, 0x01, 0x00 };  // no authentication
 const char kSOCKS5GreetReadData[] = { 0x05, 0x00 };
 
 int SOCKS5ClientSocket::DoGreetWrite() {
   // Since we only have 1 byte to send the hostname length in, if the
   // URL has a hostname longer than 255 characters we can't send it.
   if (0xFF < host_request_info_.hostname().size()) {
-    LoadLog::AddStringLiteral(load_log_,
-        "Failed sending request because hostname is "
+    net_log_.AddStringLiteral("Failed sending request because hostname is "
         "longer than 255 characters");
     return ERR_SOCKS_CONNECTION_FAILED;
   }
 
   if (buffer_.empty()) {
     buffer_ = std::string(kSOCKS5GreetWriteData,
                           arraysize(kSOCKS5GreetWriteData));
     bytes_sent_ = 0;
   }
 
@@ skipping 25 matching lines @@
   size_t handshake_buf_len = kGreetReadHeaderSize - bytes_received_;
   handshake_buf_ = new IOBuffer(handshake_buf_len);
   return transport_->Read(handshake_buf_, handshake_buf_len, &io_callback_);
 }
 
 int SOCKS5ClientSocket::DoGreetReadComplete(int result) {
   if (result < 0)
     return result;
 
   if (result == 0) {
-    LoadLog::AddStringLiteral(
-        load_log_, "Connection unexpected closed while reading greeting.");
+    net_log_.AddStringLiteral(
+        "Connection unexpected closed while reading greeting.");
     return ERR_SOCKS_CONNECTION_FAILED;
   }
 
   bytes_received_ += result;
   buffer_.append(handshake_buf_->data(), result);
   if (bytes_received_ < kGreetReadHeaderSize) {
     next_state_ = STATE_GREET_READ;
     return OK;
   }
 
   // Got the greet data.
   if (buffer_[0] != kSOCKS5Version) {
-    LoadLog::AddStringLiteral(load_log_, "Unexpected SOCKS version");
-    LoadLog::AddString(load_log_, StringPrintf(
+    net_log_.AddStringLiteral("Unexpected SOCKS version");
+    net_log_.AddString(StringPrintf(
         "buffer_[0] = 0x%x", static_cast<int>(buffer_[0])));
     return ERR_SOCKS_CONNECTION_FAILED;
   }
   if (buffer_[1] != 0x00) {
-    LoadLog::AddStringLiteral(load_log_, "Unexpected authentication method");
-    LoadLog::AddString(load_log_, StringPrintf(
+    net_log_.AddStringLiteral("Unexpected authentication method");
+    net_log_.AddString(StringPrintf(
         "buffer_[1] = 0x%x", static_cast<int>(buffer_[1])));
     return ERR_SOCKS_CONNECTION_FAILED;
   }
 
   buffer_.clear();
   next_state_ = STATE_HANDSHAKE_WRITE;
   return OK;
 }
 
 int SOCKS5ClientSocket::BuildHandshakeWriteBuffer(std::string* handshake)
@@ skipping 69 matching lines @@
   handshake_buf_ = new IOBuffer(handshake_buf_len);
   return transport_->Read(handshake_buf_, handshake_buf_len, &io_callback_);
 }
 
 int SOCKS5ClientSocket::DoHandshakeReadComplete(int result) {
   if (result < 0)
     return result;
 
   // The underlying socket closed unexpectedly.
   if (result == 0) {
-    LoadLog::AddStringLiteral(
-        load_log_, "Connection unexpected closed while reading handshake.");
+    net_log_.AddStringLiteral(
+        "Connection unexpected closed while reading handshake.");
     return ERR_SOCKS_CONNECTION_FAILED;
   }
 
   buffer_.append(handshake_buf_->data(), result);
   bytes_received_ += result;
 
   // When the first few bytes are read, check how many more are required
   // and accordingly increase them
   if (bytes_received_ == kReadHeaderSize) {
     if (buffer_[0] != kSOCKS5Version || buffer_[2] != kNullByte) {
-      LoadLog::AddStringLiteral(load_log_, "Unexpected SOCKS version.");
-      LoadLog::AddString(load_log_, StringPrintf(
+      net_log_.AddStringLiteral("Unexpected SOCKS version.");
+      net_log_.AddString(StringPrintf(
           "buffer_[0] = 0x%x; buffer_[2] = 0x%x",
           static_cast<int>(buffer_[0]),
           static_cast<int>(buffer_[2])));
       return ERR_SOCKS_CONNECTION_FAILED;
     }
     if (buffer_[1] != 0x00) {
-      LoadLog::AddStringLiteral(load_log_,
-                                "SOCKS server returned a failure code:");
+      net_log_.AddStringLiteral("SOCKS server returned a failure code:");
       const char* error_string = MapSOCKSReplyToErrorString(buffer_[1]);
       if (error_string) {
-        LoadLog::AddStringLiteral(load_log_, error_string);
+        net_log_.AddStringLiteral(error_string);
       } else {
-        LoadLog::AddString(load_log_, StringPrintf(
+        net_log_.AddString(StringPrintf(
             "buffer_[1] = 0x%x", static_cast<int>(buffer_[1])));
       }
       return ERR_SOCKS_CONNECTION_FAILED;
     }
 
     // We check the type of IP/Domain the server returns and accordingly
     // increase the size of the response. For domains, we need to read the
     // size of the domain, so the initial request size is upto the domain
     // size. Since for IPv4/IPv6 the size is fixed and hence no 'size' is
     // read, we substract 1 byte from the additional request size.
     SocksEndPointAddressType address_type =
         static_cast<SocksEndPointAddressType>(buffer_[3]);
     if (address_type == kEndPointDomain)
       read_header_size += static_cast<uint8>(buffer_[4]);
     else if (address_type == kEndPointResolvedIPv4)
       read_header_size += sizeof(struct in_addr) - 1;
     else if (address_type == kEndPointResolvedIPv6)
       read_header_size += sizeof(struct in6_addr) - 1;
     else {
-      LoadLog::AddStringLiteral(load_log_, "Unknown address type in response");
-      LoadLog::AddString(load_log_, StringPrintf(
+      net_log_.AddStringLiteral("Unknown address type in response");
+      net_log_.AddString(StringPrintf(
           "buffer_[3] = 0x%x", static_cast<int>(buffer_[3])));
       return ERR_SOCKS_CONNECTION_FAILED;
     }
 
     read_header_size += 2;  // for the port.
     next_state_ = STATE_HANDSHAKE_READ;
     return OK;
   }
 
   // When the final bytes are read, setup handshake. We ignore the rest
   // of the response since they represent the SOCKSv5 endpoint and have
   // no use when doing a tunnel connection.
   if (bytes_received_ == read_header_size) {
     completed_handshake_ = true;
     buffer_.clear();
     next_state_ = STATE_NONE;
     return OK;
   }
 
   next_state_ = STATE_HANDSHAKE_READ;
   return OK;
 }
 
 int SOCKS5ClientSocket::GetPeerAddress(AddressList* address) const {
   return transport_->GetPeerAddress(address);
 }
 
 }  // namespace net