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 "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_on_exit - A generic main menu ESC callback.
  64  */
  65
  66 void cui_on_exit(struct pmenu *menu)
  67 {
  68         cui_abort(cui_from_pmenu(menu));
  69 }
  70
  71 /**
  72  * cui_run_cmd - A generic cb to run the supplied command.
  73  */
  74
  75 int cui_run_cmd(struct pmenu_item *item)
  76 {
  77         int result;
  78         struct cui *cui = cui_from_item(item);
  79         const char *const *cmd_argv = item->data;
  80
  81         nc_scr_status_printf(cui->current, "Running %s...", cmd_argv[0]);
  82
  83         def_prog_mode();
  84
  85         result = pb_run_cmd(cmd_argv);
  86
  87         reset_prog_mode();
  88         redrawwin(cui->current->main_ncw);
  89
  90         if (result) {
  91                 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
  92                 nc_scr_status_printf(cui->current, "Failed: %s", cmd_argv[0]);
  93         }
  94
  95         return result;
  96 }
  97
  98 /**
  99  * cui_run_kexec - A generic cb to run kexec.
 100  */
 101
 102 static int cui_run_kexec(struct pmenu_item *item)
 103 {
 104         int result;
 105         struct cui *cui = cui_from_item(item);
 106         struct cui_opt_data *cod = cod_from_item(item);
 107
 108         assert(cui->current == &cui->main->scr);
 109         assert(cui->on_kexec);
 110
 111         pb_log("%s: %s\n", __func__, cod->name);
 112         nc_scr_status_printf(cui->current, "Booting %s...", cod->name);
 113
 114         def_prog_mode();
 115
 116         result = cui->on_kexec(cui, cod);
 117
 118         reset_prog_mode();
 119         redrawwin(cui->current->main_ncw);
 120
 121         if (!result) {
 122                 clear();
 123                 mvaddstr(1, 0, "system is going down now...");
 124                 refresh();
 125                 sleep(60);
 126         }
 127
 128         pb_log("%s: failed: %s\n", __func__, cod->kd->image);
 129         nc_scr_status_printf(cui->current, "Failed: kexec %s", cod->kd->image);
 130
 131         return 0;
 132 }
 133
 134 /**
 135  * cui_ked_on_exit - The ked on_exit callback.
 136  */
 137
 138 static void cui_ked_on_exit(struct ked *ked, enum ked_result ked_result,
 139         struct pb_kexec_data *kd)
 140 {
 141         struct cui *cui = cui_from_arg(ked->scr.ui_ctx);
 142
 143         if (ked_result == ked_update) {
 144                 struct pmenu_item *i = pmenu_find_selected(cui->main);
 145                 struct cui_opt_data *cod = cod_from_item(i);
 146
 147                 assert(kd);
 148
 149                 talloc_steal(i, kd);
 150                 talloc_free(cod->kd);
 151                 cod->kd = kd;
 152
 153                 pb_log("%s: updating opt '%s'\n", __func__, cod->name);
 154                 pb_log(" image  '%s'\n", cod->kd->image);
 155                 pb_log(" initrd '%s'\n", cod->kd->initrd);
 156                 pb_log(" args   '%s'\n", cod->kd->args);
 157         }
 158
 159         cui_set_current(cui, &cui->main->scr);
 160
 161         talloc_free(ked);
 162 }
 163
 164 int cui_ked_run(struct pmenu_item *item)
 165 {
 166         struct cui *cui = cui_from_item(item);
 167         struct ked *ked;
 168
 169         ked = ked_init(cui, cod_from_item(item)->kd, cui_ked_on_exit);
 170
 171         cui_set_current(cui, &ked->scr);
 172
 173         return 0;
 174 }
 175
 176 /**
 177  * cui_set_current - Set the currently active screen and redraw it.
 178  */
 179
 180 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
 181 {
 182         struct nc_scr *old;
 183
 184         DBGS("%p -> %p\n", cui->current, scr);
 185
 186         assert(cui->current != scr);
 187
 188         old = cui->current;
 189         old->unpost(old);
 190
 191         cui->current = scr;
 192         cui->current->post(cui->current);
 193
 194         return old;
 195 }
 196
 197 static int cui_process_key(void *arg)
 198 {
 199         struct cui *cui = cui_from_arg(arg);
 200
 201         assert(cui->current);
 202
 203         ui_timer_disable(&cui->timer);
 204         cui->current->process_key(cui->current);
 205
 206         return 0;
 207 }
 208
 209 /**
 210  * cui_client_process_socket - Process a socket event from the discover server.
 211  */
 212
 213 static int cui_client_process_socket(void *arg)
 214 {
 215         struct discover_client *client = arg;
 216
 217         discover_client_process(client);
 218         return 0;
 219 }
 220
 221 /**
 222  * cui_handle_timeout - Handle the timeout.
 223  */
 224
 225 static void cui_handle_timeout(struct ui_timer *timer)
 226 {
 227         struct cui *cui = cui_from_timer(timer);
 228         struct pmenu_item *i = pmenu_find_selected(cui->main);
 229
 230 #if defined(DEBUG)
 231         {
 232                 struct cui_opt_data *cod = cod_from_item(i);
 233                 assert(cod && (cod->opt_hash == cui->default_item));
 234         }
 235 #endif
 236         i->on_execute(i);
 237 }
 238
 239 /**
 240  * cui_handle_resize - Handle the term resize.
 241  */
 242
 243 static void cui_handle_resize(struct cui *cui)
 244 {
 245         struct winsize ws;
 246
 247         if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
 248                 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
 249                 return;
 250         }
 251
 252         pb_log("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
 253
 254         wclear(cui->current->main_ncw);
 255         resize_term(ws.ws_row, ws.ws_col);
 256         cui->current->resize(cui->current);
 257
 258         /* For some reason this makes ncurses redraw the screen */
 259         getch();
 260         redrawwin(cui->current->main_ncw);
 261         wrefresh(cui->current->main_ncw);
 262 }
 263
 264 /**
 265  * cui_on_open - Open new item callback.
 266  */
 267
 268 void cui_on_open(struct pmenu *menu)
 269 {
 270         unsigned int insert_pt;
 271         struct pmenu_item *i;
 272         struct cui_opt_data *cod;
 273         char *name;
 274
 275         menu->scr.unpost(&menu->scr);
 276
 277         /* This disconnects items array from menu. */
 278
 279         set_menu_items(menu->ncm, NULL);
 280
 281         /* Insert new items at insert_pt. */
 282
 283         insert_pt = pmenu_grow(menu, 1);
 284         i = pmenu_item_alloc(menu);
 285
 286         name = talloc_asprintf(i, "User item %u:", insert_pt);
 287         pmenu_item_setup(menu, i, insert_pt, name);
 288
 289         i->on_edit = cui_ked_run;
 290         i->on_execute = cui_run_kexec;
 291         i->data = cod = talloc_zero(i, struct cui_opt_data);
 292
 293         cod->kd = talloc_zero(i, struct pb_kexec_data);
 294         cod->name = name;
 295
 296         /* Re-attach the items array. */
 297
 298         set_menu_items(menu->ncm, menu->items);
 299
 300         set_current_item(menu->ncm, i->nci);
 301         menu->scr.post(&menu->scr);
 302         pos_menu_cursor(menu->ncm);
 303
 304         i->on_edit(i);
 305 }
 306
 307 /**
 308  * cui_device_add - Client device_add callback.
 309  *
 310  * Creates menu_items for all the device boot_options and inserts those
 311  * menu_items into the main menu.  Redraws the main menu if it is active.
 312  */
 313
 314 static int cui_device_add(struct device *dev, void *arg)
 315 {
 316         struct cui *cui = cui_from_arg(arg);
 317         int result;
 318         struct boot_option *opt;
 319         unsigned int o_count; /* device opts */
 320         unsigned int insert_pt;
 321         ITEM *selected;
 322
 323         pb_log("%s: %p %s\n", __func__, dev, dev->id);
 324
 325         selected = current_item(cui->main->ncm);
 326
 327         if (cui->current == &cui->main->scr)
 328                 cui->current->unpost(cui->current);
 329
 330         /* This disconnects items array from menu. */
 331
 332         result = set_menu_items(cui->main->ncm, NULL);
 333
 334         if (result)
 335                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
 336
 337         o_count = 0;
 338         list_for_each_entry(&dev->boot_options, opt, list)
 339                 o_count++;
 340
 341         /* Insert new items at insert_pt. */
 342
 343         insert_pt = pmenu_grow(cui->main, o_count);
 344
 345         list_for_each_entry(&dev->boot_options, opt, list) {
 346                 struct pmenu_item *i;
 347                 struct cui_opt_data *cod;
 348                 char *name;
 349
 350                 /* Save the item in opt->ui_info for cui_device_remove() */
 351
 352                 opt->ui_info = i = pmenu_item_alloc(cui->main);
 353
 354                 name = talloc_asprintf(i, "%s: %s", opt->name,
 355                         opt->description);
 356
 357                 pmenu_item_setup(cui->main, i, insert_pt, name);
 358
 359                 i->on_edit = cui_ked_run;
 360                 i->on_execute = cui_run_kexec;
 361                 i->data = cod = talloc(i, struct cui_opt_data);
 362
 363                 cod->dev = dev;
 364                 cod->opt = opt;
 365                 cod->opt_hash = pb_opt_hash(dev, opt);
 366                 cod->name = opt->name;
 367                 cod->kd = talloc(i, struct pb_kexec_data);
 368
 369                 cod->kd->image = talloc_strdup(cod->kd, opt->boot_image_file);
 370                 cod->kd->initrd = talloc_strdup(cod->kd, opt->initrd_file);
 371                 cod->kd->args = talloc_strdup(cod->kd, opt->boot_args);
 372
 373                 insert_pt++;
 374
 375                 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
 376                 pb_log("   image  '%s'\n", cod->kd->image);
 377                 pb_log("   initrd '%s'\n", cod->kd->initrd);
 378                 pb_log("   args   '%s'\n", cod->kd->args);
 379
 380                 /* If this is the default_item select it and start timer. */
 381
 382                 if (cod->opt_hash == cui->default_item) {
 383                         selected = i->nci;
 384                         ui_timer_kick(&cui->timer);
 385                 }
 386         }
 387
 388         /* Re-attach the items array. */
 389
 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                 /* If this is the default_item disable timer. */
 445
 446                 if (cod->opt_hash == cui->default_item)
 447                         ui_timer_disable(&cui->timer);
 448         }
 449
 450         /* Re-attach the items array. */
 451
 452         result = set_menu_items(cui->main->ncm, cui->main->items);
 453
 454         if (result)
 455                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
 456
 457         if (0) {
 458                 pb_log("%s\n", __func__);
 459                 pmenu_dump_items(cui->main->items,
 460                         item_count(cui->main->ncm) + 1);
 461         }
 462
 463         if (cui->current == &cui->main->scr)
 464                 cui->current->post(cui->current);
 465 }
 466
 467 static struct discover_client_ops cui_client_ops = {
 468         .device_add = cui_device_add,
 469         .device_remove = cui_device_remove,
 470 };
 471
 472 /**
 473  * cui_init - Setup the cui instance.
 474  * @platform_info: A value for the struct cui platform_info member.
 475  *
 476  * Returns a pointer to a struct cui on success, or NULL on error.
 477  *
 478  * Allocates the cui instance, sets up the client and stdin waiters, and
 479  * sets up the ncurses menu screen.
 480  */
 481
 482 struct cui *cui_init(void* platform_info,
 483         int (*on_kexec)(struct cui *, struct cui_opt_data *))
 484 {
 485         struct cui *cui;
 486         struct discover_client *client;
 487         unsigned int i;
 488
 489         cui = talloc_zero(NULL, struct cui);
 490
 491         if (!cui) {
 492                 pb_log("%s: alloc cui failed.\n", __func__);
 493                 fprintf(stderr, "%s: alloc cui failed.\n", __func__);
 494                 goto fail_alloc;
 495         }
 496
 497         cui->c_sig = pb_cui_sig;
 498         cui->platform_info = platform_info;
 499         cui->on_kexec = on_kexec;
 500         cui->timer.handle_timeout = cui_handle_timeout;
 501
 502         /* Loop here for scripts that just started the server. */
 503
 504         for (i = 10; i; i--) {
 505                 client = discover_client_init(&cui_client_ops, cui);
 506                 if (client)
 507                         break;
 508                 pb_log("%s: waiting for server %d\n", __func__, i);
 509                 sleep(1);
 510         }
 511
 512         if (!client) {
 513                 pb_log("%s: discover_client_init failed.\n", __func__);
 514                 fprintf(stderr, "%s: error: discover_client_init failed.\n",
 515                         __func__);
 516                 fprintf(stderr, "check that pb-discover, "
 517                         "the petitboot daemon is running.\n");
 518                 goto fail_client_init;
 519         }
 520
 521         atexit(nc_atexit);
 522         nc_start();
 523
 524         waiter_register(discover_client_get_fd(client), WAIT_IN,
 525                 cui_client_process_socket, client);
 526
 527         waiter_register(STDIN_FILENO, WAIT_IN, cui_process_key, cui);
 528
 529         return cui;
 530
 531 fail_client_init:
 532         talloc_free(cui);
 533 fail_alloc:
 534         return NULL;
 535 }
 536
 537 /**
 538  * cui_run - The main cui program loop.
 539  * @cui: The cui instance.
 540  * @main: The menu to use as the main menu.
 541  *
 542  * Runs the cui engine.  Does not return until indicated to do so by some
 543  * user action, or an error occurs.  Frees the cui object on return.
 544  * Returns 0 on success (return to shell), -1 on error (should restart).
 545  */
 546
 547 int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item)
 548 {
 549         assert(main);
 550
 551         cui->main = main;
 552         cui->current = &cui->main->scr;
 553         cui->default_item = default_item;
 554
 555         cui->current->post(cui->current);
 556
 557         while (1) {
 558                 int result = waiter_poll();
 559
 560                 if (result < 0 && errno != EINTR) {
 561                         pb_log("%s: poll: %s\n", __func__, strerror(errno));
 562                         break;
 563                 }
 564
 565                 if (cui->abort)
 566                         break;
 567
 568                 ui_timer_process_sig(&cui->timer);
 569
 570                 while (cui->resize) {
 571                         cui->resize = 0;
 572                         cui_handle_resize(cui);
 573                 }
 574         }
 575
 576         nc_atexit();
 577
 578         return cui->abort ? 0 : -1;
 579 }