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
|
// Copyright (c) 2019, 2021 by Robert Bosch GmbH. All rights reserved.
// Copyright (c) 2020 - 2021 by Apex.AI Inc. All rights reserved.
//
// 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.
//
// SPDX-License-Identifier: Apache-2.0
#include "iceoryx_posh/internal/runtime/ipc_interface_base.hpp"
#include "iceoryx_hoofs/cxx/convert.hpp"
#include "iceoryx_hoofs/error_handling/error_handling.hpp"
#include "iceoryx_hoofs/internal/posix_wrapper/message_queue.hpp"
#include "iceoryx_posh/internal/log/posh_logging.hpp"
#include "iceoryx_posh/internal/runtime/ipc_message.hpp"
#include <thread>
namespace iox
{
namespace runtime
{
IpcMessageType stringToIpcMessageType(const char* str) noexcept
{
std::underlying_type<IpcMessageType>::type msg;
bool noError = cxx::convert::stringIsNumber(str, cxx::convert::NumberType::INTEGER);
noError &= noError ? (cxx::convert::fromString(str, msg)) : false;
noError &= noError ? !(static_cast<std::underlying_type<IpcMessageType>::type>(IpcMessageType::BEGIN) >= msg
|| static_cast<std::underlying_type<IpcMessageType>::type>(IpcMessageType::END) <= msg)
: false;
return noError ? (static_cast<IpcMessageType>(msg)) : IpcMessageType::NOTYPE;
}
std::string IpcMessageTypeToString(const IpcMessageType msg) noexcept
{
return cxx::convert::toString(static_cast<std::underlying_type<IpcMessageType>::type>(msg));
}
IpcMessageErrorType stringToIpcMessageErrorType(const char* str) noexcept
{
std::underlying_type<IpcMessageErrorType>::type msg;
bool noError = cxx::convert::stringIsNumber(str, cxx::convert::NumberType::INTEGER);
noError &= noError ? (cxx::convert::fromString(str, msg)) : false;
noError &= noError
? !(static_cast<std::underlying_type<IpcMessageErrorType>::type>(IpcMessageErrorType::BEGIN) >= msg
|| static_cast<std::underlying_type<IpcMessageErrorType>::type>(IpcMessageErrorType::END) <= msg)
: false;
return noError ? (static_cast<IpcMessageErrorType>(msg)) : IpcMessageErrorType::NOTYPE;
}
std::string IpcMessageErrorTypeToString(const IpcMessageErrorType msg) noexcept
{
return cxx::convert::toString(static_cast<std::underlying_type<IpcMessageErrorType>::type>(msg));
}
IpcInterfaceBase::IpcInterfaceBase(const RuntimeName_t& runtimeName,
const uint64_t maxMessages,
const uint64_t messageSize) noexcept
: m_runtimeName(runtimeName)
{
m_maxMessages = maxMessages;
m_maxMessageSize = messageSize;
if (m_maxMessageSize > platform::IoxIpcChannelType::MAX_MESSAGE_SIZE)
{
LogWarn() << "Message size too large, reducing from " << messageSize << " to "
<< platform::IoxIpcChannelType::MAX_MESSAGE_SIZE;
m_maxMessageSize = platform::IoxIpcChannelType::MAX_MESSAGE_SIZE;
}
}
bool IpcInterfaceBase::receive(IpcMessage& answer) const noexcept
{
auto message = m_ipcChannel.receive();
if (message.has_error())
{
return false;
}
return IpcInterfaceBase::setMessageFromString(message.value().c_str(), answer);
}
bool IpcInterfaceBase::timedReceive(const units::Duration timeout, IpcMessage& answer) const noexcept
{
return !m_ipcChannel.timedReceive(timeout)
.and_then([&answer](auto& message) { IpcInterfaceBase::setMessageFromString(message.c_str(), answer); })
.has_error()
&& answer.isValid();
}
bool IpcInterfaceBase::setMessageFromString(const char* buffer, IpcMessage& answer) noexcept
{
answer.setMessage(buffer);
if (!answer.isValid())
{
LogError() << "The received message " << answer.getMessage() << " is not valid";
return false;
}
return true;
}
bool IpcInterfaceBase::send(const IpcMessage& msg) const noexcept
{
if (!msg.isValid())
{
LogError() << "Trying to send the message " << msg.getMessage() << " which "
<< "does not follow the specified syntax.";
return false;
}
auto logLengthError = [&msg](posix::IpcChannelError& error) {
if (error == posix::IpcChannelError::MESSAGE_TOO_LONG)
{
const size_t messageSize =
static_cast<size_t>(msg.getMessage().size()) + platform::IoxIpcChannelType::NULL_TERMINATOR_SIZE;
LogError() << "msg size of " << messageSize << " bigger than configured max message size";
}
};
return !m_ipcChannel.send(msg.getMessage()).or_else(logLengthError).has_error();
}
bool IpcInterfaceBase::timedSend(const IpcMessage& msg, units::Duration timeout) const noexcept
{
if (!msg.isValid())
{
LogError() << "Trying to send the message " << msg.getMessage() << " which "
<< "does not follow the specified syntax.";
return false;
}
auto logLengthError = [&msg](posix::IpcChannelError& error) {
if (error == posix::IpcChannelError::MESSAGE_TOO_LONG)
{
const size_t messageSize =
static_cast<size_t>(msg.getMessage().size()) + platform::IoxIpcChannelType::NULL_TERMINATOR_SIZE;
LogError() << "msg size of " << messageSize << " bigger than configured max message size";
}
};
return !m_ipcChannel.timedSend(msg.getMessage(), timeout).or_else(logLengthError).has_error();
}
const RuntimeName_t& IpcInterfaceBase::getRuntimeName() const noexcept
{
return m_runtimeName;
}
bool IpcInterfaceBase::isInitialized() const noexcept
{
return m_ipcChannel.isInitialized();
}
bool IpcInterfaceBase::openIpcChannel(const posix::IpcChannelSide channelSide) noexcept
{
m_ipcChannel.destroy().or_else(
[this](auto) { LogWarn() << "unable to destroy previous ipc channel " << m_runtimeName; });
m_channelSide = channelSide;
platform::IoxIpcChannelType::create(m_runtimeName, m_channelSide, m_maxMessageSize, m_maxMessages)
.and_then([this](auto& ipcChannel) { this->m_ipcChannel = std::move(ipcChannel); });
return m_ipcChannel.isInitialized();
}
bool IpcInterfaceBase::closeIpcChannel() noexcept
{
return !m_ipcChannel.destroy().has_error();
}
bool IpcInterfaceBase::reopen() noexcept
{
return openIpcChannel(m_channelSide);
}
bool IpcInterfaceBase::ipcChannelMapsToFile() noexcept
{
return !m_ipcChannel.isOutdated().value_or(true);
}
bool IpcInterfaceBase::hasClosableIpcChannel() const noexcept
{
return m_ipcChannel.isInitialized();
}
void IpcInterfaceBase::cleanupOutdatedIpcChannel(const RuntimeName_t& name) noexcept
{
if (platform::IoxIpcChannelType::unlinkIfExists(name).value_or(false))
{
LogWarn() << "IPC channel still there, doing an unlink of " << name;
}
}
} // namespace runtime
} // namespace iox
|
