ShellPkg/Application/Shell/Shell.h

   1 /** @file
   2   function definitions for internal to shell functions.
   3
   4   Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _SHELL_INTERNAL_HEADER_
  16 #define _SHELL_INTERNAL_HEADER_
  17
  18 #include <Uefi.h>
  19 #include <ShellBase.h>
  20
  21 #include <Guid/ShellVariableGuid.h>
  22 #include <Guid/ShellAliasGuid.h>
  23
  24 #include <Protocol/LoadedImage.h>
  25 #include <Protocol/SimpleTextOut.h>
  26 #include <Protocol/EfiShell.h>
  27 #include <Protocol/EfiShellInterface.h>
  28 #include <Protocol/EfiShellEnvironment2.h>
  29 #include <Protocol/EfiShellParameters.h>
  30 #include <Protocol/BlockIo.h>
  31
  32 #include <Library/BaseLib.h>
  33 #include <Library/UefiApplicationEntryPoint.h>
  34 #include <Library/UefiLib.h>
  35 #include <Library/DebugLib.h>
  36 #include <Library/MemoryAllocationLib.h>
  37 #include <Library/ShellCommandLib.h>
  38 #include <Library/UefiRuntimeServicesTableLib.h>
  39 #include <Library/UefiBootServicesTableLib.h>
  40 #include <Library/DevicePathLib.h>
  41 #include <Library/BaseMemoryLib.h>
  42 #include <Library/PcdLib.h>
  43 #include <Library/ShellLib.h>
  44 #include <Library/SortLib.h>
  45 #include <Library/HiiLib.h>
  46 #include <Library/PrintLib.h>
  47 #include <Library/HandleParsingLib.h>
  48 #include <Library/PathLib.h>
  49 #include <Library/FileHandleLib.h>
  50
  51 #include "ShellParametersProtocol.h"
  52 #include "ShellProtocol.h"
  53 #include "ShellEnvVar.h"
  54 #include "ConsoleLogger.h"
  55 #include "ShellManParser.h"
  56 #include "ConsoleWrappers.h"
  57 #include "FileHandleWrappers.h"
  58
  59 typedef struct {
  60   LIST_ENTRY        Link;           ///< Standard linked list handler.
  61   SHELL_FILE_HANDLE *SplitStdOut;   ///< ConsoleOut for use in the split.
  62   SHELL_FILE_HANDLE *SplitStdIn;    ///< ConsoleIn for use in the split.
  63 } SPLIT_LIST;
  64
  65 typedef struct {
  66   UINT32  Startup:1;      ///< Was "-startup"       found on command line.
  67   UINT32  NoStartup:1;    ///< Was "-nostartup"     found on command line.
  68   UINT32  NoConsoleOut:1; ///< Was "-noconsoleout"  found on command line.
  69   UINT32  NoConsoleIn:1;  ///< Was "-noconsolein"   found on command line.
  70   UINT32  NoInterrupt:1;  ///< Was "-nointerrupt"   found on command line.
  71   UINT32  NoMap:1;        ///< Was "-nomap"         found on command line.
  72   UINT32  NoVersion:1;    ///< Was "-noversion"     found on command line.
  73   UINT32  Delay:1;        ///< Was "-delay[:n]      found on command line
  74   UINT32  Exit:1;         ///< Was "-_exit"          found on command line
  75   UINT32  Reserved:7;     ///< Extra bits
  76 } SHELL_BITS;
  77
  78 typedef union {
  79   SHELL_BITS  Bits;
  80   UINT16      AllBits;
  81 } SHELL_BIT_UNION;
  82
  83 typedef struct {
  84   SHELL_BIT_UNION BitUnion;
  85   UINTN           Delay;          ///< Seconds of delay default:5.
  86   CHAR16          *FileName;      ///< Filename to run upon successful initialization.
  87   CHAR16          *FileOptions;   ///< Options to pass to FileName.
  88 } SHELL_INIT_SETTINGS;
  89
  90 typedef struct {
  91   BUFFER_LIST                 CommandHistory;
  92   UINTN                       VisibleRowNumber;
  93   UINTN                       OriginalVisibleRowNumber;
  94   BOOLEAN                     InsertMode;           ///< Is the current typing mode insert (FALSE = overwrite).
  95 } SHELL_VIEWING_SETTINGS;
  96
  97 typedef struct {
  98   EFI_SHELL_PARAMETERS_PROTOCOL *NewShellParametersProtocol;
  99   EFI_SHELL_PROTOCOL            *NewEfiShellProtocol;
 100   BOOLEAN                       PageBreakEnabled;
 101   BOOLEAN                       RootShellInstance;
 102   SHELL_INIT_SETTINGS           ShellInitSettings;
 103   BUFFER_LIST                   BufferToFreeList;     ///< List of buffers that were returned to the user to free.
 104   SHELL_VIEWING_SETTINGS        ViewingSettings;
 105   EFI_HII_HANDLE                HiiHandle;            ///< Handle from HiiLib.
 106   UINTN                         LogScreenCount;       ///< How many screens of log information to save.
 107   EFI_EVENT                     UserBreakTimer;       ///< Timer event for polling for CTRL-C.
 108   EFI_DEVICE_PATH_PROTOCOL      *ImageDevPath;        ///< DevicePath for ourselves.
 109   EFI_DEVICE_PATH_PROTOCOL      *FileDevPath;         ///< DevicePath for ourselves.
 110   CONSOLE_LOGGER_PRIVATE_DATA   *ConsoleInfo;         ///< Pointer for ConsoleInformation.
 111   EFI_SHELL_PARAMETERS_PROTOCOL *OldShellParameters;  ///< old shell parameters to reinstall upon exiting.
 112   SHELL_PROTOCOL_HANDLE_LIST    OldShellList;         ///< List of other instances to reinstall when closing.
 113   SPLIT_LIST                    SplitList;            ///< List of Splits in FILO stack.
 114   VOID                          *CtrlCNotifyHandle1;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 115   VOID                          *CtrlCNotifyHandle2;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 116   VOID                          *CtrlCNotifyHandle3;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 117   VOID                          *CtrlCNotifyHandle4;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 118   VOID                          *CtrlSNotifyHandle1;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 119   VOID                          *CtrlSNotifyHandle2;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 120   VOID                          *CtrlSNotifyHandle3;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 121   VOID                          *CtrlSNotifyHandle4;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 122   BOOLEAN                       HaltOutput;           ///< TRUE to start a CTRL-S halt.
 123 } SHELL_INFO;
 124
 125 extern SHELL_INFO ShellInfoObject;
 126
 127 typedef enum {
 128   Internal_Command,
 129   Script_File_Name,
 130   Efi_Application,
 131   File_Sys_Change,
 132   Unknown_Invalid
 133 } SHELL_OPERATION_TYPES;
 134
 135 /**
 136   Converts the command line to it's post-processed form.  this replaces variables and alias' per UEFI Shell spec.
 137
 138   @param[in,out] CmdLine        pointer to the command line to update
 139
 140   @retval EFI_SUCCESS           The operation was successful
 141   @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.
 142   @return                       some other error occured
 143 **/
 144 EFI_STATUS
 145 EFIAPI
 146 ProcessCommandLineToFinal(
 147   IN OUT CHAR16 **CmdLine
 148   );
 149
 150 /**
 151   Function to update the shell variable "lasterror".
 152
 153   @param[in] ErrorCode      the error code to put into lasterror
 154 **/
 155 EFI_STATUS
 156 EFIAPI
 157 SetLastError(
 158   IN CONST SHELL_STATUS   ErrorCode
 159   );
 160
 161 /**
 162   Sets all the alias' that were registered with the ShellCommandLib library.
 163
 164   @retval EFI_SUCCESS           all init commands were run sucessfully.
 165 **/
 166 EFI_STATUS
 167 EFIAPI
 168 SetBuiltInAlias(
 169   VOID
 170   );
 171
 172 /**
 173   This function will populate the 2 device path protocol parameters based on the
 174   global gImageHandle.  the DevPath will point to the device path for the handle that has
 175   loaded image protocol installed on it.  the FilePath will point to the device path
 176   for the file that was loaded.
 177
 178   @param[in, out] DevPath       on a sucessful return the device path to the loaded image
 179   @param[in, out] FilePath      on a sucessful return the device path to the file
 180
 181   @retval EFI_SUCCESS           the 2 device paths were sucessfully returned.
 182   @return other                 a error from gBS->HandleProtocol
 183
 184   @sa HandleProtocol
 185 **/
 186 EFI_STATUS
 187 EFIAPI
 188 GetDevicePathsForImageAndFile (
 189   IN OUT EFI_DEVICE_PATH_PROTOCOL **DevPath,
 190   IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath
 191   );
 192
 193 /**
 194   Process all Uefi Shell 2.0 command line options.
 195
 196   see Uefi Shell 2.0 section 3.2 for full details.
 197
 198   the command line should resemble the following:
 199
 200   shell.efi [ShellOpt-options] [options] [file-name [file-name-options]]
 201
 202   ShellOpt options  Options which control the initialization behavior of the shell.
 203                     These options are read from the EFI global variable "ShellOpt"
 204                     and are processed before options or file-name.
 205
 206   options           Options which control the initialization behavior of the shell.
 207
 208   file-name         The name of a UEFI shell application or script to be executed
 209                     after initialization is complete. By default, if file-name is
 210                     specified, then -nostartup is implied. Scripts are not supported
 211                     by level 0.
 212
 213   file-nameoptions  The command-line options that are passed to file-name when it
 214                     is invoked.
 215
 216   This will initialize the ShellInitSettings global variable.
 217
 218   @retval EFI_SUCCESS           the variable is initialized.
 219 **/
 220 EFI_STATUS
 221 EFIAPI
 222 ProcessCommandLine(
 223   VOID
 224   );
 225
 226 /**
 227   Handles all interaction with the default startup script.
 228
 229   this will check that the correct command line parameters were passed, handle the delay, and then start running the script.
 230
 231   @param[in] ImagePath          The path to the image for shell.  The first place to look for the startup script.
 232   @param[in] FilePath           The path to the file for shell.  The second place to look for the startup script.
 233   @param[out] ExitStatus        The exit code of the script. Ignored if NULL.
 234                                 Invalid when this function returns an error.
 235
 236   @retval EFI_SUCCESS           The variable is initialized.
 237 **/
 238 EFI_STATUS
 239 EFIAPI
 240 DoStartupScript(
 241   IN  EFI_DEVICE_PATH_PROTOCOL *ImagePath,
 242   IN  EFI_DEVICE_PATH_PROTOCOL *FilePath,
 243   OUT SHELL_STATUS             *ExitStatus
 244   );
 245
 246 /**
 247   Function to perform the shell prompt looping.  It will do a single prompt,
 248   dispatch the result, and then return.  It is expected that the caller will
 249   call this function in a loop many times.
 250
 251   @retval EFI_SUCCESS
 252   @retval RETURN_ABORTED
 253 **/
 254 EFI_STATUS
 255 EFIAPI
 256 DoShellPrompt (
 257   VOID
 258   );
 259
 260 /**
 261   Add a buffer to the Buffer To Free List for safely returning buffers to other
 262   places without risking letting them modify internal shell information.
 263
 264   @param Buffer   Something to pass to FreePool when the shell is exiting.
 265 **/
 266 VOID*
 267 EFIAPI
 268 AddBufferToFreeList(
 269   VOID *Buffer
 270   );
 271
 272 /**
 273   Add a buffer to the Command History List.
 274
 275   @param Buffer[in]     The line buffer to add.
 276 **/
 277 VOID
 278 EFIAPI
 279 AddLineToCommandHistory(
 280   IN CONST CHAR16 *Buffer
 281   );
 282
 283 /**
 284   Function will process and run a command line.
 285
 286   This will determine if the command line represents an internal shell command or dispatch an external application.
 287
 288   @param[in]  CmdLine     the command line to parse
 289   @param[out] ExitStatus  The exit status of the command. Ignored if NULL.
 290
 291   @retval EFI_SUCCESS     the command was completed
 292   @retval EFI_ABORTED     the command's operation was aborted
 293 **/
 294 EFI_STATUS
 295 EFIAPI
 296 RunCommand(
 297   IN  CONST CHAR16         *CmdLine,
 298   OUT       SHELL_STATUS   *ExitStatus
 299   );
 300
 301 /**
 302   Function determins if the CommandName COULD be a valid command.  It does not determine whether
 303   this is a valid command.  It only checks for invalid characters.
 304
 305   @param[in] CommandName    The name to check
 306
 307   @retval TRUE              CommandName could be a command name
 308   @retval FALSE             CommandName could not be a valid command name
 309 **/
 310 BOOLEAN
 311 EFIAPI
 312 IsValidCommandName(
 313   IN CONST CHAR16     *CommandName
 314   );
 315
 316 /**
 317   Function to process a NSH script file via SHELL_FILE_HANDLE.
 318
 319   @param[in] Handle             The handle to the already opened file.
 320   @param[in] Name               The name of the script file.
 321
 322   @param[out] ExitStatus      The exit code of the script. Ignored if NULL.
 323                               Invalid when this function returns an error.
 324
 325   @retval EFI_SUCCESS           the script completed sucessfully
 326 **/
 327 EFI_STATUS
 328 EFIAPI
 329 RunScriptFileHandle (
 330   IN  SHELL_FILE_HANDLE  Handle,
 331   IN  CONST CHAR16       *Name,
 332   OUT SHELL_STATUS       *ExitStatus
 333   );
 334
 335 /**
 336   Function to process a NSH script file.
 337
 338   @param[in] ScriptPath         Pointer to the script file name (including file system path).
 339   @param[in] Handle             the handle of the script file already opened.
 340   @param[in] CmdLine            the command line to run.
 341   @param[in] ParamProtocol      the shell parameters protocol pointer
 342
 343   @param[out] ExitStatus      The exit code of the script. Ignored if NULL.
 344                               Invalid when this function returns an error.
 345
 346   @retval EFI_SUCCESS           the script completed sucessfully
 347 **/
 348 EFI_STATUS
 349 EFIAPI
 350 RunScriptFile (
 351   IN  CONST CHAR16                   *ScriptPath,
 352   IN  SHELL_FILE_HANDLE              Handle OPTIONAL,
 353   IN  CONST CHAR16                   *CmdLine,
 354   IN  EFI_SHELL_PARAMETERS_PROTOCOL  *ParamProtocol,
 355   OUT SHELL_STATUS                   *ExitStatus
 356   );
 357
 358 #endif //_SHELL_INTERNAL_HEADER_
 359