Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 45d54976fdb8d27a539d78dc1cd7e2db0998b43a
commit45d54976fdb8d27a539d78dc1cd7e2db0998b43a[log] [tgz]
authorjinuthomas <jinu.joy.thomas@in.ibm.com>Mon Jul 03 04:36:29 2023 -0500
committerjinuthomas <jinu.joy.thomas@in.ibm.com>Sun Jul 30 23:24:35 2023 -0500
tree08400e10beeae4b14f5117aea6ea9c6f7719e5d0
parentd8577739a7875a601a32cd461e8151cb3b5b308d [diff]
Catching File Exceptions in openpower-vpd-parser

In this commit, I have added code to handle file exceptions
more effectively. By implementing proper exception handling,
we can improve the robustness and reliability of the file
operations within our codebase.

Here are the key changes made in this commit:

  - Introduced a try-catch block around the file operation sections.
  - Within the try block, added code to perform the necessary file
    operations.
  - Implemented catch blocks to handle specific file exceptions.
  - In each catch block, included appropriate error handling logic,
    such as logging the error message or displaying a user-friendly
    error message.
  - Ensured that the catch blocks gracefully handle the exceptions
    and prevent the program from crashing or behaving unexpectedly.

By adding this exception handling code, we can anticipate and handle
potential file-related errors gracefully, providing a smoother
experience for users and preventing any unexpected crashes or data
loss. This would also aid in debugging issues.

Change-Id: I621a7f0ba68d2c298e4fea0a9d3e21d1939cd090
Signed-off-by: jinuthomas <jinu.joy.thomas@in.ibm.com>
5 files changed
tree: 08400e10beeae4b14f5117aea6ea9c6f7719e5d0
  1. examples/
  2. ibm_vpd/
  3. subprojects/
  4. test/
  5. vpd-manager/
  6. vpd-parser/
  7. vpdecc/
  8. .clang-format
  9. .gitignore
  10. app.cpp
  11. args.cpp
  12. args.hpp
  13. common_utility.cpp
  14. common_utility.hpp
  15. const.hpp
  16. defines.hpp
  17. extra-properties-example.yaml
  18. extra-properties.mako.hpp
  19. extra-properties.py
  20. ibm_vpd_app.cpp
  21. ibm_vpd_utils.cpp
  22. ibm_vpd_utils.hpp
  23. impl.cpp
  24. impl.hpp
  25. LICENSE
  26. meson.build
  27. meson_options.txt
  28. OWNERS
  29. README.md
  30. store.hpp
  31. types.hpp
  32. utilInterface.hpp
  33. vpd_exceptions.hpp
  34. vpd_tool.cpp
  35. vpd_tool_impl.cpp
  36. vpd_tool_impl.hpp
  37. write.cpp
  38. write.hpp
  39. writefru.mako.hpp
  40. writefru.py
  41. writefru.yaml
README.md

Overview

This repository hosts code for OpenPower and IBM IPZ format VPD parsers. Both OpenPower VPD and IPZ VPD formats are structured binaries that consist of records and keywords. A record is a collection of multiple keywords. More information about the format can be found here.

The repository consists of two distinct applications, which are:

OpenPower VPD Parser

This is a build-time YAML driven application that parses the OpenPower VPD format and uses the YAML configuration (see extra-properties-example.yaml and writefru.yaml) to determine:

  • The supported records and keywords.
  • How VPD data is translated into D-Bus interfaces and properties.

The application instance must be passed in the file path to the VPD (this can, for example, be a sysfs path exposed by the EEPROM device driver) and also the D-Bus object path(s) that EEPROM data needs to be published under.

IBM VPD Parser

This parser is can be built by passing in the --enable-ibm-parser configure option. This parser differs from the OpenPower VPD parser in the following ways:

  • It parses all the records and keywords from the VPD, including large keywords (Keywords that begin with a # and are > 255 bytes in length).
  • It relies on a runtime JSON configuration (see examples/inventory.json) to determine the D-Bus object path(s) that hold interfaces and properties representing the VPD for a given VPD file path.

Making the application runtime JSON driven allows us to support multiple systems (with different FRU configurations) to be supported in a single code image as well as making the application more flexible for future improvements.

TODOs and Future Improvements

  1. The long-term goal is to completely do away with the build time YAML driven configurations and instead reconcile the OpenPower VPD parser and the IBM VPD parser applications into a single runtime JSON driven application.
  2. Add details to the README on how to configure and build the application.
  3. More JSON documentation.
  4. Support for more IBM VPD formats.
  5. VPD Write and tool documentation.