Add helper routines to support ncurses UI programs. Signed-off-by: Geoff Levand --- rules.mk | 2 ui/ncurses/nc-cui.c | 513 ++++++++++++++++++++++++++++++++++++++++++++++++++++ ui/ncurses/nc-cui.h | 88 ++++++++ 3 files changed, 602 insertions(+), 1 deletion(-) --- a/rules.mk +++ b/rules.mk @@ -51,7 +51,7 @@ discover_objs = discover/event.o discove ui_common_objs = ui/common/discover-client.o ui/common/loader.o \ ui/common/ui-system.o ui/common/url.o ncurses_objs = ui/ncurses/nc-scr.o ui/ncurses/nc-menu.o \ - ui/ncurses/nc-ked.o + ui/ncurses/nc-ked.o ui/ncurses/nc-cui.o twin_objs = ui/twin/pb-twin.o # Makefiles --- /dev/null +++ b/ui/ncurses/nc-cui.c @@ -0,0 +1,513 @@ +/* + * Copyright (C) 2009 Sony Computer Entertainment Inc. + * Copyright 2009 Sony Corp. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#define _GNU_SOURCE + +#include +#include +#include +#include +#include + +#include "log/log.h" +#include "talloc/talloc.h" +#include "waiter/waiter.h" +#include "ui/common/discover-client.h" +#include "nc-cui.h" + + +static struct cui_opt_data *cod_from_item(struct pmenu_item *item) +{ + return item->data; +} + +/** + * cui_abort - Signal the main cui program loop to exit. + * + * Sets cui.abort, which causes the cui_run() routine to return. + */ + +void cui_abort(struct cui *cui) +{ + pb_log("%s: exiting\n", __func__); + cui->abort = 1; +} + +/** + * cui_resize - Signal the main cui program loop to resize + * + * Called at SIGWINCH. + */ + +void cui_resize(struct cui *cui) +{ + pb_log("%s: resizing\n", __func__); + cui->resize = 1; +} + +/** + * cui_on_exit - A generic main menu ESC callback. + */ + +void cui_on_exit(struct pmenu *menu) +{ + cui_abort(cui_from_pmenu(menu)); +} + +/** + * cui_run_cmd - A generic cb to run the supplied command. + */ + +int cui_run_cmd(struct pmenu_item *item) +{ + int result; + struct cui *cui = cui_from_item(item); + const char *const *cmd_argv = item->data; + + nc_scr_status_printf(cui->current, "Running %s...", cmd_argv[0]); + + def_prog_mode(); + + result = pb_run_cmd(cmd_argv); + + reset_prog_mode(); + redrawwin(cui->current->main_ncw); + + if (result) { + pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]); + nc_scr_status_printf(cui->current, "Failed: %s", cmd_argv[0]); + } + + return result; +} + +/** + * cui_run_kexec - A generic cb to run kexec. + */ + +static int cui_run_kexec(struct pmenu_item *item) +{ + int result; + struct cui *cui = cui_from_item(item); + struct cui_opt_data *cod = cod_from_item(item); + + assert(cui->current == &cui->main->scr); + assert(cui->on_kexec); + + pb_log("%s: %s\n", __func__, cod->dev->name, cod->opt->name); + nc_scr_status_printf(cui->current, "Booting %s...", cod->opt->name); + + def_prog_mode(); + + result = cui->on_kexec(cui, cod); + + reset_prog_mode(); + redrawwin(cui->current->main_ncw); + + if (!result) { + clear(); + mvaddstr(1, 0, "system is going down now..."); + refresh(); + sleep(60); + } + + pb_log("%s: failed: %s\n", __func__, cod->kd->image); + nc_scr_status_printf(cui->current, "Failed: kexec %s", cod->kd->image); + + return 0; +} + +/** + * cui_ked_on_exit - The ked on_exit callback. + */ + +static void cui_ked_on_exit(struct ked *ked, enum ked_result ked_result, + struct pb_kexec_data *kd) +{ + struct cui *cui = cui_from_arg(ked->scr.ui_ctx); + + if (ked_result == ked_update || ked_result == ked_boot) { + struct pmenu_item *i = pmenu_find_selected(cui->main); + struct cui_opt_data *cod = cod_from_item(i); + + assert(kd); + + talloc_steal(i, kd); + talloc_free(cod->kd); + cod->kd = kd; + + pb_log("%s: updating opt '%s'\n", __func__, cod->opt->name); + pb_log(" image '%s'\n", cod->kd->image); + pb_log(" initrd '%s'\n", cod->kd->initrd); + pb_log(" args '%s'\n", cod->kd->args); + } + + cui_set_current(cui, &cui->main->scr); + + talloc_free(ked); + + if (ked_result == ked_boot) { + struct pmenu_item *i = pmenu_find_selected(cui->main); + i->on_execute(i); + } +} + +int cui_ked_run(struct pmenu_item *item) +{ + struct cui *cui = cui_from_item(item); + struct ked *ked; + + ked = ked_init(cui, cod_from_item(item)->kd, cui_ked_on_exit); + + cui_set_current(cui, &ked->scr); + + return 0; +} + +/** + * cui_set_current - Set the currently active screen and redraw it. + */ + +struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr) +{ + struct nc_scr *old; + + DBGS("%p -> %p\n", cui->current, scr); + + assert(cui->current != scr); + + old = cui->current; + old->unpost(old); + + cui->current = scr; + cui->current->post(cui->current); + + return old; +} + +static int cui_process_key(void *arg) +{ + struct cui *cui = cui_from_arg(arg); + + assert(cui->current); + cui->current->process_key(cui->current); + return 0; +} + +static int cui_client_process_socket(void *arg) +{ + struct discover_client *client = arg; + + discover_client_process(client); + return 0; +} + +/** + * cui_handle_resize - Handle the term resize. + */ + +static void cui_handle_resize(struct cui *cui) +{ + struct winsize ws; + + if (ioctl(1, TIOCGWINSZ, &ws) == -1) { + pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno)); + return; + } + + pb_log("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col); + + wclear(cui->current->main_ncw); + resize_term(ws.ws_row, ws.ws_col); + cui->current->resize(cui->current); + + /* For some reason this makes ncurses redraw the screen */ + getch(); + redrawwin(cui->current->main_ncw); + wrefresh(cui->current->main_ncw); +} + +/** + * cui_device_add - Client device_add callback. + * + * Creates menu_items for all the device boot_options and inserts those + * menu_items into the main menu. Redraws the main menu if it is active. + */ + +static int cui_device_add(struct device *dev, void *arg) +{ + struct cui *cui = cui_from_arg(arg); + int result; + struct boot_option *opt; + unsigned int o_count; /* device opts */ + unsigned int insert_pt; + ITEM *selected; + + pb_log("%s: %p %s\n", __func__, dev, dev->id); + + selected = current_item(cui->main->ncm); + + if (cui->current == &cui->main->scr) + cui->current->unpost(cui->current); + + /* This disconnects items array from menu. */ + + result = set_menu_items(cui->main->ncm, NULL); + + if (result) + pb_log("%s: set_menu_items failed: %d\n", __func__, result); + + o_count = 0; + list_for_each_entry(&dev->boot_options, opt, list) + o_count++; + + /* Insert new items at insert_pt. */ + + insert_pt = pmenu_grow(cui->main, o_count); + + list_for_each_entry(&dev->boot_options, opt, list) { + struct pmenu_item *i; + struct cui_opt_data *cod; + char *name; + char *description; + + /* Save the item in opt->ui_info for cui_device_remove() */ + + opt->ui_info = i = pmenu_item_alloc(cui->main); + + name = talloc_asprintf(i, "%s: %s", opt->name, + opt->description); + + description = talloc_asprintf(i, + " kexec: image='%s' initrd='%s' args='%s'", + opt->boot_image_file, + opt->initrd_file, + opt->boot_args); + + pmenu_item_setup(cui->main, i, insert_pt, name, description); + + i->on_edit = cui_ked_run; + i->on_execute = cui_run_kexec; + i->data = cod = talloc(i, struct cui_opt_data); + + cod->dev = dev; + cod->opt = opt; + cod->opt_hash = pb_opt_hash(dev, opt); + cod->kd = talloc(i, struct pb_kexec_data); + + cod->kd->image = talloc_strdup(cod->kd, opt->boot_image_file); + cod->kd->initrd = talloc_strdup(cod->kd, opt->initrd_file); + cod->kd->args = talloc_strdup(cod->kd, opt->boot_args); + + insert_pt++; + + /* If this is the default_item select it. */ + + if (cod->opt_hash == cui->default_item) + selected = i->nci; + + pb_log("%s: adding opt '%s'\n", __func__, cod->opt->name); + pb_log(" image '%s'\n", cod->kd->image); + pb_log(" initrd '%s'\n", cod->kd->initrd); + pb_log(" args '%s'\n", cod->kd->args); + } + + /* Re-attach the items array. */ + + result = set_menu_items(cui->main->ncm, cui->main->items); + + if (result) + pb_log("%s: set_menu_items failed: %d\n", __func__, result); + + if (0) { + pb_log("%s\n", __func__); + pmenu_dump_items(cui->main->items, + item_count(cui->main->ncm) + 1); + } + + set_current_item(cui->main->ncm, selected); + + if (cui->current == &cui->main->scr) + cui->current->post(cui->current); + + return 0; +} + +/** + * cui_device_remove - Client device remove callback. + * + * Removes all the menu_items for the device from the main menu and redraws the + * main menu if it is active. + */ + +static void cui_device_remove(struct device *dev, void *arg) +{ + struct cui *cui = cui_from_arg(arg); + int result; + struct boot_option *opt; + + pb_log("%s: %p %s\n", __func__, dev, dev->id); + + if (cui->current == &cui->main->scr) + cui->current->unpost(cui->current); + + /* This disconnects items array from menu. */ + + result = set_menu_items(cui->main->ncm, NULL); + + if (result) + pb_log("%s: set_menu_items failed: %d\n", __func__, result); + + list_for_each_entry(&dev->boot_options, opt, list) { + struct pmenu_item *i = pmenu_item_from_arg(opt->ui_info); + + assert(pb_protocol_device_cmp(dev, cod_from_item(i)->dev)); + pmenu_remove(cui->main, i); + } + + /* Re-attach the items array. */ + + result = set_menu_items(cui->main->ncm, cui->main->items); + + if (result) + pb_log("%s: set_menu_items failed: %d\n", __func__, result); + + if (0) { + pb_log("%s\n", __func__); + pmenu_dump_items(cui->main->items, + item_count(cui->main->ncm) + 1); + } + + if (cui->current == &cui->main->scr) + cui->current->post(cui->current); +} + +/** + * cui_client_process_socket - Process a socket event from the discover server. + */ + +static struct discover_client_ops cui_client_ops = { + .device_add = cui_device_add, + .device_remove = cui_device_remove, +}; + +/** + * cui_init - Setup the cui instance. + * @platform_info: A value for the struct cui platform_info member. + * + * Returns a pointer to a struct cui on success, or NULL on error. + * + * Allocates the cui instance, sets up the client and stdin waiters, and + * sets up the ncurses menu screen. + */ + +struct cui *cui_init(void* platform_info, + int (*on_kexec)(struct cui *, struct cui_opt_data *)) +{ + struct cui *cui; + struct discover_client *client; + unsigned int i; + + cui = talloc_zero(NULL, struct cui); + + if (!cui) { + pb_log("%s: alloc cui failed.\n", __func__); + fprintf(stderr, "%s: alloc cui failed.\n", __func__); + goto fail_alloc; + } + + cui->c_sig = pb_cui_sig; + cui->platform_info = platform_info; + cui->on_kexec = on_kexec; + + /* Loop here for scripts that just started the server. */ + + for (i = 10; i; i--) { + client = discover_client_init(&cui_client_ops, cui); + if (client) + break; + pb_log("%s: waiting for server %d\n", __func__, i); + sleep(1); + } + + if (!client) { + pb_log("%s: discover_client_init failed.\n", __func__); + fprintf(stderr, "%s: error: discover_client_init failed.\n", + __func__); + fprintf(stderr, "check that pb-discover, " + "the petitboot daemon is running.\n"); + goto fail_client_init; + } + + atexit(nc_atexit); + nc_start(); + + waiter_register(discover_client_get_fd(client), WAIT_IN, + cui_client_process_socket, client); + + waiter_register(STDIN_FILENO, WAIT_IN, cui_process_key, cui); + + return cui; + +fail_client_init: + talloc_free(cui); +fail_alloc: + return NULL; +} + +/** + * cui_run - The main cui program loop. + * @cui: The cui instance. + * @main: The menu to use as the main menu. + * + * Runs the cui engine. Does not return until indicated to do so by some + * user action, or an error occurs. Frees the cui object on return. + * Returns 0 on success (return to shell), -1 on error (should restart). + */ + +int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item) +{ + assert(main); + + cui->main = main; + cui->current = &cui->main->scr; + cui->default_item = default_item; + + cui->current->post(cui->current); + + while (1) { + int result = waiter_poll(); + + if (result < 0 && errno != EINTR) { + pb_log("%s: poll: %s\n", __func__, strerror(errno)); + break; + } + + if (cui->abort) + break; + + while (cui->resize) { + cui->resize = 0; + cui_handle_resize(cui); + } + } + + nc_atexit(); + + return cui->abort ? 0 : -1; +} --- /dev/null +++ b/ui/ncurses/nc-cui.h @@ -0,0 +1,88 @@ +/* + * Copyright (C) 2009 Sony Computer Entertainment Inc. + * Copyright 2009 Sony Corp. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#if !defined(_PB_NC_CUI_H) +#define _PB_NC_CUI_H + +#include + +#include "nc-menu.h" +#include "nc-ked.h" + + +struct cui_opt_data { + const struct device *dev; + const struct boot_option *opt; + uint32_t opt_hash; + struct pb_kexec_data *kd; +}; + +/** + * struct cui - Data structure defining a cui state machine. + * @c_sig: Signature for callback type checking, should be cui_sig. + * @abort: When set to true signals the state machine to exit. + * @current: Pointer to the active nc object. + * @main: Pointer to the user supplied main menu. + * + * Device boot_options are dynamically added and removed from the @main + * menu. + */ + +struct cui { + enum pb_nc_sig c_sig; + sig_atomic_t abort; + sig_atomic_t resize; + struct nc_scr *current; + struct pmenu *main; + void *platform_info; + unsigned int default_item; + int (*on_kexec)(struct cui *cui, struct cui_opt_data *cod); +}; + +struct cui *cui_init(void* platform_info, + int (*on_kexec)(struct cui *, struct cui_opt_data *)); +struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr); +int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item); +int cui_ked_run(struct pmenu_item *item); + +/* convenience routines */ + +void cui_abort(struct cui *cui); +void cui_resize(struct cui *cui); +void cui_on_exit(struct pmenu *menu); +int cui_run_cmd(struct pmenu_item *item); + +static inline struct cui *cui_from_arg(void *arg) +{ + struct cui *cui = (struct cui *)arg; + + assert(cui->c_sig == pb_cui_sig); + return cui; +} + +static inline struct cui *cui_from_pmenu(struct pmenu *menu) +{ + return cui_from_arg(menu->scr.ui_ctx); +} + +static inline struct cui *cui_from_item(struct pmenu_item *item) +{ + return cui_from_pmenu(item->pmenu); +} + +#endif --