7101c3b0f14a4b29e112310e05b21cada9689978
[thirdparty/mdadm.git] / config.c
1 /*
2 * mdadm - manage Linux "md" devices aka RAID arrays.
3 *
4 * Copyright (C) 2001-2006 Neil Brown <neilb@suse.de>
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 #include <pwd.h>
37 #include <grp.h>
38
39 /*
40 * Read the config file
41 *
42 * conf_get_uuids gets a list of devicename+uuid pairs
43 * conf_get_devs gets device names after expanding wildcards
44 *
45 * Each keeps the returned list and frees it when asked to make
46 * a new list.
47 *
48 * The format of the config file needs to be fairly extensible.
49 * Now, arrays only have names and uuids and devices merely are.
50 * But later arrays might want names, and devices might want superblock
51 * versions, and who knows what else.
52 * I like free format, abhore backslash line continuation, adore
53 * indentation for structure and am ok about # comments.
54 *
55 * So, each line that isn't blank or a #comment must either start
56 * with a key word, and not be indented, or must start with a
57 * non-key-word and must be indented.
58 *
59 * Keywords are DEVICE and ARRAY
60 * DEV{ICE} introduces some devices that might contain raid components.
61 * e.g.
62 * DEV style=0 /dev/sda* /dev/hd*
63 * DEV style=1 /dev/sd[b-f]*
64 * ARR{AY} describes an array giving md device and attributes like uuid=whatever
65 * e.g.
66 * ARRAY /dev/md0 uuid=whatever name=something
67 * Spaces separate words on each line. Quoting, with "" or '' protects them,
68 * but may not wrap over lines
69 *
70 */
71
72 #ifndef CONFFILE
73 #define CONFFILE "/etc/mdadm.conf"
74 #endif
75 #ifndef CONFFILE2
76 /* for Debian compatibility .... */
77 #define CONFFILE2 "/etc/mdadm/mdadm.conf"
78 #endif
79 char DefaultConfFile[] = CONFFILE;
80 char DefaultAltConfFile[] = CONFFILE2;
81
82 enum linetype { Devices, Array, Mailaddr, Mailfrom, Program, CreateDev, Homehost, LTEnd };
83 char *keywords[] = {
84 [Devices] = "devices",
85 [Array] = "array",
86 [Mailaddr] = "mailaddr",
87 [Mailfrom] = "mailfrom",
88 [Program] = "program",
89 [CreateDev] = "create",
90 [Homehost] = "homehost",
91 [LTEnd] = NULL
92 };
93
94 /*
95 * match_keyword returns an index into the keywords array, or -1 for no match
96 * case is ignored, and at least three characters must be given
97 */
98
99 int match_keyword(char *word)
100 {
101 int len = strlen(word);
102 int n;
103
104 if (len < 3) return -1;
105 for (n=0; keywords[n]; n++) {
106 if (strncasecmp(word, keywords[n], len)==0)
107 return n;
108 }
109 return -1;
110 }
111
112 /* conf_word gets one word from the conf file.
113 * if "allow_key", then accept words at the start of a line,
114 * otherwise stop when such a word is found.
115 * We assume that the file pointer is at the end of a word, so the
116 * next character is a space, or a newline. If not, it is the start of a line.
117 */
118
119 char *conf_word(FILE *file, int allow_key)
120 {
121 int wsize = 100;
122 int len = 0;
123 int c;
124 int quote;
125 int wordfound = 0;
126 char *word = malloc(wsize);
127
128 if (!word) abort();
129
130 while (wordfound==0) {
131 /* at the end of a word.. */
132 c = getc(file);
133 if (c == '#')
134 while (c != EOF && c != '\n')
135 c = getc(file);
136 if (c == EOF) break;
137 if (c == '\n') continue;
138
139 if (c != ' ' && c != '\t' && ! allow_key) {
140 ungetc(c, file);
141 break;
142 }
143 /* looks like it is safe to get a word here, if there is one */
144 quote = 0;
145 /* first, skip any spaces */
146 while (c == ' ' || c == '\t')
147 c = getc(file);
148 if (c != EOF && c != '\n' && c != '#') {
149 /* we really have a character of a word, so start saving it */
150 while (c != EOF && c != '\n' && (quote || (c!=' ' && c != '\t'))) {
151 wordfound = 1;
152 if (quote && c == quote) quote = 0;
153 else if (quote == 0 && (c == '\'' || c == '"'))
154 quote = c;
155 else {
156 if (len == wsize-1) {
157 wsize += 100;
158 word = realloc(word, wsize);
159 if (!word) abort();
160 }
161 word[len++] = c;
162 }
163 c = getc(file);
164 }
165 }
166 if (c != EOF) ungetc(c, file);
167 }
168 word[len] = 0;
169 /* printf("word is <%s>\n", word); */
170 if (!wordfound) {
171 free(word);
172 word = NULL;
173 }
174 return word;
175 }
176
177 /*
178 * conf_line reads one logical line from the conffile.
179 * It skips comments and continues until it finds a line that starts
180 * with a non blank/comment. This character is pushed back for the next call
181 * A doubly linked list of words is returned.
182 * the first word will be a keyword. Other words will have had quotes removed.
183 */
184
185 char *conf_line(FILE *file)
186 {
187 char *w;
188 char *list;
189
190 w = conf_word(file, 1);
191 if (w == NULL) return NULL;
192
193 list = dl_strdup(w);
194 free(w);
195 dl_init(list);
196
197 while ((w = conf_word(file,0))){
198 char *w2 = dl_strdup(w);
199 free(w);
200 dl_add(list, w2);
201 }
202 /* printf("got a line\n");*/
203 return list;
204 }
205
206 void free_line(char *line)
207 {
208 char *w;
209 for (w=dl_next(line); w != line; w=dl_next(line)) {
210 dl_del(w);
211 dl_free(w);
212 }
213 dl_free(line);
214 }
215
216
217 struct conf_dev {
218 struct conf_dev *next;
219 char *name;
220 } *cdevlist = NULL;
221
222 mddev_dev_t load_partitions(void)
223 {
224 FILE *f = fopen("/proc/partitions", "r");
225 char buf[1024];
226 mddev_dev_t rv = NULL;
227 if (f == NULL) {
228 fprintf(stderr, Name ": cannot open /proc/partitions\n");
229 return NULL;
230 }
231 while (fgets(buf, 1024, f)) {
232 int major, minor;
233 char *name, *mp;
234 mddev_dev_t d;
235
236 buf[1023] = '\0';
237 if (buf[0] != ' ')
238 continue;
239 major = strtoul(buf, &mp, 10);
240 if (mp == buf || *mp != ' ')
241 continue;
242 minor = strtoul(mp, NULL, 10);
243
244 name = map_dev(major, minor, 1);
245 if (!name)
246 continue;
247 d = malloc(sizeof(*d));
248 d->devname = strdup(name);
249 d->next = rv;
250 d->used = 0;
251 rv = d;
252 }
253 fclose(f);
254 return rv;
255 }
256
257 struct createinfo createinfo = {
258 .autof = 2, /* by default, create devices with standard names */
259 .symlinks = 1,
260 #ifdef DEBIAN
261 .gid = 6, /* disk */
262 .mode = 0660,
263 #else
264 .mode = 0600,
265 #endif
266 };
267
268 int parse_auto(char *str, char *msg, int config)
269 {
270 int autof;
271 if (str == NULL || *str == 0)
272 autof = 2;
273 else if (strcasecmp(str,"no")==0)
274 autof = 1;
275 else if (strcasecmp(str,"yes")==0)
276 autof = 2;
277 else if (strcasecmp(str,"md")==0)
278 autof = config?5:3;
279 else {
280 /* There might be digits, and maybe a hypen, at the end */
281 char *e = str + strlen(str);
282 int num = 4;
283 int len;
284 while (e > str && isdigit(e[-1]))
285 e--;
286 if (*e) {
287 num = atoi(e);
288 if (num <= 0) num = 1;
289 }
290 if (e > str && e[-1] == '-')
291 e--;
292 len = e - str;
293 if ((len == 2 && strncasecmp(str,"md",2)==0)) {
294 autof = config ? 5 : 3;
295 } else if ((len == 3 && strncasecmp(str,"yes",3)==0)) {
296 autof = 2;
297 } else if ((len == 3 && strncasecmp(str,"mdp",3)==0)) {
298 autof = config ? 6 : 4;
299 } else if ((len == 1 && strncasecmp(str,"p",1)==0) ||
300 (len >= 4 && strncasecmp(str,"part",4)==0)) {
301 autof = 6;
302 } else {
303 fprintf(stderr, Name ": %s arg of \"%s\" unrecognised: use no,yes,md,mdp,part\n"
304 " optionally followed by a number.\n",
305 msg, str);
306 exit(2);
307 }
308 autof |= num << 3;
309 }
310 return autof;
311 }
312
313 static void createline(char *line)
314 {
315 char *w;
316 char *ep;
317
318 for (w=dl_next(line); w!=line; w=dl_next(w)) {
319 if (strncasecmp(w, "auto=", 5) == 0)
320 createinfo.autof = parse_auto(w+5, "auto=", 1);
321 else if (strncasecmp(w, "owner=", 6) == 0) {
322 if (w[6] == 0) {
323 fprintf(stderr, Name ": missing owner name\n");
324 continue;
325 }
326 createinfo.uid = strtoul(w+6, &ep, 10);
327 if (*ep != 0) {
328 struct passwd *pw;
329 /* must be a name */
330 pw = getpwnam(w+6);
331 if (pw)
332 createinfo.uid = pw->pw_uid;
333 else
334 fprintf(stderr, Name ": CREATE user %s not found\n", w+6);
335 }
336 } else if (strncasecmp(w, "group=", 6) == 0) {
337 if (w[6] == 0) {
338 fprintf(stderr, Name ": missing group name\n");
339 continue;
340 }
341 createinfo.gid = strtoul(w+6, &ep, 10);
342 if (*ep != 0) {
343 struct group *gr;
344 /* must be a name */
345 gr = getgrnam(w+6);
346 if (gr)
347 createinfo.gid = gr->gr_gid;
348 else
349 fprintf(stderr, Name ": CREATE group %s not found\n", w+6);
350 }
351 } else if (strncasecmp(w, "mode=", 5) == 0) {
352 if (w[5] == 0) {
353 fprintf(stderr, Name ": missing CREATE mode\n");
354 continue;
355 }
356 createinfo.mode = strtoul(w+5, &ep, 8);
357 if (*ep != 0) {
358 createinfo.mode = 0600;
359 fprintf(stderr, Name ": unrecognised CREATE mode %s\n",
360 w+5);
361 }
362 } else if (strncasecmp(w, "metadata=", 9) == 0) {
363 /* style of metadata to use by default */
364 int i;
365 for (i=0; superlist[i] && !createinfo.supertype; i++)
366 createinfo.supertype =
367 superlist[i]->match_metadata_desc(w+9);
368 if (!createinfo.supertype)
369 fprintf(stderr, Name ": metadata format %s unknown, ignoring\n",
370 w+9);
371 } else if (strncasecmp(w, "symlinks=yes", 12) == 0)
372 createinfo.symlinks = 1;
373 else if (strncasecmp(w, "symlinks=no", 11) == 0)
374 createinfo.symlinks = 0;
375 else {
376 fprintf(stderr, Name ": unrecognised word on CREATE line: %s\n",
377 w);
378 }
379 }
380 }
381
382 void devline(char *line)
383 {
384 char *w;
385 struct conf_dev *cd;
386
387 for (w=dl_next(line); w != line; w=dl_next(w)) {
388 if (w[0] == '/' || strcasecmp(w, "partitions") == 0) {
389 cd = malloc(sizeof(*cd));
390 cd->name = strdup(w);
391 cd->next = cdevlist;
392 cdevlist = cd;
393 } else {
394 fprintf(stderr, Name ": unreconised word on DEVICE line: %s\n",
395 w);
396 }
397 }
398 }
399
400 mddev_ident_t mddevlist = NULL;
401 mddev_ident_t *mddevlp = &mddevlist;
402
403 void arrayline(char *line)
404 {
405 char *w;
406
407 struct mddev_ident_s mis;
408 mddev_ident_t mi;
409
410 mis.uuid_set = 0;
411 mis.super_minor = UnSet;
412 mis.level = UnSet;
413 mis.raid_disks = UnSet;
414 mis.spare_disks = 0;
415 mis.devices = NULL;
416 mis.devname = NULL;
417 mis.spare_group = NULL;
418 mis.autof = 0;
419 mis.next = NULL;
420 mis.st = NULL;
421 mis.bitmap_fd = -1;
422 mis.bitmap_file = NULL;
423 mis.name[0] = 0;
424
425 for (w=dl_next(line); w!=line; w=dl_next(w)) {
426 if (w[0] == '/') {
427 if (mis.devname)
428 fprintf(stderr, Name ": only give one device per ARRAY line: %s and %s\n",
429 mis.devname, w);
430 else mis.devname = w;
431 } else if (strncasecmp(w, "uuid=", 5)==0 ) {
432 if (mis.uuid_set)
433 fprintf(stderr, Name ": only specify uuid once, %s ignored.\n",
434 w);
435 else {
436 if (parse_uuid(w+5, mis.uuid))
437 mis.uuid_set = 1;
438 else
439 fprintf(stderr, Name ": bad uuid: %s\n", w);
440 }
441 } else if (strncasecmp(w, "super-minor=", 12)==0 ) {
442 if (mis.super_minor != UnSet)
443 fprintf(stderr, Name ": only specify super-minor once, %s ignored.\n",
444 w);
445 else {
446 char *endptr;
447 mis.super_minor= strtol(w+12, &endptr, 10);
448 if (w[12]==0 || endptr[0]!=0 || mis.super_minor < 0) {
449 fprintf(stderr, Name ": invalid super-minor number: %s\n",
450 w);
451 mis.super_minor = UnSet;
452 }
453 }
454 } else if (strncasecmp(w, "name=", 5)==0) {
455 if (mis.name[0])
456 fprintf(stderr, Name ": only specify name once, %s ignored.\n",
457 w);
458 else if (strlen(w+5) > 32)
459 fprintf(stderr, Name ": name too long, ignoring %s\n", w);
460 else
461 strcpy(mis.name, w+5);
462
463 } else if (strncasecmp(w, "bitmap=", 7) == 0) {
464 if (mis.bitmap_file)
465 fprintf(stderr, Name ": only specify bitmap file once. %s ignored\n",
466 w);
467 else
468 mis.bitmap_file = strdup(w+7);
469
470 } else if (strncasecmp(w, "devices=", 8 ) == 0 ) {
471 if (mis.devices)
472 fprintf(stderr, Name ": only specify devices once (use a comma separated list). %s ignored\n",
473 w);
474 else
475 mis.devices = strdup(w+8);
476 } else if (strncasecmp(w, "spare-group=", 12) == 0 ) {
477 if (mis.spare_group)
478 fprintf(stderr, Name ": only specify one spare group per array. %s ignored.\n",
479 w);
480 else
481 mis.spare_group = strdup(w+12);
482 } else if (strncasecmp(w, "level=", 6) == 0 ) {
483 /* this is mainly for compatability with --brief output */
484 mis.level = map_name(pers, w+6);
485 } else if (strncasecmp(w, "disks=", 6) == 0 ) {
486 /* again, for compat */
487 mis.raid_disks = atoi(w+6);
488 } else if (strncasecmp(w, "num-devices=", 12) == 0 ) {
489 /* again, for compat */
490 mis.raid_disks = atoi(w+12);
491 } else if (strncasecmp(w, "spares=", 7) == 0 ) {
492 /* for warning if not all spares present */
493 mis.spare_disks = atoi(w+7);
494 } else if (strncasecmp(w, "metadata=", 9) == 0) {
495 /* style of metadata on the devices. */
496 int i;
497
498 for(i=0; superlist[i] && !mis.st; i++)
499 mis.st = superlist[i]->match_metadata_desc(w+9);
500
501 if (!mis.st)
502 fprintf(stderr, Name ": metadata format %s unknown, ignored.\n", w+9);
503 } else if (strncasecmp(w, "auto=", 5) == 0 ) {
504 /* whether to create device special files as needed */
505 mis.autof = parse_auto(w+5, "auto type", 0);
506 } else {
507 fprintf(stderr, Name ": unrecognised word on ARRAY line: %s\n",
508 w);
509 }
510 }
511 if (mis.devname == NULL)
512 fprintf(stderr, Name ": ARRAY line with no device\n");
513 else if (mis.uuid_set == 0 && mis.devices == NULL && mis.super_minor == UnSet && mis.name[0] == 0)
514 fprintf(stderr, Name ": ARRAY line %s has no identity information.\n", mis.devname);
515 else {
516 mi = malloc(sizeof(*mi));
517 *mi = mis;
518 mi->devname = strdup(mis.devname);
519 mi->next = NULL;
520 *mddevlp = mi;
521 mddevlp = &mi->next;
522 }
523 }
524
525 static char *alert_email = NULL;
526 void mailline(char *line)
527 {
528 char *w;
529
530 for (w=dl_next(line); w != line ; w=dl_next(w)) {
531 if (alert_email == NULL)
532 alert_email = strdup(w);
533 else
534 fprintf(stderr, Name ": excess address on MAIL line: %s - ignored\n",
535 w);
536 }
537 }
538
539 static char *alert_mail_from = NULL;
540 void mailfromline(char *line)
541 {
542 char *w;
543
544 for (w=dl_next(line); w != line ; w=dl_next(w)) {
545 if (alert_mail_from == NULL)
546 alert_mail_from = strdup(w);
547 else {
548 char *t= NULL;
549 asprintf(&t, "%s %s", alert_mail_from, w);
550 free(alert_mail_from);
551 alert_mail_from = t;
552 }
553 }
554 }
555
556
557 static char *alert_program = NULL;
558 void programline(char *line)
559 {
560 char *w;
561
562 for (w=dl_next(line); w != line ; w=dl_next(w)) {
563 if (alert_program == NULL)
564 alert_program = strdup(w);
565 else
566 fprintf(stderr, Name ": excess program on PROGRAM line: %s - ignored\n",
567 w);
568 }
569 }
570
571 static char *home_host = NULL;
572 void homehostline(char *line)
573 {
574 char *w;
575
576 for (w=dl_next(line); w != line ; w=dl_next(w)) {
577 if (home_host == NULL)
578 home_host = strdup(w);
579 else
580 fprintf(stderr, Name ": excess host name on HOMEHOST line: %s - ignored\n",
581 w);
582 }
583 }
584
585
586 int loaded = 0;
587
588 static char *conffile = NULL;
589 void set_conffile(char *file)
590 {
591 conffile = file;
592 }
593
594 void load_conffile(void)
595 {
596 FILE *f;
597 char *line;
598
599 if (loaded) return;
600 if (conffile == NULL)
601 conffile = DefaultConfFile;
602
603 if (strcmp(conffile, "none") == 0) {
604 loaded = 1;
605 return;
606 }
607 if (strcmp(conffile, "partitions")==0) {
608 char *list = dl_strdup("DEV");
609 dl_init(list);
610 dl_add(list, dl_strdup("partitions"));
611 devline(list);
612 free_line(list);
613 loaded = 1;
614 return;
615 }
616 f = fopen(conffile, "r");
617 /* Debian chose to relocate mdadm.conf into /etc/mdadm/.
618 * To allow Debian users to compile from clean source and still
619 * have a working mdadm, we read /etc/mdadm/mdadm.conf
620 * if /etc/mdadm.conf doesn't exist
621 */
622 if (f == NULL &&
623 conffile == DefaultConfFile) {
624 f = fopen(DefaultAltConfFile, "r");
625 if (f)
626 conffile = DefaultAltConfFile;
627 }
628 if (f == NULL)
629 return;
630
631 loaded = 1;
632 while ((line=conf_line(f))) {
633 switch(match_keyword(line)) {
634 case Devices:
635 devline(line);
636 break;
637 case Array:
638 arrayline(line);
639 break;
640 case Mailaddr:
641 mailline(line);
642 break;
643 case Mailfrom:
644 mailfromline(line);
645 break;
646 case Program:
647 programline(line);
648 break;
649 case CreateDev:
650 createline(line);
651 break;
652 case Homehost:
653 homehostline(line);
654 break;
655 default:
656 fprintf(stderr, Name ": Unknown keyword %s\n", line);
657 }
658 free_line(line);
659 }
660
661 fclose(f);
662
663 /* printf("got file\n"); */
664 }
665
666 char *conf_get_mailaddr(void)
667 {
668 load_conffile();
669 return alert_email;
670 }
671
672 char *conf_get_mailfrom(void)
673 {
674 load_conffile();
675 return alert_mail_from;
676 }
677
678 char *conf_get_program(void)
679 {
680 load_conffile();
681 return alert_program;
682 }
683
684 char *conf_get_homehost(void)
685 {
686 load_conffile();
687 return home_host;
688 }
689
690 struct createinfo *conf_get_create_info(void)
691 {
692 load_conffile();
693 return &createinfo;
694 }
695
696 mddev_ident_t conf_get_ident(char *dev)
697 {
698 mddev_ident_t rv;
699 load_conffile();
700 rv = mddevlist;
701 while (dev && rv && strcmp(dev, rv->devname)!=0)
702 rv = rv->next;
703 return rv;
704 }
705
706 mddev_dev_t conf_get_devs()
707 {
708 glob_t globbuf;
709 struct conf_dev *cd;
710 int flags = 0;
711 static mddev_dev_t dlist = NULL;
712 unsigned int i;
713
714 while (dlist) {
715 mddev_dev_t t = dlist;
716 dlist = dlist->next;
717 free(t->devname);
718 free(t);
719 }
720
721 load_conffile();
722
723 if (cdevlist == NULL)
724 /* default to 'partitions */
725 dlist = load_partitions();
726
727 for (cd=cdevlist; cd; cd=cd->next) {
728 if (strcasecmp(cd->name, "partitions")==0 && dlist == NULL)
729 dlist = load_partitions();
730 else {
731 glob(cd->name, flags, NULL, &globbuf);
732 flags |= GLOB_APPEND;
733 }
734 }
735 if (flags & GLOB_APPEND) {
736 for (i=0; i<globbuf.gl_pathc; i++) {
737 mddev_dev_t t = malloc(sizeof(*t));
738 t->devname = strdup(globbuf.gl_pathv[i]);
739 t->next = dlist;
740 t->used = 0;
741 dlist = t;
742 /* printf("one dev is %s\n", t->devname);*/
743 }
744 globfree(&globbuf);
745 }
746
747 return dlist;
748 }
749
750 int match_oneof(char *devices, char *devname)
751 {
752 /* check if one of the comma separated patterns in devices
753 * matches devname
754 */
755
756
757 while (devices && *devices) {
758 char patn[1024];
759 char *p = devices;
760 devices = strchr(devices, ',');
761 if (!devices)
762 devices = p + strlen(p);
763 if (devices-p < 1024) {
764 strncpy(patn, p, devices-p);
765 patn[devices-p] = 0;
766 if (fnmatch(patn, devname, FNM_PATHNAME)==0)
767 return 1;
768 }
769 if (*devices == ',')
770 devices++;
771 }
772 return 0;
773 }