libcfs/libcfs/libcfs_string.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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
  19  *
  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
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * String manipulation functions.
  37  *
  38  * libcfs/libcfs/libcfs_string.c
  39  *
  40  * Author: Nathan Rutman <nathan.rutman@sun.com>
  41  */
  42
  43 #include <libcfs/libcfs.h>
  44
  45 char *cfs_strrstr(const char *haystack, const char *needle)
  46 {
  47         char *ptr;
  48
  49         if (unlikely(haystack == NULL || needle == NULL))
  50                 return NULL;
  51
  52         if (strlen(needle) == 1)
  53                 return strrchr(haystack, needle[0]);
  54
  55         ptr = strstr(haystack, needle);
  56         if (ptr != NULL) {
  57                 while (1) {
  58                         char *tmp;
  59
  60                         tmp = strstr(&ptr[1], needle);
  61                         if (tmp == NULL)
  62                                 return ptr;
  63
  64                         ptr = tmp;
  65                 }
  66         }
  67
  68         return NULL;
  69 }
  70 EXPORT_SYMBOL(cfs_strrstr);
  71
  72 /* non-0 = don't match */
  73 int cfs_strncasecmp(const char *s1, const char *s2, size_t n)
  74 {
  75         if (s1 == NULL || s2 == NULL)
  76                 return 1;
  77
  78         if (n == 0)
  79                 return 0;
  80
  81         while (n-- != 0 && tolower(*s1) == tolower(*s2)) {
  82                 if (n == 0 || *s1 == '\0' || *s2 == '\0')
  83                         break;
  84                 s1++;
  85                 s2++;
  86         }
  87
  88         return tolower(*(unsigned char *)s1) - tolower(*(unsigned char *)s2);
  89 }
  90 EXPORT_SYMBOL(cfs_strncasecmp);
  91
  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)
  95 {
  96         const char *debugstr;
  97         char op = 0;
  98         int newmask = minmask, i, len, found = 0;
  99         ENTRY;
 100
 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. */
 106         while (*str != 0) {
 107                 while (isspace(*str))
 108                         str++;
 109                 if (*str == 0)
 110                         break;
 111                 if (*str == '+' || *str == '-') {
 112                         op = *str++;
 113                         if (!found)
 114                                 /* only if first token is relative */
 115                                 newmask = *oldmask;
 116                         while (isspace(*str))
 117                                 str++;
 118                         if (*str == 0)          /* trailing op */
 119                                 return -EINVAL;
 120                 }
 121
 122                 /* find token length */
 123                 for (len = 0; str[len] != 0 && !isspace(str[len]) &&
 124                       str[len] != '+' && str[len] != '-'; len++);
 125
 126                 /* match token */
 127                 found = 0;
 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) {
 133                                 if (op == '-')
 134                                         newmask &= ~(1 << i);
 135                                 else
 136                                         newmask |= (1 << i);
 137                                 found = 1;
 138                                 break;
 139                         }
 140                 }
 141                 if (!found && len == 3 &&
 142                     (cfs_strncasecmp(str, "ALL", len) == 0)) {
 143                         if (op == '-')
 144                                 newmask = minmask;
 145                         else
 146                                 newmask = allmask;
 147                         found = 1;
 148                 }
 149                 if (!found) {
 150                         CWARN("unknown mask '%.*s'.\n"
 151                               "mask usage: [+|-]<all|type> ...\n", len, str);
 152                         return -EINVAL;
 153                 }
 154                 str += len;
 155         }
 156
 157         *oldmask = newmask;
 158         return 0;
 159 }
 160 EXPORT_SYMBOL(cfs_str2mask);
 161
 162 /* Duplicate a string in a platform-independent way */
 163 char *cfs_strdup(const char *str, u_int32_t flags)
 164 {
 165         size_t lenz; /* length of str + zero byte */
 166         char *dup_str;
 167
 168         lenz = strlen(str) + 1;
 169
 170         dup_str = kmalloc(lenz, flags);
 171         if (dup_str == NULL)
 172                 return NULL;
 173
 174         memcpy(dup_str, str, lenz);
 175
 176         return dup_str;
 177 }
 178 EXPORT_SYMBOL(cfs_strdup);
 179
 180 /**
 181  * cfs_{v}snprintf() return the actual size that is printed rather than
 182  * the size that would be printed in standard functions.
 183  */
 184 /* safe vsnprintf */
 185 int cfs_vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
 186 {
 187         int i;
 188
 189         LASSERT(size > 0);
 190         i = vsnprintf(buf, size, fmt, args);
 191
 192         return  (i >= size ? size - 1 : i);
 193 }
 194 EXPORT_SYMBOL(cfs_vsnprintf);
 195
 196 /* safe snprintf */
 197 int cfs_snprintf(char *buf, size_t size, const char *fmt, ...)
 198 {
 199         va_list args;
 200         int i;
 201
 202         va_start(args, fmt);
 203         i = cfs_vsnprintf(buf, size, fmt, args);
 204         va_end(args);
 205
 206         return  i;
 207 }
 208 EXPORT_SYMBOL(cfs_snprintf);
 209
 210 /* get the first string out of @str */
 211 char *cfs_firststr(char *str, size_t size)
 212 {
 213         size_t i = 0;
 214         char  *end;
 215
 216         /* trim leading spaces */
 217         while (i < size && *str && isspace(*str)) {
 218                 ++i;
 219                 ++str;
 220         }
 221
 222         /* string with all spaces */
 223         if (*str == '\0')
 224                 goto out;
 225
 226         end = str;
 227         while (i < size && *end != '\0' && !isspace(*end)) {
 228                 ++i;
 229                 ++end;
 230         }
 231
 232         *end= '\0';
 233 out:
 234         return str;
 235 }
 236 EXPORT_SYMBOL(cfs_firststr);
 237
 238 char *
 239 cfs_trimwhite(char *str)
 240 {
 241         char *end;
 242
 243         while (cfs_iswhite(*str))
 244                 str++;
 245
 246         end = str + strlen(str);
 247         while (end > str) {
 248                 if (!cfs_iswhite(end[-1]))
 249                         break;
 250                 end--;
 251         }
 252
 253         *end = 0;
 254         return str;
 255 }
 256 EXPORT_SYMBOL(cfs_trimwhite);
 257
 258 /**
 259  * Extracts tokens from strings.
 260  *
 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
 263  * delimiter.
 264  *
 265  * \retval 1 if \a res points to a string of non-whitespace characters
 266  * \retval 0 otherwise
 267  */
 268 int
 269 cfs_gettok(struct cfs_lstr *next, char delim, struct cfs_lstr *res)
 270 {
 271         char *end;
 272
 273         if (next->ls_str == NULL)
 274                 return 0;
 275
 276         /* skip leading white spaces */
 277         while (next->ls_len) {
 278                 if (!cfs_iswhite(*next->ls_str))
 279                         break;
 280                 next->ls_str++;
 281                 next->ls_len--;
 282         }
 283
 284         if (next->ls_len == 0) /* whitespaces only */
 285                 return 0;
 286
 287         if (*next->ls_str == delim) {
 288                 /* first non-writespace is the delimiter */
 289                 return 0;
 290         }
 291
 292         res->ls_str = next->ls_str;
 293         end = memchr(next->ls_str, delim, next->ls_len);
 294         if (end == NULL) {
 295                 /* there is no the delimeter in the string */
 296                 end = next->ls_str + next->ls_len;
 297                 next->ls_str = NULL;
 298         } else {
 299                 next->ls_str = end + 1;
 300                 next->ls_len -= (end - res->ls_str + 1);
 301         }
 302
 303         /* skip ending whitespaces */
 304         while (--end != res->ls_str) {
 305                 if (!cfs_iswhite(*end))
 306                         break;
 307         }
 308
 309         res->ls_len = end - res->ls_str + 1;
 310         return 1;
 311 }
 312 EXPORT_SYMBOL(cfs_gettok);
 313
 314 /**
 315  * Converts string to integer.
 316  *
 317  * Accepts decimal and hexadecimal number recordings.
 318  *
 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
 322  */
 323 int
 324 cfs_str2num_check(char *str, int nob, unsigned *num,
 325                   unsigned min, unsigned max)
 326 {
 327         char    *endp;
 328
 329         *num = strtoul(str, &endp, 0);
 330         if (endp == str)
 331                 return 0;
 332
 333         for (; endp < str + nob; endp++) {
 334                 if (!cfs_iswhite(*endp))
 335                         return 0;
 336         }
 337
 338         return (*num >= min && *num <= max);
 339 }
 340 EXPORT_SYMBOL(cfs_str2num_check);
 341
 342 /**
 343  * Parses \<range_expr\> token of the syntax. If \a bracketed is false,
 344  * \a src should only have a single token which can be \<number\> or  \*
 345  *
 346  * \retval pointer to allocated range_expr and initialized
 347  * range_expr::re_lo, range_expr::re_hi and range_expr:re_stride if \a
 348  `* src parses to
 349  * \<number\> |
 350  * \<number\> '-' \<number\> |
 351  * \<number\> '-' \<number\> '/' \<number\>
 352  * \retval 0 will be returned if it can be parsed, otherwise -EINVAL or
 353  * -ENOMEM will be returned.
 354  */
 355 int
 356 cfs_range_expr_parse(struct cfs_lstr *src, unsigned min, unsigned max,
 357                      int bracketed, struct cfs_range_expr **expr)
 358 {
 359         struct cfs_range_expr   *re;
 360         struct cfs_lstr         tok;
 361
 362         LIBCFS_ALLOC(re, sizeof(*re));
 363         if (re == NULL)
 364                 return -ENOMEM;
 365
 366         if (src->ls_len == 1 && src->ls_str[0] == '*') {
 367                 re->re_lo = min;
 368                 re->re_hi = max;
 369                 re->re_stride = 1;
 370                 goto out;
 371         }
 372
 373         if (cfs_str2num_check(src->ls_str, src->ls_len,
 374                               &re->re_lo, min, max)) {
 375                 /* <number> is parsed */
 376                 re->re_hi = re->re_lo;
 377                 re->re_stride = 1;
 378                 goto out;
 379         }
 380
 381         if (!bracketed || !cfs_gettok(src, '-', &tok))
 382                 goto failed;
 383
 384         if (!cfs_str2num_check(tok.ls_str, tok.ls_len,
 385                                &re->re_lo, min, max))
 386                 goto failed;
 387
 388         /* <number> - */
 389         if (cfs_str2num_check(src->ls_str, src->ls_len,
 390                               &re->re_hi, min, max)) {
 391                 /* <number> - <number> is parsed */
 392                 re->re_stride = 1;
 393                 goto out;
 394         }
 395
 396         /* go to check <number> '-' <number> '/' <number> */
 397         if (cfs_gettok(src, '/', &tok)) {
 398                 if (!cfs_str2num_check(tok.ls_str, tok.ls_len,
 399                                        &re->re_hi, min, max))
 400                         goto failed;
 401
 402                 /* <number> - <number> / ... */
 403                 if (cfs_str2num_check(src->ls_str, src->ls_len,
 404                                       &re->re_stride, min, max)) {
 405                         /* <number> - <number> / <number> is parsed */
 406                         goto out;
 407                 }
 408         }
 409
 410  out:
 411         *expr = re;
 412         return 0;
 413
 414  failed:
 415         LIBCFS_FREE(re, sizeof(*re));
 416         return -EINVAL;
 417 }
 418 EXPORT_SYMBOL(cfs_range_expr_parse);
 419
 420 /**
 421  * Print the range expression \a re into specified \a buffer.
 422  * If \a bracketed is true, expression does not need additional
 423  * brackets.
 424  *
 425  * \retval number of characters written
 426  */
 427 static int
 428 cfs_range_expr_print(char *buffer, int count, struct cfs_range_expr *expr,
 429                      bool bracketed)
 430 {
 431         int i;
 432         char s[] = "[";
 433         char e[] = "]";
 434
 435         if (bracketed)
 436                 s[0] = e[0] = '\0';
 437
 438         if (expr->re_lo == expr->re_hi)
 439                 i = cfs_snprintf(buffer, count, "%u", expr->re_lo);
 440         else if (expr->re_stride == 1)
 441                 i = cfs_snprintf(buffer, count, "%s%u-%u%s",
 442                                   s, expr->re_lo, expr->re_hi, e);
 443         else
 444                 i = cfs_snprintf(buffer, count, "%s%u-%u/%u%s",
 445                                   s, expr->re_lo, expr->re_hi,
 446                                   expr->re_stride, e);
 447         return i;
 448 }
 449
 450 /**
 451  * Print a list of range expressions (\a expr_list) into specified \a buffer.
 452  * If the list contains several expressions, separate them with comma
 453  * and surround the list with brackets.
 454  *
 455  * \retval number of characters written
 456  */
 457 int
 458 cfs_expr_list_print(char *buffer, int count, struct cfs_expr_list *expr_list)
 459 {
 460         struct cfs_range_expr *expr;
 461         int i = 0, j = 0;
 462         int numexprs = 0;
 463
 464         if (count <= 0)
 465                 return 0;
 466
 467         list_for_each_entry(expr, &expr_list->el_exprs, re_link)
 468                 numexprs++;
 469
 470         if (numexprs > 1)
 471                 i += cfs_snprintf(buffer + i, count - i, "[");
 472
 473         list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
 474                 if (j++ != 0)
 475                         i += cfs_snprintf(buffer + i, count - i, ",");
 476                 i += cfs_range_expr_print(buffer + i, count - i, expr,
 477                                           numexprs > 1);
 478         }
 479
 480         if (numexprs > 1)
 481                 i += cfs_snprintf(buffer + i, count - i, "]");
 482
 483         return i;
 484 }
 485 EXPORT_SYMBOL(cfs_expr_list_print);
 486
 487 /**
 488  * Matches value (\a value) against ranges expression list \a expr_list.
 489  *
 490  * \retval 1 if \a value matches
 491  * \retval 0 otherwise
 492  */
 493 int
 494 cfs_expr_list_match(__u32 value, struct cfs_expr_list *expr_list)
 495 {
 496         struct cfs_range_expr   *expr;
 497
 498         list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
 499                 if (value >= expr->re_lo && value <= expr->re_hi &&
 500                     ((value - expr->re_lo) % expr->re_stride) == 0)
 501                         return 1;
 502         }
 503
 504         return 0;
 505 }
 506 EXPORT_SYMBOL(cfs_expr_list_match);
 507
 508 /**
 509  * Convert express list (\a expr_list) to an array of all matched values
 510  *
 511  * \retval N N is total number of all matched values
 512  * \retval 0 if expression list is empty
 513  * \retval < 0 for failure
 514  */
 515 int
 516 cfs_expr_list_values(struct cfs_expr_list *expr_list, int max, __u32 **valpp)
 517 {
 518         struct cfs_range_expr   *expr;
 519         __u32                   *val;
 520         int                     count = 0;
 521         int                     i;
 522
 523         list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
 524                 for (i = expr->re_lo; i <= expr->re_hi; i++) {
 525                         if (((i - expr->re_lo) % expr->re_stride) == 0)
 526                                 count++;
 527                 }
 528         }
 529
 530         if (count == 0) /* empty expression list */
 531                 return 0;
 532
 533         if (count > max) {
 534                 CERROR("Number of values %d exceeds max allowed %d\n",
 535                        max, count);
 536                 return -EINVAL;
 537         }
 538
 539         LIBCFS_ALLOC(val, sizeof(val[0]) * count);
 540         if (val == NULL)
 541                 return -ENOMEM;
 542
 543         count = 0;
 544         list_for_each_entry(expr, &expr_list->el_exprs, re_link) {
 545                 for (i = expr->re_lo; i <= expr->re_hi; i++) {
 546                         if (((i - expr->re_lo) % expr->re_stride) == 0)
 547                                 val[count++] = i;
 548                 }
 549         }
 550
 551         *valpp = val;
 552         return count;
 553 }
 554 EXPORT_SYMBOL(cfs_expr_list_values);
 555
 556 /**
 557  * Frees cfs_range_expr structures of \a expr_list.
 558  *
 559  * \retval none
 560  */
 561 void
 562 cfs_expr_list_free(struct cfs_expr_list *expr_list)
 563 {
 564         while (!list_empty(&expr_list->el_exprs)) {
 565                 struct cfs_range_expr *expr;
 566
 567                 expr = list_entry(expr_list->el_exprs.next,
 568                                       struct cfs_range_expr, re_link),
 569                 list_del(&expr->re_link);
 570                 LIBCFS_FREE(expr, sizeof(*expr));
 571         }
 572
 573         LIBCFS_FREE(expr_list, sizeof(*expr_list));
 574 }
 575 EXPORT_SYMBOL(cfs_expr_list_free);
 576
 577 /**
 578  * Parses \<cfs_expr_list\> token of the syntax.
 579  *
 580  * \retval 0 if \a str parses to \<number\> | \<expr_list\>
 581  * \retval -errno otherwise
 582  */
 583 int
 584 cfs_expr_list_parse(char *str, int len, unsigned min, unsigned max,
 585                     struct cfs_expr_list **elpp)
 586 {
 587         struct cfs_expr_list    *expr_list;
 588         struct cfs_range_expr   *expr;
 589         struct cfs_lstr         src;
 590         int                     rc;
 591
 592         LIBCFS_ALLOC(expr_list, sizeof(*expr_list));
 593         if (expr_list == NULL)
 594                 return -ENOMEM;
 595
 596         src.ls_str = str;
 597         src.ls_len = len;
 598
 599         INIT_LIST_HEAD(&expr_list->el_exprs);
 600
 601         if (src.ls_str[0] == '[' &&
 602             src.ls_str[src.ls_len - 1] == ']') {
 603                 src.ls_str++;
 604                 src.ls_len -= 2;
 605
 606                 rc = -EINVAL;
 607                 while (src.ls_str != NULL) {
 608                         struct cfs_lstr tok;
 609
 610                         if (!cfs_gettok(&src, ',', &tok)) {
 611                                 rc = -EINVAL;
 612                                 break;
 613                         }
 614
 615                         rc = cfs_range_expr_parse(&tok, min, max, 1, &expr);
 616                         if (rc != 0)
 617                                 break;
 618
 619                         list_add_tail(&expr->re_link,
 620                                           &expr_list->el_exprs);
 621                 }
 622         } else {
 623                 rc = cfs_range_expr_parse(&src, min, max, 0, &expr);
 624                 if (rc == 0) {
 625                         list_add_tail(&expr->re_link,
 626                                           &expr_list->el_exprs);
 627                 }
 628         }
 629
 630         if (rc != 0)
 631                 cfs_expr_list_free(expr_list);
 632         else
 633                 *elpp = expr_list;
 634
 635         return rc;
 636 }
 637 EXPORT_SYMBOL(cfs_expr_list_parse);
 638
 639 /**
 640  * Frees cfs_expr_list structures of \a list.
 641  *
 642  * For each struct cfs_expr_list structure found on \a list it frees
 643  * range_expr list attached to it and frees the cfs_expr_list itself.
 644  *
 645  * \retval none
 646  */
 647 void
 648 cfs_expr_list_free_list(struct list_head *list)
 649 {
 650         struct cfs_expr_list *el;
 651
 652         while (!list_empty(list)) {
 653                 el = list_entry(list->next,
 654                                     struct cfs_expr_list, el_link);
 655                 list_del(&el->el_link);
 656                 cfs_expr_list_free(el);
 657         }
 658 }
 659 EXPORT_SYMBOL(cfs_expr_list_free_list);
 660
 661 int
 662 cfs_ip_addr_parse(char *str, int len, struct list_head *list)
 663 {
 664         struct cfs_expr_list    *el;
 665         struct cfs_lstr         src;
 666         int                     rc;
 667         int                     i;
 668
 669         src.ls_str = str;
 670         src.ls_len = len;
 671         i = 0;
 672
 673         while (src.ls_str != NULL) {
 674                 struct cfs_lstr res;
 675
 676                 if (!cfs_gettok(&src, '.', &res)) {
 677                         rc = -EINVAL;
 678                         goto out;
 679                 }
 680
 681                 rc = cfs_expr_list_parse(res.ls_str, res.ls_len, 0, 255, &el);
 682                 if (rc != 0)
 683                         goto out;
 684
 685                 list_add_tail(&el->el_link, list);
 686                 i++;
 687         }
 688
 689         if (i == 4)
 690                 return 0;
 691
 692         rc = -EINVAL;
 693  out:
 694         cfs_expr_list_free_list(list);
 695
 696         return rc;
 697 }
 698 EXPORT_SYMBOL(cfs_ip_addr_parse);
 699
 700 /**
 701  * Matches address (\a addr) against address set encoded in \a list.
 702  *
 703  * \retval 1 if \a addr matches
 704  * \retval 0 otherwise
 705  */
 706 int
 707 cfs_ip_addr_match(__u32 addr, struct list_head *list)
 708 {
 709         struct cfs_expr_list *el;
 710         int i = 0;
 711
 712         list_for_each_entry_reverse(el, list, el_link) {
 713                 if (!cfs_expr_list_match(addr & 0xff, el))
 714                         return 0;
 715                 addr >>= 8;
 716                 i++;
 717         }
 718
 719         return i == 4;
 720 }
 721 EXPORT_SYMBOL(cfs_ip_addr_match);
 722
 723 void
 724 cfs_ip_addr_free(struct list_head *list)
 725 {
 726         cfs_expr_list_free_list(list);
 727 }
 728 EXPORT_SYMBOL(cfs_ip_addr_free);