git.ozlabs.org Git - petitboot/blob - 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(" args   '%s'\n", cod->bd->args);
 162         }
 163
 164         cui_set_current(cui, &cui->main->scr);
 165
 166         talloc_free(boot_editor);
 167 }
 168
 169 int cui_boot_editor_run(struct pmenu_item *item)
 170 {
 171         struct cui *cui = cui_from_item(item);
 172         struct cui_opt_data *cod = cod_from_item(item);
 173         struct boot_editor *boot_editor;
 174
 175         boot_editor = boot_editor_init(cui, cod->bd, cui_boot_editor_on_exit);
 176         cui_set_current(cui, &boot_editor->scr);
 177
 178         return 0;
 179 }
 180
 181 /**
 182  * cui_set_current - Set the currently active screen and redraw it.
 183  */
 184
 185 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
 186 {
 187         struct nc_scr *old;
 188
 189         DBGS("%p -> %p\n", cui->current, scr);
 190
 191         assert(cui->current != scr);
 192
 193         old = cui->current;
 194         old->unpost(old);
 195
 196         cui->current = scr;
 197         cui->current->post(cui->current);
 198
 199         return old;
 200 }
 201
 202 /**
 203  * cui_process_key - Process input on stdin.
 204  */
 205
 206 static int cui_process_key(void *arg)
 207 {
 208         struct cui *cui = cui_from_arg(arg);
 209
 210         assert(cui->current);
 211
 212         ui_timer_disable(&cui->timer);
 213         cui->current->process_key(cui->current);
 214
 215         return 0;
 216 }
 217
 218 /**
 219  * cui_process_js - Process joystick events.
 220  */
 221
 222 static int cui_process_js(void *arg)
 223 {
 224         struct cui *cui = cui_from_arg(arg);
 225         int c;
 226
 227         c = pjs_process_event(cui->pjs);
 228
 229         if (c) {
 230                 ungetch(c);
 231                 cui_process_key(arg);
 232         }
 233
 234         return 0;
 235 }
 236
 237 /**
 238  * cui_handle_timeout - Handle the timeout.
 239  */
 240
 241 static void cui_handle_timeout(struct ui_timer *timer)
 242 {
 243         struct cui *cui = cui_from_timer(timer);
 244         struct pmenu_item *i = pmenu_find_selected(cui->main);
 245
 246 #if defined(DEBUG)
 247         {
 248                 struct cui_opt_data *cod = cod_from_item(i);
 249                 assert(cod && (cod->opt_hash == cui->default_item));
 250         }
 251 #endif
 252         i->on_execute(i);
 253 }
 254
 255 /**
 256  * cui_handle_resize - Handle the term resize.
 257  */
 258
 259 static void cui_handle_resize(struct cui *cui)
 260 {
 261         struct winsize ws;
 262
 263         if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
 264                 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
 265                 return;
 266         }
 267
 268         pb_log("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
 269
 270         wclear(cui->current->main_ncw);
 271         resize_term(ws.ws_row, ws.ws_col);
 272         cui->current->resize(cui->current);
 273
 274         /* For some reason this makes ncurses redraw the screen */
 275         getch();
 276         redrawwin(cui->current->main_ncw);
 277         wrefresh(cui->current->main_ncw);
 278 }
 279
 280 /**
 281  * cui_on_open - Open new item callback.
 282  */
 283
 284 void cui_on_open(struct pmenu *menu)
 285 {
 286         unsigned int insert_pt;
 287         struct pmenu_item *i;
 288         struct cui_opt_data *cod;
 289
 290         menu->scr.unpost(&menu->scr);
 291
 292         /* This disconnects items array from menu. */
 293
 294         set_menu_items(menu->ncm, NULL);
 295
 296         /* Insert new items at insert_pt. */
 297
 298         insert_pt = pmenu_grow(menu, 1);
 299         i = pmenu_item_alloc(menu);
 300
 301         i->on_edit = cui_boot_editor_run;
 302         i->on_execute = cui_boot;
 303         i->data = cod = talloc_zero(i, struct cui_opt_data);
 304
 305         cod->name = talloc_asprintf(i, "User item %u:", insert_pt);
 306         cod->bd = talloc_zero(i, struct pb_boot_data);
 307
 308         pmenu_item_setup(menu, i, insert_pt, talloc_strdup(i, cod->name));
 309
 310         /* Re-attach the items array. */
 311
 312         set_menu_items(menu->ncm, menu->items);
 313
 314         menu->scr.post(&menu->scr);
 315         set_current_item(menu->ncm, i->nci);
 316
 317         i->on_edit(i);
 318 }
 319
 320 /**
 321  * cui_device_add - Client device_add callback.
 322  *
 323  * Creates menu_items for all the device boot_options and inserts those
 324  * menu_items into the main menu.  Redraws the main menu if it is active.
 325  */
 326
 327 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
 328                 void *arg)
 329 {
 330         struct cui *cui = cui_from_arg(arg);
 331         struct cui_opt_data *cod;
 332         unsigned int insert_pt;
 333         struct pmenu_item *i;
 334         ITEM *selected;
 335         int result;
 336
 337         pb_log("%s: %p %s\n", __func__, opt, opt->id);
 338
 339         selected = current_item(cui->main->ncm);
 340
 341         if (cui->current == &cui->main->scr)
 342                 cui->current->unpost(cui->current);
 343
 344         /* This disconnects items array from menu. */
 345
 346         result = set_menu_items(cui->main->ncm, NULL);
 347
 348         if (result)
 349                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
 350
 351         /* Insert new items at insert_pt. */
 352         insert_pt = pmenu_grow(cui->main, 1);
 353
 354         /* Save the item in opt->ui_info for cui_device_remove() */
 355
 356         opt->ui_info = i = pmenu_item_alloc(cui->main);
 357
 358         i->on_edit = cui_boot_editor_run;
 359         i->on_execute = cui_boot;
 360         i->data = cod = talloc(i, struct cui_opt_data);
 361
 362         cod->opt = opt;
 363         cod->dev = dev;
 364         cod->opt_hash = pb_opt_hash(dev, opt);
 365         cod->name = opt->name;
 366         cod->bd = talloc(i, struct pb_boot_data);
 367
 368         cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
 369         cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
 370         cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
 371
 372         pmenu_item_setup(cui->main, i, insert_pt, cod->name);
 373
 374         pb_log("%s: adding opt '%s'\n", __func__, cod->name);
 375         pb_log("   image  '%s'\n", cod->bd->image);
 376         pb_log("   initrd '%s'\n", cod->bd->initrd);
 377         pb_log("   args   '%s'\n", cod->bd->args);
 378
 379         /* If this is the default_item select it and start timer. */
 380         if (cod->opt_hash == cui->default_item) {
 381                 selected = i->nci;
 382                 ui_timer_kick(&cui->timer);
 383         }
 384
 385         /* Re-attach the items array. */
 386         result = set_menu_items(cui->main->ncm, cui->main->items);
 387
 388         if (result)
 389                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
 390
 391         if (0) {
 392                 pb_log("%s\n", __func__);
 393                 pmenu_dump_items(cui->main->items,
 394                         item_count(cui->main->ncm) + 1);
 395         }
 396
 397         /* FIXME: need to make item visible somehow */
 398         menu_driver(cui->main->ncm, REQ_SCR_UPAGE);
 399         menu_driver(cui->main->ncm, REQ_SCR_DPAGE);
 400         set_current_item(cui->main->ncm, selected);
 401
 402         if (cui->current == &cui->main->scr)
 403                 cui->current->post(cui->current);
 404
 405         return 0;
 406 }
 407
 408 /**
 409  * cui_device_remove - Client device remove callback.
 410  *
 411  * Removes all the menu_items for the device from the main menu and redraws the
 412  * main menu if it is active.
 413  */
 414
 415 static void cui_device_remove(struct device *dev, void *arg)
 416 {
 417         struct cui *cui = cui_from_arg(arg);
 418         int result;
 419         struct boot_option *opt;
 420
 421         pb_log("%s: %p %s\n", __func__, dev, dev->id);
 422
 423         if (cui->current == &cui->main->scr)
 424                 cui->current->unpost(cui->current);
 425
 426         /* This disconnects items array from menu. */
 427
 428         result = set_menu_items(cui->main->ncm, NULL);
 429
 430         if (result)
 431                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
 432
 433         list_for_each_entry(&dev->boot_options, opt, list) {
 434                 struct pmenu_item *i = pmenu_item_from_arg(opt->ui_info);
 435                 struct cui_opt_data *cod = cod_from_item(i);
 436
 437                 assert(pb_protocol_device_cmp(dev, cod->dev));
 438                 pmenu_remove(cui->main, i);
 439
 440                 /* If this is the default_item disable timer. */
 441
 442                 if (cod->opt_hash == cui->default_item)
 443                         ui_timer_disable(&cui->timer);
 444         }
 445
 446         /* Re-attach the items array. */
 447
 448         result = set_menu_items(cui->main->ncm, cui->main->items);
 449
 450         if (result)
 451                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
 452
 453         if (0) {
 454                 pb_log("%s\n", __func__);
 455                 pmenu_dump_items(cui->main->items,
 456                         item_count(cui->main->ncm) + 1);
 457         }
 458
 459         if (cui->current == &cui->main->scr)
 460                 cui->current->post(cui->current);
 461 }
 462
 463 static void cui_update_status(struct boot_status *status, void *arg)
 464 {
 465         struct cui *cui = cui_from_arg(arg);
 466
 467         nc_scr_status_printf(cui->current,
 468                         "%s: %s",
 469                         status->type == BOOT_STATUS_ERROR ? "Error" : "Info",
 470                         status->message);
 471
 472 }
 473
 474 static struct discover_client_ops cui_client_ops = {
 475         .device_add = NULL,
 476         .boot_option_add = cui_boot_option_add,
 477         .device_remove = cui_device_remove,
 478         .update_status = cui_update_status,
 479 };
 480
 481 /**
 482  * cui_init - Setup the cui instance.
 483  * @platform_info: A value for the struct cui platform_info member.
 484  *
 485  * Returns a pointer to a struct cui on success, or NULL on error.
 486  *
 487  * Allocates the cui instance, sets up the client and stdin waiters, and
 488  * sets up the ncurses menu screen.
 489  */
 490
 491 struct cui *cui_init(void* platform_info,
 492         int (*js_map)(const struct js_event *e), int start_deamon)
 493 {
 494         struct cui *cui;
 495         unsigned int i;
 496
 497         cui = talloc_zero(NULL, struct cui);
 498
 499         if (!cui) {
 500                 pb_log("%s: alloc cui failed.\n", __func__);
 501                 fprintf(stderr, "%s: alloc cui failed.\n", __func__);
 502                 goto fail_alloc;
 503         }
 504
 505         cui->c_sig = pb_cui_sig;
 506         cui->platform_info = platform_info;
 507         cui->timer.handle_timeout = cui_handle_timeout;
 508         cui->waitset = waitset_create(cui);
 509
 510         /* Loop here for scripts that just started the server. */
 511
 512 retry_start:
 513         for (i = start_deamon ? 2 : 10; i; i--) {
 514                 cui->client = discover_client_init(cui->waitset,
 515                                 &cui_client_ops, cui);
 516                 if (cui->client || !i)
 517                         break;
 518                 pb_log("%s: waiting for server %d\n", __func__, i);
 519                 sleep(1);
 520         }
 521
 522         if (!cui->client && start_deamon) {
 523                 int result;
 524
 525                 start_deamon = 0;
 526
 527                 result = pb_start_daemon();
 528
 529                 if (!result)
 530                         goto retry_start;
 531
 532                 pb_log("%s: discover_client_init failed.\n", __func__);
 533                 fprintf(stderr, "%s: error: discover_client_init failed.\n",
 534                         __func__);
 535                 fprintf(stderr, "could not start pb-discover, the petitboot "
 536                         "daemon.\n");
 537                 goto fail_client_init;
 538         }
 539
 540         if (!cui->client) {
 541                 pb_log("%s: discover_client_init failed.\n", __func__);
 542                 fprintf(stderr, "%s: error: discover_client_init failed.\n",
 543                         __func__);
 544                 fprintf(stderr, "check that pb-discover, "
 545                         "the petitboot daemon is running.\n");
 546                 goto fail_client_init;
 547         }
 548
 549         atexit(nc_atexit);
 550         nc_start();
 551
 552         waiter_register(cui->waitset, STDIN_FILENO, WAIT_IN,
 553                         cui_process_key, cui);
 554
 555         if (js_map) {
 556
 557                 cui->pjs = pjs_init(cui, js_map);
 558
 559                 if (cui->pjs)
 560                         waiter_register(cui->waitset, pjs_get_fd(cui->pjs),
 561                                         WAIT_IN, cui_process_js, cui);
 562         }
 563
 564         return cui;
 565
 566 fail_client_init:
 567         talloc_free(cui);
 568 fail_alloc:
 569         return NULL;
 570 }
 571
 572 /**
 573  * cui_run - The main cui program loop.
 574  * @cui: The cui instance.
 575  * @main: The menu to use as the main menu.
 576  *
 577  * Runs the cui engine.  Does not return until indicated to do so by some
 578  * user action, or an error occurs.  Frees the cui object on return.
 579  * Returns 0 on success (return to shell), -1 on error (should restart).
 580  */
 581
 582 int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item)
 583 {
 584         assert(main);
 585
 586         cui->main = main;
 587         cui->current = &cui->main->scr;
 588         cui->default_item = default_item;
 589
 590         cui->current->post(cui->current);
 591
 592         while (1) {
 593                 int result = waiter_poll(cui->waitset);
 594
 595                 if (result < 0 && errno != EINTR) {
 596                         pb_log("%s: poll: %s\n", __func__, strerror(errno));
 597                         break;
 598                 }
 599
 600                 if (cui->abort)
 601                         break;
 602
 603                 ui_timer_process_sig(&cui->timer);
 604
 605                 while (cui->resize) {
 606                         cui->resize = 0;
 607                         cui_handle_resize(cui);
 608                 }
 609         }
 610
 611         nc_atexit();
 612
 613         return cui->abort ? 0 : -1;
 614 }