examples/qos_sched/cfg_file.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 #ifndef __CFG_FILE_H__
  36 #define __CFG_FILE_H__
  37
  38 #include <rte_sched.h>
  39
  40 #define CFG_NAME_LEN 32
  41 #define CFG_VALUE_LEN 64
  42
  43 struct cfg_entry {
  44         char name[CFG_NAME_LEN];
  45         char value[CFG_VALUE_LEN];
  46 };
  47
  48 struct cfg_section {
  49         char name[CFG_NAME_LEN];
  50         int num_entries;
  51         struct cfg_entry *entries[0];
  52 };
  53
  54 struct cfg_file {
  55         int flags;
  56         int num_sections;
  57         struct cfg_section *sections[0];
  58 };
  59
  60
  61 int cfg_load_port(struct cfg_file *cfg, struct rte_sched_port_params *port);
  62
  63 int cfg_load_pipe(struct cfg_file *cfg, struct rte_sched_pipe_params *pipe);
  64
  65 int cfg_load_subport(struct cfg_file *cfg, struct rte_sched_subport_params *subport);
  66
  67
  68 /* reads a config file from disk and returns a handle to the config
  69  * 'flags' is reserved for future use and must be 0
  70  */
  71 struct cfg_file *cfg_load(const char *filename, int flags);
  72
  73 /* returns the number of sections in the config */
  74 int cfg_num_sections(struct cfg_file *cfg, const char *sec_name, size_t length);
  75
  76 /* fills the array "sections" with the names of all the sections in the file
  77  * (up to a max of max_sections).
  78  * NOTE: buffers in the sections array must be at least CFG_NAME_LEN big
  79  */
  80 int cfg_sections(struct cfg_file *cfg, char *sections[], int max_sections);
  81
  82 /* true if the named section exists, false otherwise */
  83 int cfg_has_section(struct cfg_file *cfg, const char *sectionname);
  84
  85 /* returns the number of entries in a section */
  86 int cfg_section_num_entries(struct cfg_file *cfg, const char *sectionname);
  87
  88 /* returns the entries in a section as key-value pairs in the "entries" array */
  89 int cfg_section_entries(struct cfg_file *cfg, const char *sectionname,
  90                 struct cfg_entry *entries, int max_entries);
  91
  92 /* returns a pointer to the value of the named entry in the named section */
  93 const char *cfg_get_entry(struct cfg_file *cfg, const char *sectionname,
  94                 const char *entryname);
  95
  96 /* true if the given entry exists in the given section, false otherwise */
  97 int cfg_has_entry(struct cfg_file *cfg, const char *sectionname,
  98                 const char *entryname);
  99
 100 /* cleans up memory allocated by cfg_load() */
 101 int cfg_close(struct cfg_file *cfg);
 102
 103 #endif