ShellPkg/Application/Shell/Shell.h

   1 /** @file
   2   function definitions for internal to shell functions.
   3
   4   Copyright (c) 2009 - 2011, 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
  23 #include <Protocol/LoadedImage.h>
  24 #include <Protocol/SimpleTextOut.h>
  25 #include <Protocol/EfiShell.h>
  26 #include <Protocol/EfiShellInterface.h>
  27 #include <Protocol/EfiShellEnvironment2.h>
  28 #include <Protocol/EfiShellParameters.h>
  29 #include <Protocol/BlockIo.h>
  30
  31 #include <Library/BaseLib.h>
  32 #include <Library/UefiApplicationEntryPoint.h>
  33 #include <Library/UefiLib.h>
  34 #include <Library/DebugLib.h>
  35 #include <Library/MemoryAllocationLib.h>
  36 #include <Library/ShellCommandLib.h>
  37 #include <Library/UefiRuntimeServicesTableLib.h>
  38 #include <Library/UefiBootServicesTableLib.h>
  39 #include <Library/DevicePathLib.h>
  40 #include <Library/BaseMemoryLib.h>
  41 #include <Library/PcdLib.h>
  42 #include <Library/ShellLib.h>
  43 #include <Library/SortLib.h>
  44 #include <Library/HiiLib.h>
  45 #include <Library/PrintLib.h>
  46 #include <Library/HandleParsingLib.h>
  47
  48 #include "ShellParametersProtocol.h"
  49 #include "ShellProtocol.h"
  50 #include "ShellEnvVar.h"
  51 #include "ConsoleLogger.h"
  52 #include "ShellManParser.h"
  53
  54 typedef struct {
  55   LIST_ENTRY        Link;           ///< Standard linked list handler.
  56   SHELL_FILE_HANDLE *SplitStdOut;   ///< ConsoleOut for use in the split.
  57   SHELL_FILE_HANDLE *SplitStdIn;    ///< ConsoleIn for use in the split.
  58 } SPLIT_LIST;
  59
  60 typedef struct {
  61   UINT32  Startup:1;      ///< Was "-startup"       found on command line.
  62   UINT32  NoStartup:1;    ///< Was "-nostartup"     found on command line.
  63   UINT32  NoConsoleOut:1; ///< Was "-noconsoleout"  found on command line.
  64   UINT32  NoConsoleIn:1;  ///< Was "-noconsolein"   found on command line.
  65   UINT32  NoInterrupt:1;  ///< Was "-nointerrupt"   found on command line.
  66   UINT32  NoMap:1;        ///< Was "-nomap"         found on command line.
  67   UINT32  NoVersion:1;    ///< Was "-noversion"     found on command line.
  68   UINT32  Delay:1;        ///< Was "-delay[:n]      found on command line
  69   UINT32  Reserved:8;     ///< Extra bits
  70 } SHELL_BITS;
  71
  72 typedef union {
  73   SHELL_BITS  Bits;
  74   UINT16      AllBits;
  75 } SHELL_BIT_UNION;
  76
  77 typedef struct {
  78   SHELL_BIT_UNION BitUnion;
  79   UINTN           Delay;          ///< Seconds of delay default:5.
  80   CHAR16          *FileName;      ///< Filename to run upon successful initialization.
  81   CHAR16          *FileOptions;   ///< Options to pass to FileName.
  82 } SHELL_INIT_SETTINGS;
  83
  84 typedef struct {
  85   BUFFER_LIST                 CommandHistory;
  86   UINTN                       VisibleRowNumber;
  87   UINTN                       OriginalVisibleRowNumber;
  88   BOOLEAN                     InsertMode;           ///< Is the current typing mode insert (FALSE = overwrite).
  89 } SHELL_VIEWING_SETTINGS;
  90
  91 typedef struct {
  92   EFI_SHELL_PARAMETERS_PROTOCOL *NewShellParametersProtocol;
  93   EFI_SHELL_PROTOCOL            *NewEfiShellProtocol;
  94   BOOLEAN                       PageBreakEnabled;
  95   BOOLEAN                       RootShellInstance;
  96   SHELL_INIT_SETTINGS           ShellInitSettings;
  97   BUFFER_LIST                   BufferToFreeList;     ///< List of buffers that were returned to the user to free.
  98   SHELL_VIEWING_SETTINGS        ViewingSettings;
  99   EFI_HII_HANDLE                HiiHandle;            ///< Handle from HiiLib.
 100   UINTN                         LogScreenCount;       ///< How many screens of log information to save.
 101   EFI_EVENT                     UserBreakTimer;       ///< Timer event for polling for CTRL-C.
 102   EFI_DEVICE_PATH_PROTOCOL      *ImageDevPath;        ///< DevicePath for ourselves.
 103   EFI_DEVICE_PATH_PROTOCOL      *FileDevPath;         ///< DevicePath for ourselves.
 104   CONSOLE_LOGGER_PRIVATE_DATA   *ConsoleInfo;         ///< Pointer for ConsoleInformation.
 105   EFI_SHELL_PARAMETERS_PROTOCOL *OldShellParameters;  ///< old shell parameters to reinstall upon exiting.
 106   SHELL_PROTOCOL_HANDLE_LIST    OldShellList;         ///< List of other instances to reinstall when closing.
 107   SPLIT_LIST                    SplitList;            ///< List of Splits in FILO stack.
 108   EFI_HANDLE                    CtrlCNotifyHandle1;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 109   EFI_HANDLE                    CtrlCNotifyHandle2;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 110   EFI_HANDLE                    CtrlCNotifyHandle3;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 111   EFI_HANDLE                    CtrlCNotifyHandle4;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 112   EFI_HANDLE                    CtrlSNotifyHandle1;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 113   EFI_HANDLE                    CtrlSNotifyHandle2;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 114   EFI_HANDLE                    CtrlSNotifyHandle3;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 115   EFI_HANDLE                    CtrlSNotifyHandle4;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 116 } SHELL_INFO;
 117
 118 extern SHELL_INFO ShellInfoObject;
 119
 120 /**
 121   Sets all the alias' that were registered with the ShellCommandLib library.
 122
 123   @retval EFI_SUCCESS           all init commands were run sucessfully.
 124 **/
 125 EFI_STATUS
 126 EFIAPI
 127 SetBuiltInAlias(
 128   VOID
 129   );
 130
 131 /**
 132   This function will populate the 2 device path protocol parameters based on the
 133   global gImageHandle.  the DevPath will point to the device path for the handle that has
 134   loaded image protocol installed on it.  the FilePath will point to the device path
 135   for the file that was loaded.
 136
 137   @param[in,out] DevPath       on a sucessful return the device path to the loaded image
 138   @param[in,out] FilePath      on a sucessful return the device path to the file
 139
 140   @retval EFI_SUCCESS           the 2 device paths were sucessfully returned.
 141   @return other                 a error from gBS->HandleProtocol
 142
 143   @sa HandleProtocol
 144 **/
 145 EFI_STATUS
 146 EFIAPI
 147 GetDevicePathsForImageAndFile (
 148   IN OUT EFI_DEVICE_PATH_PROTOCOL **DevPath,
 149   IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath
 150   );
 151
 152 /**
 153   Process all Uefi Shell 2.0 command line options.
 154
 155   see Uefi Shell 2.0 section 3.2 for full details.
 156
 157   the command line should resemble the following:
 158
 159   shell.efi [ShellOpt-options] [options] [file-name [file-name-options]]
 160
 161   ShellOpt options  Options which control the initialization behavior of the shell.
 162                     These options are read from the EFI global variable "ShellOpt"
 163                     and are processed before options or file-name.
 164
 165   options           Options which control the initialization behavior of the shell.
 166
 167   file-name         The name of a UEFI shell application or script to be executed
 168                     after initialization is complete. By default, if file-name is
 169                     specified, then -nostartup is implied. Scripts are not supported
 170                     by level 0.
 171
 172   file-nameoptions  The command-line options that are passed to file-name when it
 173                     is invoked.
 174
 175   This will initialize the ShellInitSettings global variable.
 176
 177   @retval EFI_SUCCESS           the variable is initialized.
 178 **/
 179 EFI_STATUS
 180 EFIAPI
 181 ProcessCommandLine(
 182   VOID
 183   );
 184
 185 /**
 186   Handles all interaction with the default startup script.
 187
 188   this will check that the correct command line parameters were passed, handle the delay, and then start running the script.
 189
 190   @param[in] ImagePath          The path to the image for shell.  The first place to look for the startup script.
 191   @param[in] FilePath           The path to the file for shell.  The second place to look for the startup script.
 192
 193   @retval EFI_SUCCESS           The variable is initialized.
 194 **/
 195 EFI_STATUS
 196 EFIAPI
 197 DoStartupScript(
 198   IN EFI_DEVICE_PATH_PROTOCOL *ImagePath,
 199   IN EFI_DEVICE_PATH_PROTOCOL *FilePath
 200   );
 201
 202 /**
 203   Function to perform the shell prompt looping.  It will do a single prompt,
 204   dispatch the result, and then return.  It is expected that the caller will
 205   call this function in a loop many times.
 206
 207   @retval EFI_SUCCESS
 208   @retval RETURN_ABORTED
 209 **/
 210 EFI_STATUS
 211 EFIAPI
 212 DoShellPrompt (
 213   VOID
 214   );
 215
 216 /**
 217   Add a buffer to the Buffer To Free List for safely returning buffers to other
 218   places without risking letting them modify internal shell information.
 219
 220   @param Buffer   Something to pass to FreePool when the shell is exiting.
 221 **/
 222 VOID*
 223 EFIAPI
 224 AddBufferToFreeList(
 225   VOID *Buffer
 226   );
 227
 228 /**
 229   Add a buffer to the Command History List.
 230
 231   @param Buffer[in]     The line buffer to add.
 232 **/
 233 VOID
 234 EFIAPI
 235 AddLineToCommandHistory(
 236   IN CONST CHAR16 *Buffer
 237   );
 238
 239 /**
 240   Function will process and run a command line.
 241
 242   This will determine if the command line represents an internal shell command or dispatch an external application.
 243
 244   @param[in] CmdLine  the command line to parse
 245
 246   @retval EFI_SUCCESS     the command was completed
 247   @retval EFI_ABORTED     the command's operation was aborted
 248 **/
 249 EFI_STATUS
 250 EFIAPI
 251 RunCommand(
 252   IN CONST CHAR16   *CmdLine
 253   );
 254
 255 /**
 256   Function determins if the CommandName COULD be a valid command.  It does not determine whether
 257   this is a valid command.  It only checks for invalid characters.
 258
 259   @param[in] CommandName    The name to check
 260
 261   @retval TRUE              CommandName could be a command name
 262   @retval FALSE             CommandName could not be a valid command name
 263 **/
 264 BOOLEAN
 265 EFIAPI
 266 IsValidCommandName(
 267   IN CONST CHAR16     *CommandName
 268   );
 269
 270 /**
 271   Function to process a NSH script file via SHELL_FILE_HANDLE.
 272
 273   @param[in] Handle             The handle to the already opened file.
 274   @param[in] Name               The name of the script file.
 275
 276   @retval EFI_SUCCESS           the script completed sucessfully
 277 **/
 278 EFI_STATUS
 279 EFIAPI
 280 RunScriptFileHandle (
 281   IN SHELL_FILE_HANDLE  Handle,
 282   IN CONST CHAR16       *Name
 283   );
 284
 285 /**
 286   Function to process a NSH script file.
 287
 288   @param[in] ScriptPath         Pointer to the script file name (including file system path).
 289
 290   @retval EFI_SUCCESS           the script completed sucessfully
 291 **/
 292 EFI_STATUS
 293 EFIAPI
 294 RunScriptFile (
 295   IN CONST CHAR16 *ScriptPath
 296   );
 297
 298
 299 #endif //_SHELL_INTERNAL_HEADER_
 300