From ad8bd8e313f2e55e2030fdef1d31e85073183858 Mon Sep 17 00:00:00 2001 From: Changpeng Liu Date: Tue, 7 May 2019 02:35:01 -0400 Subject: [PATCH] util: add a new file operation API The new added API can load file content into a data buffer, which can be used to read configuration file as well as JSON file, and we can add WRITE API in future which can be used to implement the persistent reservation feature. Change-Id: I9aaca7571648e1ab6dbfdd7cfd6ca34083cbeec2 Signed-off-by: Changpeng Liu Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/453498 Tested-by: SPDK CI Jenkins Reviewed-by: Jim Harris Reviewed-by: Shuhei Matsumoto --- CHANGELOG.md | 4 +++ include/spdk/file.h | 61 ++++++++++++++++++++++++++++++++ lib/event/json_config.c | 26 ++------------ lib/util/Makefile | 2 +- lib/util/file.c | 71 ++++++++++++++++++++++++++++++++++++++ test/app/jsoncat/jsoncat.c | 41 ++-------------------- 6 files changed, 142 insertions(+), 63 deletions(-) create mode 100644 include/spdk/file.h create mode 100644 lib/util/file.c diff --git a/CHANGELOG.md b/CHANGELOG.md index 39f186a63..6a3ddf534 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## v19.07: (Upcoming Release) +### util + +A new file API `spdk_posix_file_load` was added to load file content into a data buffer. + ### NVMe-oF Target Shared receive queue can now be disabled even for NICs that support it using the diff --git a/include/spdk/file.h b/include/spdk/file.h new file mode 100644 index 000000000..59cab4e27 --- /dev/null +++ b/include/spdk/file.h @@ -0,0 +1,61 @@ +/*- + * BSD LICENSE + * + * 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 + * file operation functions + */ + +#ifndef SPDK_FILE_H +#define SPDK_FILE_H + +#include "spdk/stdinc.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * Load the input file content into a data buffer. + * + * \param file File handle. + * \param size Size of bytes read from the file. + * + * \return data contains the content on success, NULL on failure. + */ +void *spdk_posix_file_load(FILE *file, size_t *size); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/lib/event/json_config.c b/lib/event/json_config.c index d0cf4d7e6..fba6b7820 100644 --- a/lib/event/json_config.c +++ b/lib/event/json_config.c @@ -36,6 +36,7 @@ #include "spdk/stdinc.h" #include "spdk/util.h" +#include "spdk/file.h" #include "spdk/log.h" #include "spdk/env.h" #include "spdk/thread.h" @@ -477,39 +478,18 @@ spdk_app_json_config_load_subsystem(void *_ctx) spdk_app_json_config_load_subsystem_config_entry(ctx); } - static void * read_file(const char *filename, size_t *size) { FILE *file = fopen(filename, "r"); - void *data = NULL; - long int rc = 0; + void *data; if (file == NULL) { /* errno is set by fopen */ return NULL; } - rc = fseek(file, 0, SEEK_END); - if (rc == 0) { - rc = ftell(file); - rewind(file); - } - - if (rc != -1) { - *size = rc; - data = malloc(*size); - } - - if (data != NULL) { - rc = fread(data, 1, *size, file); - if (rc != (long int)*size) { - free(data); - data = NULL; - errno = EIO; - } - } - + data = spdk_posix_file_load(file, size); fclose(file); return data; } diff --git a/lib/util/Makefile b/lib/util/Makefile index ce9182583..f21409af3 100644 --- a/lib/util/Makefile +++ b/lib/util/Makefile @@ -34,7 +34,7 @@ SPDK_ROOT_DIR := $(abspath $(CURDIR)/../..) include $(SPDK_ROOT_DIR)/mk/spdk.common.mk -C_SRCS = base64.c bit_array.c cpuset.c crc16.c crc32.c crc32c.c crc32_ieee.c dif.c fd.c strerror_tls.c string.c uuid.c +C_SRCS = base64.c bit_array.c cpuset.c crc16.c crc32.c crc32c.c crc32_ieee.c dif.c fd.c file.c strerror_tls.c string.c uuid.c LIBNAME = util LOCAL_SYS_LIBS = -luuid diff --git a/lib/util/file.c b/lib/util/file.c new file mode 100644 index 000000000..2ba08547b --- /dev/null +++ b/lib/util/file.c @@ -0,0 +1,71 @@ +/*- + * BSD LICENSE + * + * 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. + */ + +#include "spdk/file.h" + +void * +spdk_posix_file_load(FILE *file, size_t *size) +{ + void *newbuf, *buf = NULL; + size_t rc, buf_size, cur_size = 0; + + *size = 0; + buf_size = 128 * 1024; + + while (buf_size <= 1024 * 1024 * 1024) { + newbuf = realloc(buf, buf_size); + if (newbuf == NULL) { + free(buf); + return NULL; + } + buf = newbuf; + + rc = fread(buf + cur_size, 1, buf_size - cur_size, file); + cur_size += rc; + + if (feof(file)) { + *size = cur_size; + return buf; + } + + if (ferror(file)) { + free(buf); + return NULL; + } + + buf_size *= 2; + } + + free(buf); + return NULL; +} diff --git a/test/app/jsoncat/jsoncat.c b/test/app/jsoncat/jsoncat.c index 9984e32b4..e932b54bd 100644 --- a/test/app/jsoncat/jsoncat.c +++ b/test/app/jsoncat/jsoncat.c @@ -36,6 +36,7 @@ #include "spdk/stdinc.h" #include "spdk/json.h" +#include "spdk/file.h" static void usage(const char *prog) @@ -75,44 +76,6 @@ json_write_cb(void *cb_ctx, const void *data, size_t size) return rc == size ? 0 : -1; } -static void * -read_file(FILE *f, size_t *psize) -{ - void *buf, *newbuf; - size_t cur_size, buf_size, rc; - - buf = NULL; - cur_size = 0; - buf_size = 128 * 1024; - - while (buf_size <= 1024 * 1024 * 1024) { - newbuf = realloc(buf, buf_size); - if (newbuf == NULL) { - free(buf); - return NULL; - } - buf = newbuf; - - rc = fread(buf + cur_size, 1, buf_size - cur_size, f); - cur_size += rc; - - if (feof(f)) { - *psize = cur_size; - return buf; - } - - if (ferror(f)) { - free(buf); - return NULL; - } - - buf_size *= 2; - } - - free(buf); - return NULL; -} - static int process_file(const char *filename, FILE *f, uint32_t parse_flags, uint32_t write_flags) { @@ -123,7 +86,7 @@ process_file(const char *filename, FILE *f, uint32_t parse_flags, uint32_t write size_t num_values; struct spdk_json_write_ctx *w; - buf = read_file(f, &size); + buf = spdk_posix_file_load(f, &size); if (buf == NULL) { fprintf(stderr, "%s: file read error\n", filename); return 1;