Allow specific CLI commands to run unlocked
[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 (unsigned long 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
211         if (r) {
212                 free_keys(keys);
213                 keys = NULL;
214                 return 1;
215         }
216         return 0;
217 }
218
219 static struct key *
220 find_key (const char * str)
221 {
222         int i;
223         int len, klen;
224         struct key * kw = NULL;
225         struct key * foundkw = NULL;
226
227         len = strlen(str);
228
229         vector_foreach_slot (keys, kw, i) {
230                 if (strncmp(kw->str, str, len))
231                         continue;
232                 klen = strlen(kw->str);
233                 if (len == klen)
234                         return kw; /* exact match */
235                 if (len < klen) {
236                         if (!foundkw)
237                                 foundkw = kw; /* shortcut match */
238                         else
239                                 return NULL; /* ambiguous word */
240                 }
241         }
242         return foundkw;
243 }
244
245 /*
246  * get_cmdvec
247  *
248  * returns:
249  * ENOMEM: not enough memory to allocate command
250  * EAGAIN: command not found
251  * EINVAL: argument missing for command
252  */
253 static int
254 get_cmdvec (char * cmd, vector *v)
255 {
256         int i;
257         int r = 0;
258         int get_param = 0;
259         char * buff;
260         struct key * kw = NULL;
261         struct key * cmdkw = NULL;
262         vector cmdvec, strvec;
263
264         strvec = alloc_strvec(cmd);
265         if (!strvec)
266                 return ENOMEM;
267
268         cmdvec = vector_alloc();
269
270         if (!cmdvec) {
271                 free_strvec(strvec);
272                 return ENOMEM;
273         }
274
275         vector_foreach_slot(strvec, buff, i) {
276                 if (*buff == '"')
277                         continue;
278                 if (get_param) {
279                         get_param = 0;
280                         cmdkw->param = strdup(buff);
281                         continue;
282                 }
283                 kw = find_key(buff);
284                 if (!kw) {
285                         r = EAGAIN;
286                         goto out;
287                 }
288                 cmdkw = alloc_key();
289                 if (!cmdkw) {
290                         r = ENOMEM;
291                         goto out;
292                 }
293                 if (!vector_alloc_slot(cmdvec)) {
294                         FREE(cmdkw);
295                         r = ENOMEM;
296                         goto out;
297                 }
298                 vector_set_slot(cmdvec, cmdkw);
299                 cmdkw->code = kw->code;
300                 cmdkw->has_param = kw->has_param;
301                 if (kw->has_param)
302                         get_param = 1;
303         }
304         if (get_param) {
305                 r = EINVAL;
306                 goto out;
307         }
308         *v = cmdvec;
309         free_strvec(strvec);
310         return 0;
311
312 out:
313         free_strvec(strvec);
314         free_keys(cmdvec);
315         return r;
316 }
317
318 static uint64_t
319 fingerprint(vector vec)
320 {
321         int i;
322         uint64_t fp = 0;
323         struct key * kw;
324
325         if (!vec)
326                 return 0;
327
328         vector_foreach_slot(vec, kw, i)
329                 fp += kw->code;
330
331         return fp;
332 }
333
334 int
335 alloc_handlers (void)
336 {
337         handlers = vector_alloc();
338
339         if (!handlers)
340                 return 1;
341
342         return 0;
343 }
344
345 static int
346 genhelp_sprint_aliases (char * reply, int maxlen, vector keys,
347                         struct key * refkw)
348 {
349         int i, len = 0;
350         struct key * kw;
351
352         vector_foreach_slot (keys, kw, i) {
353                 if (kw->code == refkw->code && kw != refkw) {
354                         len += snprintf(reply + len, maxlen - len,
355                                         "|%s", kw->str);
356                         if (len >= maxlen)
357                                 return len;
358                 }
359         }
360
361         return len;
362 }
363
364 static int
365 do_genhelp(char *reply, int maxlen, const char *cmd, int error) {
366         int len = 0;
367         int i, j;
368         uint64_t fp;
369         struct handler * h;
370         struct key * kw;
371
372         switch(error) {
373         case ENOMEM:
374                 len += snprintf(reply + len, maxlen - len,
375                                 "%s: Not enough memory\n", cmd);
376                 break;
377         case EAGAIN:
378                 len += snprintf(reply + len, maxlen - len,
379                                 "%s: not found\n", cmd);
380                 break;
381         case EINVAL:
382                 len += snprintf(reply + len, maxlen - len,
383                                 "%s: Missing argument\n", cmd);
384                 break;
385         }
386         if (len >= maxlen)
387                 goto out;
388         len += snprintf(reply + len, maxlen - len, VERSION_STRING);
389         if (len >= maxlen)
390                 goto out;
391         len += snprintf(reply + len, maxlen - len, "CLI commands reference:\n");
392         if (len >= maxlen)
393                 goto out;
394
395         vector_foreach_slot (handlers, h, i) {
396                 fp = h->fingerprint;
397                 vector_foreach_slot (keys, kw, j) {
398                         if ((kw->code & fp)) {
399                                 fp -= kw->code;
400                                 len += snprintf(reply + len , maxlen - len,
401                                                 " %s", kw->str);
402                                 if (len >= maxlen)
403                                         goto out;
404                                 len += genhelp_sprint_aliases(reply + len,
405                                                               maxlen - len,
406                                                               keys, kw);
407                                 if (len >= maxlen)
408                                         goto out;
409
410                                 if (kw->has_param) {
411                                         len += snprintf(reply + len,
412                                                         maxlen - len,
413                                                         " $%s", kw->str);
414                                         if (len >= maxlen)
415                                                 goto out;
416                                 }
417                         }
418                 }
419                 len += snprintf(reply + len, maxlen - len, "\n");
420                 if (len >= maxlen)
421                         goto out;
422         }
423 out:
424         return len;
425 }
426
427
428 static char *
429 genhelp_handler (const char *cmd, int error)
430 {
431         char * reply;
432         char * p = NULL;
433         int maxlen = INITIAL_REPLY_LEN;
434         int again = 1;
435
436         reply = MALLOC(maxlen);
437
438         while (again) {
439                 if (!reply)
440                         return NULL;
441                 p = reply;
442                 p += do_genhelp(reply, maxlen, cmd, error);
443                 again = ((p - reply) >= maxlen);
444                 REALLOC_REPLY(reply, again, maxlen);
445         }
446         return reply;
447 }
448
449 int
450 parse_cmd (char * cmd, char ** reply, int * len, void * data, int timeout )
451 {
452         int r;
453         struct handler * h;
454         vector cmdvec = NULL;
455         struct timespec tmo;
456         struct timeval now;
457
458         r = get_cmdvec(cmd, &cmdvec);
459
460         if (r) {
461                 *reply = genhelp_handler(cmd, r);
462                 *len = strlen(*reply) + 1;
463                 return 0;
464         }
465
466         h = find_handler(fingerprint(cmdvec));
467
468         if (!h || !h->fn) {
469                 *reply = genhelp_handler(cmd, EINVAL);
470                 *len = strlen(*reply) + 1;
471                 free_keys(cmdvec);
472                 return 0;
473         }
474
475         /*
476          * execute handler
477          */
478         if (gettimeofday(&now, NULL) == 0) {
479                 tmo.tv_sec = now.tv_sec + timeout;
480                 tmo.tv_nsec = now.tv_usec * 1000;
481         } else {
482                 tmo.tv_sec = 0;
483         }
484         if (h->locked) {
485                 struct vectors * vecs = (struct vectors *)data;
486
487                 pthread_cleanup_push(cleanup_lock, &vecs->lock);
488                 if (tmo.tv_sec) {
489                         vecs->lock.depth++;
490                         r = pthread_mutex_timedlock(vecs->lock.mutex, &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                 lock_cleanup_pop(vecs->lock);
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+TOPOLOGY, NULL);
541         add_handler(LIST+MAP+TOPOLOGY, NULL);
542         add_handler(LIST+MAP+FMT, NULL);
543         add_handler(LIST+MAP+RAW+FMT, NULL);
544         add_handler(LIST+CONFIG, NULL);
545         add_handler(LIST+BLACKLIST, NULL);
546         add_handler(LIST+DEVICES, NULL);
547         add_handler(LIST+WILDCARDS, NULL);
548         add_handler(ADD+PATH, NULL);
549         add_handler(DEL+PATH, NULL);
550         add_handler(ADD+MAP, NULL);
551         add_handler(DEL+MAP, NULL);
552         add_handler(SWITCH+MAP+GROUP, NULL);
553         add_handler(RECONFIGURE, NULL);
554         add_handler(SUSPEND+MAP, NULL);
555         add_handler(RESUME+MAP, NULL);
556         add_handler(RESIZE+MAP, NULL);
557         add_handler(RESET+MAP, NULL);
558         add_handler(RELOAD+MAP, NULL);
559         add_handler(DISABLEQ+MAP, NULL);
560         add_handler(RESTOREQ+MAP, NULL);
561         add_handler(DISABLEQ+MAPS, NULL);
562         add_handler(RESTOREQ+MAPS, NULL);
563         add_handler(REINSTATE+PATH, NULL);
564         add_handler(FAIL+PATH, NULL);
565         add_handler(QUIT, NULL);
566         add_handler(SHUTDOWN, NULL);
567         add_handler(GETPRSTATUS+MAP, NULL);
568         add_handler(SETPRSTATUS+MAP, NULL);
569         add_handler(UNSETPRSTATUS+MAP, NULL);
570         add_handler(FORCEQ+DAEMON, NULL);
571         add_handler(RESTOREQ+DAEMON, NULL);
572
573         return 0;
574 }
575
576 void cli_exit(void)
577 {
578         free_handlers();
579         free_keys(keys);
580         keys = NULL;
581 }
582
583 static int
584 key_match_fingerprint (struct key * kw, uint64_t fp)
585 {
586         if (!fp)
587                 return 0;
588
589         return ((fp & kw->code) == kw->code);
590 }
591
592 /*
593  * This is the readline completion handler
594  */
595 char *
596 key_generator (const char * str, int state)
597 {
598         static int index, len, has_param;
599         static uint64_t rlfp;
600         struct key * kw;
601         int i;
602         struct handler *h;
603         vector v = NULL;
604
605         if (!state) {
606                 index = 0;
607                 has_param = 0;
608                 rlfp = 0;
609                 len = strlen(str);
610                 int r = get_cmdvec(rl_line_buffer, &v);
611                 /*
612                  * If a word completion is in progess, we don't want
613                  * to take an exact keyword match in the fingerprint.
614                  * For ex "show map[tab]" would validate "map" and discard
615                  * "maps" as a valid candidate.
616                  */
617                 if (v && len)
618                         vector_del_slot(v, VECTOR_SIZE(v) - 1);
619                 /*
620                  * Clean up the mess if we dropped the last slot of a 1-slot
621                  * vector
622                  */
623                 if (v && !VECTOR_SIZE(v)) {
624                         vector_free(v);
625                         v = NULL;
626                 }
627                 /*
628                  * If last keyword takes a param, don't even try to guess
629                  */
630                 if (r == EINVAL) {
631                         has_param = 1;
632                         return (strdup("(value)"));
633                 }
634                 /*
635                  * Compute a command fingerprint to find out possible completions.
636                  * Once done, the vector is useless. Free it.
637                  */
638                 if (v) {
639                         rlfp = fingerprint(v);
640                         free_keys(v);
641                 }
642         }
643         /*
644          * No more completions for parameter placeholder.
645          * Brave souls might try to add parameter completion by walking paths and
646          * multipaths vectors.
647          */
648         if (has_param)
649                 return ((char *)NULL);
650         /*
651          * Loop through keywords for completion candidates
652          */
653         vector_foreach_slot_after (keys, kw, index) {
654                 if (!strncmp(kw->str, str, len)) {
655                         /*
656                          * Discard keywords already in the command line
657                          */
658                         if (key_match_fingerprint(kw, rlfp)) {
659                                 struct key * curkw = find_key(str);
660                                 if (!curkw || (curkw != kw))
661                                         continue;
662                         }
663                         /*
664                          * Discard keywords making syntax errors.
665                          *
666                          * nfp is the candidate fingerprint we try to
667                          * validate against all known command fingerprints.
668                          */
669                         uint64_t nfp = rlfp | kw->code;
670                         vector_foreach_slot(handlers, h, i) {
671                                 if (!rlfp || ((h->fingerprint & nfp) == nfp)) {
672                                         /*
673                                          * At least one full command is
674                                          * possible with this keyword :
675                                          * Consider it validated
676                                          */
677                                         index++;
678                                         return (strdup(kw->str));
679                                 }
680                         }
681                 }
682         }
683         /*
684          * No more candidates
685          */
686         return ((char *)NULL);
687 }
688