libcfs/include/libcfs/libcfs_string.h

   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  * libcfs/include/libcfs/libcfs_string.h
  37  *
  38  * Generic string manipulation functions.
  39  *
  40  * Author: Nathan Rutman <nathan.rutman@sun.com>
  41  */
  42
  43 #ifndef __LIBCFS_STRING_H__
  44 #define __LIBCFS_STRING_H__
  45
  46 /* libcfs_string.c */
  47 char *cfs_strrstr(const char *haystack, const char *needle);
  48 /* string comparison ignoring case */
  49 int cfs_strncasecmp(const char *s1, const char *s2, size_t n);
  50 /* Convert a text string to a bitmask */
  51 int cfs_str2mask(const char *str, const char *(*bit2str)(int bit),
  52                  int *oldmask, int minmask, int allmask);
  53
  54 /* Allocate space for and copy an existing string.
  55  * Must free with kfree().
  56  */
  57 char *cfs_strdup(const char *str, u_int32_t flags);
  58
  59 /* safe vsnprintf */
  60 int cfs_vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
  61
  62 /* safe snprintf */
  63 int cfs_snprintf(char *buf, size_t size, const char *fmt, ...);
  64
  65 /* trim leading and trailing space characters */
  66 char *cfs_firststr(char *str, size_t size);
  67
  68 /**
  69  * Structure to represent NULL-less strings.
  70  */
  71 struct cfs_lstr {
  72         char            *ls_str;
  73         int             ls_len;
  74 };
  75
  76 /*
  77  * Structure to represent \<range_expr\> token of the syntax.
  78  */
  79 struct cfs_range_expr {
  80         /*
  81          * Link to cfs_expr_list::el_exprs.
  82          */
  83         struct list_head        re_link;
  84         __u32                   re_lo;
  85         __u32                   re_hi;
  86         __u32                   re_stride;
  87 };
  88
  89 struct cfs_expr_list {
  90         struct list_head        el_link;
  91         struct list_head        el_exprs;
  92 };
  93
  94 static inline int
  95 cfs_iswhite(char c)
  96 {
  97         switch (c) {
  98         case ' ':
  99         case '\t':
 100         case '\n':
 101         case '\r':
 102                 return 1;
 103         default:
 104                 break;
 105         }
 106         return 0;
 107 }
 108
 109 char *cfs_trimwhite(char *str);
 110 int cfs_gettok(struct cfs_lstr *next, char delim, struct cfs_lstr *res);
 111 int cfs_str2num_check(char *str, int nob, unsigned *num,
 112                       unsigned min, unsigned max);
 113 int cfs_range_expr_parse(struct cfs_lstr *src, unsigned min, unsigned max,
 114                          int single_tok, struct cfs_range_expr **expr);
 115 int cfs_expr_list_match(__u32 value, struct cfs_expr_list *expr_list);
 116 int cfs_expr_list_values(struct cfs_expr_list *expr_list,
 117                          int max, __u32 **values);
 118 static inline void
 119 cfs_expr_list_values_free(__u32 *values, int num)
 120 {
 121         /* This array is allocated by LIBCFS_ALLOC(), so it shouldn't be freed
 122          * by OBD_FREE() if it's called by module other than libcfs & LNet,
 123          * otherwise we will see fake memory leak */
 124         LIBCFS_FREE(values, num * sizeof(values[0]));
 125 }
 126
 127 void cfs_expr_list_free(struct cfs_expr_list *expr_list);
 128 void cfs_expr_list_print(struct cfs_expr_list *expr_list);
 129 int cfs_expr_list_parse(char *str, int len, unsigned min, unsigned max,
 130                         struct cfs_expr_list **elpp);
 131 void cfs_expr_list_free_list(struct list_head *list);
 132 int cfs_ip_addr_parse(char *str, int len, struct list_head *list);
 133 int cfs_ip_addr_match(__u32 addr, struct list_head *list);
 134 void cfs_ip_addr_free(struct list_head *list);
 135
 136 #ifdef __KERNEL__
 137 #define strtoul(str, endp, base)        simple_strtoul(str, endp, base)
 138 #endif
 139
 140 #endif