800b18d028
Add disable_sections_merge() procedure that will allow to have multiple sections with a same name. This behaviour is how FIO treats such sections and so will be used in bdevperf config file. Change-Id: If221daeb7753d91b5d2608d25ccbb16f2d43ccce Signed-off-by: Vitaliy Mysak <vitaliy.mysak@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3433 Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Community-CI: Mellanox Build Bot
216 lines
6.6 KiB
C
216 lines
6.6 KiB
C
/*-
|
|
* BSD LICENSE
|
|
*
|
|
* Copyright (C) 2008-2012 Daisuke Aoyama <aoyama@peach.ne.jp>.
|
|
* Copyright (c) Intel Corporation.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* * Neither the name of Intel Corporation nor the names of its
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
/** \file
|
|
* Configuration file parser
|
|
*/
|
|
|
|
#ifndef SPDK_CONF_H
|
|
#define SPDK_CONF_H
|
|
|
|
#include "spdk/stdinc.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct spdk_conf_value;
|
|
struct spdk_conf_item;
|
|
struct spdk_conf_section;
|
|
struct spdk_conf;
|
|
|
|
/**
|
|
* Allocate a configuration struct used for the initialization of SPDK app.
|
|
*
|
|
* \return a pointer to the allocated configuration struct.
|
|
*/
|
|
struct spdk_conf *spdk_conf_allocate(void);
|
|
|
|
/**
|
|
* Free the configuration struct.
|
|
*
|
|
* \param cp Configuration struct to free.
|
|
*/
|
|
void spdk_conf_free(struct spdk_conf *cp);
|
|
|
|
/**
|
|
* Read configuration file for spdk_conf struct.
|
|
*
|
|
* \param cp Configuration struct used for the initialization of SPDK app.
|
|
* \param file File to read that is created by user to configure SPDK app.
|
|
*
|
|
* \return 0 on success, -1 on failure.
|
|
*/
|
|
int spdk_conf_read(struct spdk_conf *cp, const char *file);
|
|
|
|
/**
|
|
* Find the specified section of the configuration.
|
|
*
|
|
* \param cp Configuration struct used for the initialization of SPDK app.
|
|
* \param name Name of section to find.
|
|
*
|
|
* \return a pointer to the requested section on success or NULL otherwise.
|
|
*/
|
|
struct spdk_conf_section *spdk_conf_find_section(struct spdk_conf *cp, const char *name);
|
|
|
|
/**
|
|
* Get the first section of the configuration.
|
|
*
|
|
* \param cp Configuration struct used for the initialization of SPDK app.
|
|
*
|
|
* \return a pointer to the requested section on success or NULL otherwise.
|
|
*/
|
|
struct spdk_conf_section *spdk_conf_first_section(struct spdk_conf *cp);
|
|
|
|
/**
|
|
* Get the next section of the configuration.
|
|
*
|
|
* \param sp The current section of the configuration.
|
|
*
|
|
* \return a pointer to the requested section on success or NULL otherwise.
|
|
*/
|
|
struct spdk_conf_section *spdk_conf_next_section(struct spdk_conf_section *sp);
|
|
|
|
/**
|
|
* Match prefix of the name of section.
|
|
*
|
|
* \param sp The section of the configuration.
|
|
* \param name_prefix Prefix name to match.
|
|
*
|
|
* \return ture on success, false on failure.
|
|
*/
|
|
bool spdk_conf_section_match_prefix(const struct spdk_conf_section *sp, const char *name_prefix);
|
|
|
|
/**
|
|
* Get the name of the section.
|
|
*
|
|
* \param sp The section of the configuration.
|
|
*
|
|
* \return the name of the section.
|
|
*/
|
|
const char *spdk_conf_section_get_name(const struct spdk_conf_section *sp);
|
|
|
|
/**
|
|
* Get the number of the section.
|
|
*
|
|
* \param sp The section of the configuration.
|
|
*
|
|
* \return the number of the section.
|
|
*/
|
|
int spdk_conf_section_get_num(const struct spdk_conf_section *sp);
|
|
|
|
/**
|
|
* Get the value of the item with name 'key' in the section.
|
|
*
|
|
* If key appears multiple times, idx1 will control which version to retrieve.
|
|
* Indices will start from the top of the configuration file at 0 and increment
|
|
* by one for each new apperarance. If the configuration key contains multiple
|
|
* whitespace delimited values, idx2 controls which value is returned. The index
|
|
* begins at 0.
|
|
*
|
|
*
|
|
* \param sp The section of the configuration.
|
|
* \param key Name of item.
|
|
* \param idx1 The index into the item list for the key.
|
|
* \param idx2 The index into the value list for the item.
|
|
*
|
|
* \return the requested value on success or NULL otherwise.
|
|
*/
|
|
char *spdk_conf_section_get_nmval(struct spdk_conf_section *sp, const char *key,
|
|
int idx1, int idx2);
|
|
|
|
/**
|
|
* Get the first value of the item with name 'key' in the section.
|
|
*
|
|
* \param sp The section of the configuration.
|
|
* \param key Name of item.
|
|
* \param idx The index into the value list for the item.
|
|
*
|
|
* \return the requested value on success or NULL otherwise.
|
|
*/
|
|
char *spdk_conf_section_get_nval(struct spdk_conf_section *sp, const char *key, int idx);
|
|
|
|
/**
|
|
* Get the first value of the first item with name 'key' in the section.
|
|
*
|
|
* \param sp The section of the configuration.
|
|
* \param key Name of item.
|
|
*
|
|
* \return the requested value on success or NULL otherwise.
|
|
*/
|
|
char *spdk_conf_section_get_val(struct spdk_conf_section *sp, const char *key);
|
|
|
|
/**
|
|
* Get the first value of the first item with name 'key' in the section.
|
|
*
|
|
* \param sp The section of the configuration.
|
|
* \param key Name of item.
|
|
*
|
|
* \return the requested value on success or NULL otherwise.
|
|
*/
|
|
int spdk_conf_section_get_intval(struct spdk_conf_section *sp, const char *key);
|
|
|
|
/**
|
|
* Get the bool value of the item with name 'key' in the section.
|
|
*
|
|
* This is used to check whether the service is enabled.
|
|
*
|
|
* \param sp The section of the configuration.
|
|
* \param key Name of item.
|
|
* \param default_val Default value.
|
|
*
|
|
* \return true if matching 'Yes/Y/True', false if matching 'No/N/False', default value otherwise.
|
|
*/
|
|
bool spdk_conf_section_get_boolval(struct spdk_conf_section *sp, const char *key, bool default_val);
|
|
|
|
/**
|
|
* Set the configuration as the default.
|
|
*
|
|
* \param cp Configuration to set.
|
|
*/
|
|
void spdk_conf_set_as_default(struct spdk_conf *cp);
|
|
|
|
/**
|
|
* Disable sections merging during 'spdk_conf_read()'
|
|
*
|
|
* \param cp Configuration to be read
|
|
*/
|
|
void spdk_conf_disable_sections_merge(struct spdk_conf *cp);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|