sbin/vinum/vinumparser.c

   1 /*-
   2  * Copyright (c) 1997, 1998
   3  *      Nan Yang Computer Services Limited.  All rights reserved.
   4  *
   5  *  This software is distributed under the so-called ``Berkeley
   6  *  License'':
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by Nan Yang Computer
  19  *      Services Limited.
  20  * 4. Neither the name of the Company nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * This software is provided ``as is'', and any express or implied
  25  * warranties, including, but not limited to, the implied warranties of
  26  * merchantability and fitness for a particular purpose are disclaimed.
  27  * In no event shall the company or contributors be liable for any
  28  * direct, indirect, incidental, special, exemplary, or consequential
  29  * damages (including, but not limited to, procurement of substitute
  30  * goods or services; loss of use, data, or profits; or business
  31  * interruption) however caused and on any theory of liability, whether
  32  * in contract, strict liability, or tort (including negligence or
  33  * otherwise) arising in any way out of the use of this software, even if
  34  * advised of the possibility of such damage.
  35  *
  36  * $Id: vinumparser.c,v 1.21 2000/12/20 03:44:13 grog Exp grog $
  37  * $FreeBSD: src/sys/dev/vinum/vinumparser.c,v 1.20.2.5 2001/05/28 05:56:27 grog Exp $
  38  * $DragonFly: src/sbin/vinum/vinumparser.c,v 1.6 2005/01/25 23:09:42 joerg Exp $
  39  */
  40
  41 /*
  42  * This file contains the parser for the configuration routines.  It's used
  43  * both in the kernel and in the user interface program, thus the separate file.
  44  */
  45
  46 /*
  47  * Go through a text and split up into text tokens.  These are either non-blank
  48  * sequences, or any sequence (except \0) enclosed in ' or ".  Embedded ' or
  49  * " characters may be escaped by \, which otherwise has no special meaning.
  50  *
  51  * Delimit by following with a \0, and return pointers to the starts at token [].
  52  * Return the number of tokens found as the return value.
  53  *
  54  * This method has the restriction that a closing " or ' must be followed by
  55  * grey space.
  56  *
  57  * Error conditions are end of line before end of quote, or no space after
  58  * a closing quote.  In this case, tokenize() returns -1.
  59  */
  60
  61 #include <sys/param.h>
  62 #include <dev/raid/vinum/vinumkw.h>
  63 #include <ctype.h>
  64 #include <errno.h>
  65 #include <fcntl.h>
  66 #define iswhite isspace                                     /* use the ctype macro */
  67
  68 /* enum keyword is defined in vinumvar.h */
  69
  70 #define keypair(x) { #x, kw_##x }                           /* create pair "foo", kw_foo */
  71 #define flagkeypair(x) { "-"#x, kw_##x }                    /* create pair "-foo", kw_foo */
  72 #define KEYWORDSET(x) {sizeof (x) / sizeof (struct _keywords), x}
  73
  74 /* Normal keywords.  These are all the words that vinum knows. */
  75 struct _keywords keywords[] =
  76 {keypair(drive),
  77     keypair(partition),
  78     keypair(sd),
  79     keypair(subdisk),
  80     keypair(plex),
  81     keypair(volume),
  82     keypair(vol),
  83     keypair(setupstate),
  84     keypair(readpol),
  85     keypair(org),
  86     keypair(name),
  87     keypair(writethrough),
  88     keypair(writeback),
  89     keypair(raw),
  90     keypair(device),
  91     keypair(concat),
  92     keypair(raid4),
  93     keypair(raid5),
  94     keypair(striped),
  95     keypair(plexoffset),
  96     keypair(driveoffset),
  97     keypair(length),
  98     keypair(len),
  99     keypair(size),
 100     keypair(state),
 101     keypair(round),
 102     keypair(prefer),
 103     keypair(rename),
 104     keypair(detached),
 105 #ifdef VINUMDEBUG
 106     keypair(debug),
 107 #endif
 108     keypair(stripe),
 109     keypair(mirror),
 110     keypair(attach),
 111     keypair(detach),
 112     keypair(printconfig),
 113     keypair(saveconfig),
 114     keypair(replace),
 115     keypair(create),
 116     keypair(read),
 117     keypair(modify),
 118     keypair(list),
 119     keypair(l),
 120     keypair(ld),
 121     keypair(ls),
 122     keypair(lp),
 123     keypair(lv),
 124     keypair(info),
 125     keypair(set),
 126     keypair(rm),
 127     keypair(mv),
 128     keypair(move),
 129     keypair(init),
 130     keypair(label),
 131     keypair(resetconfig),
 132     keypair(start),
 133     keypair(stop),
 134     keypair(makedev),
 135     keypair(help),
 136     keypair(quit),
 137     keypair(setdaemon),
 138     keypair(getdaemon),
 139     keypair(max),
 140     keypair(replace),
 141     keypair(readpol),
 142     keypair(resetstats),
 143     keypair(setstate),
 144     keypair(checkparity),
 145     keypair(rebuildparity),
 146     keypair(dumpconfig),
 147     keypair(retryerrors)
 148 };
 149 struct keywordset keyword_set = KEYWORDSET(keywords);
 150
 151 struct _keywords flag_keywords[] =
 152 {flagkeypair(f),
 153     flagkeypair(d),
 154     flagkeypair(v),
 155     flagkeypair(s),
 156     flagkeypair(r),
 157     flagkeypair(w)
 158 };
 159 struct keywordset flag_set = KEYWORDSET(flag_keywords);
 160
 161 /*
 162  * Take a blank separated list of tokens and turn it into a list of
 163  * individual nul-delimited strings.  Build a list of pointers at
 164  * token, which must have enough space for the tokens.  Return the
 165  * number of tokens, or -1 on error (typically a missing string
 166  * delimiter).
 167  */
 168 int
 169 tokenize(char *cptr, char *token[])
 170 {
 171     char delim;                                             /* delimiter for searching for the partner */
 172     int tokennr;                                            /* index of this token */
 173     tokennr = 0;                                            /* none found yet */
 174
 175     for (;;) {
 176         while (iswhite(*cptr))
 177             cptr++;                                         /* skip initial white space */
 178         if ((*cptr == '\0') || (*cptr == '\n') || (*cptr == '#')) /* end of line */
 179             return tokennr;                                 /* return number of tokens found */
 180         delim = *cptr;
 181         token[tokennr] = cptr;                              /* point to it */
 182         tokennr++;                                          /* one more */
 183         /* XXX this is broken.  It leaves superfluous \\ characters in the text */
 184         if ((delim == '\'') || (delim == '"')) {            /* delimitered */
 185             for (;;) {
 186                 cptr++;
 187                 if ((*cptr == delim) && (cptr[-1] != '\\')) { /* found the partner */
 188                     cptr++;                                 /* move on past */
 189                     if (!iswhite(*cptr))                    /* error, no space after closing quote */
 190                         return -1;
 191                     *cptr++ = '\0';                         /* delimit */
 192                 } else if ((*cptr == '\0') || (*cptr == '\n')) /* end of line */
 193                     return -1;
 194             }
 195         } else {                                            /* not quoted */
 196             while ((*cptr != '\0') && (!iswhite(*cptr)) && (*cptr != '\n'))
 197                 cptr++;
 198             if (*cptr != '\0')                              /* not end of the line, */
 199                 *cptr++ = '\0';                             /* delimit and move to the next */
 200         }
 201     }
 202 }
 203
 204 /* Find a keyword and return an index */
 205 enum keyword
 206 get_keyword(char *name, struct keywordset *keywordset)
 207 {
 208     int i;
 209     struct _keywords *keywords = keywordset->k;             /* point to the keywords */
 210     if (name != NULL) {                                     /* parameter exists */
 211         for (i = 0; i < keywordset->size; i++)
 212             if (!strcmp(name, keywords[i].name))
 213                 return (enum keyword) keywords[i].keyword;
 214     }
 215     return kw_invalid_keyword;
 216 }