README.md

   1 # linux-conf-perf
   2 This is tool for automatic performance analysis.
   3 It calculates impact on performance per symbol.
   4
   5 TOOL IS IN DEVELOPMENT AND NOT WORKING PROPERLY
   6
   7 ### Folders
   8 * `scripts` In this folder are all python scripts
   9         * `pase_kconfig` Contains program for extracting dependences from Kconfig files to format for PicoSAT.
  10         * `write_config` Fixes configuration and compares it against generated one.
  11         * `permute_conf` Interactive program for setting measure base.
  12         * `shared` Shared files
  13         * `novaboot` Script Novaboot
  14         * `picosat-959` Program PicoSAT
  15 * `jobfiles` In this folder are placed files generated with local scripts.
  16 * `output` Contains output of executed boots.
  17 * `result` In this folder are expected to be files with values from benchmarks.
  18 * `log` To this folder are logged all program outputs.
  19 * `linux` Submodule of linux kernel
  20 * `buildroot` Submodule of Buildroot
  21
  22 ### Configuration files
  23 Main configuration is in file `conf.py` and has python syntax.
  24 Important settings are commented inside file.
  25 Configuration must be done before executing `make run` or `make init`.
  26
  27 ### Usage
  28 Before any other steps, create Linux configuration and setup boot target with benchmark.
  29 You can run `make test` for testing if setup is correct.
  30
  31 For configuration of measured symbols, run `make mpermute_conf`.
  32
  33 To execute tests, run `make run`.
  34
  35 Output of benchmarks must be analyzed after execution of all different configurations.
  36 Files in folder `output` contains benchmark outputs. You should ensure, that values for
  37 benchmark are extracted and saved to folder `result` to file with same name as source.
  38
  39 Final evaluation is done by `make evaluate`.