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
|
// Copyright (c) 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/mepoo/chunk_settings.hpp"
#include "iceoryx_hoofs/cxx/helplets.hpp"
#include "iceoryx_posh/mepoo/chunk_header.hpp"
namespace iox
{
namespace mepoo
{
ChunkSettings::ChunkSettings(const uint32_t userPayloadSize,
const uint32_t userPayloadAlignment,
const uint32_t userHeaderSize,
const uint32_t userHeaderAlignment,
const uint32_t requiredChunkSize) noexcept
: m_userPayloadSize(userPayloadSize)
, m_userPayloadAlignment(userPayloadAlignment)
, m_userHeaderSize(userHeaderSize)
, m_userHeaderAlignment(userHeaderAlignment)
, m_requiredChunkSize(requiredChunkSize)
{
}
cxx::expected<ChunkSettings, ChunkSettings::Error> ChunkSettings::create(const uint32_t userPayloadSize,
const uint32_t userPayloadAlignment,
const uint32_t userHeaderSize,
const uint32_t userHeaderAlignment) noexcept
{
// since alignas accepts 0, we also do but we adjust it to 1 in case there are some division or modulo operations
// with the alignment later on
uint32_t adjustedUserPayloadAlignment = userPayloadAlignment == 0U ? 1U : userPayloadAlignment;
uint32_t adjustedUserHeaderAlignment = userHeaderAlignment == 0U ? 1U : userHeaderAlignment;
if (!cxx::isPowerOfTwo(adjustedUserPayloadAlignment) || !cxx::isPowerOfTwo(adjustedUserHeaderAlignment))
{
return cxx::error<ChunkSettings::Error>(ChunkSettings::Error::ALIGNMENT_NOT_POWER_OF_TWO);
}
if (adjustedUserHeaderAlignment > alignof(ChunkHeader))
{
// for ease of calculation, the alignment of the user-header is restricted to not exceed the alignment of the
// ChunkHeader
return cxx::error<ChunkSettings::Error>(
ChunkSettings::Error::USER_HEADER_ALIGNMENT_EXCEEDS_CHUNK_HEADER_ALIGNMENT);
}
if (userHeaderSize % adjustedUserHeaderAlignment != 0U)
{
return cxx::error<ChunkSettings::Error>(ChunkSettings::Error::USER_HEADER_SIZE_NOT_MULTIPLE_OF_ITS_ALIGNMENT);
}
uint64_t requiredChunkSize =
calculateRequiredChunkSize(userPayloadSize, adjustedUserPayloadAlignment, userHeaderSize);
if (requiredChunkSize > std::numeric_limits<uint32_t>::max())
{
return cxx::error<ChunkSettings::Error>(ChunkSettings::Error::REQUIRED_CHUNK_SIZE_EXCEEDS_MAX_CHUNK_SIZE);
}
return cxx::success<ChunkSettings>(ChunkSettings{userPayloadSize,
adjustedUserPayloadAlignment,
userHeaderSize,
adjustedUserHeaderAlignment,
static_cast<uint32_t>(requiredChunkSize)});
}
uint64_t ChunkSettings::calculateRequiredChunkSize(const uint32_t userPayloadSize,
const uint32_t userPayloadAlignment,
const uint32_t userHeaderSize) noexcept
{
// have a look at »Required Chunk Size Calculation« in chunk_header.md for more details regarding the calculation
if (userHeaderSize == 0)
{
// the most simple case with no user-header and the user-payload adjacent to the ChunkHeader
if (userPayloadAlignment <= alignof(mepoo::ChunkHeader))
{
uint64_t requiredChunkSize = static_cast<uint64_t>(sizeof(ChunkHeader)) + userPayloadSize;
return requiredChunkSize;
}
// the second most simple case with no user-header but the user-payload alignment
// exceeds the ChunkHeader alignment and is therefore not necessarily adjacent
uint64_t preUserPayloadAlignmentOverhang = static_cast<uint64_t>(sizeof(ChunkHeader) - alignof(ChunkHeader));
uint64_t requiredChunkSize = preUserPayloadAlignmentOverhang + userPayloadAlignment + userPayloadSize;
return requiredChunkSize;
}
// the most complex case with a user-header
constexpr uint64_t SIZE_OF_USER_PAYLOAD_OFFSET_T{sizeof(ChunkHeader::UserPayloadOffset_t)};
constexpr uint64_t ALIGNMENT_OF_USER_PAYLOAD_OFFSET_T{alignof(ChunkHeader::UserPayloadOffset_t)};
uint64_t headerSize = static_cast<uint64_t>(sizeof(ChunkHeader) + userHeaderSize);
uint64_t preUserPayloadAlignmentOverhang = cxx::align(headerSize, ALIGNMENT_OF_USER_PAYLOAD_OFFSET_T);
uint64_t maxPadding = algorithm::max(SIZE_OF_USER_PAYLOAD_OFFSET_T, static_cast<uint64_t>(userPayloadAlignment));
uint64_t requiredChunkSize = preUserPayloadAlignmentOverhang + maxPadding + userPayloadSize;
return requiredChunkSize;
}
uint32_t ChunkSettings::requiredChunkSize() const noexcept
{
return m_requiredChunkSize;
}
uint32_t ChunkSettings::userPayloadSize() const noexcept
{
return m_userPayloadSize;
}
uint32_t ChunkSettings::userPayloadAlignment() const noexcept
{
return m_userPayloadAlignment;
}
uint32_t ChunkSettings::userHeaderSize() const noexcept
{
return m_userHeaderSize;
}
uint32_t ChunkSettings::userHeaderAlignment() const noexcept
{
return m_userHeaderAlignment;
}
} // namespace mepoo
} // namespace iox
|
