gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
protoio.hh
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  * Authors: Andreas Hansson
38  */
39 
40 
46 #ifndef __PROTO_PROTOIO_HH__
47 #define __PROTO_PROTOIO_HH__
48 
49 #include <google/protobuf/io/coded_stream.h>
50 #include <google/protobuf/io/gzip_stream.h>
51 #include <google/protobuf/io/zero_copy_stream_impl.h>
52 #include <google/protobuf/message.h>
53 
54 #include <fstream>
55 
61 {
62 
63  protected:
64 
66  static const uint32_t magicNumber = 0x356d6567;
67 
72 
73  private:
74 
79  ProtoStream(const ProtoStream&);
82 };
83 
93 {
94 
95  public:
96 
103  ProtoOutputStream(const std::string& filename);
104 
110 
117  void write(const google::protobuf::Message& msg);
118 
119  private:
120 
122  std::ofstream fileStream;
123 
125  google::protobuf::io::OstreamOutputStream* wrappedFileStream;
126 
128  google::protobuf::io::GzipOutputStream* gzipStream;
129 
131  google::protobuf::io::ZeroCopyOutputStream* zeroCopyStream;
132 
133 };
134 
143 {
144 
145  public:
146 
153  ProtoInputStream(const std::string& filename);
154 
160 
167  bool read(google::protobuf::Message& msg);
168 
172  void reset();
173 
174  private:
175 
179  void createStreams();
180 
184  void destroyStreams();
185 
187  std::ifstream fileStream;
188 
190  const std::string fileName;
191 
193  bool useGzip;
194 
196  google::protobuf::io::IstreamInputStream* wrappedFileStream;
197 
199  google::protobuf::io::GzipInputStream* gzipStream;
200 
202  google::protobuf::io::ZeroCopyInputStream* zeroCopyStream;
203 
204 };
205 
206 #endif //__PROTO_PROTOIO_HH
A ProtoOutputStream wraps a coded stream, potentially with compression, based on looking at the file ...
Definition: protoio.hh:92
google::protobuf::io::IstreamInputStream * wrappedFileStream
Zero Copy stream wrapping the STL input stream.
Definition: protoio.hh:196
void write(const google::protobuf::Message &msg)
Write a message to the stream, preprending it with the message size.
Definition: protoio.cc:84
google::protobuf::io::OstreamOutputStream * wrappedFileStream
Zero Copy stream wrapping the STL output stream.
Definition: protoio.hh:125
bool read(google::protobuf::Message &msg)
Read a message from the stream.
Definition: protoio.cc:177
~ProtoInputStream()
Destruct the input stream, and also close the underlying file streams and coded streams.
Definition: protoio.cc:159
ProtoOutputStream(const std::string &filename)
Create an output stream for a given file name.
Definition: protoio.cc:47
google::protobuf::io::ZeroCopyInputStream * zeroCopyStream
Top-level zero-copy stream, either with compression or not.
Definition: protoio.hh:202
bool useGzip
Boolean flag to remember whether we use gzip or not.
Definition: protoio.hh:193
void destroyStreams()
Destroy the internal streams that are wrapping the input file.
Definition: protoio.cc:145
A ProtoInputStream wraps a coded stream, potentially with decompression, based on looking at the file...
Definition: protoio.hh:142
ProtoStream()
Create a ProtoStream.
Definition: protoio.hh:71
void reset()
Reset the input stream and seek to the beginning of the file.
Definition: protoio.cc:167
ProtoInputStream(const std::string &filename)
Create an input stream for a given file name.
Definition: protoio.cc:98
google::protobuf::io::GzipInputStream * gzipStream
Optional Gzip stream to wrap the Zero Copy stream.
Definition: protoio.hh:199
std::ifstream fileStream
Underlying file input stream.
Definition: protoio.hh:187
std::ofstream fileStream
Underlying file output stream.
Definition: protoio.hh:122
ProtoStream & operator=(const ProtoStream &)
static const uint32_t magicNumber
Use the ASCII characters gem5 as our magic number.
Definition: protoio.hh:66
const std::string fileName
Hold on to the file name for debug messages.
Definition: protoio.hh:190
void createStreams()
Create the internal streams that are wrapping the input file.
Definition: protoio.cc:119
google::protobuf::io::GzipOutputStream * gzipStream
Optional Gzip stream to wrap the Zero Copy stream.
Definition: protoio.hh:128
~ProtoOutputStream()
Destruct the output stream, and also flush and close the underlying file streams and coded streams...
Definition: protoio.cc:74
google::protobuf::io::ZeroCopyOutputStream * zeroCopyStream
Top-level zero-copy stream, either with compression or not.
Definition: protoio.hh:131
A ProtoStream provides the shared functionality of the input and output streams.
Definition: protoio.hh:60

Generated on Fri Jun 9 2017 13:03:51 for gem5 by doxygen 1.8.6