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, 2015, 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 /* Convert a text string to a bitmask */
73 int cfs_str2mask(const char *str, const char *(*bit2str)(int bit),
74 int *oldmask, int minmask, int allmask)
78 int newmask = minmask, i, len, found = 0;
81 /* <str> must be a list of tokens separated by whitespace
82 * and optionally an operator ('+' or '-'). If an operator
83 * appears first in <str>, '*oldmask' is used as the starting point
84 * (relative), otherwise minmask is used (absolute). An operator
85 * applies to all following tokens up to the next operator. */
91 if (*str == '+' || *str == '-') {
94 /* only if first token is relative */
98 if (*str == 0) /* trailing op */
102 /* find token length */
103 for (len = 0; str[len] != 0 && !isspace(str[len]) &&
104 str[len] != '+' && str[len] != '-'; len++);
108 for (i = 0; i < 32; i++) {
109 debugstr = bit2str(i);
110 if (debugstr != NULL &&
111 strlen(debugstr) == len &&
112 strncasecmp(str, debugstr, len) == 0) {
114 newmask &= ~(1 << i);
121 if (!found && len == 3 &&
122 (strncasecmp(str, "ALL", len) == 0)) {
130 CWARN("unknown mask '%.*s'.\n"
131 "mask usage: [+|-]<all|type> ...\n", len, str);
140 EXPORT_SYMBOL(cfs_str2mask);
142 /* get the first string out of @str */
143 char *cfs_firststr(char *str, size_t size)
148 /* trim leading spaces */
149 while (i < size && *str && isspace(*str)) {
154 /* string with all spaces */
159 while (i < size && *end != '\0' && !isspace(*end)) {
168 EXPORT_SYMBOL(cfs_firststr);
171 cfs_trimwhite(char *str)
175 while (isspace(*str))
178 end = str + strlen(str);
180 if (!isspace(end[-1]))
188 EXPORT_SYMBOL(cfs_trimwhite);
191 * Extracts tokens from strings.
193 * Looks for \a delim in string \a next, sets \a res to point to
194 * substring before the delimiter, sets \a next right after the found
197 * \retval 1 if \a res points to a string of non-whitespace characters
198 * \retval 0 otherwise
201 cfs_gettok(struct cfs_lstr *next, char delim, struct cfs_lstr *res)
205 if (next->ls_str == NULL)
208 /* skip leading white spaces */
209 while (next->ls_len) {
210 if (!isspace(*next->ls_str))
216 if (next->ls_len == 0) /* whitespaces only */
219 if (*next->ls_str == delim) {
220 /* first non-writespace is the delimiter */
224 res->ls_str = next->ls_str;
225 end = memchr(next->ls_str, delim, next->ls_len);
227 /* there is no the delimeter in the string */
228 end = next->ls_str + next->ls_len;
231 next->ls_str = end + 1;
232 next->ls_len -= (end - res->ls_str + 1);
235 /* skip ending whitespaces */
236 while (--end != res->ls_str) {
241 res->ls_len = end - res->ls_str + 1;
244 EXPORT_SYMBOL(cfs_gettok);
247 * Converts string to integer.
249 * Accepts decimal and hexadecimal number recordings.
251 * \retval 1 if first \a nob chars of \a str convert to decimal or
252 * hexadecimal integer in the range [\a min, \a max]
253 * \retval 0 otherwise
256 cfs_str2num_check(char *str, int nob, unsigned *num,
257 unsigned min, unsigned max)
261 *num = simple_strtoul(str, &endp, 0);
265 for (; endp < str + nob; endp++) {
270 return (*num >= min && *num <= max);
272 EXPORT_SYMBOL(cfs_str2num_check);
275 * Parses \<range_expr\> token of the syntax. If \a bracketed is false,
276 * \a src should only have a single token which can be \<number\> or \*
278 * \retval pointer to allocated range_expr and initialized
279 * range_expr::re_lo, range_expr::re_hi and range_expr:re_stride if \a
282 * \<number\> '-' \<number\> |
283 * \<number\> '-' \<number\> '/' \<number\>
284 * \retval 0 will be returned if it can be parsed, otherwise -EINVAL or
285 * -ENOMEM will be returned.
288 cfs_range_expr_parse(struct cfs_lstr *src, unsigned min, unsigned max,
289 int bracketed, struct cfs_range_expr **expr)
291 struct cfs_range_expr *re;
294 LIBCFS_ALLOC(re, sizeof(*re));
298 if (src->ls_len == 1 && src->ls_str[0] == '*') {
305 if (cfs_str2num_check(src->ls_str, src->ls_len,
306 &re->re_lo, min, max)) {
307 /* <number> is parsed */
308 re->re_hi = re->re_lo;
313 if (!bracketed || !cfs_gettok(src, '-', &tok))
316 if (!cfs_str2num_check(tok.ls_str, tok.ls_len,
317 &re->re_lo, min, max))
321 if (cfs_str2num_check(src->ls_str, src->ls_len,
322 &re->re_hi, min, max)) {
323 /* <number> - <number> is parsed */
328 /* go to check <number> '-' <number> '/' <number> */
329 if (cfs_gettok(src, '/', &tok)) {
330 if (!cfs_str2num_check(tok.ls_str, tok.ls_len,
331 &re->re_hi, min, max))
334 /* <number> - <number> / ... */
335 if (cfs_str2num_check(src->ls_str, src->ls_len,
336 &re->re_stride, min, max)) {
337 /* <number> - <number> / <number> is parsed */
347 LIBCFS_FREE(re, sizeof(*re));
352 * Print the range expression \a re into specified \a buffer.
353 * If \a bracketed is true, expression does not need additional
356 * \retval number of characters written
359 cfs_range_expr_print(char *buffer, int count, struct cfs_range_expr *expr,
369 if (expr->re_lo == expr->re_hi)
370 i = scnprintf(buffer, count, "%u", expr->re_lo);
371 else if (expr->re_stride == 1)
372 i = scnprintf(buffer, count, "%s%u-%u%s",
373 s, expr->re_lo, expr->re_hi, e);
375 i = scnprintf(buffer, count, "%s%u-%u/%u%s",
376 s, expr->re_lo, expr->re_hi,
382 * Print a list of range expressions (\a expr_list) into specified \a buffer.
383 * If the list contains several expressions, separate them with comma
384 * and surround the list with brackets.
386 * \retval number of characters written
389 cfs_expr_list_print(char *buffer, int count, struct cfs_expr_list *expr_list)
391 struct cfs_range_expr *expr;
398 list_for_each_entry(expr, &expr_list->el_exprs, re_link)
402 i += scnprintf(buffer + i, count - i, "[");
404 list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
406 i += scnprintf(buffer + i, count - i, ",");
407 i += cfs_range_expr_print(buffer + i, count - i, expr,
412 i += scnprintf(buffer + i, count - i, "]");
416 EXPORT_SYMBOL(cfs_expr_list_print);
419 * Matches value (\a value) against ranges expression list \a expr_list.
421 * \retval 1 if \a value matches
422 * \retval 0 otherwise
425 cfs_expr_list_match(__u32 value, struct cfs_expr_list *expr_list)
427 struct cfs_range_expr *expr;
429 list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
430 if (value >= expr->re_lo && value <= expr->re_hi &&
431 ((value - expr->re_lo) % expr->re_stride) == 0)
437 EXPORT_SYMBOL(cfs_expr_list_match);
440 * Convert express list (\a expr_list) to an array of all matched values
442 * \retval N N is total number of all matched values
443 * \retval 0 if expression list is empty
444 * \retval < 0 for failure
447 cfs_expr_list_values(struct cfs_expr_list *expr_list, int max, __u32 **valpp)
449 struct cfs_range_expr *expr;
454 list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
455 for (i = expr->re_lo; i <= expr->re_hi; i++) {
456 if (((i - expr->re_lo) % expr->re_stride) == 0)
461 if (count == 0) /* empty expression list */
465 CERROR("Number of values %d exceeds max allowed %d\n",
470 LIBCFS_ALLOC(val, sizeof(val[0]) * count);
475 list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
476 for (i = expr->re_lo; i <= expr->re_hi; i++) {
477 if (((i - expr->re_lo) % expr->re_stride) == 0)
485 EXPORT_SYMBOL(cfs_expr_list_values);
488 * Frees cfs_range_expr structures of \a expr_list.
493 cfs_expr_list_free(struct cfs_expr_list *expr_list)
495 while (!list_empty(&expr_list->el_exprs)) {
496 struct cfs_range_expr *expr;
498 expr = list_entry(expr_list->el_exprs.next,
499 struct cfs_range_expr, re_link);
500 list_del(&expr->re_link);
501 LIBCFS_FREE(expr, sizeof(*expr));
504 LIBCFS_FREE(expr_list, sizeof(*expr_list));
506 EXPORT_SYMBOL(cfs_expr_list_free);
509 * Parses \<cfs_expr_list\> token of the syntax.
511 * \retval 0 if \a str parses to \<number\> | \<expr_list\>
512 * \retval -errno otherwise
515 cfs_expr_list_parse(char *str, int len, unsigned min, unsigned max,
516 struct cfs_expr_list **elpp)
518 struct cfs_expr_list *expr_list;
519 struct cfs_range_expr *expr;
523 LIBCFS_ALLOC(expr_list, sizeof(*expr_list));
524 if (expr_list == NULL)
530 INIT_LIST_HEAD(&expr_list->el_exprs);
532 if (src.ls_str[0] == '[' &&
533 src.ls_str[src.ls_len - 1] == ']') {
538 while (src.ls_str != NULL) {
541 if (!cfs_gettok(&src, ',', &tok)) {
546 rc = cfs_range_expr_parse(&tok, min, max, 1, &expr);
550 list_add_tail(&expr->re_link,
551 &expr_list->el_exprs);
554 rc = cfs_range_expr_parse(&src, min, max, 0, &expr);
556 list_add_tail(&expr->re_link,
557 &expr_list->el_exprs);
562 cfs_expr_list_free(expr_list);
568 EXPORT_SYMBOL(cfs_expr_list_parse);
571 * Frees cfs_expr_list structures of \a list.
573 * For each struct cfs_expr_list structure found on \a list it frees
574 * range_expr list attached to it and frees the cfs_expr_list itself.
579 cfs_expr_list_free_list(struct list_head *list)
581 struct cfs_expr_list *el;
583 while (!list_empty(list)) {
584 el = list_entry(list->next,
585 struct cfs_expr_list, el_link);
586 list_del(&el->el_link);
587 cfs_expr_list_free(el);
590 EXPORT_SYMBOL(cfs_expr_list_free_list);