1 /**
2  * Copyright © 2019 IBM Corporation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #include "user_data.hpp"
17 
18 #include "json_utils.hpp"
19 #include "pel_types.hpp"
20 #include "user_data_formats.hpp"
21 
22 #include <fmt/format.h>
23 #ifdef PELTOOL
24 #include "user_data_json.hpp"
25 #endif
26 
27 #include "trace.hpp"
28 
29 namespace openpower
30 {
31 namespace pels
32 {
33 
34 void UserData::unflatten(Stream& stream)
35 {
36     stream >> _header;
37 
38     if (_header.size <= SectionHeader::flattenedSize())
39     {
40         throw std::out_of_range(
41             "UserData::unflatten: SectionHeader::size field too small");
42     }
43 
44     size_t dataLength = _header.size - SectionHeader::flattenedSize();
45     _data.resize(dataLength);
46 
47     stream >> _data;
48 }
49 
50 void UserData::flatten(Stream& stream) const
51 {
52     stream << _header << _data;
53 }
54 
55 UserData::UserData(Stream& pel)
56 {
57     try
58     {
59         unflatten(pel);
60         validate();
61     }
62     catch (const std::exception& e)
63     {
64         trace::error(fmt::format("Cannot unflatten user data: {}", e.what()));
65         _valid = false;
66     }
67 }
68 
69 UserData::UserData(uint16_t componentID, uint8_t subType, uint8_t version,
70                    const std::vector<uint8_t>& data)
71 {
72     _header.id = static_cast<uint16_t>(SectionID::userData);
73     _header.size = Section::flattenedSize() + data.size();
74     _header.version = version;
75     _header.subType = subType;
76     _header.componentID = componentID;
77 
78     _data = data;
79 
80     _valid = true;
81 }
82 
83 void UserData::validate()
84 {
85     if (header().id != static_cast<uint16_t>(SectionID::userData))
86     {
87         trace::error(
88             fmt::format("Invalid user data section ID: {}", header().id));
89         _valid = false;
90     }
91     else
92     {
93         _valid = true;
94     }
95 }
96 
97 std::optional<std::string>
98     UserData::getJSON(uint8_t creatorID [[maybe_unused]],
99                       const std::vector<std::string>& plugins
100                       [[maybe_unused]]) const
101 {
102 #ifdef PELTOOL
103     return user_data::getJSON(_header.componentID, _header.subType,
104                               _header.version, _data, creatorID, plugins);
105 #endif
106     return std::nullopt;
107 }
108 
109 bool UserData::shrink(size_t newSize)
110 {
111     // minimum size is 4 bytes plus the 8B header
112     if ((newSize < flattenedSize()) &&
113         (newSize >= (Section::flattenedSize() + 4)))
114     {
115         auto dataSize = newSize - Section::flattenedSize();
116 
117         // Ensure it's 4B aligned
118         _data.resize((dataSize / 4) * 4);
119         _header.size = Section::flattenedSize() + _data.size();
120         return true;
121     }
122 
123     return false;
124 }
125 
126 } // namespace pels
127 } // namespace openpower
128