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