path: root/mdctl.c

/*
 * mdctl - manage Linux "md" devices aka RAID arrays.
 *
 * Copyright (C) 2001 Neil Brown <neilb@cse.unsw.edu.au>
 *
 *
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *    Author: Neil Brown
 *    Email: <neilb@cse.unsw.edu.au>
 *    Paper: Neil Brown
 *           School of Computer Science and Engineering
 *           The University of New South Wales
 *           Sydney, 2052
 *           Australia
 */

#include "mdctl.h"
#include "md_p.h"

int main(int argc, char *argv[])
{
    char mode = '\0';
    int opt;
    char *help_text;
    char *c;
    int rv;
    int i;

    int chunk = 0;
    int level = -10;
    int layout = -1;
    int raiddisks = 0;
    int sparedisks = 0;
    int uuid[4];
    int uuidset = 0;
    char *configfile = NULL;
    int scan = 0;
    char devmode = 0;
    int runstop = 0;
    int readonly = 0;
    char *mddev = NULL;
    char *subdev[MD_SB_DISKS];
    int devmodes[MD_SB_DISKS];
    int subdevs = 0;
    int verbose = 0;
    int force = 0;

    int mdfd = -1;

    while ((opt=getopt_long(argc, argv,
			    short_options, long_options,
			    NULL)) != -1) {
	
	switch(opt) {
	case '@': /* just incase they say --manage */
	case 'A':
	case 'B':
	case 'C':
	case 'D':
	case 'E':
	    /* setting mode - only once */
	    if (mode) {
		fprintf(stderr, "mdctl: --%s/-%c not allowed, mode already set to %s\n",
			long_options[opt-'A'+1].name,
			long_options[opt-'A'+1].val,
			long_options[mode-'A'+1].name);
		exit(2);
	    }
	    mode = opt;
	    continue;

	case 'h':
	    help_text = Help;
	    switch (mode) {
	    case 'C': help_text = Help_create; break;
	    case 'B': help_text = Help_build; break;
	    case 'A': help_text = Help_assemble; break;
	    }
	    fputs(help_text,stderr);
	    exit(0);

	case 'V':
	    fputs(Version, stderr);
	    exit(0);

	case 'v': verbose = 1;
		continue;

	case 1: /* an undecorated option - must be a device name.
		 * The first device is the "md" device unless scan
		 * has been set or mode is Examine or Detail
		 */
	    if (mddev == NULL && !scan && mode != 'E' && mode != 'D')
		mddev = optarg;
	    else {
		if (subdevs +1 >= MD_SB_DISKS) {
		    fprintf(stderr, "mdctl: too many devices at %s - current limit -s %d\n",
			    optarg, MD_SB_DISKS);
		    exit(2);
		}
		subdev[subdevs] = optarg;
		devmodes[subdevs] = devmode;
		subdevs++;
	    }
	    continue;

	case ':':
	case '?':
	    fputs(Usage, stderr);
	    exit(2);
	default:
	    /* force mode setting - @==manage if nothing else */
	    if (!mode) mode = '@';
	}

	/* We've got a mode, and opt is now something else which
	 * could depend on the mode */
#define O(a,b) ((a<<8)|b)
	switch (O(mode,opt)) {
	case O('C','c'):
	case O('B','c'): /* chunk or rounding */
	    if (chunk) {
		fprintf(stderr, "mdctl: chunk/rounding may only be specified once. "
			"Second value is %s.\n", optarg);
		exit(2);
	    }
	    chunk = strtol(optarg, &c, 10);
	    if (!optarg[0] || *c) {
		fprintf(stderr, "mdctl: invalid chunk/rounding value: %s\n",
			optarg);
		exit(2);
	    }
	    continue;

	case O('C','l'):
	case O('B','l'): /* set raid level*/
	    if (level != -10) {
		fprintf(stderr, "mdctl: raid level may only be set once.  "
			"Second value is %s.\n", optarg);
		exit(2);
	    }
	    if (strcmp(optarg,"linear")==0)
		level = -1;
	    else if (strlen(optarg)==1 && strchr("01245", optarg[0]))
		level = optarg[0]-'0';
	    else {
		fprintf(stderr, "mdctl: invalid raid level: %s\n",
			optarg);
		exit(2);
	    }
	    if (level > 0 && mode == 'B') {
		fprintf(stderr, "mdctl: Raid level %s not permitted with --build.\n",
			optarg);
		exit(2);
	    }
	    if (layout >=0 && level < 4) {
		fprintf(stderr, "mdctl: raid level %s is incompatible with layout setting\n",
			optarg);
		exit(2);
	    }
	    if (sparedisks > 0 && level < 1) {
		fprintf(stderr, "mdctl: raid level %s is incompatible with spare-disks setting.\n",
			optarg);
		exit(2);
	    }
	    continue;

	case O('C','p'): /* raid5 layout */
	    if (layout >= 0) {
		fprintf(stderr,"mdctl: layout may only be sent once.  "
			"Second value was %s\n", optarg);
		exit(2);
	    }
	    if (level > -10 && level < 4) {
		fprintf(stderr,"mdctl: layout is incompatible with raid levels below 4.\n");
		exit(2);
	    }
	    if (strcmp(optarg, "left-symmetric")==0 || strcmp(optarg,"ls")==0)
		layout = ALGORITHM_LEFT_SYMMETRIC;
	    else if (strcmp(optarg, "left-asymmetric")==0 || strcmp(optarg,"la")==0)
		layout = ALGORITHM_LEFT_ASYMMETRIC;
	    else if (strcmp(optarg, "right-symmetric")==0 || strcmp(optarg,"rs")==0)
		layout = ALGORITHM_RIGHT_SYMMETRIC;
	    else if (strcmp(optarg, "right-asymmetric")==0 || strcmp(optarg,"ra")==0)
		layout = ALGORITHM_RIGHT_ASYMMETRIC;
	    else {
		fprintf(stderr,"mdctl: %s is not a valid layout value\n",
			optarg);
		exit(2);
	    }
	    continue;

	case O('C','n'):
	case O('B','n'): /* number of raid disks */
	    if (raiddisks) {
		fprintf(stderr, "mdctl: raid-disks set twice: %d and %s\n",
			raiddisks, optarg);
		exit(2);
	    }
	    raiddisks = strtol(optarg, &c, 10);
	    if (!optarg[0] || *c || raiddisks<=0 || raiddisks > MD_SB_DISKS) {
		fprintf(stderr, "mdctl: invalid number of raid disks: %s\n",
			optarg);
		exit(2);
	    }
	    continue;

	case O('C','x'): /* number of spare (eXtra) discs */
	    if (sparedisks) {
		fprintf(stderr,"mdctl: spare-disks set twice: %d and %s\n",
			sparedisks, optarg);
		exit(2);
	    }
	    if (level > -10 && level < 1) {
		fprintf(stderr, "mdctl: spare-disks setting is incompatible with raid level %d\n",
			level);
		exit(2);
	    }
	    sparedisks = strtol(optarg, &c, 10);
	    if (!optarg[0] || *c || sparedisks < 0 || sparedisks > MD_SB_DISKS - raiddisks) {
		fprintf(stderr, "mdctl: invalid number of spare disks: %s\n",
			optarg);
		exit(2);
	    }
	    continue;

	    /* now for the Assemble options */
	case O('A','f'): /* force assembly */
		force = 1;
		continue;
	case O('A','u'): /* uuid of array */
	    if (uuidset) {
		fprintf(stderr, "mdctl: uuid cannot bet set twice.  "
			"Second value %s.\n", optarg);
		exit(2);
	    }
	    if (parse_uuid(optarg, uuid))
		uuidset = 1;
	    else {
		fprintf(stderr,"mdctl: Bad uuid: %s\n", optarg);
		exit(2);
	    }
	    continue;

	case O('A','c'): /* config file */
	    if (configfile) {
		fprintf(stderr, "mdctl: configfile cannot be set twice.  "
			"Second value is %s.\n", optarg);
		exit(2);
	    }
	    configfile = optarg;
	    /* FIXME possibly check that config file exists.  Even parse it */
	    continue;
	case O('A','s'): /* scan */
	    scan = 1;
	    continue;

	    /* now the general management options.  Some are applicable
	     * to other modes. None have arguments.
	     */
	case O('@','a'):
	case O('C','a'):
	case O('B','a'):
	case O('A','a'): /* add a drive */
	    devmode = 'a';
	    continue;
	case O('@','r'): /* remove a drive */
	    devmode = 'r';
	    continue;
	case O('@','f'): /* set faulty */
	case O('C','f'):
	    devmode = 'f';
	    continue;
	case O('@','R'):
	case O('A','R'):
	case O('B','R'):
	case O('C','R'): /* Run the array */
	    if (runstop < 0) {
		fprintf(stderr, "mdctl: Cannot both Stop and Run an array\n");
		exit(2);
	    }
	    runstop = 1;
	    continue;
	case O('@','S'):
	    if (runstop > 0) {
		fprintf(stderr, "mdctl: Cannot both Run and Stop an array\n");
		exit(2);
	    }
	    runstop = -1;
	    continue;

	case O('@','o'):
	    if (readonly < 0) {
		fprintf(stderr, "mdctl: Cannot have both readonly and readwrite\n");
		exit(2);
	    }
	    readonly = 1;
	    continue;
	case O('@','w'):
	    if (readonly > 0) {
		fprintf(stderr, "mkdctl: Cannot have both readwrite and readonly.\n");
		exit(2);
	    }
	    readonly = -1;
	    continue;
	}
	/* We have now processed all the valid options. Anything else is
	 * an error
	 */
	fprintf(stderr, "mdctl: option %c not valid in mode %c\n",
		opt, mode);
	exit(2);

    }

    if (!mode) {
	    fputs(Usage, stderr);
	    exit(2);
    }
    /* Ok, got the option parsing out of the way
     * hopefully it's mostly right but there might be some stuff
     * missing
     *
     * That is mosty checked in ther per-mode stuff but...
     *
     * There must be an mddev unless D or E or (A and scan)
     * If there is one, we open it.
     */
    if (mode !='D' && mode !='E' && ! (mode =='A' && scan)) {
	if (!mddev) {
	    fprintf(stderr, "mdctl: an md device must be given in this mode\n");
	    exit(2);
	}
	mdfd = open(mddev, O_RDWR, 0);
	if (mdfd < 0) {
	    fprintf(stderr,"mdctl: error opening %s: %s\n",
		    mddev, strerror(errno));
	    exit(1);
	}
	if (md_get_version(mdfd) <= 0) {
	    fprintf(stderr, "mdctl: %s does not appear to be an md device\n",
		    mddev);
	    close(mdfd);
	    exit(1);
	}
    }
    
    rv  =0;
    switch(mode) {
    case '@':/* Management */
	/* readonly, add/remove, readwrite, runstop */
	if (readonly>1)
	    rv = Manage_ro(mddev, mdfd, readonly);
	if (!rv && subdevs)
	    rv = Manage_subdevs(mddev, mdfd, subdevs, subdev, devmodes);
	if (!rv && readonly < 1)
	    rv = Manage_ro(mddev, mdfd, readonly);
	if (!rv && runstop)
	    rv = Manage_runstop(mddev, mdfd, runstop);
	break;
    case 'A': /* Assemble */
	rv = Assemble(mddev, mdfd, uuid, uuidset, configfile, scan, subdevs, subdev, readonly, runstop, verbose, force);
	break;
    case 'B': /* Build */
	rv = Build(mddev, mdfd, chunk, level, raiddisks, subdevs,subdev);
	break;
    case 'C': /* Create */
	rv = Create(mddev, mdfd, chunk, level, layout, raiddisks, sparedisks,
		    subdevs,subdev,runstop);
	break;
    case 'D': /* Detail */
	for (i=0; i<subdevs; i++)
	    rv |= Detail(subdev[i]);
	break;
    case 'E': /* Examine */
	for (i=0; i<subdevs; i++)
	    rv |= Examine(subdev[i]);
	break;
    }
    exit(rv);
}