1 /*
2 // Copyright (c) 2018 Intel 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 
17 #pragma once
18 #include "channel_layer.hpp"
19 
20 #include <boost/interprocess/sync/file_lock.hpp>
21 #include <boost/interprocess/sync/named_recursive_mutex.hpp>
22 #include <cstdint>
23 #include <ctime>
24 #include <nlohmann/json.hpp>
25 #include <sdbusplus/bus.hpp>
26 
27 namespace ipmi
28 {
29 
30 using Json = nlohmann::json;
31 
32 using DbusVariant =
33     sdbusplus::message::variant<std::vector<std::string>, std::string, bool>;
34 
35 using DbusChObjProperties = std::vector<std::pair<std::string, DbusVariant>>;
36 
37 static constexpr const char* ipmiChannelMutex = "ipmi_channel_mutex";
38 static constexpr const char* ipmiChMutexCleanupLockFile =
39     "/var/lib/ipmi/ipmi_channel_mutex_cleanup";
40 
41 /** @struct ChannelAccessData
42  *
43  *  Structure to store both non-volatile and volatile channel access information
44  *  as used by IPMI specification (refer spec sec 22.22 to 22.24)
45  */
46 struct ChannelAccessData
47 {
48     ChannelAccess chNonVolatileData;
49     ChannelAccess chVolatileData;
50 };
51 
52 /** @struct ChannelData
53  *
54  *  Structure for channel information - base structure to get all information
55  * about the channel.(refer spec sec 22.22 to 22.24)
56  */
57 struct ChannelData
58 {
59     std::string chName;
60     uint8_t chID;
61     bool isChValid;
62     uint8_t activeSessCount;
63     ChannelInfo chInfo;
64     ChannelAccessData chAccess;
65     size_t maxTransferSize;
66 };
67 
68 class ChannelConfig;
69 
70 ChannelConfig& getChannelConfigObject();
71 
72 class ChannelConfig
73 {
74   public:
75     ChannelConfig(const ChannelConfig&) = delete;
76     ChannelConfig& operator=(const ChannelConfig&) = delete;
77     ChannelConfig(ChannelConfig&&) = delete;
78     ChannelConfig& operator=(ChannelConfig&&) = delete;
79 
80     ~ChannelConfig();
81     ChannelConfig();
82 
83     /** @brief determines valid channel
84      *
85      *  @param[in] chNum - channel number
86      *
87      *  @return true if valid, false otherwise
88      */
89     bool isValidChannel(const uint8_t chNum);
90 
91     /** @brief determines valid authentication type
92      *
93      *  @param[in] chNum - channel number
94      *  @param[in] authType - authentication type
95      *
96      *  @return true if valid, false otherwise
97      */
98     bool isValidAuthType(const uint8_t chNum, const EAuthType& authType);
99 
100     /** @brief function to get channel name from channel number
101      *
102      *  @param[in] chNum - channel number index
103      *
104      *  @return network channel interface name
105      */
106     std::string getChannelName(const uint8_t chNum);
107 
108     /** @brief determines supported session type of a channel
109      *
110      *  @param[in] chNum - channel number
111      *
112      *  @return EChannelSessSupported - supported session type
113      */
114     EChannelSessSupported getChannelSessionSupport(const uint8_t chNum);
115 
116     /** @brief determines number of active sessions on a channel
117      *
118      *  @param[in] chNum - channel number
119      *
120      *  @return numer of active sessions
121      */
122     int getChannelActiveSessions(const uint8_t chNum);
123 
124     /** @brief determines maximum transfer size for a channel
125      *
126      *  @param[in] chNum - channel number
127      *
128      *  @return maximum bytes that can be transferred on this channel
129      */
130     size_t getChannelMaxTransferSize(uint8_t chNum);
131 
132     /** @brief provides channel info details
133      *
134      *  @param[in] chNum - channel number
135      *  @param[out] chInfo - channel info details
136      *
137      *  @return IPMI_CC_OK for success, others for failure.
138      */
139     ipmi_ret_t getChannelInfo(const uint8_t chNum, ChannelInfo& chInfo);
140 
141     /** @brief provides channel access data
142      *
143      *  @param[in] chNum - channel number
144      *  @param[out] chAccessData - channel access data
145      *
146      *  @return IPMI_CC_OK for success, others for failure.
147      */
148     ipmi_ret_t getChannelAccessData(const uint8_t chNum,
149                                     ChannelAccess& chAccessData);
150 
151     /** @brief to set channel access data
152      *
153      *  @param[in] chNum - channel number
154      *  @param[in] chAccessData - channel access data
155      *  @param[in] setFlag - flag to indicate updatable fields
156      *
157      *  @return IPMI_CC_OK for success, others for failure.
158      */
159     ipmi_ret_t setChannelAccessData(const uint8_t chNum,
160                                     const ChannelAccess& chAccessData,
161                                     const uint8_t setFlag);
162 
163     /** @brief to get channel access data persistent data
164      *
165      *  @param[in] chNum - channel number
166      *  @param[out] chAccessData - channel access data
167      *
168      *  @return IPMI_CC_OK for success, others for failure.
169      */
170     ipmi_ret_t getChannelAccessPersistData(const uint8_t chNum,
171                                            ChannelAccess& chAccessData);
172 
173     /** @brief to set channel access data persistent data
174      *
175      *  @param[in] chNum - channel number
176      *  @param[in] chAccessData - channel access data
177      *  @param[in] setFlag - flag to indicate updatable fields
178      *
179      *  @return IPMI_CC_OK for success, others for failure.
180      */
181     ipmi_ret_t setChannelAccessPersistData(const uint8_t chNum,
182                                            const ChannelAccess& chAccessData,
183                                            const uint8_t setFlag);
184 
185     /** @brief provides supported authentication type for the channel
186      *
187      *  @param[in] chNum - channel number
188      *  @param[out] authTypeSupported - supported authentication type
189      *
190      *  @return IPMI_CC_OK for success, others for failure.
191      */
192     ipmi_ret_t getChannelAuthTypeSupported(const uint8_t chNum,
193                                            uint8_t& authTypeSupported);
194 
195     /** @brief provides enabled authentication type for the channel
196      *
197      *  @param[in] chNum - channel number
198      *  @param[in] priv - privilege
199      *  @param[out] authType - enabled authentication type
200      *
201      *  @return IPMI_CC_OK for success, others for failure.
202      */
203     ipmi_ret_t getChannelEnabledAuthType(const uint8_t chNum,
204                                          const uint8_t priv,
205                                          EAuthType& authType);
206 
207     /** @brief conver to channel privilege from system privilege
208      *
209      *  @param[in] value - privilege value
210      *
211      *  @return Channel privilege
212      */
213     CommandPrivilege convertToPrivLimitIndex(const std::string& value);
214 
215     /** @brief function to convert channel number to channel index
216      *
217      *  @param[in] chNum - channel number
218      *
219      *  @return channel index
220      */
221     uint8_t convertToChannelIndexNumber(const uint8_t chNum);
222 
223     /** @brief function to write persistent channel configuration to config file
224      *
225      *  @return 0 for success, -errno for failure.
226      */
227     int writeChannelPersistData();
228 
229     /** @brief function to write volatile channel configuration to config file
230      *
231      *  @return 0 for success, -errno for failure.
232      */
233     int writeChannelVolatileData();
234 
235     uint32_t signalFlag = 0;
236 
237     std::unique_ptr<boost::interprocess::named_recursive_mutex> channelMutex{
238         nullptr};
239 
240   private:
241     std::array<ChannelData, maxIpmiChannels> channelData;
242     std::time_t nvFileLastUpdatedTime;
243     std::time_t voltFileLastUpdatedTime;
244     std::time_t getUpdatedFileTime(const std::string& fileName);
245     boost::interprocess::file_lock mutexCleanupLock;
246     sdbusplus::bus::bus bus;
247     bool signalHndlrObjectState = false;
248     boost::interprocess::file_lock sigHndlrLock;
249 
250     /** @brief function to initialize persistent channel configuration
251      *
252      */
253     void initChannelPersistData();
254 
255     /** @brief function to set default channel configuration based on channel
256      * number
257      *
258      *  @param[in] chNum - channel number
259      *  @param[in] chName - channel name
260      */
261     void setDefaultChannelConfig(const uint8_t chNum,
262                                  const std::string& chName);
263 
264     /** @brief function to load all channel configuration
265      *
266      *  @return 0 for success, -errno for failure.
267      */
268     int loadChannelConfig();
269 
270     /** @brief function to read persistent channel data
271      *
272      *  @return 0 for success, -errno for failure.
273      */
274     int readChannelPersistData();
275 
276     /** @brief function to read volatile channel data
277      *
278      *  @return 0 for success, -errno for failure.
279      */
280     int readChannelVolatileData();
281 
282     /** @brief function to check and reload persistent channel data
283      *
284      *  @return 0 for success, -errno for failure.
285      */
286     int checkAndReloadNVData();
287 
288     /** @brief function to check and reload volatile channel data
289      *
290      *  @return 0 for success, -errno for failure.
291      */
292     int checkAndReloadVolatileData();
293 
294     /** @brief function to sync channel privilege with system network channel
295      * privilege
296      *
297      *  @return 0 for success, -errno for failure.
298      */
299     int syncNetworkChannelConfig();
300 
301     /** @brief function to set D-Bus property value
302      *
303      *  @param[in] service - service name
304      *  @param[in] objPath - object path
305      *  @param[in] interface - interface
306      *  @param[in] property - property name
307      *  @param[in] value - property value
308      *
309      *  @return 0 for success, -errno for failure.
310      */
311     int setDbusProperty(const std::string& service, const std::string& objPath,
312                         const std::string& interface,
313                         const std::string& property, const DbusVariant& value);
314 
315     /** @brief function to get D-Bus property value
316      *
317      *  @param[in] service - service name
318      *  @param[in] objPath - object path
319      *  @param[in] interface - interface
320      *  @param[in] property - property name
321      *  @param[out] value - property value
322      *
323      *  @return 0 for success, -errno for failure.
324      */
325     int getDbusProperty(const std::string& service, const std::string& objPath,
326                         const std::string& interface,
327                         const std::string& property, DbusVariant& value);
328 
329     /** @brief function to read json config file
330      *
331      *  @param[in] configFile - configuration file name
332      *
333      *  @return Json object
334      */
335     Json readJsonFile(const std::string& configFile);
336 
337     /** @brief function to write json config file
338      *
339      *  @param[in] configFile - configuration file name
340      *  @param[in] jsonData - json object
341      *
342      *  @return 0 for success, -errno for failure.
343      */
344     int writeJsonFile(const std::string& configFile, const Json& jsonData);
345 
346     /** @brief function to convert system access mode to Channel access mode
347      * type
348      *
349      *  @param[in] mode - access mode in string
350      *
351      *  @return Channel access mode.
352      */
353     EChannelAccessMode convertToAccessModeIndex(const std::string& mode);
354 
355     /** @brief function to convert access mode value to string
356      *
357      *  @param[in] value - acess mode value
358      *
359      *  @return access mode in string
360      */
361     std::string convertToAccessModeString(const uint8_t value);
362 
363     /** @brief function to convert privilege value to string
364      *
365      *  @param[in] value - privilege value
366      *
367      *  @return privilege in string
368      */
369     std::string convertToPrivLimitString(const uint8_t value);
370 
371     /** @brief function to convert session support string to value type
372      *
373      *  @param[in] value - session support type in string
374      *
375      *  @return support session type
376      */
377     EChannelSessSupported
378         convertToSessionSupportIndex(const std::string& value);
379 
380     /** @brief function to convert medium type string to value type
381      *
382      *  @param[in] value - medium type in string
383      *
384      *  @return channel medium type
385      */
386     EChannelMediumType convertToMediumTypeIndex(const std::string& value);
387 
388     /** @brief function to convert protocol type string to value type
389      *
390      *  @param[in] value - protocol type in string
391      *
392      *  @return channel protocol  type
393      */
394     EChannelProtocolType convertToProtocolTypeIndex(const std::string& value);
395 
396     /** @brief function to convert channel name to network interface name
397      *
398      *  @param[in] value - channel interface name - ipmi centric
399      *
400      *  @return network channel interface name
401      */
402     std::string convertToNetInterface(const std::string& value);
403 
404     /** @brief function to handle Channel access property update through the
405      * D-Bus handler.
406      *
407      *  @param[in] path - D-Bus path to the network element (i.e. eth0)
408      *  @param[in] chProperties - D-Bus channel properties
409      */
410     void processChAccessPropChange(const std::string& path,
411                                    const DbusChObjProperties& chProperties);
412 };
413 
414 } // namespace ipmi
415