gem5  v21.1.0.2
protoio.cc
Go to the documentation of this file.
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 
38 #include "proto/protoio.hh"
39 
40 #include "base/logging.hh"
41 
42 using namespace google::protobuf;
43 
44 ProtoOutputStream::ProtoOutputStream(const std::string& filename) :
45  fileStream(filename.c_str(),
46  std::ios::out | std::ios::binary | std::ios::trunc),
47  wrappedFileStream(NULL), gzipStream(NULL), zeroCopyStream(NULL)
48 {
49  if (!fileStream.good())
50  panic("Could not open %s for writing\n", filename);
51 
52  // Wrap the output file in a zero copy stream, that in turn is
53  // wrapped in a gzip stream if the filename ends with .gz. The
54  // latter stream is in turn wrapped in a coded stream
55  wrappedFileStream = new io::OstreamOutputStream(&fileStream);
56  if (filename.find_last_of('.') != string::npos &&
57  filename.substr(filename.find_last_of('.') + 1) == "gz") {
58  gzipStream = new io::GzipOutputStream(wrappedFileStream);
60  } else {
62  }
63 
64  // Write the magic number to the file
65  io::CodedOutputStream codedStream(zeroCopyStream);
66  codedStream.WriteLittleEndian32(magicNumber);
67 
68  // Note that each type of stream (packet, instruction etc) should
69  // add its own header and perform the appropriate checks
70 }
71 
73 {
74  // As the compression is optional, see if the stream exists
75  if (gzipStream != NULL)
76  delete gzipStream;
77  delete wrappedFileStream;
78  fileStream.close();
79 }
80 
81 void
82 ProtoOutputStream::write(const Message& msg)
83 {
84  // Due to the byte limit of the coded stream we create it for
85  // every single mesage (based on forum discussions around the size
86  // limitation)
87  io::CodedOutputStream codedStream(zeroCopyStream);
88 
89  // Write the size of the message to the stream
90 # if GOOGLE_PROTOBUF_VERSION < 3001000
91  auto msg_size = msg.ByteSize();
92 # else
93  auto msg_size = msg.ByteSizeLong();
94 # endif
95  codedStream.WriteVarint32(msg_size);
96 
97  // Write the message itself to the stream
98  msg.SerializeWithCachedSizes(&codedStream);
99 }
100 
101 ProtoInputStream::ProtoInputStream(const std::string& filename) :
102  fileStream(filename.c_str(), std::ios::in | std::ios::binary),
103  fileName(filename), useGzip(false),
104  wrappedFileStream(NULL), gzipStream(NULL), zeroCopyStream(NULL)
105 {
106  if (!fileStream.good())
107  panic("Could not open %s for reading\n", filename);
108 
109  // check the magic number to see if this is a gzip stream
110  unsigned char bytes[2];
111  fileStream.read((char*) bytes, 2);
112  useGzip = fileStream.good() && bytes[0] == 0x1f && bytes[1] == 0x8b;
113 
114  // seek to the start of the input file and clear any flags
115  fileStream.clear();
116  fileStream.seekg(0, std::ifstream::beg);
117 
118  createStreams();
119 }
120 
121 void
123 {
124  // All streams should be NULL at this point
125  assert(wrappedFileStream == NULL && gzipStream == NULL &&
126  zeroCopyStream == NULL);
127 
128  // Wrap the input file in a zero copy stream, that in turn is
129  // wrapped in a gzip stream if the filename ends with .gz. The
130  // latter stream is in turn wrapped in a coded stream
131  wrappedFileStream = new io::IstreamInputStream(&fileStream);
132  if (useGzip) {
133  gzipStream = new io::GzipInputStream(wrappedFileStream);
135  } else {
137  }
138 
139  uint32_t magic_check;
140  io::CodedInputStream codedStream(zeroCopyStream);
141  if (!codedStream.ReadLittleEndian32(&magic_check) ||
142  magic_check != magicNumber)
143  panic("Input file %s is not a valid gem5 proto format.\n",
144  fileName);
145 }
146 
147 void
149 {
150  // As the compression is optional, see if the stream exists
151  if (gzipStream != NULL) {
152  delete gzipStream;
153  gzipStream = NULL;
154  }
155  delete wrappedFileStream;
156  wrappedFileStream = NULL;
157 
158  zeroCopyStream = NULL;
159 }
160 
161 
163 {
164  destroyStreams();
165  fileStream.close();
166 }
167 
168 
169 void
171 {
172  destroyStreams();
173  // seek to the start of the input file and clear any flags
174  fileStream.clear();
175  fileStream.seekg(0, std::ifstream::beg);
176  createStreams();
177 }
178 
179 bool
181 {
182  // Read a message from the stream by getting the size, using it as
183  // a limit when parsing the message, then popping the limit again
184  uint32_t size;
185 
186  // Due to the byte limit of the coded stream we create it for
187  // every single mesage (based on forum discussions around the size
188  // limitation)
189  io::CodedInputStream codedStream(zeroCopyStream);
190  if (codedStream.ReadVarint32(&size)) {
191  io::CodedInputStream::Limit limit = codedStream.PushLimit(size);
192  if (msg.ParseFromCodedStream(&codedStream)) {
193  codedStream.PopLimit(limit);
194  // All went well, the message is parsed and the limit is
195  // popped again
196  return true;
197  } else {
198  panic("Unable to read message from coded stream %s\n",
199  fileName);
200  }
201  }
202 
203  return false;
204 }
ProtoOutputStream::write
void write(const google::protobuf::Message &msg)
Write a message to the stream, preprending it with the message size.
Definition: protoio.cc:82
ProtoOutputStream::zeroCopyStream
google::protobuf::io::ZeroCopyOutputStream * zeroCopyStream
Top-level zero-copy stream, either with compression or not.
Definition: protoio.hh:129
ProtoInputStream::useGzip
bool useGzip
Boolean flag to remember whether we use gzip or not.
Definition: protoio.hh:191
ProtoInputStream::read
bool read(google::protobuf::Message &msg)
Read a message from the stream.
Definition: protoio.cc:180
ProtoInputStream::wrappedFileStream
google::protobuf::io::IstreamInputStream * wrappedFileStream
Zero Copy stream wrapping the STL input stream.
Definition: protoio.hh:194
protoio.hh
ProtoInputStream::~ProtoInputStream
~ProtoInputStream()
Destruct the input stream, and also close the underlying file streams and coded streams.
Definition: protoio.cc:162
ProtoInputStream::gzipStream
google::protobuf::io::GzipInputStream * gzipStream
Optional Gzip stream to wrap the Zero Copy stream.
Definition: protoio.hh:197
ProtoOutputStream::wrappedFileStream
google::protobuf::io::OstreamOutputStream * wrappedFileStream
Zero Copy stream wrapping the STL output stream.
Definition: protoio.hh:123
gem5::X86ISA::limit
BitfieldType< SegDescriptorLimit > limit
Definition: misc.hh:930
ProtoOutputStream::ProtoOutputStream
ProtoOutputStream(const std::string &filename)
Create an output stream for a given file name.
Definition: protoio.cc:44
ProtoInputStream::zeroCopyStream
google::protobuf::io::ZeroCopyInputStream * zeroCopyStream
Top-level zero-copy stream, either with compression or not.
Definition: protoio.hh:200
ProtoInputStream::fileName
const std::string fileName
Hold on to the file name for debug messages.
Definition: protoio.hh:188
ProtoInputStream::fileStream
std::ifstream fileStream
Underlying file input stream.
Definition: protoio.hh:185
ProtoStream::magicNumber
static const uint32_t magicNumber
Use the ASCII characters gem5 as our magic number.
Definition: protoio.hh:64
ProtoOutputStream::fileStream
std::ofstream fileStream
Underlying file output stream.
Definition: protoio.hh:120
ProtoOutputStream::gzipStream
google::protobuf::io::GzipOutputStream * gzipStream
Optional Gzip stream to wrap the Zero Copy stream.
Definition: protoio.hh:126
std
Overload hash function for BasicBlockRange type.
Definition: types.hh:111
ProtoInputStream::createStreams
void createStreams()
Create the internal streams that are wrapping the input file.
Definition: protoio.cc:122
logging.hh
ProtoInputStream::destroyStreams
void destroyStreams()
Destroy the internal streams that are wrapping the input file.
Definition: protoio.cc:148
ProtoOutputStream::~ProtoOutputStream
~ProtoOutputStream()
Destruct the output stream, and also flush and close the underlying file streams and coded streams.
Definition: protoio.cc:72
ProtoInputStream::reset
void reset()
Reset the input stream and seek to the beginning of the file.
Definition: protoio.cc:170
ProtoInputStream::ProtoInputStream
ProtoInputStream(const std::string &filename)
Create an input stream for a given file name.
Definition: protoio.cc:101
panic
#define panic(...)
This implements a cprintf based panic() function.
Definition: logging.hh:177

Generated on Tue Sep 21 2021 12:25:47 for gem5 by doxygen 1.8.17