Eliminate public function returning pointer to private class data
The getChannelDataPtr method breaks class encapsulation. Only class
methods are supposed to have access to class private instance variables.
Change-Id: I5dbfb75f0fa409b82a1e7f426b2034d39f7df9ad
Signed-off-by: Johnathan Mantey <johnathanx.mantey@intel.com>
diff --git a/user_channel/channel_mgmt.cpp b/user_channel/channel_mgmt.cpp
index 697219c..859045a 100644
--- a/user_channel/channel_mgmt.cpp
+++ b/user_channel/channel_mgmt.cpp
@@ -151,8 +151,8 @@
return intfName;
}
-void processChAccessPropChange(ChannelConfig& chConfig, const std::string& path,
- const DbusChObjProperties& chProperties)
+void ChannelConfig::processChAccessPropChange(
+ const std::string& path, const DbusChObjProperties& chProperties)
{
// Get interface name from path. ex: '/xyz/openbmc_project/network/eth0'
std::string channelName;
@@ -195,8 +195,7 @@
uint8_t intfPriv = 0;
try
{
- intfPriv =
- static_cast<uint8_t>(chConfig.convertToPrivLimitIndex(intfPrivStr));
+ intfPriv = static_cast<uint8_t>(convertToPrivLimitIndex(intfPrivStr));
}
catch (const std::invalid_argument& e)
{
@@ -205,14 +204,12 @@
}
boost::interprocess::scoped_lock<boost::interprocess::named_recursive_mutex>
- channelLock{*chConfig.channelMutex};
+ channelLock{*channelMutex};
uint8_t chNum = 0;
- ChannelData* chData;
// Get the channel number based on the channel name.
for (chNum = 0; chNum < maxIpmiChannels; chNum++)
{
- chData = chConfig.getChannelDataPtr(chNum);
- if (chData->chName == channelName)
+ if (channelData[chNum].chName == channelName)
{
break;
}
@@ -224,9 +221,9 @@
}
// skip updating the values, if this property change originated from IPMI.
- if (chConfig.signalFlag & (1 << chNum))
+ if (signalFlag & (1 << chNum))
{
- chConfig.signalFlag &= ~(1 << chNum);
+ signalFlag &= ~(1 << chNum);
log<level::DEBUG>("Request originated from IPMI so ignoring signal");
return;
}
@@ -234,21 +231,23 @@
// Update both volatile & Non-volatile, if there is mismatch.
// as property change other than IPMI, has to update both volatile &
// non-volatile data.
- if (chData->chAccess.chNonVolatileData.privLimit != intfPriv)
+ checkAndReloadVolatileData();
+ checkAndReloadNVData();
+ if (channelData[chNum].chAccess.chNonVolatileData.privLimit != intfPriv)
{
// Update NV data
- chData->chAccess.chNonVolatileData.privLimit = intfPriv;
- if (chConfig.writeChannelPersistData() != 0)
+ channelData[chNum].chAccess.chNonVolatileData.privLimit = intfPriv;
+ if (writeChannelPersistData() != 0)
{
log<level::ERR>("Failed to update the persist data file");
return;
}
// Update Volatile data
- if (chData->chAccess.chVolatileData.privLimit != intfPriv)
+ if (channelData[chNum].chAccess.chVolatileData.privLimit != intfPriv)
{
- chData->chAccess.chVolatileData.privLimit = intfPriv;
- if (chConfig.writeChannelVolatileData() != 0)
+ channelData[chNum].chAccess.chVolatileData.privLimit = intfPriv;
+ if (writeChannelVolatileData() != 0)
{
log<level::ERR>("Failed to update the volatile data file");
return;
@@ -325,19 +324,12 @@
std::string iface;
std::string path = msg.get_path();
msg.read(iface, props);
- processChAccessPropChange(*this, path, props);
+ processChAccessPropChange(path, props);
});
signalHndlrObjectState = true;
}
}
-ChannelData* ChannelConfig::getChannelDataPtr(const uint8_t chNum)
-{
- // reload data before using it.
- checkAndReloadVolatileData();
- return &channelData[chNum];
-}
-
bool ChannelConfig::isValidChannel(const uint8_t chNum)
{
if (chNum > maxIpmiChannels)
@@ -349,10 +341,9 @@
if (channelData[chNum].isChValid == false)
{
log<level::DEBUG>("Channel is not valid");
- return false;
}
- return true;
+ return channelData[chNum].isChValid;
}
EChannelSessSupported
@@ -879,7 +870,7 @@
channelLock{*channelMutex};
Json data = readJsonFile(channelConfigDefaultFilename);
- if (data == nullptr)
+ if (data.empty())
{
log<level::DEBUG>("Error in opening IPMI Channel data file");
return -EIO;
diff --git a/user_channel/channel_mgmt.hpp b/user_channel/channel_mgmt.hpp
index 8b81391..993b3d1 100644
--- a/user_channel/channel_mgmt.hpp
+++ b/user_channel/channel_mgmt.hpp
@@ -232,21 +232,13 @@
*/
int writeChannelVolatileData();
- /** @brief function to get channel data based on channel number
- *
- * @param[in] chNum - channel number
- *
- * @return 0 for success, -errno for failure.
- */
- ChannelData* getChannelDataPtr(const uint8_t chNum);
-
uint32_t signalFlag = 0;
std::unique_ptr<boost::interprocess::named_recursive_mutex> channelMutex{
nullptr};
private:
- ChannelData channelData[maxIpmiChannels];
+ std::array<ChannelData, maxIpmiChannels> channelData;
std::time_t nvFileLastUpdatedTime;
std::time_t voltFileLastUpdatedTime;
std::time_t getUpdatedFileTime(const std::string& fileName);
@@ -400,6 +392,23 @@
* @return channel protocol type
*/
EChannelProtocolType convertToProtocolTypeIndex(const std::string& value);
+
+ /** @brief function to convert channel name to network interface name
+ *
+ * @param[in] value - channel interface name - ipmi centric
+ *
+ * @return network channel interface name
+ */
+ std::string convertToNetInterface(const std::string& value);
+
+ /** @brief function to handle Channel access property update through the
+ * D-Bus handler.
+ *
+ * @param[in] path - D-Bus path to the network element (i.e. eth0)
+ * @param[in] chProperties - D-Bus channel properties
+ */
+ void processChAccessPropChange(const std::string& path,
+ const DbusChObjProperties& chProperties);
};
} // namespace ipmi