blob: a42d9810f50a02e612bdbcc63b5bea0e82c425a1 [file] [log] [blame]
Tom Joseph07181f52016-08-08 08:17:08 -05001#include "command_table.hpp"
2
Richard Marian Thomaiyar472a37b2018-09-06 07:11:07 +05303#include "main.hpp"
Tom Joseph07181f52016-08-08 08:17:08 -05004#include "message_handler.hpp"
Tom Joseph1efcb492017-01-31 16:56:47 +05305#include "message_parsers.hpp"
Tom Joseph07181f52016-08-08 08:17:08 -05006#include "sessions_manager.hpp"
Nagaraju Goruganti1d9d4162018-03-22 01:27:37 -05007
Vernon Mauery9e801a22018-10-12 13:20:49 -07008#include <iomanip>
Vernon Mauery66501642018-07-30 09:07:10 -07009#include <main.hpp>
Vernon Mauery9e801a22018-10-12 13:20:49 -070010#include <phosphor-logging/elog-errors.hpp>
11#include <phosphor-logging/log.hpp>
Vernon Mauery66501642018-07-30 09:07:10 -070012#include <user_channel/user_layer.hpp>
Vernon Maueryf41a5542018-10-15 16:04:17 -070013#include <xyz/openbmc_project/Common/error.hpp>
Vernon Mauery9e801a22018-10-12 13:20:49 -070014
Vernon Mauery66501642018-07-30 09:07:10 -070015using namespace sdbusplus::xyz::openbmc_project::Common::Error;
Nagaraju Goruganti1d9d4162018-03-22 01:27:37 -050016using namespace phosphor::logging;
Tom Joseph07181f52016-08-08 08:17:08 -050017
Vernon Mauery66501642018-07-30 09:07:10 -070018namespace ipmi
19{
Patrick Williams9edc2312020-05-13 17:58:04 -050020using Value = std::variant<bool, uint8_t, int16_t, uint16_t, int32_t, uint32_t,
21 int64_t, uint64_t, double, std::string>;
Vernon Mauery66501642018-07-30 09:07:10 -070022
23} // namespace ipmi
24
Tom Joseph07181f52016-08-08 08:17:08 -050025namespace command
26{
27
28void Table::registerCommand(CommandID inCommand, std::unique_ptr<Entry>&& entry)
29{
Feist, Jamesbd45aae2017-10-26 15:06:13 -070030 auto& command = commandTable[inCommand.command];
31
32 if (command)
33 {
Vernon Mauery9e801a22018-10-12 13:20:49 -070034 log<level::DEBUG>(
35 "Already Registered",
Vernon Mauery66501642018-07-30 09:07:10 -070036 phosphor::logging::entry("SKIPPED_ENTRY=0x%x", inCommand.command));
Feist, Jamesbd45aae2017-10-26 15:06:13 -070037 return;
38 }
39
Feist, Jamesbd45aae2017-10-26 15:06:13 -070040 command = std::move(entry);
Tom Joseph07181f52016-08-08 08:17:08 -050041}
42
Vernon Mauery8d6f2002018-11-07 09:55:53 -080043void Table::executeCommand(uint32_t inCommand,
44 std::vector<uint8_t>& commandData,
45 std::shared_ptr<message::Handler> handler)
Tom Joseph07181f52016-08-08 08:17:08 -050046{
47 using namespace std::chrono_literals;
48
Tom Joseph07181f52016-08-08 08:17:08 -050049 auto iterator = commandTable.find(inCommand);
50
51 if (iterator == commandTable.end())
52 {
Vernon Mauery66501642018-07-30 09:07:10 -070053 CommandID command(inCommand);
54
Vernon Mauery779e7e12021-06-08 16:24:45 -070055 // Do not forward any session zero commands to ipmid
56 if (handler->sessionID == session::sessionZero)
57 {
58 log<level::INFO>("Table: refuse to forward session-zero command",
59 entry("LUN=%x", command.lun()),
60 entry("NETFN=%x", command.netFn()),
61 entry("CMD=%x", command.cmd()));
62 return;
63 }
Vernon Mauerycfb34ca2021-06-10 15:37:07 -070064 std::shared_ptr<session::Session> session =
Vernon Mauery2085ae02021-06-10 11:51:00 -070065 session::Manager::get().getSession(handler->sessionID);
Vernon Mauerycfb34ca2021-06-10 15:37:07 -070066
67 // Ignore messages that are not part of an active session
68 auto state = static_cast<session::State>(session->state());
69 if (state != session::State::active)
70 {
71 return;
72 }
Vernon Mauery779e7e12021-06-08 16:24:45 -070073
Vernon Mauery66501642018-07-30 09:07:10 -070074 auto bus = getSdBus();
75 // forward the request onto the main ipmi queue
Vernon Mauery8d6f2002018-11-07 09:55:53 -080076 using IpmiDbusRspType = std::tuple<uint8_t, uint8_t, uint8_t, uint8_t,
77 std::vector<uint8_t>>;
Vernon Mauery66501642018-07-30 09:07:10 -070078 uint8_t lun = command.lun();
79 uint8_t netFn = command.netFn();
80 uint8_t cmd = command.cmd();
Vernon Mauerycfb34ca2021-06-10 15:37:07 -070081
Vernon Mauery66501642018-07-30 09:07:10 -070082 std::map<std::string, ipmi::Value> options = {
Vernon Maueryd92bc322019-03-15 15:24:30 -070083 {"userId", ipmi::Value(static_cast<int>(
84 ipmi::ipmiUserGetUserId(session->userName)))},
Suryakanth Sekarf8a34fc2019-06-12 20:59:18 +053085 {"privilege",
86 ipmi::Value(static_cast<int>(session->currentPrivilege()))},
Rajashekar Gade Reddy49a94b22019-11-13 16:46:32 +053087 {"currentSessionId",
88 ipmi::Value(static_cast<uint32_t>(session->getBMCSessionID()))},
Vernon Mauery66501642018-07-30 09:07:10 -070089 };
Vernon Mauery8d6f2002018-11-07 09:55:53 -080090 bus->async_method_call(
91 [handler, this](const boost::system::error_code& ec,
92 const IpmiDbusRspType& response) {
93 if (!ec)
94 {
95 const uint8_t& cc = std::get<3>(response);
96 const std::vector<uint8_t>& responseData =
97 std::get<4>(response);
98 std::vector<uint8_t> payload;
99 payload.reserve(1 + responseData.size());
100 payload.push_back(cc);
101 payload.insert(payload.end(), responseData.begin(),
102 responseData.end());
103 handler->outPayload = std::move(payload);
104 }
105 else
106 {
107 std::vector<uint8_t> payload;
108 payload.push_back(IPMI_CC_UNSPECIFIED_ERROR);
109 handler->outPayload = std::move(payload);
110 }
111 },
112 "xyz.openbmc_project.Ipmi.Host", "/xyz/openbmc_project/Ipmi",
113 "xyz.openbmc_project.Ipmi.Server", "execute", netFn, lun, cmd,
114 commandData, options);
Tom Joseph07181f52016-08-08 08:17:08 -0500115 }
116 else
117 {
118 auto start = std::chrono::steady_clock::now();
119
Vernon Mauerycfb34ca2021-06-10 15:37:07 -0700120 // Ignore messages that are not part of an active/pre-active session
121 if (handler->sessionID != session::sessionZero)
122 {
123 std::shared_ptr<session::Session> session =
Vernon Mauery2085ae02021-06-10 11:51:00 -0700124 session::Manager::get().getSession(handler->sessionID);
Vernon Mauerycfb34ca2021-06-10 15:37:07 -0700125 auto state = static_cast<session::State>(session->state());
126 if ((state != session::State::setupInProgress) &&
127 (state != session::State::active))
128 {
129 return;
130 }
131 }
132
Vernon Mauery8d6f2002018-11-07 09:55:53 -0800133 handler->outPayload =
134 iterator->second->executeCommand(commandData, handler);
Tom Joseph07181f52016-08-08 08:17:08 -0500135
136 auto end = std::chrono::steady_clock::now();
137
Yong Li899cf5a2020-01-19 13:32:20 +0800138 std::chrono::duration<size_t> elapsedSeconds =
Vernon Mauery9e801a22018-10-12 13:20:49 -0700139 std::chrono::duration_cast<std::chrono::seconds>(end - start);
Tom Joseph07181f52016-08-08 08:17:08 -0500140
141 // If command time execution time exceeds 2 seconds, log a time
142 // exceeded message
143 if (elapsedSeconds > 2s)
144 {
Vernon Maueryfc37e592018-12-19 14:55:15 -0800145 log<level::ERR>("IPMI command timed out",
Yong Li899cf5a2020-01-19 13:32:20 +0800146 entry("DELAY=%zu", elapsedSeconds.count()));
Tom Joseph07181f52016-08-08 08:17:08 -0500147 }
148 }
Tom Joseph07181f52016-08-08 08:17:08 -0500149}
150
Vernon Mauery9e801a22018-10-12 13:20:49 -0700151std::vector<uint8_t>
152 NetIpmidEntry::executeCommand(std::vector<uint8_t>& commandData,
Vernon Mauery8d6f2002018-11-07 09:55:53 -0800153 std::shared_ptr<message::Handler> handler)
Tom Joseph07181f52016-08-08 08:17:08 -0500154{
155 std::vector<uint8_t> errResponse;
156
157 // Check if the command qualifies to be run prior to establishing a session
Suryakanth Sekarf8a34fc2019-06-12 20:59:18 +0530158 if (!sessionless && (handler->sessionID == session::sessionZero))
Tom Joseph07181f52016-08-08 08:17:08 -0500159 {
160 errResponse.resize(1);
161 errResponse[0] = IPMI_CC_INSUFFICIENT_PRIVILEGE;
Vernon Maueryfc37e592018-12-19 14:55:15 -0800162 log<level::INFO>("Table: Insufficient privilege for command",
Vernon Mauery66501642018-07-30 09:07:10 -0700163 entry("LUN=%x", command.lun()),
164 entry("NETFN=%x", command.netFn()),
165 entry("CMD=%x", command.cmd()));
Tom Joseph07181f52016-08-08 08:17:08 -0500166 return errResponse;
167 }
168
Vernon Mauery8d6f2002018-11-07 09:55:53 -0800169 return functor(commandData, *handler);
Tom Joseph07181f52016-08-08 08:17:08 -0500170}
171
Tom Joseph07181f52016-08-08 08:17:08 -0500172} // namespace command