jochen@chromium.org | 30c8e91 | 2012-01-29 19:57:33 +0900 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef IPC_IPC_MESSAGE_UTILS_H_ |
| 6 | #define IPC_IPC_MESSAGE_UTILS_H_ |
| 7 | |
avi | 2f68ea0 | 2015-12-27 02:30:50 +0900 | [diff] [blame] | 8 | #include <limits.h> |
avi | 42ebda4 | 2015-12-22 11:39:04 +0900 | [diff] [blame] | 9 | #include <stddef.h> |
tfarina | 1cbfa08 | 2015-09-05 03:47:57 +0900 | [diff] [blame] | 10 | #include <stdint.h> |
| 11 | |
jhawkins@chromium.org | 63c75eb | 2010-03-09 09:38:41 +0900 | [diff] [blame] | 12 | #include <algorithm> |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 13 | #include <map> |
danakj | c3fb6c5 | 2016-04-23 13:21:09 +0900 | [diff] [blame] | 14 | #include <memory> |
mirandac@chromium.org | ee262ad | 2010-05-14 04:10:34 +0900 | [diff] [blame] | 15 | #include <set> |
tfarina@chromium.org | 439aef6 | 2011-03-21 10:07:01 +0900 | [diff] [blame] | 16 | #include <string> |
tzik | a088e35 | 2016-03-08 14:47:44 +0900 | [diff] [blame] | 17 | #include <tuple> |
Stuart Langley | 80d7b64 | 2017-11-02 12:54:44 +0900 | [diff] [blame] | 18 | #include <unordered_map> |
tfarina@chromium.org | 439aef6 | 2011-03-21 10:07:01 +0900 | [diff] [blame] | 19 | #include <vector> |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 20 | |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 21 | #include "base/component_export.h" |
brettw | d3d9de0 | 2017-04-20 15:10:20 +0900 | [diff] [blame] | 22 | #include "base/containers/flat_map.h" |
jdduke@chromium.org | 556db8b | 2014-03-19 05:48:35 +0900 | [diff] [blame] | 23 | #include "base/containers/small_map.h" |
miletus | d41fe22 | 2015-07-24 04:42:36 +0900 | [diff] [blame] | 24 | #include "base/containers/stack_container.h" |
rvargas@chromium.org | 9e469f6 | 2014-01-28 06:36:00 +0900 | [diff] [blame] | 25 | #include "base/files/file.h" |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 26 | #include "base/format_macros.h" |
Klaus Weidner | 22df765 | 2017-11-03 15:24:57 +0900 | [diff] [blame] | 27 | #include "base/memory/shared_memory_handle.h" |
brettw | d3d9de0 | 2017-04-20 15:10:20 +0900 | [diff] [blame] | 28 | #include "base/numerics/safe_conversions.h" |
bmcquade | 1175837 | 2016-07-01 22:13:50 +0900 | [diff] [blame] | 29 | #include "base/optional.h" |
avi@chromium.org | e7eaf39 | 2013-06-11 15:32:18 +0900 | [diff] [blame] | 30 | #include "base/strings/string16.h" |
| 31 | #include "base/strings/string_util.h" |
| 32 | #include "base/strings/stringprintf.h" |
avi | 42ebda4 | 2015-12-22 11:39:04 +0900 | [diff] [blame] | 33 | #include "build/build_config.h" |
tsepez@chromium.org | 4afe8f7 | 2012-10-24 08:03:35 +0900 | [diff] [blame] | 34 | #include "ipc/ipc_message_start.h" |
erg@google.com | b16c8a6 | 2010-08-25 05:29:02 +0900 | [diff] [blame] | 35 | #include "ipc/ipc_param_traits.h" |
erg@google.com | bfae859 | 2010-08-17 09:24:54 +0900 | [diff] [blame] | 36 | #include "ipc/ipc_sync_message.h" |
erg@google.com | cab37e7 | 2010-08-14 05:43:58 +0900 | [diff] [blame] | 37 | |
erg@google.com | e6ffcb5 | 2010-08-18 03:38:24 +0900 | [diff] [blame] | 38 | namespace base { |
dmazzoni@chromium.org | 13e5365 | 2011-07-13 04:15:03 +0900 | [diff] [blame] | 39 | class DictionaryValue; |
brettw@chromium.org | a708694 | 2013-02-02 14:12:33 +0900 | [diff] [blame] | 40 | class FilePath; |
dmazzoni@chromium.org | 13e5365 | 2011-07-13 04:15:03 +0900 | [diff] [blame] | 41 | class ListValue; |
avi@chromium.org | d817965 | 2013-06-13 22:47:46 +0900 | [diff] [blame] | 42 | class NullableString16; |
erg@google.com | e6ffcb5 | 2010-08-18 03:38:24 +0900 | [diff] [blame] | 43 | class Time; |
apatrick@chromium.org | 519c1c6 | 2010-10-22 07:04:52 +0900 | [diff] [blame] | 44 | class TimeDelta; |
isherman@chromium.org | 9952aaf | 2011-09-03 05:42:04 +0900 | [diff] [blame] | 45 | class TimeTicks; |
tguilbert | 76e690d | 2016-09-20 06:11:25 +0900 | [diff] [blame] | 46 | class UnguessableToken; |
erg@google.com | e6ffcb5 | 2010-08-18 03:38:24 +0900 | [diff] [blame] | 47 | struct FileDescriptor; |
| 48 | } |
| 49 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 50 | namespace IPC { |
| 51 | |
erg@google.com | e6ffcb5 | 2010-08-18 03:38:24 +0900 | [diff] [blame] | 52 | struct ChannelHandle; |
| 53 | |
erikchen | 9a454c1 | 2017-04-29 11:24:36 +0900 | [diff] [blame] | 54 | #if defined(OS_WIN) |
| 55 | class PlatformFileForTransit; |
| 56 | #endif |
| 57 | |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 58 | // ----------------------------------------------------------------------------- |
| 59 | // How we send IPC message logs across channels. |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 60 | struct COMPONENT_EXPORT(IPC) LogData { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 61 | LogData(); |
vmpstr | d661bf7 | 2016-03-25 05:22:54 +0900 | [diff] [blame] | 62 | LogData(const LogData& other); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 63 | ~LogData(); |
| 64 | |
| 65 | std::string channel; |
tfarina | 1cbfa08 | 2015-09-05 03:47:57 +0900 | [diff] [blame] | 66 | int32_t routing_id; |
| 67 | uint32_t type; // "User-defined" message type, from ipc_message.h. |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 68 | std::string flags; |
tfarina | 1cbfa08 | 2015-09-05 03:47:57 +0900 | [diff] [blame] | 69 | int64_t sent; // Time that the message was sent (i.e. at Send()). |
| 70 | int64_t receive; // Time before it was dispatched (i.e. before calling |
| 71 | // OnMessageReceived). |
| 72 | int64_t dispatch; // Time after it was dispatched (i.e. after calling |
| 73 | // OnMessageReceived). |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 74 | std::string message_name; |
| 75 | std::string params; |
| 76 | }; |
| 77 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 78 | //----------------------------------------------------------------------------- |
viettrungluu@chromium.org | c3ad051 | 2012-12-18 05:23:47 +0900 | [diff] [blame] | 79 | |
tsepez@chromium.org | 1ac4613 | 2011-02-12 03:46:19 +0900 | [diff] [blame] | 80 | // A dummy struct to place first just to allow leading commas for all |
| 81 | // members in the macro-generated constructor initializer lists. |
| 82 | struct NoParams { |
| 83 | }; |
| 84 | |
dskiba | a789c21 | 2016-04-07 00:51:06 +0900 | [diff] [blame] | 85 | // Specializations are checked by 'IPC checker' part of find-bad-constructs |
| 86 | // Clang plugin (see WriteParam() below for the details). |
| 87 | template <typename... Ts> |
| 88 | struct CheckedTuple { |
| 89 | typedef std::tuple<Ts...> Tuple; |
| 90 | }; |
| 91 | |
dskiba | a789c21 | 2016-04-07 00:51:06 +0900 | [diff] [blame] | 92 | // This function is checked by 'IPC checker' part of find-bad-constructs |
| 93 | // Clang plugin to make it's not called on the following types: |
| 94 | // 1. long / unsigned long (but not typedefs to) |
| 95 | // 2. intmax_t, uintmax_t, intptr_t, uintptr_t, wint_t, |
| 96 | // size_t, rsize_t, ssize_t, ptrdiff_t, dev_t, off_t, clock_t, |
| 97 | // time_t, suseconds_t (including typedefs to) |
| 98 | // 3. Any template referencing types above (e.g. std::vector<size_t>) |
rockot | 15c8ac4 | 2016-02-05 11:12:32 +0900 | [diff] [blame] | 99 | template <class P> |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 100 | static inline void WriteParam(base::Pickle* m, const P& p) { |
aa@chromium.org | 1605b6d | 2009-08-14 14:43:53 +0900 | [diff] [blame] | 101 | typedef typename SimilarTypeTraits<P>::Type Type; |
thakis@chromium.org | b13bd1d | 2010-06-17 03:39:53 +0900 | [diff] [blame] | 102 | ParamTraits<Type>::Write(m, static_cast<const Type& >(p)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 103 | } |
| 104 | |
| 105 | template <class P> |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 106 | static inline bool WARN_UNUSED_RESULT ReadParam(const base::Pickle* m, |
| 107 | base::PickleIterator* iter, |
| 108 | P* p) { |
aa@chromium.org | 1605b6d | 2009-08-14 14:43:53 +0900 | [diff] [blame] | 109 | typedef typename SimilarTypeTraits<P>::Type Type; |
| 110 | return ParamTraits<Type>::Read(m, iter, reinterpret_cast<Type* >(p)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | template <class P> |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 114 | static inline void LogParam(const P& p, std::string* l) { |
aa@chromium.org | 1605b6d | 2009-08-14 14:43:53 +0900 | [diff] [blame] | 115 | typedef typename SimilarTypeTraits<P>::Type Type; |
thakis@chromium.org | b13bd1d | 2010-06-17 03:39:53 +0900 | [diff] [blame] | 116 | ParamTraits<Type>::Log(static_cast<const Type& >(p), l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 117 | } |
| 118 | |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 119 | // Primitive ParamTraits ------------------------------------------------------- |
| 120 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 121 | template <> |
| 122 | struct ParamTraits<bool> { |
| 123 | typedef bool param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 124 | static void Write(base::Pickle* m, const param_type& p) { m->WriteBool(p); } |
| 125 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 126 | base::PickleIterator* iter, |
brettw | a487947 | 2015-06-02 16:02:47 +0900 | [diff] [blame] | 127 | param_type* r) { |
avi | c9f0ad0 | 2014-12-29 08:31:48 +0900 | [diff] [blame] | 128 | return iter->ReadBool(r); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 129 | } |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 130 | COMPONENT_EXPORT(IPC) static void Log(const param_type& p, std::string* l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 131 | }; |
| 132 | |
| 133 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 134 | struct COMPONENT_EXPORT(IPC) ParamTraits<signed char> { |
ortuno | 6e3f7b3 | 2015-10-30 09:46:20 +0900 | [diff] [blame] | 135 | typedef signed char param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 136 | static void Write(base::Pickle* m, const param_type& p); |
| 137 | static bool Read(const base::Pickle* m, |
| 138 | base::PickleIterator* iter, |
| 139 | param_type* r); |
ortuno | 6e3f7b3 | 2015-10-30 09:46:20 +0900 | [diff] [blame] | 140 | static void Log(const param_type& p, std::string* l); |
| 141 | }; |
| 142 | |
| 143 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 144 | struct COMPONENT_EXPORT(IPC) ParamTraits<unsigned char> { |
jschuh@chromium.org | ccd324a | 2013-07-13 13:42:10 +0900 | [diff] [blame] | 145 | typedef unsigned char param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 146 | static void Write(base::Pickle* m, const param_type& p); |
| 147 | static bool Read(const base::Pickle* m, |
| 148 | base::PickleIterator* iter, |
| 149 | param_type* r); |
tsepez@chromium.org | 09eb95f | 2013-07-13 08:12:28 +0900 | [diff] [blame] | 150 | static void Log(const param_type& p, std::string* l); |
| 151 | }; |
| 152 | |
| 153 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 154 | struct COMPONENT_EXPORT(IPC) ParamTraits<unsigned short> { |
tsepez@chromium.org | 09eb95f | 2013-07-13 08:12:28 +0900 | [diff] [blame] | 155 | typedef unsigned short param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 156 | static void Write(base::Pickle* m, const param_type& p); |
| 157 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 158 | base::PickleIterator* iter, |
| 159 | param_type* r); |
tsepez@chromium.org | 09eb95f | 2013-07-13 08:12:28 +0900 | [diff] [blame] | 160 | static void Log(const param_type& p, std::string* l); |
| 161 | }; |
| 162 | |
| 163 | template <> |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 164 | struct ParamTraits<int> { |
| 165 | typedef int param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 166 | static void Write(base::Pickle* m, const param_type& p) { m->WriteInt(p); } |
| 167 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 168 | base::PickleIterator* iter, |
brettw | a487947 | 2015-06-02 16:02:47 +0900 | [diff] [blame] | 169 | param_type* r) { |
avi | c9f0ad0 | 2014-12-29 08:31:48 +0900 | [diff] [blame] | 170 | return iter->ReadInt(r); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 171 | } |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 172 | COMPONENT_EXPORT(IPC) static void Log(const param_type& p, std::string* l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 173 | }; |
| 174 | |
| 175 | template <> |
deanm@chromium.org | 1543aa7 | 2009-07-29 04:35:08 +0900 | [diff] [blame] | 176 | struct ParamTraits<unsigned int> { |
| 177 | typedef unsigned int param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 178 | static void Write(base::Pickle* m, const param_type& p) { m->WriteInt(p); } |
| 179 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 180 | base::PickleIterator* iter, |
brettw | a487947 | 2015-06-02 16:02:47 +0900 | [diff] [blame] | 181 | param_type* r) { |
avi | c9f0ad0 | 2014-12-29 08:31:48 +0900 | [diff] [blame] | 182 | return iter->ReadInt(reinterpret_cast<int*>(r)); |
deanm@chromium.org | 1543aa7 | 2009-07-29 04:35:08 +0900 | [diff] [blame] | 183 | } |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 184 | COMPONENT_EXPORT(IPC) static void Log(const param_type& p, std::string* l); |
deanm@chromium.org | 1543aa7 | 2009-07-29 04:35:08 +0900 | [diff] [blame] | 185 | }; |
| 186 | |
jam | 923e546 | 2016-02-11 05:13:39 +0900 | [diff] [blame] | 187 | // long isn't safe to send over IPC because it's 4 bytes on 32 bit builds but |
| 188 | // 8 bytes on 64 bit builds. So if a 32 bit and 64 bit process have a channel |
| 189 | // that would cause problem. |
| 190 | // We need to keep this on for a few configs: |
| 191 | // 1) Windows because DWORD is typedef'd to it, which is fine because we have |
| 192 | // very few IPCs that cross this boundary. |
| 193 | // 2) We also need to keep it for Linux for two reasons: int64_t is typedef'd |
| 194 | // to long, and gfx::PluginWindow is long and is used in one GPU IPC. |
Scott Graham | 3bf3a7e | 2017-06-20 08:09:33 +0900 | [diff] [blame] | 195 | // 3) Android 64 bit and Fuchsia also have int64_t typedef'd to long. |
jam | 923e546 | 2016-02-11 05:13:39 +0900 | [diff] [blame] | 196 | // Since we want to support Android 32<>64 bit IPC, as long as we don't have |
| 197 | // these traits for 32 bit ARM then that'll catch any errors. |
Scott Graham | 3bf3a7e | 2017-06-20 08:09:33 +0900 | [diff] [blame] | 198 | #if defined(OS_WIN) || defined(OS_LINUX) || defined(OS_FUCHSIA) || \ |
jam | 739d8d1 | 2016-02-11 09:50:28 +0900 | [diff] [blame] | 199 | (defined(OS_ANDROID) && defined(ARCH_CPU_64_BITS)) |
deanm@chromium.org | 1543aa7 | 2009-07-29 04:35:08 +0900 | [diff] [blame] | 200 | template <> |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 201 | struct ParamTraits<long> { |
| 202 | typedef long param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 203 | static void Write(base::Pickle* m, const param_type& p) { |
jam | 923e546 | 2016-02-11 05:13:39 +0900 | [diff] [blame] | 204 | m->WriteLong(p); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 205 | } |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 206 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 207 | base::PickleIterator* iter, |
brettw | a487947 | 2015-06-02 16:02:47 +0900 | [diff] [blame] | 208 | param_type* r) { |
avi | c9f0ad0 | 2014-12-29 08:31:48 +0900 | [diff] [blame] | 209 | return iter->ReadLong(r); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 210 | } |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 211 | COMPONENT_EXPORT(IPC) static void Log(const param_type& p, std::string* l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 212 | }; |
| 213 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 214 | template <> |
| 215 | struct ParamTraits<unsigned long> { |
| 216 | typedef unsigned long param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 217 | static void Write(base::Pickle* m, const param_type& p) { |
jam | 923e546 | 2016-02-11 05:13:39 +0900 | [diff] [blame] | 218 | m->WriteLong(p); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 219 | } |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 220 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 221 | base::PickleIterator* iter, |
brettw | a487947 | 2015-06-02 16:02:47 +0900 | [diff] [blame] | 222 | param_type* r) { |
avi | c9f0ad0 | 2014-12-29 08:31:48 +0900 | [diff] [blame] | 223 | return iter->ReadLong(reinterpret_cast<long*>(r)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 224 | } |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 225 | COMPONENT_EXPORT(IPC) static void Log(const param_type& p, std::string* l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 226 | }; |
jam | 923e546 | 2016-02-11 05:13:39 +0900 | [diff] [blame] | 227 | #endif |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 228 | |
| 229 | template <> |
deanm@chromium.org | 1543aa7 | 2009-07-29 04:35:08 +0900 | [diff] [blame] | 230 | struct ParamTraits<long long> { |
| 231 | typedef long long param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 232 | static void Write(base::Pickle* m, const param_type& p) { |
tfarina | 1cbfa08 | 2015-09-05 03:47:57 +0900 | [diff] [blame] | 233 | m->WriteInt64(static_cast<int64_t>(p)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 234 | } |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 235 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 236 | base::PickleIterator* iter, |
jbates@chromium.org | 0fc8736 | 2012-03-08 05:42:56 +0900 | [diff] [blame] | 237 | param_type* r) { |
tfarina | 1cbfa08 | 2015-09-05 03:47:57 +0900 | [diff] [blame] | 238 | return iter->ReadInt64(reinterpret_cast<int64_t*>(r)); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 239 | } |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 240 | COMPONENT_EXPORT(IPC) static void Log(const param_type& p, std::string* l); |
deanm@chromium.org | 1543aa7 | 2009-07-29 04:35:08 +0900 | [diff] [blame] | 241 | }; |
| 242 | |
| 243 | template <> |
| 244 | struct ParamTraits<unsigned long long> { |
| 245 | typedef unsigned long long param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 246 | static void Write(base::Pickle* m, const param_type& p) { m->WriteInt64(p); } |
| 247 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 248 | base::PickleIterator* iter, |
jbates@chromium.org | 0fc8736 | 2012-03-08 05:42:56 +0900 | [diff] [blame] | 249 | param_type* r) { |
tfarina | 1cbfa08 | 2015-09-05 03:47:57 +0900 | [diff] [blame] | 250 | return iter->ReadInt64(reinterpret_cast<int64_t*>(r)); |
deanm@chromium.org | 1543aa7 | 2009-07-29 04:35:08 +0900 | [diff] [blame] | 251 | } |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 252 | COMPONENT_EXPORT(IPC) static void Log(const param_type& p, std::string* l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 253 | }; |
| 254 | |
jeremy@chromium.org | 4be619f | 2010-06-17 12:29:26 +0900 | [diff] [blame] | 255 | // Note that the IPC layer doesn't sanitize NaNs and +/- INF values. Clients |
| 256 | // should be sure to check the sanity of these values after receiving them over |
| 257 | // IPC. |
| 258 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 259 | struct COMPONENT_EXPORT(IPC) ParamTraits<float> { |
jeremy@chromium.org | 4be619f | 2010-06-17 12:29:26 +0900 | [diff] [blame] | 260 | typedef float param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 261 | static void Write(base::Pickle* m, const param_type& p) { m->WriteFloat(p); } |
| 262 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 263 | base::PickleIterator* iter, |
brettw | a487947 | 2015-06-02 16:02:47 +0900 | [diff] [blame] | 264 | param_type* r) { |
avi | c9f0ad0 | 2014-12-29 08:31:48 +0900 | [diff] [blame] | 265 | return iter->ReadFloat(r); |
piman@chromium.org | dd413b4 | 2013-10-31 18:27:31 +0900 | [diff] [blame] | 266 | } |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 267 | static void Log(const param_type& p, std::string* l); |
jeremy@chromium.org | 4be619f | 2010-06-17 12:29:26 +0900 | [diff] [blame] | 268 | }; |
| 269 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 270 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 271 | struct COMPONENT_EXPORT(IPC) ParamTraits<double> { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 272 | typedef double param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 273 | static void Write(base::Pickle* m, const param_type& p); |
| 274 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 275 | base::PickleIterator* iter, |
| 276 | param_type* r); |
tsepez@chromium.org | 3081fac | 2012-05-31 06:15:57 +0900 | [diff] [blame] | 277 | static void Log(const param_type& p, std::string* l); |
| 278 | }; |
| 279 | |
ericrk | 43a3bd5 | 2017-02-11 02:49:35 +0900 | [diff] [blame] | 280 | template <class P, size_t Size> |
| 281 | struct ParamTraits<P[Size]> { |
| 282 | using param_type = P[Size]; |
ericrk | 43a3bd5 | 2017-02-11 02:49:35 +0900 | [diff] [blame] | 283 | static void Write(base::Pickle* m, const param_type& p) { |
| 284 | for (const P& element : p) |
| 285 | WriteParam(m, element); |
| 286 | } |
| 287 | static bool Read(const base::Pickle* m, |
| 288 | base::PickleIterator* iter, |
| 289 | param_type* r) { |
| 290 | for (P& element : *r) { |
| 291 | if (!ReadParam(m, iter, &element)) |
| 292 | return false; |
| 293 | } |
| 294 | return true; |
| 295 | } |
| 296 | static void Log(const param_type& p, std::string* l) { |
| 297 | l->append("["); |
| 298 | for (const P& element : p) { |
| 299 | if (&element != &p[0]) |
| 300 | l->append(" "); |
| 301 | LogParam(element, l); |
| 302 | } |
| 303 | l->append("]"); |
| 304 | } |
| 305 | }; |
| 306 | |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 307 | // STL ParamTraits ------------------------------------------------------------- |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 308 | |
| 309 | template <> |
| 310 | struct ParamTraits<std::string> { |
| 311 | typedef std::string param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 312 | static void Write(base::Pickle* m, const param_type& p) { m->WriteString(p); } |
| 313 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 314 | base::PickleIterator* iter, |
jbates@chromium.org | 0fc8736 | 2012-03-08 05:42:56 +0900 | [diff] [blame] | 315 | param_type* r) { |
avi | c9f0ad0 | 2014-12-29 08:31:48 +0900 | [diff] [blame] | 316 | return iter->ReadString(r); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 317 | } |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 318 | COMPONENT_EXPORT(IPC) static void Log(const param_type& p, std::string* l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 319 | }; |
| 320 | |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 321 | template <> |
brettw@chromium.org | 5b04085 | 2013-12-03 09:39:26 +0900 | [diff] [blame] | 322 | struct ParamTraits<base::string16> { |
| 323 | typedef base::string16 param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 324 | static void Write(base::Pickle* m, const param_type& p) { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 325 | m->WriteString16(p); |
| 326 | } |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 327 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 328 | base::PickleIterator* iter, |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 329 | param_type* r) { |
avi | c9f0ad0 | 2014-12-29 08:31:48 +0900 | [diff] [blame] | 330 | return iter->ReadString16(r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 331 | } |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 332 | COMPONENT_EXPORT(IPC) static void Log(const param_type& p, std::string* l); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 333 | }; |
evan@chromium.org | a659036 | 2009-07-28 06:09:07 +0900 | [diff] [blame] | 334 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 335 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 336 | struct COMPONENT_EXPORT(IPC) ParamTraits<std::vector<char>> { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 337 | typedef std::vector<char> param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 338 | static void Write(base::Pickle* m, const param_type& p); |
| 339 | static bool Read(const base::Pickle*, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 340 | base::PickleIterator* iter, |
| 341 | param_type* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 342 | static void Log(const param_type& p, std::string* l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 343 | }; |
| 344 | |
bauerb@chromium.org | 17246c7 | 2011-10-06 03:55:42 +0900 | [diff] [blame] | 345 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 346 | struct COMPONENT_EXPORT(IPC) ParamTraits<std::vector<unsigned char>> { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 347 | typedef std::vector<unsigned char> param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 348 | static void Write(base::Pickle* m, const param_type& p); |
| 349 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 350 | base::PickleIterator* iter, |
| 351 | param_type* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 352 | static void Log(const param_type& p, std::string* l); |
| 353 | }; |
| 354 | |
| 355 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 356 | struct COMPONENT_EXPORT(IPC) ParamTraits<std::vector<bool>> { |
bauerb@chromium.org | 17246c7 | 2011-10-06 03:55:42 +0900 | [diff] [blame] | 357 | typedef std::vector<bool> param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 358 | static void Write(base::Pickle* m, const param_type& p); |
| 359 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 360 | base::PickleIterator* iter, |
| 361 | param_type* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 362 | static void Log(const param_type& p, std::string* l); |
bauerb@chromium.org | 17246c7 | 2011-10-06 03:55:42 +0900 | [diff] [blame] | 363 | }; |
| 364 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 365 | template <class P> |
bmcquade | 1175837 | 2016-07-01 22:13:50 +0900 | [diff] [blame] | 366 | struct ParamTraits<std::vector<P>> { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 367 | typedef std::vector<P> param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 368 | static void Write(base::Pickle* m, const param_type& p) { |
Chris Palmer | 751d004 | 2017-09-26 07:53:22 +0900 | [diff] [blame] | 369 | WriteParam(m, base::checked_cast<int>(p.size())); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 370 | for (size_t i = 0; i < p.size(); i++) |
| 371 | WriteParam(m, p[i]); |
| 372 | } |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 373 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 374 | base::PickleIterator* iter, |
jbates@chromium.org | 0fc8736 | 2012-03-08 05:42:56 +0900 | [diff] [blame] | 375 | param_type* r) { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 376 | int size; |
cevans@chromium.org | 7600d94 | 2009-12-31 14:17:23 +0900 | [diff] [blame] | 377 | // ReadLength() checks for < 0 itself. |
avi | c9f0ad0 | 2014-12-29 08:31:48 +0900 | [diff] [blame] | 378 | if (!iter->ReadLength(&size)) |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 379 | return false; |
| 380 | // Resizing beforehand is not safe, see BUG 1006367 for details. |
cevans@chromium.org | 7600d94 | 2009-12-31 14:17:23 +0900 | [diff] [blame] | 381 | if (INT_MAX / sizeof(P) <= static_cast<size_t>(size)) |
| 382 | return false; |
| 383 | r->resize(size); |
| 384 | for (int i = 0; i < size; i++) { |
| 385 | if (!ReadParam(m, iter, &(*r)[i])) |
| 386 | return false; |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 387 | } |
| 388 | return true; |
| 389 | } |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 390 | static void Log(const param_type& p, std::string* l) { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 391 | for (size_t i = 0; i < p.size(); ++i) { |
| 392 | if (i != 0) |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 393 | l->append(" "); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 394 | LogParam((p[i]), l); |
| 395 | } |
| 396 | } |
| 397 | }; |
| 398 | |
mirandac@chromium.org | ee262ad | 2010-05-14 04:10:34 +0900 | [diff] [blame] | 399 | template <class P> |
| 400 | struct ParamTraits<std::set<P> > { |
| 401 | typedef std::set<P> param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 402 | static void Write(base::Pickle* m, const param_type& p) { |
Chris Palmer | 751d004 | 2017-09-26 07:53:22 +0900 | [diff] [blame] | 403 | WriteParam(m, base::checked_cast<int>(p.size())); |
mirandac@chromium.org | ee262ad | 2010-05-14 04:10:34 +0900 | [diff] [blame] | 404 | typename param_type::const_iterator iter; |
| 405 | for (iter = p.begin(); iter != p.end(); ++iter) |
| 406 | WriteParam(m, *iter); |
| 407 | } |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 408 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 409 | base::PickleIterator* iter, |
jbates@chromium.org | 0fc8736 | 2012-03-08 05:42:56 +0900 | [diff] [blame] | 410 | param_type* r) { |
mirandac@chromium.org | ee262ad | 2010-05-14 04:10:34 +0900 | [diff] [blame] | 411 | int size; |
avi | c9f0ad0 | 2014-12-29 08:31:48 +0900 | [diff] [blame] | 412 | if (!iter->ReadLength(&size)) |
mirandac@chromium.org | ee262ad | 2010-05-14 04:10:34 +0900 | [diff] [blame] | 413 | return false; |
| 414 | for (int i = 0; i < size; ++i) { |
| 415 | P item; |
| 416 | if (!ReadParam(m, iter, &item)) |
| 417 | return false; |
| 418 | r->insert(item); |
| 419 | } |
| 420 | return true; |
| 421 | } |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 422 | static void Log(const param_type& p, std::string* l) { |
| 423 | l->append("<std::set>"); |
mirandac@chromium.org | ee262ad | 2010-05-14 04:10:34 +0900 | [diff] [blame] | 424 | } |
| 425 | }; |
| 426 | |
jkarlin | 45b11f9 | 2014-09-24 20:42:37 +0900 | [diff] [blame] | 427 | template <class K, class V, class C, class A> |
| 428 | struct ParamTraits<std::map<K, V, C, A> > { |
| 429 | typedef std::map<K, V, C, A> param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 430 | static void Write(base::Pickle* m, const param_type& p) { |
Chris Palmer | 751d004 | 2017-09-26 07:53:22 +0900 | [diff] [blame] | 431 | WriteParam(m, base::checked_cast<int>(p.size())); |
Stuart Langley | 80d7b64 | 2017-11-02 12:54:44 +0900 | [diff] [blame] | 432 | for (const auto& iter : p) { |
| 433 | WriteParam(m, iter.first); |
| 434 | WriteParam(m, iter.second); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 435 | } |
| 436 | } |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 437 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 438 | base::PickleIterator* iter, |
jbates@chromium.org | 0fc8736 | 2012-03-08 05:42:56 +0900 | [diff] [blame] | 439 | param_type* r) { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 440 | int size; |
| 441 | if (!ReadParam(m, iter, &size) || size < 0) |
| 442 | return false; |
| 443 | for (int i = 0; i < size; ++i) { |
| 444 | K k; |
| 445 | if (!ReadParam(m, iter, &k)) |
| 446 | return false; |
| 447 | V& value = (*r)[k]; |
| 448 | if (!ReadParam(m, iter, &value)) |
| 449 | return false; |
| 450 | } |
| 451 | return true; |
| 452 | } |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 453 | static void Log(const param_type& p, std::string* l) { |
| 454 | l->append("<std::map>"); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 455 | } |
| 456 | }; |
| 457 | |
Stuart Langley | 80d7b64 | 2017-11-02 12:54:44 +0900 | [diff] [blame] | 458 | template <class K, class V, class C, class A> |
| 459 | struct ParamTraits<std::unordered_map<K, V, C, A>> { |
| 460 | typedef std::unordered_map<K, V, C, A> param_type; |
| 461 | static void Write(base::Pickle* m, const param_type& p) { |
| 462 | WriteParam(m, base::checked_cast<int>(p.size())); |
| 463 | for (const auto& iter : p) { |
| 464 | WriteParam(m, iter.first); |
| 465 | WriteParam(m, iter.second); |
| 466 | } |
| 467 | } |
| 468 | static bool Read(const base::Pickle* m, |
| 469 | base::PickleIterator* iter, |
| 470 | param_type* r) { |
| 471 | int size; |
| 472 | if (!ReadParam(m, iter, &size) || size < 0) |
| 473 | return false; |
| 474 | for (int i = 0; i < size; ++i) { |
| 475 | K k; |
| 476 | if (!ReadParam(m, iter, &k)) |
| 477 | return false; |
| 478 | V& value = (*r)[k]; |
| 479 | if (!ReadParam(m, iter, &value)) |
| 480 | return false; |
| 481 | } |
| 482 | return true; |
| 483 | } |
| 484 | static void Log(const param_type& p, std::string* l) { |
| 485 | l->append("<std::unordered_map>"); |
| 486 | } |
| 487 | }; |
| 488 | |
jam@chromium.org | 0aa0502 | 2009-08-04 11:00:56 +0900 | [diff] [blame] | 489 | template <class A, class B> |
| 490 | struct ParamTraits<std::pair<A, B> > { |
| 491 | typedef std::pair<A, B> param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 492 | static void Write(base::Pickle* m, const param_type& p) { |
jam@chromium.org | 0aa0502 | 2009-08-04 11:00:56 +0900 | [diff] [blame] | 493 | WriteParam(m, p.first); |
| 494 | WriteParam(m, p.second); |
| 495 | } |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 496 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 497 | base::PickleIterator* iter, |
jbates@chromium.org | 0fc8736 | 2012-03-08 05:42:56 +0900 | [diff] [blame] | 498 | param_type* r) { |
jam@chromium.org | 0aa0502 | 2009-08-04 11:00:56 +0900 | [diff] [blame] | 499 | return ReadParam(m, iter, &r->first) && ReadParam(m, iter, &r->second); |
| 500 | } |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 501 | static void Log(const param_type& p, std::string* l) { |
| 502 | l->append("("); |
jam@chromium.org | 0aa0502 | 2009-08-04 11:00:56 +0900 | [diff] [blame] | 503 | LogParam(p.first, l); |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 504 | l->append(", "); |
jam@chromium.org | 0aa0502 | 2009-08-04 11:00:56 +0900 | [diff] [blame] | 505 | LogParam(p.second, l); |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 506 | l->append(")"); |
jam@chromium.org | 0aa0502 | 2009-08-04 11:00:56 +0900 | [diff] [blame] | 507 | } |
| 508 | }; |
| 509 | |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 510 | // Base ParamTraits ------------------------------------------------------------ |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 511 | |
| 512 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 513 | struct COMPONENT_EXPORT(IPC) ParamTraits<base::DictionaryValue> { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 514 | typedef base::DictionaryValue param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 515 | static void Write(base::Pickle* m, const param_type& p); |
| 516 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 517 | base::PickleIterator* iter, |
| 518 | param_type* r); |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 519 | static void Log(const param_type& p, std::string* l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 520 | }; |
| 521 | |
| 522 | #if defined(OS_POSIX) |
| 523 | // FileDescriptors may be serialised over IPC channels on POSIX. On the |
| 524 | // receiving side, the FileDescriptor is a valid duplicate of the file |
| 525 | // descriptor which was transmitted: *it is not just a copy of the integer like |
| 526 | // HANDLEs on Windows*. The only exception is if the file descriptor is < 0. In |
| 527 | // this case, the receiving end will see a value of -1. *Zero is a valid file |
| 528 | // descriptor*. |
| 529 | // |
| 530 | // The received file descriptor will have the |auto_close| flag set to true. The |
| 531 | // code which handles the message is responsible for taking ownership of it. |
| 532 | // File descriptors are OS resources and must be closed when no longer needed. |
| 533 | // |
| 534 | // When sending a file descriptor, the file descriptor must be valid at the time |
| 535 | // of transmission. Since transmission is not synchronous, one should consider |
| 536 | // dup()ing any file descriptors to be transmitted and setting the |auto_close| |
| 537 | // flag, which causes the file descriptor to be closed after writing. |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 538 | template <> |
| 539 | struct COMPONENT_EXPORT(IPC) ParamTraits<base::FileDescriptor> { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 540 | typedef base::FileDescriptor param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 541 | static void Write(base::Pickle* m, const param_type& p); |
| 542 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 543 | base::PickleIterator* iter, |
| 544 | param_type* r); |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 545 | static void Log(const param_type& p, std::string* l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 546 | }; |
jhawkins@chromium.org | 63c75eb | 2010-03-09 09:38:41 +0900 | [diff] [blame] | 547 | #endif // defined(OS_POSIX) |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 548 | |
scottmg | 8149127 | 2015-06-20 07:51:00 +0900 | [diff] [blame] | 549 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 550 | struct COMPONENT_EXPORT(IPC) ParamTraits<base::SharedMemoryHandle> { |
scottmg | 8149127 | 2015-06-20 07:51:00 +0900 | [diff] [blame] | 551 | typedef base::SharedMemoryHandle param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 552 | static void Write(base::Pickle* m, const param_type& p); |
| 553 | static bool Read(const base::Pickle* m, |
| 554 | base::PickleIterator* iter, |
| 555 | param_type* r); |
scottmg | 8149127 | 2015-06-20 07:51:00 +0900 | [diff] [blame] | 556 | static void Log(const param_type& p, std::string* l); |
| 557 | }; |
scottmg | 8149127 | 2015-06-20 07:51:00 +0900 | [diff] [blame] | 558 | |
Klaus Weidner | 22df765 | 2017-11-03 15:24:57 +0900 | [diff] [blame] | 559 | #if defined(OS_ANDROID) |
| 560 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 561 | struct COMPONENT_EXPORT(IPC) ParamTraits<base::SharedMemoryHandle::Type> { |
Klaus Weidner | 22df765 | 2017-11-03 15:24:57 +0900 | [diff] [blame] | 562 | typedef base::SharedMemoryHandle::Type param_type; |
| 563 | static void Write(base::Pickle* m, const param_type& p); |
| 564 | static bool Read(const base::Pickle* m, |
| 565 | base::PickleIterator* iter, |
| 566 | param_type* r); |
| 567 | static void Log(const param_type& p, std::string* l); |
| 568 | }; |
| 569 | #endif |
| 570 | |
erikchen | 9a454c1 | 2017-04-29 11:24:36 +0900 | [diff] [blame] | 571 | #if defined(OS_WIN) |
| 572 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 573 | struct COMPONENT_EXPORT(IPC) ParamTraits<PlatformFileForTransit> { |
erikchen | 9a454c1 | 2017-04-29 11:24:36 +0900 | [diff] [blame] | 574 | typedef PlatformFileForTransit param_type; |
erikchen | 9a454c1 | 2017-04-29 11:24:36 +0900 | [diff] [blame] | 575 | static void Write(base::Pickle* m, const param_type& p); |
| 576 | static bool Read(const base::Pickle* m, |
| 577 | base::PickleIterator* iter, |
| 578 | param_type* r); |
| 579 | static void Log(const param_type& p, std::string* l); |
| 580 | }; |
| 581 | #endif // defined(OS_WIN) |
| 582 | |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 583 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 584 | struct COMPONENT_EXPORT(IPC) ParamTraits<base::FilePath> { |
brettw@chromium.org | a708694 | 2013-02-02 14:12:33 +0900 | [diff] [blame] | 585 | typedef base::FilePath param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 586 | static void Write(base::Pickle* m, const param_type& p); |
| 587 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 588 | base::PickleIterator* iter, |
| 589 | param_type* r); |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 590 | static void Log(const param_type& p, std::string* l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 591 | }; |
| 592 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 593 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 594 | struct COMPONENT_EXPORT(IPC) ParamTraits<base::ListValue> { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 595 | typedef base::ListValue param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 596 | static void Write(base::Pickle* m, const param_type& p); |
| 597 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 598 | base::PickleIterator* iter, |
| 599 | param_type* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 600 | static void Log(const param_type& p, std::string* l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 601 | }; |
| 602 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 603 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 604 | struct COMPONENT_EXPORT(IPC) ParamTraits<base::NullableString16> { |
avi@chromium.org | d817965 | 2013-06-13 22:47:46 +0900 | [diff] [blame] | 605 | typedef base::NullableString16 param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 606 | static void Write(base::Pickle* m, const param_type& p); |
| 607 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 608 | base::PickleIterator* iter, |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 609 | param_type* r); |
| 610 | static void Log(const param_type& p, std::string* l); |
| 611 | }; |
| 612 | |
| 613 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 614 | struct COMPONENT_EXPORT(IPC) ParamTraits<base::File::Info> { |
rvargas@chromium.org | 9e469f6 | 2014-01-28 06:36:00 +0900 | [diff] [blame] | 615 | typedef base::File::Info param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 616 | static void Write(base::Pickle* m, const param_type& p); |
| 617 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 618 | base::PickleIterator* iter, |
| 619 | param_type* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 620 | static void Log(const param_type& p, std::string* l); |
| 621 | }; |
| 622 | |
| 623 | template <> |
rvargas@chromium.org | 9e469f6 | 2014-01-28 06:36:00 +0900 | [diff] [blame] | 624 | struct SimilarTypeTraits<base::File::Error> { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 625 | typedef int Type; |
| 626 | }; |
| 627 | |
grt@chromium.org | b9abb17 | 2013-03-01 06:46:11 +0900 | [diff] [blame] | 628 | #if defined(OS_WIN) |
| 629 | template <> |
| 630 | struct SimilarTypeTraits<HWND> { |
| 631 | typedef HANDLE Type; |
| 632 | }; |
| 633 | #endif // defined(OS_WIN) |
| 634 | |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 635 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 636 | struct COMPONENT_EXPORT(IPC) ParamTraits<base::Time> { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 637 | typedef base::Time param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 638 | static void Write(base::Pickle* m, const param_type& p); |
| 639 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 640 | base::PickleIterator* iter, |
| 641 | param_type* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 642 | static void Log(const param_type& p, std::string* l); |
| 643 | }; |
| 644 | |
| 645 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 646 | struct COMPONENT_EXPORT(IPC) ParamTraits<base::TimeDelta> { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 647 | typedef base::TimeDelta param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 648 | static void Write(base::Pickle* m, const param_type& p); |
| 649 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 650 | base::PickleIterator* iter, |
| 651 | param_type* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 652 | static void Log(const param_type& p, std::string* l); |
| 653 | }; |
| 654 | |
| 655 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 656 | struct COMPONENT_EXPORT(IPC) ParamTraits<base::TimeTicks> { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 657 | typedef base::TimeTicks param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 658 | static void Write(base::Pickle* m, const param_type& p); |
| 659 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 660 | base::PickleIterator* iter, |
| 661 | param_type* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 662 | static void Log(const param_type& p, std::string* l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 663 | }; |
| 664 | |
| 665 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 666 | struct COMPONENT_EXPORT(IPC) ParamTraits<base::UnguessableToken> { |
tguilbert | 76e690d | 2016-09-20 06:11:25 +0900 | [diff] [blame] | 667 | typedef base::UnguessableToken param_type; |
tguilbert | 76e690d | 2016-09-20 06:11:25 +0900 | [diff] [blame] | 668 | static void Write(base::Pickle* m, const param_type& p); |
| 669 | static bool Read(const base::Pickle* m, |
| 670 | base::PickleIterator* iter, |
| 671 | param_type* r); |
| 672 | static void Log(const param_type& p, std::string* l); |
| 673 | }; |
| 674 | |
| 675 | template <> |
tzik | 51faa09 | 2016-02-11 19:24:45 +0900 | [diff] [blame] | 676 | struct ParamTraits<std::tuple<>> { |
| 677 | typedef std::tuple<> param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 678 | static void Write(base::Pickle* m, const param_type& p) {} |
| 679 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 680 | base::PickleIterator* iter, |
brettw | a487947 | 2015-06-02 16:02:47 +0900 | [diff] [blame] | 681 | param_type* r) { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 682 | return true; |
| 683 | } |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 684 | static void Log(const param_type& p, std::string* l) { |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 685 | } |
| 686 | }; |
| 687 | |
ossu | e8a9749 | 2017-06-22 18:35:39 +0900 | [diff] [blame] | 688 | template <typename T, int index, int count> |
| 689 | struct TupleParamTraitsHelper { |
| 690 | using Next = TupleParamTraitsHelper<T, index + 1, count>; |
| 691 | |
ossu | e8a9749 | 2017-06-22 18:35:39 +0900 | [diff] [blame] | 692 | static void Write(base::Pickle* m, const T& p) { |
| 693 | WriteParam(m, std::get<index>(p)); |
| 694 | Next::Write(m, p); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 695 | } |
ossu | e8a9749 | 2017-06-22 18:35:39 +0900 | [diff] [blame] | 696 | |
| 697 | static bool Read(const base::Pickle* m, base::PickleIterator* iter, T* r) { |
| 698 | return ReadParam(m, iter, &std::get<index>(*r)) && Next::Read(m, iter, r); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 699 | } |
ossu | e8a9749 | 2017-06-22 18:35:39 +0900 | [diff] [blame] | 700 | |
| 701 | static void Log(const T& p, std::string* l) { |
| 702 | LogParam(std::get<index>(p), l); |
| 703 | if (index < count - 1) |
| 704 | l->append(", "); |
| 705 | Next::Log(p, l); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 706 | } |
| 707 | }; |
| 708 | |
ossu | e8a9749 | 2017-06-22 18:35:39 +0900 | [diff] [blame] | 709 | template <typename T, int index> |
| 710 | struct TupleParamTraitsHelper<T, index, index> { |
ossu | e8a9749 | 2017-06-22 18:35:39 +0900 | [diff] [blame] | 711 | static void Write(base::Pickle* m, const T& p) {} |
| 712 | static bool Read(const base::Pickle* m, base::PickleIterator* iter, T* r) { |
| 713 | return true; |
rockot | 15c8ac4 | 2016-02-05 11:12:32 +0900 | [diff] [blame] | 714 | } |
ossu | e8a9749 | 2017-06-22 18:35:39 +0900 | [diff] [blame] | 715 | static void Log(const T& p, std::string* l) {} |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 716 | }; |
| 717 | |
ossu | e8a9749 | 2017-06-22 18:35:39 +0900 | [diff] [blame] | 718 | template <typename... Args> |
| 719 | struct ParamTraits<std::tuple<Args...>> { |
| 720 | using param_type = std::tuple<Args...>; |
| 721 | using Helper = |
| 722 | TupleParamTraitsHelper<param_type, 0, std::tuple_size<param_type>::value>; |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 723 | |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 724 | static void Write(base::Pickle* m, const param_type& p) { |
ossu | e8a9749 | 2017-06-22 18:35:39 +0900 | [diff] [blame] | 725 | Helper::Write(m, p); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 726 | } |
ossu | e8a9749 | 2017-06-22 18:35:39 +0900 | [diff] [blame] | 727 | |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 728 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 729 | base::PickleIterator* iter, |
brettw | a487947 | 2015-06-02 16:02:47 +0900 | [diff] [blame] | 730 | param_type* r) { |
ossu | e8a9749 | 2017-06-22 18:35:39 +0900 | [diff] [blame] | 731 | return Helper::Read(m, iter, r); |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 732 | } |
ossu | e8a9749 | 2017-06-22 18:35:39 +0900 | [diff] [blame] | 733 | |
| 734 | static void Log(const param_type& p, std::string* l) { Helper::Log(p, l); } |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 735 | }; |
| 736 | |
miletus | d41fe22 | 2015-07-24 04:42:36 +0900 | [diff] [blame] | 737 | template <class P, size_t stack_capacity> |
| 738 | struct ParamTraits<base::StackVector<P, stack_capacity> > { |
| 739 | typedef base::StackVector<P, stack_capacity> param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 740 | static void Write(base::Pickle* m, const param_type& p) { |
Chris Palmer | 751d004 | 2017-09-26 07:53:22 +0900 | [diff] [blame] | 741 | WriteParam(m, base::checked_cast<int>(p->size())); |
miletus | d41fe22 | 2015-07-24 04:42:36 +0900 | [diff] [blame] | 742 | for (size_t i = 0; i < p->size(); i++) |
| 743 | WriteParam(m, p[i]); |
| 744 | } |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 745 | static bool Read(const base::Pickle* m, |
miletus | d41fe22 | 2015-07-24 04:42:36 +0900 | [diff] [blame] | 746 | base::PickleIterator* iter, |
| 747 | param_type* r) { |
| 748 | int size; |
| 749 | // ReadLength() checks for < 0 itself. |
| 750 | if (!iter->ReadLength(&size)) |
| 751 | return false; |
| 752 | // Sanity check for the vector size. |
| 753 | if (INT_MAX / sizeof(P) <= static_cast<size_t>(size)) |
| 754 | return false; |
| 755 | P value; |
| 756 | for (int i = 0; i < size; i++) { |
| 757 | if (!ReadParam(m, iter, &value)) |
| 758 | return false; |
| 759 | (*r)->push_back(value); |
| 760 | } |
| 761 | return true; |
| 762 | } |
| 763 | static void Log(const param_type& p, std::string* l) { |
| 764 | for (size_t i = 0; i < p->size(); ++i) { |
| 765 | if (i != 0) |
| 766 | l->append(" "); |
| 767 | LogParam((p[i]), l); |
| 768 | } |
| 769 | } |
| 770 | }; |
| 771 | |
jdduke@chromium.org | 556db8b | 2014-03-19 05:48:35 +0900 | [diff] [blame] | 772 | template <typename NormalMap, |
| 773 | int kArraySize, |
| 774 | typename EqualKey, |
| 775 | typename MapInit> |
brettw | d3d9de0 | 2017-04-20 15:10:20 +0900 | [diff] [blame] | 776 | struct ParamTraits<base::small_map<NormalMap, kArraySize, EqualKey, MapInit>> { |
| 777 | using param_type = base::small_map<NormalMap, kArraySize, EqualKey, MapInit>; |
| 778 | using K = typename param_type::key_type; |
| 779 | using V = typename param_type::data_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 780 | static void Write(base::Pickle* m, const param_type& p) { |
Chris Palmer | 751d004 | 2017-09-26 07:53:22 +0900 | [diff] [blame] | 781 | WriteParam(m, base::checked_cast<int>(p.size())); |
jdduke@chromium.org | 556db8b | 2014-03-19 05:48:35 +0900 | [diff] [blame] | 782 | typename param_type::const_iterator iter; |
| 783 | for (iter = p.begin(); iter != p.end(); ++iter) { |
| 784 | WriteParam(m, iter->first); |
| 785 | WriteParam(m, iter->second); |
| 786 | } |
| 787 | } |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 788 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 789 | base::PickleIterator* iter, |
brettw | a487947 | 2015-06-02 16:02:47 +0900 | [diff] [blame] | 790 | param_type* r) { |
jdduke@chromium.org | 556db8b | 2014-03-19 05:48:35 +0900 | [diff] [blame] | 791 | int size; |
avi | c9f0ad0 | 2014-12-29 08:31:48 +0900 | [diff] [blame] | 792 | if (!iter->ReadLength(&size)) |
jdduke@chromium.org | 556db8b | 2014-03-19 05:48:35 +0900 | [diff] [blame] | 793 | return false; |
| 794 | for (int i = 0; i < size; ++i) { |
| 795 | K key; |
| 796 | if (!ReadParam(m, iter, &key)) |
| 797 | return false; |
| 798 | V& value = (*r)[key]; |
| 799 | if (!ReadParam(m, iter, &value)) |
| 800 | return false; |
| 801 | } |
| 802 | return true; |
| 803 | } |
| 804 | static void Log(const param_type& p, std::string* l) { |
brettw | d3d9de0 | 2017-04-20 15:10:20 +0900 | [diff] [blame] | 805 | l->append("<base::small_map>"); |
| 806 | } |
| 807 | }; |
| 808 | |
| 809 | template <class Key, class Mapped, class Compare> |
| 810 | struct ParamTraits<base::flat_map<Key, Mapped, Compare>> { |
| 811 | using param_type = base::flat_map<Key, Mapped, Compare>; |
brettw | d3d9de0 | 2017-04-20 15:10:20 +0900 | [diff] [blame] | 812 | static void Write(base::Pickle* m, const param_type& p) { |
| 813 | DCHECK(base::IsValueInRangeForNumericType<int>(p.size())); |
Chris Palmer | 751d004 | 2017-09-26 07:53:22 +0900 | [diff] [blame] | 814 | WriteParam(m, base::checked_cast<int>(p.size())); |
brettw | d3d9de0 | 2017-04-20 15:10:20 +0900 | [diff] [blame] | 815 | for (const auto& iter : p) { |
| 816 | WriteParam(m, iter.first); |
| 817 | WriteParam(m, iter.second); |
| 818 | } |
| 819 | } |
| 820 | static bool Read(const base::Pickle* m, |
| 821 | base::PickleIterator* iter, |
| 822 | param_type* r) { |
| 823 | int size; |
| 824 | if (!iter->ReadLength(&size)) |
| 825 | return false; |
| 826 | |
| 827 | // Construct by creating in a vector and moving into the flat_map. Properly |
| 828 | // serialized flat_maps will be in-order so this will be O(n). Incorrectly |
| 829 | // serialized ones will still be handled properly. |
| 830 | std::vector<typename param_type::value_type> vect; |
| 831 | vect.resize(size); |
| 832 | for (int i = 0; i < size; ++i) { |
| 833 | if (!ReadParam(m, iter, &vect[i].first)) |
| 834 | return false; |
| 835 | if (!ReadParam(m, iter, &vect[i].second)) |
| 836 | return false; |
| 837 | } |
| 838 | |
| 839 | *r = param_type(std::move(vect), base::KEEP_FIRST_OF_DUPES); |
| 840 | return true; |
| 841 | } |
| 842 | static void Log(const param_type& p, std::string* l) { |
| 843 | l->append("<base::flat_map>"); |
jdduke@chromium.org | 556db8b | 2014-03-19 05:48:35 +0900 | [diff] [blame] | 844 | } |
| 845 | }; |
| 846 | |
jdduke@chromium.org | c6d80f0 | 2014-05-20 11:34:56 +0900 | [diff] [blame] | 847 | template <class P> |
danakj | c3fb6c5 | 2016-04-23 13:21:09 +0900 | [diff] [blame] | 848 | struct ParamTraits<std::unique_ptr<P>> { |
| 849 | typedef std::unique_ptr<P> param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 850 | static void Write(base::Pickle* m, const param_type& p) { |
jdduke@chromium.org | c6d80f0 | 2014-05-20 11:34:56 +0900 | [diff] [blame] | 851 | bool valid = !!p; |
| 852 | WriteParam(m, valid); |
| 853 | if (valid) |
| 854 | WriteParam(m, *p); |
| 855 | } |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 856 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 857 | base::PickleIterator* iter, |
brettw | a487947 | 2015-06-02 16:02:47 +0900 | [diff] [blame] | 858 | param_type* r) { |
jdduke@chromium.org | c6d80f0 | 2014-05-20 11:34:56 +0900 | [diff] [blame] | 859 | bool valid = false; |
| 860 | if (!ReadParam(m, iter, &valid)) |
| 861 | return false; |
| 862 | |
| 863 | if (!valid) { |
| 864 | r->reset(); |
| 865 | return true; |
| 866 | } |
| 867 | |
| 868 | param_type temp(new P()); |
| 869 | if (!ReadParam(m, iter, temp.get())) |
| 870 | return false; |
| 871 | |
| 872 | r->swap(temp); |
| 873 | return true; |
| 874 | } |
| 875 | static void Log(const param_type& p, std::string* l) { |
| 876 | if (p) |
| 877 | LogParam(*p, l); |
| 878 | else |
| 879 | l->append("NULL"); |
| 880 | } |
| 881 | }; |
| 882 | |
bmcquade | 1175837 | 2016-07-01 22:13:50 +0900 | [diff] [blame] | 883 | template <class P> |
| 884 | struct ParamTraits<base::Optional<P>> { |
| 885 | typedef base::Optional<P> param_type; |
bmcquade | 1175837 | 2016-07-01 22:13:50 +0900 | [diff] [blame] | 886 | static void Write(base::Pickle* m, const param_type& p) { |
| 887 | const bool is_set = static_cast<bool>(p); |
| 888 | WriteParam(m, is_set); |
| 889 | if (is_set) |
| 890 | WriteParam(m, p.value()); |
| 891 | } |
| 892 | static bool Read(const base::Pickle* m, |
| 893 | base::PickleIterator* iter, |
| 894 | param_type* r) { |
| 895 | bool is_set = false; |
| 896 | if (!iter->ReadBool(&is_set)) |
| 897 | return false; |
| 898 | if (is_set) { |
| 899 | P value; |
| 900 | if (!ReadParam(m, iter, &value)) |
| 901 | return false; |
| 902 | *r = std::move(value); |
| 903 | } |
| 904 | return true; |
| 905 | } |
| 906 | static void Log(const param_type& p, std::string* l) { |
| 907 | if (p) |
| 908 | LogParam(p.value(), l); |
| 909 | else |
| 910 | l->append("(unset)"); |
| 911 | } |
| 912 | }; |
| 913 | |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 914 | // IPC types ParamTraits ------------------------------------------------------- |
| 915 | |
| 916 | // A ChannelHandle is basically a platform-inspecific wrapper around the |
| 917 | // fact that IPC endpoints are handled specially on POSIX. See above comments |
| 918 | // on FileDescriptor for more background. |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 919 | template <> |
| 920 | struct COMPONENT_EXPORT(IPC) ParamTraits<IPC::ChannelHandle> { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 921 | typedef ChannelHandle param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 922 | static void Write(base::Pickle* m, const param_type& p); |
| 923 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 924 | base::PickleIterator* iter, |
| 925 | param_type* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 926 | static void Log(const param_type& p, std::string* l); |
| 927 | }; |
| 928 | |
| 929 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 930 | struct COMPONENT_EXPORT(IPC) ParamTraits<LogData> { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 931 | typedef LogData param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 932 | static void Write(base::Pickle* m, const param_type& p); |
| 933 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 934 | base::PickleIterator* iter, |
| 935 | param_type* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 936 | static void Log(const param_type& p, std::string* l); |
| 937 | }; |
| 938 | |
| 939 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 940 | struct COMPONENT_EXPORT(IPC) ParamTraits<Message> { |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 941 | static void Write(base::Pickle* m, const Message& p); |
| 942 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 943 | base::PickleIterator* iter, |
| 944 | Message* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 945 | static void Log(const Message& p, std::string* l); |
| 946 | }; |
| 947 | |
| 948 | // Windows ParamTraits --------------------------------------------------------- |
| 949 | |
| 950 | #if defined(OS_WIN) |
| 951 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 952 | struct COMPONENT_EXPORT(IPC) ParamTraits<HANDLE> { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 953 | typedef HANDLE param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 954 | static void Write(base::Pickle* m, const param_type& p); |
| 955 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 956 | base::PickleIterator* iter, |
| 957 | param_type* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 958 | static void Log(const param_type& p, std::string* l); |
| 959 | }; |
| 960 | |
| 961 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 962 | struct COMPONENT_EXPORT(IPC) ParamTraits<LOGFONT> { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 963 | typedef LOGFONT param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 964 | static void Write(base::Pickle* m, const param_type& p); |
| 965 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 966 | base::PickleIterator* iter, |
| 967 | param_type* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 968 | static void Log(const param_type& p, std::string* l); |
| 969 | }; |
| 970 | |
| 971 | template <> |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 972 | struct COMPONENT_EXPORT(IPC) ParamTraits<MSG> { |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 973 | typedef MSG param_type; |
rockot | 6dbfea5 | 2016-02-04 05:20:16 +0900 | [diff] [blame] | 974 | static void Write(base::Pickle* m, const param_type& p); |
| 975 | static bool Read(const base::Pickle* m, |
brettw | f314620 | 2015-06-03 13:29:25 +0900 | [diff] [blame] | 976 | base::PickleIterator* iter, |
| 977 | param_type* r); |
brettw@chromium.org | ce352e5 | 2012-06-05 06:18:25 +0900 | [diff] [blame] | 978 | static void Log(const param_type& p, std::string* l); |
| 979 | }; |
| 980 | #endif // defined(OS_WIN) |
| 981 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 982 | //----------------------------------------------------------------------------- |
| 983 | // Generic message subclasses |
| 984 | |
erg@google.com | e6ffcb5 | 2010-08-18 03:38:24 +0900 | [diff] [blame] | 985 | // defined in ipc_logging.cc |
Ken Rockot | e6f96f8 | 2018-01-23 11:44:39 +0900 | [diff] [blame] | 986 | COMPONENT_EXPORT(IPC) |
| 987 | void GenerateLogData(const Message& message, LogData* data, bool get_params); |
erg@google.com | e6ffcb5 | 2010-08-18 03:38:24 +0900 | [diff] [blame] | 988 | |
davidsz | 3bf38eb | 2017-05-12 18:19:23 +0900 | [diff] [blame] | 989 | #if BUILDFLAG(IPC_MESSAGE_LOG_ENABLED) |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 990 | inline void AddOutputParamsToLog(const Message* msg, std::string* l) { |
| 991 | const std::string& output_params = msg->output_params(); |
erg@google.com | e6ffcb5 | 2010-08-18 03:38:24 +0900 | [diff] [blame] | 992 | if (!l->empty() && !output_params.empty()) |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 993 | l->append(", "); |
erg@google.com | e6ffcb5 | 2010-08-18 03:38:24 +0900 | [diff] [blame] | 994 | |
| 995 | l->append(output_params); |
| 996 | } |
| 997 | |
| 998 | template <class ReplyParamType> |
| 999 | inline void LogReplyParamsToMessage(const ReplyParamType& reply_params, |
| 1000 | const Message* msg) { |
| 1001 | if (msg->received_time() != 0) { |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 1002 | std::string output_params; |
erg@google.com | e6ffcb5 | 2010-08-18 03:38:24 +0900 | [diff] [blame] | 1003 | LogParam(reply_params, &output_params); |
| 1004 | msg->set_output_params(output_params); |
| 1005 | } |
| 1006 | } |
| 1007 | |
| 1008 | inline void ConnectMessageAndReply(const Message* msg, Message* reply) { |
| 1009 | if (msg->sent_time()) { |
| 1010 | // Don't log the sync message after dispatch, as we don't have the |
| 1011 | // output parameters at that point. Instead, save its data and log it |
| 1012 | // with the outgoing reply message when it's sent. |
| 1013 | LogData* data = new LogData; |
sammc | 65f302f | 2016-11-15 09:34:36 +0900 | [diff] [blame] | 1014 | GenerateLogData(*msg, data, true); |
erg@google.com | e6ffcb5 | 2010-08-18 03:38:24 +0900 | [diff] [blame] | 1015 | msg->set_dont_log(); |
| 1016 | reply->set_sync_log_data(data); |
| 1017 | } |
| 1018 | } |
| 1019 | #else |
erg@google.com | 8aca727 | 2010-08-19 03:33:57 +0900 | [diff] [blame] | 1020 | inline void AddOutputParamsToLog(const Message* msg, std::string* l) {} |
erg@google.com | e6ffcb5 | 2010-08-18 03:38:24 +0900 | [diff] [blame] | 1021 | |
| 1022 | template <class ReplyParamType> |
| 1023 | inline void LogReplyParamsToMessage(const ReplyParamType& reply_params, |
| 1024 | const Message* msg) {} |
| 1025 | |
| 1026 | inline void ConnectMessageAndReply(const Message* msg, Message* reply) {} |
| 1027 | #endif |
| 1028 | |
agl@chromium.org | 1c6dcf2 | 2009-07-23 08:57:21 +0900 | [diff] [blame] | 1029 | } // namespace IPC |
| 1030 | |
| 1031 | #endif // IPC_IPC_MESSAGE_UTILS_H_ |