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

Generated on Thu Jul 28 2022 13:32:36 for gem5 by doxygen 1.8.17