shell.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (C) 2001 Fernando Ruiz Casas <fruizcasas@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __RTEMS_SHELL_H__
#define __RTEMS_SHELL_H__
 
#include <sys/types.h>
#include <sys/stat.h>
#include <rtems.h>
#include <stdio.h>
#include <termios.h>
#include <rtems/fs.h>
#include <rtems/libio.h>
#include <rtems/chain.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * Some key labels to define special keys.
 */
 
#define RTEMS_SHELL_KEYS_EXTENDED    (0x8000)
#define RTEMS_SHELL_KEYS_NORMAL_MASK (0x00ff)
#define RTEMS_SHELL_KEYS_INS         (0)
#define RTEMS_SHELL_KEYS_DEL         (1)
#define RTEMS_SHELL_KEYS_UARROW      (2)
#define RTEMS_SHELL_KEYS_DARROW      (3)
#define RTEMS_SHELL_KEYS_LARROW      (4)
#define RTEMS_SHELL_KEYS_RARROW      (5)
#define RTEMS_SHELL_KEYS_HOME        (6)
#define RTEMS_SHELL_KEYS_END         (7)
#define RTEMS_SHELL_KEYS_F1          (8)
#define RTEMS_SHELL_KEYS_F2          (9)
#define RTEMS_SHELL_KEYS_F3          (10)
#define RTEMS_SHELL_KEYS_F4          (11)
#define RTEMS_SHELL_KEYS_F5          (12)
#define RTEMS_SHELL_KEYS_F6          (13)
#define RTEMS_SHELL_KEYS_F7          (14)
#define RTEMS_SHELL_KEYS_F8          (15)
#define RTEMS_SHELL_KEYS_F9          (16)
#define RTEMS_SHELL_KEYS_F10         (17)
 
typedef bool (*rtems_shell_login_check_t)(
  const char * /* user */,
  const char * /* passphrase */
);
 
extern bool rtems_shell_login_prompt(
  FILE *in,
  FILE *out,
  const char *device,
  rtems_shell_login_check_t check
);
 
extern bool rtems_shell_login_check(
  const char *user,
  const char *passphrase
);
 
typedef int (*rtems_shell_command_t)(int argc, char **argv);
 
struct rtems_shell_cmd_tt;
typedef struct rtems_shell_cmd_tt rtems_shell_cmd_t;
 
struct rtems_shell_cmd_tt {
  const char            *name;
  const char            *usage;
  const char            *topic;
  rtems_shell_command_t  command;
  rtems_shell_cmd_t     *alias;
  rtems_shell_cmd_t     *next;
  mode_t                 mode;
  uid_t                  uid;
  gid_t                  gid;
};
 
typedef struct {
  const char *name;
  const char *alias;
} rtems_shell_alias_t;
 
struct rtems_shell_topic_tt;
typedef struct rtems_shell_topic_tt rtems_shell_topic_t;
 
struct rtems_shell_topic_tt {
  const char          *topic;
  rtems_shell_topic_t *next;
};
 
/*
 * The return value has RTEMS_SHELL_KEYS_EXTENDED set if the key
 * is extended, ie a special key.
 */
extern unsigned int rtems_shell_getchar(FILE *in);
 
extern rtems_shell_cmd_t * rtems_shell_lookup_cmd(const char *cmd);
 
extern rtems_shell_cmd_t *rtems_shell_add_cmd_struct(
  rtems_shell_cmd_t *shell_cmd
);
 
rtems_shell_cmd_t * rtems_shell_add_cmd(
  const char            *cmd,
  const char            *topic,
  const char            *usage,
  rtems_shell_command_t  command
);
 
extern rtems_shell_cmd_t * rtems_shell_alias_cmd(
  const char *cmd,
  const char *alias
);
 
extern int rtems_shell_make_args(
  char  *commandLine,
  int   *argc_p,
  char **argv_p,
  int    max_args
);
 
extern rtems_shell_topic_t * rtems_shell_lookup_topic(
  const char *topic
);
 
extern bool rtems_shell_can_see_cmd(
  const rtems_shell_cmd_t *shell_cmd
);
 
extern int rtems_shell_execute_cmd(
  const char *cmd, int argc, char *argv[]
);
 
/*
 * Call to set up the shell environment if you need to execute commands before
 * running a shell.
 */
extern void rtems_shell_init_environment(
  void
);
 
extern int rtems_shell_cat_file(
  FILE *out,
  const char *name
);
 
extern void rtems_shell_write_file(
  const char *name,
  const char *content
);
 
extern int rtems_shell_script_file(
  int    argc,
  char **argv
);
 
extern rtems_status_code rtems_shell_init(
  const char *task_name,
  size_t task_stacksize,
  rtems_task_priority task_priority,
  const char *devname,
  bool forever,
  bool wait,
  rtems_shell_login_check_t login_check
);
 
extern rtems_status_code rtems_shell_script(
  const char          *task_name,
  size_t               task_stacksize,  /* 0 default*/
  rtems_task_priority  task_priority,
  const char          *input,
  const char          *output,
  bool                 output_append,
  bool                 wait,
  bool                 echo
);
 
typedef struct {
  rtems_name magic;
  bool managed;
  const char *devname;
  const char *taskname;
  bool exit_shell; /* logout */
  bool forever; /* repeat login */
  int *exit_code;
  bool exit_on_error;
  bool echo;
  char cwd[256];
  const char *input;
  const char *output;
  bool output_append;
  FILE *parent_stdin;
  FILE *parent_stdout;
  FILE *parent_stderr;
  rtems_id wake_on_end;
  rtems_shell_login_check_t login_check;
 
  uid_t uid;
 
  gid_t gid;
} rtems_shell_env_t;
 
bool rtems_shell_main_loop(
  rtems_shell_env_t *rtems_shell_env
);
 
bool rtems_shell_run_main_loop(
  rtems_shell_env_t *shell_env,
  bool               interactive,
  FILE              *line_editor_output
);
 
extern const rtems_shell_env_t rtems_global_shell_env;
 
rtems_shell_env_t *rtems_shell_get_current_env(void);
void rtems_shell_dup_current_env(rtems_shell_env_t *);
 
/*
 * The types of file systems we can mount. We have them broken out
 * out like this so they can be configured by shellconfig.h. The
 * mount command needs special treatment due to some file systems
 * being dependent on the network stack and some not. If we had
 * all possible file systems being included it would force the
 * networking stack into the applcation and this may not be
 * required.
 */
struct rtems_shell_filesystems_tt;
typedef struct rtems_shell_filesystems_tt rtems_shell_filesystems_t;
 
typedef int (*rtems_shell_filesystems_mounter_t)(
  const char*                driver,
  const char*                path,
  rtems_shell_filesystems_t* fs,
  rtems_filesystem_options_t options
);
 
struct rtems_shell_filesystems_tt {
  rtems_chain_node                         link;
  const char                              *name;
  int                                      driver_needed;
  const rtems_filesystem_operations_table *fs_ops;
  rtems_shell_filesystems_mounter_t        mounter;
};
 
extern void rtems_shell_get_prompt(
  rtems_shell_env_t *shell_env,
  char              *prompt,
  size_t             size
);
 
extern int rtems_shell_libc_mounter(
  const char*                driver,
  const char*                path,
  rtems_shell_filesystems_t* fs,
  rtems_filesystem_options_t options
);
 
extern void rtems_shell_mount_add_fsys(rtems_shell_filesystems_t* fs);
 
extern void rtems_shell_mount_del_fsys(rtems_shell_filesystems_t* fs);
 
typedef void (*rtems_shell_wait_for_input_notification)(
  int fd,
  int seconds_remaining,
  void *arg
);
 
extern rtems_status_code rtems_shell_wait_for_input(
  int fd,
  int timeout_in_seconds,
  rtems_shell_wait_for_input_notification notification,
  void *notification_arg
);
 
extern rtems_status_code rtems_shell_wait_for_explicit_input(
  int fd,
  int timeout_in_seconds,
  rtems_shell_wait_for_input_notification notification,
  void *notification_arg,
  int desired_input
);
 
extern int rtems_shell_main_monitor(int argc, char **argv);
 
/*
 * Provide these commands for application use, as their implementation
 * is tedious.
 */
int rtems_shell_main_mv(int argc, char *argv[]);
int rtems_shell_main_cp(int argc, char *argv[]);
int rtems_shell_main_rm(int argc, char *argv[]);
 
#ifdef __cplusplus
}
#endif
 
#endif