lib/librte_eal/common/include/rte_string_fns.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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 /**
  36  * @file
  37  *
  38  * Definitions of warnings for use of various insecure functions
  39  */
  40
  41 #ifndef _RTE_STRING_FNS_H_
  42 #define _RTE_STRING_FNS_H_
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 #include <stdio.h>
  49 #include <stdarg.h>
  50 #include <stddef.h>
  51 #include <errno.h>
  52
  53 /**
  54  * Safer version of snprintf that writes up to buflen characters to
  55  * the output buffer and ensures that the resultant string is null-terminated,
  56  * that is, it writes at most buflen-1 actual string characters to buffer. The
  57  * return value is the number of characters which should be written to the
  58  * buffer, so string truncation can be detected by the caller by checking if
  59  * the return value is greater than or equal to the buflen.
  60  *
  61  * @param buffer
  62  *   The buffer into which the output is to be written
  63  *
  64  * @param buflen
  65  *   The size of the output buffer
  66  *
  67  * @param format
  68  *   The format string to be printed to the buffer
  69  *
  70  * @return
  71  *   The number of characters written to the buffer, or if the string has been
  72  *   truncated, the number of characters which would have been written had the
  73  *   buffer been sufficiently big.
  74  *
  75  */
  76 static inline int
  77 rte_snprintf(char *buffer, int buflen, const char *format, ...)
  78 {
  79         int len;
  80         va_list ap;
  81
  82         if (buffer == NULL && buflen != 0)
  83                 goto einval_error;
  84         if (format == NULL) {
  85                 if (buflen > 0)
  86                         buffer[0] = '\0';
  87                 goto einval_error;
  88         }
  89
  90         va_start(ap, format);
  91         len = vsnprintf(buffer, buflen, format, ap);
  92         va_end(ap);
  93         if (len >= buflen && buflen > 0)
  94                 buffer[buflen - 1] = '\0';
  95
  96         return len;
  97
  98 einval_error:
  99         errno = EINVAL;
 100         return -1;
 101 }
 102
 103
 104 /**
 105  * Takes string "string" parameter and splits it at character "delim"
 106  * up to maxtokens-1 times - to give "maxtokens" resulting tokens. Like
 107  * strtok or strsep functions, this modifies its input string, by replacing
 108  * instances of "delim" with '\0'. All resultant tokens are returned in the
 109  * "tokens" array which must have enough entries to hold "maxtokens".
 110  *
 111  * @param string
 112  *   The input string to be split into tokens
 113  *
 114  * @param stringlen
 115  *   The max length of the input buffer
 116  *
 117  * @param tokens
 118  *   The array to hold the pointers to the tokens in the string
 119  *
 120  * @param maxtokens
 121  *   The number of elements in the tokens array. At most, maxtokens-1 splits
 122  *   of the string will be done.
 123  *
 124  * @param delim
 125  *   The character on which the split of the data will be done
 126  *
 127  * @return
 128  *   The number of tokens in the tokens array.
 129  */
 130 static inline int
 131 rte_strsplit(char *string, int stringlen,
 132                 char **tokens, int maxtokens, char delim)
 133 {
 134         int i, tok = 0;
 135         int tokstart = 1; /* first token is right at start of string */
 136
 137         if (string == NULL || tokens == NULL)
 138                 goto einval_error;
 139
 140         for (i = 0; i < stringlen; i++) {
 141                 if (string[i] == '\0' || tok >= maxtokens)
 142                         break;
 143                 if (tokstart) {
 144                         tokstart = 0;
 145                         tokens[tok++] = &string[i];
 146                 }
 147                 if (string[i] == delim) {
 148                         string[i] = '\0';
 149                         tokstart = 1;
 150                 }
 151         }
 152         return tok;
 153
 154 einval_error:
 155         errno = EINVAL;
 156         return -1;
 157 }
 158
 159 #ifdef __cplusplus
 160 }
 161 #endif
 162
 163
 164 #endif /* RTE_STRING_FNS_H */