1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*
* Copyright (c) 2012 ARM Limited
* All rights reserved
*
* The license below extends only to copyright in the software and shall
* not be construed as granting a license to any other intellectual
* property including but not limited to intellectual property relating
* to a hardware implementation of the functionality of the software
* licensed hereunder. You may use the software subject to the license
* terms below provided that you ensure that this notice is replicated
* unmodified and in its entirety in all distributions of the software,
* modified or unmodified, in source code or in binary form.
*
* 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 the copyright holders 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.
*
* Authors: Andreas Hansson
*/
/**
* @file
* Declaration of a wrapper for protobuf output streams and input streams.
*/
#ifndef __PROTO_PROTOIO_HH__
#define __PROTO_PROTOIO_HH__
#include <google/protobuf/io/coded_stream.h>
#include <google/protobuf/io/gzip_stream.h>
#include <google/protobuf/io/zero_copy_stream_impl.h>
#include <google/protobuf/message.h>
#include <fstream>
/**
* A ProtoStream provides the shared functionality of the input and
* output streams. At the moment this is limited to magic number.
*/
class ProtoStream
{
protected:
/// Use the ASCII characters gem5 as our magic number
static const uint32_t magicNumber = 0x356d6567;
/**
* Create a ProtoStream.
*/
ProtoStream() {}
private:
/**
* Hide the copy constructor and assignment operator.
* @{
*/
ProtoStream(const ProtoStream&);
ProtoStream& operator=(const ProtoStream&);
/** @} */
};
/**
* A ProtoOutputStream wraps a coded stream, potentially with
* compression, based on looking at the file name. Writing to the
* stream is done to enable interaction with the file on a per-message
* basis to avoid having to deal with huge data structures. The latter
* is made possible by encoding the length of each message in the
* stream.
*/
class ProtoOutputStream : public ProtoStream
{
public:
/**
* Create an output stream for a given file name. If the filename
* ends with .gz then the file will be compressed accordinly.
*
* @param filename Path to the file to create or truncate
*/
ProtoOutputStream(const std::string& filename);
/**
* Destruct the output stream, and also flush and close the
* underlying file streams and coded streams.
*/
~ProtoOutputStream();
/**
* Write a message to the stream, preprending it with the message
* size.
*
* @param msg Message to write to the stream
*/
void write(const google::protobuf::Message& msg);
private:
/// Underlying file output stream
std::ofstream fileStream;
/// Zero Copy stream wrapping the STL output stream
google::protobuf::io::OstreamOutputStream* zeroCopyStream;
/// Optional Gzip stream to wrap the Zero Copy stream
google::protobuf::io::GzipOutputStream* gzipStream;
/// Top-level coded stream that messages are written to
google::protobuf::io::CodedOutputStream* codedStream;
};
/**
* A ProtoInputStream wraps a coded stream, potentially with
* decompression, based on looking at the file name. Reading from the
* stream is done on a per-message basis to avoid having to deal with
* huge data structures. The latter assumes the length of each message
* is encoded in the stream when it is written.
*/
class ProtoInputStream : public ProtoStream
{
public:
/**
* Create an input stream for a given file name. If the filename
* ends with .gz then the file will be decompressed accordingly.
*
* @param filename Path to the file to read from
*/
ProtoInputStream(const std::string& filename);
/**
* Destruct the input stream, and also close the underlying file
* streams and coded streams.
*/
~ProtoInputStream();
/**
* Read a message from the stream.
*
* @param msg Message read from the stream
* @param return True if a message was read, false if reading fails
*/
bool read(google::protobuf::Message& msg);
/**
* Reset the input stream and seek to the beginning of the file.
*/
void reset();
private:
/**
* Create the internal streams that are wrapping the input file.
*/
void createStreams();
/**
* Destroy the internal streams that are wrapping the input file.
*/
void destroyStreams();
/// Underlying file input stream
std::ifstream fileStream;
/// Hold on to the file name for debug messages
const std::string fileName;
/// Boolean flag to remember whether we use gzip or not
bool useGzip;
/// Zero Copy stream wrapping the STL input stream
google::protobuf::io::IstreamInputStream* zeroCopyStream;
/// Optional Gzip stream to wrap the Zero Copy stream
google::protobuf::io::GzipInputStream* gzipStream;
/// Top-level coded stream that messages are read from
google::protobuf::io::CodedInputStream* codedStream;
};
#endif //__PROTO_PROTOIO_HH
|
