lib/librte_eal/common/include/rte_string_fns.h

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