util: Add a function to parse ip addresses.

This function parses in place by inserting null terminators.

Change-Id: I61cb97b87ec05d0183fbaa993fd3d7580a188bde
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
This commit is contained in:
Ben Walker 2017-02-01 10:05:51 -07:00 committed by Daniel Verkamp
parent 8314b54996
commit 08238af7ee
7 changed files with 247 additions and 1 deletions

View File

@ -113,6 +113,21 @@ void spdk_strcpy_pad(void *dst, const char *src, size_t size, int pad);
*/
size_t spdk_strlen_pad(const void *str, size_t size, int pad);
/**
* Parse an IP address into its hostname and port components.
* This modifies the IP address in place.
*
* \param ip A null terminated IP address, including port.
* Both IPv4 and IPv6 are supported.
* \param host Will point to the start of the hostname within ip.
* The string will be null terminated.
* \param port Will point to the start of the port within ip.
* The string will be null terminated.
*
* \return 0 if successful. -1 on error.
*/
int spdk_parse_ip_addr(char *ip, const char **host, const char **port);
#ifdef __cplusplus
}
#endif

View File

@ -256,3 +256,59 @@ spdk_strlen_pad(const void *str, size_t size, int pad)
iter--;
}
}
int
spdk_parse_ip_addr(char *ip, const char **host, const char **port)
{
char *p;
if (ip == NULL) {
return -1;
}
*host = NULL;
*port = NULL;
if (ip[0] == '[') {
/* IPv6 */
p = strchr(ip, ']');
if (p == NULL) {
return -1;
}
*host = &ip[1];
*p = '\0';
p++;
if (*p == '\0') {
return 0;
} else if (*p != ':') {
return -1;
}
p++;
if (*p == '\0') {
return 0;
}
*port = p;
} else {
/* IPv4 */
p = strchr(ip, ':');
if (p == NULL) {
*host = ip;
return 0;
}
*host = ip;
*p = '\0';
p++;
if (*p == '\0') {
return 0;
}
*port = p;
}
return 0;
}

View File

@ -34,7 +34,7 @@
SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../..)
include $(SPDK_ROOT_DIR)/mk/spdk.common.mk
DIRS-y = bit_array io_channel
DIRS-y = bit_array io_channel string
.PHONY: all clean $(DIRS-y)

1
test/lib/util/string/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
string_ut

View File

@ -0,0 +1,52 @@
#
# 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.
#
SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../../..)
include $(SPDK_ROOT_DIR)/mk/spdk.common.mk
CFLAGS += -I$(SPDK_ROOT_DIR)/test
CFLAGS += -I$(SPDK_ROOT_DIR)/lib/util
APP = string_ut
C_SRCS := string_ut.c
LIBS += -lcunit
all : $(APP)
$(APP) : $(OBJS) $(SPDK_LIBS)
$(LINK_C)
clean :
$(CLEAN_C) $(APP)
include $(SPDK_ROOT_DIR)/mk/spdk.deps.mk

View File

@ -0,0 +1,121 @@
/*-
* 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 <stdio.h>
#include "spdk_cunit.h"
#include "string.c"
static void
test_parse_ip_addr(void)
{
int rc;
const char *host;
const char *port;
char ip[255];
/* IPv4 */
snprintf(ip, 255, "%s", "192.168.0.1");
rc = spdk_parse_ip_addr(ip, &host, &port);
CU_ASSERT_EQUAL(rc, 0);
CU_ASSERT(strcmp(host, "192.168.0.1") == 0);
CU_ASSERT_EQUAL(strlen(host), 11);
CU_ASSERT_EQUAL(port, NULL);
/* IPv4 with port */
snprintf(ip, 255, "%s", "123.456.789.0:5520");
rc = spdk_parse_ip_addr(ip, &host, &port);
CU_ASSERT_EQUAL(rc, 0);
CU_ASSERT(strcmp(host, "123.456.789.0") == 0);
CU_ASSERT_EQUAL(strlen(host), 13);
CU_ASSERT(strcmp(port, "5520") == 0);
CU_ASSERT_EQUAL(strlen(port), 4);
/* IPv6 */
snprintf(ip, 255, "%s", "[2001:db8:85a3:8d3:1319:8a2e:370:7348]");
rc = spdk_parse_ip_addr(ip, &host, &port);
CU_ASSERT_EQUAL(rc, 0);
CU_ASSERT(strcmp(host, "2001:db8:85a3:8d3:1319:8a2e:370:7348") == 0);
CU_ASSERT_EQUAL(strlen(host), 36);
CU_ASSERT_EQUAL(port, NULL);
/* IPv6 with port */
snprintf(ip, 255, "%s", "[2001:db8:85a3:8d3:1319:8a2e:370:7348]:443");
rc = spdk_parse_ip_addr(ip, &host, &port);
CU_ASSERT_EQUAL(rc, 0);
CU_ASSERT(strcmp(host, "2001:db8:85a3:8d3:1319:8a2e:370:7348") == 0);
CU_ASSERT_EQUAL(strlen(host), 36);
CU_ASSERT(strcmp(port, "443") == 0);
CU_ASSERT_EQUAL(strlen(port), 3);
/* IPv6 dangling colon */
snprintf(ip, 255, "%s", "[2001:db8:85a3:8d3:1319:8a2e:370:7348]:");
rc = spdk_parse_ip_addr(ip, &host, &port);
CU_ASSERT_EQUAL(rc, 0);
CU_ASSERT(strcmp(host, "2001:db8:85a3:8d3:1319:8a2e:370:7348") == 0);
CU_ASSERT_EQUAL(strlen(host), 36);
CU_ASSERT_EQUAL(port, NULL);
}
int
main(int argc, char **argv)
{
CU_pSuite suite = NULL;
unsigned int num_failures;
if (CU_initialize_registry() != CUE_SUCCESS) {
return CU_get_error();
}
suite = CU_add_suite("string", NULL, NULL);
if (suite == NULL) {
CU_cleanup_registry();
return CU_get_error();
}
if (
CU_add_test(suite, "test_parse_ip_addr", test_parse_ip_addr) == NULL) {
CU_cleanup_registry();
return CU_get_error();
}
CU_basic_set_mode(CU_BRM_VERBOSE);
CU_basic_run_tests();
num_failures = CU_get_number_of_failures();
CU_cleanup_registry();
return num_failures;
}

View File

@ -38,3 +38,4 @@ $valgrind test/lib/scsi/scsi_nvme/scsi_nvme_ut
$valgrind test/lib/util/bit_array/bit_array_ut
$valgrind test/lib/util/io_channel/io_channel_ut
$valgrind test/lib/util/string/string_ut