mdadm-1.6.0
[thirdparty/mdadm.git] / config.c
1 /*
2  * mdadm - manage Linux "md" devices aka RAID arrays.
3  *
4  * Copyright (C) 2001-2002 Neil Brown <neilb@cse.unsw.edu.au>
5  *
6  *
7  *    This program is free software; you can redistribute it and/or modify
8  *    it under the terms of the GNU General Public License as published by
9  *    the Free Software Foundation; either version 2 of the License, or
10  *    (at your option) any later version.
11  *
12  *    This program is distributed in the hope that it will be useful,
13  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *    GNU General Public License for more details.
16  *
17  *    You should have received a copy of the GNU General Public License
18  *    along with this program; if not, write to the Free Software
19  *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  *
21  *    Author: Neil Brown
22  *    Email: <neilb@cse.unsw.edu.au>
23  *    Paper: Neil Brown
24  *           School of Computer Science and Engineering
25  *           The University of New South Wales
26  *           Sydney, 2052
27  *           Australia
28  */
29
30 #include        "mdadm.h"
31 #include        "dlink.h"
32 #include        <sys/dir.h>
33 #include        <glob.h>
34 #include        <fnmatch.h>
35 #include        <ctype.h>
36
37 /*
38  * Read the config file
39  *
40  * conf_get_uuids gets a list of devicename+uuid pairs
41  * conf_get_devs gets device names after expanding wildcards
42  *
43  * Each keeps the returned list and frees it when asked to make
44  * a new list.
45  *
46  * The format of the config file needs to be fairly extensible.
47  * Now, arrays only have names and uuids and devices merely are.
48  * But later arrays might want names, and devices might want superblock
49  * versions, and who knows what else.
50  * I like free format, abhore backslash line continuation, adore
51  *   indentation for structure and am ok about # comments.
52  *
53  * So, each line that isn't blank or a #comment must either start
54  *  with a key word, and not be indented, or must start with a
55  *  non-key-word and must be indented.
56  *
57  * Keywords are DEVICE and ARRAY
58  * DEV{ICE} introduces some devices that might contain raid components.
59  * e.g.
60  *   DEV style=0 /dev/sda* /dev/hd*
61  *   DEV style=1 /dev/sd[b-f]*
62  * ARR{AY} describes an array giving md device and attributes like uuid=whatever
63  * e.g.
64  *   ARRAY /dev/md0 uuid=whatever name=something
65  * Spaces separate words on each line.  Quoting, with "" or '' protects them,
66  * but may not wrap over lines
67  *
68  */
69
70 #ifndef CONFFILE
71 #define CONFFILE "/etc/mdadm.conf"
72 #endif
73 char DefaultConfFile[] = CONFFILE;
74
75 char *keywords[] = { "device", "array", "mailaddr", "program", NULL };
76
77 /*
78  * match_keyword returns an index into the keywords array, or -1 for no match
79  * case is ignored, and at least three characters must be given
80  */
81
82 int match_keyword(char *word)
83 {
84         int len = strlen(word);
85         int n;
86     
87         if (len < 3) return -1;
88         for (n=0; keywords[n]; n++) {
89                 if (strncasecmp(word, keywords[n], len)==0)
90                         return n;
91         }
92         return -1;
93 }
94
95 /* conf_word gets one word from the conf file.
96  * if "allow_key", then accept words at the start of a line,
97  * otherwise stop when such a word is found.
98  * We assume that the file pointer is at the end of a word, so the
99  * next character is a space, or a newline.  If not, it is the start of a line.
100  */
101
102 char *conf_word(FILE *file, int allow_key)
103 {
104         int wsize = 100;
105         int len = 0;
106         int c;
107         int quote;
108         int wordfound = 0;
109         char *word = malloc(wsize);
110
111         if (!word) abort();
112
113         while (wordfound==0) {
114                 /* at the end of a word.. */
115                 c = getc(file);
116                 if (c == '#')
117                         while (c != EOF && c != '\n')
118                                 c = getc(file);
119                 if (c == EOF) break;
120                 if (c == '\n') continue;
121
122                 if (c != ' ' && c != '\t' && ! allow_key) {
123                         ungetc(c, file);
124                         break;
125                 }
126                 /* looks like it is safe to get a word here, if there is one */
127                 quote = 0;
128                 /* first, skip any spaces */
129                 while (c == ' ' || c == '\t')
130                         c = getc(file);
131                 if (c != EOF && c != '\n' && c != '#') {
132                         /* we really have a character of a word, so start saving it */
133                         while (c != EOF && c != '\n' && (quote || (c!=' ' && c != '\t'))) {
134                                 wordfound = 1;
135                                 if (quote && c == quote) quote = 0;
136                                 else if (quote == 0 && (c == '\'' || c == '"'))
137                                         quote = c;
138                                 else {
139                                         if (len == wsize-1) {
140                                                 wsize += 100;
141                                                 word = realloc(word, wsize);
142                                                 if (!word) abort();
143                                         }
144                                         word[len++] = c;
145                                 }
146                                 c = getc(file);
147                         }
148                 }
149                 if (c != EOF) ungetc(c, file);
150         }
151         word[len] = 0;
152 /*    printf("word is <%s>\n", word); */
153         if (!wordfound) {
154                 free(word);
155                 word = NULL;
156         }
157         return word;
158 }
159         
160 /*
161  * conf_line reads one logical line from the conffile.
162  * It skips comments and continues until it finds a line that starts
163  * with a non blank/comment.  This character is pushed back for the next call
164  * A doubly linked list of words is returned.
165  * the first word will be a keyword.  Other words will have had quotes removed.
166  */
167
168 char *conf_line(FILE *file)
169 {
170         char *w;
171         char *list;
172
173         w = conf_word(file, 1);
174         if (w == NULL) return NULL;
175
176         list = dl_strdup(w);
177         free(w);
178         dl_init(list);
179
180         while ((w = conf_word(file,0))){
181                 char *w2 = dl_strdup(w);
182                 free(w);
183                 dl_add(list, w2);
184         }
185 /*    printf("got a line\n");*/
186         return list;
187 }
188
189 void free_line(char *line)
190 {
191         char *w;
192         for (w=dl_next(line); w != line; w=dl_next(line)) {
193                 dl_del(w);
194                 dl_free(w);
195         }
196         dl_free(line);
197 }
198
199
200 struct conf_dev {
201     struct conf_dev *next;
202     char *name;
203 } *cdevlist = NULL;
204
205 void load_partitions(void)
206 {
207         FILE *f = fopen("/proc/partitions", "r");
208         char buf[1024];
209         if (f == NULL) {
210                 fprintf(stderr, Name ": cannot open /proc/partitions\n");
211                 return;
212         }
213         while (fgets(buf, 1024, f)) {
214                 int major, minor;
215                 char *name, *mp;
216                 buf[1023] = '\0';
217                 if (buf[0] != ' ')
218                         continue;
219                 major = strtoul(buf, &mp, 10);
220                 if (mp == buf || *mp != ' ') 
221                         continue;
222                 minor = strtoul(mp, NULL, 10);
223
224                 name = map_dev(major, minor);
225                 if (name) {
226                         struct conf_dev *cd;
227
228                         cd = malloc(sizeof(*cd));
229                         cd->name = strdup(name);
230                         cd->next = cdevlist;
231                         cdevlist = cd;
232                 }
233         }
234         fclose(f);
235 }
236
237
238 void devline(char *line) 
239 {
240         char *w;
241         struct conf_dev *cd;
242
243         for (w=dl_next(line); w != line; w=dl_next(w)) {
244                 if (w[0] == '/') {
245                         cd = malloc(sizeof(*cd));
246                         cd->name = strdup(w);
247                         cd->next = cdevlist;
248                         cdevlist = cd;
249                 } else if (strcasecmp(w, "partitions") == 0) {
250                         /* read /proc/partitions, and look major/minor up in /dev */
251                         load_partitions();
252                 } else {
253                         fprintf(stderr, Name ": unreconised word on DEVICE line: %s\n",
254                                 w);
255                 }
256         }
257 }
258
259 mddev_ident_t mddevlist = NULL;
260 mddev_ident_t *mddevlp = &mddevlist;
261
262 void arrayline(char *line)
263 {
264         char *w;
265
266         struct mddev_ident_s mis;
267         mddev_ident_t mi;
268
269         mis.uuid_set = 0;
270         mis.super_minor = UnSet;
271         mis.level = UnSet;
272         mis.raid_disks = UnSet;
273         mis.spare_disks = UnSet;
274         mis.devices = NULL;
275         mis.devname = NULL;
276         mis.spare_group = NULL;
277         mis.autof = 0;
278
279         for (w=dl_next(line); w!=line; w=dl_next(w)) {
280                 if (w[0] == '/') {
281                         if (mis.devname)
282                                 fprintf(stderr, Name ": only give one device per ARRAY line: %s and %s\n",
283                                         mis.devname, w);
284                         else mis.devname = w;
285                 } else if (strncasecmp(w, "uuid=", 5)==0 ) {
286                         if (mis.uuid_set)
287                                 fprintf(stderr, Name ": only specify uuid once, %s ignored.\n",
288                                         w);
289                         else {
290                                 if (parse_uuid(w+5, mis.uuid))
291                                         mis.uuid_set = 1;
292                                 else
293                                         fprintf(stderr, Name ": bad uuid: %s\n", w);
294                         }
295                 } else if (strncasecmp(w, "super-minor=", 12)==0 ) {
296                         if (mis.super_minor >= 0)
297                                 fprintf(stderr, Name ": only specify super-minor once, %s ignored.\n",
298                                         w);
299                         else {
300                                 char *endptr;
301                                 mis.super_minor= strtol(w+12, &endptr, 10);
302                                 if (w[12]==0 || endptr[0]!=0 || mis.super_minor < 0) {
303                                         fprintf(stderr, Name ": invalid super-minor number: %s\n",
304                                                 w);
305                                         mis.super_minor = UnSet;
306                                 }
307                         }
308                 } else if (strncasecmp(w, "devices=", 8 ) == 0 ) {
309                         if (mis.devices)
310                                 fprintf(stderr, Name ": only specify devices once (use a comma separated list). %s ignored\n",
311                                         w);
312                         else
313                                 mis.devices = strdup(w+8);
314                 } else if (strncasecmp(w, "spare-group=", 12) == 0 ) {
315                         if (mis.spare_group)
316                                 fprintf(stderr, Name ": only specify one spare group per array. %s ignored.\n",
317                                         w);
318                         else
319                                 mis.spare_group = strdup(w+12);
320                 } else if (strncasecmp(w, "level=", 6) == 0 ) {
321                         /* this is mainly for compatability with --brief output */
322                         mis.level = map_name(pers, w+6);
323                 } else if (strncasecmp(w, "disks=", 6) == 0 ) {
324                         /* again, for compat */
325                         mis.raid_disks = atoi(w+6);
326                 } else if (strncasecmp(w, "num-devices=", 12) == 0 ) {
327                         /* again, for compat */
328                         mis.raid_disks = atoi(w+12);
329                 } else if (strncasecmp(w, "spares=", 7) == 0 ) {
330                         /* for warning if not all spares present */
331                         mis.spare_disks = atoi(w+7);
332                 } else if (strncasecmp(w, "auto=", 5) == 0 ) {
333                         /* whether to create device special files as needed */
334                         if (strcasecmp(w+5, "no")==0)
335                                 mis.autof = 0;
336                         else if (strcasecmp(w+5,"yes")==0 || strcasecmp(w+5,"md")==0)
337                                 mis.autof = -1;
338                         else {
339                                 /* There might be digits, and maybe a hypen, at the end */
340                                 char *e = w+5 + strlen(w+5);
341                                 int num = 4;
342                                 int len;
343                                 while (e > w+5 && isdigit(e[-1]))
344                                         e--;
345                                 if (*e) {
346                                         num = atoi(e);
347                                         if (num <= 0) num = 1;
348                                 }
349                                 if (e > w+5 && e[-1] == '-')
350                                         e--;
351                                 len = e - (w+5);
352                                 if ((len == 3 && strncasecmp(w+5,"mdp",3)==0) ||
353                                     (len == 1 && strncasecmp(w+5,"p",1)==0) ||
354                                     (len >= 4 && strncasecmp(w+5,"part",4)==0))
355                                         mis.autof = num;
356                                 else 
357                                         fprintf(stderr, Name ": auto type of \"%s\" ignored for %s\n",
358                                                 w+5, mis.devname?mis.devname:"unlabeled-array");
359                         }
360                 } else {
361                         fprintf(stderr, Name ": unrecognised word on ARRAY line: %s\n",
362                                 w);
363                 }
364         }
365         if (mis.devname == NULL)
366                 fprintf(stderr, Name ": ARRAY line with no device\n");
367         else if (mis.uuid_set == 0 && mis.devices == NULL && mis.super_minor < 0)
368                 fprintf(stderr, Name ": ARRAY line %s has no identity information.\n", mis.devname);
369         else {
370                 mi = malloc(sizeof(*mi));
371                 *mi = mis;
372                 mi->devname = strdup(mis.devname);
373                 mi->next = NULL;
374                 *mddevlp = mi;
375                 mddevlp = &mi->next;
376         }
377 }
378
379 static char *alert_email = NULL;
380 void mailline(char *line)
381 {
382         char *w;
383
384         for (w=dl_next(line); w != line ; w=dl_next(w)) {
385                 if (alert_email == NULL)
386                         alert_email = strdup(w);
387                 else
388                         fprintf(stderr, Name ": excess address on MAIL line: %s - ignored\n",
389                                 w);
390         }
391 }
392
393
394 static char *alert_program = NULL;
395 void programline(char *line)
396 {
397         char *w;
398
399         for (w=dl_next(line); w != line ; w=dl_next(w)) {
400                 if (alert_program == NULL)
401                         alert_program = strdup(w);
402                 else
403                         fprintf(stderr, Name ": excess program on PROGRAM line: %s - ignored\n",
404                                 w);
405         }
406 }
407
408
409 int loaded = 0;
410
411 void load_conffile(char *conffile)
412 {
413         FILE *f;
414         char *line;
415
416         if (loaded) return;
417         if (conffile == NULL)
418                 conffile = DefaultConfFile;
419
420         if (strcmp(conffile, "none") == 0) {
421                 loaded = 1;
422                 return;
423         }
424         if (strcmp(conffile, "partitions")==0) {
425                 load_partitions();
426                 loaded = 1;
427                 return;
428         }
429         f = fopen(conffile, "r");
430         if (f ==NULL)
431                 return;
432
433         loaded = 1;
434         while ((line=conf_line(f))) {
435                 switch(match_keyword(line)) {
436                 case 0: /* DEVICE */
437                         devline(line);
438                         break;
439                 case 1: /* ARRAY */
440                         arrayline(line);
441                         break;
442                 case 2: /* MAIL */
443                         mailline(line);
444                         break;
445                 case 3: /* PROGRAM */
446                         programline(line);
447                         break;
448                 default:
449                         fprintf(stderr, Name ": Unknown keyword %s\n", line);
450                 }
451                 free_line(line);
452         }
453     
454         fclose(f);
455
456 /*    printf("got file\n"); */
457 }
458
459 char *conf_get_mailaddr(char *conffile)
460 {
461         load_conffile(conffile);
462         return alert_email;
463 }
464
465 char *conf_get_program(char *conffile)
466 {
467         load_conffile(conffile);
468         return alert_program;
469 }
470
471
472 mddev_ident_t conf_get_ident(char *conffile, char *dev)
473 {
474         mddev_ident_t rv;
475         load_conffile(conffile);
476         rv = mddevlist;
477         while (dev && rv && strcmp(dev, rv->devname)!=0)
478                 rv = rv->next;
479         return rv;
480 }
481
482 mddev_dev_t conf_get_devs(char *conffile)
483 {
484         glob_t globbuf;
485         struct conf_dev *cd;
486         int flags = 0;
487         static mddev_dev_t dlist = NULL;
488         unsigned int i;
489
490         while (dlist) {
491                 mddev_dev_t t = dlist;
492                 dlist = dlist->next;
493                 free(t->devname);
494                 free(t);
495         }
496     
497         load_conffile(conffile);
498     
499         for (cd=cdevlist; cd; cd=cd->next) {
500                 glob(cd->name, flags, NULL, &globbuf);
501                 flags |= GLOB_APPEND;
502         }
503         if (flags & GLOB_APPEND) {
504                 for (i=0; i<globbuf.gl_pathc; i++) {
505                         mddev_dev_t t = malloc(sizeof(*t));
506                         t->devname = strdup(globbuf.gl_pathv[i]);
507                         t->next = dlist;
508                         dlist = t;
509 /*      printf("one dev is %s\n", t->devname);*/
510                 }
511                 globfree(&globbuf);
512         }
513
514         return dlist;
515 }
516
517 int match_oneof(char *devices, char *devname)
518 {
519     /* check if one of the comma separated patterns in devices
520      * matches devname
521      */
522
523
524     while (devices && *devices) {
525         char patn[1024];
526         char *p = devices;
527         devices = strchr(devices, ',');
528         if (!devices)
529             devices = p + strlen(p);
530         if (devices-p < 1024) {
531                 strncpy(patn, p, devices-p);
532                 patn[devices-p] = 0;
533                 if (fnmatch(patn, devname, FNM_PATHNAME)==0)
534                         return 1;
535         }
536         if (*devices == ',')
537                 devices++;
538     }
539     return 0;
540 }