1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #include "ipc/ipc_message_utils.h"
7 #include "base/files/file_path.h"
8 #include "base/json/json_writer.h"
9 #include "base/memory/scoped_ptr.h"
10 #include "base/strings/nullable_string16.h"
11 #include "base/strings/string_number_conversions.h"
12 #include "base/strings/utf_string_conversions.h"
13 #include "base/time/time.h"
14 #include "base/values.h"
15 #include "ipc/ipc_channel_handle.h"
18 #include "ipc/file_descriptor_set_posix.h"
27 const int kMaxRecursionDepth
= 100;
29 template<typename CharType
>
30 void LogBytes(const std::vector
<CharType
>& data
, std::string
* out
) {
32 // Windows has a GUI for logging, which can handle arbitrary binary data.
33 for (size_t i
= 0; i
< data
.size(); ++i
)
34 out
->push_back(data
[i
]);
36 // On POSIX, we log to stdout, which we assume can display ASCII.
37 static const size_t kMaxBytesToLog
= 100;
38 for (size_t i
= 0; i
< std::min(data
.size(), kMaxBytesToLog
); ++i
) {
40 out
->push_back(data
[i
]);
43 base::StringPrintf("[%02X]", static_cast<unsigned char>(data
[i
])));
45 if (data
.size() > kMaxBytesToLog
) {
46 out
->append(base::StringPrintf(
48 static_cast<unsigned>(data
.size() - kMaxBytesToLog
)));
53 bool ReadValue(const Message
* m
, PickleIterator
* iter
, base::Value
** value
,
56 void WriteValue(Message
* m
, const base::Value
* value
, int recursion
) {
58 if (recursion
> kMaxRecursionDepth
) {
59 LOG(WARNING
) << "Max recursion depth hit in WriteValue.";
63 m
->WriteInt(value
->GetType());
65 switch (value
->GetType()) {
66 case base::Value::TYPE_NULL
:
68 case base::Value::TYPE_BOOLEAN
: {
70 result
= value
->GetAsBoolean(&val
);
75 case base::Value::TYPE_INTEGER
: {
77 result
= value
->GetAsInteger(&val
);
82 case base::Value::TYPE_DOUBLE
: {
84 result
= value
->GetAsDouble(&val
);
89 case base::Value::TYPE_STRING
: {
91 result
= value
->GetAsString(&val
);
96 case base::Value::TYPE_BINARY
: {
97 const base::BinaryValue
* binary
=
98 static_cast<const base::BinaryValue
*>(value
);
99 m
->WriteData(binary
->GetBuffer(), static_cast<int>(binary
->GetSize()));
102 case base::Value::TYPE_DICTIONARY
: {
103 const base::DictionaryValue
* dict
=
104 static_cast<const base::DictionaryValue
*>(value
);
106 WriteParam(m
, static_cast<int>(dict
->size()));
108 for (base::DictionaryValue::Iterator
it(*dict
); !it
.IsAtEnd();
110 WriteParam(m
, it
.key());
111 WriteValue(m
, &it
.value(), recursion
+ 1);
115 case base::Value::TYPE_LIST
: {
116 const base::ListValue
* list
= static_cast<const base::ListValue
*>(value
);
117 WriteParam(m
, static_cast<int>(list
->GetSize()));
118 for (base::ListValue::const_iterator it
= list
->begin();
119 it
!= list
->end(); ++it
) {
120 WriteValue(m
, *it
, recursion
+ 1);
127 // Helper for ReadValue that reads a DictionaryValue into a pre-allocated
129 bool ReadDictionaryValue(const Message
* m
, PickleIterator
* iter
,
130 base::DictionaryValue
* value
, int recursion
) {
132 if (!ReadParam(m
, iter
, &size
))
135 for (int i
= 0; i
< size
; ++i
) {
138 if (!ReadParam(m
, iter
, &key
) ||
139 !ReadValue(m
, iter
, &subval
, recursion
+ 1))
141 value
->SetWithoutPathExpansion(key
, subval
);
147 // Helper for ReadValue that reads a ReadListValue into a pre-allocated
149 bool ReadListValue(const Message
* m
, PickleIterator
* iter
,
150 base::ListValue
* value
, int recursion
) {
152 if (!ReadParam(m
, iter
, &size
))
155 for (int i
= 0; i
< size
; ++i
) {
157 if (!ReadValue(m
, iter
, &subval
, recursion
+ 1))
159 value
->Set(i
, subval
);
165 bool ReadValue(const Message
* m
, PickleIterator
* iter
, base::Value
** value
,
167 if (recursion
> kMaxRecursionDepth
) {
168 LOG(WARNING
) << "Max recursion depth hit in ReadValue.";
173 if (!ReadParam(m
, iter
, &type
))
177 case base::Value::TYPE_NULL
:
178 *value
= base::Value::CreateNullValue();
180 case base::Value::TYPE_BOOLEAN
: {
182 if (!ReadParam(m
, iter
, &val
))
184 *value
= new base::FundamentalValue(val
);
187 case base::Value::TYPE_INTEGER
: {
189 if (!ReadParam(m
, iter
, &val
))
191 *value
= new base::FundamentalValue(val
);
194 case base::Value::TYPE_DOUBLE
: {
196 if (!ReadParam(m
, iter
, &val
))
198 *value
= new base::FundamentalValue(val
);
201 case base::Value::TYPE_STRING
: {
203 if (!ReadParam(m
, iter
, &val
))
205 *value
= new base::StringValue(val
);
208 case base::Value::TYPE_BINARY
: {
211 if (!m
->ReadData(iter
, &data
, &length
))
213 *value
= base::BinaryValue::CreateWithCopiedBuffer(data
, length
);
216 case base::Value::TYPE_DICTIONARY
: {
217 scoped_ptr
<base::DictionaryValue
> val(new base::DictionaryValue());
218 if (!ReadDictionaryValue(m
, iter
, val
.get(), recursion
))
220 *value
= val
.release();
223 case base::Value::TYPE_LIST
: {
224 scoped_ptr
<base::ListValue
> val(new base::ListValue());
225 if (!ReadListValue(m
, iter
, val
.get(), recursion
))
227 *value
= val
.release();
239 // -----------------------------------------------------------------------------
249 LogData::~LogData() {
252 void ParamTraits
<bool>::Log(const param_type
& p
, std::string
* l
) {
253 l
->append(p
? "true" : "false");
256 void ParamTraits
<unsigned char>::Write(Message
* m
, const param_type
& p
) {
257 m
->WriteBytes(&p
, sizeof(param_type
));
260 bool ParamTraits
<unsigned char>::Read(const Message
* m
, PickleIterator
* iter
,
263 if (!m
->ReadBytes(iter
, &data
, sizeof(param_type
)))
265 memcpy(r
, data
, sizeof(param_type
));
269 void ParamTraits
<unsigned char>::Log(const param_type
& p
, std::string
* l
) {
270 l
->append(base::UintToString(p
));
273 void ParamTraits
<unsigned short>::Write(Message
* m
, const param_type
& p
) {
274 m
->WriteBytes(&p
, sizeof(param_type
));
277 bool ParamTraits
<unsigned short>::Read(const Message
* m
, PickleIterator
* iter
,
280 if (!m
->ReadBytes(iter
, &data
, sizeof(param_type
)))
282 memcpy(r
, data
, sizeof(param_type
));
286 void ParamTraits
<unsigned short>::Log(const param_type
& p
, std::string
* l
) {
287 l
->append(base::UintToString(p
));
290 void ParamTraits
<int>::Log(const param_type
& p
, std::string
* l
) {
291 l
->append(base::IntToString(p
));
294 void ParamTraits
<unsigned int>::Log(const param_type
& p
, std::string
* l
) {
295 l
->append(base::UintToString(p
));
298 void ParamTraits
<long>::Log(const param_type
& p
, std::string
* l
) {
299 l
->append(base::Int64ToString(static_cast<int64
>(p
)));
302 void ParamTraits
<unsigned long>::Log(const param_type
& p
, std::string
* l
) {
303 l
->append(base::Uint64ToString(static_cast<uint64
>(p
)));
306 void ParamTraits
<long long>::Log(const param_type
& p
, std::string
* l
) {
307 l
->append(base::Int64ToString(static_cast<int64
>(p
)));
310 void ParamTraits
<unsigned long long>::Log(const param_type
& p
, std::string
* l
) {
311 l
->append(base::Uint64ToString(p
));
314 void ParamTraits
<float>::Log(const param_type
& p
, std::string
* l
) {
315 l
->append(base::StringPrintf("%e", p
));
318 void ParamTraits
<double>::Write(Message
* m
, const param_type
& p
) {
319 m
->WriteBytes(reinterpret_cast<const char*>(&p
), sizeof(param_type
));
322 bool ParamTraits
<double>::Read(const Message
* m
, PickleIterator
* iter
,
325 if (!m
->ReadBytes(iter
, &data
, sizeof(*r
))) {
329 memcpy(r
, data
, sizeof(param_type
));
333 void ParamTraits
<double>::Log(const param_type
& p
, std::string
* l
) {
334 l
->append(base::StringPrintf("%e", p
));
338 void ParamTraits
<std::string
>::Log(const param_type
& p
, std::string
* l
) {
342 void ParamTraits
<std::wstring
>::Log(const param_type
& p
, std::string
* l
) {
343 l
->append(base::WideToUTF8(p
));
346 #if !defined(WCHAR_T_IS_UTF16)
347 void ParamTraits
<base::string16
>::Log(const param_type
& p
, std::string
* l
) {
348 l
->append(base::UTF16ToUTF8(p
));
352 void ParamTraits
<std::vector
<char> >::Write(Message
* m
, const param_type
& p
) {
354 m
->WriteData(NULL
, 0);
356 m
->WriteData(&p
.front(), static_cast<int>(p
.size()));
360 bool ParamTraits
<std::vector
<char> >::Read(const Message
* m
,
361 PickleIterator
* iter
,
365 if (!m
->ReadData(iter
, &data
, &data_size
) || data_size
< 0)
367 r
->resize(data_size
);
369 memcpy(&r
->front(), data
, data_size
);
373 void ParamTraits
<std::vector
<char> >::Log(const param_type
& p
, std::string
* l
) {
377 void ParamTraits
<std::vector
<unsigned char> >::Write(Message
* m
,
378 const param_type
& p
) {
380 m
->WriteData(NULL
, 0);
382 m
->WriteData(reinterpret_cast<const char*>(&p
.front()),
383 static_cast<int>(p
.size()));
387 bool ParamTraits
<std::vector
<unsigned char> >::Read(const Message
* m
,
388 PickleIterator
* iter
,
392 if (!m
->ReadData(iter
, &data
, &data_size
) || data_size
< 0)
394 r
->resize(data_size
);
396 memcpy(&r
->front(), data
, data_size
);
400 void ParamTraits
<std::vector
<unsigned char> >::Log(const param_type
& p
,
405 void ParamTraits
<std::vector
<bool> >::Write(Message
* m
, const param_type
& p
) {
406 WriteParam(m
, static_cast<int>(p
.size()));
407 // Cast to bool below is required because libc++'s
408 // vector<bool>::const_reference is different from bool, and we want to avoid
409 // writing an extra specialization of ParamTraits for it.
410 for (size_t i
= 0; i
< p
.size(); i
++)
411 WriteParam(m
, static_cast<bool>(p
[i
]));
414 bool ParamTraits
<std::vector
<bool> >::Read(const Message
* m
,
415 PickleIterator
* iter
,
418 // ReadLength() checks for < 0 itself.
419 if (!m
->ReadLength(iter
, &size
))
422 for (int i
= 0; i
< size
; i
++) {
424 if (!ReadParam(m
, iter
, &value
))
431 void ParamTraits
<std::vector
<bool> >::Log(const param_type
& p
, std::string
* l
) {
432 for (size_t i
= 0; i
< p
.size(); ++i
) {
435 LogParam(static_cast<bool>(p
[i
]), l
);
439 void ParamTraits
<base::DictionaryValue
>::Write(Message
* m
,
440 const param_type
& p
) {
441 WriteValue(m
, &p
, 0);
444 bool ParamTraits
<base::DictionaryValue
>::Read(
445 const Message
* m
, PickleIterator
* iter
, param_type
* r
) {
447 if (!ReadParam(m
, iter
, &type
) || type
!= base::Value::TYPE_DICTIONARY
)
450 return ReadDictionaryValue(m
, iter
, r
, 0);
453 void ParamTraits
<base::DictionaryValue
>::Log(const param_type
& p
,
456 base::JSONWriter::Write(&p
, &json
);
460 #if defined(OS_POSIX)
461 void ParamTraits
<base::FileDescriptor
>::Write(Message
* m
, const param_type
& p
) {
462 const bool valid
= p
.fd
>= 0;
463 WriteParam(m
, valid
);
466 if (!m
->WriteFileDescriptor(p
))
471 bool ParamTraits
<base::FileDescriptor
>::Read(const Message
* m
,
472 PickleIterator
* iter
,
475 if (!ReadParam(m
, iter
, &valid
))
480 r
->auto_close
= false;
484 return m
->ReadFileDescriptor(iter
, r
);
487 void ParamTraits
<base::FileDescriptor
>::Log(const param_type
& p
,
490 l
->append(base::StringPrintf("FD(%d auto-close)", p
.fd
));
492 l
->append(base::StringPrintf("FD(%d)", p
.fd
));
495 #endif // defined(OS_POSIX)
497 void ParamTraits
<base::FilePath
>::Write(Message
* m
, const param_type
& p
) {
501 bool ParamTraits
<base::FilePath
>::Read(const Message
* m
,
502 PickleIterator
* iter
,
504 return r
->ReadFromPickle(iter
);
507 void ParamTraits
<base::FilePath
>::Log(const param_type
& p
, std::string
* l
) {
508 ParamTraits
<base::FilePath::StringType
>::Log(p
.value(), l
);
511 void ParamTraits
<base::ListValue
>::Write(Message
* m
, const param_type
& p
) {
512 WriteValue(m
, &p
, 0);
515 bool ParamTraits
<base::ListValue
>::Read(
516 const Message
* m
, PickleIterator
* iter
, param_type
* r
) {
518 if (!ReadParam(m
, iter
, &type
) || type
!= base::Value::TYPE_LIST
)
521 return ReadListValue(m
, iter
, r
, 0);
524 void ParamTraits
<base::ListValue
>::Log(const param_type
& p
, std::string
* l
) {
526 base::JSONWriter::Write(&p
, &json
);
530 void ParamTraits
<base::NullableString16
>::Write(Message
* m
,
531 const param_type
& p
) {
532 WriteParam(m
, p
.string());
533 WriteParam(m
, p
.is_null());
536 bool ParamTraits
<base::NullableString16
>::Read(const Message
* m
,
537 PickleIterator
* iter
,
539 base::string16 string
;
540 if (!ReadParam(m
, iter
, &string
))
543 if (!ReadParam(m
, iter
, &is_null
))
545 *r
= base::NullableString16(string
, is_null
);
549 void ParamTraits
<base::NullableString16
>::Log(const param_type
& p
,
552 LogParam(p
.string(), l
);
554 LogParam(p
.is_null(), l
);
558 void ParamTraits
<base::PlatformFileInfo
>::Write(Message
* m
,
559 const param_type
& p
) {
560 WriteParam(m
, p
.size
);
561 WriteParam(m
, p
.is_directory
);
562 WriteParam(m
, p
.last_modified
.ToDoubleT());
563 WriteParam(m
, p
.last_accessed
.ToDoubleT());
564 WriteParam(m
, p
.creation_time
.ToDoubleT());
567 bool ParamTraits
<base::PlatformFileInfo
>::Read(const Message
* m
,
568 PickleIterator
* iter
,
570 double last_modified
;
571 double last_accessed
;
572 double creation_time
;
574 ReadParam(m
, iter
, &p
->size
) &&
575 ReadParam(m
, iter
, &p
->is_directory
) &&
576 ReadParam(m
, iter
, &last_modified
) &&
577 ReadParam(m
, iter
, &last_accessed
) &&
578 ReadParam(m
, iter
, &creation_time
);
580 p
->last_modified
= base::Time::FromDoubleT(last_modified
);
581 p
->last_accessed
= base::Time::FromDoubleT(last_accessed
);
582 p
->creation_time
= base::Time::FromDoubleT(creation_time
);
587 void ParamTraits
<base::PlatformFileInfo
>::Log(const param_type
& p
,
592 LogParam(p
.is_directory
, l
);
594 LogParam(p
.last_modified
.ToDoubleT(), l
);
596 LogParam(p
.last_accessed
.ToDoubleT(), l
);
598 LogParam(p
.creation_time
.ToDoubleT(), l
);
602 void ParamTraits
<base::Time
>::Write(Message
* m
, const param_type
& p
) {
603 ParamTraits
<int64
>::Write(m
, p
.ToInternalValue());
606 bool ParamTraits
<base::Time
>::Read(const Message
* m
, PickleIterator
* iter
,
609 if (!ParamTraits
<int64
>::Read(m
, iter
, &value
))
611 *r
= base::Time::FromInternalValue(value
);
615 void ParamTraits
<base::Time
>::Log(const param_type
& p
, std::string
* l
) {
616 ParamTraits
<int64
>::Log(p
.ToInternalValue(), l
);
619 void ParamTraits
<base::TimeDelta
>::Write(Message
* m
, const param_type
& p
) {
620 ParamTraits
<int64
>::Write(m
, p
.ToInternalValue());
623 bool ParamTraits
<base::TimeDelta
>::Read(const Message
* m
,
624 PickleIterator
* iter
,
627 bool ret
= ParamTraits
<int64
>::Read(m
, iter
, &value
);
629 *r
= base::TimeDelta::FromInternalValue(value
);
634 void ParamTraits
<base::TimeDelta
>::Log(const param_type
& p
, std::string
* l
) {
635 ParamTraits
<int64
>::Log(p
.ToInternalValue(), l
);
638 void ParamTraits
<base::TimeTicks
>::Write(Message
* m
, const param_type
& p
) {
639 ParamTraits
<int64
>::Write(m
, p
.ToInternalValue());
642 bool ParamTraits
<base::TimeTicks
>::Read(const Message
* m
,
643 PickleIterator
* iter
,
646 bool ret
= ParamTraits
<int64
>::Read(m
, iter
, &value
);
648 *r
= base::TimeTicks::FromInternalValue(value
);
653 void ParamTraits
<base::TimeTicks
>::Log(const param_type
& p
, std::string
* l
) {
654 ParamTraits
<int64
>::Log(p
.ToInternalValue(), l
);
657 void ParamTraits
<IPC::ChannelHandle
>::Write(Message
* m
, const param_type
& p
) {
659 // On Windows marshalling pipe handle is not supported.
660 DCHECK(p
.pipe
.handle
== NULL
);
661 #endif // defined (OS_WIN)
662 WriteParam(m
, p
.name
);
663 #if defined(OS_POSIX)
664 WriteParam(m
, p
.socket
);
668 bool ParamTraits
<IPC::ChannelHandle
>::Read(const Message
* m
,
669 PickleIterator
* iter
,
671 return ReadParam(m
, iter
, &r
->name
)
672 #if defined(OS_POSIX)
673 && ReadParam(m
, iter
, &r
->socket
)
678 void ParamTraits
<IPC::ChannelHandle
>::Log(const param_type
& p
,
680 l
->append(base::StringPrintf("ChannelHandle(%s", p
.name
.c_str()));
681 #if defined(OS_POSIX)
683 ParamTraits
<base::FileDescriptor
>::Log(p
.socket
, l
);
688 void ParamTraits
<LogData
>::Write(Message
* m
, const param_type
& p
) {
689 WriteParam(m
, p
.channel
);
690 WriteParam(m
, p
.routing_id
);
691 WriteParam(m
, p
.type
);
692 WriteParam(m
, p
.flags
);
693 WriteParam(m
, p
.sent
);
694 WriteParam(m
, p
.receive
);
695 WriteParam(m
, p
.dispatch
);
696 WriteParam(m
, p
.message_name
);
697 WriteParam(m
, p
.params
);
700 bool ParamTraits
<LogData
>::Read(const Message
* m
,
701 PickleIterator
* iter
,
704 ReadParam(m
, iter
, &r
->channel
) &&
705 ReadParam(m
, iter
, &r
->routing_id
) &&
706 ReadParam(m
, iter
, &r
->type
) &&
707 ReadParam(m
, iter
, &r
->flags
) &&
708 ReadParam(m
, iter
, &r
->sent
) &&
709 ReadParam(m
, iter
, &r
->receive
) &&
710 ReadParam(m
, iter
, &r
->dispatch
) &&
711 ReadParam(m
, iter
, &r
->message_name
) &&
712 ReadParam(m
, iter
, &r
->params
);
715 void ParamTraits
<LogData
>::Log(const param_type
& p
, std::string
* l
) {
716 // Doesn't make sense to implement this!
719 void ParamTraits
<Message
>::Write(Message
* m
, const Message
& p
) {
720 #if defined(OS_POSIX)
721 // We don't serialize the file descriptors in the nested message, so there
722 // better not be any.
723 DCHECK(!p
.HasFileDescriptors());
726 // Don't just write out the message. This is used to send messages between
727 // NaCl (Posix environment) and the browser (could be on Windows). The message
728 // header formats differ between these systems (so does handle sharing, but
729 // we already asserted we don't have any handles). So just write out the
730 // parts of the header we use.
732 // Be careful also to use only explicitly-sized types. The NaCl environment
733 // could be 64-bit and the host browser could be 32-bits. The nested message
734 // may or may not be safe to send between 32-bit and 64-bit systems, but we
735 // leave that up to the code sending the message to ensure.
736 m
->WriteUInt32(static_cast<uint32
>(p
.routing_id()));
737 m
->WriteUInt32(p
.type());
738 m
->WriteUInt32(p
.flags());
739 m
->WriteData(p
.payload(), static_cast<uint32
>(p
.payload_size()));
742 bool ParamTraits
<Message
>::Read(const Message
* m
, PickleIterator
* iter
,
744 uint32 routing_id
, type
, flags
;
745 if (!m
->ReadUInt32(iter
, &routing_id
) ||
746 !m
->ReadUInt32(iter
, &type
) ||
747 !m
->ReadUInt32(iter
, &flags
))
752 if (!m
->ReadData(iter
, &payload
, &payload_size
))
755 r
->SetHeaderValues(static_cast<int32
>(routing_id
), type
, flags
);
756 return r
->WriteBytes(payload
, payload_size
);
759 void ParamTraits
<Message
>::Log(const Message
& p
, std::string
* l
) {
760 l
->append("<IPC::Message>");
764 // Note that HWNDs/HANDLE/HCURSOR/HACCEL etc are always 32 bits, even on 64
765 // bit systems. That's why we use the Windows macros to convert to 32 bits.
766 void ParamTraits
<HANDLE
>::Write(Message
* m
, const param_type
& p
) {
767 m
->WriteInt(HandleToLong(p
));
770 bool ParamTraits
<HANDLE
>::Read(const Message
* m
, PickleIterator
* iter
,
773 if (!m
->ReadInt(iter
, &temp
))
775 *r
= LongToHandle(temp
);
779 void ParamTraits
<HANDLE
>::Log(const param_type
& p
, std::string
* l
) {
780 l
->append(base::StringPrintf("0x%X", p
));
783 void ParamTraits
<LOGFONT
>::Write(Message
* m
, const param_type
& p
) {
784 m
->WriteData(reinterpret_cast<const char*>(&p
), sizeof(LOGFONT
));
787 bool ParamTraits
<LOGFONT
>::Read(const Message
* m
, PickleIterator
* iter
,
791 if (m
->ReadData(iter
, &data
, &data_size
) && data_size
== sizeof(LOGFONT
)) {
792 const LOGFONT
*font
= reinterpret_cast<LOGFONT
*>(const_cast<char*>(data
));
793 if (_tcsnlen(font
->lfFaceName
, LF_FACESIZE
) < LF_FACESIZE
) {
794 memcpy(r
, data
, sizeof(LOGFONT
));
803 void ParamTraits
<LOGFONT
>::Log(const param_type
& p
, std::string
* l
) {
804 l
->append(base::StringPrintf("<LOGFONT>"));
807 void ParamTraits
<MSG
>::Write(Message
* m
, const param_type
& p
) {
808 m
->WriteData(reinterpret_cast<const char*>(&p
), sizeof(MSG
));
811 bool ParamTraits
<MSG
>::Read(const Message
* m
, PickleIterator
* iter
,
815 bool result
= m
->ReadData(iter
, &data
, &data_size
);
816 if (result
&& data_size
== sizeof(MSG
)) {
817 memcpy(r
, data
, sizeof(MSG
));
826 void ParamTraits
<MSG
>::Log(const param_type
& p
, std::string
* l
) {