chiark / gitweb /
[PATCH] remove historical SYSFS_attr="value" format
[elogind.git] / namedev_parse.c
1 /*
2  * namedev_parse.c
3  *
4  * Userspace devfs
5  *
6  * Copyright (C) 2003,2004 Greg Kroah-Hartman <greg@kroah.com>
7  *
8  *
9  *      This program is free software; you can redistribute it and/or modify it
10  *      under the terms of the GNU General Public License as published by the
11  *      Free Software Foundation version 2 of the License.
12  * 
13  *      This program is distributed in the hope that it will be useful, but
14  *      WITHOUT ANY WARRANTY; without even the implied warranty of
15  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  *      General Public License for more details.
17  * 
18  *      You should have received a copy of the GNU General Public License along
19  *      with this program; if not, write to the Free Software Foundation, Inc.,
20  *      675 Mass Ave, Cambridge, MA 02139, USA.
21  *
22  */
23
24 #ifdef DEBUG
25 /* define this to enable parsing debugging also */
26 /* #define DEBUG_PARSER */
27 #endif
28
29 #include <stddef.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <stdio.h>
33 #include <ctype.h>
34 #include <unistd.h>
35 #include <sys/stat.h>
36 #include <errno.h>
37
38 #include "udev.h"
39 #include "udev_lib.h"
40 #include "logging.h"
41 #include "namedev.h"
42
43
44 static int add_config_dev(struct config_device *new_dev)
45 {
46         struct config_device *tmp_dev;
47
48         tmp_dev = malloc(sizeof(*tmp_dev));
49         if (tmp_dev == NULL)
50                 return -ENOMEM;
51         memcpy(tmp_dev, new_dev, sizeof(*tmp_dev));
52         list_add_tail(&tmp_dev->node, &config_device_list);
53         //dump_config_dev(tmp_dev);
54         return 0;
55 }
56
57 void dump_config_dev(struct config_device *dev)
58 {
59         dbg_parse("name='%s', symlink='%s', bus='%s', place='%s', id='%s', "
60                   "sysfs_file[0]='%s', sysfs_value[0]='%s', "
61                   "kernel='%s', program='%s', result='%s'"
62                   "owner='%s', group='%s', mode=%#o",
63                   dev->name, dev->symlink, dev->bus, dev->place, dev->id,
64                   dev->sysfs_pair[0].file, dev->sysfs_pair[0].value,
65                   dev->kernel, dev->program, dev->result,
66                   dev->owner, dev->group, dev->mode);
67 }
68
69 void dump_config_dev_list(void)
70 {
71         struct config_device *dev;
72
73         list_for_each_entry(dev, &config_device_list, node)
74                 dump_config_dev(dev);
75 }
76
77 static int add_perm_dev(struct perm_device *new_dev)
78 {
79         struct perm_device *dev;
80         struct perm_device *tmp_dev;
81
82         /* update the values if we already have the device */
83         list_for_each_entry(dev, &perm_device_list, node) {
84                 if (strcmp(new_dev->name, dev->name) != 0)
85                         continue;
86
87                 set_empty_perms(dev, new_dev->mode, new_dev->owner, new_dev->group);
88                 return 0;
89         }
90
91         /* not found, add new structure to the perm list */
92         tmp_dev = malloc(sizeof(*tmp_dev));
93         if (!tmp_dev)
94                 return -ENOMEM;
95
96         memcpy(tmp_dev, new_dev, sizeof(*tmp_dev));
97         list_add_tail(&tmp_dev->node, &perm_device_list);
98         //dump_perm_dev(tmp_dev);
99         return 0;
100 }
101
102 void dump_perm_dev(struct perm_device *dev)
103 {
104         dbg_parse("name='%s', owner='%s', group='%s', mode=%#o",
105                   dev->name, dev->owner, dev->group, dev->mode);
106 }
107
108 void dump_perm_dev_list(void)
109 {
110         struct perm_device *dev;
111
112         list_for_each_entry(dev, &perm_device_list, node)
113                 dump_perm_dev(dev);
114 }
115
116 /* extract possible KEY{attr} */
117 static char *get_key_attribute(char *str)
118 {
119         char *pos;
120         char *attr;
121
122         attr = strchr(str, '{');
123         if (attr != NULL) {
124                 attr++;
125                 pos = strchr(attr, '}');
126                 if (pos == NULL) {
127                         dbg("missing closing brace for format");
128                         return NULL;
129                 }
130                 pos[0] = '\0';
131                 dbg("attribute='%s'", attr);
132                 return attr;
133         }
134
135         return NULL;
136 }
137
138 static int namedev_parse_rules(const char *filename, void *data)
139 {
140         char line[LINE_SIZE];
141         char *bufline;
142         int lineno;
143         char *temp;
144         char *temp2;
145         char *temp3;
146         char *attr;
147         char *buf;
148         size_t bufsize;
149         size_t cur;
150         size_t count;
151         int program_given = 0;
152         int valid;
153         int retval = 0;
154         struct config_device dev;
155
156         if (file_map(filename, &buf, &bufsize) == 0) {
157                 dbg("reading '%s' as rules file", filename);
158         } else {
159                 dbg("can't open '%s' as rules file", filename);
160                 return -1;
161         }
162
163         /* loop through the whole file */
164         cur = 0;
165         lineno = 0;
166         while (cur < bufsize) {
167                 count = buf_get_line(buf, bufsize, cur);
168                 bufline = &buf[cur];
169                 cur += count+1;
170                 lineno++;
171
172                 if (count >= LINE_SIZE) {
173                         info("line too long, rule skipped %s, line %d",
174                              filename, lineno);
175                         continue;
176                 }
177
178                 /* eat the whitespace */
179                 while ((count > 0) && isspace(bufline[0])) {
180                         bufline++;
181                         count--;
182                 }
183                 if (count == 0)
184                         continue;
185
186                 /* see if this is a comment */
187                 if (bufline[0] == COMMENT_CHARACTER)
188                         continue;
189
190                 strncpy(line, bufline, count);
191                 line[count] = '\0';
192                 dbg_parse("read '%s'", line);
193
194                 /* get all known keys */
195                 memset(&dev, 0x00, sizeof(struct config_device));
196                 temp = line;
197                 valid = 0;
198
199                 while (1) {
200                         retval = parse_get_pair(&temp, &temp2, &temp3);
201                         if (retval)
202                                 break;
203
204                         if (strcasecmp(temp2, FIELD_BUS) == 0) {
205                                 strfieldcpy(dev.bus, temp3);
206                                 valid = 1;
207                                 continue;
208                         }
209
210                         if (strcasecmp(temp2, FIELD_ID) == 0) {
211                                 strfieldcpy(dev.id, temp3);
212                                 valid = 1;
213                                 continue;
214                         }
215
216                         if (strcasecmp(temp2, FIELD_PLACE) == 0) {
217                                 strfieldcpy(dev.place, temp3);
218                                 valid = 1;
219                                 continue;
220                         }
221
222                         if (strncasecmp(temp2, FIELD_SYSFS, sizeof(FIELD_SYSFS)-1) == 0) {
223                                 struct sysfs_pair *pair = &dev.sysfs_pair[0];
224                                 int sysfs_pair_num = 0;
225
226                                 /* find first unused pair */
227                                 while (pair->file[0] != '\0') {
228                                         ++sysfs_pair_num;
229                                         if (sysfs_pair_num >= MAX_SYSFS_PAIRS) {
230                                                 pair = NULL;
231                                                 break;
232                                         }
233                                         ++pair;
234                                 }
235                                 if (pair) {
236                                         attr = get_key_attribute(temp2 + sizeof(FIELD_SYSFS)-1);
237                                         if (attr == NULL) {
238                                                 dbg("error parsing " FIELD_SYSFS " attribute");
239                                                 continue;
240                                         }
241                                         strfieldcpy(pair->file, attr);
242                                         strfieldcpy(pair->value, temp3);
243                                         valid = 1;
244                                 }
245                                 continue;
246                         }
247
248                         if (strcasecmp(temp2, FIELD_KERNEL) == 0) {
249                                 strfieldcpy(dev.kernel, temp3);
250                                 valid = 1;
251                                 continue;
252                         }
253
254                         if (strcasecmp(temp2, FIELD_SUBSYSTEM) == 0) {
255                                 strfieldcpy(dev.subsystem, temp3);
256                                 valid = 1;
257                                 continue;
258                         }
259
260                         if (strcasecmp(temp2, FIELD_DRIVER) == 0) {
261                                 strfieldcpy(dev.driver, temp3);
262                                 valid = 1;
263                                 continue;
264                         }
265
266                         if (strcasecmp(temp2, FIELD_PROGRAM) == 0) {
267                                 program_given = 1;
268                                 strfieldcpy(dev.program, temp3);
269                                 valid = 1;
270                                 continue;
271                         }
272
273                         if (strcasecmp(temp2, FIELD_RESULT) == 0) {
274                                 strfieldcpy(dev.result, temp3);
275                                 valid = 1;
276                                 continue;
277                         }
278
279                         if (strncasecmp(temp2, FIELD_NAME, sizeof(FIELD_NAME)-1) == 0) {
280                                 attr = get_key_attribute(temp2 + sizeof(FIELD_NAME)-1);
281                                 if (attr != NULL && strcasecmp(attr, ATTR_PARTITIONS) == 0) {
282                                                 dbg_parse("creation of partition nodes requested");
283                                                 dev.partitions = PARTITIONS_COUNT;
284                                         }
285                                 strfieldcpy(dev.name, temp3);
286                                 valid = 1;
287                                 continue;
288                         }
289
290                         if (strcasecmp(temp2, FIELD_SYMLINK) == 0) {
291                                 strfieldcpy(dev.symlink, temp3);
292                                 valid = 1;
293                                 continue;
294                         }
295
296                         if (strcasecmp(temp2, FIELD_OWNER) == 0) {
297                                 strfieldcpy(dev.owner, temp3);
298                                 valid = 1;
299                                 continue;
300                         }
301
302                         if (strcasecmp(temp2, FIELD_GROUP) == 0) {
303                                 strfieldcpy(dev.group, temp3);
304                                 valid = 1;
305                                 continue;
306                         }
307
308                         if (strcasecmp(temp2, FIELD_MODE) == 0) {
309                                 dev.mode = strtol(temp3, NULL, 8);
310                                 valid = 1;
311                                 continue;
312                         }
313
314                         dbg("unknown type of field '%s'", temp2);
315                         goto error;
316                 }
317
318                 /* skip line if not any valid key was found */
319                 if (!valid)
320                         goto error;
321
322                 /* simple plausibility checks for given keys */
323                 if ((dev.sysfs_pair[0].file[0] == '\0') ^
324                     (dev.sysfs_pair[0].value[0] == '\0')) {
325                         info("inconsistency in " FIELD_SYSFS " key");
326                         goto error;
327                 }
328
329                 if ((dev.result[0] != '\0') && (program_given == 0)) {
330                         info(FIELD_RESULT " is only useful when "
331                              FIELD_PROGRAM " is called in any rule before");
332                         goto error;
333                 }
334
335                 dev.config_line = lineno;
336                 strfieldcpy(dev.config_file, filename);
337                 retval = add_config_dev(&dev);
338                 if (retval) {
339                         dbg("add_config_dev returned with error %d", retval);
340                         continue;
341 error:
342                         info("parse error %s, line %d:%d, rule skipped",
343                              filename, lineno, temp - line);
344                 }
345         }
346
347         file_unmap(buf, bufsize);
348         return retval;
349 }
350
351 static int namedev_parse_permissions(const char *filename, void *data)
352 {
353         char line[LINE_SIZE];
354         char *bufline;
355         char *temp;
356         char *temp2;
357         char *buf;
358         size_t bufsize;
359         size_t cur;
360         size_t count;
361         int retval = 0;
362         struct perm_device dev;
363         int lineno;
364
365         if (file_map(filename, &buf, &bufsize) == 0) {
366                 dbg("reading '%s' as permissions file", filename);
367         } else {
368                 dbg("can't open '%s' as permissions file", filename);
369                 return -1;
370         }
371
372         /* loop through the whole file */
373         cur = 0;
374         lineno = 0;
375         while (cur < bufsize) {
376                 count = buf_get_line(buf, bufsize, cur);
377                 bufline = &buf[cur];
378                 cur += count+1;
379                 lineno++;
380
381                 if (count >= LINE_SIZE) {
382                         info("line too long, rule skipped %s, line %d",
383                              filename, lineno);
384                         continue;
385                 }
386
387                 /* eat the whitespace */
388                 while ((count > 0) && isspace(bufline[0])) {
389                         bufline++;
390                         count--;
391                 }
392                 if (count == 0)
393                         continue;
394
395                 /* see if this is a comment */
396                 if (bufline[0] == COMMENT_CHARACTER)
397                         continue;
398
399                 strncpy(line, bufline, count);
400                 line[count] = '\0';
401                 dbg_parse("read '%s'", line);
402
403                 /* parse the line */
404                 memset(&dev, 0x00, sizeof(struct perm_device));
405                 temp = line;
406
407                 temp2 = strsep(&temp, ":");
408                 if (!temp2) {
409                         dbg("cannot parse line '%s'", line);
410                         continue;
411                 }
412                 strfieldcpy(dev.name, temp2);
413
414                 temp2 = strsep(&temp, ":");
415                 if (!temp2) {
416                         dbg("cannot parse line '%s'", line);
417                         continue;
418                 }
419                 strfieldcpy(dev.owner, temp2);
420
421                 temp2 = strsep(&temp, ":");
422                 if (!temp2) {
423                         dbg("cannot parse line '%s'", line);
424                         continue;
425                 }
426                 strfieldcpy(dev.group, temp2);
427
428                 if (!temp) {
429                         dbg("cannot parse line '%s'", line);
430                         continue;
431                 }
432                 dev.mode = strtol(temp, NULL, 8);
433
434                 dbg_parse("name='%s', owner='%s', group='%s', mode=%#o",
435                           dev.name, dev.owner, dev.group, dev.mode);
436
437                 retval = add_perm_dev(&dev);
438                 if (retval) {
439                         dbg("add_perm_dev returned with error %d", retval);
440                         goto exit;
441                 }
442         }
443
444 exit:
445         file_unmap(buf, bufsize);
446         return retval;
447 }
448
449 int namedev_init_rules(void)
450 {
451         struct stat stats;
452
453         stat(udev_rules_filename, &stats);
454         if ((stats.st_mode & S_IFMT) != S_IFDIR)
455                 return namedev_parse_rules(udev_rules_filename, NULL);
456         else
457                 return call_foreach_file(namedev_parse_rules, udev_rules_filename,
458                                          RULEFILE_SUFFIX, NULL);
459 }
460
461 int namedev_init_permissions(void)
462 {
463         struct stat stats;
464
465         stat(udev_permissions_filename, &stats);
466         if ((stats.st_mode & S_IFMT) != S_IFDIR)
467                 return namedev_parse_permissions(udev_permissions_filename, NULL);
468         else
469                 return call_foreach_file(namedev_parse_permissions, udev_permissions_filename,
470                                          PERMFILE_SUFFIX, NULL);
471 }