1 /******************************************************************************
2 *
3 * Module Name: dbhistry - debugger HISTORY command
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2023, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #include "acpi.h"
153 #include "accommon.h"
154 #include "acdebug.h"
155
156
157 #define _COMPONENT ACPI_CA_DEBUGGER
158 ACPI_MODULE_NAME ("dbhistry")
159
160
161 #define HI_NO_HISTORY 0
162 #define HI_RECORD_HISTORY 1
163 #define HISTORY_SIZE 40
164
165
166 typedef struct HistoryInfo
167 {
168 char *Command;
169 UINT32 CmdNum;
170
171 } HISTORY_INFO;
172
173
174 static HISTORY_INFO AcpiGbl_HistoryBuffer[HISTORY_SIZE];
175 static UINT16 AcpiGbl_LoHistory = 0;
176 static UINT16 AcpiGbl_NumHistory = 0;
177 static UINT16 AcpiGbl_NextHistoryIndex = 0;
178
179
180 /*******************************************************************************
181 *
182 * FUNCTION: AcpiDbAddToHistory
183 *
184 * PARAMETERS: CommandLine - Command to add
185 *
186 * RETURN: None
187 *
188 * DESCRIPTION: Add a command line to the history buffer.
189 *
190 ******************************************************************************/
191
192 void
AcpiDbAddToHistory(char * CommandLine)193 AcpiDbAddToHistory (
194 char *CommandLine)
195 {
196 UINT16 CmdLen;
197 UINT16 BufferLen;
198
199 /* Put command into the next available slot */
200
201 CmdLen = (UINT16) strlen (CommandLine);
202 if (!CmdLen)
203 {
204 return;
205 }
206
207 if (AcpiGbl_HistoryBuffer[AcpiGbl_NextHistoryIndex].Command != NULL)
208 {
209 BufferLen = (UINT16) strlen (
210 AcpiGbl_HistoryBuffer[AcpiGbl_NextHistoryIndex].Command);
211
212 if (CmdLen > BufferLen)
213 {
214 AcpiOsFree (AcpiGbl_HistoryBuffer[AcpiGbl_NextHistoryIndex].
215 Command);
216 AcpiGbl_HistoryBuffer[AcpiGbl_NextHistoryIndex].Command =
217 AcpiOsAllocate (CmdLen + 1);
218 }
219 }
220 else
221 {
222 AcpiGbl_HistoryBuffer[AcpiGbl_NextHistoryIndex].Command =
223 AcpiOsAllocate (CmdLen + 1);
224 }
225
226 strcpy (AcpiGbl_HistoryBuffer[AcpiGbl_NextHistoryIndex].Command,
227 CommandLine);
228
229 AcpiGbl_HistoryBuffer[AcpiGbl_NextHistoryIndex].CmdNum =
230 AcpiGbl_NextCmdNum;
231
232 /* Adjust indexes */
233
234 if ((AcpiGbl_NumHistory == HISTORY_SIZE) &&
235 (AcpiGbl_NextHistoryIndex == AcpiGbl_LoHistory))
236 {
237 AcpiGbl_LoHistory++;
238 if (AcpiGbl_LoHistory >= HISTORY_SIZE)
239 {
240 AcpiGbl_LoHistory = 0;
241 }
242 }
243
244 AcpiGbl_NextHistoryIndex++;
245 if (AcpiGbl_NextHistoryIndex >= HISTORY_SIZE)
246 {
247 AcpiGbl_NextHistoryIndex = 0;
248 }
249
250 AcpiGbl_NextCmdNum++;
251 if (AcpiGbl_NumHistory < HISTORY_SIZE)
252 {
253 AcpiGbl_NumHistory++;
254 }
255 }
256
257
258 /*******************************************************************************
259 *
260 * FUNCTION: AcpiDbDisplayHistory
261 *
262 * PARAMETERS: None
263 *
264 * RETURN: None
265 *
266 * DESCRIPTION: Display the contents of the history buffer
267 *
268 ******************************************************************************/
269
270 void
AcpiDbDisplayHistory(void)271 AcpiDbDisplayHistory (
272 void)
273 {
274 UINT32 i;
275 UINT16 HistoryIndex;
276
277
278 HistoryIndex = AcpiGbl_LoHistory;
279
280 /* Dump entire history buffer */
281
282 for (i = 0; i < AcpiGbl_NumHistory; i++)
283 {
284 if (AcpiGbl_HistoryBuffer[HistoryIndex].Command)
285 {
286 AcpiOsPrintf ("%3u %s\n",
287 AcpiGbl_HistoryBuffer[HistoryIndex].CmdNum,
288 AcpiGbl_HistoryBuffer[HistoryIndex].Command);
289 }
290
291 HistoryIndex++;
292 if (HistoryIndex >= HISTORY_SIZE)
293 {
294 HistoryIndex = 0;
295 }
296 }
297 }
298
299
300 /*******************************************************************************
301 *
302 * FUNCTION: AcpiDbGetFromHistory
303 *
304 * PARAMETERS: CommandNumArg - String containing the number of the
305 * command to be retrieved
306 *
307 * RETURN: Pointer to the retrieved command. Null on error.
308 *
309 * DESCRIPTION: Get a command from the history buffer
310 *
311 ******************************************************************************/
312
313 char *
AcpiDbGetFromHistory(char * CommandNumArg)314 AcpiDbGetFromHistory (
315 char *CommandNumArg)
316 {
317 UINT32 CmdNum;
318
319
320 if (CommandNumArg == NULL)
321 {
322 CmdNum = AcpiGbl_NextCmdNum - 1;
323 }
324
325 else
326 {
327 CmdNum = strtoul (CommandNumArg, NULL, 0);
328 }
329
330 return (AcpiDbGetHistoryByIndex (CmdNum));
331 }
332
333
334 /*******************************************************************************
335 *
336 * FUNCTION: AcpiDbGetHistoryByIndex
337 *
338 * PARAMETERS: CmdNum - Index of the desired history entry.
339 * Values are 0...(AcpiGbl_NextCmdNum - 1)
340 *
341 * RETURN: Pointer to the retrieved command. Null on error.
342 *
343 * DESCRIPTION: Get a command from the history buffer
344 *
345 ******************************************************************************/
346
347 char *
AcpiDbGetHistoryByIndex(UINT32 CmdNum)348 AcpiDbGetHistoryByIndex (
349 UINT32 CmdNum)
350 {
351 UINT32 i;
352 UINT16 HistoryIndex;
353
354
355 /* Search history buffer */
356
357 HistoryIndex = AcpiGbl_LoHistory;
358 for (i = 0; i < AcpiGbl_NumHistory; i++)
359 {
360 if (AcpiGbl_HistoryBuffer[HistoryIndex].CmdNum == CmdNum)
361 {
362 /* Found the command, return it */
363
364 return (AcpiGbl_HistoryBuffer[HistoryIndex].Command);
365 }
366
367 /* History buffer is circular */
368
369 HistoryIndex++;
370 if (HistoryIndex >= HISTORY_SIZE)
371 {
372 HistoryIndex = 0;
373 }
374 }
375
376 AcpiOsPrintf ("Invalid history number: %u\n", HistoryIndex);
377 return (NULL);
378 }
379
