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 /* Convert a text string to a bitmask */
  49 int cfs_str2mask(const char *str, const char *(*bit2str)(int bit),
  50                  int *oldmask, int minmask, int allmask);
  51
  52 /* Allocate space for and copy an existing string.
  53  * Must free with kfree().
  54  */
  55 char *cfs_strdup(const char *str, u_int32_t flags);
  56
  57 /* safe vsnprintf */
  58 int cfs_vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
  59
  60 /* safe snprintf */
  61 int cfs_snprintf(char *buf, size_t size, const char *fmt, ...);
  62
  63 /* trim leading and trailing space characters */
  64 char *cfs_firststr(char *str, size_t size);
  65
  66 /**
  67  * Structure to represent NULL-less strings.
  68  */
  69 struct cfs_lstr {
  70         char            *ls_str;
  71         int             ls_len;
  72 };
  73
  74 /*
  75  * Structure to represent \<range_expr\> token of the syntax.
  76  */
  77 struct cfs_range_expr {
  78         /*
  79          * Link to cfs_expr_list::el_exprs.
  80          */
  81         struct list_head        re_link;
  82         __u32                   re_lo;
  83         __u32                   re_hi;
  84         __u32                   re_stride;
  85 };
  86
  87 struct cfs_expr_list {
  88         struct list_head        el_link;
  89         struct list_head        el_exprs;
  90 };
  91
  92 static inline int
  93 cfs_iswhite(char c)
  94 {
  95         switch (c) {
  96         case ' ':
  97         case '\t':
  98         case '\n':
  99         case '\r':
 100                 return 1;
 101         default:
 102                 break;
 103         }
 104         return 0;
 105 }
 106
 107 char *cfs_trimwhite(char *str);
 108 int cfs_gettok(struct cfs_lstr *next, char delim, struct cfs_lstr *res);
 109 int cfs_str2num_check(char *str, int nob, unsigned *num,
 110                       unsigned min, unsigned max);
 111 int cfs_range_expr_parse(struct cfs_lstr *src, unsigned min, unsigned max,
 112                          int single_tok, struct cfs_range_expr **expr);
 113 int cfs_expr_list_match(__u32 value, struct cfs_expr_list *expr_list);
 114 int cfs_expr_list_print(char *buffer, int count,
 115                         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 int cfs_expr_list_parse(char *str, int len, unsigned min, unsigned max,
 129                         struct cfs_expr_list **elpp);
 130 void cfs_expr_list_free_list(struct list_head *list);
 131 int cfs_ip_addr_parse(char *str, int len, struct list_head *list);
 132 int cfs_ip_addr_match(__u32 addr, struct list_head *list);
 133 void cfs_ip_addr_free(struct list_head *list);
 134
 135 #ifdef __KERNEL__
 136 #define strtoul(str, endp, base)        simple_strtoul(str, endp, base)
 137 #endif
 138
 139 #endif