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