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