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