numam-spdk/include/spdk/string.h
Seth Howell 4d43844f4d lib: replace strerror with strerror_r
replaces all references to strerror in the spdk lib directory with
references to the thread safe strerror_r

Change-Id: I80d946cce3299007ee10500b93f7e1c8e503ee41
Signed-off-by: Seth Howell <seth.howell@intel.com>
Reviewed-on: https://review.gerrithub.io/374012
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-08-15 16:47:01 -04:00

156 lines
5.1 KiB
C

/*-
* 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
* String utility functions
*/
#ifndef SPDK_STRING_H
#define SPDK_STRING_H
#include "spdk/stdinc.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* sprintf with automatic buffer allocation.
*
* The return value is the formatted string,
* which should be passed to free() when no longer needed,
* or NULL on failure.
*/
char *spdk_sprintf_alloc(const char *format, ...) __attribute__((format(printf, 1, 2)));
/**
* vsprintf with automatic buffer allocation.
*
* The return value is the formatted string,
* which should be passed to free() when no longer needed,
* or NULL on failure.
*/
char *spdk_vsprintf_alloc(const char *format, va_list args);
/**
* Convert string to lowercase in place.
*
* \param s String to convert to lowercase.
*/
char *spdk_strlwr(char *s);
/**
* Parse a delimited string with quote handling.
*
* \param stringp Pointer to starting location in string. *stringp will be updated to point to the
* start of the next field, or NULL if the end of the string has been reached.
* \param delim Null-terminated string containing the list of accepted delimiters.
*
* \return Pointer to beginning of the current field.
*
* Note that the string will be modified in place to add the string terminator to each field.
*/
char *spdk_strsepq(char **stringp, const char *delim);
/**
* Trim whitespace from a string in place.
*
* \param s String to trim.
*/
char *spdk_str_trim(char *s);
/**
* Copy the string version of an error into the user supplied buffer
*
* \param errnum Error code
* \param buf Pointer to a buffer in which to place the error message
* \param buflen the size of the buffer in bytes
*
* \return 0 upon success, a positive error number or -1 upon failure.
*/
int spdk_strerror_r(int errnum, char *buf, size_t buflen);
/**
* Remove trailing newlines from the end of a string in place.
*
* Any sequence of trailing \r and \n characters is removed from the end of the string.
*
* \param s String to remove newline from.
* \return Number of characters removed.
*/
size_t spdk_str_chomp(char *s);
/**
* Copy a string into a fixed-size buffer, padding extra bytes with a specific character.
*
* \param dst Pointer to destination fixed-size buffer to fill.
* \param src Pointer to source null-terminated string to copy into dst.
* \param size Number of bytes to fill in dst.
* \param pad Character to pad extra space in dst beyond the size of src.
*
* If src is longer than size, only size bytes will be copied.
*/
void spdk_strcpy_pad(void *dst, const char *src, size_t size, int pad);
/**
* Find the length of a string that has been padded with a specific byte.
*
* \param str Right-padded string to find the length of.
* \param size Size of the full string pointed to by str, including padding.
* \param pad Character that was used to pad str up to size.
*
* \return Length of the non-padded portion of str.
*/
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, char **host, char **port);
#ifdef __cplusplus
}
#endif
#endif