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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/*
* Copyright (c) 2021 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <hicn/transport/interfaces/socket_consumer.h>
#include <implementation/socket_consumer.h>
#include <protocols/transport_protocol.h>
namespace transport {
namespace protocol {
using namespace interface;
TransportProtocol::TransportProtocol(implementation::ConsumerSocket *icn_socket,
Indexer *indexer, Reassembly *reassembly)
: Protocol(),
socket_(icn_socket),
indexer_verifier_(indexer),
reassembly_(reassembly),
fec_decoder_(nullptr),
is_first_(false),
on_interest_retransmission_(VOID_HANDLER),
on_interest_output_(VOID_HANDLER),
on_interest_timeout_(VOID_HANDLER),
on_interest_satisfied_(VOID_HANDLER),
on_content_object_input_(VOID_HANDLER),
stats_summary_(VOID_HANDLER),
on_fwd_strategy_(VOID_HANDLER),
on_rec_strategy_(VOID_HANDLER),
on_payload_(VOID_HANDLER),
fec_type_(fec::FECType::UNKNOWN) {
socket_->getSocketOption(GeneralTransportOptions::PORTAL, portal_);
socket_->getSocketOption(OtherOptions::STATISTICS, &stats_);
indexer_verifier_->setReassembly(reassembly_.get());
reassembly->setIndexer(indexer_verifier_.get());
}
TransportProtocol::~TransportProtocol() {}
int TransportProtocol::start() {
// If the protocol is already running, return otherwise set as running
if (isRunning()) {
return -1;
}
// Start protocol on its own thread
portal_->getThread().add([this]() {
// Get all callbacks references
socket_->getSocketOption(ConsumerCallbacksOptions::INTEREST_RETRANSMISSION,
&on_interest_retransmission_);
socket_->getSocketOption(ConsumerCallbacksOptions::INTEREST_OUTPUT,
&on_interest_output_);
socket_->getSocketOption(ConsumerCallbacksOptions::INTEREST_EXPIRED,
&on_interest_timeout_);
socket_->getSocketOption(ConsumerCallbacksOptions::INTEREST_SATISFIED,
&on_interest_satisfied_);
socket_->getSocketOption(ConsumerCallbacksOptions::CONTENT_OBJECT_INPUT,
&on_content_object_input_);
socket_->getSocketOption(ConsumerCallbacksOptions::STATS_SUMMARY,
&stats_summary_);
socket_->getSocketOption(ConsumerCallbacksOptions::FWD_STRATEGY_CHANGE,
&on_fwd_strategy_);
socket_->getSocketOption(ConsumerCallbacksOptions::REC_STRATEGY_CHANGE,
&on_rec_strategy_);
socket_->getSocketOption(ConsumerCallbacksOptions::READ_CALLBACK,
&on_payload_);
socket_->getSocketOption(GeneralTransportOptions::ASYNC_MODE, is_async_);
std::string fec_type_str = "";
socket_->getSocketOption(GeneralTransportOptions::FEC_TYPE, fec_type_str);
if (fec_type_str != "") {
fec_type_ = fec::FECUtils::fecTypeFromString(fec_type_str.c_str());
}
// Set it is the first time we schedule an interest
is_first_ = true;
// Reset the protocol state machine
reset();
// Set this transport protocol as portal's consumer callback
portal_->registerTransportCallback(this);
// Schedule next interests
scheduleNextInterests();
is_first_ = false;
// Set the protocol as running
setRunning();
});
return 0;
}
void TransportProtocol::resume() {
if (isRunning()) return;
setRunning();
portal_->getThread().tryRunHandlerNow([this]() { scheduleNextInterests(); });
}
void TransportProtocol::reset() {
reassembly_->reInitialize();
indexer_verifier_->reset();
if (fec_decoder_) {
fec_decoder_->reset();
}
}
void TransportProtocol::onContentReassembled(const std::error_code &ec) {
stop();
if (!on_payload_) {
throw errors::RuntimeException(
"The read callback must be installed in the transport before "
"starting "
"the content retrieval.");
}
if (!ec) {
on_payload_->readSuccess(stats_->getBytesRecv());
} else {
on_payload_->readError(ec);
}
}
void TransportProtocol::sendInterest(
const Name &interest_name,
std::array<uint32_t, MAX_AGGREGATED_INTEREST> *additional_suffixes,
uint32_t len) {
DLOG_IF(INFO, VLOG_IS_ON(3)) << "Sending interest for name " << interest_name;
Packet::Format format;
socket_->getSocketOption(interface::GeneralTransportOptions::PACKET_FORMAT,
format);
auto interest =
core::PacketManager<>::getInstance().getPacket<Interest>(format);
interest->setName(interest_name);
for (uint32_t i = 0; i < len; i++) {
interest->appendSuffix(additional_suffixes->at(i));
}
uint32_t lifetime = default_values::interest_lifetime;
socket_->getSocketOption(GeneralTransportOptions::INTEREST_LIFETIME,
lifetime);
interest->setLifetime(uint32_t(lifetime));
if (*on_interest_output_) {
(*on_interest_output_)(*socket_->getInterface(), *interest);
}
if (TRANSPORT_EXPECT_FALSE(!isRunning() && !is_first_)) {
return;
}
portal_->sendInterest(std::move(interest));
}
void TransportProtocol::onError(const std::error_code &ec) {
// error from portal: stop socket
stop();
// signal error to application
on_payload_->readError(ec);
}
void TransportProtocol::onTimeout(Interest::Ptr &i, const Name &n) {
if (TRANSPORT_EXPECT_FALSE(!isRunning())) {
return;
}
DLOG_IF(INFO, VLOG_IS_ON(3)) << "Timeout on content " << n;
onInterestTimeout(i, n);
}
void TransportProtocol::onContentObject(Interest &i, ContentObject &c) {
// Check whether it makes sense to continue
if (TRANSPORT_EXPECT_FALSE(!isRunning())) {
return;
}
// Call transport protocol function
std::error_code ec;
onContentObjectReceived(i, c, ec);
// Call reassemble function, if packet is eligible for reassemblying
bool reassemble = false;
if (!ec) {
reassemble = true;
}
// Perform verification and update indexer. This step may be performed offline
// - i.e. we may not get a result here (e.g. we use manifest). Verification
// failures in that case will be handled in the onPacketDropped function.
// XXX This step should be done before calling onContentObjectReceived, but
// for now we do it here since currently the indexer does not need manifests
// to move forward.
indexer_verifier_->onContentObject(i, c, reassemble);
}
} // end namespace protocol
} // end namespace transport
|
