From bac6245e1e5e337077ca246104fa23f382ae7063 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Thu, 5 Dec 2013 17:45:24 -0500 Subject: [PATCH] Add code from the inih library under libconfig MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit This code is under BSD license. The ini.h/.c reference contains the license and copyright. Signed-off-by: Jérémie Galarneau Signed-off-by: David Goulet --- configure.ac | 1 + src/common/Makefile.am | 2 +- src/common/config/Makefile.am | 3 + src/common/config/ini.c | 215 ++++++++++++++++++++++++++++++++++ src/common/config/ini.h | 101 ++++++++++++++++ 5 files changed, 321 insertions(+), 1 deletion(-) create mode 100644 src/common/config/Makefile.am create mode 100644 src/common/config/ini.c create mode 100644 src/common/config/ini.h diff --git a/configure.ac b/configure.ac index 72966a44d..15c224471 100644 --- a/configure.ac +++ b/configure.ac @@ -392,6 +392,7 @@ AC_CONFIG_FILES([ src/common/testpoint/Makefile src/common/index/Makefile src/common/health/Makefile + src/common/config/Makefile src/lib/Makefile src/lib/lttng-ctl/Makefile src/lib/lttng-ctl/filter/Makefile diff --git a/src/common/Makefile.am b/src/common/Makefile.am index 7817b40ae..a8dccc617 100644 --- a/src/common/Makefile.am +++ b/src/common/Makefile.am @@ -1,7 +1,7 @@ AM_CPPFLAGS = -I$(top_srcdir)/include -I$(top_srcdir)/src SUBDIRS = compat health hashtable kernel-ctl sessiond-comm relayd \ - kernel-consumer ust-consumer testpoint index + kernel-consumer ust-consumer testpoint index config AM_CFLAGS = -fno-strict-aliasing diff --git a/src/common/config/Makefile.am b/src/common/config/Makefile.am new file mode 100644 index 000000000..9e91b943d --- /dev/null +++ b/src/common/config/Makefile.am @@ -0,0 +1,3 @@ +noinst_LTLIBRARIES = libconfig.la + +libconfig_la_SOURCES = ini.c ini.h diff --git a/src/common/config/ini.c b/src/common/config/ini.c new file mode 100644 index 000000000..7462aeb35 --- /dev/null +++ b/src/common/config/ini.c @@ -0,0 +1,215 @@ +/* + * inih -- simple .INI file parser + * + * The "inih" library is distributed under the New BSD license: + * + * Copyright (c) 2009, Brush Technology - 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 Brush Technology 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 BRUSH TECHNOLOGY ''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 BRUSH TECHNOLOGY 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. + * + * http://code.google.com/p/inih/ + */ + +#include +#include +#include + +#include "ini.h" + +#if !INI_USE_STACK +#include +#endif + +#define MAX_SECTION 50 +#define MAX_NAME 50 + +/* Strip whitespace chars off end of given string, in place. Return s. */ +static char* rstrip(char* s) +{ + char* p = s + strlen(s); + + while (p > s && isspace((unsigned char)(*--p))) + *p = '\0'; + return s; +} + +/* Return pointer to first non-whitespace char in given string. */ +static char* lskip(const char* s) +{ + while (*s && isspace((unsigned char)(*s))) + s++; + return (char*)s; +} + +/* + * Return pointer to first char c or ';' comment in given string, or pointer to + * null at end of string if neither found. ';' must be prefixed by a whitespace + * character to register as a comment. + */ +static char* find_char_or_comment(const char* s, char c) +{ + int was_whitespace = 0; + + while (*s && *s != c && !(was_whitespace && *s == ';')) { + was_whitespace = isspace((unsigned char)(*s)); + s++; + } + return (char*)s; +} + +/* Version of strncpy that ensures dest (size bytes) is null-terminated. */ +static char* strncpy0(char* dest, const char* src, size_t size) +{ + strncpy(dest, src, size); + dest[size - 1] = '\0'; + return dest; +} + +/* See documentation in header file. */ +int ini_parse_file(FILE* file, ini_entry_handler handler, void* user) +{ + /* Uses a fair bit of stack (use heap instead if you need to) */ +#if INI_USE_STACK + char line[INI_MAX_LINE]; +#else + char* line; +#endif + char section[MAX_SECTION] = ""; + char prev_name[MAX_NAME] = ""; + + char* start; + char* end; + char* name; + char* value; + int lineno = 0; + int error = 0; + +#if !INI_USE_STACK + line = (char*)malloc(INI_MAX_LINE); + if (!line) { + return -2; + } +#endif + + /* Scan through file line by line */ + while (fgets(line, INI_MAX_LINE, file) != NULL) { + lineno++; + + start = line; +#if INI_ALLOW_BOM + if (lineno == 1 && (unsigned char)start[0] == 0xEF && + (unsigned char)start[1] == 0xBB && + (unsigned char)start[2] == 0xBF) { + start += 3; + } +#endif + start = lskip(rstrip(start)); + + if (*start == ';' || *start == '#') { + /* + * Per Python ConfigParser, allow '#' comments at + * start of line. + */ + } +#if INI_ALLOW_MULTILINE + else if (*prev_name && *start && start > line) { + /* Non-black line with leading whitespace, treat as + * continuation of previous name's value + * (as per Python ConfigParser). + */ + if (handler(user, section, prev_name, start) < 0 && + !error) { + error = lineno; + } + } +#endif + else if (*start == '[') { + /* A "[section]" line */ + end = find_char_or_comment(start + 1, ']'); + if (*end == ']') { + *end = '\0'; + strncpy0(section, start + 1, sizeof(section)); + *prev_name = '\0'; + } + else if (!error) { + /* No ']' found on section line */ + error = lineno; + } + } + else if (*start && *start != ';') { + /* Not a comment, must be a name[=:]value pair */ + end = find_char_or_comment(start, '='); + if (*end != '=') { + end = find_char_or_comment(start, ':'); + } + if (*end == '=' || *end == ':') { + *end = '\0'; + name = rstrip(start); + value = lskip(end + 1); + end = find_char_or_comment(value, '\0'); + if (*end == ';') { + *end = '\0'; + } + + rstrip(value); + + /* + * Valid name[=:]value pair found, call + * handler + */ + strncpy0(prev_name, name, sizeof(prev_name)); + if (handler(user, section, name, value) < 0 && + !error) { + error = lineno; + } + } + else if (!error) { + /* No '=' or ':' found on name[=:]value line */ + error = lineno; + } + } + } + +#if !INI_USE_STACK + free(line); +#endif + + return error; +} + +/* See documentation in header file. */ +int ini_parse(const char* filename, ini_entry_handler handler, void* user) +{ + FILE* file; + int error; + + file = fopen(filename, "r"); + if (!file) { + return -1; + } + + error = ini_parse_file(file, handler, user); + fclose(file); + return error; +} diff --git a/src/common/config/ini.h b/src/common/config/ini.h new file mode 100644 index 000000000..4d9b771c6 --- /dev/null +++ b/src/common/config/ini.h @@ -0,0 +1,101 @@ +/* + * inih -- simple .INI file parser + * + * The "inih" library is distributed under the New BSD license: + * + * Copyright (c) 2009, Brush Technology - 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 Brush Technology 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 BRUSH TECHNOLOGY ''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 BRUSH TECHNOLOGY 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. + * + * http://code.google.com/p/inih/ + */ + +#ifndef __INI_H__ +#define __INI_H__ + +/* Make this header file easier to include in C++ code */ +#ifdef __cplusplus +extern "C" { +#endif + +#define _GNU_SOURCE +#include + +typedef int (*ini_entry_handler)(void *, const char *, const char *, + const char *); + +/* + * Parse given INI-style file. May have [section]s, name=value pairs + * (whitespace stripped), and comments starting with ';' (semicolon). Section + * is "" if name=value pair parsed before any section heading. name:value + * pairs are also supported as a concession to Python's ConfigParser. + * + * For each name=value pair parsed, call handler function with given user + * pointer as well as section, name, and value (data only valid for duration + * of handler call). Handler should return zero on success, < 0 on error. + * + * Returns 0 on success, line number of first error on parse error (doesn't + * stop on first error), -1 on file open error, or -2 on memory allocation + * error (only when INI_USE_STACK is zero). + */ +int ini_parse(const char *filename, ini_entry_handler handler, void *user); + +/* + * Same as ini_parse(), but takes a FILE* instead of filename. This doesn't + * close the file when it's finished -- the caller must do that. + */ +int ini_parse_file(FILE *file, ini_entry_handler handler, void *user); + +/* + * Nonzero to allow multi-line value parsing, in the style of Python's + * ConfigParser. If allowed, ini_parse() will call the handler with the same + * name for each subsequent line parsed. + */ +#ifndef INI_ALLOW_MULTILINE +#define INI_ALLOW_MULTILINE 1 +#endif + +/* + * Nonzero to allow a UTF-8 BOM sequence (0xEF 0xBB 0xBF) at the start of + * the file. See http://code.google.com/p/inih/issues/detail?id=21 + */ +#ifndef INI_ALLOW_BOM +#define INI_ALLOW_BOM 1 +#endif + +/* Nonzero to use stack, zero to use heap (malloc/free). */ +#ifndef INI_USE_STACK +#define INI_USE_STACK 1 +#endif + +/* Maximum line length for any line in INI file. */ +#ifndef INI_MAX_LINE +#define INI_MAX_LINE 200 +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* __INI_H__ */ -- 2.34.1