blob: 5ef6f4ba4d508b98bc2aacf9c155299902f80960 [file] [log] [blame]
Vernon Mauery240b1862018-10-08 12:05:16 -07001/**
2 * Copyright © 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#include "config.h"
17
18#include "settings.hpp"
19
20#include <dlfcn.h>
21
22#include <algorithm>
23#include <any>
Vernon Mauery735ee952019-02-15 13:38:52 -080024#include <boost/algorithm/string.hpp>
Ed Tanous778418d2020-08-17 23:20:21 -070025#include <boost/asio/io_context.hpp>
Vernon Mauerye8d43232019-03-26 16:23:43 -070026#include <dcmihandler.hpp>
Vernon Mauery240b1862018-10-08 12:05:16 -070027#include <exception>
Vernon Mauerybdda8002019-02-26 10:18:51 -080028#include <filesystem>
Vernon Mauery240b1862018-10-08 12:05:16 -070029#include <forward_list>
30#include <host-cmd-manager.hpp>
31#include <ipmid-host/cmd.hpp>
32#include <ipmid/api.hpp>
33#include <ipmid/handler.hpp>
34#include <ipmid/message.hpp>
35#include <ipmid/oemrouter.hpp>
Vernon Mauery33250242019-03-12 16:49:26 -070036#include <ipmid/types.hpp>
Vernon Mauery240b1862018-10-08 12:05:16 -070037#include <map>
38#include <memory>
39#include <optional>
40#include <phosphor-logging/log.hpp>
41#include <sdbusplus/asio/connection.hpp>
42#include <sdbusplus/asio/object_server.hpp>
43#include <sdbusplus/asio/sd_event.hpp>
44#include <sdbusplus/bus.hpp>
45#include <sdbusplus/bus/match.hpp>
46#include <sdbusplus/timer.hpp>
47#include <tuple>
Vernon Mauery240b1862018-10-08 12:05:16 -070048#include <unordered_map>
49#include <utility>
50#include <vector>
51
Vernon Mauery240b1862018-10-08 12:05:16 -070052namespace fs = std::filesystem;
53
54using namespace phosphor::logging;
55
Vernon Mauery240b1862018-10-08 12:05:16 -070056// IPMI Spec, shared Reservation ID.
57static unsigned short selReservationID = 0xFFFF;
58static bool selReservationValid = false;
59
60unsigned short reserveSel(void)
61{
62 // IPMI spec, Reservation ID, the value simply increases against each
63 // execution of the Reserve SEL command.
64 if (++selReservationID == 0)
65 {
66 selReservationID = 1;
67 }
68 selReservationValid = true;
69 return selReservationID;
70}
71
72bool checkSELReservation(unsigned short id)
73{
74 return (selReservationValid && selReservationID == id);
75}
76
77void cancelSELReservation(void)
78{
79 selReservationValid = false;
80}
81
82EInterfaceIndex getInterfaceIndex(void)
83{
84 return interfaceKCS;
85}
86
87sd_bus* bus;
88sd_event* events = nullptr;
89sd_event* ipmid_get_sd_event_connection(void)
90{
91 return events;
92}
93sd_bus* ipmid_get_sd_bus_connection(void)
94{
95 return bus;
96}
97
98namespace ipmi
99{
100
101static inline unsigned int makeCmdKey(unsigned int cluster, unsigned int cmd)
102{
103 return (cluster << 8) | cmd;
104}
105
106using HandlerTuple = std::tuple<int, /* prio */
107 Privilege, HandlerBase::ptr /* handler */
108 >;
109
110/* map to handle standard registered commands */
111static std::unordered_map<unsigned int, /* key is NetFn/Cmd */
112 HandlerTuple>
113 handlerMap;
114
Vernon Maueryf984a012018-10-08 12:05:18 -0700115/* special map for decoding Group registered commands (NetFn 2Ch) */
116static std::unordered_map<unsigned int, /* key is Group/Cmd (NetFn is 2Ch) */
117 HandlerTuple>
118 groupHandlerMap;
119
120/* special map for decoding OEM registered commands (NetFn 2Eh) */
121static std::unordered_map<unsigned int, /* key is Iana/Cmd (NetFn is 2Eh) */
122 HandlerTuple>
123 oemHandlerMap;
124
Vernon Mauery08a70aa2018-11-07 09:36:22 -0800125using FilterTuple = std::tuple<int, /* prio */
126 FilterBase::ptr /* filter */
127 >;
128
129/* list to hold all registered ipmi command filters */
130static std::forward_list<FilterTuple> filterList;
131
Vernon Mauery240b1862018-10-08 12:05:16 -0700132namespace impl
133{
134/* common function to register all standard IPMI handlers */
135bool registerHandler(int prio, NetFn netFn, Cmd cmd, Privilege priv,
136 HandlerBase::ptr handler)
137{
138 // check for valid NetFn: even; 00-0Ch, 30-3Eh
139 if (netFn & 1 || (netFn > netFnTransport && netFn < netFnGroup) ||
140 netFn > netFnOemEight)
141 {
142 return false;
143 }
144
145 // create key and value for this handler
146 unsigned int netFnCmd = makeCmdKey(netFn, cmd);
147 HandlerTuple item(prio, priv, handler);
148
149 // consult the handler map and look for a match
150 auto& mapCmd = handlerMap[netFnCmd];
151 if (!std::get<HandlerBase::ptr>(mapCmd) || std::get<int>(mapCmd) <= prio)
152 {
153 mapCmd = item;
154 return true;
155 }
156 return false;
157}
158
Vernon Maueryf984a012018-10-08 12:05:18 -0700159/* common function to register all Group IPMI handlers */
160bool registerGroupHandler(int prio, Group group, Cmd cmd, Privilege priv,
161 HandlerBase::ptr handler)
162{
163 // create key and value for this handler
164 unsigned int netFnCmd = makeCmdKey(group, cmd);
165 HandlerTuple item(prio, priv, handler);
166
167 // consult the handler map and look for a match
168 auto& mapCmd = groupHandlerMap[netFnCmd];
169 if (!std::get<HandlerBase::ptr>(mapCmd) || std::get<int>(mapCmd) <= prio)
170 {
171 mapCmd = item;
172 return true;
173 }
174 return false;
175}
176
177/* common function to register all OEM IPMI handlers */
178bool registerOemHandler(int prio, Iana iana, Cmd cmd, Privilege priv,
179 HandlerBase::ptr handler)
180{
181 // create key and value for this handler
182 unsigned int netFnCmd = makeCmdKey(iana, cmd);
183 HandlerTuple item(prio, priv, handler);
184
185 // consult the handler map and look for a match
186 auto& mapCmd = oemHandlerMap[netFnCmd];
187 if (!std::get<HandlerBase::ptr>(mapCmd) || std::get<int>(mapCmd) <= prio)
188 {
189 mapCmd = item;
190 return true;
191 }
192 return false;
193}
194
Vernon Mauery08a70aa2018-11-07 09:36:22 -0800195/* common function to register all IPMI filter handlers */
196void registerFilter(int prio, FilterBase::ptr filter)
197{
198 // check for initial placement
199 if (filterList.empty() || std::get<int>(filterList.front()) < prio)
200 {
201 filterList.emplace_front(std::make_tuple(prio, filter));
202 }
203 // walk the list and put it in the right place
204 auto j = filterList.begin();
205 for (auto i = j; i != filterList.end() && std::get<int>(*i) > prio; i++)
206 {
207 j = i;
208 }
209 filterList.emplace_after(j, std::make_tuple(prio, filter));
210}
211
Vernon Mauery240b1862018-10-08 12:05:16 -0700212} // namespace impl
213
Vernon Mauery08a70aa2018-11-07 09:36:22 -0800214message::Response::ptr filterIpmiCommand(message::Request::ptr request)
215{
216 // pass the command through the filter mechanism
217 // This can be the firmware firewall or any OEM mechanism like
218 // whitelist filtering based on operational mode
219 for (auto& item : filterList)
220 {
221 FilterBase::ptr filter = std::get<FilterBase::ptr>(item);
222 ipmi::Cc cc = filter->call(request);
223 if (ipmi::ccSuccess != cc)
224 {
225 return errorResponse(request, cc);
226 }
227 }
228 return message::Response::ptr();
229}
230
Vernon Mauery240b1862018-10-08 12:05:16 -0700231message::Response::ptr executeIpmiCommandCommon(
232 std::unordered_map<unsigned int, HandlerTuple>& handlers,
233 unsigned int keyCommon, message::Request::ptr request)
234{
Vernon Mauery08a70aa2018-11-07 09:36:22 -0800235 // filter the command first; a non-null message::Response::ptr
236 // means that the message has been rejected for some reason
Vernon Mauery51f78142020-01-13 16:28:59 -0800237 message::Response::ptr filterResponse = filterIpmiCommand(request);
Vernon Mauery08a70aa2018-11-07 09:36:22 -0800238
Vernon Mauery240b1862018-10-08 12:05:16 -0700239 Cmd cmd = request->ctx->cmd;
240 unsigned int key = makeCmdKey(keyCommon, cmd);
241 auto cmdIter = handlers.find(key);
242 if (cmdIter != handlers.end())
243 {
Vernon Mauery51f78142020-01-13 16:28:59 -0800244 // only return the filter response if the command is found
245 if (filterResponse)
246 {
247 return filterResponse;
248 }
Vernon Mauery240b1862018-10-08 12:05:16 -0700249 HandlerTuple& chosen = cmdIter->second;
250 if (request->ctx->priv < std::get<Privilege>(chosen))
251 {
252 return errorResponse(request, ccInsufficientPrivilege);
253 }
254 return std::get<HandlerBase::ptr>(chosen)->call(request);
255 }
256 else
257 {
258 unsigned int wildcard = makeCmdKey(keyCommon, cmdWildcard);
259 cmdIter = handlers.find(wildcard);
260 if (cmdIter != handlers.end())
261 {
Vernon Mauery51f78142020-01-13 16:28:59 -0800262 // only return the filter response if the command is found
263 if (filterResponse)
264 {
265 return filterResponse;
266 }
Vernon Mauery240b1862018-10-08 12:05:16 -0700267 HandlerTuple& chosen = cmdIter->second;
268 if (request->ctx->priv < std::get<Privilege>(chosen))
269 {
270 return errorResponse(request, ccInsufficientPrivilege);
271 }
272 return std::get<HandlerBase::ptr>(chosen)->call(request);
273 }
274 }
275 return errorResponse(request, ccInvalidCommand);
276}
277
Vernon Maueryf984a012018-10-08 12:05:18 -0700278message::Response::ptr executeIpmiGroupCommand(message::Request::ptr request)
279{
280 // look up the group for this request
William A. Kennington IIId10d9052019-04-24 01:57:36 -0700281 uint8_t bytes;
282 if (0 != request->payload.unpack(bytes))
Vernon Maueryf984a012018-10-08 12:05:18 -0700283 {
284 return errorResponse(request, ccReqDataLenInvalid);
285 }
William A. Kennington IIId10d9052019-04-24 01:57:36 -0700286 auto group = static_cast<Group>(bytes);
Vernon Maueryf984a012018-10-08 12:05:18 -0700287 message::Response::ptr response =
288 executeIpmiCommandCommon(groupHandlerMap, group, request);
William A. Kennington IIIda31f9a2019-04-25 01:36:32 -0700289 ipmi::message::Payload prefix;
290 prefix.pack(bytes);
291 response->prepend(prefix);
Vernon Maueryf984a012018-10-08 12:05:18 -0700292 return response;
293}
294
295message::Response::ptr executeIpmiOemCommand(message::Request::ptr request)
296{
297 // look up the iana for this request
William A. Kennington IIId10d9052019-04-24 01:57:36 -0700298 uint24_t bytes;
299 if (0 != request->payload.unpack(bytes))
Vernon Maueryf984a012018-10-08 12:05:18 -0700300 {
301 return errorResponse(request, ccReqDataLenInvalid);
302 }
William A. Kennington IIId10d9052019-04-24 01:57:36 -0700303 auto iana = static_cast<Iana>(bytes);
Vernon Maueryf984a012018-10-08 12:05:18 -0700304 message::Response::ptr response =
305 executeIpmiCommandCommon(oemHandlerMap, iana, request);
William A. Kennington IIIda31f9a2019-04-25 01:36:32 -0700306 ipmi::message::Payload prefix;
307 prefix.pack(bytes);
308 response->prepend(prefix);
Vernon Maueryf984a012018-10-08 12:05:18 -0700309 return response;
310}
311
Vernon Mauery240b1862018-10-08 12:05:16 -0700312message::Response::ptr executeIpmiCommand(message::Request::ptr request)
313{
314 NetFn netFn = request->ctx->netFn;
Vernon Maueryf984a012018-10-08 12:05:18 -0700315 if (netFnGroup == netFn)
316 {
317 return executeIpmiGroupCommand(request);
318 }
319 else if (netFnOem == netFn)
320 {
321 return executeIpmiOemCommand(request);
322 }
Vernon Mauery240b1862018-10-08 12:05:16 -0700323 return executeIpmiCommandCommon(handlerMap, netFn, request);
324}
325
Vernon Mauery735ee952019-02-15 13:38:52 -0800326namespace utils
327{
328template <typename AssocContainer, typename UnaryPredicate>
329void assoc_erase_if(AssocContainer& c, UnaryPredicate p)
330{
331 typename AssocContainer::iterator next = c.begin();
332 typename AssocContainer::iterator last = c.end();
333 while ((next = std::find_if(next, last, p)) != last)
334 {
335 c.erase(next++);
336 }
337}
338} // namespace utils
339
340namespace
341{
342std::unordered_map<std::string, uint8_t> uniqueNameToChannelNumber;
343
344// sdbusplus::bus::match::rules::arg0namespace() wants the prefix
345// to match without any trailing '.'
346constexpr const char ipmiDbusChannelMatch[] =
347 "xyz.openbmc_project.Ipmi.Channel";
348void updateOwners(sdbusplus::asio::connection& conn, const std::string& name)
349{
350 conn.async_method_call(
351 [name](const boost::system::error_code ec,
352 const std::string& nameOwner) {
353 if (ec)
354 {
355 log<level::ERR>("Error getting dbus owner",
356 entry("INTERFACE=%s", name.c_str()));
357 return;
358 }
359 // start after ipmiDbusChannelPrefix (after the '.')
360 std::string chName =
361 name.substr(std::strlen(ipmiDbusChannelMatch) + 1);
362 try
363 {
364 uint8_t channel = getChannelByName(chName);
365 uniqueNameToChannelNumber[nameOwner] = channel;
366 log<level::INFO>("New interface mapping",
367 entry("INTERFACE=%s", name.c_str()),
368 entry("CHANNEL=%u", channel));
369 }
370 catch (const std::exception& e)
371 {
372 log<level::INFO>("Failed interface mapping, no such name",
373 entry("INTERFACE=%s", name.c_str()));
374 }
375 },
376 "org.freedesktop.DBus", "/", "org.freedesktop.DBus", "GetNameOwner",
377 name);
378}
379
Ed Tanous778418d2020-08-17 23:20:21 -0700380void doListNames(boost::asio::io_context& io, sdbusplus::asio::connection& conn)
Vernon Mauery735ee952019-02-15 13:38:52 -0800381{
382 conn.async_method_call(
383 [&io, &conn](const boost::system::error_code ec,
384 std::vector<std::string> busNames) {
385 if (ec)
386 {
387 log<level::ERR>("Error getting dbus names");
388 std::exit(EXIT_FAILURE);
389 return;
390 }
391 // Try to make startup consistent
392 std::sort(busNames.begin(), busNames.end());
393
394 const std::string channelPrefix =
395 std::string(ipmiDbusChannelMatch) + ".";
396 for (const std::string& busName : busNames)
397 {
398 if (busName.find(channelPrefix) == 0)
399 {
400 updateOwners(conn, busName);
401 }
402 }
403 },
404 "org.freedesktop.DBus", "/org/freedesktop/DBus", "org.freedesktop.DBus",
405 "ListNames");
406}
407
408void nameChangeHandler(sdbusplus::message::message& message)
409{
410 std::string name;
411 std::string oldOwner;
412 std::string newOwner;
413
414 message.read(name, oldOwner, newOwner);
415
416 if (!oldOwner.empty())
417 {
418 if (boost::starts_with(oldOwner, ":"))
419 {
420 // Connection removed
421 auto it = uniqueNameToChannelNumber.find(oldOwner);
422 if (it != uniqueNameToChannelNumber.end())
423 {
424 uniqueNameToChannelNumber.erase(it);
425 }
426 }
427 }
428 if (!newOwner.empty())
429 {
430 // start after ipmiDbusChannelMatch (and after the '.')
431 std::string chName = name.substr(std::strlen(ipmiDbusChannelMatch) + 1);
432 try
433 {
434 uint8_t channel = getChannelByName(chName);
435 uniqueNameToChannelNumber[newOwner] = channel;
436 log<level::INFO>("New interface mapping",
437 entry("INTERFACE=%s", name.c_str()),
438 entry("CHANNEL=%u", channel));
439 }
440 catch (const std::exception& e)
441 {
442 log<level::INFO>("Failed interface mapping, no such name",
443 entry("INTERFACE=%s", name.c_str()));
444 }
445 }
446};
447
448} // anonymous namespace
449
450static constexpr const char intraBmcName[] = "INTRABMC";
451uint8_t channelFromMessage(sdbusplus::message::message& msg)
452{
453 // channel name for ipmitool to resolve to
454 std::string sender = msg.get_sender();
455 auto chIter = uniqueNameToChannelNumber.find(sender);
456 if (chIter != uniqueNameToChannelNumber.end())
457 {
458 return chIter->second;
459 }
460 // FIXME: currently internal connections are ephemeral and hard to pin down
461 try
462 {
463 return getChannelByName(intraBmcName);
464 }
465 catch (const std::exception& e)
466 {
467 return invalidChannel;
468 }
469} // namespace ipmi
470
Vernon Mauery240b1862018-10-08 12:05:16 -0700471/* called from sdbus async server context */
Vernon Mauery735ee952019-02-15 13:38:52 -0800472auto executionEntry(boost::asio::yield_context yield,
473 sdbusplus::message::message& m, NetFn netFn, uint8_t lun,
Vernon Mauery240b1862018-10-08 12:05:16 -0700474 Cmd cmd, std::vector<uint8_t>& data,
475 std::map<std::string, ipmi::Value>& options)
476{
Vernon Mauery735ee952019-02-15 13:38:52 -0800477 const auto dbusResponse =
478 [netFn, lun, cmd](Cc cc, const std::vector<uint8_t>& data = {}) {
479 constexpr uint8_t netFnResponse = 0x01;
480 uint8_t retNetFn = netFn | netFnResponse;
481 return std::make_tuple(retNetFn, lun, cmd, cc, data);
482 };
483 std::string sender = m.get_sender();
484 Privilege privilege = Privilege::None;
Vernon Maueryd6a2da02019-04-09 16:00:46 -0700485 int rqSA = 0;
Kumar Thangavelf7d081f2020-08-19 20:41:18 +0530486 int hostIdx = 0;
Vernon Mauery735ee952019-02-15 13:38:52 -0800487 uint8_t userId = 0; // undefined user
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +0530488 uint32_t sessionId = 0;
Vernon Mauery735ee952019-02-15 13:38:52 -0800489
490 // figure out what channel the request came in on
491 uint8_t channel = channelFromMessage(m);
492 if (channel == invalidChannel)
493 {
494 // unknown sender channel; refuse to service the request
495 log<level::ERR>("ERROR determining source IPMI channel",
496 entry("SENDER=%s", sender.c_str()),
497 entry("NETFN=0x%X", netFn), entry("CMD=0x%X", cmd));
498 return dbusResponse(ipmi::ccDestinationUnavailable);
499 }
500
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +0530501 // session-based channels are required to provide userId, privilege and
502 // sessionId
Vernon Mauery735ee952019-02-15 13:38:52 -0800503 if (getChannelSessionSupport(channel) != EChannelSessSupported::none)
504 {
505 try
506 {
507 Value requestPriv = options.at("privilege");
508 Value requestUserId = options.at("userId");
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +0530509 Value requestSessionId = options.at("currentSessionId");
Vernon Mauery735ee952019-02-15 13:38:52 -0800510 privilege = static_cast<Privilege>(std::get<int>(requestPriv));
511 userId = static_cast<uint8_t>(std::get<int>(requestUserId));
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +0530512 sessionId =
513 static_cast<uint32_t>(std::get<uint32_t>(requestSessionId));
Vernon Mauery735ee952019-02-15 13:38:52 -0800514 }
515 catch (const std::exception& e)
516 {
517 log<level::ERR>("ERROR determining IPMI session credentials",
518 entry("CHANNEL=%u", channel),
519 entry("NETFN=0x%X", netFn), entry("CMD=0x%X", cmd));
520 return dbusResponse(ipmi::ccUnspecifiedError);
521 }
522 }
523 else
524 {
525 // get max privilege for session-less channels
526 // For now, there is not a way to configure this, default to Admin
527 privilege = Privilege::Admin;
Vernon Maueryd6a2da02019-04-09 16:00:46 -0700528
529 // ipmb should supply rqSA
530 ChannelInfo chInfo;
531 getChannelInfo(channel, chInfo);
532 if (static_cast<EChannelMediumType>(chInfo.mediumType) ==
533 EChannelMediumType::ipmb)
534 {
535 const auto iter = options.find("rqSA");
536 if (iter != options.end())
537 {
538 if (std::holds_alternative<int>(iter->second))
539 {
540 rqSA = std::get<int>(iter->second);
541 }
542 }
Kumar Thangavelf7d081f2020-08-19 20:41:18 +0530543 const auto iteration = options.find("hostId");
544 if (iteration != options.end())
545 {
546 if (std::holds_alternative<int>(iteration->second))
547 {
548 hostIdx = std::get<int>(iteration->second);
549 }
550 }
Vernon Maueryd6a2da02019-04-09 16:00:46 -0700551 }
Vernon Mauery735ee952019-02-15 13:38:52 -0800552 }
553 // check to see if the requested priv/username is valid
554 log<level::DEBUG>("Set up ipmi context", entry("SENDER=%s", sender.c_str()),
Johnathan Manteyc11cc5c2020-07-22 13:52:33 -0700555 entry("NETFN=0x%X", netFn), entry("LUN=0x%X", lun),
556 entry("CMD=0x%X", cmd), entry("CHANNEL=%u", channel),
557 entry("USERID=%u", userId),
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +0530558 entry("SESSIONID=0x%X", sessionId),
Vernon Maueryd6a2da02019-04-09 16:00:46 -0700559 entry("PRIVILEGE=%u", static_cast<uint8_t>(privilege)),
560 entry("RQSA=%x", rqSA));
Vernon Mauery735ee952019-02-15 13:38:52 -0800561
Johnathan Manteyc11cc5c2020-07-22 13:52:33 -0700562 auto ctx = std::make_shared<ipmi::Context>(getSdBus(), netFn, lun, cmd,
563 channel, userId, sessionId,
Kumar Thangavelf7d081f2020-08-19 20:41:18 +0530564 privilege, rqSA, hostIdx, yield);
Vernon Mauery240b1862018-10-08 12:05:16 -0700565 auto request = std::make_shared<ipmi::message::Request>(
566 ctx, std::forward<std::vector<uint8_t>>(data));
567 message::Response::ptr response = executeIpmiCommand(request);
568
Vernon Mauery735ee952019-02-15 13:38:52 -0800569 return dbusResponse(response->cc, response->payload.raw);
Vernon Mauery240b1862018-10-08 12:05:16 -0700570}
571
572/** @struct IpmiProvider
573 *
574 * RAII wrapper for dlopen so that dlclose gets called on exit
575 */
576struct IpmiProvider
577{
578 public:
579 /** @brief address of the opened library */
580 void* addr;
581 std::string name;
582
583 IpmiProvider() = delete;
584 IpmiProvider(const IpmiProvider&) = delete;
585 IpmiProvider& operator=(const IpmiProvider&) = delete;
586 IpmiProvider(IpmiProvider&&) = delete;
587 IpmiProvider& operator=(IpmiProvider&&) = delete;
588
589 /** @brief dlopen a shared object file by path
590 * @param[in] filename - path of shared object to open
591 */
592 explicit IpmiProvider(const char* fname) : addr(nullptr), name(fname)
593 {
594 log<level::DEBUG>("Open IPMI provider library",
595 entry("PROVIDER=%s", name.c_str()));
596 try
597 {
598 addr = dlopen(name.c_str(), RTLD_NOW);
599 }
600 catch (std::exception& e)
601 {
602 log<level::ERR>("ERROR opening IPMI provider",
603 entry("PROVIDER=%s", name.c_str()),
604 entry("ERROR=%s", e.what()));
605 }
606 catch (...)
607 {
608 std::exception_ptr eptr = std::current_exception();
609 try
610 {
611 std::rethrow_exception(eptr);
612 }
613 catch (std::exception& e)
614 {
615 log<level::ERR>("ERROR opening IPMI provider",
616 entry("PROVIDER=%s", name.c_str()),
617 entry("ERROR=%s", e.what()));
618 }
619 }
620 if (!isOpen())
621 {
622 log<level::ERR>("ERROR opening IPMI provider",
623 entry("PROVIDER=%s", name.c_str()),
624 entry("ERROR=%s", dlerror()));
625 }
626 }
627
628 ~IpmiProvider()
629 {
630 if (isOpen())
631 {
632 dlclose(addr);
633 }
634 }
635 bool isOpen() const
636 {
637 return (nullptr != addr);
638 }
639};
640
641// Plugin libraries need to contain .so either at the end or in the middle
642constexpr const char ipmiPluginExtn[] = ".so";
643
644/* return a list of self-closing library handles */
645std::forward_list<IpmiProvider> loadProviders(const fs::path& ipmiLibsPath)
646{
647 std::vector<fs::path> libs;
648 for (const auto& libPath : fs::directory_iterator(ipmiLibsPath))
649 {
Vernon Maueryb0ab5fe2019-03-06 14:03:00 -0800650 std::error_code ec;
Vernon Mauery240b1862018-10-08 12:05:16 -0700651 fs::path fname = libPath.path();
Vernon Maueryb0ab5fe2019-03-06 14:03:00 -0800652 if (fs::is_symlink(fname, ec) || ec)
653 {
654 // it's a symlink or some other error; skip it
655 continue;
656 }
Vernon Mauery240b1862018-10-08 12:05:16 -0700657 while (fname.has_extension())
658 {
659 fs::path extn = fname.extension();
660 if (extn == ipmiPluginExtn)
661 {
662 libs.push_back(libPath.path());
663 break;
664 }
665 fname.replace_extension();
666 }
667 }
668 std::sort(libs.begin(), libs.end());
669
670 std::forward_list<IpmiProvider> handles;
671 for (auto& lib : libs)
672 {
673#ifdef __IPMI_DEBUG__
674 log<level::DEBUG>("Registering handler",
675 entry("HANDLER=%s", lib.c_str()));
676#endif
677 handles.emplace_front(lib.c_str());
678 }
679 return handles;
680}
681
682} // namespace ipmi
683
Vernon Mauery240b1862018-10-08 12:05:16 -0700684#ifdef ALLOW_DEPRECATED_API
685/* legacy registration */
686void ipmi_register_callback(ipmi_netfn_t netFn, ipmi_cmd_t cmd,
687 ipmi_context_t context, ipmid_callback_t handler,
688 ipmi_cmd_privilege_t priv)
689{
Vernon Mauerybe376302019-03-21 13:02:05 -0700690 auto h = ipmi::makeLegacyHandler(handler, context);
Vernon Mauery240b1862018-10-08 12:05:16 -0700691 // translate priv from deprecated enum to current
692 ipmi::Privilege realPriv;
693 switch (priv)
694 {
695 case PRIVILEGE_CALLBACK:
696 realPriv = ipmi::Privilege::Callback;
697 break;
698 case PRIVILEGE_USER:
699 realPriv = ipmi::Privilege::User;
700 break;
701 case PRIVILEGE_OPERATOR:
702 realPriv = ipmi::Privilege::Operator;
703 break;
704 case PRIVILEGE_ADMIN:
705 realPriv = ipmi::Privilege::Admin;
706 break;
707 case PRIVILEGE_OEM:
708 realPriv = ipmi::Privilege::Oem;
709 break;
710 case SYSTEM_INTERFACE:
711 realPriv = ipmi::Privilege::Admin;
712 break;
713 default:
714 realPriv = ipmi::Privilege::Admin;
715 break;
716 }
Vernon Mauerye8d43232019-03-26 16:23:43 -0700717 // The original ipmi_register_callback allowed for group OEM handlers
718 // to be registered via this same interface. It just so happened that
719 // all the handlers were part of the DCMI group, so default to that.
720 if (netFn == NETFUN_GRPEXT)
721 {
722 ipmi::impl::registerGroupHandler(ipmi::prioOpenBmcBase,
723 dcmi::groupExtId, cmd, realPriv, h);
724 }
725 else
726 {
727 ipmi::impl::registerHandler(ipmi::prioOpenBmcBase, netFn, cmd, realPriv,
728 h);
729 }
Vernon Mauery240b1862018-10-08 12:05:16 -0700730}
731
Vernon Maueryf984a012018-10-08 12:05:18 -0700732namespace oem
733{
734
735class LegacyRouter : public oem::Router
736{
737 public:
738 virtual ~LegacyRouter()
739 {
740 }
741
742 /// Enable message routing to begin.
743 void activate() override
744 {
745 }
746
747 void registerHandler(Number oen, ipmi_cmd_t cmd, Handler handler) override
748 {
749 auto h = ipmi::makeLegacyHandler(std::forward<Handler>(handler));
750 ipmi::impl::registerOemHandler(ipmi::prioOpenBmcBase, oen, cmd,
751 ipmi::Privilege::Admin, h);
752 }
753};
754static LegacyRouter legacyRouter;
755
756Router* mutableRouter()
757{
758 return &legacyRouter;
759}
760
761} // namespace oem
762
Vernon Mauery240b1862018-10-08 12:05:16 -0700763/* legacy alternative to executionEntry */
764void handleLegacyIpmiCommand(sdbusplus::message::message& m)
765{
Vernon Mauery23b70212019-05-08 15:19:05 -0700766 // make a copy so the next two moves don't wreak havoc on the stack
767 sdbusplus::message::message b{m};
768 boost::asio::spawn(*getIoContext(), [b = std::move(b)](
769 boost::asio::yield_context yield) {
770 sdbusplus::message::message m{std::move(b)};
771 unsigned char seq, netFn, lun, cmd;
772 std::vector<uint8_t> data;
Vernon Mauery240b1862018-10-08 12:05:16 -0700773
Vernon Mauery23b70212019-05-08 15:19:05 -0700774 m.read(seq, netFn, lun, cmd, data);
Vernon Mauery33298af2019-05-13 15:32:37 -0700775 std::shared_ptr<sdbusplus::asio::connection> bus = getSdBus();
Vernon Mauery23b70212019-05-08 15:19:05 -0700776 auto ctx = std::make_shared<ipmi::Context>(
Kumar Thangavelf7d081f2020-08-19 20:41:18 +0530777 bus, netFn, lun, cmd, 0, 0, 0, ipmi::Privilege::Admin, 0, 0, yield);
Vernon Mauery23b70212019-05-08 15:19:05 -0700778 auto request = std::make_shared<ipmi::message::Request>(
779 ctx, std::forward<std::vector<uint8_t>>(data));
780 ipmi::message::Response::ptr response =
781 ipmi::executeIpmiCommand(request);
Vernon Mauery240b1862018-10-08 12:05:16 -0700782
Vernon Mauery23b70212019-05-08 15:19:05 -0700783 // Responses in IPMI require a bit set. So there ya go...
784 netFn |= 0x01;
Vernon Mauery240b1862018-10-08 12:05:16 -0700785
Vernon Mauery23b70212019-05-08 15:19:05 -0700786 const char *dest, *path;
787 constexpr const char* DBUS_INTF = "org.openbmc.HostIpmi";
Vernon Mauery240b1862018-10-08 12:05:16 -0700788
Vernon Mauery23b70212019-05-08 15:19:05 -0700789 dest = m.get_sender();
790 path = m.get_path();
791 boost::system::error_code ec;
Vernon Mauery33298af2019-05-13 15:32:37 -0700792 bus->yield_method_call(yield, ec, dest, path, DBUS_INTF, "sendMessage",
793 seq, netFn, lun, cmd, response->cc,
794 response->payload.raw);
Vernon Mauery23b70212019-05-08 15:19:05 -0700795 if (ec)
796 {
797 log<level::ERR>("Failed to send response to requestor",
798 entry("ERROR=%s", ec.message().c_str()),
799 entry("SENDER=%s", dest),
800 entry("NETFN=0x%X", netFn), entry("CMD=0x%X", cmd));
801 }
802 });
Vernon Mauery240b1862018-10-08 12:05:16 -0700803}
804
805#endif /* ALLOW_DEPRECATED_API */
806
807// Calls host command manager to do the right thing for the command
808using CommandHandler = phosphor::host::command::CommandHandler;
809std::unique_ptr<phosphor::host::command::Manager> cmdManager;
810void ipmid_send_cmd_to_host(CommandHandler&& cmd)
811{
Vernon Mauery1b7f6f22019-03-13 13:11:25 -0700812 return cmdManager->execute(std::forward<CommandHandler>(cmd));
Vernon Mauery240b1862018-10-08 12:05:16 -0700813}
814
815std::unique_ptr<phosphor::host::command::Manager>& ipmid_get_host_cmd_manager()
816{
817 return cmdManager;
818}
819
Vernon Mauery20ff3332019-03-01 16:52:25 -0800820// These are symbols that are present in libipmid, but not expected
821// to be used except here (or maybe a unit test), so declare them here
822extern void setIoContext(std::shared_ptr<boost::asio::io_context>& newIo);
823extern void setSdBus(std::shared_ptr<sdbusplus::asio::connection>& newBus);
824
Vernon Mauery240b1862018-10-08 12:05:16 -0700825int main(int argc, char* argv[])
826{
827 // Connect to system bus
Vernon Mauery20ff3332019-03-01 16:52:25 -0800828 auto io = std::make_shared<boost::asio::io_context>();
829 setIoContext(io);
Vernon Mauery240b1862018-10-08 12:05:16 -0700830 if (argc > 1 && std::string(argv[1]) == "-session")
831 {
832 sd_bus_default_user(&bus);
833 }
834 else
835 {
836 sd_bus_default_system(&bus);
837 }
Vernon Mauery20ff3332019-03-01 16:52:25 -0800838 auto sdbusp = std::make_shared<sdbusplus::asio::connection>(*io, bus);
839 setSdBus(sdbusp);
Vernon Mauery240b1862018-10-08 12:05:16 -0700840
841 // TODO: Hack to keep the sdEvents running.... Not sure why the sd_event
842 // queue stops running if we don't have a timer that keeps re-arming
843 phosphor::Timer t2([]() { ; });
844 t2.start(std::chrono::microseconds(500000), true);
845
846 // TODO: Remove all vestiges of sd_event from phosphor-host-ipmid
847 // until that is done, add the sd_event wrapper to the io object
848 sdbusplus::asio::sd_event_wrapper sdEvents(*io);
849
850 cmdManager = std::make_unique<phosphor::host::command::Manager>(*sdbusp);
851
852 // Register all command providers and filters
Vernon Mauery4ec4e402019-03-20 13:09:27 -0700853 std::forward_list<ipmi::IpmiProvider> providers =
854 ipmi::loadProviders(HOST_IPMI_LIB_PATH);
Vernon Mauery240b1862018-10-08 12:05:16 -0700855
Vernon Mauery240b1862018-10-08 12:05:16 -0700856#ifdef ALLOW_DEPRECATED_API
857 // listen on deprecated signal interface for kcs/bt commands
858 constexpr const char* FILTER = "type='signal',interface='org.openbmc."
859 "HostIpmi',member='ReceivedMessage'";
860 sdbusplus::bus::match::match oldIpmiInterface(*sdbusp, FILTER,
861 handleLegacyIpmiCommand);
862#endif /* ALLOW_DEPRECATED_API */
863
Vernon Mauery735ee952019-02-15 13:38:52 -0800864 // set up bus name watching to match channels with bus names
865 sdbusplus::bus::match::match nameOwnerChanged(
866 *sdbusp,
867 sdbusplus::bus::match::rules::nameOwnerChanged() +
868 sdbusplus::bus::match::rules::arg0namespace(
869 ipmi::ipmiDbusChannelMatch),
870 ipmi::nameChangeHandler);
871 ipmi::doListNames(*io, *sdbusp);
872
James Feistb0094a72019-11-26 09:07:15 -0800873 int exitCode = 0;
Vernon Mauery1b7f6f22019-03-13 13:11:25 -0700874 // set up boost::asio signal handling
875 std::function<SignalResponse(int)> stopAsioRunLoop =
James Feistb0094a72019-11-26 09:07:15 -0800876 [&io, &exitCode](int signalNumber) {
Vernon Mauery1b7f6f22019-03-13 13:11:25 -0700877 log<level::INFO>("Received signal; quitting",
878 entry("SIGNAL=%d", signalNumber));
879 io->stop();
James Feistb0094a72019-11-26 09:07:15 -0800880 exitCode = signalNumber;
Vernon Mauery1b7f6f22019-03-13 13:11:25 -0700881 return SignalResponse::breakExecution;
882 };
883 registerSignalHandler(ipmi::prioOpenBmcBase, SIGINT, stopAsioRunLoop);
884 registerSignalHandler(ipmi::prioOpenBmcBase, SIGTERM, stopAsioRunLoop);
885
Richard Marian Thomaiyar369406e2020-01-09 14:56:54 +0530886 sdbusp->request_name("xyz.openbmc_project.Ipmi.Host");
887 // Add bindings for inbound IPMI requests
888 auto server = sdbusplus::asio::object_server(sdbusp);
889 auto iface = server.add_interface("/xyz/openbmc_project/Ipmi",
890 "xyz.openbmc_project.Ipmi.Server");
891 iface->register_method("execute", ipmi::executionEntry);
892 iface->initialize();
893
Vernon Mauery240b1862018-10-08 12:05:16 -0700894 io->run();
895
Vernon Mauery1b7f6f22019-03-13 13:11:25 -0700896 // destroy all the IPMI handlers so the providers can unload safely
897 ipmi::handlerMap.clear();
898 ipmi::groupHandlerMap.clear();
899 ipmi::oemHandlerMap.clear();
900 ipmi::filterList.clear();
901 // unload the provider libraries
Vernon Mauery4ec4e402019-03-20 13:09:27 -0700902 providers.clear();
Vernon Mauery1b7f6f22019-03-13 13:11:25 -0700903
James Feistb0094a72019-11-26 09:07:15 -0800904 std::exit(exitCode);
Vernon Mauery240b1862018-10-08 12:05:16 -0700905}