• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Protocol Buffers - Google's data interchange format
2 // Copyright 2008 Google Inc.  All rights reserved.
3 // https://developers.google.com/protocol-buffers/
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 //     * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //     * Redistributions in binary form must reproduce the above
12 // copyright notice, this list of conditions and the following disclaimer
13 // in the documentation and/or other materials provided with the
14 // distribution.
15 //     * Neither the name of Google Inc. nor the names of its
16 // contributors may be used to endorse or promote products derived from
17 // this software without specific prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 // Authors: wink@google.com (Wink Saville),
32 //          kenton@google.com (Kenton Varda)
33 //  Based on original Protocol Buffers design by
34 //  Sanjay Ghemawat, Jeff Dean, and others.
35 
36 #include <google/protobuf/message_lite.h>
37 #include <google/protobuf/arena.h>
38 #include <google/protobuf/repeated_field.h>
39 #include <string>
40 #include <google/protobuf/stubs/logging.h>
41 #include <google/protobuf/stubs/common.h>
42 #include <google/protobuf/io/coded_stream.h>
43 #include <google/protobuf/io/zero_copy_stream_impl_lite.h>
44 #include <google/protobuf/stubs/stl_util.h>
45 
46 namespace google {
47 namespace protobuf {
48 
InitializationErrorString() const49 string MessageLite::InitializationErrorString() const {
50   return "(cannot determine missing fields for lite message)";
51 }
52 
53 namespace {
54 
55 // When serializing, we first compute the byte size, then serialize the message.
56 // If serialization produces a different number of bytes than expected, we
57 // call this function, which crashes.  The problem could be due to a bug in the
58 // protobuf implementation but is more likely caused by concurrent modification
59 // of the message.  This function attempts to distinguish between the two and
60 // provide a useful error message.
ByteSizeConsistencyError(int byte_size_before_serialization,int byte_size_after_serialization,int bytes_produced_by_serialization,const MessageLite & message)61 void ByteSizeConsistencyError(int byte_size_before_serialization,
62                               int byte_size_after_serialization,
63                               int bytes_produced_by_serialization,
64                               const MessageLite& message) {
65   GOOGLE_CHECK_EQ(byte_size_before_serialization, byte_size_after_serialization)
66       << message.GetTypeName()
67       << " was modified concurrently during serialization.";
68   GOOGLE_CHECK_EQ(bytes_produced_by_serialization, byte_size_before_serialization)
69       << "Byte size calculation and serialization were inconsistent.  This "
70          "may indicate a bug in protocol buffers or it may be caused by "
71          "concurrent modification of " << message.GetTypeName() << ".";
72   GOOGLE_LOG(FATAL) << "This shouldn't be called if all the sizes are equal.";
73 }
74 
InitializationErrorMessage(const char * action,const MessageLite & message)75 string InitializationErrorMessage(const char* action,
76                                   const MessageLite& message) {
77   // Note:  We want to avoid depending on strutil in the lite library, otherwise
78   //   we'd use:
79   //
80   // return strings::Substitute(
81   //   "Can't $0 message of type \"$1\" because it is missing required "
82   //   "fields: $2",
83   //   action, message.GetTypeName(),
84   //   message.InitializationErrorString());
85 
86   string result;
87   result += "Can't ";
88   result += action;
89   result += " message of type \"";
90   result += message.GetTypeName();
91   result += "\" because it is missing required fields: ";
92   result += message.InitializationErrorString();
93   return result;
94 }
95 
96 // Several of the Parse methods below just do one thing and then call another
97 // method.  In a naive implementation, we might have ParseFromString() call
98 // ParseFromArray() which would call ParseFromZeroCopyStream() which would call
99 // ParseFromCodedStream() which would call MergeFromCodedStream() which would
100 // call MergePartialFromCodedStream().  However, when parsing very small
101 // messages, every function call introduces significant overhead.  To avoid
102 // this without reproducing code, we use these forced-inline helpers.
103 GOOGLE_ATTRIBUTE_ALWAYS_INLINE bool InlineMergeFromCodedStream(
104     io::CodedInputStream* input, MessageLite* message);
105 GOOGLE_ATTRIBUTE_ALWAYS_INLINE bool InlineParseFromCodedStream(
106     io::CodedInputStream* input, MessageLite* message);
107 GOOGLE_ATTRIBUTE_ALWAYS_INLINE bool InlineParsePartialFromCodedStream(
108     io::CodedInputStream* input, MessageLite* message);
109 GOOGLE_ATTRIBUTE_ALWAYS_INLINE bool InlineParseFromArray(
110     const void* data, int size, MessageLite* message);
111 GOOGLE_ATTRIBUTE_ALWAYS_INLINE bool InlineParsePartialFromArray(
112     const void* data, int size, MessageLite* message);
113 
InlineMergeFromCodedStream(io::CodedInputStream * input,MessageLite * message)114 inline bool InlineMergeFromCodedStream(io::CodedInputStream* input,
115                                        MessageLite* message) {
116   if (!message->MergePartialFromCodedStream(input)) return false;
117   if (!message->IsInitialized()) {
118     GOOGLE_LOG(ERROR) << InitializationErrorMessage("parse", *message);
119     return false;
120   }
121   return true;
122 }
123 
InlineParseFromCodedStream(io::CodedInputStream * input,MessageLite * message)124 inline bool InlineParseFromCodedStream(io::CodedInputStream* input,
125                                        MessageLite* message) {
126   message->Clear();
127   return InlineMergeFromCodedStream(input, message);
128 }
129 
InlineParsePartialFromCodedStream(io::CodedInputStream * input,MessageLite * message)130 inline bool InlineParsePartialFromCodedStream(io::CodedInputStream* input,
131                                               MessageLite* message) {
132   message->Clear();
133   return message->MergePartialFromCodedStream(input);
134 }
135 
InlineParseFromArray(const void * data,int size,MessageLite * message)136 inline bool InlineParseFromArray(
137     const void* data, int size, MessageLite* message) {
138   io::CodedInputStream input(reinterpret_cast<const uint8*>(data), size);
139   return InlineParseFromCodedStream(&input, message) &&
140          input.ConsumedEntireMessage();
141 }
142 
InlineParsePartialFromArray(const void * data,int size,MessageLite * message)143 inline bool InlineParsePartialFromArray(
144     const void* data, int size, MessageLite* message) {
145   io::CodedInputStream input(reinterpret_cast<const uint8*>(data), size);
146   return InlineParsePartialFromCodedStream(&input, message) &&
147          input.ConsumedEntireMessage();
148 }
149 
150 }  // namespace
151 
152 
New(::google::protobuf::Arena * arena) const153 MessageLite* MessageLite::New(::google::protobuf::Arena* arena) const {
154   MessageLite* message = New();
155   if (arena != NULL) {
156     arena->Own(message);
157   }
158   return message;
159 }
160 
MergeFromCodedStream(io::CodedInputStream * input)161 bool MessageLite::MergeFromCodedStream(io::CodedInputStream* input) {
162   return InlineMergeFromCodedStream(input, this);
163 }
164 
ParseFromCodedStream(io::CodedInputStream * input)165 bool MessageLite::ParseFromCodedStream(io::CodedInputStream* input) {
166   return InlineParseFromCodedStream(input, this);
167 }
168 
ParsePartialFromCodedStream(io::CodedInputStream * input)169 bool MessageLite::ParsePartialFromCodedStream(io::CodedInputStream* input) {
170   return InlineParsePartialFromCodedStream(input, this);
171 }
172 
ParseFromZeroCopyStream(io::ZeroCopyInputStream * input)173 bool MessageLite::ParseFromZeroCopyStream(io::ZeroCopyInputStream* input) {
174   io::CodedInputStream decoder(input);
175   return ParseFromCodedStream(&decoder) && decoder.ConsumedEntireMessage();
176 }
177 
ParsePartialFromZeroCopyStream(io::ZeroCopyInputStream * input)178 bool MessageLite::ParsePartialFromZeroCopyStream(
179     io::ZeroCopyInputStream* input) {
180   io::CodedInputStream decoder(input);
181   return ParsePartialFromCodedStream(&decoder) &&
182          decoder.ConsumedEntireMessage();
183 }
184 
ParseFromBoundedZeroCopyStream(io::ZeroCopyInputStream * input,int size)185 bool MessageLite::ParseFromBoundedZeroCopyStream(
186     io::ZeroCopyInputStream* input, int size) {
187   io::CodedInputStream decoder(input);
188   decoder.PushLimit(size);
189   return ParseFromCodedStream(&decoder) &&
190          decoder.ConsumedEntireMessage() &&
191          decoder.BytesUntilLimit() == 0;
192 }
193 
ParsePartialFromBoundedZeroCopyStream(io::ZeroCopyInputStream * input,int size)194 bool MessageLite::ParsePartialFromBoundedZeroCopyStream(
195     io::ZeroCopyInputStream* input, int size) {
196   io::CodedInputStream decoder(input);
197   decoder.PushLimit(size);
198   return ParsePartialFromCodedStream(&decoder) &&
199          decoder.ConsumedEntireMessage() &&
200          decoder.BytesUntilLimit() == 0;
201 }
202 
ParseFromString(const string & data)203 bool MessageLite::ParseFromString(const string& data) {
204   return InlineParseFromArray(data.data(), data.size(), this);
205 }
206 
ParsePartialFromString(const string & data)207 bool MessageLite::ParsePartialFromString(const string& data) {
208   return InlineParsePartialFromArray(data.data(), data.size(), this);
209 }
210 
ParseFromArray(const void * data,int size)211 bool MessageLite::ParseFromArray(const void* data, int size) {
212   return InlineParseFromArray(data, size, this);
213 }
214 
ParsePartialFromArray(const void * data,int size)215 bool MessageLite::ParsePartialFromArray(const void* data, int size) {
216   return InlineParsePartialFromArray(data, size, this);
217 }
218 
219 
220 // ===================================================================
221 
InternalSerializeWithCachedSizesToArray(bool deterministic,uint8 * target) const222 uint8* MessageLite::InternalSerializeWithCachedSizesToArray(
223     bool deterministic, uint8* target) const {
224   // We only optimize this when using optimize_for = SPEED.  In other cases
225   // we just use the CodedOutputStream path.
226   int size = GetCachedSize();
227   io::ArrayOutputStream out(target, size);
228   io::CodedOutputStream coded_out(&out);
229   SerializeWithCachedSizes(&coded_out);
230   GOOGLE_CHECK(!coded_out.HadError());
231   return target + size;
232 }
233 
SerializeToCodedStream(io::CodedOutputStream * output) const234 bool MessageLite::SerializeToCodedStream(io::CodedOutputStream* output) const {
235   GOOGLE_DCHECK(IsInitialized()) << InitializationErrorMessage("serialize", *this);
236   return SerializePartialToCodedStream(output);
237 }
238 
SerializePartialToCodedStream(io::CodedOutputStream * output) const239 bool MessageLite::SerializePartialToCodedStream(
240     io::CodedOutputStream* output) const {
241   const int size = ByteSize();  // Force size to be cached.
242   if (size < 0) {
243     // Messages >2G cannot be serialized due to overflow computing ByteSize.
244     GOOGLE_LOG(ERROR) << "Error computing ByteSize (possible overflow?).";
245     return false;
246   }
247 
248   uint8* buffer = output->GetDirectBufferForNBytesAndAdvance(size);
249   if (buffer != NULL) {
250     uint8* end = SerializeWithCachedSizesToArray(buffer);
251     if (end - buffer != size) {
252       ByteSizeConsistencyError(size, ByteSize(), end - buffer, *this);
253     }
254     return true;
255   } else {
256     int original_byte_count = output->ByteCount();
257     SerializeWithCachedSizes(output);
258     if (output->HadError()) {
259       return false;
260     }
261     int final_byte_count = output->ByteCount();
262 
263     if (final_byte_count - original_byte_count != size) {
264       ByteSizeConsistencyError(size, ByteSize(),
265                                final_byte_count - original_byte_count, *this);
266     }
267 
268     return true;
269   }
270 }
271 
SerializeToZeroCopyStream(io::ZeroCopyOutputStream * output) const272 bool MessageLite::SerializeToZeroCopyStream(
273     io::ZeroCopyOutputStream* output) const {
274   io::CodedOutputStream encoder(output);
275   return SerializeToCodedStream(&encoder);
276 }
277 
SerializePartialToZeroCopyStream(io::ZeroCopyOutputStream * output) const278 bool MessageLite::SerializePartialToZeroCopyStream(
279     io::ZeroCopyOutputStream* output) const {
280   io::CodedOutputStream encoder(output);
281   return SerializePartialToCodedStream(&encoder);
282 }
283 
AppendToString(string * output) const284 bool MessageLite::AppendToString(string* output) const {
285   GOOGLE_DCHECK(IsInitialized()) << InitializationErrorMessage("serialize", *this);
286   return AppendPartialToString(output);
287 }
288 
AppendPartialToString(string * output) const289 bool MessageLite::AppendPartialToString(string* output) const {
290   int old_size = output->size();
291   int byte_size = ByteSize();
292   if (byte_size < 0) {
293     // Messages >2G cannot be serialized due to overflow computing ByteSize.
294     GOOGLE_LOG(ERROR) << "Error computing ByteSize (possible overflow?).";
295     return false;
296   }
297 
298   STLStringResizeUninitialized(output, old_size + byte_size);
299   uint8* start =
300       reinterpret_cast<uint8*>(io::mutable_string_data(output) + old_size);
301   uint8* end = SerializeWithCachedSizesToArray(start);
302   if (end - start != byte_size) {
303     ByteSizeConsistencyError(byte_size, ByteSize(), end - start, *this);
304   }
305   return true;
306 }
307 
SerializeToString(string * output) const308 bool MessageLite::SerializeToString(string* output) const {
309   output->clear();
310   return AppendToString(output);
311 }
312 
SerializePartialToString(string * output) const313 bool MessageLite::SerializePartialToString(string* output) const {
314   output->clear();
315   return AppendPartialToString(output);
316 }
317 
SerializeToArray(void * data,int size) const318 bool MessageLite::SerializeToArray(void* data, int size) const {
319   GOOGLE_DCHECK(IsInitialized()) << InitializationErrorMessage("serialize", *this);
320   return SerializePartialToArray(data, size);
321 }
322 
SerializePartialToArray(void * data,int size) const323 bool MessageLite::SerializePartialToArray(void* data, int size) const {
324   int byte_size = ByteSize();
325   if (size < byte_size) return false;
326   uint8* start = reinterpret_cast<uint8*>(data);
327   uint8* end = SerializeWithCachedSizesToArray(start);
328   if (end - start != byte_size) {
329     ByteSizeConsistencyError(byte_size, ByteSize(), end - start, *this);
330   }
331   return true;
332 }
333 
SerializeAsString() const334 string MessageLite::SerializeAsString() const {
335   // If the compiler implements the (Named) Return Value Optimization,
336   // the local variable 'output' will not actually reside on the stack
337   // of this function, but will be overlaid with the object that the
338   // caller supplied for the return value to be constructed in.
339   string output;
340   if (!AppendToString(&output))
341     output.clear();
342   return output;
343 }
344 
SerializePartialAsString() const345 string MessageLite::SerializePartialAsString() const {
346   string output;
347   if (!AppendPartialToString(&output))
348     output.clear();
349   return output;
350 }
351 
352 namespace internal {
353 template<>
NewFromPrototype(const MessageLite * prototype,google::protobuf::Arena * arena)354 MessageLite* GenericTypeHandler<MessageLite>::NewFromPrototype(
355     const MessageLite* prototype, google::protobuf::Arena* arena) {
356   return prototype->New(arena);
357 }
358 template <>
Merge(const MessageLite & from,MessageLite * to)359 void GenericTypeHandler<MessageLite>::Merge(const MessageLite& from,
360                                             MessageLite* to) {
361   to->CheckTypeAndMergeFrom(from);
362 }
363 template<>
Merge(const string & from,string * to)364 void GenericTypeHandler<string>::Merge(const string& from,
365                                               string* to) {
366   *to = from;
367 }
368 }  // namespace internal
369 
370 }  // namespace protobuf
371 }  // namespace google
372