blob: 9a19e7d224f736fb94008fe02ab269dac47db650 [file] [log] [blame]
Ratan Gupta0b77cfa2017-01-31 17:32:31 +05301#include <exception>
Vishwa4be4b7a2015-10-31 22:55:50 -05002#include <vector>
3#include <stdlib.h>
4#include <dlfcn.h>
5#include <errno.h>
6#include <stdio.h>
Vishwa4be4b7a2015-10-31 22:55:50 -05007#include <systemd/sd-bus.h>
Chris Austenb45c4cb2015-11-01 06:34:56 -06008#include <unistd.h>
vishwa13555bd2015-11-10 12:10:38 -06009#include <host-ipmid/ipmid-api.h>
vishwac93d6d42015-12-16 11:55:16 -060010#include <iostream>
11#include <memory>
12#include <algorithm>
13#include <fstream>
Yi Li75c2d462016-04-11 16:57:46 +080014#include <sstream>
Brad Bishopde6a3792016-07-25 17:09:12 -040015#include <mapper.h>
Ratan Gupta19c617b2017-02-10 15:39:40 +053016#include "frup.hpp"
Matthew Barth155c34f2016-10-18 14:33:17 -050017#include "fru-area.hpp"
Ratan Gupta0b77cfa2017-01-31 17:32:31 +053018#include <sdbusplus/server.hpp>
Vishwa4be4b7a2015-10-31 22:55:50 -050019
20// OpenBMC System Manager dbus framework
vishwa13555bd2015-11-10 12:10:38 -060021const char *sys_object_name = "/org/openbmc/managers/System";
22const char *sys_intf_name = "org.openbmc.managers.System";
Vishwa4be4b7a2015-10-31 22:55:50 -050023
Ratan Guptacb0d4e52016-12-22 19:05:57 +053024extern const FruMap frus;
25
Ratan Gupta6eed4032017-02-10 15:59:31 +053026using Property = std::string;
27using Value = sdbusplus::message::variant<bool, int64_t, std::string>;
Ratan Guptacb0d4e52016-12-22 19:05:57 +053028// Association between property and its value
Ratan Gupta6eed4032017-02-10 15:59:31 +053029using PropertyMap = std::map<Property, Value>;
Ratan Guptacb0d4e52016-12-22 19:05:57 +053030
Ratan Gupta6eed4032017-02-10 15:59:31 +053031using Interface = std::string;
32// Association between interface and the dbus property
33using InterfaceMap = std::map<Interface, PropertyMap>;
34
35using Object = sdbusplus::message::object_path;
36
37// Association between object and the interfaces.
38using ObjectMap = std::map<Object, InterfaceMap>;
Ratan Guptacb0d4e52016-12-22 19:05:57 +053039
vishwac93d6d42015-12-16 11:55:16 -060040//----------------------------------------------------------------
41// Constructor
42//----------------------------------------------------------------
43ipmi_fru::ipmi_fru(const uint8_t fruid, const ipmi_fru_area_type type,
44 sd_bus *bus_type, bool bmc_fru)
45{
46 iv_fruid = fruid;
47 iv_type = type;
48 iv_bmc_fru = bmc_fru;
49 iv_bus_type = bus_type;
50 iv_valid = false;
51 iv_data = NULL;
52 iv_present = false;
53
54 if(iv_type == IPMI_FRU_AREA_INTERNAL_USE)
55 {
56 iv_name = "INTERNAL_";
57 }
58 else if(iv_type == IPMI_FRU_AREA_CHASSIS_INFO)
59 {
60 iv_name = "CHASSIS_";
61 }
62 else if(iv_type == IPMI_FRU_AREA_BOARD_INFO)
63 {
64 iv_name = "BOARD_";
65 }
66 else if(iv_type == IPMI_FRU_AREA_PRODUCT_INFO)
67 {
68 iv_name = "PRODUCT_";
69 }
70 else if(iv_type == IPMI_FRU_AREA_MULTI_RECORD)
71 {
72 iv_name = "MULTI_";
73 }
74 else
75 {
76 iv_name = IPMI_FRU_AREA_TYPE_MAX;
77 fprintf(stderr, "ERROR: Invalid Area type :[%d]\n",iv_type);
78 }
79}
80
81//-----------------------------------------------------
82// For a FRU area type, accepts the data and updates
83// area specific data.
84//-----------------------------------------------------
85void ipmi_fru::set_data(const uint8_t *data, const size_t len)
86{
87 iv_len = len;
88 iv_data = new uint8_t[len];
89 memcpy(iv_data, data, len);
90}
91
92//-----------------------------------------------------
93// Sets the dbus parameters
94//-----------------------------------------------------
95void ipmi_fru::update_dbus_paths(const char *bus_name,
96 const char *obj_path, const char *intf_name)
97{
98 iv_bus_name = bus_name;
99 iv_obj_path = obj_path;
100 iv_intf_name = intf_name;
101}
102
103//-------------------
104// Destructor
105//-------------------
106ipmi_fru::~ipmi_fru()
107{
108 sd_bus_error bus_error = SD_BUS_ERROR_NULL;
109 sd_bus_message *response = NULL;
110 int rc = 0;
111
112 if(iv_data != NULL)
113 {
114 delete [] iv_data;
115 iv_data = NULL;
116 }
117
118 // If we have not been successful in doing some updates and we are a BMC
119 // fru, then need to set the fault bits.
120 bool valid_dbus = !(iv_bus_name.empty()) &&
121 !(iv_obj_path.empty()) &&
122 !(iv_intf_name.empty());
123
124 // Based on bmc_fru, success in updating the FRU inventory we need to set
125 // some special bits.
126 if(iv_bmc_fru && valid_dbus)
127 {
128 // Set the Fault bit if we did not successfully process the fru
129 const char *fault_bit = iv_valid ? "False" : "True";
130
131 rc = sd_bus_call_method(iv_bus_type, // On the System Bus
132 iv_bus_name.c_str(), // Service to contact
133 iv_obj_path.c_str(), // Object path
134 iv_intf_name.c_str(), // Interface name
135 "setFault", // Method to be called
136 &bus_error, // object to return error
137 &response, // Response message on success
138 "s", // input message (string)
139 fault_bit); // First argument to setFault
140
141 if(rc <0)
142 {
143 fprintf(stderr,"Failed to set Fault bit, value:[%s] for fruid:[%d], path:[%s]\n",
144 fault_bit, iv_fruid, iv_obj_path.c_str());
145 }
146 else
147 {
148 printf("Fault bit set to :[%s] for fruid:[%d], Path:[%s]\n",
149 fault_bit, iv_fruid,iv_obj_path.c_str());
150 }
151
152 sd_bus_error_free(&bus_error);
153 sd_bus_message_unref(response);
154
155 // Set the Present bits
156 const char *present_bit = iv_present ? "True" : "False";
157
158 rc = sd_bus_call_method(iv_bus_type, // On the System Bus
159 iv_bus_name.c_str(), // Service to contact
160 iv_obj_path.c_str(), // Object path
161 iv_intf_name.c_str(), // Interface name
162 "setPresent", // Method to be called
163 &bus_error, // object to return error
164 &response, // Response message on success
165 "s", // input message (string)
166 present_bit); // First argument to setPresent
167 if(rc < 0)
168 {
169 fprintf(stderr,"Failed to set Present bit for fruid:[%d], path:[%s]\n",
170 iv_fruid, iv_obj_path.c_str());
171 }
172 else
173 {
Yi Li75c2d462016-04-11 16:57:46 +0800174 printf("Present bit set to :[%s] for fruid:[%d], Path[%s]:\n",
175 present_bit, iv_fruid, iv_obj_path.c_str());
vishwac93d6d42015-12-16 11:55:16 -0600176 }
177
178 sd_bus_error_free(&bus_error);
179 sd_bus_message_unref(response);
180 }
181}
182
183// Sets up the sd_bus structures for the given fru type
184int ipmi_fru::setup_sd_bus_paths(void)
185{
186 // Need this to get respective DBUS objects
187 sd_bus_error bus_error = SD_BUS_ERROR_NULL;
188 sd_bus_message *response = NULL;
189 int rc = 0;
190
191 // What we need is BOARD_1, PRODUCT_1, CHASSIS_1 etc..
Patrick Williams867da972016-08-17 17:40:05 -0500192 char *inv_bus_name = NULL;
193 const char *inv_obj_path = NULL,
Patrick Williams804077d2016-07-29 15:26:18 -0500194 *inv_intf_name = NULL;
vishwac93d6d42015-12-16 11:55:16 -0600195 char fru_area_name[16] = {0};
Brad Bishopde6a3792016-07-25 17:09:12 -0400196 char *sys_bus_name = NULL;
vishwac93d6d42015-12-16 11:55:16 -0600197 sprintf(fru_area_name,"%s%d",iv_name.c_str(), iv_fruid);
198
199#ifdef __IPMI_DEBUG__
200 printf("Getting sd_bus for :[%s]\n",fru_area_name);
201#endif
202
Brad Bishopde6a3792016-07-25 17:09:12 -0400203 rc = mapper_get_service(iv_bus_type, sys_object_name, &sys_bus_name);
204 if(rc < 0)
205 {
206 fprintf(stderr, "Failed to get system manager service:[%s]\n",
207 strerror(-rc));
208 goto exit;
209 }
210
vishwac93d6d42015-12-16 11:55:16 -0600211 // We want to call a method "getObjectFromId" on System Bus that is
212 // made available over OpenBmc system services.
Yi Li75c2d462016-04-11 16:57:46 +0800213
vishwac93d6d42015-12-16 11:55:16 -0600214 rc = sd_bus_call_method(iv_bus_type, // On the System Bus
215 sys_bus_name, // Service to contact
216 sys_object_name, // Object path
217 sys_intf_name, // Interface name
218 "getObjectFromId", // Method to be called
219 &bus_error, // object to return error
220 &response, // Response message on success
221 "ss", // input message (string,string)
222 "FRU_STR", // First argument to getObjectFromId
223 fru_area_name); // Second Argument
vishwac93d6d42015-12-16 11:55:16 -0600224 if(rc < 0)
225 {
226 fprintf(stderr, "Failed to resolve fruid:[%d] to dbus: [%s]\n", iv_fruid, bus_error.message);
227 }
228 else
229 {
Brad Bishopde6a3792016-07-25 17:09:12 -0400230 // Method getObjectFromId returns 2 parameters and all are strings, namely
231 // object_path and interface name for accessing that particular
232 // FRU over Inventory SDBUS manager. 'ss' here mentions that format.
233 rc = sd_bus_message_read(response, "(ss)", &inv_obj_path, &inv_intf_name);
vishwac93d6d42015-12-16 11:55:16 -0600234 if(rc < 0)
235 {
236 fprintf(stderr, "Failed to parse response message:[%s]\n", strerror(-rc));
237 }
238 else
239 {
Brad Bishopde6a3792016-07-25 17:09:12 -0400240 rc = mapper_get_service(iv_bus_type, inv_obj_path, &inv_bus_name);
241 if(rc < 0)
242 {
243 fprintf(stderr, "Failed to get inventory item service:[%s]\n",
244 strerror(-rc));
245 goto exit;
246 }
vishwac93d6d42015-12-16 11:55:16 -0600247 // Update the paths in the area object
248 update_dbus_paths(inv_bus_name, inv_obj_path, inv_intf_name);
249 }
250 }
251
Brad Bishopde6a3792016-07-25 17:09:12 -0400252exit:
vishwac93d6d42015-12-16 11:55:16 -0600253#ifdef __IPMI_DEBUG__
254 printf("fru_area=[%s], inv_bus_name=[%s], inv_obj_path=[%s], inv_intf_name=[%s]\n",
255 fru_area_name, inv_bus_name, inv_obj_path, inv_intf_name);
256#endif
257
Brad Bishopde6a3792016-07-25 17:09:12 -0400258 free(sys_bus_name);
Patrick Williams867da972016-08-17 17:40:05 -0500259 free(inv_bus_name);
vishwac93d6d42015-12-16 11:55:16 -0600260 sd_bus_error_free(&bus_error);
261 sd_bus_message_unref(response);
262
263 return rc;
264}
265
Vishwa4be4b7a2015-10-31 22:55:50 -0500266//------------------------------------------------
vishwaf3ca3522015-12-02 10:35:13 -0600267// Takes the pointer to stream of bytes and length
vishwac93d6d42015-12-16 11:55:16 -0600268// and returns the 8 bit checksum
269// This algo is per IPMI V2.0 spec
Vishwa4be4b7a2015-10-31 22:55:50 -0500270//-------------------------------------------------
vishwac93d6d42015-12-16 11:55:16 -0600271unsigned char calculate_crc(const unsigned char *data, size_t len)
Vishwa4be4b7a2015-10-31 22:55:50 -0500272{
273 char crc = 0;
vishwac93d6d42015-12-16 11:55:16 -0600274 size_t byte = 0;
Vishwa4be4b7a2015-10-31 22:55:50 -0500275
276 for(byte = 0; byte < len; byte++)
277 {
278 crc += *data++;
279 }
vishwaf3ca3522015-12-02 10:35:13 -0600280
Vishwa4be4b7a2015-10-31 22:55:50 -0500281 return(-crc);
282}
283
284//---------------------------------------------------------------------
285// Accepts a fru area offset in commom hdr and tells which area it is.
286//---------------------------------------------------------------------
vishwac93d6d42015-12-16 11:55:16 -0600287ipmi_fru_area_type get_fru_area_type(uint8_t area_offset)
Vishwa4be4b7a2015-10-31 22:55:50 -0500288{
289 ipmi_fru_area_type type = IPMI_FRU_AREA_TYPE_MAX;
290
291 switch(area_offset)
292 {
293 case IPMI_FRU_INTERNAL_OFFSET:
294 type = IPMI_FRU_AREA_INTERNAL_USE;
295 break;
296
297 case IPMI_FRU_CHASSIS_OFFSET:
298 type = IPMI_FRU_AREA_CHASSIS_INFO;
299 break;
300
301 case IPMI_FRU_BOARD_OFFSET:
302 type = IPMI_FRU_AREA_BOARD_INFO;
303 break;
304
305 case IPMI_FRU_PRODUCT_OFFSET:
306 type = IPMI_FRU_AREA_PRODUCT_INFO;
307 break;
308
309 case IPMI_FRU_MULTI_OFFSET:
310 type = IPMI_FRU_AREA_MULTI_RECORD;
311 break;
312
313 default:
314 type = IPMI_FRU_AREA_TYPE_MAX;
315 }
316
317 return type;
318}
319
vishwac93d6d42015-12-16 11:55:16 -0600320///-----------------------------------------------
321// Validates the data for crc and mandatory fields
322///-----------------------------------------------
323int verify_fru_data(const uint8_t *data, const size_t len)
324{
325 uint8_t checksum = 0;
326 int rc = -1;
327
328 // Validate for first byte to always have a value of [1]
329 if(data[0] != IPMI_FRU_HDR_BYTE_ZERO)
330 {
331 fprintf(stderr, "Invalid entry:[%d] in byte-0\n",data[0]);
332 return rc;
333 }
334#ifdef __IPMI_DEBUG__
335 else
336 {
337 printf("SUCCESS: Validated [0x%X] in entry_1 of fru_data\n",data[0]);
338 }
339#endif
340
341 // See if the calculated CRC matches with the embedded one.
342 // CRC to be calculated on all except the last one that is CRC itself.
343 checksum = calculate_crc(data, len - 1);
344 if(checksum != data[len-1])
345 {
346#ifdef __IPMI_DEBUG__
347 fprintf(stderr, "Checksum mismatch."
348 " Calculated:[0x%X], Embedded:[0x%X]\n",
349 checksum, data[len]);
350#endif
351 return rc;
352 }
353#ifdef __IPMI_DEBUG__
354 else
355 {
356 printf("SUCCESS: Checksum matches:[0x%X]\n",checksum);
357 }
358#endif
359
360 return EXIT_SUCCESS;
361}
362
Vishwa4be4b7a2015-10-31 22:55:50 -0500363//------------------------------------------------------------------------
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530364// Gets the value of the key from the fru dictionary of the given section.
365// FRU dictionary is parsed fru data for all the sections.
366//------------------------------------------------------------------------
367
368std::string getFRUValue(const std::string& section,
369 const std::string& key,
370 IPMIFruInfo& fruData)
371{
372
373 auto minIndexValue = 0;
374 auto maxIndexValue = 0;
375 std::string fruValue = "";
376 if (section == "Board")
377 {
378 minIndexValue = OPENBMC_VPD_KEY_BOARD_MFG_DATE;
379 maxIndexValue = OPENBMC_VPD_KEY_BOARD_MAX;
380 }
381 else if (section == "Product")
382 {
383 minIndexValue = OPENBMC_VPD_KEY_PRODUCT_MFR;
384 maxIndexValue = OPENBMC_VPD_KEY_PRODUCT_MAX;
385
386 }
387 else if (section == "Chassis")
388 {
389 minIndexValue = OPENBMC_VPD_KEY_CHASSIS_TYPE;
390 maxIndexValue = OPENBMC_VPD_KEY_CHASSIS_MAX;
391 }
392
393 auto first = fruData.cbegin() + minIndexValue;
394 auto last = first + (maxIndexValue - minIndexValue) + 1;
395
396 auto itr = std::find_if(first, last,
397 [&key](auto& e){ return key == e.first; });
398
399 if (itr != last)
400 {
401 fruValue = itr->second;
402 }
403 return fruValue;
404
405}
Ratan Gupta0b77cfa2017-01-31 17:32:31 +0530406//Get the inventory service from the mapper.
407auto getService(sdbusplus::bus::bus& bus,
408 const std::string& intf,
409 const std::string& path)
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530410{
Ratan Gupta0b77cfa2017-01-31 17:32:31 +0530411 auto mapperCall = bus.new_method_call(
412 "xyz.openbmc_project.ObjectMapper",
413 "/xyz/openbmc_project/ObjectMapper",
414 "xyz.openbmc_project.ObjectMapper",
415 "GetObject");
416
417 mapperCall.append(path);
418 mapperCall.append(std::vector<std::string>({intf}));
419
420 auto mapperResponseMsg = bus.call(mapperCall);
421 if (mapperResponseMsg.is_method_error())
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530422 {
Ratan Gupta0b77cfa2017-01-31 17:32:31 +0530423 throw std::runtime_error("ERROR in mapper call");
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530424 }
Ratan Gupta0b77cfa2017-01-31 17:32:31 +0530425
426 std::map<std::string, std::vector<std::string>> mapperResponse;
427 mapperResponseMsg.read(mapperResponse);
428
429 if (mapperResponse.begin() == mapperResponse.end())
430 {
431 throw std::runtime_error("ERROR in reading the mapper response");
432 }
433
434 return mapperResponse.begin()->first;
435}
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530436
437//------------------------------------------------------------------------
Vishwa4be4b7a2015-10-31 22:55:50 -0500438// Takes FRU data, invokes Parser for each fru record area and updates
439// Inventory
440//------------------------------------------------------------------------
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530441int ipmi_update_inventory(fru_area_vec_t& area_vec)
Vishwa4be4b7a2015-10-31 22:55:50 -0500442{
vishwac93d6d42015-12-16 11:55:16 -0600443 // Generic error reporter
Vishwa4be4b7a2015-10-31 22:55:50 -0500444 int rc = 0;
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530445 uint8_t fruid = 0;
446 IPMIFruInfo fruData;
Vishwa4be4b7a2015-10-31 22:55:50 -0500447
Vishwa4be4b7a2015-10-31 22:55:50 -0500448 // For each FRU area, extract the needed data , get it parsed and update
449 // the Inventory.
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530450 for (const auto& fruArea : area_vec)
Vishwa4be4b7a2015-10-31 22:55:50 -0500451 {
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530452 fruid = fruArea->get_fruid();
Vishwa4be4b7a2015-10-31 22:55:50 -0500453 // Fill the container with information
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530454 rc = parse_fru_area((fruArea)->get_type(), (void*)(fruArea)->get_data(),
455 (fruArea)->get_len(), fruData);
456 if (rc < 0)
Vishwa4be4b7a2015-10-31 22:55:50 -0500457 {
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530458 std::cerr << "ERROR parsing FRU records\n";
459 return rc;
Vishwa4be4b7a2015-10-31 22:55:50 -0500460 }
461 } // END walking the vector of areas and updating
462
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530463 // For each Fru we have the list of instances which needs to be updated.
464 // Each instance object implements certain interfaces.
465 // Each Interface is having Dbus properties.
466 // Each Dbus Property would be having metaData(eg section,VpdPropertyName).
467
468 // Here we are just printing the object,interface and the properties.
469 // which needs to be called with the new inventory manager implementation.
Ratan Gupta0b77cfa2017-01-31 17:32:31 +0530470 auto bus = sdbusplus::bus::new_default();
471 using namespace std::string_literals;
472 static const auto intf = "xyz.openbmc_project.Inventory.Manager"s;
473 static const auto path = "/xyz/openbmc_project/Inventory"s;
474 std::string service;
475 try
476 {
477 service = getService(bus,intf,path);
478 }
479 catch (const std::runtime_error& e)
480 {
481 std::cerr << e.what() << "\n";
482 return -1;
483 }
Ratan Gupta0b77cfa2017-01-31 17:32:31 +0530484
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530485 auto iter = frus.find(fruid);
486 if (iter == frus.end())
487 {
Ratan Gupta0fc20ed2017-02-06 19:59:12 +0530488 std::cerr << "ERROR Unable to get the fru info for FRU="
489 << static_cast<int>(fruid) << "\n";
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530490 return -1;
491 }
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530492
Ratan Gupta0b77cfa2017-01-31 17:32:31 +0530493 auto& instanceList = iter->second;
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530494 if (instanceList.size() <= 0)
495 {
Ratan Gupta0fc20ed2017-02-06 19:59:12 +0530496 std::cout << "Object List empty for this FRU="
497 << static_cast<int>(fruid) << "\n";
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530498 }
Ratan Gupta0fc20ed2017-02-06 19:59:12 +0530499
500 ObjectMap objects;
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530501 for (auto& instance : instanceList)
502 {
Ratan Gupta0fc20ed2017-02-06 19:59:12 +0530503 InterfaceMap interfaces;
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530504
505 for (auto& interfaceList : instance.second)
506 {
Ratan Gupta0fc20ed2017-02-06 19:59:12 +0530507 PropertyMap props;//store all the properties
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530508 for (auto& properties : interfaceList.second)
509 {
510 std::string section, property, value;
511 for (auto& info : properties.second)
512 {
513 if (info.first == "IPMIFruSection")
514 {
515 section = std::move(info.second);
516 }
517 if (info.first == "IPMIFruProperty")
518 {
519 property = std::move(info.second);
520 }
521 }
522
523 if (!section.empty() && !property.empty())
524 {
525 value = getFRUValue(section, property, fruData);
526 }
Ratan Gupta0fc20ed2017-02-06 19:59:12 +0530527 props.emplace(std::move(properties.first), std::move(value));
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530528 }
Ratan Gupta0fc20ed2017-02-06 19:59:12 +0530529 interfaces.emplace(std::move(interfaceList.first), std::move(props));
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530530 }
Vishwa4be4b7a2015-10-31 22:55:50 -0500531
Ratan Gupta0fc20ed2017-02-06 19:59:12 +0530532 //Call the inventory manager
533 sdbusplus::message::object_path path = instance.first;
534 objects.emplace(path,interfaces);
535 }
536
537 auto pimMsg = bus.new_method_call(
538 service.c_str(),
539 path.c_str(),
540 intf.c_str(),
541 "Notify");
542 pimMsg.append(std::move(objects));
543 auto inventoryMgrResponseMsg = bus.call(pimMsg);
544 if (inventoryMgrResponseMsg.is_method_error())
545 {
546 std::cerr << "Error in notify call\n";
547 return -1;
Ratan Gupta0b77cfa2017-01-31 17:32:31 +0530548 }
Vishwa4be4b7a2015-10-31 22:55:50 -0500549 return rc;
550}
551
vishwac93d6d42015-12-16 11:55:16 -0600552///----------------------------------------------------
553// Checks if a particular fru area is populated or not
554///----------------------------------------------------
555bool remove_invalid_area(const std::unique_ptr<ipmi_fru> &fru_area)
Vishwa4be4b7a2015-10-31 22:55:50 -0500556{
vishwac93d6d42015-12-16 11:55:16 -0600557 // Filter the ones that do not have dbus reference.
558 if((strlen((fru_area)->get_bus_name()) == 0) ||
559 (strlen((fru_area)->get_obj_path()) == 0) ||
560 (strlen((fru_area)->get_intf_name()) == 0))
561 {
562 return true;
563 }
564 return false;
565}
Vishwa4be4b7a2015-10-31 22:55:50 -0500566
vishwac93d6d42015-12-16 11:55:16 -0600567///----------------------------------------------------------------------------------
568// Populates various FRU areas
569// @prereq : This must be called only after validating common header.
570///----------------------------------------------------------------------------------
571int ipmi_populate_fru_areas(uint8_t *fru_data, const size_t data_len,
572 fru_area_vec_t & fru_area_vec)
573{
vishwa13555bd2015-11-10 12:10:38 -0600574 size_t area_offset = 0;
vishwac93d6d42015-12-16 11:55:16 -0600575 int rc = -1;
Vishwa4be4b7a2015-10-31 22:55:50 -0500576
vishwac93d6d42015-12-16 11:55:16 -0600577 // Now walk the common header and see if the file size has atleast the last
578 // offset mentioned by the common_hdr. If the file size is less than the
579 // offset of any if the fru areas mentioned in the common header, then we do
580 // not have a complete file.
581 for(uint8_t fru_entry = IPMI_FRU_INTERNAL_OFFSET;
582 fru_entry < (sizeof(struct common_header) -2); fru_entry++)
583 {
Yi Li75c2d462016-04-11 16:57:46 +0800584 rc = -1;
vishwac93d6d42015-12-16 11:55:16 -0600585 // Actual offset in the payload is the offset mentioned in common header
586 // multipled by 8. Common header is always the first 8 bytes.
587 area_offset = fru_data[fru_entry] * IPMI_EIGHT_BYTES;
588 if(area_offset && (data_len < (area_offset + 2)))
589 {
590 // Our file size is less than what it needs to be. +2 because we are
591 // using area len that is at 2 byte off area_offset
Patrick Williams3365ec82016-08-17 17:45:18 -0500592 fprintf(stderr, "fru file is incomplete. Size:[%zd]\n",data_len);
vishwac93d6d42015-12-16 11:55:16 -0600593 return rc;
594 }
595 else if(area_offset)
596 {
597 // Read 2 bytes to know the actual size of area.
598 uint8_t area_hdr[2] = {0};
599 memcpy(area_hdr, &((uint8_t *)fru_data)[area_offset], sizeof(area_hdr));
Vishwa4be4b7a2015-10-31 22:55:50 -0500600
vishwac93d6d42015-12-16 11:55:16 -0600601 // Size of this area will be the 2nd byte in the fru area header.
602 size_t area_len = area_hdr[1] * IPMI_EIGHT_BYTES;
603 uint8_t area_data[area_len] = {0};
Vishwa4be4b7a2015-10-31 22:55:50 -0500604
Patrick Williams3365ec82016-08-17 17:45:18 -0500605 printf("fru data size:[%zd], area offset:[%zd], area_size:[%zd]\n",
vishwac93d6d42015-12-16 11:55:16 -0600606 data_len, area_offset, area_len);
Vishwa4be4b7a2015-10-31 22:55:50 -0500607
vishwac93d6d42015-12-16 11:55:16 -0600608 // See if we really have that much buffer. We have area offset amd
609 // from there, the actual len.
610 if(data_len < (area_len + area_offset))
611 {
Patrick Williams3365ec82016-08-17 17:45:18 -0500612 fprintf(stderr, "Incomplete Fru file.. Size:[%zd]\n",data_len);
vishwac93d6d42015-12-16 11:55:16 -0600613 return rc;
614 }
615
616 // Save off the data.
617 memcpy(area_data, &((uint8_t *)fru_data)[area_offset], area_len);
618
619 // Validate the crc
620 rc = verify_fru_data(area_data, area_len);
621 if(rc < 0)
622 {
Patrick Williams3365ec82016-08-17 17:45:18 -0500623 fprintf(stderr, "Error validating fru area. offset:[%zd]\n",area_offset);
vishwac93d6d42015-12-16 11:55:16 -0600624 return rc;
625 }
626 else
627 {
Patrick Williams3365ec82016-08-17 17:45:18 -0500628 printf("Successfully verified area checksum. offset:[%zd]\n",area_offset);
vishwac93d6d42015-12-16 11:55:16 -0600629 }
630
631 // We already have a vector that is passed to us containing all
632 // of the fields populated. Update the data portion now.
633 for(auto& iter : fru_area_vec)
634 {
635 if((iter)->get_type() == get_fru_area_type(fru_entry))
636 {
637 (iter)->set_data(area_data, area_len);
638 }
639 }
640 } // If we have fru data present
641 } // Walk common_hdr
642
643 // Not all the fields will be populated in a fru data. Mostly all cases will
644 // not have more than 2 or 3.
645 fru_area_vec.erase(std::remove_if(fru_area_vec.begin(), fru_area_vec.end(),
646 remove_invalid_area), fru_area_vec.end());
647
648 return EXIT_SUCCESS;
649}
650
651///---------------------------------------------------------
652// Validates the fru data per ipmi common header constructs.
653// Returns with updated common_hdr and also file_size
654//----------------------------------------------------------
655int ipmi_validate_common_hdr(const uint8_t *fru_data, const size_t data_len)
656{
657 int rc = -1;
Vishwa4be4b7a2015-10-31 22:55:50 -0500658
659 uint8_t common_hdr[sizeof(struct common_header)] = {0};
vishwac93d6d42015-12-16 11:55:16 -0600660 if(data_len >= sizeof(common_hdr))
Vishwa4be4b7a2015-10-31 22:55:50 -0500661 {
vishwac93d6d42015-12-16 11:55:16 -0600662 memcpy(common_hdr, fru_data, sizeof(common_hdr));
Vishwa4be4b7a2015-10-31 22:55:50 -0500663 }
664 else
665 {
Patrick Williams3365ec82016-08-17 17:45:18 -0500666 fprintf(stderr, "Incomplete fru data file. Size:[%zd]\n", data_len);
vishwac93d6d42015-12-16 11:55:16 -0600667 return rc;
Vishwa4be4b7a2015-10-31 22:55:50 -0500668 }
669
vishwac93d6d42015-12-16 11:55:16 -0600670 // Verify the crc and size
671 rc = verify_fru_data(common_hdr, sizeof(common_hdr));
672 if(rc < 0)
Vishwa4be4b7a2015-10-31 22:55:50 -0500673 {
vishwac93d6d42015-12-16 11:55:16 -0600674 fprintf(stderr, "Failed to validate common header\n");
675 return rc;
Vishwa4be4b7a2015-10-31 22:55:50 -0500676 }
677
vishwac93d6d42015-12-16 11:55:16 -0600678 return EXIT_SUCCESS;
679}
Vishwa4be4b7a2015-10-31 22:55:50 -0500680
vishwac93d6d42015-12-16 11:55:16 -0600681//------------------------------------------------------------
682// Cleanup routine
683//------------------------------------------------------------
684int cleanup_error(FILE *fru_fp, fru_area_vec_t & fru_area_vec)
685{
686 if(fru_fp != NULL)
Vishwa4be4b7a2015-10-31 22:55:50 -0500687 {
vishwac93d6d42015-12-16 11:55:16 -0600688 fclose(fru_fp);
689 fru_fp = NULL;
690 }
vishwaf3ca3522015-12-02 10:35:13 -0600691
Vishwa4be4b7a2015-10-31 22:55:50 -0500692 if(!(fru_area_vec.empty()))
693 {
vishwac93d6d42015-12-16 11:55:16 -0600694 fru_area_vec.clear();
Vishwa4be4b7a2015-10-31 22:55:50 -0500695 }
vishwaf3ca3522015-12-02 10:35:13 -0600696
vishwac93d6d42015-12-16 11:55:16 -0600697 return -1;
Vishwa4be4b7a2015-10-31 22:55:50 -0500698}
699
Yi Li75c2d462016-04-11 16:57:46 +0800700
701///-----------------------------------------------------
702// Get the fru area names defined in BMC for a given @fruid.
703//----------------------------------------------------
704int get_defined_fru_area(sd_bus *bus_type, const uint8_t fruid,
705 std::vector<std::string> &defined_fru_area)
706{
707 // Need this to get respective DBUS objects
708 sd_bus_error bus_error = SD_BUS_ERROR_NULL;
709 sd_bus_message *response = NULL;
710 int rc = 0;
Patrick Williams804077d2016-07-29 15:26:18 -0500711 const char *areas = NULL;
Brad Bishopde6a3792016-07-25 17:09:12 -0400712 char *sys_bus_name = NULL;
Yi Li75c2d462016-04-11 16:57:46 +0800713
714#ifdef __IPMI_DEBUG__
715 printf("Getting fru areas defined in Skeleton for :[%d]\n", fruid);
716#endif
717
Brad Bishopde6a3792016-07-25 17:09:12 -0400718 rc = mapper_get_service(bus_type, sys_object_name, &sys_bus_name);
719 if(rc < 0)
720 {
721 fprintf(stderr, "Failed to get system manager service:[%s]\n",
722 strerror(-rc));
723 goto exit;
724 }
725
Yi Li75c2d462016-04-11 16:57:46 +0800726 // We want to call a method "getFRUArea" on System Bus that is
727 // made available over OpenBmc system services.
728 rc = sd_bus_call_method(bus_type, // On the System Bus
729 sys_bus_name, // Service to contact
730 sys_object_name, // Object path
731 sys_intf_name, // Interface name
732 "getFRUArea", // Method to be called
733 &bus_error, // object to return error
734 &response, // Response message on success
735 "y", // input message (integer)
736 fruid); // Argument
737
738 if(rc < 0)
739 {
740 fprintf(stderr, "Failed to get fru area for fruid:[%d] to dbus: [%s]\n",
741 fruid, bus_error.message);
742 }
743 else
744 {
745 // if several fru area names are defined, the names are combined to
746 // a string seperated by ','
747 rc = sd_bus_message_read(response, "s", &areas);
748 if(rc < 0)
749 {
750 fprintf(stderr, "Failed to parse response message from getFRUArea:[%s]\n",
751 strerror(-rc));
752 }
753 else
754 {
755#ifdef __IPMI_DEBUG__
756 printf("get defined fru area: id: %d, areas: %s\n", fruid, areas);
757#endif
758 std::string area_name;
759 std::stringstream ss(areas);
760 // fru area names string is seperated by ',', parse it into tokens
761 while (std::getline(ss, area_name, ','))
762 {
763 if (!area_name.empty())
764 defined_fru_area.emplace_back(area_name);
765 }
766 }
767 }
768
Brad Bishopde6a3792016-07-25 17:09:12 -0400769exit:
770
771 free(sys_bus_name);
Yi Li75c2d462016-04-11 16:57:46 +0800772 sd_bus_error_free(&bus_error);
773 sd_bus_message_unref(response);
774
775 return rc;
776}
777
778
Vishwa4be4b7a2015-10-31 22:55:50 -0500779///-----------------------------------------------------
780// Accepts the filename and validates per IPMI FRU spec
781//----------------------------------------------------
vishwaf3ca3522015-12-02 10:35:13 -0600782int ipmi_validate_fru_area(const uint8_t fruid, const char *fru_file_name,
vishwac93d6d42015-12-16 11:55:16 -0600783 sd_bus *bus_type, const bool bmc_fru)
Vishwa4be4b7a2015-10-31 22:55:50 -0500784{
vishwac93d6d42015-12-16 11:55:16 -0600785 size_t data_len = 0;
786 size_t bytes_read = 0;
787 int rc = -1;
Vishwa4be4b7a2015-10-31 22:55:50 -0500788
vishwac93d6d42015-12-16 11:55:16 -0600789 // Vector that holds individual IPMI FRU AREAs. Although MULTI and INTERNAL
790 // are not used, keeping it here for completeness.
791 fru_area_vec_t fru_area_vec;
Yi Li75c2d462016-04-11 16:57:46 +0800792 std::vector<std::string> defined_fru_area;
793
794 // BMC defines fru areas that should be present in Skeleton
795 rc = get_defined_fru_area(bus_type, fruid, defined_fru_area);
796 if(rc < 0)
797 {
798 fprintf(stderr, "ERROR: cannot get defined fru area\n");
799 return rc;
800 }
vishwac93d6d42015-12-16 11:55:16 -0600801 for(uint8_t fru_entry = IPMI_FRU_INTERNAL_OFFSET;
802 fru_entry < (sizeof(struct common_header) -2); fru_entry++)
803 {
804 // Create an object and push onto a vector.
805 std::unique_ptr<ipmi_fru> fru_area = std::make_unique<ipmi_fru>
806 (fruid, get_fru_area_type(fru_entry), bus_type, bmc_fru);
807
808 // Physically being present
vishwa2f5a3cf2016-05-30 02:25:21 -0500809 bool present = access(fru_file_name, F_OK) == 0;
vishwac93d6d42015-12-16 11:55:16 -0600810 fru_area->set_present(present);
811
Yi Li75c2d462016-04-11 16:57:46 +0800812 // Only setup dbus path for areas defined in BMC.
813 // Otherwise Skeleton will report 'not found' error
814 std::string fru_area_name = fru_area->get_name() + std::to_string(fruid);
815 auto iter = std::find(defined_fru_area.begin(), defined_fru_area.end(),
816 fru_area_name);
817 if (iter != defined_fru_area.end())
818 {
819 fru_area->setup_sd_bus_paths();
820 }
vishwac93d6d42015-12-16 11:55:16 -0600821 fru_area_vec.emplace_back(std::move(fru_area));
822 }
823
824 FILE *fru_fp = fopen(fru_file_name,"rb");
825 if(fru_fp == NULL)
Vishwa4be4b7a2015-10-31 22:55:50 -0500826 {
827 fprintf(stderr, "ERROR: opening:[%s]\n",fru_file_name);
828 perror("Error:");
vishwac93d6d42015-12-16 11:55:16 -0600829 return cleanup_error(fru_fp, fru_area_vec);
Vishwa4be4b7a2015-10-31 22:55:50 -0500830 }
831
vishwac93d6d42015-12-16 11:55:16 -0600832 // Get the size of the file to see if it meets minimum requirement
833 if(fseek(fru_fp, 0, SEEK_END))
Vishwa4be4b7a2015-10-31 22:55:50 -0500834 {
835 perror("Error:");
vishwac93d6d42015-12-16 11:55:16 -0600836 return cleanup_error(fru_fp, fru_area_vec);
Vishwa4be4b7a2015-10-31 22:55:50 -0500837 }
838
vishwac93d6d42015-12-16 11:55:16 -0600839 // Allocate a buffer to hold entire file content
840 data_len = ftell(fru_fp);
841 uint8_t fru_data[data_len] = {0};
Vishwa4be4b7a2015-10-31 22:55:50 -0500842
vishwac93d6d42015-12-16 11:55:16 -0600843 rewind(fru_fp);
844 bytes_read = fread(fru_data, data_len, 1, fru_fp);
Vishwa4be4b7a2015-10-31 22:55:50 -0500845 if(bytes_read != 1)
846 {
Patrick Williams3365ec82016-08-17 17:45:18 -0500847 fprintf(stderr, "Failed reading fru data. Bytes_read=[%zd]\n",bytes_read);
Vishwa4be4b7a2015-10-31 22:55:50 -0500848 perror("Error:");
vishwac93d6d42015-12-16 11:55:16 -0600849 return cleanup_error(fru_fp, fru_area_vec);
Vishwa4be4b7a2015-10-31 22:55:50 -0500850 }
Vishwa4be4b7a2015-10-31 22:55:50 -0500851
vishwac93d6d42015-12-16 11:55:16 -0600852 // We are done reading.
853 fclose(fru_fp);
854 fru_fp = NULL;
855
856 rc = ipmi_validate_common_hdr(fru_data, data_len);
vishwaf3ca3522015-12-02 10:35:13 -0600857 if(rc < 0)
Vishwa4be4b7a2015-10-31 22:55:50 -0500858 {
vishwac93d6d42015-12-16 11:55:16 -0600859 return cleanup_error(fru_fp, fru_area_vec);
860 }
861
862 // Now that we validated the common header, populate various fru sections if we have them here.
863 rc = ipmi_populate_fru_areas(fru_data, data_len, fru_area_vec);
864 if(rc < 0)
865 {
866 fprintf(stderr,"Populating FRU areas failed for:[%d]\n",fruid);
867 return cleanup_error(fru_fp, fru_area_vec);
Vishwa4be4b7a2015-10-31 22:55:50 -0500868 }
869 else
870 {
vishwac93d6d42015-12-16 11:55:16 -0600871 printf("SUCCESS: Populated FRU areas for:[%s]\n",fru_file_name);
Vishwa4be4b7a2015-10-31 22:55:50 -0500872 }
873
vishwac93d6d42015-12-16 11:55:16 -0600874#ifdef __IPMI_DEBUG__
875 for(auto& iter : fru_area_vec)
Vishwa4be4b7a2015-10-31 22:55:50 -0500876 {
vishwac93d6d42015-12-16 11:55:16 -0600877 printf("FRU ID : [%d]\n",(iter)->get_fruid());
878 printf("AREA NAME : [%s]\n",(iter)->get_name());
879 printf("TYPE : [%d]\n",(iter)->get_type());
880 printf("LEN : [%d]\n",(iter)->get_len());
881 printf("BUS NAME : [%s]\n", (iter)->get_bus_name());
882 printf("OBJ PATH : [%s]\n", (iter)->get_obj_path());
883 printf("INTF NAME :[%s]\n", (iter)->get_intf_name());
Vishwa4be4b7a2015-10-31 22:55:50 -0500884 }
vishwac93d6d42015-12-16 11:55:16 -0600885#endif
886
887 // If the vector is populated with everything, then go ahead and update the
888 // inventory.
889 if(!(fru_area_vec.empty()))
890 {
891
892#ifdef __IPMI_DEBUG__
893 printf("\n SIZE of vector is : [%d] \n",fru_area_vec.size());
894#endif
895 rc = ipmi_update_inventory(fru_area_vec);
896 if(rc <0)
897 {
898 fprintf(stderr, "Error updating inventory\n");
899 }
900 }
901
902 // we are done with all that we wanted to do. This will do the job of
903 // calling any destructors too.
904 fru_area_vec.clear();
Vishwa4be4b7a2015-10-31 22:55:50 -0500905
906 return rc;
907}