intel / xml-cli

UFFAF - UEFI Firmware Foundational Automation Framework (formerly XmlCli)
https://intel.github.io/xml-cli/
BSD 3-Clause "New" or "Revised" License
18 stars 7 forks source link

[FEATURE] Perform Data Analytics on Output Generated JSON #8

Open gahan9 opened 1 year ago

gahan9 commented 1 year ago

Is your feature request related to a problem? Please describe. Implement Analysis data based on the output JSON file to calculate i.e., Free space, Compression Ratio, comparing any two or more JSON file data to show difference

Describe the solution you'd like Any kind of Dashboard view is sufficient enough which gives easy idea to perform firmware binary analysis.

gahan9 commented 1 year ago

Queries -

  1. Free space of the firmware volume/FFS/Flash space is expected here ?
    • Yes (for Firmware Volume and FFS), So to be precise Free-space can be categorized as:
      1. Free Space within uncompressed section
      2. Free Space within compressed section [Compressed section have GUID defined in PI Specification] --- this section needs to be differed because free space before compression v/s after compression would not be the same.
    • According to Specification, the free space can be under FV, FFS or Section. However, FFS would be part of FV only so that is kind of contributes to overall Free Space to FV
  2. Compression ratio for each FV inside the FFS is expected here ?
    • Yes, it would be of data where amount of size data which is compressed and the GUID of compression algorithm
  3. comparing 2 or more JSON files to show the difference between FVs, Free space, compression ratio, etc. ? What more is expected here ?
    • Comparison could be on parameters described below (4).
  4. Firmware binary analysis should be on what parameters ?
    • That is up to implementation effort to bring possibilities for assessment, there can be any possibility for comparing number of sections, drivers, classifying available driver types, analyzing space consumption of space by type, etc...