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
|
// Copyright 2020 The Pigweed Authors
//
// 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
//
// https://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.
// clang-format off
#include "pw_rpc/internal/log_config.h" // PW_LOG_* macros must be first.
#include "pw_rpc/server.h"
// clang-format on
#include <algorithm>
#include "pw_log/log.h"
#include "pw_rpc/internal/endpoint.h"
#include "pw_rpc/internal/packet.h"
#include "pw_rpc/service_id.h"
namespace pw::rpc {
namespace {
using internal::Packet;
using internal::pwpb::PacketType;
} // namespace
Status Server::ProcessPacket(ConstByteSpan packet_data) {
PW_TRY_ASSIGN(Packet packet,
Endpoint::ProcessPacket(packet_data, Packet::kServer));
internal::rpc_lock().lock();
// Verbose log for debugging.
// PW_LOG_DEBUG("RPC server received packet type %u for %u:%08x/%08x",
// static_cast<unsigned>(packet.type()),
// static_cast<unsigned>(packet.channel_id()),
// static_cast<unsigned>(packet.service_id()),
// static_cast<unsigned>(packet.method_id()));
internal::Channel* channel = GetInternalChannel(packet.channel_id());
if (channel == nullptr) {
internal::rpc_lock().unlock();
PW_LOG_WARN("RPC server received packet for unknown channel %u",
static_cast<unsigned>(packet.channel_id()));
return Status::Unavailable();
}
const auto [service, method] = FindMethod(packet);
if (method == nullptr) {
// Don't send responses to errors to avoid infinite error cycles.
if (packet.type() != PacketType::CLIENT_ERROR) {
channel->Send(Packet::ServerError(packet, Status::NotFound()))
.IgnoreError();
}
internal::rpc_lock().unlock();
PW_LOG_DEBUG("Received packet on channel %u for unknown RPC %08x/%08x",
static_cast<unsigned>(packet.channel_id()),
static_cast<unsigned>(packet.service_id()),
static_cast<unsigned>(packet.method_id()));
return OkStatus(); // OK since the packet was handled.
}
// Handle request packets separately to avoid an unnecessary call lookup. The
// Call constructor looks up and cancels any duplicate calls.
if (packet.type() == PacketType::REQUEST) {
const internal::CallContext context(
*this, packet.channel_id(), *service, *method, packet.call_id());
method->Invoke(context, packet);
return OkStatus();
}
IntrusiveList<internal::Call>::iterator call = FindCall(packet);
switch (packet.type()) {
case PacketType::CLIENT_STREAM:
HandleClientStreamPacket(packet, *channel, call);
break;
case PacketType::CLIENT_ERROR:
if (call != calls_end()) {
call->HandleError(packet.status());
} else {
internal::rpc_lock().unlock();
}
break;
case PacketType::CLIENT_STREAM_END:
HandleClientStreamPacket(packet, *channel, call);
break;
case PacketType::REQUEST: // Handled above
case PacketType::RESPONSE:
case PacketType::SERVER_ERROR:
case PacketType::SERVER_STREAM:
default:
internal::rpc_lock().unlock();
PW_LOG_WARN("pw_rpc server unable to handle packet of type %u",
unsigned(packet.type()));
}
return OkStatus(); // OK since the packet was handled
}
std::tuple<Service*, const internal::Method*> Server::FindMethod(
const internal::Packet& packet) {
// Packets always include service and method IDs.
auto service = std::find_if(services_.begin(), services_.end(), [&](auto& s) {
return internal::UnwrapServiceId(s.service_id()) == packet.service_id();
});
if (service == services_.end()) {
return {};
}
return {&(*service), service->FindMethod(packet.method_id())};
}
void Server::HandleClientStreamPacket(
const internal::Packet& packet,
internal::Channel& channel,
IntrusiveList<internal::Call>::iterator call) const {
if (call == calls_end()) {
channel.Send(Packet::ServerError(packet, Status::FailedPrecondition()))
.IgnoreError(); // Errors are logged in Channel::Send.
internal::rpc_lock().unlock();
PW_LOG_DEBUG(
"Received client stream packet for %u:%08x/%08x, which is not pending",
static_cast<unsigned>(packet.channel_id()),
static_cast<unsigned>(packet.service_id()),
static_cast<unsigned>(packet.method_id()));
return;
}
if (!call->has_client_stream()) {
channel.Send(Packet::ServerError(packet, Status::InvalidArgument()))
.IgnoreError(); // Errors are logged in Channel::Send.
internal::rpc_lock().unlock();
PW_LOG_DEBUG(
"Received client stream packet for %u:%08x/%08x, which doesn't have a "
"client stream",
static_cast<unsigned>(packet.channel_id()),
static_cast<unsigned>(packet.service_id()),
static_cast<unsigned>(packet.method_id()));
return;
}
if (!call->client_stream_open()) {
channel.Send(Packet::ServerError(packet, Status::FailedPrecondition()))
.IgnoreError(); // Errors are logged in Channel::Send.
internal::rpc_lock().unlock();
PW_LOG_DEBUG(
"Received client stream packet for %u:%08x/%08x, but its client stream "
"is closed",
static_cast<unsigned>(packet.channel_id()),
static_cast<unsigned>(packet.service_id()),
static_cast<unsigned>(packet.method_id()));
return;
}
if (packet.type() == PacketType::CLIENT_STREAM) {
call->HandlePayload(packet.payload());
} else { // Handle PacketType::CLIENT_STREAM_END.
static_cast<internal::ServerCall&>(*call).HandleClientStreamEnd();
}
}
} // namespace pw::rpc
|
