protoio.cc revision 9397:6e6b8d8ab258 
1/*
2 * Copyright (c) 2012 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: Andreas Hansson
38 */
39
40#include "base/misc.hh"
41#include "proto/protoio.hh"
42
43using namespace std;
44using namespace google::protobuf;
45
46ProtoOutputStream::ProtoOutputStream(const string& filename) :
47    fileStream(filename.c_str(), ios::out | ios::binary | ios::trunc),
48    zeroCopyStream(NULL), gzipStream(NULL), codedStream(NULL)
49{
50    if (!fileStream.good())
51        panic("Could not open %s for writing\n", filename);
52
53    // Wrap the output file in a zero copy stream, that in turn is
54    // wrapped in a gzip stream if the filename ends with .gz. The
55    // latter stream is in turn wrapped in a coded stream
56    zeroCopyStream = new io::OstreamOutputStream(&fileStream);
57    if (filename.find_last_of('.') != string::npos &&
58        filename.substr(filename.find_last_of('.') + 1) == "gz") {
59        gzipStream = new io::GzipOutputStream(zeroCopyStream);
60        codedStream = new io::CodedOutputStream(gzipStream);
61    } else {
62        codedStream = new io::CodedOutputStream(zeroCopyStream);
63    }
64
65    // Use the ASCII characters gem5 as our magic number and write it
66    // to the file
67    const uint32_t magic_number = 0x356d6567;
68    codedStream->WriteLittleEndian32(magic_number);
69
70    // Note that each type of stream (packet, instruction etc) should
71    // add its own header and perform the appropriate checks
72}
73
74ProtoOutputStream::~ProtoOutputStream()
75{
76    delete codedStream;
77    // As the compression is optional, see if the stream exists
78    if (gzipStream != NULL)
79        delete gzipStream;
80    delete zeroCopyStream;
81    fileStream.close();
82}
83
84void
85ProtoOutputStream::write(const Message& msg)
86{
87    // Write the size of the message to the stream
88    codedStream->WriteVarint32(msg.ByteSize());
89
90    // Write the message itself to the stream
91    if (!msg.SerializeToCodedStream(codedStream))
92        panic("Unable to write message to coded stream\n");
93}
94