ceph/src/spdk/intel-ipsec-mb/LibPerfApp/README

   1 ========================================================================
   2 README for Intel(R) Multi-Buffer Crypto for IPsec Library API
   3 performance measurement tool
   4
   5 February 2017
   6 ========================================================================
   7
   8
   9 Contents
  10 ========
  11
  12 - Overview
  13 - Files
  14 - Compilation
  15 - Usage
  16 - Legal Disclaimer
  17
  18
  19 Overview
  20 ========
  21 This test tool performs multiple execution of functions included in
  22 Intel Multi-Buffer Crypto for IPsec Library.
  23
  24 Files
  25 =====
  26
  27 ipsec_perf.c -  Tool which produces text formatted output representing
  28                 average times of ipsec_mb functions execution.
  29 ipsec_diff_tool.py - Another tool which interprets text data given.
  30
  31 Compilation
  32 ===========
  33
  34 Required tools:
  35 - GNU make
  36 - gcc (GCC) 4.8.3 (or newer)
  37
  38 Simply run "make" to compile the tool.
  39 To clean the build please run "make clean".
  40
  41 You can point to another directory contaning IPSec MB library by setting
  42 LIB_LOC. for ex:
  43         LIB_LOC=../ipsec_mb_lib make
  44
  45 In order to perform static code analysis or style check you can do:
  46         make cppcheck
  47 or
  48         make style
  49
  50 Be aware that you will have cppcheck tool installed and checkpatch.pl
  51 script copied into one of the directories listed in $PATH.
  52 You can also set CPPCHECK and/or CHECKPATCH variables if you want give paths
  53 to this tools being placed in different directories. for ex:
  54         CPPCHECK=~/tools/cppcheck make cppcheck
  55         CHECKPATCH=~/scripts/checkpatch.pl make style
  56
  57 Usage
  58 =====
  59
  60 You can simply check list of arguments by typing:
  61         ./ipsec_perf -h
  62
  63 Usage example:
  64         ./ipsec_perf -c --no-avx512 --no-gcm -o 24
  65
  66 Later you can pass output to ipsec_diff_tool.py for data
  67 analysis:
  68         ./ipsec_diff_tool.py out1.txt out2.txt 5
  69
  70 Run ipsec_diff_tool.py -h too see help page.
  71
  72 Legal Disclaimer
  73 ================
  74
  75 THIS SOFTWARE IS PROVIDED BY INTEL"AS IS". NO LICENSE, EXPRESS OR
  76 IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS
  77 ARE GRANTED THROUGH USE. EXCEPT AS PROVIDED IN INTEL'S TERMS AND
  78 CONDITIONS OF SALE, INTEL ASSUMES NO LIABILITY WHATSOEVER AND INTEL
  79 DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR
  80 USE OF INTEL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO
  81 FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT
  82 OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT.