summaryrefslogtreecommitdiff
path: root/meta-openbmc-mods/meta-common/recipes-phosphor/ipmi/phosphor-ipmi-net/0008-Sync-GetSession-Info-cmd-based-on-Upstream-review.patch
blob: 1a109a57174262dcac74d548d0984adcf3c18cdc (plain)
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
From 0ecc7c816ad4836f8f54922ba92cb527f5978d5a Mon Sep 17 00:00:00 2001
From: Suryakanth Sekar <suryakanth.sekar@linux.intel.com>
Date: Wed, 6 Mar 2019 10:35:56 +0530
Subject: [PATCH] Sync GetSession Info cmd based on Upstream review

Signed-off-by: Suryakanth Sekar <suryakanth.sekar@linux.intel.com>
---
 comm_module.cpp          | 12 ++++----
 command/session_cmds.cpp | 72 +++++++++++++++++++++---------------------------
 sessions_manager.cpp     | 10 +++----
 sessions_manager.hpp     |  2 +-
 socket_channel.hpp       | 33 +++++++++++-----------
 5 files changed, 59 insertions(+), 70 deletions(-)

diff --git a/comm_module.cpp b/comm_module.cpp
index 7a1a17d..2546583 100644
--- a/comm_module.cpp
+++ b/comm_module.cpp
@@ -54,13 +54,11 @@ void sessionSetupCommands()
          session::Privilege::CALLBACK,
          false},
         // Session Info Command
-        {
-            {
-                (static_cast<uint32_t>(message::PayloadType::IPMI) << 16) |
-                static_cast<uint16_t>(command::NetFns::APP) | 0x3D
-            },
-            &getSessionInfo, session::Privilege::USER, false
-        },
+        {{(static_cast<uint32_t>(message::PayloadType::IPMI) << 16) |
+          static_cast<uint16_t>(command::NetFns::APP) | 0x3D},
+         &getSessionInfo,
+         session::Privilege::USER,
+         false},
     };
 
     for (auto& iter : commands)
diff --git a/command/session_cmds.cpp b/command/session_cmds.cpp
index 7563b18..fc996a4 100644
--- a/command/session_cmds.cpp
+++ b/command/session_cmds.cpp
@@ -5,13 +5,12 @@
 
 #include <ipmid/api.h>
 
-#include <iostream>
 #include <user_channel/channel_layer.hpp>
 #include <user_channel/user_layer.hpp>
 
 namespace command
 {
-// Defined as per IPMI sepcification
+// Defined as per IPMI specification
 static constexpr uint8_t searchCurrentSession = 0x00;
 static constexpr uint8_t searchSessionByHandle = 0xFE;
 static constexpr uint8_t searchSessionByID = 0xFF;
@@ -129,20 +128,6 @@ std::vector<uint8_t> getSessionInfo(const std::vector<uint8_t>& inPayload,
         reinterpret_cast<GetSessionInfoResponse*>(outPayload.data());
     uint32_t reqSessionID = handler.sessionID;
     response->completionCode = IPMI_CC_OK;
-    if (inPayload.size() == 1 && request->sessionIndex != 0)
-    {
-        if (request->sessionIndex <= session::MAX_SESSION_COUNT)
-        {
-            reqSessionID = std::get<session::Manager&>(singletonPool)
-                               .getSessionIDbyHandle(request->sessionIndex);
-        }
-        else
-        {
-            response->completionCode = IPMI_CC_INVALID_FIELD_REQUEST;
-            outPayload.resize(sizeof(response->completionCode));
-            return std::move(outPayload);
-        }
-    }
 
     // Here we look for session info according to session index parameter
     switch (request->sessionIndex)
@@ -150,29 +135,22 @@ std::vector<uint8_t> getSessionInfo(const std::vector<uint8_t>& inPayload,
         // Look for current active session which this cmd is received over
         case searchCurrentSession:
             // Request data should only contain session index byte
-            if (inPayload.size() != 1)
+            if (inPayload.size() != sizeof(request->sessionIndex))
             {
                 response->completionCode = IPMI_CC_REQ_DATA_LEN_INVALID;
                 outPayload.resize(sizeof(response->completionCode));
-                return std::move(outPayload);
-            }
-            // To look for current active session which the command came over,
-            // the session ID cannot be 0.
-            if (0 == reqSessionID)
-            {
-                response->completionCode = IPMI_CC_INVALID_FIELD_REQUEST;
-                outPayload.resize(sizeof(response->completionCode));
-                return std::move(outPayload);
+                return outPayload;
             }
             break;
         case searchSessionByHandle:
             // Request data should only contain session index byte and Session
             // handle
-            if (inPayload.size() != 2)
+            if (inPayload.size() != (sizeof(request->sessionIndex) +
+                                     sizeof(request->sessionHandle)))
             {
                 response->completionCode = IPMI_CC_REQ_DATA_LEN_INVALID;
                 outPayload.resize(sizeof(response->completionCode));
-                return std::move(outPayload);
+                return outPayload;
             }
 
             // Retrieve session id based on session handle
@@ -186,7 +164,7 @@ std::vector<uint8_t> getSessionInfo(const std::vector<uint8_t>& inPayload,
             {
                 response->completionCode = IPMI_CC_INVALID_FIELD_REQUEST;
                 outPayload.resize(sizeof(response->completionCode));
-                return std::move(outPayload);
+                return outPayload;
             }
             break;
         case searchSessionByID:
@@ -196,23 +174,38 @@ std::vector<uint8_t> getSessionInfo(const std::vector<uint8_t>& inPayload,
             {
                 response->completionCode = IPMI_CC_REQ_DATA_LEN_INVALID;
                 outPayload.resize(sizeof(response->completionCode));
-                return std::move(outPayload);
+                return outPayload;
             }
             reqSessionID = endian::from_ipmi(request->sessionID);
 
             break;
         default:
-            if (inPayload.size() != 1)
+            if (inPayload.size() == sizeof(request->sessionIndex))
+            {
+                if (request->sessionIndex <= session::MAX_SESSION_COUNT)
+                {
+                    reqSessionID =
+                        std::get<session::Manager&>(singletonPool)
+                            .getSessionIDbyHandle(request->sessionIndex);
+                }
+                else
+                {
+                    response->completionCode = IPMI_CC_REQ_DATA_LEN_INVALID;
+                    outPayload.resize(sizeof(response->completionCode));
+                    return outPayload;
+                }
+            }
+            else
             {
                 response->completionCode = IPMI_CC_REQ_DATA_LEN_INVALID;
                 outPayload.resize(sizeof(response->completionCode));
-                return std::move(outPayload);
+                return outPayload;
             }
     }
 
     response->totalSessionCount = session::MAX_SESSION_COUNT;
     response->activeSessioncount =
-        std::get<session::Manager&>(singletonPool).getNoOfActiveSession();
+        std::get<session::Manager&>(singletonPool).getActiveSessionCount();
     response->sessionHandle = 0;
     if (reqSessionID != 0)
     {
@@ -225,9 +218,9 @@ std::vector<uint8_t> getSessionInfo(const std::vector<uint8_t>& inPayload,
         }
         catch (std::exception& e)
         {
-            response->completionCode = IPMI_CC_UNSPECIFIED_ERROR;
+            response->completionCode = IPMI_CC_REQ_DATA_LEN_INVALID;
             outPayload.resize(sizeof(response->completionCode));
-            return std::move(outPayload);
+            return outPayload;
         }
         response->sessionHandle = std::get<session::Manager&>(singletonPool)
                                       .getSessionHandle(reqSessionID);
@@ -236,25 +229,24 @@ std::vector<uint8_t> getSessionInfo(const std::vector<uint8_t>& inPayload,
         {
             response->completionCode = IPMI_CC_UNSPECIFIED_ERROR;
             outPayload.resize(sizeof(response->completionCode));
-            return std::move(outPayload);
+            return outPayload;
         }
         response->userID = userId; // userId;
         response->privLevel = static_cast<uint8_t>(sessionInfo->curPrivLevel);
         response->chanNum = sessionInfo->chNum; // byte7 3:0
         response->ipmiVer = ipmi20VerSession;   // byte7 7:4
-        response->remoteIpAddr =
-            sessionInfo->channelPtr->getRemoteAddressInbytes();
         response->remotePort =
             sessionInfo->channelPtr->getPort(); // remoteSessionPort;
+        response->remoteIpAddr =
+            sessionInfo->channelPtr->getRemoteAddressInBytes();
 
-        std::cerr << "\nSessionInfo:" << (int)reqSessionID;
         // TODO: Filling the Remote MACAddress
     }
     else
     {
         outPayload.resize(4);
     }
-    return std::move(outPayload);
+    return outPayload;
 }
 
 } // namespace command
diff --git a/sessions_manager.cpp b/sessions_manager.cpp
index 9f3210b..c6897c6 100644
--- a/sessions_manager.cpp
+++ b/sessions_manager.cpp
@@ -152,15 +152,13 @@ std::shared_ptr<Session> Manager::getSession(SessionID sessionID,
 
 void Manager::cleanStaleEntries()
 {
-    uint8_t sessionIndex = 0;
     for (auto iter = sessionsMap.begin(); iter != sessionsMap.end();)
     {
         auto session = iter->second;
         if ((session->getBMCSessionID() != SESSION_ZERO) &&
             !(session->isSessionActive()))
         {
-            sessionIndex = getSessionHandle(session->getBMCSessionID());
-            sessionHandleMap[sessionIndex] = 0;
+            sessionHandleMap[getSessionHandle(session->getBMCSessionID())] = 0;
             iter = sessionsMap.erase(iter);
         }
         else
@@ -172,8 +170,8 @@ void Manager::cleanStaleEntries()
 
 uint8_t Manager::storeSessionHandle(SessionID bmcSessionID)
 {
-    // Zero handler is reserved for invalid session.
-    //index starts with 1, for direct usage. Index 0 reserved
+    // Handler index 0 is  reserved for invalid session.
+    // index starts with 1, for direct usage. Index 0 reserved
     for (uint8_t i = 1; i <= MAX_SESSION_COUNT; i++)
     {
         if (sessionHandleMap[i] == 0)
@@ -206,7 +204,7 @@ uint8_t Manager::getSessionHandle(SessionID bmcSessionID) const
     }
     return 0;
 }
-uint8_t Manager::getNoOfActiveSession() const
+uint8_t Manager::getActiveSessionCount() const
 {
     uint8_t count = 0;
     for (const auto& it : sessionsMap)
diff --git a/sessions_manager.hpp b/sessions_manager.hpp
index c4caad4..3a3825d 100644
--- a/sessions_manager.hpp
+++ b/sessions_manager.hpp
@@ -82,7 +82,7 @@ class Manager
     std::shared_ptr<Session>
         getSession(SessionID sessionID,
                    RetrieveOption option = RetrieveOption::BMC_SESSION_ID);
-    uint8_t getNoOfActiveSession() const;
+    uint8_t getActiveSessionCount() const;
     uint8_t getSessionHandle(SessionID bmcSessionID) const;
     uint8_t storeSessionHandle(SessionID bmcSessionID);
     uint32_t getSessionIDbyHandle(uint8_t sessionHandle) const;
diff --git a/socket_channel.hpp b/socket_channel.hpp
index 349701e..8b64740 100644
--- a/socket_channel.hpp
+++ b/socket_channel.hpp
@@ -52,33 +52,34 @@ class Channel
     }
 
     /**
-     * @brief Fetch the port number of the remote peer
-     *
-     * Returns the port number of the remote peer
+     * @brief Fetch the IP address of the remote peer
      *
-     * @return Port number
+     * Returns the IP address of the remote peer which is connected to this
+     * socket
      *
+     * @return IP address of the remote peer
      */
-    auto getPort() const
+    std::uint32_t getRemoteAddressInBytes() const
     {
-        return endpoint.port();
+        const boost::asio::ip::address& addr = endpoint.address();
+        if (addr.is_v4())
+        {
+            return addr.to_v4().to_uint();
+        }
+        return 0;
     }
 
     /**
-     * @brief Return the binary representation of the remote IPv4 address
+     * @brief Fetch the port number of the remote peer
      *
-     * getSessionInfo needs to return the remote IPv4 addresses of each session
+     * Returns the port number of the remote peer
+     *
+     * @return Port number
      *
-     * @return A uint32_t representation of the remote IPv4 address
      */
-    std::uint32_t getRemoteAddressInbytes()
+    auto getPort() const
     {
-        const boost::asio::ip::address& addr = endpoint.address();
-        if (addr.is_v4())
-        {
-            return addr.to_v4().to_uint();
-        }
-        return 0;
+        return endpoint.port();
     }
 
     /**
-- 
2.7.4