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