lib/librte_eal/common/include/rte_string_fns.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 /**
  35  * @file
  36  *
  37  * String-related functions as replacement for libc equivalents
  38  */
  39
  40 #ifndef _RTE_STRING_FNS_H_
  41 #define _RTE_STRING_FNS_H_
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 #include <stdio.h>
  48
  49 /**
  50  * Takes string "string" parameter and splits it at character "delim"
  51  * up to maxtokens-1 times - to give "maxtokens" resulting tokens. Like
  52  * strtok or strsep functions, this modifies its input string, by replacing
  53  * instances of "delim" with '\\0'. All resultant tokens are returned in the
  54  * "tokens" array which must have enough entries to hold "maxtokens".
  55  *
  56  * @param string
  57  *   The input string to be split into tokens
  58  *
  59  * @param stringlen
  60  *   The max length of the input buffer
  61  *
  62  * @param tokens
  63  *   The array to hold the pointers to the tokens in the string
  64  *
  65  * @param maxtokens
  66  *   The number of elements in the tokens array. At most, maxtokens-1 splits
  67  *   of the string will be done.
  68  *
  69  * @param delim
  70  *   The character on which the split of the data will be done
  71  *
  72  * @return
  73  *   The number of tokens in the tokens array.
  74  */
  75 int
  76 rte_strsplit(char *string, int stringlen,
  77              char **tokens, int maxtokens, char delim);
  78
  79 /**
  80  * @internal
  81  * DPDK-specific version of strlcpy for systems without
  82  * libc or libbsd copies of the function
  83  */
  84 static inline size_t
  85 rte_strlcpy(char *dst, const char *src, size_t size)
  86 {
  87         return snprintf(dst, size, "%s", src);
  88 }
  89
  90 /* pull in a strlcpy function */
  91 #ifdef RTE_EXEC_ENV_BSDAPP
  92 #include <string.h>
  93 #ifndef __BSD_VISIBLE /* non-standard functions are hidden */
  94 #define strlcpy(dst, src, size) rte_strlcpy(dst, src, size)
  95 #endif
  96
  97
  98 #else /* non-BSD platforms */
  99 #ifdef RTE_USE_LIBBSD
 100 #include <bsd/string.h>
 101
 102 #else /* no BSD header files, create own */
 103 #define strlcpy(dst, src, size) rte_strlcpy(dst, src, size)
 104
 105 #endif /* RTE_USE_LIBBSD */
 106 #endif /* BSDAPP */
 107
 108 #ifdef __cplusplus
 109 }
 110 #endif
 111
 112 #endif /* RTE_STRING_FNS_H */