app/test-crypto-perf/cperf_test_vector_parsing.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
   5  *
   6  *   Redistribution and use in source and binary forms, with or without
   7  *   modification, are permitted provided that the following conditions
   8  *   are met:
   9  *
  10  *     * Redistributions of source code must retain the above copyright
  11  *       notice, this list of conditions and the following disclaimer.
  12  *     * Redistributions in binary form must reproduce the above copyright
  13  *       notice, this list of conditions and the following disclaimer in
  14  *       the documentation and/or other materials provided with the
  15  *       distribution.
  16  *     * Neither the name of Intel Corporation nor the names of its
  17  *       contributors may be used to endorse or promote products derived
  18  *       from this software without specific prior written permission.
  19  *
  20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #ifndef APP_CRYPTO_PERF_CPERF_TEST_VECTOR_PARSING_H_
  34 #define APP_CRYPTO_PERF_CPERF_TEST_VECTOR_PARSING_H_
  35
  36 #define CPERF_VALUE_DELIMITER ","
  37 #define CPERF_ENTRY_DELIMITER "="
  38
  39 /**
  40  * Frees the allocated memory for test vector
  41  *
  42  * @param vector
  43  *   Destination vector test to release
  44  * @param opts
  45  *   Test options
  46  * @return
  47  *   0 on success, (-1) on error.
  48  */
  49 int
  50 free_test_vector(struct cperf_test_vector *vector, struct cperf_options *opts);
  51
  52 /**
  53  * Displays data in test vector
  54  *
  55  * @param vector
  56  *   Vector to display
  57  */
  58 void
  59 show_test_vector(struct cperf_test_vector *test_vector);
  60
  61 /**
  62  * Completes test vector with data from file
  63  *
  64  * @param opts
  65  *   Test options
  66  * @return
  67  *   NULL on error.
  68  *   Test vector pointer on successful.
  69  */
  70 struct cperf_test_vector*
  71 cperf_test_vector_get_from_file(struct cperf_options *opts);
  72
  73 #endif /* APP_CRYPTO_PERF_CPERF_TEST_VECTOR_PARSING_H_ */