Refactor Pickle Read methods to use higher performance PickleIterator.

ipc/ipc_message_utils.cc

 // Copyright (c) 2012 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 "ipc/ipc_message_utils.h"
 
 #include "base/file_path.h"
 #include "base/json/json_writer.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/nullable_string16.h"
 #include "base/string_number_conversions.h"
 #include "base/time.h"
 #include "base/utf_string_conversions.h"
 #include "base/values.h"
 #if defined(OS_POSIX)
 #include "ipc/file_descriptor_set_posix.h"
 #endif
 #include "ipc/ipc_channel_handle.h"
 
 namespace IPC {
 
 const int kMaxRecursionDepth = 100;
 
 // Value serialization
 
-static bool ReadValue(const Message* m, void** iter, Value** value,
+static bool ReadValue(const Message* m, PickleIterator* iter, Value** value,
                       int recursion);
 
 static void WriteValue(Message* m, const Value* value, int recursion) {
   if (recursion > kMaxRecursionDepth) {
     LOG(WARNING) << "Max recursion depth hit in WriteValue.";
     return;
   }
 
   m->WriteInt(value->GetType());
 
@@ skipping 58 matching lines @@
           NOTREACHED() << "ListValue::GetSize is a filthy liar.";
         }
       }
       break;
     }
   }
 }
 
 // Helper for ReadValue that reads a DictionaryValue into a pre-allocated
 // object.
-static bool ReadDictionaryValue(const Message* m, void** iter,
+static bool ReadDictionaryValue(const Message* m, PickleIterator* iter,
                                 DictionaryValue* value, int recursion) {
   int size;
   if (!ReadParam(m, iter, &size))
     return false;
 
   for (int i = 0; i < size; ++i) {
     std::string key;
     Value* subval;
     if (!ReadParam(m, iter, &key) ||
         !ReadValue(m, iter, &subval, recursion + 1))
       return false;
     value->SetWithoutPathExpansion(key, subval);
   }
 
   return true;
 }
 
 // Helper for ReadValue that reads a ReadListValue into a pre-allocated
 // object.
-static bool ReadListValue(const Message* m, void** iter,
+static bool ReadListValue(const Message* m, PickleIterator* iter,
                           ListValue* value, int recursion) {
   int size;
   if (!ReadParam(m, iter, &size))
     return false;
 
   for (int i = 0; i < size; ++i) {
     Value* subval;
     if (!ReadValue(m, iter, &subval, recursion + 1))
       return false;
     value->Set(i, subval);
   }
 
   return true;
 }
 
-static bool ReadValue(const Message* m, void** iter, Value** value,
+static bool ReadValue(const Message* m, PickleIterator* iter, Value** value,
                       int recursion) {
   if (recursion > kMaxRecursionDepth) {
     LOG(WARNING) << "Max recursion depth hit in ReadValue.";
     return false;
   }
 
   int type;
   if (!ReadParam(m, iter, &type))
     return false;
 
@@ skipping 79 matching lines @@
 }
 
 void ParamTraits<unsigned long long>::Log(const param_type& p, std::string* l) {
   l->append(base::Uint64ToString(p));
 }
 
 void ParamTraits<unsigned short>::Write(Message* m, const param_type& p) {
   m->WriteBytes(&p, sizeof(param_type));
 }
 
-bool ParamTraits<unsigned short>::Read(const Message* m, void** iter,
+bool ParamTraits<unsigned short>::Read(const Message* m, PickleIterator* iter,
                                        param_type* r) {
   const char* data;
   if (!m->ReadBytes(iter, &data, sizeof(param_type)))
     return false;
   memcpy(r, data, sizeof(param_type));
   return true;
 }
 
 void ParamTraits<unsigned short>::Log(const param_type& p, std::string* l) {
   l->append(base::UintToString(p));
 }
 
 void ParamTraits<base::Time>::Write(Message* m, const param_type& p) {
   ParamTraits<int64>::Write(m, p.ToInternalValue());
 }
 
-bool ParamTraits<base::Time>::Read(const Message* m, void** iter,
+bool ParamTraits<base::Time>::Read(const Message* m, PickleIterator* iter,
                                    param_type* r) {
   int64 value;
   if (!ParamTraits<int64>::Read(m, iter, &value))
     return false;
   *r = base::Time::FromInternalValue(value);
   return true;
 }
 
 void ParamTraits<base::Time>::Log(const param_type& p, std::string* l) {
   ParamTraits<int64>::Log(p.ToInternalValue(), l);
 }
 
 void ParamTraits<base::TimeDelta> ::Write(Message* m, const param_type& p) {
   ParamTraits<int64> ::Write(m, p.ToInternalValue());
 }
 
 bool ParamTraits<base::TimeDelta> ::Read(const Message* m,
-                                         void** iter,
+                                         PickleIterator* iter,
                                          param_type* r) {
   int64 value;
   bool ret = ParamTraits<int64> ::Read(m, iter, &value);
   if (ret)
     *r = base::TimeDelta::FromInternalValue(value);
 
   return ret;
 }
 
 void ParamTraits<base::TimeDelta> ::Log(const param_type& p, std::string* l) {
   ParamTraits<int64> ::Log(p.ToInternalValue(), l);
 }
 
 void ParamTraits<base::TimeTicks> ::Write(Message* m, const param_type& p) {
   ParamTraits<int64> ::Write(m, p.ToInternalValue());
 }
 
 bool ParamTraits<base::TimeTicks> ::Read(const Message* m,
-                                         void** iter,
+                                         PickleIterator* iter,
                                          param_type* r) {
   int64 value;
   bool ret = ParamTraits<int64> ::Read(m, iter, &value);
   if (ret)
     *r = base::TimeTicks::FromInternalValue(value);
 
   return ret;
 }
 
 void ParamTraits<base::TimeTicks> ::Log(const param_type& p, std::string* l) {
   ParamTraits<int64> ::Log(p.ToInternalValue(), l);
 }
 
 void ParamTraits<DictionaryValue>::Write(Message* m, const param_type& p) {
   WriteValue(m, &p, 0);
 }
 
 bool ParamTraits<DictionaryValue>::Read(
-    const Message* m, void** iter, param_type* r) {
+    const Message* m, PickleIterator* iter, param_type* r) {
   int type;
   if (!ReadParam(m, iter, &type) || type != Value::TYPE_DICTIONARY)
     return false;
 
   return ReadDictionaryValue(m, iter, r, 0);
 }
 
 void ParamTraits<DictionaryValue>::Log(const param_type& p, std::string* l) {
   std::string json;
   base::JSONWriter::Write(&p, false, &json);
   l->append(json);
 }
 
 void ParamTraits<ListValue>::Write(Message* m, const param_type& p) {
   WriteValue(m, &p, 0);
 }
 
 bool ParamTraits<ListValue>::Read(
-    const Message* m, void** iter, param_type* r) {
+    const Message* m, PickleIterator* iter, param_type* r) {
   int type;
   if (!ReadParam(m, iter, &type) || type != Value::TYPE_LIST)
     return false;
 
   return ReadListValue(m, iter, r, 0);
 }
 
 void ParamTraits<ListValue>::Log(const param_type& p, std::string* l) {
   std::string json;
   base::JSONWriter::Write(&p, false, &json);
   l->append(json);
 }
 
 void ParamTraits<std::wstring>::Log(const param_type& p, std::string* l) {
   l->append(WideToUTF8(p));
 }
 
 void ParamTraits<NullableString16>::Write(Message* m, const param_type& p) {
   WriteParam(m, p.string());
   WriteParam(m, p.is_null());
 }
 
-bool ParamTraits<NullableString16>::Read(const Message* m, void** iter,
+bool ParamTraits<NullableString16>::Read(const Message* m, PickleIterator* iter,
                                          param_type* r) {
   string16 string;
   if (!ReadParam(m, iter, &string))
     return false;
   bool is_null;
   if (!ReadParam(m, iter, &is_null))
     return false;
   *r = NullableString16(string, is_null);
   return true;
 }
@@ skipping 10 matching lines @@
 void ParamTraits<string16>::Log(const param_type& p, std::string* l) {
   l->append(UTF16ToUTF8(p));
 }
 #endif
 
 
 void ParamTraits<FilePath>::Write(Message* m, const param_type& p) {
   ParamTraits<FilePath::StringType>::Write(m, p.value());
 }
 
-bool ParamTraits<FilePath>::Read(const Message* m, void** iter, param_type* r) {
+bool ParamTraits<FilePath>::Read(const Message* m,
+                                 PickleIterator* iter,
+                                 param_type* r) {
   FilePath::StringType value;
   if (!ParamTraits<FilePath::StringType>::Read(m, iter, &value))
     return false;
   *r = FilePath(value);
   return true;
 }
 
 void ParamTraits<FilePath>::Log(const param_type& p, std::string* l) {
   ParamTraits<FilePath::StringType>::Log(p.value(), l);
 }
 
 #if defined(OS_POSIX)
 void ParamTraits<base::FileDescriptor>::Write(Message* m, const param_type& p) {
   const bool valid = p.fd >= 0;
   WriteParam(m, valid);
 
   if (valid) {
     if (!m->WriteFileDescriptor(p))
       NOTREACHED();
   }
 }
 
-bool ParamTraits<base::FileDescriptor>::Read(const Message* m, void** iter,
+bool ParamTraits<base::FileDescriptor>::Read(const Message* m,
+                                             PickleIterator* iter,
                                              param_type* r) {
   bool valid;
   if (!ReadParam(m, iter, &valid))
     return false;
 
   if (!valid) {
     r->fd = -1;
     r->auto_close = false;
     return true;
   }
@@ skipping 15 matching lines @@
 #if defined(OS_WIN)
   // On Windows marshalling pipe handle is not supported.
   DCHECK(p.pipe.handle == NULL);
 #endif  // defined (OS_WIN)
   WriteParam(m, p.name);
 #if defined(OS_POSIX)
   WriteParam(m, p.socket);
 #endif
 }
 
-bool ParamTraits<IPC::ChannelHandle>::Read(const Message* m, void** iter,
+bool ParamTraits<IPC::ChannelHandle>::Read(const Message* m,
+                                           PickleIterator* iter,
                                            param_type* r) {
   return ReadParam(m, iter, &r->name)
 #if defined(OS_POSIX)
       && ReadParam(m, iter, &r->socket)
 #endif
       ;
 }
 
 void ParamTraits<IPC::ChannelHandle>::Log(const param_type& p,
                                           std::string* l) {
@@ skipping 20 matching lines @@
   WriteParam(m, p.channel);
   WriteParam(m, p.routing_id);
   WriteParam(m, p.type);
   WriteParam(m, p.flags);
   WriteParam(m, p.sent);
   WriteParam(m, p.receive);
   WriteParam(m, p.dispatch);
   WriteParam(m, p.params);
 }
 
-bool ParamTraits<LogData>::Read(const Message* m, void** iter, param_type* r) {
+bool ParamTraits<LogData>::Read(const Message* m,
+                                PickleIterator* iter,
+                                param_type* r) {
   return
       ReadParam(m, iter, &r->channel) &&
       ReadParam(m, iter, &r->routing_id) &&
       ReadParam(m, iter, &r->type) &&
       ReadParam(m, iter, &r->flags) &&
       ReadParam(m, iter, &r->sent) &&
       ReadParam(m, iter, &r->receive) &&
       ReadParam(m, iter, &r->dispatch) &&
       ReadParam(m, iter, &r->params);
 }
 
 }  // namespace IPC