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