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 #if defined(HAVE_CONFIG_H)
  20 #include "config.h"
  21 #endif
  22
  23 #include <assert.h>
  24 #include <errno.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <locale.h>
  28 #include <sys/ioctl.h>
  29
  30 #include "log/log.h"
  31 #include "pb-protocol/pb-protocol.h"
  32 #include "talloc/talloc.h"
  33 #include "waiter/waiter.h"
  34 #include "process/process.h"
  35 #include "ui/common/discover-client.h"
  36 #include "ui/common/ui-system.h"
  37 #include "nc-cui.h"
  38 #include "nc-boot-editor.h"
  39 #include "nc-config.h"
  40 #include "nc-sysinfo.h"
  41 #include "nc-helpscreen.h"
  42
  43 static void cui_start(void)
  44 {
  45         initscr();                      /* Initialize ncurses. */
  46         cbreak();                       /* Disable line buffering. */
  47         noecho();                       /* Disable getch() echo. */
  48         keypad(stdscr, TRUE);           /* Enable num keypad keys. */
  49         nonl();                         /* Disable new-line translation. */
  50         intrflush(stdscr, FALSE);       /* Disable interrupt flush. */
  51         curs_set(0);                    /* Make cursor invisible */
  52         nodelay(stdscr, TRUE);          /* Enable non-blocking getch() */
  53
  54         /* We may be operating with an incorrect $TERM type; in this case
  55          * the keymappings will be slightly broken. We want at least
  56          * backspace to work though, so we'll define both DEL and ^H to
  57          * map to backspace */
  58         define_key("\x7f", KEY_BACKSPACE);
  59         define_key("\x08", KEY_BACKSPACE);
  60
  61         while (getch() != ERR)          /* flush stdin */
  62                 (void)0;
  63 }
  64
  65 static void cui_atexit(void)
  66 {
  67         clear();
  68         refresh();
  69         endwin();
  70 }
  71
  72 /**
  73  * cui_abort - Signal the main cui program loop to exit.
  74  *
  75  * Sets cui.abort, which causes the cui_run() routine to return.
  76  */
  77
  78 void cui_abort(struct cui *cui)
  79 {
  80         pb_log("%s: exiting\n", __func__);
  81         cui->abort = 1;
  82 }
  83
  84 /**
  85  * cui_resize - Signal the main cui program loop to resize
  86  *
  87  * Called at SIGWINCH.
  88  */
  89
  90 void cui_resize(struct cui *cui)
  91 {
  92         pb_debug("%s: resizing\n", __func__);
  93         cui->resize = 1;
  94 }
  95
  96 /**
  97  * cui_on_exit - A generic main menu exit callback.
  98  */
  99
 100 void cui_on_exit(struct pmenu *menu)
 101 {
 102         cui_abort(cui_from_pmenu(menu));
 103 }
 104
 105 /**
 106  * cui_run_cmd - A generic cb to run the supplied command.
 107  */
 108
 109 int cui_run_cmd(struct pmenu_item *item)
 110 {
 111         int result;
 112         struct cui *cui = cui_from_item(item);
 113         const char **cmd_argv = item->data;
 114
 115         nc_scr_status_printf(cui->current, "Running %s...", cmd_argv[0]);
 116
 117         def_prog_mode();
 118
 119         result = process_run_simple_argv(item, cmd_argv);
 120
 121         reset_prog_mode();
 122         redrawwin(cui->current->main_ncw);
 123
 124         if (result) {
 125                 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
 126                 nc_scr_status_printf(cui->current, "Failed: %s", cmd_argv[0]);
 127         }
 128
 129         return result;
 130 }
 131
 132 /**
 133  * cui_boot - A generic cb to run kexec.
 134  */
 135
 136 static int cui_boot(struct pmenu_item *item)
 137 {
 138         int result;
 139         struct cui *cui = cui_from_item(item);
 140         struct cui_opt_data *cod = cod_from_item(item);
 141
 142         assert(cui->current == &cui->main->scr);
 143
 144         pb_debug("%s: %s\n", __func__, cod->name);
 145
 146         nc_scr_status_printf(cui->current, "Booting %s...", cod->name);
 147
 148         result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
 149
 150         if (result) {
 151                 nc_scr_status_printf(cui->current,
 152                                 "Failed: boot %s", cod->bd->image);
 153         }
 154
 155         return 0;
 156 }
 157
 158 static void cui_boot_editor_on_exit(struct cui *cui,
 159                 struct pmenu_item *item,
 160                 struct pb_boot_data *bd)
 161 {
 162         struct pmenu *menu = cui->main;
 163         struct cui_opt_data *cod;
 164         static int user_idx = 0;
 165
 166         /* Was the edit cancelled? */
 167         if (!bd) {
 168                 cui_set_current(cui, &cui->main->scr);
 169                 talloc_free(cui->boot_editor);
 170                 cui->boot_editor = NULL;
 171                 return;
 172         }
 173
 174         /* Is this was a new item, we'll need to update the menu */
 175         if (!item) {
 176                 int insert_pt;
 177
 178                 /* Detach the items array. */
 179                 set_menu_items(menu->ncm, NULL);
 180
 181                 /* Insert new item at insert_pt. */
 182                 insert_pt = pmenu_grow(menu, 1);
 183                 item = pmenu_item_alloc(menu);
 184                 item->on_edit = cui_item_edit;
 185                 item->on_execute = cui_boot;
 186                 item->data = cod = talloc_zero(item, struct cui_opt_data);
 187
 188                 cod->name = talloc_asprintf(cod, "User item %u:", ++user_idx);
 189                 if (pmenu_item_setup(menu, item, insert_pt,
 190                                 talloc_strdup(item, cod->name)) == NULL) {
 191                         talloc_free(item);
 192                         item = NULL;
 193                 }
 194
 195                 /* Re-attach the items array. */
 196                 set_menu_items(menu->ncm, menu->items);
 197                 nc_scr_post(&menu->scr);
 198         } else {
 199                 cod = item->data;
 200         }
 201
 202         cod->bd = talloc_steal(cod, bd);
 203
 204         if (item)
 205                 set_current_item(item->pmenu->ncm, item->nci);
 206         cui_set_current(cui, &cui->main->scr);
 207         talloc_free(cui->boot_editor);
 208         cui->boot_editor = NULL;
 209 }
 210
 211 void cui_item_edit(struct pmenu_item *item)
 212 {
 213         struct cui *cui = cui_from_item(item);
 214         cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
 215                                         cui_boot_editor_on_exit);
 216         cui_set_current(cui, boot_editor_scr(cui->boot_editor));
 217 }
 218
 219 void cui_item_new(struct pmenu *menu)
 220 {
 221         struct cui *cui = cui_from_pmenu(menu);
 222         cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
 223                                         cui_boot_editor_on_exit);
 224         cui_set_current(cui, boot_editor_scr(cui->boot_editor));
 225 }
 226
 227 static void cui_sysinfo_exit(struct cui *cui)
 228 {
 229         cui_set_current(cui, &cui->main->scr);
 230         talloc_free(cui->sysinfo_screen);
 231         cui->sysinfo_screen = NULL;
 232 }
 233
 234 void cui_show_sysinfo(struct cui *cui)
 235 {
 236         cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
 237                         cui_sysinfo_exit);
 238         cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
 239 }
 240
 241 static void cui_config_exit(struct cui *cui)
 242 {
 243         cui_set_current(cui, &cui->main->scr);
 244         talloc_free(cui->config_screen);
 245         cui->config_screen = NULL;
 246 }
 247
 248 void cui_show_config(struct cui *cui)
 249 {
 250         cui->config_screen = config_screen_init(cui, cui->config,
 251                         cui->sysinfo, cui_config_exit);
 252         cui_set_current(cui, config_screen_scr(cui->config_screen));
 253 }
 254
 255 static void cui_help_exit(struct cui *cui)
 256 {
 257         cui_set_current(cui, help_screen_return_scr(cui->help_screen));
 258         talloc_free(cui->help_screen);
 259         cui->help_screen = NULL;
 260 }
 261
 262 void cui_show_help(struct cui *cui, const char *title, const char *text)
 263 {
 264         if (!cui->current)
 265                 return;
 266
 267         if (cui->help_screen)
 268                 return;
 269
 270         cui->help_screen = help_screen_init(cui, cui->current,
 271                         title, text, cui_help_exit);
 272
 273         if (cui->help_screen)
 274                 cui_set_current(cui, help_screen_scr(cui->help_screen));
 275 }
 276
 277 /**
 278  * cui_set_current - Set the currently active screen and redraw it.
 279  */
 280
 281 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
 282 {
 283         struct nc_scr *old;
 284
 285         DBGS("%p -> %p\n", cui->current, scr);
 286
 287         assert(cui->current != scr);
 288
 289         old = cui->current;
 290         nc_scr_unpost(old);
 291
 292         cui->current = scr;
 293
 294         nc_scr_post(cui->current);
 295
 296         return old;
 297 }
 298
 299 static bool process_global_keys(struct cui *cui, int key)
 300 {
 301         switch (key) {
 302         case 0xc:
 303                 if (cui->current && cui->current->main_ncw)
 304                         wrefresh(curscr);
 305                 return true;
 306         }
 307         return false;
 308 }
 309
 310 /**
 311  * cui_process_key - Process input on stdin.
 312  */
 313
 314 static int cui_process_key(void *arg)
 315 {
 316         struct cui *cui = cui_from_arg(arg);
 317
 318         assert(cui->current);
 319
 320         if (!cui->has_input)
 321                 discover_client_cancel_default(cui->client);
 322         cui->has_input = true;
 323
 324         for (;;) {
 325                 int c = getch();
 326
 327                 pb_debug("%s: got key %d\n", __func__, c);
 328
 329                 if (c == ERR)
 330                         break;
 331
 332                 if (process_global_keys(cui, c))
 333                         continue;
 334
 335                 cui->current->process_key(cui->current, c);
 336         }
 337
 338         return 0;
 339 }
 340
 341 /**
 342  * cui_process_js - Process joystick events.
 343  */
 344
 345 static int cui_process_js(void *arg)
 346 {
 347         struct cui *cui = cui_from_arg(arg);
 348         int c;
 349
 350         c = pjs_process_event(cui->pjs);
 351
 352         if (c) {
 353                 ungetch(c);
 354                 cui_process_key(arg);
 355         }
 356
 357         return 0;
 358 }
 359
 360 /**
 361  * cui_handle_resize - Handle the term resize.
 362  */
 363
 364 static void cui_handle_resize(struct cui *cui)
 365 {
 366         struct winsize ws;
 367
 368         if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
 369                 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
 370                 return;
 371         }
 372
 373         pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
 374
 375         wclear(cui->current->main_ncw);
 376         resize_term(ws.ws_row, ws.ws_col);
 377         cui->current->resize(cui->current);
 378
 379         /* For some reason this makes ncurses redraw the screen */
 380         getch();
 381         redrawwin(cui->current->main_ncw);
 382         wrefresh(cui->current->main_ncw);
 383 }
 384
 385 /**
 386  * cui_device_add - Client device_add callback.
 387  *
 388  * Creates menu_items for all the device boot_options and inserts those
 389  * menu_items into the main menu.  Redraws the main menu if it is active.
 390  */
 391
 392 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
 393                 void *arg)
 394 {
 395         struct cui *cui = cui_from_arg(arg);
 396         struct cui_opt_data *cod;
 397         unsigned int insert_pt;
 398         int result, rows, cols;
 399         struct pmenu_item *i;
 400         ITEM *selected;
 401
 402         pb_debug("%s: %p %s\n", __func__, opt, opt->id);
 403
 404         selected = current_item(cui->main->ncm);
 405         menu_format(cui->main->ncm, &rows, &cols);
 406
 407         if (cui->current == &cui->main->scr)
 408                 nc_scr_unpost(cui->current);
 409
 410         /* This disconnects items array from menu. */
 411
 412         result = set_menu_items(cui->main->ncm, NULL);
 413
 414         if (result)
 415                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
 416
 417         /* Insert new items at insert_pt. */
 418         insert_pt = pmenu_grow(cui->main, 1);
 419
 420         /* Save the item in opt->ui_info for cui_device_remove() */
 421
 422         opt->ui_info = i = pmenu_item_alloc(cui->main);
 423
 424         i->on_edit = cui_item_edit;
 425         i->on_execute = cui_boot;
 426         i->data = cod = talloc(i, struct cui_opt_data);
 427
 428         cod->opt = opt;
 429         cod->dev = dev;
 430         cod->opt_hash = pb_opt_hash(dev, opt);
 431         cod->name = opt->name;
 432         cod->bd = talloc(i, struct pb_boot_data);
 433
 434         cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
 435         cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
 436         cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
 437         cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
 438
 439         pmenu_item_setup(cui->main, i, insert_pt, cod->name);
 440
 441         pb_log("%s: adding opt '%s'\n", __func__, cod->name);
 442         pb_log("   image  '%s'\n", cod->bd->image);
 443         pb_log("   initrd '%s'\n", cod->bd->initrd);
 444         pb_log("   args   '%s'\n", cod->bd->args);
 445
 446         /* Re-attach the items array. */
 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 (!item_visible(selected)) {
 459                 int idx, top;
 460
 461                 top = top_row(cui->main->ncm);
 462                 idx = item_index(selected);
 463
 464                 /* If our index is above the current top row, align
 465                  * us to the new top. Otherwise, align us to the new
 466                  * bottom */
 467                 top = top < idx ? idx - rows : idx;
 468
 469                 set_top_row(cui->main->ncm, top);
 470                 set_current_item(cui->main->ncm, selected);
 471         }
 472
 473         if (cui->current == &cui->main->scr)
 474                 nc_scr_post(cui->current);
 475
 476         return 0;
 477 }
 478
 479 /**
 480  * cui_device_remove - Client device remove callback.
 481  *
 482  * Removes all the menu_items for the device from the main menu and redraws the
 483  * main menu if it is active.
 484  */
 485
 486 static void cui_device_remove(struct device *dev, void *arg)
 487 {
 488         struct cui *cui = cui_from_arg(arg);
 489         int result;
 490         struct boot_option *opt;
 491
 492         pb_log("%s: %p %s\n", __func__, dev, dev->id);
 493
 494         if (cui->current == &cui->main->scr)
 495                 nc_scr_unpost(cui->current);
 496
 497         /* This disconnects items array from menu. */
 498
 499         result = set_menu_items(cui->main->ncm, NULL);
 500
 501         if (result)
 502                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
 503
 504         list_for_each_entry(&dev->boot_options, opt, list) {
 505                 struct pmenu_item *i = pmenu_item_from_arg(opt->ui_info);
 506
 507                 assert(pb_protocol_device_cmp(dev, cod_from_item(i)->dev));
 508                 pmenu_remove(cui->main, i);
 509         }
 510
 511         /* Re-attach the items array. */
 512
 513         result = set_menu_items(cui->main->ncm, cui->main->items);
 514
 515         if (result)
 516                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
 517
 518         if (0) {
 519                 pb_log("%s\n", __func__);
 520                 pmenu_dump_items(cui->main->items,
 521                         item_count(cui->main->ncm) + 1);
 522         }
 523
 524         if (cui->current == &cui->main->scr)
 525                 nc_scr_post(cui->current);
 526 }
 527
 528 static void cui_update_status(struct boot_status *status, void *arg)
 529 {
 530         struct cui *cui = cui_from_arg(arg);
 531
 532         nc_scr_status_printf(cui->current,
 533                         "%s: %s",
 534                         status->type == BOOT_STATUS_ERROR ? "Error" : "Info",
 535                         status->message);
 536
 537 }
 538
 539 static void cui_update_mm_title(struct cui *cui)
 540 {
 541         struct nc_frame *frame = &cui->main->scr.frame;
 542
 543         talloc_free(frame->rtitle);
 544
 545         frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
 546         if (cui->sysinfo->identifier)
 547                 frame->rtitle = talloc_asprintf_append(frame->rtitle,
 548                                 " %s", cui->sysinfo->identifier);
 549
 550         if (cui->current == &cui->main->scr)
 551                 nc_scr_post(cui->current);
 552 }
 553
 554 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
 555 {
 556         struct cui *cui = cui_from_arg(arg);
 557         cui->sysinfo = talloc_steal(cui, sysinfo);
 558
 559         /* if we're currently displaying the system info screen, inform it
 560          * of the updated information. */
 561         if (cui->sysinfo_screen)
 562                 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
 563
 564         /* ... and do the same with the config screen... */
 565         if (cui->config_screen)
 566                 config_screen_update(cui->config_screen, cui->config, sysinfo);
 567
 568         /* ... and the boot editor. */
 569         if (cui->boot_editor)
 570                 boot_editor_update(cui->boot_editor, sysinfo);
 571
 572         cui_update_mm_title(cui);
 573 }
 574
 575 static void cui_update_config(struct config *config, void *arg)
 576 {
 577         struct cui *cui = cui_from_arg(arg);
 578         cui->config = talloc_steal(cui, config);
 579
 580         if (cui->config_screen)
 581                 config_screen_update(cui->config_screen, config, cui->sysinfo);
 582 }
 583
 584 int cui_send_config(struct cui *cui, struct config *config)
 585 {
 586         return discover_client_send_config(cui->client, config);
 587 }
 588
 589 void cui_send_reinit(struct cui *cui)
 590 {
 591         discover_client_send_reinit(cui->client);
 592 }
 593
 594 static struct discover_client_ops cui_client_ops = {
 595         .device_add = NULL,
 596         .boot_option_add = cui_boot_option_add,
 597         .device_remove = cui_device_remove,
 598         .update_status = cui_update_status,
 599         .update_sysinfo = cui_update_sysinfo,
 600         .update_config = cui_update_config,
 601 };
 602
 603 /**
 604  * cui_init - Setup the cui instance.
 605  * @platform_info: A value for the struct cui platform_info member.
 606  *
 607  * Returns a pointer to a struct cui on success, or NULL on error.
 608  *
 609  * Allocates the cui instance, sets up the client and stdin waiters, and
 610  * sets up the ncurses menu screen.
 611  */
 612
 613 struct cui *cui_init(void* platform_info,
 614         int (*js_map)(const struct js_event *e), int start_deamon)
 615 {
 616         struct cui *cui;
 617         unsigned int i;
 618
 619         cui = talloc_zero(NULL, struct cui);
 620
 621         if (!cui) {
 622                 pb_log("%s: alloc cui failed.\n", __func__);
 623                 fprintf(stderr, "%s: alloc cui failed.\n", __func__);
 624                 goto fail_alloc;
 625         }
 626
 627         cui->c_sig = pb_cui_sig;
 628         cui->platform_info = platform_info;
 629         cui->waitset = waitset_create(cui);
 630
 631         process_init(cui, cui->waitset, false);
 632
 633         setlocale(LC_ALL, "");
 634
 635         /* Loop here for scripts that just started the server. */
 636
 637 retry_start:
 638         for (i = start_deamon ? 2 : 10; i; i--) {
 639                 cui->client = discover_client_init(cui->waitset,
 640                                 &cui_client_ops, cui);
 641                 if (cui->client || !i)
 642                         break;
 643                 pb_log("%s: waiting for server %d\n", __func__, i);
 644                 sleep(1);
 645         }
 646
 647         if (!cui->client && start_deamon) {
 648                 int result;
 649
 650                 start_deamon = 0;
 651
 652                 result = pb_start_daemon(cui);
 653
 654                 if (!result)
 655                         goto retry_start;
 656
 657                 pb_log("%s: discover_client_init failed.\n", __func__);
 658                 fprintf(stderr, "%s: error: discover_client_init failed.\n",
 659                         __func__);
 660                 fprintf(stderr, "could not start pb-discover, the petitboot "
 661                         "daemon.\n");
 662                 goto fail_client_init;
 663         }
 664
 665         if (!cui->client) {
 666                 pb_log("%s: discover_client_init failed.\n", __func__);
 667                 fprintf(stderr, "%s: error: discover_client_init failed.\n",
 668                         __func__);
 669                 fprintf(stderr, "check that pb-discover, "
 670                         "the petitboot daemon is running.\n");
 671                 goto fail_client_init;
 672         }
 673
 674         atexit(cui_atexit);
 675         cui_start();
 676
 677         waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
 678                         cui_process_key, cui);
 679
 680         if (js_map) {
 681
 682                 cui->pjs = pjs_init(cui, js_map);
 683
 684                 if (cui->pjs)
 685                         waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
 686                                         WAIT_IN, cui_process_js, cui);
 687         }
 688
 689         return cui;
 690
 691 fail_client_init:
 692         talloc_free(cui);
 693 fail_alloc:
 694         return NULL;
 695 }
 696
 697 /**
 698  * cui_run - The main cui program loop.
 699  * @cui: The cui instance.
 700  * @main: The menu to use as the main menu.
 701  *
 702  * Runs the cui engine.  Does not return until indicated to do so by some
 703  * user action, or an error occurs.  Frees the cui object on return.
 704  * Returns 0 on success (return to shell), -1 on error (should restart).
 705  */
 706
 707 int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item)
 708 {
 709         assert(main);
 710
 711         cui->main = main;
 712         cui->current = &cui->main->scr;
 713         cui->default_item = default_item;
 714
 715         nc_scr_post(cui->current);
 716
 717         while (1) {
 718                 int result = waiter_poll(cui->waitset);
 719
 720                 if (result < 0) {
 721                         pb_log("%s: poll: %s\n", __func__, strerror(errno));
 722                         break;
 723                 }
 724
 725                 if (cui->abort)
 726                         break;
 727
 728                 while (cui->resize) {
 729                         cui->resize = 0;
 730                         cui_handle_resize(cui);
 731                 }
 732         }
 733
 734         cui_atexit();
 735
 736         return cui->abort ? 0 : -1;
 737 }