Source code
Revision control
Copy as Markdown
Other Tools
// Copyright (c) 2010, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// module_serializer.cc: ModuleSerializer implementation.
//
// See module_serializer.h for documentation.
//
// Author: Siyang Xie (lambxsy@google.com)
#include "processor/module_serializer.h"
#include <map>
#include <string>
#include "processor/basic_code_module.h"
#include "processor/logging.h"
namespace google_breakpad {
// Definition of static member variable in SimplerSerializer<Funcion>, which
// is declared in file "simple_serializer-inl.h"
RangeMapSerializer< MemAddr, linked_ptr<BasicSourceLineResolver::Line> >
SimpleSerializer<BasicSourceLineResolver::Function>::range_map_serializer_;
size_t ModuleSerializer::SizeOf(const BasicSourceLineResolver::Module &module) {
size_t total_size_alloc_ = 0;
// Size of the "is_corrupt" flag.
total_size_alloc_ += SimpleSerializer<bool>::SizeOf(module.is_corrupt_);
// Compute memory size for each map component in Module class.
int map_index = 0;
map_sizes_[map_index++] = files_serializer_.SizeOf(module.files_);
map_sizes_[map_index++] = functions_serializer_.SizeOf(module.functions_);
map_sizes_[map_index++] = pubsym_serializer_.SizeOf(module.public_symbols_);
for (int i = 0; i < WindowsFrameInfo::STACK_INFO_LAST; ++i)
map_sizes_[map_index++] =
wfi_serializer_.SizeOf(&(module.windows_frame_info_[i]));
map_sizes_[map_index++] = cfi_init_rules_serializer_.SizeOf(
module.cfi_initial_rules_);
map_sizes_[map_index++] = cfi_delta_rules_serializer_.SizeOf(
module.cfi_delta_rules_);
// Header size.
total_size_alloc_ += kNumberMaps_ * sizeof(uint32_t);
for (int i = 0; i < kNumberMaps_; ++i) {
total_size_alloc_ += map_sizes_[i];
}
// Extra one byte for null terminator for C-string copy safety.
total_size_alloc_ += SimpleSerializer<char>::SizeOf(0);
return total_size_alloc_;
}
char *ModuleSerializer::Write(const BasicSourceLineResolver::Module &module,
char *dest) {
// Write the is_corrupt flag.
dest = SimpleSerializer<bool>::Write(module.is_corrupt_, dest);
// Write header.
memcpy(dest, map_sizes_, kNumberMaps_ * sizeof(uint32_t));
dest += kNumberMaps_ * sizeof(uint32_t);
// Write each map.
dest = files_serializer_.Write(module.files_, dest);
dest = functions_serializer_.Write(module.functions_, dest);
dest = pubsym_serializer_.Write(module.public_symbols_, dest);
for (int i = 0; i < WindowsFrameInfo::STACK_INFO_LAST; ++i)
dest = wfi_serializer_.Write(&(module.windows_frame_info_[i]), dest);
dest = cfi_init_rules_serializer_.Write(module.cfi_initial_rules_, dest);
dest = cfi_delta_rules_serializer_.Write(module.cfi_delta_rules_, dest);
// Write a null terminator.
dest = SimpleSerializer<char>::Write(0, dest);
return dest;
}
char* ModuleSerializer::Serialize(
const BasicSourceLineResolver::Module &module, unsigned int *size) {
// Compute size of memory to allocate.
unsigned int size_to_alloc = SizeOf(module);
// Allocate memory for serialized data.
char *serialized_data = new char[size_to_alloc];
if (!serialized_data) {
BPLOG(ERROR) << "ModuleSerializer: memory allocation failed, "
<< "size to alloc: " << size_to_alloc;
if (size) *size = 0;
return NULL;
}
// Write serialized data to allocated memory chunk.
char *end_address = Write(module, serialized_data);
// Verify the allocated memory size is equal to the size of data been written.
unsigned int size_written =
static_cast<unsigned int>(end_address - serialized_data);
if (size_to_alloc != size_written) {
BPLOG(ERROR) << "size_to_alloc differs from size_written: "
<< size_to_alloc << " vs " << size_written;
}
// Set size and return the start address of memory chunk.
if (size)
*size = size_to_alloc;
return serialized_data;
}
bool ModuleSerializer::SerializeModuleAndLoadIntoFastResolver(
const BasicSourceLineResolver::ModuleMap::const_iterator &iter,
FastSourceLineResolver *fast_resolver) {
BPLOG(INFO) << "Converting symbol " << iter->first.c_str();
// Cast SourceLineResolverBase::Module* to BasicSourceLineResolver::Module*.
BasicSourceLineResolver::Module* basic_module =
dynamic_cast<BasicSourceLineResolver::Module*>(iter->second);
unsigned int size = 0;
scoped_array<char> symbol_data(Serialize(*basic_module, &size));
if (!symbol_data.get()) {
BPLOG(ERROR) << "Serialization failed for module: " << basic_module->name_;
return false;
}
BPLOG(INFO) << "Serialized Symbol Size " << size;
// Copy the data into string.
// Must pass string to LoadModuleUsingMapBuffer(), instead of passing char* to
// LoadModuleUsingMemoryBuffer(), becaused of data ownership/lifetime issue.
string symbol_data_string(symbol_data.get(), size);
symbol_data.reset();
scoped_ptr<CodeModule> code_module(
new BasicCodeModule(0, 0, iter->first, "", "", "", ""));
return fast_resolver->LoadModuleUsingMapBuffer(code_module.get(),
symbol_data_string);
}
void ModuleSerializer::ConvertAllModules(
const BasicSourceLineResolver *basic_resolver,
FastSourceLineResolver *fast_resolver) {
// Check for NULL pointer.
if (!basic_resolver || !fast_resolver)
return;
// Traverse module list in basic resolver.
BasicSourceLineResolver::ModuleMap::const_iterator iter;
iter = basic_resolver->modules_->begin();
for (; iter != basic_resolver->modules_->end(); ++iter)
SerializeModuleAndLoadIntoFastResolver(iter, fast_resolver);
}
bool ModuleSerializer::ConvertOneModule(
const string &moduleid,
const BasicSourceLineResolver *basic_resolver,
FastSourceLineResolver *fast_resolver) {
// Check for NULL pointer.
if (!basic_resolver || !fast_resolver)
return false;
BasicSourceLineResolver::ModuleMap::const_iterator iter;
iter = basic_resolver->modules_->find(moduleid);
if (iter == basic_resolver->modules_->end())
return false;
return SerializeModuleAndLoadIntoFastResolver(iter, fast_resolver);
}
char* ModuleSerializer::SerializeSymbolFileData(
const string &symbol_data, unsigned int *size) {
scoped_ptr<BasicSourceLineResolver::Module> module(
new BasicSourceLineResolver::Module("no name"));
scoped_array<char> buffer(new char[symbol_data.size() + 1]);
memcpy(buffer.get(), symbol_data.c_str(), symbol_data.size());
buffer.get()[symbol_data.size()] = '\0';
if (!module->LoadMapFromMemory(buffer.get(), symbol_data.size() + 1)) {
return NULL;
}
buffer.reset(NULL);
return Serialize(*(module.get()), size);
}
} // namespace google_breakpad