blob: c5f2539c09e387350420a1f63829c5d4cf3581d4 [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 }
484 auto notify = [&]()
485 {
486 return bus.new_method_call(
487 service.c_str(),
488 path.c_str(),
489 intf.c_str(),
490 "Notify");
491 };
492
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530493 auto iter = frus.find(fruid);
494 if (iter == frus.end())
495 {
496 std::cerr << "ERROR Unable to get the fru info for FRU=" << fruid << "\n";
497 return -1;
498 }
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530499
Ratan Gupta0b77cfa2017-01-31 17:32:31 +0530500 auto& instanceList = iter->second;
Ratan Guptacb0d4e52016-12-22 19:05:57 +0530501 if (instanceList.size() <= 0)
502 {
503 std::cout << "Object List empty for this FRU=" << fruid << "\n";
504 }
505 for (auto& instance : instanceList)
506 {
507 InterfaceList interfaces;
508
509 for (auto& interfaceList : instance.second)
510 {
511 PropertiesList prop;//store all the properties
512 for (auto& properties : interfaceList.second)
513 {
514 std::string section, property, value;
515 for (auto& info : properties.second)
516 {
517 if (info.first == "IPMIFruSection")
518 {
519 section = std::move(info.second);
520 }
521 if (info.first == "IPMIFruProperty")
522 {
523 property = std::move(info.second);
524 }
525 }
526
527 if (!section.empty() && !property.empty())
528 {
529 value = getFRUValue(section, property, fruData);
530 }
531 prop.emplace(std::move(properties.first), std::move(value));
532 }
533 interfaces.emplace(std::move(interfaceList.first), std::move(prop));
534 }
Ratan Gupta0b77cfa2017-01-31 17:32:31 +0530535 //Call the inventory manager
536 sdbusplus::message::object_path relPath = instance.first;
Vishwa4be4b7a2015-10-31 22:55:50 -0500537
Ratan Gupta0b77cfa2017-01-31 17:32:31 +0530538 auto m = notify();
539 m.append(relPath);
540 m.append(interfaces);
541 auto inventoryMgrResponseMsg = bus.call(m);
542 if (inventoryMgrResponseMsg.is_method_error())
543 {
544 std::cerr << "Error in notify call\n";
545 return -1;
546 }
547 }
Vishwa4be4b7a2015-10-31 22:55:50 -0500548 return rc;
549}
550
vishwac93d6d42015-12-16 11:55:16 -0600551///----------------------------------------------------
552// Checks if a particular fru area is populated or not
553///----------------------------------------------------
554bool remove_invalid_area(const std::unique_ptr<ipmi_fru> &fru_area)
Vishwa4be4b7a2015-10-31 22:55:50 -0500555{
vishwac93d6d42015-12-16 11:55:16 -0600556 // Filter the ones that do not have dbus reference.
557 if((strlen((fru_area)->get_bus_name()) == 0) ||
558 (strlen((fru_area)->get_obj_path()) == 0) ||
559 (strlen((fru_area)->get_intf_name()) == 0))
560 {
561 return true;
562 }
563 return false;
564}
Vishwa4be4b7a2015-10-31 22:55:50 -0500565
vishwac93d6d42015-12-16 11:55:16 -0600566///----------------------------------------------------------------------------------
567// Populates various FRU areas
568// @prereq : This must be called only after validating common header.
569///----------------------------------------------------------------------------------
570int ipmi_populate_fru_areas(uint8_t *fru_data, const size_t data_len,
571 fru_area_vec_t & fru_area_vec)
572{
vishwa13555bd2015-11-10 12:10:38 -0600573 size_t area_offset = 0;
vishwac93d6d42015-12-16 11:55:16 -0600574 int rc = -1;
Vishwa4be4b7a2015-10-31 22:55:50 -0500575
vishwac93d6d42015-12-16 11:55:16 -0600576 // Now walk the common header and see if the file size has atleast the last
577 // offset mentioned by the common_hdr. If the file size is less than the
578 // offset of any if the fru areas mentioned in the common header, then we do
579 // not have a complete file.
580 for(uint8_t fru_entry = IPMI_FRU_INTERNAL_OFFSET;
581 fru_entry < (sizeof(struct common_header) -2); fru_entry++)
582 {
Yi Li75c2d462016-04-11 16:57:46 +0800583 rc = -1;
vishwac93d6d42015-12-16 11:55:16 -0600584 // Actual offset in the payload is the offset mentioned in common header
585 // multipled by 8. Common header is always the first 8 bytes.
586 area_offset = fru_data[fru_entry] * IPMI_EIGHT_BYTES;
587 if(area_offset && (data_len < (area_offset + 2)))
588 {
589 // Our file size is less than what it needs to be. +2 because we are
590 // using area len that is at 2 byte off area_offset
Patrick Williams3365ec82016-08-17 17:45:18 -0500591 fprintf(stderr, "fru file is incomplete. Size:[%zd]\n",data_len);
vishwac93d6d42015-12-16 11:55:16 -0600592 return rc;
593 }
594 else if(area_offset)
595 {
596 // Read 2 bytes to know the actual size of area.
597 uint8_t area_hdr[2] = {0};
598 memcpy(area_hdr, &((uint8_t *)fru_data)[area_offset], sizeof(area_hdr));
Vishwa4be4b7a2015-10-31 22:55:50 -0500599
vishwac93d6d42015-12-16 11:55:16 -0600600 // Size of this area will be the 2nd byte in the fru area header.
601 size_t area_len = area_hdr[1] * IPMI_EIGHT_BYTES;
602 uint8_t area_data[area_len] = {0};
Vishwa4be4b7a2015-10-31 22:55:50 -0500603
Patrick Williams3365ec82016-08-17 17:45:18 -0500604 printf("fru data size:[%zd], area offset:[%zd], area_size:[%zd]\n",
vishwac93d6d42015-12-16 11:55:16 -0600605 data_len, area_offset, area_len);
Vishwa4be4b7a2015-10-31 22:55:50 -0500606
vishwac93d6d42015-12-16 11:55:16 -0600607 // See if we really have that much buffer. We have area offset amd
608 // from there, the actual len.
609 if(data_len < (area_len + area_offset))
610 {
Patrick Williams3365ec82016-08-17 17:45:18 -0500611 fprintf(stderr, "Incomplete Fru file.. Size:[%zd]\n",data_len);
vishwac93d6d42015-12-16 11:55:16 -0600612 return rc;
613 }
614
615 // Save off the data.
616 memcpy(area_data, &((uint8_t *)fru_data)[area_offset], area_len);
617
618 // Validate the crc
619 rc = verify_fru_data(area_data, area_len);
620 if(rc < 0)
621 {
Patrick Williams3365ec82016-08-17 17:45:18 -0500622 fprintf(stderr, "Error validating fru area. offset:[%zd]\n",area_offset);
vishwac93d6d42015-12-16 11:55:16 -0600623 return rc;
624 }
625 else
626 {
Patrick Williams3365ec82016-08-17 17:45:18 -0500627 printf("Successfully verified area checksum. offset:[%zd]\n",area_offset);
vishwac93d6d42015-12-16 11:55:16 -0600628 }
629
630 // We already have a vector that is passed to us containing all
631 // of the fields populated. Update the data portion now.
632 for(auto& iter : fru_area_vec)
633 {
634 if((iter)->get_type() == get_fru_area_type(fru_entry))
635 {
636 (iter)->set_data(area_data, area_len);
637 }
638 }
639 } // If we have fru data present
640 } // Walk common_hdr
641
642 // Not all the fields will be populated in a fru data. Mostly all cases will
643 // not have more than 2 or 3.
644 fru_area_vec.erase(std::remove_if(fru_area_vec.begin(), fru_area_vec.end(),
645 remove_invalid_area), fru_area_vec.end());
646
647 return EXIT_SUCCESS;
648}
649
650///---------------------------------------------------------
651// Validates the fru data per ipmi common header constructs.
652// Returns with updated common_hdr and also file_size
653//----------------------------------------------------------
654int ipmi_validate_common_hdr(const uint8_t *fru_data, const size_t data_len)
655{
656 int rc = -1;
Vishwa4be4b7a2015-10-31 22:55:50 -0500657
658 uint8_t common_hdr[sizeof(struct common_header)] = {0};
vishwac93d6d42015-12-16 11:55:16 -0600659 if(data_len >= sizeof(common_hdr))
Vishwa4be4b7a2015-10-31 22:55:50 -0500660 {
vishwac93d6d42015-12-16 11:55:16 -0600661 memcpy(common_hdr, fru_data, sizeof(common_hdr));
Vishwa4be4b7a2015-10-31 22:55:50 -0500662 }
663 else
664 {
Patrick Williams3365ec82016-08-17 17:45:18 -0500665 fprintf(stderr, "Incomplete fru data file. Size:[%zd]\n", data_len);
vishwac93d6d42015-12-16 11:55:16 -0600666 return rc;
Vishwa4be4b7a2015-10-31 22:55:50 -0500667 }
668
vishwac93d6d42015-12-16 11:55:16 -0600669 // Verify the crc and size
670 rc = verify_fru_data(common_hdr, sizeof(common_hdr));
671 if(rc < 0)
Vishwa4be4b7a2015-10-31 22:55:50 -0500672 {
vishwac93d6d42015-12-16 11:55:16 -0600673 fprintf(stderr, "Failed to validate common header\n");
674 return rc;
Vishwa4be4b7a2015-10-31 22:55:50 -0500675 }
676
vishwac93d6d42015-12-16 11:55:16 -0600677 return EXIT_SUCCESS;
678}
Vishwa4be4b7a2015-10-31 22:55:50 -0500679
vishwac93d6d42015-12-16 11:55:16 -0600680//------------------------------------------------------------
681// Cleanup routine
682//------------------------------------------------------------
683int cleanup_error(FILE *fru_fp, fru_area_vec_t & fru_area_vec)
684{
685 if(fru_fp != NULL)
Vishwa4be4b7a2015-10-31 22:55:50 -0500686 {
vishwac93d6d42015-12-16 11:55:16 -0600687 fclose(fru_fp);
688 fru_fp = NULL;
689 }
vishwaf3ca3522015-12-02 10:35:13 -0600690
Vishwa4be4b7a2015-10-31 22:55:50 -0500691 if(!(fru_area_vec.empty()))
692 {
vishwac93d6d42015-12-16 11:55:16 -0600693 fru_area_vec.clear();
Vishwa4be4b7a2015-10-31 22:55:50 -0500694 }
vishwaf3ca3522015-12-02 10:35:13 -0600695
vishwac93d6d42015-12-16 11:55:16 -0600696 return -1;
Vishwa4be4b7a2015-10-31 22:55:50 -0500697}
698
Yi Li75c2d462016-04-11 16:57:46 +0800699
700///-----------------------------------------------------
701// Get the fru area names defined in BMC for a given @fruid.
702//----------------------------------------------------
703int get_defined_fru_area(sd_bus *bus_type, const uint8_t fruid,
704 std::vector<std::string> &defined_fru_area)
705{
706 // Need this to get respective DBUS objects
707 sd_bus_error bus_error = SD_BUS_ERROR_NULL;
708 sd_bus_message *response = NULL;
709 int rc = 0;
Patrick Williams804077d2016-07-29 15:26:18 -0500710 const char *areas = NULL;
Brad Bishopde6a3792016-07-25 17:09:12 -0400711 char *sys_bus_name = NULL;
Yi Li75c2d462016-04-11 16:57:46 +0800712
713#ifdef __IPMI_DEBUG__
714 printf("Getting fru areas defined in Skeleton for :[%d]\n", fruid);
715#endif
716
Brad Bishopde6a3792016-07-25 17:09:12 -0400717 rc = mapper_get_service(bus_type, sys_object_name, &sys_bus_name);
718 if(rc < 0)
719 {
720 fprintf(stderr, "Failed to get system manager service:[%s]\n",
721 strerror(-rc));
722 goto exit;
723 }
724
Yi Li75c2d462016-04-11 16:57:46 +0800725 // We want to call a method "getFRUArea" on System Bus that is
726 // made available over OpenBmc system services.
727 rc = sd_bus_call_method(bus_type, // On the System Bus
728 sys_bus_name, // Service to contact
729 sys_object_name, // Object path
730 sys_intf_name, // Interface name
731 "getFRUArea", // Method to be called
732 &bus_error, // object to return error
733 &response, // Response message on success
734 "y", // input message (integer)
735 fruid); // Argument
736
737 if(rc < 0)
738 {
739 fprintf(stderr, "Failed to get fru area for fruid:[%d] to dbus: [%s]\n",
740 fruid, bus_error.message);
741 }
742 else
743 {
744 // if several fru area names are defined, the names are combined to
745 // a string seperated by ','
746 rc = sd_bus_message_read(response, "s", &areas);
747 if(rc < 0)
748 {
749 fprintf(stderr, "Failed to parse response message from getFRUArea:[%s]\n",
750 strerror(-rc));
751 }
752 else
753 {
754#ifdef __IPMI_DEBUG__
755 printf("get defined fru area: id: %d, areas: %s\n", fruid, areas);
756#endif
757 std::string area_name;
758 std::stringstream ss(areas);
759 // fru area names string is seperated by ',', parse it into tokens
760 while (std::getline(ss, area_name, ','))
761 {
762 if (!area_name.empty())
763 defined_fru_area.emplace_back(area_name);
764 }
765 }
766 }
767
Brad Bishopde6a3792016-07-25 17:09:12 -0400768exit:
769
770 free(sys_bus_name);
Yi Li75c2d462016-04-11 16:57:46 +0800771 sd_bus_error_free(&bus_error);
772 sd_bus_message_unref(response);
773
774 return rc;
775}
776
777
Vishwa4be4b7a2015-10-31 22:55:50 -0500778///-----------------------------------------------------
779// Accepts the filename and validates per IPMI FRU spec
780//----------------------------------------------------
vishwaf3ca3522015-12-02 10:35:13 -0600781int ipmi_validate_fru_area(const uint8_t fruid, const char *fru_file_name,
vishwac93d6d42015-12-16 11:55:16 -0600782 sd_bus *bus_type, const bool bmc_fru)
Vishwa4be4b7a2015-10-31 22:55:50 -0500783{
vishwac93d6d42015-12-16 11:55:16 -0600784 size_t data_len = 0;
785 size_t bytes_read = 0;
786 int rc = -1;
Vishwa4be4b7a2015-10-31 22:55:50 -0500787
vishwac93d6d42015-12-16 11:55:16 -0600788 // Vector that holds individual IPMI FRU AREAs. Although MULTI and INTERNAL
789 // are not used, keeping it here for completeness.
790 fru_area_vec_t fru_area_vec;
Yi Li75c2d462016-04-11 16:57:46 +0800791 std::vector<std::string> defined_fru_area;
792
793 // BMC defines fru areas that should be present in Skeleton
794 rc = get_defined_fru_area(bus_type, fruid, defined_fru_area);
795 if(rc < 0)
796 {
797 fprintf(stderr, "ERROR: cannot get defined fru area\n");
798 return rc;
799 }
vishwac93d6d42015-12-16 11:55:16 -0600800 for(uint8_t fru_entry = IPMI_FRU_INTERNAL_OFFSET;
801 fru_entry < (sizeof(struct common_header) -2); fru_entry++)
802 {
803 // Create an object and push onto a vector.
804 std::unique_ptr<ipmi_fru> fru_area = std::make_unique<ipmi_fru>
805 (fruid, get_fru_area_type(fru_entry), bus_type, bmc_fru);
806
807 // Physically being present
vishwa2f5a3cf2016-05-30 02:25:21 -0500808 bool present = access(fru_file_name, F_OK) == 0;
vishwac93d6d42015-12-16 11:55:16 -0600809 fru_area->set_present(present);
810
Yi Li75c2d462016-04-11 16:57:46 +0800811 // Only setup dbus path for areas defined in BMC.
812 // Otherwise Skeleton will report 'not found' error
813 std::string fru_area_name = fru_area->get_name() + std::to_string(fruid);
814 auto iter = std::find(defined_fru_area.begin(), defined_fru_area.end(),
815 fru_area_name);
816 if (iter != defined_fru_area.end())
817 {
818 fru_area->setup_sd_bus_paths();
819 }
vishwac93d6d42015-12-16 11:55:16 -0600820 fru_area_vec.emplace_back(std::move(fru_area));
821 }
822
823 FILE *fru_fp = fopen(fru_file_name,"rb");
824 if(fru_fp == NULL)
Vishwa4be4b7a2015-10-31 22:55:50 -0500825 {
826 fprintf(stderr, "ERROR: opening:[%s]\n",fru_file_name);
827 perror("Error:");
vishwac93d6d42015-12-16 11:55:16 -0600828 return cleanup_error(fru_fp, fru_area_vec);
Vishwa4be4b7a2015-10-31 22:55:50 -0500829 }
830
vishwac93d6d42015-12-16 11:55:16 -0600831 // Get the size of the file to see if it meets minimum requirement
832 if(fseek(fru_fp, 0, SEEK_END))
Vishwa4be4b7a2015-10-31 22:55:50 -0500833 {
834 perror("Error:");
vishwac93d6d42015-12-16 11:55:16 -0600835 return cleanup_error(fru_fp, fru_area_vec);
Vishwa4be4b7a2015-10-31 22:55:50 -0500836 }
837
vishwac93d6d42015-12-16 11:55:16 -0600838 // Allocate a buffer to hold entire file content
839 data_len = ftell(fru_fp);
840 uint8_t fru_data[data_len] = {0};
Vishwa4be4b7a2015-10-31 22:55:50 -0500841
vishwac93d6d42015-12-16 11:55:16 -0600842 rewind(fru_fp);
843 bytes_read = fread(fru_data, data_len, 1, fru_fp);
Vishwa4be4b7a2015-10-31 22:55:50 -0500844 if(bytes_read != 1)
845 {
Patrick Williams3365ec82016-08-17 17:45:18 -0500846 fprintf(stderr, "Failed reading fru data. Bytes_read=[%zd]\n",bytes_read);
Vishwa4be4b7a2015-10-31 22:55:50 -0500847 perror("Error:");
vishwac93d6d42015-12-16 11:55:16 -0600848 return cleanup_error(fru_fp, fru_area_vec);
Vishwa4be4b7a2015-10-31 22:55:50 -0500849 }
Vishwa4be4b7a2015-10-31 22:55:50 -0500850
vishwac93d6d42015-12-16 11:55:16 -0600851 // We are done reading.
852 fclose(fru_fp);
853 fru_fp = NULL;
854
855 rc = ipmi_validate_common_hdr(fru_data, data_len);
vishwaf3ca3522015-12-02 10:35:13 -0600856 if(rc < 0)
Vishwa4be4b7a2015-10-31 22:55:50 -0500857 {
vishwac93d6d42015-12-16 11:55:16 -0600858 return cleanup_error(fru_fp, fru_area_vec);
859 }
860
861 // Now that we validated the common header, populate various fru sections if we have them here.
862 rc = ipmi_populate_fru_areas(fru_data, data_len, fru_area_vec);
863 if(rc < 0)
864 {
865 fprintf(stderr,"Populating FRU areas failed for:[%d]\n",fruid);
866 return cleanup_error(fru_fp, fru_area_vec);
Vishwa4be4b7a2015-10-31 22:55:50 -0500867 }
868 else
869 {
vishwac93d6d42015-12-16 11:55:16 -0600870 printf("SUCCESS: Populated FRU areas for:[%s]\n",fru_file_name);
Vishwa4be4b7a2015-10-31 22:55:50 -0500871 }
872
vishwac93d6d42015-12-16 11:55:16 -0600873#ifdef __IPMI_DEBUG__
874 for(auto& iter : fru_area_vec)
Vishwa4be4b7a2015-10-31 22:55:50 -0500875 {
vishwac93d6d42015-12-16 11:55:16 -0600876 printf("FRU ID : [%d]\n",(iter)->get_fruid());
877 printf("AREA NAME : [%s]\n",(iter)->get_name());
878 printf("TYPE : [%d]\n",(iter)->get_type());
879 printf("LEN : [%d]\n",(iter)->get_len());
880 printf("BUS NAME : [%s]\n", (iter)->get_bus_name());
881 printf("OBJ PATH : [%s]\n", (iter)->get_obj_path());
882 printf("INTF NAME :[%s]\n", (iter)->get_intf_name());
Vishwa4be4b7a2015-10-31 22:55:50 -0500883 }
vishwac93d6d42015-12-16 11:55:16 -0600884#endif
885
886 // If the vector is populated with everything, then go ahead and update the
887 // inventory.
888 if(!(fru_area_vec.empty()))
889 {
890
891#ifdef __IPMI_DEBUG__
892 printf("\n SIZE of vector is : [%d] \n",fru_area_vec.size());
893#endif
894 rc = ipmi_update_inventory(fru_area_vec);
895 if(rc <0)
896 {
897 fprintf(stderr, "Error updating inventory\n");
898 }
899 }
900
901 // we are done with all that we wanted to do. This will do the job of
902 // calling any destructors too.
903 fru_area_vec.clear();
Vishwa4be4b7a2015-10-31 22:55:50 -0500904
905 return rc;
906}