Whamcloud - gitweb
LU-6142 libcfs: use BIT() macro where appropriate
[fs/lustre-release.git] / libcfs / libcfs / libcfs_string.c
index db376b5..f559701 100644 (file)
  *
  * You should have received a copy of the GNU General Public License
  * version 2 along with this program; If not, see
- * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
- *
- * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
- * CA 95054 USA or visit www.sun.com if you need additional information or
- * have any questions.
+ * http://www.gnu.org/licenses/gpl-2.0.html
  *
  * GPL HEADER END
  */
@@ -27,7 +23,7 @@
  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
  *
- * Copyright (c) 2012, Intel Corporation.
+ * Copyright (c) 2012, 2017, Intel Corporation.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
  * Author: Nathan Rutman <nathan.rutman@sun.com>
  */
 
+#include <linux/ctype.h>
 #include <libcfs/libcfs.h>
+#include <libcfs/libcfs_string.h>
 
-/* non-0 = don't match */
-int cfs_strncasecmp(const char *s1, const char *s2, size_t n)
+char *cfs_strrstr(const char *haystack, const char *needle)
 {
-        if (s1 == NULL || s2 == NULL)
-                return 1;
+       char *ptr;
 
-        if (n == 0)
-                return 0;
+       if (unlikely(haystack == NULL || needle == NULL))
+               return NULL;
 
-        while (n-- != 0 && tolower(*s1) == tolower(*s2)) {
-                if (n == 0 || *s1 == '\0' || *s2 == '\0')
-                        break;
-                s1++;
-                s2++;
-        }
+       if (strlen(needle) == 1)
+               return strrchr(haystack, needle[0]);
+
+       ptr = strstr(haystack, needle);
+       if (ptr != NULL) {
+               while (1) {
+                       char *tmp;
+
+                       tmp = strstr(&ptr[1], needle);
+                       if (tmp == NULL)
+                               return ptr;
+
+                       ptr = tmp;
+               }
+       }
 
-        return tolower(*(unsigned char *)s1) - tolower(*(unsigned char *)s2);
+       return NULL;
 }
-EXPORT_SYMBOL(cfs_strncasecmp);
+EXPORT_SYMBOL(cfs_strrstr);
 
 /* Convert a text string to a bitmask */
 int cfs_str2mask(const char *str, const char *(*bit2str)(int bit),
@@ -98,21 +103,21 @@ int cfs_str2mask(const char *str, const char *(*bit2str)(int bit),
 
                 /* match token */
                 found = 0;
-                for (i = 0; i < 32; i++) {
-                        debugstr = bit2str(i);
-                        if (debugstr != NULL &&
-                            strlen(debugstr) == len &&
-                            cfs_strncasecmp(str, debugstr, len) == 0) {
-                                if (op == '-')
-                                        newmask &= ~(1 << i);
-                                else
-                                        newmask |= (1 << i);
-                                found = 1;
-                                break;
-                        }
-                }
+               for (i = 0; i < 32; i++) {
+                       debugstr = bit2str(i);
+                       if (debugstr != NULL &&
+                           strlen(debugstr) == len &&
+                           strncasecmp(str, debugstr, len) == 0) {
+                               if (op == '-')
+                                       newmask &= ~BIT(i);
+                               else
+                                       newmask |= BIT(i);
+                               found = 1;
+                               break;
+                       }
+               }
                 if (!found && len == 3 &&
-                    (cfs_strncasecmp(str, "ALL", len) == 0)) {
+                    (strncasecmp(str, "ALL", len) == 0)) {
                         if (op == '-')
                                 newmask = minmask;
                         else
@@ -132,54 +137,6 @@ int cfs_str2mask(const char *str, const char *(*bit2str)(int bit),
 }
 EXPORT_SYMBOL(cfs_str2mask);
 
-/* Duplicate a string in a platform-independent way */
-char *cfs_strdup(const char *str, u_int32_t flags)
-{
-        size_t lenz; /* length of str + zero byte */
-        char *dup_str;
-
-        lenz = strlen(str) + 1;
-
-        dup_str = cfs_alloc(lenz, flags);
-        if (dup_str == NULL)
-                return NULL;
-
-        memcpy(dup_str, str, lenz);
-
-        return dup_str;
-}
-EXPORT_SYMBOL(cfs_strdup);
-
-/**
- * cfs_{v}snprintf() return the actual size that is printed rather than
- * the size that would be printed in standard functions.
- */
-/* safe vsnprintf */
-int cfs_vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
-{
-        int i;
-
-        LASSERT(size > 0);
-        i = vsnprintf(buf, size, fmt, args);
-
-        return  (i >= size ? size - 1 : i);
-}
-EXPORT_SYMBOL(cfs_vsnprintf);
-
-/* safe snprintf */
-int cfs_snprintf(char *buf, size_t size, const char *fmt, ...)
-{
-        va_list args;
-        int i;
-
-        va_start(args, fmt);
-        i = cfs_vsnprintf(buf, size, fmt, args);
-        va_end(args);
-
-        return  i;
-}
-EXPORT_SYMBOL(cfs_snprintf);
-
 /* get the first string out of @str */
 char *cfs_firststr(char *str, size_t size)
 {
@@ -208,26 +165,6 @@ out:
 }
 EXPORT_SYMBOL(cfs_firststr);
 
-char *
-cfs_trimwhite(char *str)
-{
-       char *end;
-
-       while (cfs_iswhite(*str))
-               str++;
-
-       end = str + strlen(str);
-       while (end > str) {
-               if (!cfs_iswhite(end[-1]))
-                       break;
-               end--;
-       }
-
-       *end = 0;
-       return str;
-}
-EXPORT_SYMBOL(cfs_trimwhite);
-
 /**
  * Extracts tokens from strings.
  *
@@ -248,7 +185,7 @@ cfs_gettok(struct cfs_lstr *next, char delim, struct cfs_lstr *res)
 
        /* skip leading white spaces */
        while (next->ls_len) {
-               if (!cfs_iswhite(*next->ls_str))
+               if (!isspace(*next->ls_str))
                        break;
                next->ls_str++;
                next->ls_len--;
@@ -275,7 +212,7 @@ cfs_gettok(struct cfs_lstr *next, char delim, struct cfs_lstr *res)
 
        /* skip ending whitespaces */
        while (--end != res->ls_str) {
-               if (!cfs_iswhite(*end))
+               if (!isspace(*end))
                        break;
        }
 
@@ -297,18 +234,47 @@ int
 cfs_str2num_check(char *str, int nob, unsigned *num,
                  unsigned min, unsigned max)
 {
-       char    *endp;
-
-       str = cfs_trimwhite(str);
-       *num = strtoul(str, &endp, 0);
-       if (endp == str)
-               return 0;
+       bool all_numbers = true;
+       char *endp, cache;
+       int len;
+       int rc;
+
+       endp = strim(str);
+       /**
+        * kstrouint can only handle strings composed
+        * of only numbers. We need to scan the string
+        * passed in for the first non-digit character
+        * and end the string at that location. If we
+        * don't find any non-digit character we still
+        * need to place a '\0' at position len since
+        * we are not interested in the rest of the
+        * string which is longer than len in size.
+        * After we are done the character at the
+        * position we placed '\0' must be restored.
+        */
+       len = min((int)strlen(endp), nob);
+       for (; endp < str + len; endp++) {
+               if (!isxdigit(*endp) && *endp != '-' &&
+                   *endp != '+') {
+                       all_numbers = false;
+                       break;
+               }
+       }
 
-       for (; endp < str + nob; endp++) {
-               if (!cfs_iswhite(*endp))
-                       return 0;
+       /* Eat trailing space */
+       if (!all_numbers && isspace(*endp)) {
+               all_numbers = true;
+               endp--;
        }
 
+       cache = *endp;
+       *endp = '\0';
+
+       rc = kstrtouint(str, 0, num);
+       *endp = cache;
+       if (rc || !all_numbers)
+               return 0;
+
        return (*num >= min && *num <= max);
 }
 EXPORT_SYMBOL(cfs_str2num_check);
@@ -326,7 +292,7 @@ EXPORT_SYMBOL(cfs_str2num_check);
  * \retval 0 will be returned if it can be parsed, otherwise -EINVAL or
  * -ENOMEM will be returned.
  */
-int
+static int
 cfs_range_expr_parse(struct cfs_lstr *src, unsigned min, unsigned max,
                     int bracketed, struct cfs_range_expr **expr)
 {
@@ -389,7 +355,73 @@ cfs_range_expr_parse(struct cfs_lstr *src, unsigned min, unsigned max,
        LIBCFS_FREE(re, sizeof(*re));
        return -EINVAL;
 }
-EXPORT_SYMBOL(cfs_range_expr_parse);
+
+/**
+ * Print the range expression \a re into specified \a buffer.
+ * If \a bracketed is true, expression does not need additional
+ * brackets.
+ *
+ * \retval number of characters written
+ */
+static int
+cfs_range_expr_print(char *buffer, int count, struct cfs_range_expr *expr,
+                    bool bracketed)
+{
+       int i;
+       char s[] = "[";
+       char e[] = "]";
+
+       if (bracketed)
+               s[0] = e[0] = '\0';
+
+       if (expr->re_lo == expr->re_hi)
+               i = scnprintf(buffer, count, "%u", expr->re_lo);
+       else if (expr->re_stride == 1)
+               i = scnprintf(buffer, count, "%s%u-%u%s",
+                                 s, expr->re_lo, expr->re_hi, e);
+       else
+               i = scnprintf(buffer, count, "%s%u-%u/%u%s",
+                                 s, expr->re_lo, expr->re_hi,
+                                 expr->re_stride, e);
+       return i;
+}
+
+/**
+ * Print a list of range expressions (\a expr_list) into specified \a buffer.
+ * If the list contains several expressions, separate them with comma
+ * and surround the list with brackets.
+ *
+ * \retval number of characters written
+ */
+int
+cfs_expr_list_print(char *buffer, int count, struct cfs_expr_list *expr_list)
+{
+       struct cfs_range_expr *expr;
+       int i = 0, j = 0;
+       int numexprs = 0;
+
+       if (count <= 0)
+               return 0;
+
+       list_for_each_entry(expr, &expr_list->el_exprs, re_link)
+               numexprs++;
+
+       if (numexprs > 1)
+               i += scnprintf(buffer + i, count - i, "[");
+
+       list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
+               if (j++ != 0)
+                       i += scnprintf(buffer + i, count - i, ",");
+               i += cfs_range_expr_print(buffer + i, count - i, expr,
+                                         numexprs > 1);
+       }
+
+       if (numexprs > 1)
+               i += scnprintf(buffer + i, count - i, "]");
+
+       return i;
+}
+EXPORT_SYMBOL(cfs_expr_list_print);
 
 /**
  * Matches value (\a value) against ranges expression list \a expr_list.
@@ -402,7 +434,7 @@ cfs_expr_list_match(__u32 value, struct cfs_expr_list *expr_list)
 {
        struct cfs_range_expr   *expr;
 
-       cfs_list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
+       list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
                if (value >= expr->re_lo && value <= expr->re_hi &&
                    ((value - expr->re_lo) % expr->re_stride) == 0)
                        return 1;
@@ -427,7 +459,7 @@ cfs_expr_list_values(struct cfs_expr_list *expr_list, int max, __u32 **valpp)
        int                     count = 0;
        int                     i;
 
-       cfs_list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
+       list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
                for (i = expr->re_lo; i <= expr->re_hi; i++) {
                        if (((i - expr->re_lo) % expr->re_stride) == 0)
                                count++;
@@ -443,12 +475,12 @@ cfs_expr_list_values(struct cfs_expr_list *expr_list, int max, __u32 **valpp)
                return -EINVAL;
        }
 
-       LIBCFS_ALLOC(val, sizeof(val[0]) * count);
+       CFS_ALLOC_PTR_ARRAY(val, count);
        if (val == NULL)
                return -ENOMEM;
 
        count = 0;
-       cfs_list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
+       list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
                for (i = expr->re_lo; i <= expr->re_hi; i++) {
                        if (((i - expr->re_lo) % expr->re_stride) == 0)
                                val[count++] = i;
@@ -460,6 +492,16 @@ cfs_expr_list_values(struct cfs_expr_list *expr_list, int max, __u32 **valpp)
 }
 EXPORT_SYMBOL(cfs_expr_list_values);
 
+void
+cfs_expr_list_values_free(__u32 *values, int num)
+{
+       /* This array is allocated by LIBCFS_ALLOC(), so it shouldn't be freed
+        * by OBD_FREE() if it's called by module other than libcfs & LNet,
+        * otherwise we will see fake memory leak */
+       CFS_FREE_PTR_ARRAY(values, num);
+}
+EXPORT_SYMBOL(cfs_expr_list_values_free);
+
 /**
  * Frees cfs_range_expr structures of \a expr_list.
  *
@@ -468,12 +510,12 @@ EXPORT_SYMBOL(cfs_expr_list_values);
 void
 cfs_expr_list_free(struct cfs_expr_list *expr_list)
 {
-       while (!cfs_list_empty(&expr_list->el_exprs)) {
+       while (!list_empty(&expr_list->el_exprs)) {
                struct cfs_range_expr *expr;
 
-               expr = cfs_list_entry(expr_list->el_exprs.next,
-                                     struct cfs_range_expr, re_link),
-               cfs_list_del(&expr->re_link);
+               expr = list_entry(expr_list->el_exprs.next,
+                                     struct cfs_range_expr, re_link);
+               list_del(&expr->re_link);
                LIBCFS_FREE(expr, sizeof(*expr));
        }
 
@@ -481,23 +523,11 @@ cfs_expr_list_free(struct cfs_expr_list *expr_list)
 }
 EXPORT_SYMBOL(cfs_expr_list_free);
 
-void
-cfs_expr_list_print(struct cfs_expr_list *expr_list)
-{
-       struct cfs_range_expr *expr;
-
-       cfs_list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
-               CDEBUG(D_WARNING, "%d-%d/%d\n",
-                      expr->re_lo, expr->re_hi, expr->re_stride);
-       }
-}
-EXPORT_SYMBOL(cfs_expr_list_print);
-
 /**
  * Parses \<cfs_expr_list\> token of the syntax.
  *
- * \retval 1 if \a str parses to \<number\> | \<expr_list\>
- * \retval 0 otherwise
+ * \retval 0 if \a str parses to \<number\> | \<expr_list\>
+ * \retval -errno otherwise
  */
 int
 cfs_expr_list_parse(char *str, int len, unsigned min, unsigned max,
@@ -515,7 +545,7 @@ cfs_expr_list_parse(char *str, int len, unsigned min, unsigned max,
        src.ls_str = str;
        src.ls_len = len;
 
-       CFS_INIT_LIST_HEAD(&expr_list->el_exprs);
+       INIT_LIST_HEAD(&expr_list->el_exprs);
 
        if (src.ls_str[0] == '[' &&
            src.ls_str[src.ls_len - 1] == ']') {
@@ -535,13 +565,13 @@ cfs_expr_list_parse(char *str, int len, unsigned min, unsigned max,
                        if (rc != 0)
                                break;
 
-                       cfs_list_add_tail(&expr->re_link,
+                       list_add_tail(&expr->re_link,
                                          &expr_list->el_exprs);
                }
        } else {
                rc = cfs_range_expr_parse(&src, min, max, 0, &expr);
                if (rc == 0) {
-                       cfs_list_add_tail(&expr->re_link,
+                       list_add_tail(&expr->re_link,
                                          &expr_list->el_exprs);
                }
        }
@@ -564,84 +594,15 @@ EXPORT_SYMBOL(cfs_expr_list_parse);
  * \retval none
  */
 void
-cfs_expr_list_free_list(cfs_list_t *list)
+cfs_expr_list_free_list(struct list_head *list)
 {
        struct cfs_expr_list *el;
 
-       while (!cfs_list_empty(list)) {
-               el = cfs_list_entry(list->next,
+       while (!list_empty(list)) {
+               el = list_entry(list->next,
                                    struct cfs_expr_list, el_link);
-               cfs_list_del(&el->el_link);
+               list_del(&el->el_link);
                cfs_expr_list_free(el);
        }
 }
 EXPORT_SYMBOL(cfs_expr_list_free_list);
-
-int
-cfs_ip_addr_parse(char *str, int len, cfs_list_t *list)
-{
-       struct cfs_expr_list    *el;
-       struct cfs_lstr         src;
-       int                     rc;
-       int                     i;
-
-       src.ls_str = str;
-       src.ls_len = len;
-       i = 0;
-
-       while (src.ls_str != NULL) {
-               struct cfs_lstr res;
-
-               if (!cfs_gettok(&src, '.', &res)) {
-                       rc = -EINVAL;
-                       goto out;
-               }
-
-               rc = cfs_expr_list_parse(res.ls_str, res.ls_len, 0, 255, &el);
-               if (rc != 0)
-                       goto out;
-
-               cfs_list_add_tail(&el->el_link, list);
-               i++;
-       }
-
-       if (i == 4)
-               return 0;
-
-       rc = -EINVAL;
- out:
-       cfs_expr_list_free_list(list);
-
-       return rc;
-}
-EXPORT_SYMBOL(cfs_ip_addr_parse);
-
-/**
- * Matches address (\a addr) against address set encoded in \a list.
- *
- * \retval 1 if \a addr matches
- * \retval 0 otherwise
- */
-int
-cfs_ip_addr_match(__u32 addr, cfs_list_t *list)
-{
-       struct cfs_expr_list *el;
-       int i = 0;
-
-       cfs_list_for_each_entry_reverse(el, list, el_link) {
-               if (!cfs_expr_list_match(addr & 0xff, el))
-                       return 0;
-               addr >>= 8;
-               i++;
-       }
-
-       return i == 4;
-}
-EXPORT_SYMBOL(cfs_ip_addr_match);
-
-void
-cfs_ip_addr_free(cfs_list_t *list)
-{
-       cfs_expr_list_free_list(list);
-}
-EXPORT_SYMBOL(cfs_ip_addr_free);