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                 mddev_dev_t d;
 218
 219                 buf[1023] = '\0';
 220                 if (buf[0] != ' ')
 221                         continue;
 222                 major = strtoul(buf, &mp, 10);
 223                 if (mp == buf || *mp != ' ')
 224                         continue;
 225                 minor = strtoul(mp, NULL, 10);
 226
 227                 name = map_dev(major, minor);
 228                 if (!name) {
 229                         snprintf(buf, 1024, "%d:%d", major, minor);
 230                         name = buf;
 231                 }
 232
 233                 d = malloc(sizeof(*d));
 234                 d->devname = strdup(name);
 235                 d->next = rv;
 236                 rv = d;
 237         }
 238         fclose(f);
 239         return rv;
 240 }
 241
 242
 243 void devline(char *line)
 244 {
 245         char *w;
 246         struct conf_dev *cd;
 247
 248         for (w=dl_next(line); w != line; w=dl_next(w)) {
 249                 if (w[0] == '/' || strcasecmp(w, "partitions") == 0) {
 250                         cd = malloc(sizeof(*cd));
 251                         cd->name = strdup(w);
 252                         cd->next = cdevlist;
 253                         cdevlist = cd;
 254                 } else {
 255                         fprintf(stderr, Name ": unreconised word on DEVICE line: %s\n",
 256                                 w);
 257                 }
 258         }
 259 }
 260
 261 mddev_ident_t mddevlist = NULL;
 262 mddev_ident_t *mddevlp = &mddevlist;
 263
 264 void arrayline(char *line)
 265 {
 266         char *w;
 267
 268         struct mddev_ident_s mis;
 269         mddev_ident_t mi;
 270
 271         mis.uuid_set = 0;
 272         mis.super_minor = UnSet;
 273         mis.level = UnSet;
 274         mis.raid_disks = UnSet;
 275         mis.spare_disks = UnSet;
 276         mis.devices = NULL;
 277         mis.devname = NULL;
 278         mis.spare_group = NULL;
 279         mis.autof = 0;
 280         mis.next = NULL;
 281         mis.st = NULL;
 282         mis.bitmap_fd = -1;
 283         mis.name[0] = 0;
 284
 285         for (w=dl_next(line); w!=line; w=dl_next(w)) {
 286                 if (w[0] == '/') {
 287                         if (mis.devname)
 288                                 fprintf(stderr, Name ": only give one device per ARRAY line: %s and %s\n",
 289                                         mis.devname, w);
 290                         else mis.devname = w;
 291                 } else if (strncasecmp(w, "uuid=", 5)==0 ) {
 292                         if (mis.uuid_set)
 293                                 fprintf(stderr, Name ": only specify uuid once, %s ignored.\n",
 294                                         w);
 295                         else {
 296                                 if (parse_uuid(w+5, mis.uuid))
 297                                         mis.uuid_set = 1;
 298                                 else
 299                                         fprintf(stderr, Name ": bad uuid: %s\n", w);
 300                         }
 301                 } else if (strncasecmp(w, "super-minor=", 12)==0 ) {
 302                         if (mis.super_minor != UnSet)
 303                                 fprintf(stderr, Name ": only specify super-minor once, %s ignored.\n",
 304                                         w);
 305                         else {
 306                                 char *endptr;
 307                                 mis.super_minor= strtol(w+12, &endptr, 10);
 308                                 if (w[12]==0 || endptr[0]!=0 || mis.super_minor < 0) {
 309                                         fprintf(stderr, Name ": invalid super-minor number: %s\n",
 310                                                 w);
 311                                         mis.super_minor = UnSet;
 312                                 }
 313                         }
 314                 } else if (strncasecmp(w, "name=", 5)==0) {
 315                         if (mis.name[0])
 316                                 fprintf(stderr, Name ": only specify name once, %s ignored.\n",
 317                                         w);
 318                         else if (strlen(w+5) > 32)
 319                                 fprintf(stderr, Name ": name too long, ignoring %s\n", w);
 320                         else
 321                                 strcpy(mis.name, w+5);
 322
 323                 } else if (strncasecmp(w, "devices=", 8 ) == 0 ) {
 324                         if (mis.devices)
 325                                 fprintf(stderr, Name ": only specify devices once (use a comma separated list). %s ignored\n",
 326                                         w);
 327                         else
 328                                 mis.devices = strdup(w+8);
 329                 } else if (strncasecmp(w, "spare-group=", 12) == 0 ) {
 330                         if (mis.spare_group)
 331                                 fprintf(stderr, Name ": only specify one spare group per array. %s ignored.\n",
 332                                         w);
 333                         else
 334                                 mis.spare_group = strdup(w+12);
 335                 } else if (strncasecmp(w, "level=", 6) == 0 ) {
 336                         /* this is mainly for compatability with --brief output */
 337                         mis.level = map_name(pers, w+6);
 338                 } else if (strncasecmp(w, "disks=", 6) == 0 ) {
 339                         /* again, for compat */
 340                         mis.raid_disks = atoi(w+6);
 341                 } else if (strncasecmp(w, "num-devices=", 12) == 0 ) {
 342                         /* again, for compat */
 343                         mis.raid_disks = atoi(w+12);
 344                 } else if (strncasecmp(w, "spares=", 7) == 0 ) {
 345                         /* for warning if not all spares present */
 346                         mis.spare_disks = atoi(w+7);
 347                 } else if (strncasecmp(w, "metadata=", 9) == 0) {
 348                         /* style of metadata on the devices. */
 349                         int i;
 350
 351                         for(i=0; superlist[i] && !mis.st; i++)
 352                                 mis.st = superlist[i]->match_metadata_desc(w+9);
 353
 354                         if (!mis.st)
 355                                 fprintf(stderr, Name ": metadata format %s unknown, ignored.\n", w+9);
 356                 } else if (strncasecmp(w, "auto=", 5) == 0 ) {
 357                         /* whether to create device special files as needed */
 358                         if (strcasecmp(w+5, "no")==0)
 359                                 mis.autof = 0;
 360                         else if (strcasecmp(w+5,"yes")==0 || strcasecmp(w+5,"md")==0)
 361                                 mis.autof = -1;
 362                         else {
 363                                 /* There might be digits, and maybe a hyphen, at the end */
 364                                 char *e = w+5 + strlen(w+5);
 365                                 int num = 4;
 366                                 int len;
 367                                 while (e > w+5 && isdigit(e[-1]))
 368                                         e--;
 369                                 if (*e) {
 370                                         num = atoi(e);
 371                                         if (num <= 0) num = 1;
 372                                 }
 373                                 if (e > w+5 && e[-1] == '-')
 374                                         e--;
 375                                 len = e - (w+5);
 376                                 if ((len == 3 && strncasecmp(w+5,"mdp",3)==0) ||
 377                                     (len == 1 && strncasecmp(w+5,"p",1)==0) ||
 378                                     (len >= 4 && strncasecmp(w+5,"part",4)==0))
 379                                         mis.autof = num;
 380                                 else
 381                                         fprintf(stderr, Name ": auto type of \"%s\" ignored for %s\n",
 382                                                 w+5, mis.devname?mis.devname:"unlabeled-array");
 383                         }
 384                 } else {
 385                         fprintf(stderr, Name ": unrecognised word on ARRAY line: %s\n",
 386                                 w);
 387                 }
 388         }
 389         if (mis.devname == NULL)
 390                 fprintf(stderr, Name ": ARRAY line with no device\n");
 391         else if (mis.uuid_set == 0 && mis.devices == NULL && mis.super_minor == UnSet && mis.name[0] == 0)
 392                 fprintf(stderr, Name ": ARRAY line %s has no identity information.\n", mis.devname);
 393         else {
 394                 mi = malloc(sizeof(*mi));
 395                 *mi = mis;
 396                 mi->devname = strdup(mis.devname);
 397                 mi->next = NULL;
 398                 *mddevlp = mi;
 399                 mddevlp = &mi->next;
 400         }
 401 }
 402
 403 static char *alert_email = NULL;
 404 void mailline(char *line)
 405 {
 406         char *w;
 407
 408         for (w=dl_next(line); w != line ; w=dl_next(w)) {
 409                 if (alert_email == NULL)
 410                         alert_email = strdup(w);
 411                 else
 412                         fprintf(stderr, Name ": excess address on MAIL line: %s - ignored\n",
 413                                 w);
 414         }
 415 }
 416
 417
 418 static char *alert_program = NULL;
 419 void programline(char *line)
 420 {
 421         char *w;
 422
 423         for (w=dl_next(line); w != line ; w=dl_next(w)) {
 424                 if (alert_program == NULL)
 425                         alert_program = strdup(w);
 426                 else
 427                         fprintf(stderr, Name ": excess program on PROGRAM line: %s - ignored\n",
 428                                 w);
 429         }
 430 }
 431
 432
 433 int loaded = 0;
 434
 435 void load_conffile(char *conffile)
 436 {
 437         FILE *f;
 438         char *line;
 439
 440         if (loaded) return;
 441         if (conffile == NULL)
 442                 conffile = DefaultConfFile;
 443
 444         if (strcmp(conffile, "none") == 0) {
 445                 loaded = 1;
 446                 return;
 447         }
 448         if (strcmp(conffile, "partitions")==0) {
 449                 char *list = dl_strdup("DEV");
 450                 dl_init(list);
 451                 dl_add(list, dl_strdup("partitions"));
 452                 devline(list);
 453                 free_line(list);
 454                 loaded = 1;
 455                 return;
 456         }
 457         f = fopen(conffile, "r");
 458         if (f ==NULL)
 459                 return;
 460
 461         loaded = 1;
 462         while ((line=conf_line(f))) {
 463                 switch(match_keyword(line)) {
 464                 case 0: /* DEVICE */
 465                         devline(line);
 466                         break;
 467                 case 1: /* ARRAY */
 468                         arrayline(line);
 469                         break;
 470                 case 2: /* MAIL */
 471                         mailline(line);
 472                         break;
 473                 case 3: /* PROGRAM */
 474                         programline(line);
 475                         break;
 476                 default:
 477                         fprintf(stderr, Name ": Unknown keyword %s\n", line);
 478                 }
 479                 free_line(line);
 480         }
 481
 482         fclose(f);
 483
 484 /*    printf("got file\n"); */
 485 }
 486
 487 char *conf_get_mailaddr(char *conffile)
 488 {
 489         load_conffile(conffile);
 490         return alert_email;
 491 }
 492
 493 char *conf_get_program(char *conffile)
 494 {
 495         load_conffile(conffile);
 496         return alert_program;
 497 }
 498
 499
 500 mddev_ident_t conf_get_ident(char *conffile, char *dev)
 501 {
 502         mddev_ident_t rv;
 503         load_conffile(conffile);
 504         rv = mddevlist;
 505         while (dev && rv && strcmp(dev, rv->devname)!=0)
 506                 rv = rv->next;
 507         return rv;
 508 }
 509
 510 mddev_dev_t conf_get_devs(char *conffile)
 511 {
 512         glob_t globbuf;
 513         struct conf_dev *cd;
 514         int flags = 0;
 515         static mddev_dev_t dlist = NULL;
 516         unsigned int i;
 517
 518         while (dlist) {
 519                 mddev_dev_t t = dlist;
 520                 dlist = dlist->next;
 521                 free(t->devname);
 522                 free(t);
 523         }
 524
 525         load_conffile(conffile);
 526
 527         for (cd=cdevlist; cd; cd=cd->next) {
 528                 if (strcasecmp(cd->name, "partitions")==0 && dlist == NULL)
 529                         dlist = load_partitions();
 530                 else {
 531                         glob(cd->name, flags, NULL, &globbuf);
 532                         flags |= GLOB_APPEND;
 533                 }
 534         }
 535         if (flags & GLOB_APPEND) {
 536                 for (i=0; i<globbuf.gl_pathc; i++) {
 537                         mddev_dev_t t = malloc(sizeof(*t));
 538                         t->devname = strdup(globbuf.gl_pathv[i]);
 539                         t->next = dlist;
 540                         dlist = t;
 541 /*      printf("one dev is %s\n", t->devname);*/
 542                 }
 543                 globfree(&globbuf);
 544         }
 545
 546         return dlist;
 547 }
 548
 549 int match_oneof(char *devices, char *devname)
 550 {
 551     /* check if one of the comma separated patterns in devices
 552      * matches devname
 553      */
 554
 555
 556     while (devices && *devices) {
 557         char patn[1024];
 558         char *p = devices;
 559         devices = strchr(devices, ',');
 560         if (!devices)
 561             devices = p + strlen(p);
 562         if (devices-p < 1024) {
 563                 strncpy(patn, p, devices-p);
 564                 patn[devices-p] = 0;
 565                 if (fnmatch(patn, devname, FNM_PATHNAME)==0)
 566                         return 1;
 567         }
 568         if (*devices == ',')
 569                 devices++;
 570     }
 571     return 0;
 572 }