17795b61e3fc845471469c6723e316736ab1b700
[multipath-tools/.git] / multipathd / cli.c
1 /*
2  * Copyright (c) 2005 Christophe Varoqui
3  */
4 #include <sys/time.h>
5 #include <errno.h>
6 #include <pthread.h>
7 #include "memory.h"
8 #include "vector.h"
9 #include "structs.h"
10 #include "structs_vec.h"
11 #include "parser.h"
12 #include "util.h"
13 #include "version.h"
14 #include <readline/readline.h>
15
16 #include "mpath_cmd.h"
17 #include "cli.h"
18 #include "debug.h"
19
20 static vector keys;
21 static vector handlers;
22
23 static struct key *
24 alloc_key (void)
25 {
26         return (struct key *)MALLOC(sizeof(struct key));
27 }
28
29 static struct handler *
30 alloc_handler (void)
31 {
32         return (struct handler *)MALLOC(sizeof(struct handler));
33 }
34
35 static int
36 add_key (vector vec, char * str, uint64_t code, int has_param)
37 {
38         struct key * kw;
39
40         kw = alloc_key();
41
42         if (!kw)
43                 return 1;
44
45         kw->code = code;
46         kw->has_param = has_param;
47         kw->str = STRDUP(str);
48
49         if (!kw->str)
50                 goto out;
51
52         if (!vector_alloc_slot(vec))
53                 goto out1;
54
55         vector_set_slot(vec, kw);
56
57         return 0;
58
59 out1:
60         FREE(kw->str);
61 out:
62         FREE(kw);
63         return 1;
64 }
65
66 int
67 add_handler (uint64_t fp, int (*fn)(void *, char **, int *, void *))
68 {
69         struct handler * h;
70
71         h = alloc_handler();
72
73         if (!h)
74                 return 1;
75
76         if (!vector_alloc_slot(handlers)) {
77                 FREE(h);
78                 return 1;
79         }
80
81         vector_set_slot(handlers, h);
82         h->fingerprint = fp;
83         h->fn = fn;
84
85         return 0;
86 }
87
88 static struct handler *
89 find_handler (uint64_t fp)
90 {
91         int i;
92         struct handler *h;
93
94         vector_foreach_slot (handlers, h, i)
95                 if (h->fingerprint == fp)
96                         return h;
97
98         return NULL;
99 }
100
101 int
102 set_handler_callback (uint64_t fp, int (*fn)(void *, char **, int *, void *))
103 {
104         struct handler * h = find_handler(fp);
105
106         if (!h)
107                 return 1;
108         h->fn = fn;
109         h->locked = 1;
110         return 0;
111 }
112
113 int
114 set_unlocked_handler_callback (uint64_t fp,int (*fn)(void *, char **, int *, void *))
115 {
116         struct handler * h = find_handler(fp);
117
118         if (!h)
119                 return 1;
120         h->fn = fn;
121         h->locked = 0;
122         return 0;
123 }
124
125 static void
126 free_key (struct key * kw)
127 {
128         if (kw->str)
129                 FREE(kw->str);
130
131         if (kw->param)
132                 FREE(kw->param);
133
134         FREE(kw);
135 }
136
137 void
138 free_keys (vector vec)
139 {
140         int i;
141         struct key * kw;
142
143         vector_foreach_slot (vec, kw, i)
144                 free_key(kw);
145
146         vector_free(vec);
147 }
148
149 void
150 free_handlers (void)
151 {
152         int i;
153         struct handler * h;
154
155         vector_foreach_slot (handlers, h, i)
156                 FREE(h);
157
158         vector_free(handlers);
159         handlers = NULL;
160 }
161
162 int
163 load_keys (void)
164 {
165         int r = 0;
166         keys = vector_alloc();
167
168         if (!keys)
169                 return 1;
170
171         r += add_key(keys, "list", LIST, 0);
172         r += add_key(keys, "show", LIST, 0);
173         r += add_key(keys, "add", ADD, 0);
174         r += add_key(keys, "remove", DEL, 0);
175         r += add_key(keys, "del", DEL, 0);
176         r += add_key(keys, "switch", SWITCH, 0);
177         r += add_key(keys, "switchgroup", SWITCH, 0);
178         r += add_key(keys, "suspend", SUSPEND, 0);
179         r += add_key(keys, "resume", RESUME, 0);
180         r += add_key(keys, "reinstate", REINSTATE, 0);
181         r += add_key(keys, "fail", FAIL, 0);
182         r += add_key(keys, "resize", RESIZE, 0);
183         r += add_key(keys, "reset", RESET, 0);
184         r += add_key(keys, "reload", RELOAD, 0);
185         r += add_key(keys, "forcequeueing", FORCEQ, 0);
186         r += add_key(keys, "disablequeueing", DISABLEQ, 0);
187         r += add_key(keys, "restorequeueing", RESTOREQ, 0);
188         r += add_key(keys, "paths", PATHS, 0);
189         r += add_key(keys, "maps", MAPS, 0);
190         r += add_key(keys, "multipaths", MAPS, 0);
191         r += add_key(keys, "path", PATH, 1);
192         r += add_key(keys, "map", MAP, 1);
193         r += add_key(keys, "multipath", MAP, 1);
194         r += add_key(keys, "group", GROUP, 1);
195         r += add_key(keys, "reconfigure", RECONFIGURE, 0);
196         r += add_key(keys, "daemon", DAEMON, 0);
197         r += add_key(keys, "status", STATUS, 0);
198         r += add_key(keys, "stats", STATS, 0);
199         r += add_key(keys, "topology", TOPOLOGY, 0);
200         r += add_key(keys, "config", CONFIG, 0);
201         r += add_key(keys, "blacklist", BLACKLIST, 0);
202         r += add_key(keys, "devices", DEVICES, 0);
203         r += add_key(keys, "raw", RAW, 0);
204         r += add_key(keys, "wildcards", WILDCARDS, 0);
205         r += add_key(keys, "quit", QUIT, 0);
206         r += add_key(keys, "exit", QUIT, 0);
207         r += add_key(keys, "shutdown", SHUTDOWN, 0);
208         r += add_key(keys, "getprstatus", GETPRSTATUS, 0);
209         r += add_key(keys, "setprstatus", SETPRSTATUS, 0);
210         r += add_key(keys, "unsetprstatus", UNSETPRSTATUS, 0);
211         r += add_key(keys, "format", FMT, 1);
212         r += add_key(keys, "json", JSON, 0);
213         r += add_key(keys, "getprkey", GETPRKEY, 0);
214         r += add_key(keys, "setprkey", SETPRKEY, 0);
215         r += add_key(keys, "unsetprkey", UNSETPRKEY, 0);
216         r += add_key(keys, "key", KEY, 1);
217         r += add_key(keys, "local", LOCAL, 0);
218
219
220         if (r) {
221                 free_keys(keys);
222                 keys = NULL;
223                 return 1;
224         }
225         return 0;
226 }
227
228 static struct key *
229 find_key (const char * str)
230 {
231         int i;
232         int len, klen;
233         struct key * kw = NULL;
234         struct key * foundkw = NULL;
235
236         len = strlen(str);
237
238         vector_foreach_slot (keys, kw, i) {
239                 if (strncmp(kw->str, str, len))
240                         continue;
241                 klen = strlen(kw->str);
242                 if (len == klen)
243                         return kw; /* exact match */
244                 if (len < klen) {
245                         if (!foundkw)
246                                 foundkw = kw; /* shortcut match */
247                         else
248                                 return NULL; /* ambiguous word */
249                 }
250         }
251         return foundkw;
252 }
253
254 /*
255  * get_cmdvec
256  *
257  * returns:
258  * ENOMEM: not enough memory to allocate command
259  * EAGAIN: command not found
260  * EINVAL: argument missing for command
261  */
262 static int
263 get_cmdvec (char * cmd, vector *v)
264 {
265         int i;
266         int r = 0;
267         int get_param = 0;
268         char * buff;
269         struct key * kw = NULL;
270         struct key * cmdkw = NULL;
271         vector cmdvec, strvec;
272
273         strvec = alloc_strvec(cmd);
274         if (!strvec)
275                 return ENOMEM;
276
277         cmdvec = vector_alloc();
278
279         if (!cmdvec) {
280                 free_strvec(strvec);
281                 return ENOMEM;
282         }
283
284         vector_foreach_slot(strvec, buff, i) {
285                 if (is_quote(buff))
286                         continue;
287                 if (get_param) {
288                         get_param = 0;
289                         cmdkw->param = strdup(buff);
290                         continue;
291                 }
292                 kw = find_key(buff);
293                 if (!kw) {
294                         r = EAGAIN;
295                         goto out;
296                 }
297                 cmdkw = alloc_key();
298                 if (!cmdkw) {
299                         r = ENOMEM;
300                         goto out;
301                 }
302                 if (!vector_alloc_slot(cmdvec)) {
303                         FREE(cmdkw);
304                         r = ENOMEM;
305                         goto out;
306                 }
307                 vector_set_slot(cmdvec, cmdkw);
308                 cmdkw->code = kw->code;
309                 cmdkw->has_param = kw->has_param;
310                 if (kw->has_param)
311                         get_param = 1;
312         }
313         if (get_param) {
314                 r = EINVAL;
315                 goto out;
316         }
317         *v = cmdvec;
318         free_strvec(strvec);
319         return 0;
320
321 out:
322         free_strvec(strvec);
323         free_keys(cmdvec);
324         return r;
325 }
326
327 static uint64_t
328 fingerprint(vector vec)
329 {
330         int i;
331         uint64_t fp = 0;
332         struct key * kw;
333
334         if (!vec)
335                 return 0;
336
337         vector_foreach_slot(vec, kw, i)
338                 fp += kw->code;
339
340         return fp;
341 }
342
343 int
344 alloc_handlers (void)
345 {
346         handlers = vector_alloc();
347
348         if (!handlers)
349                 return 1;
350
351         return 0;
352 }
353
354 static int
355 genhelp_sprint_aliases (char * reply, int maxlen, vector keys,
356                         struct key * refkw)
357 {
358         int i, len = 0;
359         struct key * kw;
360
361         vector_foreach_slot (keys, kw, i) {
362                 if (kw->code == refkw->code && kw != refkw) {
363                         len += snprintf(reply + len, maxlen - len,
364                                         "|%s", kw->str);
365                         if (len >= maxlen)
366                                 return len;
367                 }
368         }
369
370         return len;
371 }
372
373 static int
374 do_genhelp(char *reply, int maxlen, const char *cmd, int error) {
375         int len = 0;
376         int i, j;
377         uint64_t fp;
378         struct handler * h;
379         struct key * kw;
380
381         switch(error) {
382         case ENOMEM:
383                 len += snprintf(reply + len, maxlen - len,
384                                 "%s: Not enough memory\n", cmd);
385                 break;
386         case EAGAIN:
387                 len += snprintf(reply + len, maxlen - len,
388                                 "%s: not found\n", cmd);
389                 break;
390         case EINVAL:
391                 len += snprintf(reply + len, maxlen - len,
392                                 "%s: Missing argument\n", cmd);
393                 break;
394         }
395         if (len >= maxlen)
396                 goto out;
397         len += snprintf(reply + len, maxlen - len, VERSION_STRING);
398         if (len >= maxlen)
399                 goto out;
400         len += snprintf(reply + len, maxlen - len, "CLI commands reference:\n");
401         if (len >= maxlen)
402                 goto out;
403
404         vector_foreach_slot (handlers, h, i) {
405                 fp = h->fingerprint;
406                 vector_foreach_slot (keys, kw, j) {
407                         if ((kw->code & fp)) {
408                                 fp -= kw->code;
409                                 len += snprintf(reply + len , maxlen - len,
410                                                 " %s", kw->str);
411                                 if (len >= maxlen)
412                                         goto out;
413                                 len += genhelp_sprint_aliases(reply + len,
414                                                               maxlen - len,
415                                                               keys, kw);
416                                 if (len >= maxlen)
417                                         goto out;
418
419                                 if (kw->has_param) {
420                                         len += snprintf(reply + len,
421                                                         maxlen - len,
422                                                         " $%s", kw->str);
423                                         if (len >= maxlen)
424                                                 goto out;
425                                 }
426                         }
427                 }
428                 len += snprintf(reply + len, maxlen - len, "\n");
429                 if (len >= maxlen)
430                         goto out;
431         }
432 out:
433         return len;
434 }
435
436
437 static char *
438 genhelp_handler (const char *cmd, int error)
439 {
440         char * reply;
441         char * p = NULL;
442         int maxlen = INITIAL_REPLY_LEN;
443         int again = 1;
444
445         reply = MALLOC(maxlen);
446
447         while (again) {
448                 if (!reply)
449                         return NULL;
450                 p = reply;
451                 p += do_genhelp(reply, maxlen, cmd, error);
452                 again = ((p - reply) >= maxlen);
453                 REALLOC_REPLY(reply, again, maxlen);
454         }
455         return reply;
456 }
457
458 int
459 parse_cmd (char * cmd, char ** reply, int * len, void * data, int timeout )
460 {
461         int r;
462         struct handler * h;
463         vector cmdvec = NULL;
464         struct timespec tmo;
465
466         r = get_cmdvec(cmd, &cmdvec);
467
468         if (r) {
469                 *reply = genhelp_handler(cmd, r);
470                 if (*reply == NULL)
471                         return EINVAL;
472                 *len = strlen(*reply) + 1;
473                 return 0;
474         }
475
476         h = find_handler(fingerprint(cmdvec));
477
478         if (!h || !h->fn) {
479                 free_keys(cmdvec);
480                 *reply = genhelp_handler(cmd, EINVAL);
481                 if (*reply == NULL)
482                         return EINVAL;
483                 *len = strlen(*reply) + 1;
484                 return 0;
485         }
486
487         /*
488          * execute handler
489          */
490         if (clock_gettime(CLOCK_REALTIME, &tmo) == 0) {
491                 tmo.tv_sec += timeout;
492         } else {
493                 tmo.tv_sec = 0;
494         }
495         if (h->locked) {
496                 int locked = 0;
497                 struct vectors * vecs = (struct vectors *)data;
498
499                 pthread_cleanup_push(cleanup_lock, &vecs->lock);
500                 if (tmo.tv_sec) {
501                         r = timedlock(&vecs->lock, &tmo);
502                 } else {
503                         lock(&vecs->lock);
504                         r = 0;
505                 }
506                 if (r == 0) {
507                         locked = 1;
508                         pthread_testcancel();
509                         r = h->fn(cmdvec, reply, len, data);
510                 }
511                 pthread_cleanup_pop(locked);
512         } else
513                 r = h->fn(cmdvec, reply, len, data);
514         free_keys(cmdvec);
515
516         return r;
517 }
518
519 char *
520 get_keyparam (vector v, uint64_t code)
521 {
522         struct key * kw;
523         int i;
524
525         vector_foreach_slot(v, kw, i)
526                 if (kw->code == code)
527                         return kw->param;
528
529         return NULL;
530 }
531
532 int
533 cli_init (void) {
534         if (load_keys())
535                 return 1;
536
537         if (alloc_handlers())
538                 return 1;
539
540         add_handler(LIST+PATHS, NULL);
541         add_handler(LIST+PATHS+FMT, NULL);
542         add_handler(LIST+PATHS+RAW+FMT, NULL);
543         add_handler(LIST+PATH, NULL);
544         add_handler(LIST+STATUS, NULL);
545         add_handler(LIST+DAEMON, NULL);
546         add_handler(LIST+MAPS, NULL);
547         add_handler(LIST+MAPS+STATUS, NULL);
548         add_handler(LIST+MAPS+STATS, NULL);
549         add_handler(LIST+MAPS+FMT, NULL);
550         add_handler(LIST+MAPS+RAW+FMT, NULL);
551         add_handler(LIST+MAPS+TOPOLOGY, NULL);
552         add_handler(LIST+MAPS+JSON, NULL);
553         add_handler(LIST+TOPOLOGY, NULL);
554         add_handler(LIST+MAP+TOPOLOGY, NULL);
555         add_handler(LIST+MAP+JSON, NULL);
556         add_handler(LIST+MAP+FMT, NULL);
557         add_handler(LIST+MAP+RAW+FMT, NULL);
558         add_handler(LIST+CONFIG, NULL);
559         add_handler(LIST+CONFIG+LOCAL, NULL);
560         add_handler(LIST+BLACKLIST, NULL);
561         add_handler(LIST+DEVICES, NULL);
562         add_handler(LIST+WILDCARDS, NULL);
563         add_handler(RESET+MAPS+STATS, NULL);
564         add_handler(RESET+MAP+STATS, NULL);
565         add_handler(ADD+PATH, NULL);
566         add_handler(DEL+PATH, NULL);
567         add_handler(ADD+MAP, NULL);
568         add_handler(DEL+MAP, NULL);
569         add_handler(SWITCH+MAP+GROUP, NULL);
570         add_handler(RECONFIGURE, NULL);
571         add_handler(SUSPEND+MAP, NULL);
572         add_handler(RESUME+MAP, NULL);
573         add_handler(RESIZE+MAP, NULL);
574         add_handler(RESET+MAP, NULL);
575         add_handler(RELOAD+MAP, NULL);
576         add_handler(DISABLEQ+MAP, NULL);
577         add_handler(RESTOREQ+MAP, NULL);
578         add_handler(DISABLEQ+MAPS, NULL);
579         add_handler(RESTOREQ+MAPS, NULL);
580         add_handler(REINSTATE+PATH, NULL);
581         add_handler(FAIL+PATH, NULL);
582         add_handler(QUIT, NULL);
583         add_handler(SHUTDOWN, NULL);
584         add_handler(GETPRSTATUS+MAP, NULL);
585         add_handler(SETPRSTATUS+MAP, NULL);
586         add_handler(UNSETPRSTATUS+MAP, NULL);
587         add_handler(GETPRKEY+MAP, NULL);
588         add_handler(SETPRKEY+MAP+KEY, NULL);
589         add_handler(UNSETPRKEY+MAP, NULL);
590         add_handler(FORCEQ+DAEMON, NULL);
591         add_handler(RESTOREQ+DAEMON, NULL);
592
593         return 0;
594 }
595
596 void cli_exit(void)
597 {
598         free_handlers();
599         free_keys(keys);
600         keys = NULL;
601 }
602
603 static int
604 key_match_fingerprint (struct key * kw, uint64_t fp)
605 {
606         if (!fp)
607                 return 0;
608
609         return ((fp & kw->code) == kw->code);
610 }
611
612 /*
613  * This is the readline completion handler
614  */
615 char *
616 key_generator (const char * str, int state)
617 {
618         static int index, len, has_param;
619         static uint64_t rlfp;
620         struct key * kw;
621         int i;
622         struct handler *h;
623         vector v = NULL;
624
625         if (!state) {
626                 index = 0;
627                 has_param = 0;
628                 rlfp = 0;
629                 len = strlen(str);
630                 int r = get_cmdvec(rl_line_buffer, &v);
631                 /*
632                  * If a word completion is in progress, we don't want
633                  * to take an exact keyword match in the fingerprint.
634                  * For ex "show map[tab]" would validate "map" and discard
635                  * "maps" as a valid candidate.
636                  */
637                 if (v && len)
638                         vector_del_slot(v, VECTOR_SIZE(v) - 1);
639                 /*
640                  * Clean up the mess if we dropped the last slot of a 1-slot
641                  * vector
642                  */
643                 if (v && !VECTOR_SIZE(v)) {
644                         vector_free(v);
645                         v = NULL;
646                 }
647                 /*
648                  * If last keyword takes a param, don't even try to guess
649                  */
650                 if (r == EINVAL) {
651                         has_param = 1;
652                         return (strdup("(value)"));
653                 }
654                 /*
655                  * Compute a command fingerprint to find out possible completions.
656                  * Once done, the vector is useless. Free it.
657                  */
658                 if (v) {
659                         rlfp = fingerprint(v);
660                         free_keys(v);
661                 }
662         }
663         /*
664          * No more completions for parameter placeholder.
665          * Brave souls might try to add parameter completion by walking paths and
666          * multipaths vectors.
667          */
668         if (has_param)
669                 return ((char *)NULL);
670         /*
671          * Loop through keywords for completion candidates
672          */
673         vector_foreach_slot_after (keys, kw, index) {
674                 if (!strncmp(kw->str, str, len)) {
675                         /*
676                          * Discard keywords already in the command line
677                          */
678                         if (key_match_fingerprint(kw, rlfp)) {
679                                 struct key * curkw = find_key(str);
680                                 if (!curkw || (curkw != kw))
681                                         continue;
682                         }
683                         /*
684                          * Discard keywords making syntax errors.
685                          *
686                          * nfp is the candidate fingerprint we try to
687                          * validate against all known command fingerprints.
688                          */
689                         uint64_t nfp = rlfp | kw->code;
690                         vector_foreach_slot(handlers, h, i) {
691                                 if (!rlfp || ((h->fingerprint & nfp) == nfp)) {
692                                         /*
693                                          * At least one full command is
694                                          * possible with this keyword :
695                                          * Consider it validated
696                                          */
697                                         index++;
698                                         return (strdup(kw->str));
699                                 }
700                         }
701                 }
702         }
703         /*
704          * No more candidates
705          */
706         return ((char *)NULL);
707 }