4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * String manipulation functions.
38 * libcfs/libcfs/libcfs_string.c
40 * Author: Nathan Rutman <nathan.rutman@sun.com>
43 #include <libcfs/libcfs.h>
45 char *cfs_strrstr(const char *haystack, const char *needle)
49 if (unlikely(haystack == NULL || needle == NULL))
52 if (strlen(needle) == 1)
53 return strrchr(haystack, needle[0]);
55 ptr = strstr(haystack, needle);
60 tmp = strstr(&ptr[1], needle);
70 EXPORT_SYMBOL(cfs_strrstr);
72 /* non-0 = don't match */
73 int cfs_strncasecmp(const char *s1, const char *s2, size_t n)
75 if (s1 == NULL || s2 == NULL)
81 while (n-- != 0 && tolower(*s1) == tolower(*s2)) {
82 if (n == 0 || *s1 == '\0' || *s2 == '\0')
88 return tolower(*(unsigned char *)s1) - tolower(*(unsigned char *)s2);
90 EXPORT_SYMBOL(cfs_strncasecmp);
92 /* Convert a text string to a bitmask */
93 int cfs_str2mask(const char *str, const char *(*bit2str)(int bit),
94 int *oldmask, int minmask, int allmask)
98 int newmask = minmask, i, len, found = 0;
101 /* <str> must be a list of tokens separated by whitespace
102 * and optionally an operator ('+' or '-'). If an operator
103 * appears first in <str>, '*oldmask' is used as the starting point
104 * (relative), otherwise minmask is used (absolute). An operator
105 * applies to all following tokens up to the next operator. */
107 while (isspace(*str))
111 if (*str == '+' || *str == '-') {
114 /* only if first token is relative */
116 while (isspace(*str))
118 if (*str == 0) /* trailing op */
122 /* find token length */
123 for (len = 0; str[len] != 0 && !isspace(str[len]) &&
124 str[len] != '+' && str[len] != '-'; len++);
128 for (i = 0; i < 32; i++) {
129 debugstr = bit2str(i);
130 if (debugstr != NULL &&
131 strlen(debugstr) == len &&
132 cfs_strncasecmp(str, debugstr, len) == 0) {
134 newmask &= ~(1 << i);
141 if (!found && len == 3 &&
142 (cfs_strncasecmp(str, "ALL", len) == 0)) {
150 CWARN("unknown mask '%.*s'.\n"
151 "mask usage: [+|-]<all|type> ...\n", len, str);
160 EXPORT_SYMBOL(cfs_str2mask);
162 /* Duplicate a string in a platform-independent way */
163 char *cfs_strdup(const char *str, u_int32_t flags)
165 size_t lenz; /* length of str + zero byte */
168 lenz = strlen(str) + 1;
170 dup_str = kmalloc(lenz, flags);
174 memcpy(dup_str, str, lenz);
178 EXPORT_SYMBOL(cfs_strdup);
181 * cfs_{v}snprintf() return the actual size that is printed rather than
182 * the size that would be printed in standard functions.
185 int cfs_vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
190 i = vsnprintf(buf, size, fmt, args);
192 return (i >= size ? size - 1 : i);
194 EXPORT_SYMBOL(cfs_vsnprintf);
197 int cfs_snprintf(char *buf, size_t size, const char *fmt, ...)
203 i = cfs_vsnprintf(buf, size, fmt, args);
208 EXPORT_SYMBOL(cfs_snprintf);
210 /* get the first string out of @str */
211 char *cfs_firststr(char *str, size_t size)
216 /* trim leading spaces */
217 while (i < size && *str && isspace(*str)) {
222 /* string with all spaces */
227 while (i < size && *end != '\0' && !isspace(*end)) {
236 EXPORT_SYMBOL(cfs_firststr);
239 cfs_trimwhite(char *str)
243 while (cfs_iswhite(*str))
246 end = str + strlen(str);
248 if (!cfs_iswhite(end[-1]))
256 EXPORT_SYMBOL(cfs_trimwhite);
259 * Extracts tokens from strings.
261 * Looks for \a delim in string \a next, sets \a res to point to
262 * substring before the delimiter, sets \a next right after the found
265 * \retval 1 if \a res points to a string of non-whitespace characters
266 * \retval 0 otherwise
269 cfs_gettok(struct cfs_lstr *next, char delim, struct cfs_lstr *res)
273 if (next->ls_str == NULL)
276 /* skip leading white spaces */
277 while (next->ls_len) {
278 if (!cfs_iswhite(*next->ls_str))
284 if (next->ls_len == 0) /* whitespaces only */
287 if (*next->ls_str == delim) {
288 /* first non-writespace is the delimiter */
292 res->ls_str = next->ls_str;
293 end = memchr(next->ls_str, delim, next->ls_len);
295 /* there is no the delimeter in the string */
296 end = next->ls_str + next->ls_len;
299 next->ls_str = end + 1;
300 next->ls_len -= (end - res->ls_str + 1);
303 /* skip ending whitespaces */
304 while (--end != res->ls_str) {
305 if (!cfs_iswhite(*end))
309 res->ls_len = end - res->ls_str + 1;
312 EXPORT_SYMBOL(cfs_gettok);
315 * Converts string to integer.
317 * Accepts decimal and hexadecimal number recordings.
319 * \retval 1 if first \a nob chars of \a str convert to decimal or
320 * hexadecimal integer in the range [\a min, \a max]
321 * \retval 0 otherwise
324 cfs_str2num_check(char *str, int nob, unsigned *num,
325 unsigned min, unsigned max)
329 str = cfs_trimwhite(str);
330 *num = strtoul(str, &endp, 0);
334 for (; endp < str + nob; endp++) {
335 if (!cfs_iswhite(*endp))
339 return (*num >= min && *num <= max);
341 EXPORT_SYMBOL(cfs_str2num_check);
344 * Parses \<range_expr\> token of the syntax. If \a bracketed is false,
345 * \a src should only have a single token which can be \<number\> or \*
347 * \retval pointer to allocated range_expr and initialized
348 * range_expr::re_lo, range_expr::re_hi and range_expr:re_stride if \a
351 * \<number\> '-' \<number\> |
352 * \<number\> '-' \<number\> '/' \<number\>
353 * \retval 0 will be returned if it can be parsed, otherwise -EINVAL or
354 * -ENOMEM will be returned.
357 cfs_range_expr_parse(struct cfs_lstr *src, unsigned min, unsigned max,
358 int bracketed, struct cfs_range_expr **expr)
360 struct cfs_range_expr *re;
363 LIBCFS_ALLOC(re, sizeof(*re));
367 if (src->ls_len == 1 && src->ls_str[0] == '*') {
374 if (cfs_str2num_check(src->ls_str, src->ls_len,
375 &re->re_lo, min, max)) {
376 /* <number> is parsed */
377 re->re_hi = re->re_lo;
382 if (!bracketed || !cfs_gettok(src, '-', &tok))
385 if (!cfs_str2num_check(tok.ls_str, tok.ls_len,
386 &re->re_lo, min, max))
390 if (cfs_str2num_check(src->ls_str, src->ls_len,
391 &re->re_hi, min, max)) {
392 /* <number> - <number> is parsed */
397 /* go to check <number> '-' <number> '/' <number> */
398 if (cfs_gettok(src, '/', &tok)) {
399 if (!cfs_str2num_check(tok.ls_str, tok.ls_len,
400 &re->re_hi, min, max))
403 /* <number> - <number> / ... */
404 if (cfs_str2num_check(src->ls_str, src->ls_len,
405 &re->re_stride, min, max)) {
406 /* <number> - <number> / <number> is parsed */
416 LIBCFS_FREE(re, sizeof(*re));
419 EXPORT_SYMBOL(cfs_range_expr_parse);
422 * Print the range expression \a re into specified \a buffer.
423 * If \a bracketed is true, expression does not need additional
426 * \retval number of characters written
429 cfs_range_expr_print(char *buffer, int count, struct cfs_range_expr *expr,
439 if (expr->re_lo == expr->re_hi)
440 i = cfs_snprintf(buffer, count, "%u", expr->re_lo);
441 else if (expr->re_stride == 1)
442 i = cfs_snprintf(buffer, count, "%s%u-%u%s",
443 s, expr->re_lo, expr->re_hi, e);
445 i = cfs_snprintf(buffer, count, "%s%u-%u/%u%s",
446 s, expr->re_lo, expr->re_hi,
452 * Print a list of range expressions (\a expr_list) into specified \a buffer.
453 * If the list contains several expressions, separate them with comma
454 * and surround the list with brackets.
456 * \retval number of characters written
459 cfs_expr_list_print(char *buffer, int count, struct cfs_expr_list *expr_list)
461 struct cfs_range_expr *expr;
468 list_for_each_entry(expr, &expr_list->el_exprs, re_link)
472 i += cfs_snprintf(buffer + i, count - i, "[");
474 list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
476 i += cfs_snprintf(buffer + i, count - i, ",");
477 i += cfs_range_expr_print(buffer + i, count - i, expr,
482 i += cfs_snprintf(buffer + i, count - i, "]");
486 EXPORT_SYMBOL(cfs_expr_list_print);
489 * Matches value (\a value) against ranges expression list \a expr_list.
491 * \retval 1 if \a value matches
492 * \retval 0 otherwise
495 cfs_expr_list_match(__u32 value, struct cfs_expr_list *expr_list)
497 struct cfs_range_expr *expr;
499 list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
500 if (value >= expr->re_lo && value <= expr->re_hi &&
501 ((value - expr->re_lo) % expr->re_stride) == 0)
507 EXPORT_SYMBOL(cfs_expr_list_match);
510 * Convert express list (\a expr_list) to an array of all matched values
512 * \retval N N is total number of all matched values
513 * \retval 0 if expression list is empty
514 * \retval < 0 for failure
517 cfs_expr_list_values(struct cfs_expr_list *expr_list, int max, __u32 **valpp)
519 struct cfs_range_expr *expr;
524 list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
525 for (i = expr->re_lo; i <= expr->re_hi; i++) {
526 if (((i - expr->re_lo) % expr->re_stride) == 0)
531 if (count == 0) /* empty expression list */
535 CERROR("Number of values %d exceeds max allowed %d\n",
540 LIBCFS_ALLOC(val, sizeof(val[0]) * count);
545 list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
546 for (i = expr->re_lo; i <= expr->re_hi; i++) {
547 if (((i - expr->re_lo) % expr->re_stride) == 0)
555 EXPORT_SYMBOL(cfs_expr_list_values);
558 * Frees cfs_range_expr structures of \a expr_list.
563 cfs_expr_list_free(struct cfs_expr_list *expr_list)
565 while (!list_empty(&expr_list->el_exprs)) {
566 struct cfs_range_expr *expr;
568 expr = list_entry(expr_list->el_exprs.next,
569 struct cfs_range_expr, re_link),
570 list_del(&expr->re_link);
571 LIBCFS_FREE(expr, sizeof(*expr));
574 LIBCFS_FREE(expr_list, sizeof(*expr_list));
576 EXPORT_SYMBOL(cfs_expr_list_free);
579 * Parses \<cfs_expr_list\> token of the syntax.
581 * \retval 0 if \a str parses to \<number\> | \<expr_list\>
582 * \retval -errno otherwise
585 cfs_expr_list_parse(char *str, int len, unsigned min, unsigned max,
586 struct cfs_expr_list **elpp)
588 struct cfs_expr_list *expr_list;
589 struct cfs_range_expr *expr;
593 LIBCFS_ALLOC(expr_list, sizeof(*expr_list));
594 if (expr_list == NULL)
600 INIT_LIST_HEAD(&expr_list->el_exprs);
602 if (src.ls_str[0] == '[' &&
603 src.ls_str[src.ls_len - 1] == ']') {
608 while (src.ls_str != NULL) {
611 if (!cfs_gettok(&src, ',', &tok)) {
616 rc = cfs_range_expr_parse(&tok, min, max, 1, &expr);
620 list_add_tail(&expr->re_link,
621 &expr_list->el_exprs);
624 rc = cfs_range_expr_parse(&src, min, max, 0, &expr);
626 list_add_tail(&expr->re_link,
627 &expr_list->el_exprs);
632 cfs_expr_list_free(expr_list);
638 EXPORT_SYMBOL(cfs_expr_list_parse);
641 * Frees cfs_expr_list structures of \a list.
643 * For each struct cfs_expr_list structure found on \a list it frees
644 * range_expr list attached to it and frees the cfs_expr_list itself.
649 cfs_expr_list_free_list(struct list_head *list)
651 struct cfs_expr_list *el;
653 while (!list_empty(list)) {
654 el = list_entry(list->next,
655 struct cfs_expr_list, el_link);
656 list_del(&el->el_link);
657 cfs_expr_list_free(el);
660 EXPORT_SYMBOL(cfs_expr_list_free_list);
663 cfs_ip_addr_parse(char *str, int len, struct list_head *list)
665 struct cfs_expr_list *el;
674 while (src.ls_str != NULL) {
677 if (!cfs_gettok(&src, '.', &res)) {
682 rc = cfs_expr_list_parse(res.ls_str, res.ls_len, 0, 255, &el);
686 list_add_tail(&el->el_link, list);
695 cfs_expr_list_free_list(list);
699 EXPORT_SYMBOL(cfs_ip_addr_parse);
702 * Matches address (\a addr) against address set encoded in \a list.
704 * \retval 1 if \a addr matches
705 * \retval 0 otherwise
708 cfs_ip_addr_match(__u32 addr, struct list_head *list)
710 struct cfs_expr_list *el;
713 list_for_each_entry_reverse(el, list, el_link) {
714 if (!cfs_expr_list_match(addr & 0xff, el))
722 EXPORT_SYMBOL(cfs_ip_addr_match);
725 cfs_ip_addr_free(struct list_head *list)
727 cfs_expr_list_free_list(list);
729 EXPORT_SYMBOL(cfs_ip_addr_free);