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 mddev_dev_t load_partitions(void)
 206 {
 207         FILE *f = fopen("/proc/partitions", "r");
 208         char buf[1024];
 209         mddev_dev_t rv = NULL;
 210         if (f == NULL) {
 211                 fprintf(stderr, Name ": cannot open /proc/partitions\n");
 212                 return NULL;
 213         }
 214         while (fgets(buf, 1024, f)) {
 215                 int major, minor;
 216                 char *name, *mp;
 217                 buf[1023] = '\0';
 218                 if (buf[0] != ' ')
 219                         continue;
 220                 major = strtoul(buf, &mp, 10);
 221                 if (mp == buf || *mp != ' ')
 222                         continue;
 223                 minor = strtoul(mp, NULL, 10);
 224
 225                 name = map_dev(major, minor);
 226                 if (name) {
 227                         mddev_dev_t d;
 228
 229                         d = malloc(sizeof(*d));
 230                         d->devname = strdup(name);
 231                         d->next = rv;
 232                         rv = d;
 233                 }
 234         }
 235         fclose(f);
 236         return rv;
 237 }
 238
 239
 240 void devline(char *line)
 241 {
 242         char *w;
 243         struct conf_dev *cd;
 244
 245         for (w=dl_next(line); w != line; w=dl_next(w)) {
 246                 if (w[0] == '/' || strcasecmp(w, "partitions") == 0) {
 247                         cd = malloc(sizeof(*cd));
 248                         cd->name = strdup(w);
 249                         cd->next = cdevlist;
 250                         cdevlist = cd;
 251                 } else {
 252                         fprintf(stderr, Name ": unreconised word on DEVICE line: %s\n",
 253                                 w);
 254                 }
 255         }
 256 }
 257
 258 mddev_ident_t mddevlist = NULL;
 259 mddev_ident_t *mddevlp = &mddevlist;
 260
 261 void arrayline(char *line)
 262 {
 263         char *w;
 264
 265         struct mddev_ident_s mis;
 266         mddev_ident_t mi;
 267
 268         mis.uuid_set = 0;
 269         mis.super_minor = UnSet;
 270         mis.level = UnSet;
 271         mis.raid_disks = UnSet;
 272         mis.spare_disks = UnSet;
 273         mis.devices = NULL;
 274         mis.devname = NULL;
 275         mis.spare_group = NULL;
 276         mis.autof = 0;
 277         mis.next = NULL;
 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, "metadata=", 9) == 0) {
 333                         /* style of metadata on the devices. */
 334                         int i;
 335
 336                         for(i=0; superlist[i] && !mis.st; i++)
 337                                 mis.st = superlist[i]->match_metadata_desc(w+9);
 338
 339                         if (!mis.st)
 340                                 fprintf(stderr, Name ": metadata format %s unknown, ignored.\n", w+9);
 341                 } else if (strncasecmp(w, "auto=", 5) == 0 ) {
 342                         /* whether to create device special files as needed */
 343                         if (strcasecmp(w+5, "no")==0)
 344                                 mis.autof = 0;
 345                         else if (strcasecmp(w+5,"yes")==0 || strcasecmp(w+5,"md")==0)
 346                                 mis.autof = -1;
 347                         else {
 348                                 /* There might be digits, and maybe a hyphen, at the end */
 349                                 char *e = w+5 + strlen(w+5);
 350                                 int num = 4;
 351                                 int len;
 352                                 while (e > w+5 && isdigit(e[-1]))
 353                                         e--;
 354                                 if (*e) {
 355                                         num = atoi(e);
 356                                         if (num <= 0) num = 1;
 357                                 }
 358                                 if (e > w+5 && e[-1] == '-')
 359                                         e--;
 360                                 len = e - (w+5);
 361                                 if ((len == 3 && strncasecmp(w+5,"mdp",3)==0) ||
 362                                     (len == 1 && strncasecmp(w+5,"p",1)==0) ||
 363                                     (len >= 4 && strncasecmp(w+5,"part",4)==0))
 364                                         mis.autof = num;
 365                                 else
 366                                         fprintf(stderr, Name ": auto type of \"%s\" ignored for %s\n",
 367                                                 w+5, mis.devname?mis.devname:"unlabeled-array");
 368                         }
 369                 } else {
 370                         fprintf(stderr, Name ": unrecognised word on ARRAY line: %s\n",
 371                                 w);
 372                 }
 373         }
 374         if (mis.devname == NULL)
 375                 fprintf(stderr, Name ": ARRAY line with no device\n");
 376         else if (mis.uuid_set == 0 && mis.devices == NULL && mis.super_minor == UnSet)
 377                 fprintf(stderr, Name ": ARRAY line %s has no identity information.\n", mis.devname);
 378         else {
 379                 mi = malloc(sizeof(*mi));
 380                 *mi = mis;
 381                 mi->devname = strdup(mis.devname);
 382                 mi->next = NULL;
 383                 *mddevlp = mi;
 384                 mddevlp = &mi->next;
 385         }
 386 }
 387
 388 static char *alert_email = NULL;
 389 void mailline(char *line)
 390 {
 391         char *w;
 392
 393         for (w=dl_next(line); w != line ; w=dl_next(w)) {
 394                 if (alert_email == NULL)
 395                         alert_email = strdup(w);
 396                 else
 397                         fprintf(stderr, Name ": excess address on MAIL line: %s - ignored\n",
 398                                 w);
 399         }
 400 }
 401
 402
 403 static char *alert_program = NULL;
 404 void programline(char *line)
 405 {
 406         char *w;
 407
 408         for (w=dl_next(line); w != line ; w=dl_next(w)) {
 409                 if (alert_program == NULL)
 410                         alert_program = strdup(w);
 411                 else
 412                         fprintf(stderr, Name ": excess program on PROGRAM line: %s - ignored\n",
 413                                 w);
 414         }
 415 }
 416
 417
 418 int loaded = 0;
 419
 420 void load_conffile(char *conffile)
 421 {
 422         FILE *f;
 423         char *line;
 424
 425         if (loaded) return;
 426         if (conffile == NULL)
 427                 conffile = DefaultConfFile;
 428
 429         if (strcmp(conffile, "none") == 0) {
 430                 loaded = 1;
 431                 return;
 432         }
 433         if (strcmp(conffile, "partitions")==0) {
 434                 char *list = dl_strdup("DEV");
 435                 dl_init(list);
 436                 dl_add(list, dl_strdup("partitions"));
 437                 devline(list);
 438                 free_line(list);
 439                 loaded = 1;
 440                 return;
 441         }
 442         f = fopen(conffile, "r");
 443         if (f ==NULL)
 444                 return;
 445
 446         loaded = 1;
 447         while ((line=conf_line(f))) {
 448                 switch(match_keyword(line)) {
 449                 case 0: /* DEVICE */
 450                         devline(line);
 451                         break;
 452                 case 1: /* ARRAY */
 453                         arrayline(line);
 454                         break;
 455                 case 2: /* MAIL */
 456                         mailline(line);
 457                         break;
 458                 case 3: /* PROGRAM */
 459                         programline(line);
 460                         break;
 461                 default:
 462                         fprintf(stderr, Name ": Unknown keyword %s\n", line);
 463                 }
 464                 free_line(line);
 465         }
 466
 467         fclose(f);
 468
 469 /*    printf("got file\n"); */
 470 }
 471
 472 char *conf_get_mailaddr(char *conffile)
 473 {
 474         load_conffile(conffile);
 475         return alert_email;
 476 }
 477
 478 char *conf_get_program(char *conffile)
 479 {
 480         load_conffile(conffile);
 481         return alert_program;
 482 }
 483
 484
 485 mddev_ident_t conf_get_ident(char *conffile, char *dev)
 486 {
 487         mddev_ident_t rv;
 488         load_conffile(conffile);
 489         rv = mddevlist;
 490         while (dev && rv && strcmp(dev, rv->devname)!=0)
 491                 rv = rv->next;
 492         return rv;
 493 }
 494
 495 mddev_dev_t conf_get_devs(char *conffile)
 496 {
 497         glob_t globbuf;
 498         struct conf_dev *cd;
 499         int flags = 0;
 500         static mddev_dev_t dlist = NULL;
 501         unsigned int i;
 502
 503         while (dlist) {
 504                 mddev_dev_t t = dlist;
 505                 dlist = dlist->next;
 506                 free(t->devname);
 507                 free(t);
 508         }
 509
 510         load_conffile(conffile);
 511
 512         for (cd=cdevlist; cd; cd=cd->next) {
 513                 if (strcasecmp(cd->name, "partitions")==0 && dlist == NULL)
 514                         dlist = load_partitions();
 515                 else {
 516                         glob(cd->name, flags, NULL, &globbuf);
 517                         flags |= GLOB_APPEND;
 518                 }
 519         }
 520         if (flags & GLOB_APPEND) {
 521                 for (i=0; i<globbuf.gl_pathc; i++) {
 522                         mddev_dev_t t = malloc(sizeof(*t));
 523                         t->devname = strdup(globbuf.gl_pathv[i]);
 524                         t->next = dlist;
 525                         dlist = t;
 526 /*      printf("one dev is %s\n", t->devname);*/
 527                 }
 528                 globfree(&globbuf);
 529         }
 530
 531         return dlist;
 532 }
 533
 534 int match_oneof(char *devices, char *devname)
 535 {
 536     /* check if one of the comma separated patterns in devices
 537      * matches devname
 538      */
 539
 540
 541     while (devices && *devices) {
 542         char patn[1024];
 543         char *p = devices;
 544         devices = strchr(devices, ',');
 545         if (!devices)
 546             devices = p + strlen(p);
 547         if (devices-p < 1024) {
 548                 strncpy(patn, p, devices-p);
 549                 patn[devices-p] = 0;
 550                 if (fnmatch(patn, devname, FNM_PATHNAME)==0)
 551                         return 1;
 552         }
 553         if (*devices == ',')
 554                 devices++;
 555     }
 556     return 0;
 557 }