multipath: make 'dev' internal to the multipath program
[multipath-tools/.git] / multipath / main.c
1 /*
2  * Soft:        multipath device mapper target autoconfig
3  *
4  * Version:     $Id: main.h,v 0.0.1 2003/09/18 15:13:38 cvaroqui Exp $
5  *
6  * Author:      Christophe Varoqui
7  *
8  *              This program is distributed in the hope that it will be useful,
9  *              but WITHOUT ANY WARRANTY; without even the implied warranty of
10  *              MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11  *              See the GNU General Public License for more details.
12  *
13  *              This program is free software; you can redistribute it and/or
14  *              modify it under the terms of the GNU General Public License
15  *              as published by the Free Software Foundation; either version
16  *              2 of the License, or (at your option) any later version.
17  *
18  * Copyright (c) 2003, 2004, 2005 Christophe Varoqui
19  * Copyright (c) 2005 Benjamin Marzinski, Redhat
20  * Copyright (c) 2005 Kiyoshi Ueda, NEC
21  * Copyright (c) 2005 Patrick Caulfield, Redhat
22  * Copyright (c) 2005 Edward Goggin, EMC
23  */
24
25 #include <sys/types.h>
26 #include <sys/stat.h>
27 #include <stdio.h>
28 #include <unistd.h>
29 #include <ctype.h>
30 #include <libudev.h>
31 #include <syslog.h>
32
33 #include <checkers.h>
34 #include <prio.h>
35 #include <vector.h>
36 #include <memory.h>
37 #include <libdevmapper.h>
38 #include <devmapper.h>
39 #include <util.h>
40 #include <defaults.h>
41 #include <structs.h>
42 #include <structs_vec.h>
43 #include <dmparser.h>
44 #include <sysfs.h>
45 #include <config.h>
46 #include <blacklist.h>
47 #include <discovery.h>
48 #include <debug.h>
49 #include <switchgroup.h>
50 #include <print.h>
51 #include <alias.h>
52 #include <configure.h>
53 #include <pgpolicies.h>
54 #include <version.h>
55 #include <errno.h>
56 #include <sys/time.h>
57 #include <sys/resource.h>
58 #include <wwids.h>
59 #include <uxsock.h>
60 #include <mpath_cmd.h>
61
62 int logsink;
63
64 static int
65 filter_pathvec (vector pathvec, char * refwwid)
66 {
67         int i;
68         struct path * pp;
69
70         if (!refwwid || !strlen(refwwid))
71                 return 0;
72
73         vector_foreach_slot (pathvec, pp, i) {
74                 if (strncmp(pp->wwid, refwwid, WWID_SIZE) != 0) {
75                         condlog(3, "skip path %s : out of scope", pp->dev);
76                         free_path(pp);
77                         vector_del_slot(pathvec, i);
78                         i--;
79                 }
80         }
81         return 0;
82 }
83
84 static void
85 usage (char * progname)
86 {
87         fprintf (stderr, VERSION_STRING);
88         fprintf (stderr, "Usage:\n");
89         fprintf (stderr, "  %s [-a|-c|-w|-W] [-d] [-r] [-i] [-v lvl] [-p pol] [-b fil] [-q] [dev]\n", progname);
90         fprintf (stderr, "  %s -l|-ll|-f [-v lvl] [-b fil] [dev]\n", progname);
91         fprintf (stderr, "  %s -F [-v lvl]\n", progname);
92         fprintf (stderr, "  %s -t\n", progname);
93         fprintf (stderr, "  %s -h\n", progname);
94         fprintf (stderr,
95                 "\n"
96                 "Where:\n"
97                 "  -h      print this usage text\n" \
98                 "  -l      show multipath topology (sysfs and DM info)\n" \
99                 "  -ll     show multipath topology (maximum info)\n" \
100                 "  -f      flush a multipath device map\n" \
101                 "  -F      flush all multipath device maps\n" \
102                 "  -a      add a device wwid to the wwids file\n" \
103                 "  -c      check if a device should be a path in a multipath device\n" \
104                 "  -q      allow queue_if_no_path when multipathd is not running\n"\
105                 "  -d      dry run, do not create or update devmaps\n" \
106                 "  -t      dump internal hardware table\n" \
107                 "  -r      force devmap reload\n" \
108                 "  -i      ignore wwids file\n" \
109                 "  -B      treat the bindings file as read only\n" \
110                 "  -b fil  bindings file location\n" \
111                 "  -w      remove a device from the wwids file\n" \
112                 "  -W      reset the wwids file include only the current devices\n" \
113                 "  -p pol  force all maps to specified path grouping policy :\n" \
114                 "          . failover            one path per priority group\n" \
115                 "          . multibus            all paths in one priority group\n" \
116                 "          . group_by_serial     one priority group per serial\n" \
117                 "          . group_by_prio       one priority group per priority lvl\n" \
118                 "          . group_by_node_name  one priority group per target node\n" \
119                 "  -v lvl  verbosity level\n" \
120                 "          . 0 no output\n" \
121                 "          . 1 print created devmap names only\n" \
122                 "          . 2 default verbosity\n" \
123                 "          . 3 print debug information\n" \
124                 "  dev     action limited to:\n" \
125                 "          . multipath named 'dev' (ex: mpath0) or\n" \
126                 "          . multipath whose wwid is 'dev' (ex: 60051..)\n" \
127                 "          . multipath including the path named 'dev' (ex: /dev/sda)\n" \
128                 "          . multipath including the path with maj:min 'dev' (ex: 8:0)\n" \
129                 );
130
131 }
132
133 static int
134 update_paths (struct multipath * mpp)
135 {
136         int i, j;
137         struct pathgroup * pgp;
138         struct path * pp;
139
140         if (!mpp->pg)
141                 return 0;
142
143         vector_foreach_slot (mpp->pg, pgp, i) {
144                 if (!pgp->paths)
145                         continue;
146
147                 vector_foreach_slot (pgp->paths, pp, j) {
148                         if (!strlen(pp->dev)) {
149                                 if (devt2devname(pp->dev, FILE_NAME_SIZE,
150                                                  pp->dev_t)) {
151                                         /*
152                                          * path is not in sysfs anymore
153                                          */
154                                         pp->chkrstate = pp->state = PATH_DOWN;
155                                         continue;
156                                 }
157                                 pp->mpp = mpp;
158                                 if (pathinfo(pp, conf->hwtable, DI_ALL))
159                                         pp->state = PATH_UNCHECKED;
160                                 continue;
161                         }
162                         pp->mpp = mpp;
163                         if (pp->state == PATH_UNCHECKED ||
164                             pp->state == PATH_WILD) {
165                                 if (pathinfo(pp, conf->hwtable, DI_CHECKER))
166                                         pp->state = PATH_UNCHECKED;
167                         }
168
169                         if (pp->priority == PRIO_UNDEF) {
170                                 if (pathinfo(pp, conf->hwtable, DI_PRIO))
171                                         pp->priority = PRIO_UNDEF;
172                         }
173                 }
174         }
175         return 0;
176 }
177
178 static int
179 get_dm_mpvec (enum mpath_cmds cmd, vector curmp, vector pathvec, char * refwwid)
180 {
181         int i;
182         struct multipath * mpp;
183         char params[PARAMS_SIZE], status[PARAMS_SIZE];
184
185         if (dm_get_maps(curmp))
186                 return 1;
187
188         vector_foreach_slot (curmp, mpp, i) {
189                 /*
190                  * discard out of scope maps
191                  */
192                 if (mpp->wwid && refwwid &&
193                     strncmp(mpp->wwid, refwwid, WWID_SIZE)) {
194                         condlog(3, "skip map %s: out of scope", mpp->alias);
195                         free_multipath(mpp, KEEP_PATHS);
196                         vector_del_slot(curmp, i);
197                         i--;
198                         continue;
199                 }
200
201                 if (cmd == CMD_VALID_PATH)
202                         continue;
203
204                 dm_get_map(mpp->alias, &mpp->size, params);
205                 condlog(3, "params = %s", params);
206                 dm_get_status(mpp->alias, status);
207                 condlog(3, "status = %s", status);
208
209                 disassemble_map(pathvec, params, mpp, 0);
210
211                 /*
212                  * disassemble_map() can add new paths to pathvec.
213                  * If not in "fast list mode", we need to fetch information
214                  * about them
215                  */
216                 if (cmd != CMD_LIST_SHORT)
217                         update_paths(mpp);
218
219                 if (cmd == CMD_LIST_LONG)
220                         mpp->bestpg = select_path_group(mpp);
221
222                 disassemble_status(status, mpp);
223
224                 if (cmd == CMD_LIST_SHORT ||
225                     cmd == CMD_LIST_LONG)
226                         print_multipath_topology(mpp, conf->verbosity);
227
228                 if (cmd == CMD_CREATE)
229                         reinstate_paths(mpp);
230         }
231         return 0;
232 }
233
234
235 /*
236  * Return value:
237  *  -1: Retry
238  *   0: Success
239  *   1: Failure
240  */
241 static int
242 configure (enum mpath_cmds cmd, enum devtypes dev_type, char *devpath)
243 {
244         vector curmp = NULL;
245         vector pathvec = NULL;
246         struct vectors vecs;
247         int r = 1;
248         int di_flag = 0;
249         char * refwwid = NULL;
250         char * dev = NULL;
251
252         /*
253          * allocate core vectors to store paths and multipaths
254          */
255         curmp = vector_alloc();
256         pathvec = vector_alloc();
257
258         if (!curmp || !pathvec) {
259                 condlog(0, "can not allocate memory");
260                 goto out;
261         }
262         vecs.pathvec = pathvec;
263         vecs.mpvec = curmp;
264
265         dev = convert_dev(devpath, (dev_type == DEV_DEVNODE));
266
267         /*
268          * if we have a blacklisted device parameter, exit early
269          */
270         if (dev && dev_type == DEV_DEVNODE &&
271             cmd != CMD_REMOVE_WWID &&
272             (filter_devnode(conf->blist_devnode,
273                             conf->elist_devnode, dev) > 0)) {
274                 if (cmd == CMD_VALID_PATH)
275                         printf("%s is not a valid multipath device path\n",
276                                devpath);
277                 goto out;
278         }
279         /*
280          * scope limiting must be translated into a wwid
281          * failing the translation is fatal (by policy)
282          */
283         if (devpath) {
284                 int failed = get_refwwid(cmd, devpath, dev_type,
285                                          pathvec, &refwwid);
286                 if (!refwwid) {
287                         condlog(4, "%s: failed to get wwid", devpath);
288                         if (failed == 2 && cmd == CMD_VALID_PATH)
289                                 printf("%s is not a valid multipath device path\n", devpath);
290                         else
291                                 condlog(3, "scope is nul");
292                         goto out;
293                 }
294                 if (cmd == CMD_REMOVE_WWID) {
295                         r = remove_wwid(refwwid);
296                         if (r == 0)
297                                 printf("wwid '%s' removed\n", refwwid);
298                         else if (r == 1) {
299                                 printf("wwid '%s' not in wwids file\n",
300                                         refwwid);
301                                 r = 0;
302                         }
303                         goto out;
304                 }
305                 if (cmd == CMD_ADD_WWID) {
306                         r = remember_wwid(refwwid);
307                         if (r == 0)
308                                 printf("wwid '%s' added\n", refwwid);
309                         else
310                                 printf("failed adding '%s' to wwids file\n",
311                                        refwwid);
312                         goto out;
313                 }
314                 condlog(3, "scope limited to %s", refwwid);
315                 /* If you are ignoring the wwids file and find_multipaths is
316                  * set, you need to actually check if there are two available
317                  * paths to determine if this path should be multipathed. To
318                  * do this, we put off the check until after discovering all
319                  * the paths */
320                 if (cmd == CMD_VALID_PATH &&
321                     (!conf->find_multipaths || !conf->ignore_wwids)) {
322                         if (conf->ignore_wwids ||
323                             check_wwids_file(refwwid, 0) == 0)
324                                 r = 0;
325
326                         printf("%s %s a valid multipath device path\n",
327                                devpath, r == 0 ? "is" : "is not");
328                         goto out;
329                 }
330         }
331
332         /*
333          * get a path list
334          */
335         if (devpath)
336                 di_flag = DI_WWID;
337
338         if (cmd == CMD_LIST_LONG)
339                 /* extended path info '-ll' */
340                 di_flag |= DI_SYSFS | DI_CHECKER;
341         else if (cmd == CMD_LIST_SHORT)
342                 /* minimum path info '-l' */
343                 di_flag |= DI_SYSFS;
344         else
345                 /* maximum info */
346                 di_flag = DI_ALL;
347
348         if (path_discovery(pathvec, conf, di_flag) < 0)
349                 goto out;
350
351         if (conf->verbosity > 2)
352                 print_all_paths(pathvec, 1);
353
354         get_path_layout(pathvec, 0);
355
356         if (get_dm_mpvec(cmd, curmp, pathvec, refwwid))
357                 goto out;
358
359         filter_pathvec(pathvec, refwwid);
360
361
362         if (cmd == CMD_VALID_PATH) {
363                 /* This only happens if find_multipaths is and
364                  * ignore_wwids is set.
365                  * If there is currently a multipath device matching
366                  * the refwwid, or there is more than one path matching
367                  * the refwwid, then the path is valid */
368                 if (VECTOR_SIZE(curmp) != 0 || VECTOR_SIZE(pathvec) > 1)
369                         r = 0;
370                 printf("%s %s a valid multipath device path\n",
371                        devpath, r == 0 ? "is" : "is not");
372                 goto out;
373         }
374
375         if (cmd != CMD_CREATE && cmd != CMD_DRY_RUN) {
376                 r = 0;
377                 goto out;
378         }
379
380         /*
381          * core logic entry point
382          */
383         r = coalesce_paths(&vecs, NULL, refwwid,
384                            conf->force_reload, cmd);
385
386 out:
387         if (refwwid)
388                 FREE(refwwid);
389
390         free_multipathvec(curmp, KEEP_PATHS);
391         free_pathvec(pathvec, FREE_PATHS);
392
393         return r;
394 }
395
396 static int
397 dump_config (void)
398 {
399         char * c, * tmp = NULL;
400         char * reply;
401         unsigned int maxlen = 256;
402         int again = 1;
403
404         reply = MALLOC(maxlen);
405
406         while (again) {
407                 if (!reply) {
408                         if (tmp)
409                                 free(tmp);
410                         return 1;
411                 }
412                 c = tmp = reply;
413                 c += snprint_defaults(c, reply + maxlen - c);
414                 again = ((c - reply) == maxlen);
415                 if (again) {
416                         reply = REALLOC(reply, maxlen *= 2);
417                         continue;
418                 }
419                 c += snprint_blacklist(c, reply + maxlen - c);
420                 again = ((c - reply) == maxlen);
421                 if (again) {
422                         reply = REALLOC(reply, maxlen *= 2);
423                         continue;
424                 }
425                 c += snprint_blacklist_except(c, reply + maxlen - c);
426                 again = ((c - reply) == maxlen);
427                 if (again) {
428                         reply = REALLOC(reply, maxlen *= 2);
429                         continue;
430                 }
431                 c += snprint_hwtable(c, reply + maxlen - c, conf->hwtable);
432                 again = ((c - reply) == maxlen);
433                 if (again) {
434                         reply = REALLOC(reply, maxlen *= 2);
435                         continue;
436                 }
437                 c += snprint_overrides(c, reply + maxlen - c, conf->overrides);
438                 again = ((c - reply) == maxlen);
439                 if (again) {
440                         reply = REALLOC(reply, maxlen *= 2);
441                         continue;
442                 }
443                 if (VECTOR_SIZE(conf->mptable) > 0) {
444                         c += snprint_mptable(c, reply + maxlen - c,
445                                              conf->mptable);
446                         again = ((c - reply) == maxlen);
447                         if (again)
448                                 reply = REALLOC(reply, maxlen *= 2);
449                 }
450         }
451
452         printf("%s", reply);
453         FREE(reply);
454         return 0;
455 }
456
457 static int
458 get_dev_type(char *dev) {
459         struct stat buf;
460         int i;
461
462         if (stat(dev, &buf) == 0 && S_ISBLK(buf.st_mode)) {
463                 if (dm_is_dm_major(major(buf.st_rdev)))
464                         return DEV_DEVMAP;
465                 return DEV_DEVNODE;
466         }
467         else if (sscanf(dev, "%d:%d", &i, &i) == 2)
468                 return DEV_DEVT;
469         else if (valid_alias(dev))
470                 return DEV_DEVMAP;
471         return DEV_NONE;
472 }
473
474 int
475 main (int argc, char *argv[])
476 {
477         struct udev *udev;
478         int arg;
479         extern char *optarg;
480         extern int optind;
481         int r = 1;
482         enum mpath_cmds cmd = CMD_CREATE;
483         enum devtypes dev_type;
484         char *dev = NULL;
485
486         udev = udev_new();
487         logsink = 0;
488         if (load_config(DEFAULT_CONFIGFILE, udev))
489                 exit(1);
490         while ((arg = getopt(argc, argv, ":adchl::FfM:v:p:b:BritquwW")) != EOF ) {
491                 switch(arg) {
492                 case 1: printf("optarg : %s\n",optarg);
493                         break;
494                 case 'v':
495                         if (sizeof(optarg) > sizeof(char *) ||
496                             !isdigit(optarg[0])) {
497                                 usage (argv[0]);
498                                 exit(1);
499                         }
500
501                         conf->verbosity = atoi(optarg);
502                         break;
503                 case 'b':
504                         conf->bindings_file = strdup(optarg);
505                         break;
506                 case 'B':
507                         conf->bindings_read_only = 1;
508                         break;
509                 case 'q':
510                         conf->allow_queueing = 1;
511                         break;
512                 case 'c':
513                         cmd = CMD_VALID_PATH;
514                         break;
515                 case 'd':
516                         if (cmd == CMD_CREATE)
517                                 cmd = CMD_DRY_RUN;
518                         break;
519                 case 'f':
520                         conf->remove = FLUSH_ONE;
521                         break;
522                 case 'F':
523                         conf->remove = FLUSH_ALL;
524                         break;
525                 case 'l':
526                         if (optarg && !strncmp(optarg, "l", 1))
527                                 cmd = CMD_LIST_LONG;
528                         else
529                                 cmd = CMD_LIST_SHORT;
530
531                         break;
532                 case 'M':
533 #if _DEBUG_
534                         debug = atoi(optarg);
535 #endif
536                         break;
537                 case 'p':
538                         conf->pgpolicy_flag = get_pgpolicy_id(optarg);
539                         if (conf->pgpolicy_flag == -1) {
540                                 printf("'%s' is not a valid policy\n", optarg);
541                                 usage(argv[0]);
542                                 exit(1);
543                         }
544                         break;
545                 case 'r':
546                         conf->force_reload = 1;
547                         break;
548                 case 'i':
549                         conf->ignore_wwids = 1;
550                         break;
551                 case 't':
552                         r = dump_config();
553                         goto out_free_config;
554                 case 'h':
555                         usage(argv[0]);
556                         exit(0);
557                 case 'u':
558                         cmd = CMD_VALID_PATH;
559                         dev_type = DEV_UEVENT;
560                         break;
561                 case 'w':
562                         cmd = CMD_REMOVE_WWID;
563                         break;
564                 case 'W':
565                         cmd = CMD_RESET_WWIDS;
566                         break;
567                 case 'a':
568                         cmd = CMD_ADD_WWID;
569                         break;
570                 case ':':
571                         fprintf(stderr, "Missing option argument\n");
572                         usage(argv[0]);
573                         exit(1);
574                 case '?':
575                         fprintf(stderr, "Unknown switch: %s\n", optarg);
576                         usage(argv[0]);
577                         exit(1);
578                 default:
579                         usage(argv[0]);
580                         exit(1);
581                 }
582         }
583
584         if (getuid() != 0) {
585                 fprintf(stderr, "need to be root\n");
586                 exit(1);
587         }
588
589         dm_init(conf->verbosity);
590         if (dm_prereq())
591                 exit(1);
592         dm_drv_version(conf->version, TGT_MPATH);
593         dm_udev_set_sync_support(1);
594
595         if (optind < argc) {
596                 dev = MALLOC(FILE_NAME_SIZE);
597
598                 if (!dev)
599                         goto out;
600
601                 strncpy(dev, argv[optind], FILE_NAME_SIZE);
602                 if (dev_type != DEV_UEVENT)
603                         dev_type = get_dev_type(dev);
604                 if (dev_type == DEV_NONE) {
605                         condlog(0, "'%s' is not a valid argument\n", dev);
606                         goto out;
607                 }
608         }
609         if (dev_type == DEV_UEVENT) {
610                 openlog("multipath", 0, LOG_DAEMON);
611                 setlogmask(LOG_UPTO(conf->verbosity + 3));
612                 logsink = 1;
613         }
614
615         if (conf->max_fds) {
616                 struct rlimit fd_limit;
617
618                 fd_limit.rlim_cur = conf->max_fds;
619                 fd_limit.rlim_max = conf->max_fds;
620                 if (setrlimit(RLIMIT_NOFILE, &fd_limit) < 0)
621                         condlog(0, "can't set open fds limit to %d : %s",
622                                 conf->max_fds, strerror(errno));
623         }
624
625         if (init_checkers()) {
626                 condlog(0, "failed to initialize checkers");
627                 goto out;
628         }
629         if (init_prio()) {
630                 condlog(0, "failed to initialize prioritizers");
631                 goto out;
632         }
633
634         if (cmd == CMD_VALID_PATH &&
635             (!dev || dev_type == DEV_DEVMAP)) {
636                 condlog(0, "the -c option requires a path to check");
637                 goto out;
638         }
639         if (cmd == CMD_VALID_PATH &&
640             dev_type == DEV_UEVENT) {
641                 int fd;
642
643                 fd = mpath_connect();
644                 if (fd == -1) {
645                         printf("%s is not a valid multipath device path\n",
646                                 dev);
647                         goto out;
648                 }
649                 mpath_disconnect(fd);
650         }
651         if (cmd == CMD_REMOVE_WWID && !dev) {
652                 condlog(0, "the -w option requires a device");
653                 goto out;
654         }
655         if (cmd == CMD_RESET_WWIDS) {
656                 struct multipath * mpp;
657                 int i;
658                 vector curmp;
659
660                 curmp = vector_alloc();
661                 if (!curmp) {
662                         condlog(0, "can't allocate memory for mp list");
663                         goto out;
664                 }
665                 if (dm_get_maps(curmp) == 0)
666                         r = replace_wwids(curmp);
667                 if (r == 0)
668                         printf("successfully reset wwids\n");
669                 vector_foreach_slot_backwards(curmp, mpp, i) {
670                         vector_del_slot(curmp, i);
671                         free_multipath(mpp, KEEP_PATHS);
672                 }
673                 vector_free(curmp);
674                 goto out;
675         }
676         if (conf->remove == FLUSH_ONE) {
677                 if (dev_type == DEV_DEVMAP) {
678                         r = dm_suspend_and_flush_map(dev);
679                 } else
680                         condlog(0, "must provide a map name to remove");
681
682                 goto out;
683         }
684         else if (conf->remove == FLUSH_ALL) {
685                 r = dm_flush_maps();
686                 goto out;
687         }
688         while ((r = configure(cmd, dev_type, dev)) < 0)
689                 condlog(3, "restart multipath configuration process");
690
691 out:
692         dm_lib_release();
693         dm_lib_exit();
694
695         cleanup_prio();
696         cleanup_checkers();
697
698         if (dev_type == DEV_UEVENT)
699                 closelog();
700
701 out_free_config:
702         /*
703          * Freeing config must be done after dm_lib_exit(), because
704          * the logging function (dm_write_log()), which is called there,
705          * references the config.
706          */
707         free_config(conf);
708         conf = NULL;
709         udev_unref(udev);
710         if (dev)
711                 FREE(dev);
712 #ifdef _DEBUG_
713         dbg_free_final(NULL);
714 #endif
715         return r;
716 }