discover-client: interact directly with waitset
[petitboot] / ui / ncurses / nc-cui.c
1 /*
2  *  Copyright (C) 2009 Sony Computer Entertainment Inc.
3  *  Copyright 2009 Sony Corp.
4  *
5  *  This program is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; version 2 of the License.
8  *
9  *  This program is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  *  GNU General Public License for more details.
13  *
14  *  You should have received a copy of the GNU General Public License
15  *  along with this program; if not, write to the Free Software
16  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17  */
18
19 #define _GNU_SOURCE
20
21 #include <assert.h>
22 #include <errno.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <sys/ioctl.h>
26
27 #include "log/log.h"
28 #include "talloc/talloc.h"
29 #include "waiter/waiter.h"
30 #include "ui/common/discover-client.h"
31 #include "nc-cui.h"
32
33 static struct cui_opt_data *cod_from_item(struct pmenu_item *item)
34 {
35         return item->data;
36 }
37
38 /**
39  * cui_abort - Signal the main cui program loop to exit.
40  *
41  * Sets cui.abort, which causes the cui_run() routine to return.
42  */
43
44 void cui_abort(struct cui *cui)
45 {
46         pb_log("%s: exiting\n", __func__);
47         cui->abort = 1;
48 }
49
50 /**
51  * cui_resize - Signal the main cui program loop to resize
52  *
53  * Called at SIGWINCH.
54  */
55
56 void cui_resize(struct cui *cui)
57 {
58         pb_log("%s: resizing\n", __func__);
59         cui->resize = 1;
60 }
61
62 /**
63  * cui_make_item_name - Format the menu item name srting.
64  *
65  * Returns a talloc string.
66  */
67
68 static char *cui_make_item_name(struct pmenu_item *i, struct cui_opt_data *cod)
69 {
70         char *name;
71
72         assert(cod->name);
73         assert(cod->bd);
74
75         name = talloc_asprintf(i, "%s:", cod->name);
76
77         if (cod->bd->image)
78                 name = talloc_asprintf_append(name, " %s", cod->bd->image);
79
80         if (cod->bd->initrd)
81                 name = talloc_asprintf_append(name, " initrd=%s",
82                         cod->bd->initrd);
83
84         if (cod->bd->args)
85                 name = talloc_asprintf_append(name, " %s", cod->bd->args);
86
87         DBGS("@%s@\n", name);
88         return name;
89 }
90
91 /**
92  * cui_on_exit - A generic main menu ESC callback.
93  */
94
95 void cui_on_exit(struct pmenu *menu)
96 {
97         cui_abort(cui_from_pmenu(menu));
98 }
99
100 /**
101  * cui_run_cmd - A generic cb to run the supplied command.
102  */
103
104 int cui_run_cmd(struct pmenu_item *item)
105 {
106         int result;
107         struct cui *cui = cui_from_item(item);
108         const char *const *cmd_argv = item->data;
109
110         nc_scr_status_printf(cui->current, "Running %s...", cmd_argv[0]);
111
112         def_prog_mode();
113
114         result = pb_run_cmd(cmd_argv, 1, 0);
115
116         reset_prog_mode();
117         redrawwin(cui->current->main_ncw);
118
119         if (result) {
120                 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
121                 nc_scr_status_printf(cui->current, "Failed: %s", cmd_argv[0]);
122         }
123
124         return result;
125 }
126
127 /**
128  * cui_boot - A generic cb to run kexec.
129  */
130
131 static int cui_boot(struct pmenu_item *item)
132 {
133         int result;
134         struct cui *cui = cui_from_item(item);
135         struct cui_opt_data *cod = cod_from_item(item);
136
137         assert(cui->current == &cui->main->scr);
138         assert(cui->on_boot);
139
140         pb_log("%s: %s\n", __func__, cod->name);
141         nc_scr_status_printf(cui->current, "Booting %s...", cod->name);
142
143         def_prog_mode();
144
145         result = cui->on_boot(cui, cod);
146
147         reset_prog_mode();
148         redrawwin(cui->current->main_ncw);
149
150         if (!result) {
151                 clear();
152                 mvaddstr(1, 0, "system is going down now...");
153                 refresh();
154                 sleep(cui->dry_run ? 1 : 60);
155         }
156
157         pb_log("%s: failed: %s\n", __func__, cod->bd->image);
158         nc_scr_status_printf(cui->current, "Failed: kexec %s", cod->bd->image);
159
160         return 0;
161 }
162
163 /**
164  * cui_boot_editor_on_exit - The boot_editor on_exit callback.
165  */
166
167 static void cui_boot_editor_on_exit(struct boot_editor *boot_editor, enum boot_editor_result boot_editor_result,
168         struct pb_boot_data *bd)
169 {
170         struct cui *cui = cui_from_arg(boot_editor->scr.ui_ctx);
171
172         if (boot_editor_result == boot_editor_update) {
173                 struct pmenu_item *i = pmenu_find_selected(cui->main);
174                 struct cui_opt_data *cod = cod_from_item(i);
175                 char *name;
176
177                 assert(bd);
178
179                 talloc_steal(i, bd);
180                 talloc_free(cod->bd);
181                 cod->bd = bd;
182
183                 name = cui_make_item_name(i, cod);
184                 pmenu_item_replace(i, name);
185
186                 /* FIXME: need to make item visible somehow */
187                 set_current_item(cui->main->ncm, i->nci);
188
189                 pb_log("%s: updating opt '%s'\n", __func__, cod->name);
190                 pb_log(" image  '%s'\n", cod->bd->image);
191                 pb_log(" initrd '%s'\n", cod->bd->initrd);
192                 pb_log(" args   '%s'\n", cod->bd->args);
193         }
194
195         cui_set_current(cui, &cui->main->scr);
196
197         talloc_free(boot_editor);
198 }
199
200 int cui_boot_editor_run(struct pmenu_item *item)
201 {
202         struct cui *cui = cui_from_item(item);
203         struct cui_opt_data *cod = cod_from_item(item);
204         struct boot_editor *boot_editor;
205
206         boot_editor = boot_editor_init(cui, cod->bd, cui_boot_editor_on_exit);
207         cui_set_current(cui, &boot_editor->scr);
208
209         return 0;
210 }
211
212 /**
213  * cui_set_current - Set the currently active screen and redraw it.
214  */
215
216 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
217 {
218         struct nc_scr *old;
219
220         DBGS("%p -> %p\n", cui->current, scr);
221
222         assert(cui->current != scr);
223
224         old = cui->current;
225         old->unpost(old);
226
227         cui->current = scr;
228         cui->current->post(cui->current);
229
230         return old;
231 }
232
233 /**
234  * cui_process_key - Process input on stdin.
235  */
236
237 static int cui_process_key(void *arg)
238 {
239         struct cui *cui = cui_from_arg(arg);
240
241         assert(cui->current);
242
243         ui_timer_disable(&cui->timer);
244         cui->current->process_key(cui->current);
245
246         return 0;
247 }
248
249 /**
250  * cui_process_js - Process joystick events.
251  */
252
253 static int cui_process_js(void *arg)
254 {
255         struct cui *cui = cui_from_arg(arg);
256         int c;
257
258         c = pjs_process_event(cui->pjs);
259
260         if (c) {
261                 ungetch(c);
262                 cui_process_key(arg);
263         }
264
265         return 0;
266 }
267
268 /**
269  * cui_handle_timeout - Handle the timeout.
270  */
271
272 static void cui_handle_timeout(struct ui_timer *timer)
273 {
274         struct cui *cui = cui_from_timer(timer);
275         struct pmenu_item *i = pmenu_find_selected(cui->main);
276
277 #if defined(DEBUG)
278         {
279                 struct cui_opt_data *cod = cod_from_item(i);
280                 assert(cod && (cod->opt_hash == cui->default_item));
281         }
282 #endif
283         i->on_execute(i);
284 }
285
286 /**
287  * cui_handle_resize - Handle the term resize.
288  */
289
290 static void cui_handle_resize(struct cui *cui)
291 {
292         struct winsize ws;
293
294         if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
295                 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
296                 return;
297         }
298
299         pb_log("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
300
301         wclear(cui->current->main_ncw);
302         resize_term(ws.ws_row, ws.ws_col);
303         cui->current->resize(cui->current);
304
305         /* For some reason this makes ncurses redraw the screen */
306         getch();
307         redrawwin(cui->current->main_ncw);
308         wrefresh(cui->current->main_ncw);
309 }
310
311 /**
312  * cui_on_open - Open new item callback.
313  */
314
315 void cui_on_open(struct pmenu *menu)
316 {
317         unsigned int insert_pt;
318         struct pmenu_item *i;
319         struct cui_opt_data *cod;
320
321         menu->scr.unpost(&menu->scr);
322
323         /* This disconnects items array from menu. */
324
325         set_menu_items(menu->ncm, NULL);
326
327         /* Insert new items at insert_pt. */
328
329         insert_pt = pmenu_grow(menu, 1);
330         i = pmenu_item_alloc(menu);
331
332         i->on_edit = cui_boot_editor_run;
333         i->on_execute = cui_boot;
334         i->data = cod = talloc_zero(i, struct cui_opt_data);
335
336         cod->name = talloc_asprintf(i, "User item %u:", insert_pt);
337         cod->bd = talloc_zero(i, struct pb_boot_data);
338
339         pmenu_item_setup(menu, i, insert_pt, talloc_strdup(i, cod->name));
340
341         /* Re-attach the items array. */
342
343         set_menu_items(menu->ncm, menu->items);
344
345         menu->scr.post(&menu->scr);
346         set_current_item(menu->ncm, i->nci);
347
348         i->on_edit(i);
349 }
350
351 /**
352  * cui_device_add - Client device_add callback.
353  *
354  * Creates menu_items for all the device boot_options and inserts those
355  * menu_items into the main menu.  Redraws the main menu if it is active.
356  */
357
358 static int cui_device_add(struct device *dev, void *arg)
359 {
360         struct cui *cui = cui_from_arg(arg);
361         int result;
362         struct boot_option *opt;
363         unsigned int o_count; /* device opts */
364         unsigned int insert_pt;
365         ITEM *selected;
366
367         pb_log("%s: %p %s\n", __func__, dev, dev->id);
368
369         selected = current_item(cui->main->ncm);
370
371         if (cui->current == &cui->main->scr)
372                 cui->current->unpost(cui->current);
373
374         /* This disconnects items array from menu. */
375
376         result = set_menu_items(cui->main->ncm, NULL);
377
378         if (result)
379                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
380
381         o_count = 0;
382         list_for_each_entry(&dev->boot_options, opt, list)
383                 o_count++;
384
385         /* Insert new items at insert_pt. */
386
387         insert_pt = pmenu_grow(cui->main, o_count);
388
389         list_for_each_entry(&dev->boot_options, opt, list) {
390                 struct pmenu_item *i;
391                 struct cui_opt_data *cod;
392                 char *name;
393
394                 /* Save the item in opt->ui_info for cui_device_remove() */
395
396                 opt->ui_info = i = pmenu_item_alloc(cui->main);
397
398                 i->on_edit = cui_boot_editor_run;
399                 i->on_execute = cui_boot;
400                 i->data = cod = talloc(i, struct cui_opt_data);
401
402                 cod->dev = dev;
403                 cod->opt = opt;
404                 cod->opt_hash = pb_opt_hash(dev, opt);
405                 cod->name = opt->name;
406                 cod->bd = talloc(i, struct pb_boot_data);
407
408                 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
409                 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
410                 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
411
412                 name = cui_make_item_name(i, cod);
413                 pmenu_item_setup(cui->main, i, insert_pt, name);
414
415                 insert_pt++;
416
417                 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
418                 pb_log("   image  '%s'\n", cod->bd->image);
419                 pb_log("   initrd '%s'\n", cod->bd->initrd);
420                 pb_log("   args   '%s'\n", cod->bd->args);
421
422                 /* If this is the default_item select it and start timer. */
423
424                 if (cod->opt_hash == cui->default_item) {
425                         selected = i->nci;
426                         ui_timer_kick(&cui->timer);
427                 }
428         }
429
430         /* Re-attach the items array. */
431
432         result = set_menu_items(cui->main->ncm, cui->main->items);
433
434         if (result)
435                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
436
437         if (0) {
438                 pb_log("%s\n", __func__);
439                 pmenu_dump_items(cui->main->items,
440                         item_count(cui->main->ncm) + 1);
441         }
442
443         /* FIXME: need to make item visible somehow */
444         menu_driver(cui->main->ncm, REQ_SCR_UPAGE);
445         menu_driver(cui->main->ncm, REQ_SCR_DPAGE);
446         set_current_item(cui->main->ncm, selected);
447
448         if (cui->current == &cui->main->scr)
449                 cui->current->post(cui->current);
450
451         return 0;
452 }
453
454 /**
455  * cui_device_remove - Client device remove callback.
456  *
457  * Removes all the menu_items for the device from the main menu and redraws the
458  * main menu if it is active.
459  */
460
461 static void cui_device_remove(struct device *dev, void *arg)
462 {
463         struct cui *cui = cui_from_arg(arg);
464         int result;
465         struct boot_option *opt;
466
467         pb_log("%s: %p %s\n", __func__, dev, dev->id);
468
469         if (cui->current == &cui->main->scr)
470                 cui->current->unpost(cui->current);
471
472         /* This disconnects items array from menu. */
473
474         result = set_menu_items(cui->main->ncm, NULL);
475
476         if (result)
477                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
478
479         list_for_each_entry(&dev->boot_options, opt, list) {
480                 struct pmenu_item *i = pmenu_item_from_arg(opt->ui_info);
481                 struct cui_opt_data *cod = cod_from_item(i);
482
483                 assert(pb_protocol_device_cmp(dev, cod->dev));
484                 pmenu_remove(cui->main, i);
485
486                 /* If this is the default_item disable timer. */
487
488                 if (cod->opt_hash == cui->default_item)
489                         ui_timer_disable(&cui->timer);
490         }
491
492         /* Re-attach the items array. */
493
494         result = set_menu_items(cui->main->ncm, cui->main->items);
495
496         if (result)
497                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
498
499         if (0) {
500                 pb_log("%s\n", __func__);
501                 pmenu_dump_items(cui->main->items,
502                         item_count(cui->main->ncm) + 1);
503         }
504
505         if (cui->current == &cui->main->scr)
506                 cui->current->post(cui->current);
507 }
508
509 static struct discover_client_ops cui_client_ops = {
510         .device_add = cui_device_add,
511         .device_remove = cui_device_remove,
512 };
513
514 /**
515  * cui_init - Setup the cui instance.
516  * @platform_info: A value for the struct cui platform_info member.
517  *
518  * Returns a pointer to a struct cui on success, or NULL on error.
519  *
520  * Allocates the cui instance, sets up the client and stdin waiters, and
521  * sets up the ncurses menu screen.
522  */
523
524 struct cui *cui_init(void* platform_info,
525         int (*on_boot)(struct cui *, struct cui_opt_data *),
526         int (*js_map)(const struct js_event *e), int start_deamon, int dry_run)
527 {
528         struct cui *cui;
529         struct discover_client *client;
530         unsigned int i;
531
532         cui = talloc_zero(NULL, struct cui);
533
534         if (!cui) {
535                 pb_log("%s: alloc cui failed.\n", __func__);
536                 fprintf(stderr, "%s: alloc cui failed.\n", __func__);
537                 goto fail_alloc;
538         }
539
540         cui->c_sig = pb_cui_sig;
541         cui->platform_info = platform_info;
542         cui->on_boot = on_boot;
543         cui->timer.handle_timeout = cui_handle_timeout;
544         cui->dry_run = dry_run;
545         cui->waitset = waitset_create(cui);
546
547         /* Loop here for scripts that just started the server. */
548
549 retry_start:
550         for (i = start_deamon ? 2 : 10; i; i--) {
551                 client = discover_client_init(cui->waitset,
552                                 &cui_client_ops, cui);
553                 if (client || !i)
554                         break;
555                 pb_log("%s: waiting for server %d\n", __func__, i);
556                 sleep(1);
557         }
558
559         if (!client && start_deamon) {
560                 int result;
561
562                 start_deamon = 0;
563
564                 result = pb_start_daemon();
565
566                 if (!result)
567                         goto retry_start;
568
569                 pb_log("%s: discover_client_init failed.\n", __func__);
570                 fprintf(stderr, "%s: error: discover_client_init failed.\n",
571                         __func__);
572                 fprintf(stderr, "could not start pb-discover, the petitboot "
573                         "daemon.\n");
574                 goto fail_client_init;
575         }
576
577         if (!client) {
578                 pb_log("%s: discover_client_init failed.\n", __func__);
579                 fprintf(stderr, "%s: error: discover_client_init failed.\n",
580                         __func__);
581                 fprintf(stderr, "check that pb-discover, "
582                         "the petitboot daemon is running.\n");
583                 goto fail_client_init;
584         }
585
586         atexit(nc_atexit);
587         nc_start();
588
589         waiter_register(cui->waitset, STDIN_FILENO, WAIT_IN,
590                         cui_process_key, cui);
591
592         if (js_map) {
593
594                 cui->pjs = pjs_init(cui, js_map);
595
596                 if (cui->pjs)
597                         waiter_register(cui->waitset, pjs_get_fd(cui->pjs),
598                                         WAIT_IN, cui_process_js, cui);
599         }
600
601         return cui;
602
603 fail_client_init:
604         talloc_free(cui);
605 fail_alloc:
606         return NULL;
607 }
608
609 /**
610  * cui_run - The main cui program loop.
611  * @cui: The cui instance.
612  * @main: The menu to use as the main menu.
613  *
614  * Runs the cui engine.  Does not return until indicated to do so by some
615  * user action, or an error occurs.  Frees the cui object on return.
616  * Returns 0 on success (return to shell), -1 on error (should restart).
617  */
618
619 int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item)
620 {
621         assert(main);
622
623         cui->main = main;
624         cui->current = &cui->main->scr;
625         cui->default_item = default_item;
626
627         cui->current->post(cui->current);
628
629         while (1) {
630                 int result = waiter_poll(cui->waitset);
631
632                 if (result < 0 && errno != EINTR) {
633                         pb_log("%s: poll: %s\n", __func__, strerror(errno));
634                         break;
635                 }
636
637                 if (cui->abort)
638                         break;
639
640                 ui_timer_process_sig(&cui->timer);
641
642                 while (cui->resize) {
643                         cui->resize = 0;
644                         cui_handle_resize(cui);
645                 }
646         }
647
648         nc_atexit();
649
650         return cui->abort ? 0 : -1;
651 }