base/pickle.cc

   1 // Copyright (c) 2011 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.
   4
   5 #include "base/pickle.h"
   6
   7 #include <stdlib.h>
   8
   9 #include <algorithm>  // for max()
  10 #include <limits>
  11
  12 //------------------------------------------------------------------------------
  13
  14 // static
  15 const int Pickle::kPayloadUnit = 64;
  16
  17 // We mark a read only pickle with a special capacity_.
  18 static const size_t kCapacityReadOnly = std::numeric_limits<size_t>::max();
  19
  20 // Payload is uint32 aligned.
  21
  22 Pickle::Pickle()
  23     : header_(NULL),
  24       header_size_(sizeof(Header)),
  25       capacity_(0),
  26       variable_buffer_offset_(0) {
  27   Resize(kPayloadUnit);
  28   header_->payload_size = 0;
  29 }
  30
  31 Pickle::Pickle(int header_size)
  32     : header_(NULL),
  33       header_size_(AlignInt(header_size, sizeof(uint32))),
  34       capacity_(0),
  35       variable_buffer_offset_(0) {
  36   DCHECK_GE(static_cast<size_t>(header_size), sizeof(Header));
  37   DCHECK_LE(header_size, kPayloadUnit);
  38   Resize(kPayloadUnit);
  39   header_->payload_size = 0;
  40 }
  41
  42 Pickle::Pickle(const char* data, int data_len)
  43     : header_(reinterpret_cast<Header*>(const_cast<char*>(data))),
  44       header_size_(0),
  45       capacity_(kCapacityReadOnly),
  46       variable_buffer_offset_(0)
  47 {
  48
  49   if (data_len >= static_cast<int>(sizeof(Header)))
  50         {
  51         header_size_ = data_len - header_->payload_size;
  52         }
  53
  54   if (header_size_ > static_cast<unsigned int>(data_len))
  55         {
  56     header_size_ = 0;
  57         }
  58
  59
  60   if (header_size_ != AlignInt(header_size_, sizeof(uint32)))
  61         {
  62     header_size_ = 0;
  63         }
  64
  65
  66   // If there is anything wrong with the data, we're not going to use it.
  67   if (!header_size_)
  68     header_ = NULL;
  69 }
  70
  71 Pickle::Pickle(const Pickle& other)
  72     : header_(NULL),
  73       header_size_(other.header_size_),
  74       capacity_(0),
  75       variable_buffer_offset_(other.variable_buffer_offset_) {
  76   size_t payload_size = header_size_ + other.header_->payload_size;
  77   bool resized = Resize(payload_size);
  78   CHECK(resized);  // Realloc failed.
  79   memcpy(header_, other.header_, payload_size);
  80 }
  81
  82 Pickle::~Pickle() {
  83   if (capacity_ != kCapacityReadOnly)
  84     free(header_);
  85 }
  86
  87 Pickle& Pickle::operator=(const Pickle& other) {
  88   if (this == &other) {
  89     NOTREACHED();
  90     return *this;
  91   }
  92   if (capacity_ == kCapacityReadOnly) {
  93     header_ = NULL;
  94     capacity_ = 0;
  95   }
  96   if (header_size_ != other.header_size_) {
  97     free(header_);
  98     header_ = NULL;
  99     header_size_ = other.header_size_;
 100   }
 101   bool resized = Resize(other.header_size_ + other.header_->payload_size);
 102   CHECK(resized);  // Realloc failed.
 103   memcpy(header_, other.header_,
 104          other.header_size_ + other.header_->payload_size);
 105   variable_buffer_offset_ = other.variable_buffer_offset_;
 106   return *this;
 107 }
 108
 109 bool Pickle::ReadBool(void** iter, bool* result) const {
 110   DCHECK(iter);
 111
 112   int tmp;
 113   if (!ReadInt(iter, &tmp))
 114     return false;
 115   DCHECK(0 == tmp || 1 == tmp);
 116   *result = tmp ? true : false;
 117   return true;
 118 }
 119
 120 bool Pickle::ReadInt(void** iter, int* result) const {
 121   DCHECK(iter);
 122   if (!*iter)
 123     *iter = const_cast<char*>(payload());
 124
 125   if (!IteratorHasRoomFor(*iter, sizeof(*result)))
 126     return false;
 127
 128   // TODO(jar): http://crbug.com/13108 Pickle should be cleaned up, and not
 129   // dependent on alignment.
 130   // Next line is otherwise the same as: memcpy(result, *iter, sizeof(*result));
 131   *result = *reinterpret_cast<int*>(*iter);
 132
 133   UpdateIter(iter, sizeof(*result));
 134   return true;
 135 }
 136
 137 bool Pickle::ReadLong(void** iter, long* result) const {
 138   DCHECK(iter);
 139   if (!*iter)
 140     *iter = const_cast<char*>(payload());
 141
 142   if (!IteratorHasRoomFor(*iter, sizeof(*result)))
 143     return false;
 144
 145   // TODO(jar): http://crbug.com/13108 Pickle should be cleaned up, and not
 146   // dependent on alignment.
 147   memcpy(result, *iter, sizeof(*result));
 148
 149   UpdateIter(iter, sizeof(*result));
 150   return true;
 151 }
 152
 153 bool Pickle::ReadSize(void** iter, size_t* result) const {
 154   DCHECK(iter);
 155   if (!*iter)
 156     *iter = const_cast<char*>(payload());
 157
 158   if (!IteratorHasRoomFor(*iter, sizeof(*result)))
 159     return false;
 160
 161   // TODO(jar): http://crbug.com/13108 Pickle should be cleaned up, and not
 162   // dependent on alignment.
 163   // Next line is otherwise the same as: memcpy(result, *iter, sizeof(*result));
 164   *result = *reinterpret_cast<size_t*>(*iter);
 165
 166   UpdateIter(iter, sizeof(*result));
 167   return true;
 168 }
 169
 170 bool Pickle::ReadUInt16(void** iter, uint16* result) const {
 171   DCHECK(iter);
 172   if (!*iter)
 173     *iter = const_cast<char*>(payload());
 174
 175   if (!IteratorHasRoomFor(*iter, sizeof(*result)))
 176     return false;
 177
 178   memcpy(result, *iter, sizeof(*result));
 179
 180   UpdateIter(iter, sizeof(*result));
 181   return true;
 182 }
 183
 184 bool Pickle::ReadUInt32(void** iter, uint32* result) const {
 185   DCHECK(iter);
 186   if (!*iter)
 187     *iter = const_cast<char*>(payload());
 188
 189   if (!IteratorHasRoomFor(*iter, sizeof(*result)))
 190     return false;
 191
 192   memcpy(result, *iter, sizeof(*result));
 193
 194   UpdateIter(iter, sizeof(*result));
 195   return true;
 196 }
 197
 198 bool Pickle::ReadInt64(void** iter, int64* result) const {
 199   DCHECK(iter);
 200   if (!*iter)
 201     *iter = const_cast<char*>(payload());
 202
 203   if (!IteratorHasRoomFor(*iter, sizeof(*result)))
 204     return false;
 205
 206   memcpy(result, *iter, sizeof(*result));
 207
 208   UpdateIter(iter, sizeof(*result));
 209   return true;
 210 }
 211
 212 bool Pickle::ReadUInt64(void** iter, uint64* result) const {
 213   DCHECK(iter);
 214   if (!*iter)
 215     *iter = const_cast<char*>(payload());
 216
 217   if (!IteratorHasRoomFor(*iter, sizeof(*result)))
 218     return false;
 219
 220   memcpy(result, *iter, sizeof(*result));
 221
 222   UpdateIter(iter, sizeof(*result));
 223   return true;
 224 }
 225
 226
 227 bool Pickle::ReadString(void** iter, std::string* result) const {
 228   DCHECK(iter);
 229
 230   int len;
 231   if (!ReadLength(iter, &len))
 232     return false;
 233   if (!IteratorHasRoomFor(*iter, len))
 234     return false;
 235
 236   char* chars = reinterpret_cast<char*>(*iter);
 237   result->assign(chars, len);
 238
 239   UpdateIter(iter, len);
 240   return true;
 241 }
 242
 243 /*
 244 bool Pickle::ReadWString(void** iter, std::wstring* result) const {
 245   DCHECK(iter);
 246
 247   int len;
 248   if (!ReadLength(iter, &len))
 249     return false;
 250   // Avoid integer overflow.
 251   if (len > INT_MAX / static_cast<int>(sizeof(wchar_t)))
 252     return false;
 253   if (!IteratorHasRoomFor(*iter, len * sizeof(wchar_t)))
 254     return false;
 255
 256   wchar_t* chars = reinterpret_cast<wchar_t*>(*iter);
 257   result->assign(chars, len);
 258
 259   UpdateIter(iter, len * sizeof(wchar_t));
 260   return true;
 261 }
 262
 263 bool Pickle::ReadString16(void** iter, string16* result) const {
 264   DCHECK(iter);
 265
 266   int len;
 267   if (!ReadLength(iter, &len))
 268     return false;
 269   if (!IteratorHasRoomFor(*iter, len * sizeof(char16)))
 270     return false;
 271
 272   char16* chars = reinterpret_cast<char16*>(*iter);
 273   result->assign(chars, len);
 274
 275   UpdateIter(iter, len * sizeof(char16));
 276   return true;
 277 }
 278 */
 279
 280 bool Pickle::ReadData(void** iter, const char** data, int* length) const {
 281   DCHECK(iter);
 282   DCHECK(data);
 283   DCHECK(length);
 284   *length = 0;
 285   *data = 0;
 286
 287   if (!ReadLength(iter, length))
 288     return false;
 289
 290   return ReadBytes(iter, data, *length);
 291 }
 292
 293 bool Pickle::ReadBytes(void** iter, const char** data, int length) const {
 294   DCHECK(iter);
 295   DCHECK(data);
 296   *data = 0;
 297   if (!*iter)
 298     *iter = const_cast<char*>(payload());
 299
 300   if (!IteratorHasRoomFor(*iter, length))
 301     return false;
 302
 303   *data = reinterpret_cast<const char*>(*iter);
 304
 305   UpdateIter(iter, length);
 306   return true;
 307 }
 308
 309 bool Pickle::ReadLength(void** iter, int* result) const {
 310   if (!ReadInt(iter, result))
 311     return false;
 312   return ((*result) >= 0);
 313 }
 314
 315
 316 bool Pickle::WriteString(const std::string& value) {
 317   if (!WriteInt(static_cast<int>(value.size())))
 318     return false;
 319
 320   return WriteBytes(value.data(), static_cast<int>(value.size()));
 321 }
 322
 323 /*
 324 bool Pickle::WriteWString(const std::wstring& value) {
 325   if (!WriteInt(static_cast<int>(value.size())))
 326     return false;
 327
 328   return WriteBytes(value.data(),
 329                     static_cast<int>(value.size() * sizeof(wchar_t)));
 330 }
 331
 332 bool Pickle::WriteString16(const string16& value) {
 333   if (!WriteInt(static_cast<int>(value.size())))
 334     return false;
 335
 336   return WriteBytes(value.data(),
 337                     static_cast<int>(value.size()) * sizeof(char16));
 338 }
 339 */
 340
 341 bool Pickle::WriteData(const char* data, int length) {
 342   return length >= 0 && WriteInt(length) && WriteBytes(data, length);
 343 }
 344
 345 bool Pickle::WriteBytes(const void* data, int data_len) {
 346   DCHECK_NE(kCapacityReadOnly, capacity_) << "oops: pickle is readonly";
 347
 348   char* dest = BeginWrite(data_len);
 349   if (!dest)
 350     return false;
 351
 352   memcpy(dest, data, data_len);
 353
 354   EndWrite(dest, data_len);
 355   return true;
 356 }
 357
 358 char* Pickle::BeginWriteData(int length) {
 359   DCHECK_EQ(variable_buffer_offset_, 0U) <<
 360     "There can only be one variable buffer in a Pickle";
 361
 362   if (length < 0 || !WriteInt(length))
 363     return NULL;
 364
 365   char *data_ptr = BeginWrite(length);
 366   if (!data_ptr)
 367     return NULL;
 368
 369   variable_buffer_offset_ =
 370       data_ptr - reinterpret_cast<char*>(header_) - sizeof(int);
 371
 372   // EndWrite doesn't necessarily have to be called after the write operation,
 373   // so we call it here to pad out what the caller will eventually write.
 374   EndWrite(data_ptr, length);
 375   return data_ptr;
 376 }
 377
 378 void Pickle::TrimWriteData(int new_length) {
 379   DCHECK_NE(variable_buffer_offset_, 0U);
 380
 381   // Fetch the the variable buffer size
 382   int* cur_length = reinterpret_cast<int*>(
 383       reinterpret_cast<char*>(header_) + variable_buffer_offset_);
 384
 385   if (new_length < 0 || new_length > *cur_length) {
 386     NOTREACHED() << "Invalid length in TrimWriteData.";
 387     return;
 388   }
 389
 390   // Update the payload size and variable buffer size
 391   header_->payload_size -= (*cur_length - new_length);
 392   *cur_length = new_length;
 393 }
 394
 395 char* Pickle::BeginWrite(size_t length) {
 396   // write at a uint32-aligned offset from the beginning of the header
 397   size_t offset = AlignInt(header_->payload_size, sizeof(uint32));
 398
 399   size_t new_size = offset + length;
 400   size_t needed_size = header_size_ + new_size;
 401   if (needed_size > capacity_ && !Resize(std::max(capacity_ * 2, needed_size)))
 402     return NULL;
 403
 404 #ifdef ARCH_CPU_64_BITS
 405   DCHECK_LE(length, std::numeric_limits<uint32>::max());
 406 #endif
 407
 408   header_->payload_size = static_cast<uint32>(new_size);
 409   return payload() + offset;
 410 }
 411
 412 void Pickle::EndWrite(char* dest, int length) {
 413   // Zero-pad to keep tools like purify from complaining about uninitialized
 414   // memory.
 415   if (length % sizeof(uint32))
 416     memset(dest + length, 0, sizeof(uint32) - (length % sizeof(uint32)));
 417 }
 418
 419 bool Pickle::Resize(size_t new_capacity) {
 420   new_capacity = AlignInt(new_capacity, kPayloadUnit);
 421
 422   CHECK_NE(capacity_, kCapacityReadOnly);
 423   void* p = realloc(header_, new_capacity);
 424   if (!p)
 425     return false;
 426
 427   header_ = reinterpret_cast<Header*>(p);
 428   capacity_ = new_capacity;
 429   return true;
 430 }
 431
 432 // static
 433 const char* Pickle::FindNext(size_t header_size,
 434                              const char* start,
 435                              const char* end) {
 436   DCHECK_EQ(header_size, AlignInt(header_size, sizeof(uint32)));
 437   DCHECK_LE(header_size, static_cast<size_t>(kPayloadUnit));
 438
 439   if (static_cast<size_t>(end - start) < sizeof(Header))
 440     return NULL;
 441
 442   const Header* hdr = reinterpret_cast<const Header*>(start);
 443   const char* payload_base = start + header_size;
 444   const char* payload_end = payload_base + hdr->payload_size;
 445   if (payload_end < payload_base)
 446     return NULL;
 447
 448   return (payload_end > end) ? NULL : payload_end;
 449 }