forked from openbmc/phosphor-host-ipmid
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapphandler.cpp
1154 lines (1010 loc) · 38.5 KB
/
apphandler.cpp
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include "apphandler.hpp"
#include "app/channel.hpp"
#include "app/watchdog.hpp"
#include "ipmid.hpp"
#include "sys_info_param.hpp"
#include "transporthandler.hpp"
#include "types.hpp"
#include "utils.hpp"
#include <arpa/inet.h>
#include <host-ipmid/ipmid-api.h>
#include <limits.h>
#include <mapper.h>
#include <systemd/sd-bus.h>
#include <unistd.h>
#include <algorithm>
#include <array>
#include <cstddef>
#include <fstream>
#include <memory>
#include <nlohmann/json.hpp>
#include <phosphor-logging/elog-errors.hpp>
#include <phosphor-logging/log.hpp>
#include <sdbusplus/message/types.hpp>
#include <string>
#include <tuple>
#include <vector>
#include <xyz/openbmc_project/Common/error.hpp>
#include <xyz/openbmc_project/Control/Power/ACPIPowerState/server.hpp>
#include <xyz/openbmc_project/Software/Activation/server.hpp>
#include <xyz/openbmc_project/Software/Version/server.hpp>
#include <xyz/openbmc_project/State/BMC/server.hpp>
#if __has_include(<filesystem>)
#include <filesystem>
#elif __has_include(<experimental/filesystem>)
#include <experimental/filesystem>
namespace std
{
// splice experimental::filesystem into std
namespace filesystem = std::experimental::filesystem;
} // namespace std
#else
#error filesystem not available
#endif
extern sd_bus* bus;
constexpr auto bmc_state_interface = "xyz.openbmc_project.State.BMC";
constexpr auto bmc_state_property = "CurrentBMCState";
constexpr auto bmc_interface = "xyz.openbmc_project.Inventory.Item.Bmc";
constexpr auto bmc_guid_interface = "xyz.openbmc_project.Common.UUID";
constexpr auto bmc_guid_property = "UUID";
constexpr auto bmc_guid_len = 16;
static constexpr auto redundancyIntf =
"xyz.openbmc_project.Software.RedundancyPriority";
static constexpr auto versionIntf = "xyz.openbmc_project.Software.Version";
static constexpr auto activationIntf =
"xyz.openbmc_project.Software.Activation";
static constexpr auto softwareRoot = "/xyz/openbmc_project/software";
void register_netfn_app_functions() __attribute__((constructor));
using namespace phosphor::logging;
using namespace sdbusplus::xyz::openbmc_project::Common::Error;
using Version = sdbusplus::xyz::openbmc_project::Software::server::Version;
using Activation =
sdbusplus::xyz::openbmc_project::Software::server::Activation;
using BMC = sdbusplus::xyz::openbmc_project::State::server::BMC;
namespace fs = std::filesystem;
namespace variant_ns = sdbusplus::message::variant_ns;
// Offset in get device id command.
typedef struct
{
uint8_t id;
uint8_t revision;
uint8_t fw[2];
uint8_t ipmi_ver;
uint8_t addn_dev_support;
uint8_t manuf_id[3];
uint8_t prod_id[2];
uint8_t aux[4];
} __attribute__((packed)) ipmi_device_id_t;
/**
* @brief Returns the Version info from primary s/w object
*
* Get the Version info from the active s/w object which is having high
* "Priority" value(a smaller number is a higher priority) and "Purpose"
* is "BMC" from the list of all s/w objects those are implementing
* RedundancyPriority interface from the given softwareRoot path.
*
* @return On success returns the Version info from primary s/w object.
*
*/
std::string getActiveSoftwareVersionInfo()
{
sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()};
std::string revision{};
auto objectTree =
ipmi::getAllDbusObjects(bus, softwareRoot, redundancyIntf, "");
if (objectTree.empty())
{
log<level::ERR>("No Obj has implemented the s/w redundancy interface",
entry("INTERFACE=%s", redundancyIntf));
elog<InternalFailure>();
}
auto objectFound = false;
for (auto& softObject : objectTree)
{
auto service = ipmi::getService(bus, redundancyIntf, softObject.first);
auto objValueTree = ipmi::getManagedObjects(bus, service, softwareRoot);
auto minPriority = 0xFF;
for (const auto& objIter : objValueTree)
{
try
{
auto& intfMap = objIter.second;
auto& redundancyPriorityProps = intfMap.at(redundancyIntf);
auto& versionProps = intfMap.at(versionIntf);
auto& activationProps = intfMap.at(activationIntf);
auto priority = variant_ns::get<uint8_t>(
redundancyPriorityProps.at("Priority"));
auto purpose =
variant_ns::get<std::string>(versionProps.at("Purpose"));
auto activation = variant_ns::get<std::string>(
activationProps.at("Activation"));
auto version =
variant_ns::get<std::string>(versionProps.at("Version"));
if ((Version::convertVersionPurposeFromString(purpose) ==
Version::VersionPurpose::BMC) &&
(Activation::convertActivationsFromString(activation) ==
Activation::Activations::Active))
{
if (priority < minPriority)
{
minPriority = priority;
objectFound = true;
revision = std::move(version);
}
}
}
catch (const std::exception& e)
{
log<level::ERR>(e.what());
}
}
}
if (!objectFound)
{
log<level::ERR>("Could not found an BMC software Object");
elog<InternalFailure>();
}
return revision;
}
bool getCurrentBmcState()
{
sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()};
// Get the Inventory object implementing the BMC interface
ipmi::DbusObjectInfo bmcObject =
ipmi::getDbusObject(bus, bmc_state_interface);
auto variant =
ipmi::getDbusProperty(bus, bmcObject.second, bmcObject.first,
bmc_state_interface, bmc_state_property);
return variant_ns::holds_alternative<std::string>(variant) &&
BMC::convertBMCStateFromString(
variant_ns::get<std::string>(variant)) == BMC::BMCState::Ready;
}
namespace acpi_state
{
using namespace sdbusplus::xyz::openbmc_project::Control::Power::server;
const static constexpr char* acpiObjPath =
"/xyz/openbmc_project/control/host0/acpi_power_state";
const static constexpr char* acpiInterface =
"xyz.openbmc_project.Control.Power.ACPIPowerState";
const static constexpr char* sysACPIProp = "SysACPIStatus";
const static constexpr char* devACPIProp = "DevACPIStatus";
enum class PowerStateType : uint8_t
{
sysPowerState = 0x00,
devPowerState = 0x01,
};
// Defined in 20.6 of ipmi doc
enum class PowerState : uint8_t
{
s0G0D0 = 0x00,
s1D1 = 0x01,
s2D2 = 0x02,
s3D3 = 0x03,
s4 = 0x04,
s5G2 = 0x05,
s4S5 = 0x06,
g3 = 0x07,
sleep = 0x08,
g1Sleep = 0x09,
override = 0x0a,
legacyOn = 0x20,
legacyOff = 0x21,
unknown = 0x2a,
noChange = 0x7f,
};
static constexpr uint8_t stateChanged = 0x80;
struct ACPIState
{
uint8_t sysACPIState;
uint8_t devACPIState;
} __attribute__((packed));
std::map<ACPIPowerState::ACPI, PowerState> dbusToIPMI = {
{ACPIPowerState::ACPI::S0_G0_D0, PowerState::s0G0D0},
{ACPIPowerState::ACPI::S1_D1, PowerState::s1D1},
{ACPIPowerState::ACPI::S2_D2, PowerState::s2D2},
{ACPIPowerState::ACPI::S3_D3, PowerState::s3D3},
{ACPIPowerState::ACPI::S4, PowerState::s4},
{ACPIPowerState::ACPI::S5_G2, PowerState::s5G2},
{ACPIPowerState::ACPI::S4_S5, PowerState::s4S5},
{ACPIPowerState::ACPI::G3, PowerState::g3},
{ACPIPowerState::ACPI::SLEEP, PowerState::sleep},
{ACPIPowerState::ACPI::G1_SLEEP, PowerState::g1Sleep},
{ACPIPowerState::ACPI::OVERRIDE, PowerState::override},
{ACPIPowerState::ACPI::LEGACY_ON, PowerState::legacyOn},
{ACPIPowerState::ACPI::LEGACY_OFF, PowerState::legacyOff},
{ACPIPowerState::ACPI::Unknown, PowerState::unknown}};
bool isValidACPIState(acpi_state::PowerStateType type, uint8_t state)
{
if (type == acpi_state::PowerStateType::sysPowerState)
{
if ((state <= static_cast<uint8_t>(acpi_state::PowerState::override)) ||
(state == static_cast<uint8_t>(acpi_state::PowerState::legacyOn)) ||
(state ==
static_cast<uint8_t>(acpi_state::PowerState::legacyOff)) ||
(state == static_cast<uint8_t>(acpi_state::PowerState::unknown)) ||
(state == static_cast<uint8_t>(acpi_state::PowerState::noChange)))
{
return true;
}
else
{
return false;
}
}
else if (type == acpi_state::PowerStateType::devPowerState)
{
if ((state <= static_cast<uint8_t>(acpi_state::PowerState::s3D3)) ||
(state == static_cast<uint8_t>(acpi_state::PowerState::unknown)) ||
(state == static_cast<uint8_t>(acpi_state::PowerState::noChange)))
{
return true;
}
else
{
return false;
}
}
else
{
return false;
}
return false;
}
} // namespace acpi_state
ipmi_ret_t ipmi_app_set_acpi_power_state(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
ipmi_request_t request,
ipmi_response_t response,
ipmi_data_len_t data_len,
ipmi_context_t context)
{
auto s = static_cast<uint8_t>(acpi_state::PowerState::unknown);
ipmi_ret_t rc = IPMI_CC_OK;
sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()};
auto value = acpi_state::ACPIPowerState::ACPI::Unknown;
auto* req = reinterpret_cast<acpi_state::ACPIState*>(request);
if (*data_len != sizeof(acpi_state::ACPIState))
{
log<level::ERR>("set_acpi invalid len");
*data_len = 0;
return IPMI_CC_REQ_DATA_LEN_INVALID;
}
*data_len = 0;
if (req->sysACPIState & acpi_state::stateChanged)
{
// set system power state
s = req->sysACPIState & ~acpi_state::stateChanged;
if (!acpi_state::isValidACPIState(
acpi_state::PowerStateType::sysPowerState, s))
{
log<level::ERR>("set_acpi_power sys invalid input",
entry("S=%x", s));
return IPMI_CC_PARM_OUT_OF_RANGE;
}
// valid input
if (s == static_cast<uint8_t>(acpi_state::PowerState::noChange))
{
log<level::DEBUG>("No change for system power state");
}
else
{
auto found = std::find_if(
acpi_state::dbusToIPMI.begin(), acpi_state::dbusToIPMI.end(),
[&s](const auto& iter) {
return (static_cast<uint8_t>(iter.second) == s);
});
value = found->first;
try
{
auto acpiObject =
ipmi::getDbusObject(bus, acpi_state::acpiInterface);
ipmi::setDbusProperty(bus, acpiObject.second, acpiObject.first,
acpi_state::acpiInterface,
acpi_state::sysACPIProp,
convertForMessage(value));
}
catch (const InternalFailure& e)
{
log<level::ERR>("Failed in set ACPI system property",
entry("EXCEPTION=%s", e.what()));
return IPMI_CC_UNSPECIFIED_ERROR;
}
}
}
else
{
log<level::DEBUG>("Do not change system power state");
}
if (req->devACPIState & acpi_state::stateChanged)
{
// set device power state
s = req->devACPIState & ~acpi_state::stateChanged;
if (!acpi_state::isValidACPIState(
acpi_state::PowerStateType::devPowerState, s))
{
log<level::ERR>("set_acpi_power dev invalid input",
entry("S=%x", s));
return IPMI_CC_PARM_OUT_OF_RANGE;
}
// valid input
if (s == static_cast<uint8_t>(acpi_state::PowerState::noChange))
{
log<level::DEBUG>("No change for device power state");
}
else
{
auto found = std::find_if(
acpi_state::dbusToIPMI.begin(), acpi_state::dbusToIPMI.end(),
[&s](const auto& iter) {
return (static_cast<uint8_t>(iter.second) == s);
});
value = found->first;
try
{
auto acpiObject =
ipmi::getDbusObject(bus, acpi_state::acpiInterface);
ipmi::setDbusProperty(bus, acpiObject.second, acpiObject.first,
acpi_state::acpiInterface,
acpi_state::devACPIProp,
convertForMessage(value));
}
catch (const InternalFailure& e)
{
log<level::ERR>("Failed in set ACPI device property",
entry("EXCEPTION=%s", e.what()));
return IPMI_CC_UNSPECIFIED_ERROR;
}
}
}
else
{
log<level::DEBUG>("Do not change device power state");
}
return rc;
}
ipmi_ret_t ipmi_app_get_acpi_power_state(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
ipmi_request_t request,
ipmi_response_t response,
ipmi_data_len_t data_len,
ipmi_context_t context)
{
ipmi_ret_t rc = IPMI_CC_OK;
auto* res = reinterpret_cast<acpi_state::ACPIState*>(response);
sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()};
*data_len = 0;
try
{
auto acpiObject = ipmi::getDbusObject(bus, acpi_state::acpiInterface);
auto sysACPIVal = ipmi::getDbusProperty(
bus, acpiObject.second, acpiObject.first, acpi_state::acpiInterface,
acpi_state::sysACPIProp);
auto sysACPI = acpi_state::ACPIPowerState::convertACPIFromString(
variant_ns::get<std::string>(sysACPIVal));
res->sysACPIState =
static_cast<uint8_t>(acpi_state::dbusToIPMI.at(sysACPI));
auto devACPIVal = ipmi::getDbusProperty(
bus, acpiObject.second, acpiObject.first, acpi_state::acpiInterface,
acpi_state::devACPIProp);
auto devACPI = acpi_state::ACPIPowerState::convertACPIFromString(
variant_ns::get<std::string>(devACPIVal));
res->devACPIState =
static_cast<uint8_t>(acpi_state::dbusToIPMI.at(devACPI));
*data_len = sizeof(acpi_state::ACPIState);
}
catch (const InternalFailure& e)
{
log<level::ERR>("Failed in get ACPI property");
return IPMI_CC_UNSPECIFIED_ERROR;
}
return rc;
}
typedef struct
{
char major;
char minor;
uint16_t d[2];
} rev_t;
/* Currently supports the vx.x-x-[-x] and v1.x.x-x-[-x] format. It will */
/* return -1 if not in those formats, this routine knows how to parse */
/* version = v0.6-19-gf363f61-dirty */
/* ^ ^ ^^ ^ */
/* | | |----------|-- additional details */
/* | |---------------- Minor */
/* |------------------ Major */
/* and version = v1.99.10-113-g65edf7d-r3-0-g9e4f715 */
/* ^ ^ ^^ ^ */
/* | | |--|---------- additional details */
/* | |---------------- Minor */
/* |------------------ Major */
/* Additional details : If the option group exists it will force Auxiliary */
/* Firmware Revision Information 4th byte to 1 indicating the build was */
/* derived with additional edits */
int convert_version(const char* p, rev_t* rev)
{
std::string s(p);
std::string token;
uint16_t commits;
auto location = s.find_first_of('v');
if (location != std::string::npos)
{
s = s.substr(location + 1);
}
if (!s.empty())
{
location = s.find_first_of(".");
if (location != std::string::npos)
{
rev->major =
static_cast<char>(std::stoi(s.substr(0, location), 0, 16));
token = s.substr(location + 1);
}
if (!token.empty())
{
location = token.find_first_of(".-");
if (location != std::string::npos)
{
rev->minor = static_cast<char>(
std::stoi(token.substr(0, location), 0, 16));
token = token.substr(location + 1);
}
}
// Capture the number of commits on top of the minor tag.
// I'm using BE format like the ipmi spec asked for
location = token.find_first_of(".-");
if (!token.empty())
{
commits = std::stoi(token.substr(0, location), 0, 16);
rev->d[0] = (commits >> 8) | (commits << 8);
// commit number we skip
location = token.find_first_of(".-");
if (location != std::string::npos)
{
token = token.substr(location + 1);
}
}
else
{
rev->d[0] = 0;
}
if (location != std::string::npos)
{
token = token.substr(location + 1);
}
// Any value of the optional parameter forces it to 1
location = token.find_first_of(".-");
if (location != std::string::npos)
{
token = token.substr(location + 1);
}
commits = (!token.empty()) ? 1 : 0;
// We do this operation to get this displayed in least significant bytes
// of ipmitool device id command.
rev->d[1] = (commits >> 8) | (commits << 8);
}
return 0;
}
ipmi_ret_t ipmi_app_get_device_id(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
ipmi_request_t request,
ipmi_response_t response,
ipmi_data_len_t data_len,
ipmi_context_t context)
{
ipmi_ret_t rc = IPMI_CC_OK;
int r = -1;
rev_t rev = {0};
static ipmi_device_id_t dev_id{};
static bool dev_id_initialized = false;
const char* filename = "/usr/share/ipmi-providers/dev_id.json";
constexpr auto ipmiDevIdStateShift = 7;
constexpr auto ipmiDevIdFw1Mask = ~(1 << ipmiDevIdStateShift);
// Data length
*data_len = sizeof(dev_id);
if (!dev_id_initialized)
{
try
{
auto version = getActiveSoftwareVersionInfo();
r = convert_version(version.c_str(), &rev);
}
catch (const std::exception& e)
{
log<level::ERR>(e.what());
}
if (r >= 0)
{
// bit7 identifies if the device is available
// 0=normal operation
// 1=device firmware, SDR update,
// or self-initialization in progress.
// The availability may change in run time, so mask here
// and initialize later.
dev_id.fw[0] = rev.major & ipmiDevIdFw1Mask;
rev.minor = (rev.minor > 99 ? 99 : rev.minor);
dev_id.fw[1] = rev.minor % 10 + (rev.minor / 10) * 16;
std::memcpy(&dev_id.aux, rev.d, 4);
}
// IPMI Spec version 2.0
dev_id.ipmi_ver = 2;
std::ifstream dev_id_file(filename);
if (dev_id_file.is_open())
{
auto data = nlohmann::json::parse(dev_id_file, nullptr, false);
if (!data.is_discarded())
{
dev_id.id = data.value("id", 0);
dev_id.revision = data.value("revision", 0);
dev_id.addn_dev_support = data.value("addn_dev_support", 0);
dev_id.manuf_id[2] = data.value("manuf_id", 0) >> 16;
dev_id.manuf_id[1] = data.value("manuf_id", 0) >> 8;
dev_id.manuf_id[0] = data.value("manuf_id", 0);
dev_id.prod_id[1] = data.value("prod_id", 0) >> 8;
dev_id.prod_id[0] = data.value("prod_id", 0);
dev_id.aux[3] = data.value("aux", 0);
dev_id.aux[2] = data.value("aux", 0) >> 8;
dev_id.aux[1] = data.value("aux", 0) >> 16;
dev_id.aux[0] = data.value("aux", 0) >> 24;
// Don't read the file every time if successful
dev_id_initialized = true;
}
else
{
log<level::ERR>("Device ID JSON parser failure");
rc = IPMI_CC_UNSPECIFIED_ERROR;
}
}
else
{
log<level::ERR>("Device ID file not found");
rc = IPMI_CC_UNSPECIFIED_ERROR;
}
}
// Set availability to the actual current BMC state
dev_id.fw[0] &= ipmiDevIdFw1Mask;
if (!getCurrentBmcState())
{
dev_id.fw[0] |= (1 << ipmiDevIdStateShift);
}
// Pack the actual response
std::memcpy(response, &dev_id, *data_len);
return rc;
}
ipmi_ret_t ipmi_app_get_self_test_results(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
ipmi_request_t request,
ipmi_response_t response,
ipmi_data_len_t data_len,
ipmi_context_t context)
{
ipmi_ret_t rc = IPMI_CC_OK;
// Byte 2:
// 55h - No error.
// 56h - Self Test function not implemented in this controller.
// 57h - Corrupted or inaccesssible data or devices.
// 58h - Fatal hardware error.
// FFh - reserved.
// all other: Device-specific 'internal failure'.
// Byte 3:
// For byte 2 = 55h, 56h, FFh: 00h
// For byte 2 = 58h, all other: Device-specific
// For byte 2 = 57h: self-test error bitfield.
// Note: returning 57h does not imply that all test were run.
// [7] 1b = Cannot access SEL device.
// [6] 1b = Cannot access SDR Repository.
// [5] 1b = Cannot access BMC FRU device.
// [4] 1b = IPMB signal lines do not respond.
// [3] 1b = SDR Repository empty.
// [2] 1b = Internal Use Area of BMC FRU corrupted.
// [1] 1b = controller update 'boot block' firmware corrupted.
// [0] 1b = controller operational firmware corrupted.
char selftestresults[2] = {0};
*data_len = 2;
selftestresults[0] = 0x56;
selftestresults[1] = 0;
std::memcpy(response, selftestresults, *data_len);
return rc;
}
ipmi_ret_t ipmi_app_get_device_guid(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
ipmi_request_t request,
ipmi_response_t response,
ipmi_data_len_t data_len,
ipmi_context_t context)
{
const char* objname = "/org/openbmc/control/chassis0";
const char* iface = "org.freedesktop.DBus.Properties";
const char* chassis_iface = "org.openbmc.control.Chassis";
sd_bus_message* reply = NULL;
sd_bus_error error = SD_BUS_ERROR_NULL;
int r = 0;
char* uuid = NULL;
char* busname = NULL;
// UUID is in RFC4122 format. Ex: 61a39523-78f2-11e5-9862-e6402cfc3223
// Per IPMI Spec 2.0 need to convert to 16 hex bytes and reverse the byte
// order
// Ex: 0x2332fc2c40e66298e511f2782395a361
const int resp_size = 16; // Response is 16 hex bytes per IPMI Spec
uint8_t resp_uuid[resp_size]; // Array to hold the formatted response
// Point resp end of array to save in reverse order
int resp_loc = resp_size - 1;
int i = 0;
char* tokptr = NULL;
char* id_octet = NULL;
size_t total_uuid_size = 0;
// 1 byte of resp is built from 2 chars of uuid.
constexpr size_t max_uuid_size = 2 * resp_size;
// Status code.
ipmi_ret_t rc = IPMI_CC_OK;
*data_len = 0;
// Call Get properties method with the interface and property name
r = mapper_get_service(bus, objname, &busname);
if (r < 0)
{
log<level::ERR>("Failed to get bus name", entry("BUS=%s", objname),
entry("ERRNO=0x%X", -r));
goto finish;
}
r = sd_bus_call_method(bus, busname, objname, iface, "Get", &error, &reply,
"ss", chassis_iface, "uuid");
if (r < 0)
{
log<level::ERR>("Failed to call Get Method", entry("ERRNO=0x%X", -r));
rc = IPMI_CC_UNSPECIFIED_ERROR;
goto finish;
}
r = sd_bus_message_read(reply, "v", "s", &uuid);
if (r < 0 || uuid == NULL)
{
log<level::ERR>("Failed to get a response", entry("ERRNO=0x%X", -r));
rc = IPMI_CC_RESPONSE_ERROR;
goto finish;
}
// Traverse the UUID
// Get the UUID octects separated by dash
id_octet = strtok_r(uuid, "-", &tokptr);
if (id_octet == NULL)
{
// Error
log<level::ERR>("Unexpected UUID format", entry("UUID=%s", uuid));
rc = IPMI_CC_RESPONSE_ERROR;
goto finish;
}
while (id_octet != NULL)
{
// Calculate the octet string size since it varies
// Divide it by 2 for the array size since 1 byte is built from 2 chars
int tmp_size = strlen(id_octet) / 2;
// Check if total UUID size has been exceeded
if ((total_uuid_size += strlen(id_octet)) > max_uuid_size)
{
// Error - UUID too long to store
log<level::ERR>("UUID too long", entry("UUID=%s", uuid));
rc = IPMI_CC_RESPONSE_ERROR;
goto finish;
}
for (i = 0; i < tmp_size; i++)
{
// Holder of the 2 chars that will become a byte
char tmp_array[3] = {0};
strncpy(tmp_array, id_octet, 2); // 2 chars at a time
int resp_byte = strtoul(tmp_array, NULL, 16); // Convert to hex byte
// Copy end to first
std::memcpy((void*)&resp_uuid[resp_loc], &resp_byte, 1);
resp_loc--;
id_octet += 2; // Finished with the 2 chars, advance
}
id_octet = strtok_r(NULL, "-", &tokptr); // Get next octet
}
// Data length
*data_len = resp_size;
// Pack the actual response
std::memcpy(response, &resp_uuid, *data_len);
finish:
sd_bus_error_free(&error);
reply = sd_bus_message_unref(reply);
free(busname);
return rc;
}
ipmi_ret_t ipmi_app_get_bt_capabilities(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
ipmi_request_t request,
ipmi_response_t response,
ipmi_data_len_t data_len,
ipmi_context_t context)
{
// Status code.
ipmi_ret_t rc = IPMI_CC_OK;
// Per IPMI 2.0 spec, the input and output buffer size must be the max
// buffer size minus one byte to allocate space for the length byte.
uint8_t str[] = {0x01, MAX_IPMI_BUFFER - 1, MAX_IPMI_BUFFER - 1, 0x0A,
0x01};
// Data length
*data_len = sizeof(str);
// Pack the actual response
std::memcpy(response, &str, *data_len);
return rc;
}
ipmi_ret_t ipmi_app_wildcard_handler(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
ipmi_request_t request,
ipmi_response_t response,
ipmi_data_len_t data_len,
ipmi_context_t context)
{
// Status code.
ipmi_ret_t rc = IPMI_CC_INVALID;
*data_len = strlen("THIS IS WILDCARD");
// Now pack actual response
std::memcpy(response, "THIS IS WILDCARD", *data_len);
return rc;
}
ipmi_ret_t ipmi_app_get_sys_guid(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
ipmi_request_t request,
ipmi_response_t response,
ipmi_data_len_t data_len,
ipmi_context_t context)
{
ipmi_ret_t rc = IPMI_CC_OK;
sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()};
try
{
// Get the Inventory object implementing BMC interface
ipmi::DbusObjectInfo bmcObject =
ipmi::getDbusObject(bus, bmc_interface);
// Read UUID property value from bmcObject
// UUID is in RFC4122 format Ex: 61a39523-78f2-11e5-9862-e6402cfc3223
auto variant =
ipmi::getDbusProperty(bus, bmcObject.second, bmcObject.first,
bmc_guid_interface, bmc_guid_property);
std::string guidProp = variant_ns::get<std::string>(variant);
// Erase "-" characters from the property value
guidProp.erase(std::remove(guidProp.begin(), guidProp.end(), '-'),
guidProp.end());
auto guidPropLen = guidProp.length();
// Validate UUID data
// Divide by 2 as 1 byte is built from 2 chars
if ((guidPropLen <= 0) || ((guidPropLen / 2) != bmc_guid_len))
{
log<level::ERR>("Invalid UUID property value",
entry("UUID_LENGTH=%d", guidPropLen));
return IPMI_CC_RESPONSE_ERROR;
}
// Convert data in RFC4122(MSB) format to LSB format
// Get 2 characters at a time as 1 byte is built from 2 chars and
// convert to hex byte
// TODO: Data printed for GUID command is not as per the
// GUID format defined in IPMI specification 2.0 section 20.8
// Ticket raised: https://sourceforge.net/p/ipmitool/bugs/501/
uint8_t respGuid[bmc_guid_len];
for (size_t i = 0, respLoc = (bmc_guid_len - 1);
i < guidPropLen && respLoc >= 0; i += 2, respLoc--)
{
auto value = static_cast<uint8_t>(
std::stoi(guidProp.substr(i, 2).c_str(), NULL, 16));
respGuid[respLoc] = value;
}
*data_len = bmc_guid_len;
std::memcpy(response, &respGuid, bmc_guid_len);
}
catch (const InternalFailure& e)
{
log<level::ERR>("Failed in reading BMC UUID property",
entry("INTERFACE=%s", bmc_interface),
entry("PROPERTY_INTERFACE=%s", bmc_guid_interface),
entry("PROPERTY=%s", bmc_guid_property));
return IPMI_CC_UNSPECIFIED_ERROR;
}
return rc;
}
static std::unique_ptr<SysInfoParamStore> sysInfoParamStore;
static std::string sysInfoReadSystemName()
{
// Use the BMC hostname as the "System Name."
char hostname[HOST_NAME_MAX + 1] = {};
if (gethostname(hostname, HOST_NAME_MAX) != 0)
{
perror("System info parameter: system name");
}
return hostname;
}
struct IpmiSysInfoResp
{
uint8_t paramRevision;
uint8_t setSelector;
union
{
struct
{
uint8_t encoding;
uint8_t stringLen;
uint8_t stringData0[14];
} __attribute__((packed));
uint8_t stringDataN[16];
uint8_t byteData;
};
} __attribute__((packed));
/**
* Split a string into (up to) 16-byte chunks as expected in response for get
* system info parameter.
*
* @param[in] fullString: Input string to be split
* @param[in] chunkIndex: Index of the chunk to be written out
* @param[in,out] chunk: Output data buffer; must have 14 byte capacity if
* chunk_index = 0 and 16-byte capacity otherwise
* @return the number of bytes written into the output buffer, or -EINVAL for
* invalid arguments.
*/
static int splitStringParam(const std::string& fullString, int chunkIndex,
uint8_t* chunk)
{
constexpr int maxChunk = 255;
constexpr int smallChunk = 14;
constexpr int chunkSize = 16;
if (chunkIndex > maxChunk || chunk == nullptr)
{
return -EINVAL;
}
try
{
std::string output;
if (chunkIndex == 0)
{
// Output must have 14 byte capacity.
output = fullString.substr(0, smallChunk);
}
else
{
// Output must have 16 byte capacity.
output = fullString.substr((chunkIndex * chunkSize) - 2, chunkSize);
}
std::memcpy(chunk, output.c_str(), output.length());
return output.length();
}
catch (const std::out_of_range& e)
{
// The position was beyond the end.
return -EINVAL;
}
}
/**
* Packs the Get Sys Info Request Item into the response.
*
* @param[in] paramString - the parameter.
* @param[in] setSelector - the selector
* @param[in,out] resp - the System info response.
* @return The number of bytes packed or failure from splitStringParam().
*/
static int packGetSysInfoResp(const std::string& paramString,
uint8_t setSelector, IpmiSysInfoResp* resp)
{
uint8_t* dataBuffer = resp->stringDataN;
resp->setSelector = setSelector;
if (resp->setSelector == 0) // First chunk has only 14 bytes.
{
resp->encoding = 0;
resp->stringLen = paramString.length();