Blame view

lib/parser.c 6.06 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
  /*
   * lib/parser.c - simple parser for mount, etc. options.
   *
   * This source code is licensed under the GNU General Public License,
   * Version 2.  See the file COPYING for more details.
   */
  
  #include <linux/ctype.h>
  #include <linux/module.h>
  #include <linux/parser.h>
  #include <linux/slab.h>
  #include <linux/string.h>
  
  /**
   * match_one: - Determines if a string matches a simple pattern
25985edce   Lucas De Marchi   Fix common misspe...
16
   * @s: the string to examine for presence of the pattern
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
17
18
19
20
21
22
23
24
   * @p: the string containing the pattern
   * @args: array of %MAX_OPT_ARGS &substring_t elements. Used to return match
   * locations.
   *
   * Description: Determines if the pattern @p is present in string @s. Can only
   * match extremely simple token=arg style patterns. If the pattern is found,
   * the location(s) of the arguments will be returned in the @args array.
   */
ef4533f8a   David Howells   [AFS]: Make the m...
25
  static int match_one(char *s, const char *p, substring_t args[])
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
  {
  	char *meta;
  	int argc = 0;
  
  	if (!p)
  		return 1;
  
  	while(1) {
  		int len = -1;
  		meta = strchr(p, '%');
  		if (!meta)
  			return strcmp(p, s) == 0;
  
  		if (strncmp(p, s, meta-p))
  			return 0;
  
  		s += meta - p;
  		p = meta + 1;
  
  		if (isdigit(*p))
ef4533f8a   David Howells   [AFS]: Make the m...
46
  			len = simple_strtoul(p, (char **) &p, 10);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
47
48
49
50
51
52
53
54
55
56
57
58
  		else if (*p == '%') {
  			if (*s++ != '%')
  				return 0;
  			p++;
  			continue;
  		}
  
  		if (argc >= MAX_OPT_ARGS)
  			return 0;
  
  		args[argc].from = s;
  		switch (*p++) {
b5f54b07c   André Goddard Rosa   parser: remove un...
59
60
61
62
  		case 's': {
  			size_t str_len = strlen(s);
  
  			if (str_len == 0)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
63
  				return 0;
b5f54b07c   André Goddard Rosa   parser: remove un...
64
65
  			if (len == -1 || len > str_len)
  				len = str_len;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
66
67
  			args[argc].to = s + len;
  			break;
b5f54b07c   André Goddard Rosa   parser: remove un...
68
  		}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
  		case 'd':
  			simple_strtol(s, &args[argc].to, 0);
  			goto num;
  		case 'u':
  			simple_strtoul(s, &args[argc].to, 0);
  			goto num;
  		case 'o':
  			simple_strtoul(s, &args[argc].to, 8);
  			goto num;
  		case 'x':
  			simple_strtoul(s, &args[argc].to, 16);
  		num:
  			if (args[argc].to == args[argc].from)
  				return 0;
  			break;
  		default:
  			return 0;
  		}
  		s = args[argc].to;
  		argc++;
  	}
  }
  
  /**
   * match_token: - Find a token (and optional args) in a string
   * @s: the string to examine for token/argument pairs
   * @table: match_table_t describing the set of allowed option tokens and the
   * arguments that may be associated with them. Must be terminated with a
   * &struct match_token whose pattern is set to the NULL pointer.
   * @args: array of %MAX_OPT_ARGS &substring_t elements. Used to return match
   * locations.
   *
   * Description: Detects which if any of a set of token strings has been passed
   * to it. Tokens can include up to MAX_OPT_ARGS instances of basic c-style
   * format identifiers which will be taken into account when matching the
   * tokens, and whose locations will be returned in the @args array.
   */
a447c0932   Steven Whitehouse   vfs: Use const fo...
106
  int match_token(char *s, const match_table_t table, substring_t args[])
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
107
  {
ef4533f8a   David Howells   [AFS]: Make the m...
108
  	const struct match_token *p;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
  
  	for (p = table; !match_one(s, p->pattern, args) ; p++)
  		;
  
  	return p->token;
  }
  
  /**
   * match_number: scan a number in the given base from a substring_t
   * @s: substring to be scanned
   * @result: resulting integer on success
   * @base: base to use when converting string
   *
   * Description: Given a &substring_t and a base, attempts to parse the substring
   * as a number in that base. On success, sets @result to the integer represented
   * by the string and returns 0. Returns either -ENOMEM or -EINVAL on failure.
   */
  static int match_number(substring_t *s, int *result, int base)
  {
  	char *endp;
  	char *buf;
  	int ret;
5d051decf   Namhyung Kim   lib/parser: clean...
131
  	size_t len = s->to - s->from;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
132

5d051decf   Namhyung Kim   lib/parser: clean...
133
  	buf = kmalloc(len + 1, GFP_KERNEL);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
134
135
  	if (!buf)
  		return -ENOMEM;
5d051decf   Namhyung Kim   lib/parser: clean...
136
137
  	memcpy(buf, s->from, len);
  	buf[len] = '\0';
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
  	*result = simple_strtol(buf, &endp, base);
  	ret = 0;
  	if (endp == buf)
  		ret = -EINVAL;
  	kfree(buf);
  	return ret;
  }
  
  /**
   * match_int: - scan a decimal representation of an integer from a substring_t
   * @s: substring_t to be scanned
   * @result: resulting integer on success
   *
   * Description: Attempts to parse the &substring_t @s as a decimal integer. On
   * success, sets @result to the integer represented by the string and returns 0.
   * Returns either -ENOMEM or -EINVAL on failure.
   */
  int match_int(substring_t *s, int *result)
  {
  	return match_number(s, result, 0);
  }
  
  /**
   * match_octal: - scan an octal representation of an integer from a substring_t
   * @s: substring_t to be scanned
   * @result: resulting integer on success
   *
   * Description: Attempts to parse the &substring_t @s as an octal integer. On
   * success, sets @result to the integer represented by the string and returns
   * 0. Returns either -ENOMEM or -EINVAL on failure.
   */
  int match_octal(substring_t *s, int *result)
  {
  	return match_number(s, result, 8);
  }
  
  /**
   * match_hex: - scan a hex representation of an integer from a substring_t
   * @s: substring_t to be scanned
   * @result: resulting integer on success
   *
   * Description: Attempts to parse the &substring_t @s as a hexadecimal integer.
   * On success, sets @result to the integer represented by the string and
   * returns 0. Returns either -ENOMEM or -EINVAL on failure.
   */
  int match_hex(substring_t *s, int *result)
  {
  	return match_number(s, result, 16);
  }
  
  /**
b32a09db4   Markus Armbruster   add match_strlcpy...
189
190
191
192
   * match_strlcpy: - Copy the characters from a substring_t to a sized buffer
   * @dest: where to copy to
   * @src: &substring_t to copy
   * @size: size of destination buffer
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
193
   *
b32a09db4   Markus Armbruster   add match_strlcpy...
194
195
196
   * Description: Copy the characters in &substring_t @src to the
   * c-style string @dest.  Copy no more than @size - 1 characters, plus
   * the terminating NUL.  Return length of @src.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
197
   */
b32a09db4   Markus Armbruster   add match_strlcpy...
198
  size_t match_strlcpy(char *dest, const substring_t *src, size_t size)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
199
  {
b32a09db4   Markus Armbruster   add match_strlcpy...
200
201
202
203
204
205
206
207
  	size_t ret = src->to - src->from;
  
  	if (size) {
  		size_t len = ret >= size ? size - 1 : ret;
  		memcpy(dest, src->from, len);
  		dest[len] = '\0';
  	}
  	return ret;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
208
209
210
211
212
213
214
215
216
217
  }
  
  /**
   * match_strdup: - allocate a new string with the contents of a substring_t
   * @s: &substring_t to copy
   *
   * Description: Allocates and returns a string filled with the contents of
   * the &substring_t @s. The caller is responsible for freeing the returned
   * string with kfree().
   */
ef4533f8a   David Howells   [AFS]: Make the m...
218
  char *match_strdup(const substring_t *s)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
219
  {
b32a09db4   Markus Armbruster   add match_strlcpy...
220
221
  	size_t sz = s->to - s->from + 1;
  	char *p = kmalloc(sz, GFP_KERNEL);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
222
  	if (p)
b32a09db4   Markus Armbruster   add match_strlcpy...
223
  		match_strlcpy(p, s, sz);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
224
225
226
227
228
229
230
  	return p;
  }
  
  EXPORT_SYMBOL(match_token);
  EXPORT_SYMBOL(match_int);
  EXPORT_SYMBOL(match_octal);
  EXPORT_SYMBOL(match_hex);
b32a09db4   Markus Armbruster   add match_strlcpy...
231
  EXPORT_SYMBOL(match_strlcpy);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
232
  EXPORT_SYMBOL(match_strdup);