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.gnu.org/licenses/gpl-2.0.html
19 *
20 * GPL HEADER END
21 */
22 /*
23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
25 *
26 * Copyright (c) 2012, Intel Corporation.
27 */
28 /*
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
31 *
32 * libcfs/include/libcfs/libcfs_string.h
33 *
34 * Generic string manipulation functions.
35 *
36 * Author: Nathan Rutman <nathan.rutman@sun.com>
37 */
38
39 #ifndef __LIBCFS_STRING_H__
40 #define __LIBCFS_STRING_H__
41
42 /* libcfs_string.c */
43 /* Convert a text string to a bitmask */
44 int cfs_str2mask(const char *str, const char *(*bit2str)(int bit),
45 int *oldmask, int minmask, int allmask);
46 /* trim leading and trailing space characters */
47 char *cfs_firststr(char *str, size_t size);
48
49 /**
50 * Structure to represent NULL-less strings.
51 */
52 struct cfs_lstr {
53 char *ls_str;
54 int ls_len;
55 };
56
57 /*
58 * Structure to represent \<range_expr\> token of the syntax.
59 */
60 struct cfs_range_expr {
61 /*
62 * Link to cfs_expr_list::el_exprs.
63 */
64 struct list_head re_link;
65 __u32 re_lo;
66 __u32 re_hi;
67 __u32 re_stride;
68 };
69
70 struct cfs_expr_list {
71 struct list_head el_link;
72 struct list_head el_exprs;
73 };
74
75 char *cfs_trimwhite(char *str);
76 int cfs_gettok(struct cfs_lstr *next, char delim, struct cfs_lstr *res);
77 int cfs_str2num_check(char *str, int nob, unsigned *num,
78 unsigned min, unsigned max);
79 int cfs_expr_list_match(__u32 value, struct cfs_expr_list *expr_list);
80 int cfs_expr_list_print(char *buffer, int count,
81 struct cfs_expr_list *expr_list);
82 int cfs_expr_list_values(struct cfs_expr_list *expr_list,
83 int max, __u32 **values);
84 static inline void
cfs_expr_list_values_free(__u32 * values,int num)85 cfs_expr_list_values_free(__u32 *values, int num)
86 {
87 /* This array is allocated by LIBCFS_ALLOC(), so it shouldn't be freed
88 * by OBD_FREE() if it's called by module other than libcfs & LNet,
89 * otherwise we will see fake memory leak */
90 LIBCFS_FREE(values, num * sizeof(values[0]));
91 }
92
93 void cfs_expr_list_free(struct cfs_expr_list *expr_list);
94 int cfs_expr_list_parse(char *str, int len, unsigned min, unsigned max,
95 struct cfs_expr_list **elpp);
96 void cfs_expr_list_free_list(struct list_head *list);
97
98 #endif
99