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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/*
* Copyright (C) 2017 The Android Open Source Project
*
* 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 <cinttypes>
#include <type_traits>
#include "chre/core/event_loop_manager.h"
#include "chre/core/host_comms_manager.h"
#include "chre/platform/assert.h"
#include "chre/platform/host_link.h"
namespace chre {
constexpr uint32_t kMessageToHostReservedFieldValue = UINT32_MAX;
void HostCommsManager::flushMessagesSentByNanoapp(uint64_t appId) {
mHostLink.flushMessagesSentByNanoapp(appId);
}
void HostCommsManager::sendLogMessage(const char *logMessage,
size_t logMessageSize) {
mHostLink.sendLogMessage(logMessage, logMessageSize);
}
bool HostCommsManager::sendMessageToHostFromNanoapp(
Nanoapp *nanoapp, void *messageData, size_t messageSize,
uint32_t messageType, uint16_t hostEndpoint,
chreMessageFreeFunction *freeCallback) {
bool success = false;
if (messageSize > 0 && messageData == nullptr) {
LOGW("Rejecting malformed message (null data but non-zero size)");
} else if (messageSize > CHRE_MESSAGE_TO_HOST_MAX_SIZE) {
LOGW("Rejecting message of size %zu bytes (max %d)", messageSize,
CHRE_MESSAGE_TO_HOST_MAX_SIZE);
} else if (hostEndpoint == kHostEndpointUnspecified) {
LOGW("Rejecting message to invalid host endpoint");
} else {
MessageToHost *msgToHost = mMessagePool.allocate();
if (msgToHost == nullptr) {
LOG_OOM();
} else {
msgToHost->appId = nanoapp->getAppId();
msgToHost->message.wrap(static_cast<uint8_t *>(messageData), messageSize);
msgToHost->toHostData.hostEndpoint = hostEndpoint;
msgToHost->toHostData.messageType = messageType;
msgToHost->toHostData.nanoappFreeFunction = freeCallback;
// Populate a special value to help disambiguate message direction when
// debugging
msgToHost->toHostData.reserved = kMessageToHostReservedFieldValue;
// Let the nanoapp know that it woke up the host and record it
bool hostWasAwake = EventLoopManagerSingleton::get()
->getEventLoop()
.getPowerControlManager()
.hostIsAwake();
success = mHostLink.sendMessage(msgToHost);
if (!success) {
mMessagePool.deallocate(msgToHost);
} else if (!hostWasAwake && !mIsNanoappBlamedForWakeup) {
// If message successfully sent and host was suspended before sending
EventLoopManagerSingleton::get()
->getEventLoop()
.handleNanoappWakeupBuckets();
mIsNanoappBlamedForWakeup = true;
nanoapp->blameHostWakeup();
}
}
}
return success;
}
MessageFromHost *HostCommsManager::craftNanoappMessageFromHost(
uint64_t appId, uint16_t hostEndpoint, uint32_t messageType,
const void *messageData, uint32_t messageSize) {
MessageFromHost *msgFromHost = mMessagePool.allocate();
if (msgFromHost == nullptr) {
LOG_OOM();
} else if (!msgFromHost->message.copy_array(
static_cast<const uint8_t *>(messageData), messageSize)) {
LOGE("Couldn't allocate %" PRIu32
" bytes for message data from host "
"(endpoint 0x%" PRIx16 " type %" PRIu32 ")",
messageSize, hostEndpoint, messageType);
mMessagePool.deallocate(msgFromHost);
msgFromHost = nullptr;
} else {
msgFromHost->appId = appId;
msgFromHost->fromHostData.messageType = messageType;
msgFromHost->fromHostData.messageSize = messageSize;
msgFromHost->fromHostData.message = msgFromHost->message.data();
msgFromHost->fromHostData.hostEndpoint = hostEndpoint;
}
return msgFromHost;
}
bool HostCommsManager::deliverNanoappMessageFromHost(
MessageFromHost *craftedMessage) {
const EventLoop &eventLoop = EventLoopManagerSingleton::get()->getEventLoop();
uint32_t targetInstanceId;
bool success = false;
CHRE_ASSERT_LOG(craftedMessage != nullptr,
"Cannot deliver NULL pointer nanoapp message from host");
if (eventLoop.findNanoappInstanceIdByAppId(craftedMessage->appId,
&targetInstanceId)) {
success = true;
if (!EventLoopManagerSingleton::get()->getEventLoop().postEventOrDie(
CHRE_EVENT_MESSAGE_FROM_HOST, &craftedMessage->fromHostData,
freeMessageFromHostCallback, targetInstanceId)) {
mMessagePool.deallocate(craftedMessage);
}
}
return success;
}
void HostCommsManager::sendMessageToNanoappFromHost(uint64_t appId,
uint32_t messageType,
uint16_t hostEndpoint,
const void *messageData,
size_t messageSize) {
if (hostEndpoint == kHostEndpointBroadcast) {
LOGE("Received invalid message from host from broadcast endpoint");
} else if (messageSize > ((UINT32_MAX))) {
// The current CHRE API uses uint32_t to represent the message size in
// struct chreMessageFromHostData. We don't expect to ever need to exceed
// this, but the check ensures we're on the up and up.
LOGE("Rejecting message of size %zu (too big)", messageSize);
} else {
MessageFromHost *craftedMessage = craftNanoappMessageFromHost(
appId, hostEndpoint, messageType, messageData,
static_cast<uint32_t>(messageSize));
if (craftedMessage == nullptr) {
LOGE("Out of memory - rejecting message to app ID 0x%016" PRIx64
"(size %zu)",
appId, messageSize);
} else if (!deliverNanoappMessageFromHost(craftedMessage)) {
LOGD("Deferring message; destination app ID 0x%016" PRIx64
" not found at this time",
appId);
auto deferredMessageCallback = [](uint16_t /*type*/, void *data) {
EventLoopManagerSingleton::get()
->getHostCommsManager()
.sendDeferredMessageToNanoappFromHost(
static_cast<MessageFromHost *>(data));
};
EventLoopManagerSingleton::get()->deferCallback(
SystemCallbackType::DeferredMessageToNanoappFromHost, craftedMessage,
deferredMessageCallback);
}
}
}
void HostCommsManager::sendDeferredMessageToNanoappFromHost(
MessageFromHost *craftedMessage) {
CHRE_ASSERT_LOG(craftedMessage != nullptr,
"Deferred message from host is a NULL pointer");
if (!deliverNanoappMessageFromHost(craftedMessage)) {
LOGE("Dropping deferred message; destination app ID 0x%016" PRIx64
" still not found",
craftedMessage->appId);
mMessagePool.deallocate(craftedMessage);
} else {
LOGD("Deferred message to app ID 0x%016" PRIx64 " delivered",
craftedMessage->appId);
}
}
void HostCommsManager::resetBlameForNanoappHostWakeup() {
mIsNanoappBlamedForWakeup = false;
}
void HostCommsManager::onMessageToHostComplete(const MessageToHost *message) {
// Removing const on message since we own the memory and will deallocate it;
// the caller (HostLink) only gets a const pointer
auto *msgToHost = const_cast<MessageToHost *>(message);
// If there's no free callback, we can free the message right away as the
// message pool is thread-safe; otherwise, we need to do it from within the
// EventLoop context.
if (msgToHost->toHostData.nanoappFreeFunction == nullptr) {
mMessagePool.deallocate(msgToHost);
} else {
auto freeMsgCallback = [](uint16_t /*type*/, void *data) {
EventLoopManagerSingleton::get()->getHostCommsManager().freeMessageToHost(
static_cast<MessageToHost *>(data));
};
EventLoopManagerSingleton::get()->deferCallback(
SystemCallbackType::MessageToHostComplete, msgToHost, freeMsgCallback);
}
}
void HostCommsManager::freeMessageToHost(MessageToHost *msgToHost) {
if (msgToHost->toHostData.nanoappFreeFunction != nullptr) {
EventLoopManagerSingleton::get()->getEventLoop().invokeMessageFreeFunction(
msgToHost->appId, msgToHost->toHostData.nanoappFreeFunction,
msgToHost->message.data(), msgToHost->message.size());
}
mMessagePool.deallocate(msgToHost);
}
void HostCommsManager::freeMessageFromHostCallback(uint16_t /*type*/,
void *data) {
// We pass the chreMessageFromHostData structure to the nanoapp as the event's
// data pointer, but we need to return to the enclosing HostMessage pointer.
// As long as HostMessage is standard-layout, and fromHostData is the first
// field, we can convert between these two pointers via reinterpret_cast.
// These static assertions ensure this assumption is held.
static_assert(std::is_standard_layout<HostMessage>::value,
"HostMessage* is derived from HostMessage::fromHostData*, "
"therefore it must be standard layout");
static_assert(offsetof(MessageFromHost, fromHostData) == 0,
"fromHostData must be the first field in HostMessage");
auto *eventData = static_cast<chreMessageFromHostData *>(data);
auto *msgFromHost = reinterpret_cast<MessageFromHost *>(eventData);
auto &hostCommsMgr = EventLoopManagerSingleton::get()->getHostCommsManager();
hostCommsMgr.mMessagePool.deallocate(msgFromHost);
}
} // namespace chre
|
