sys/contrib/dev/acpica-unix/debugger/dbhistry.c

   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 - 2011, 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
 117 #include "acpi.h"
 118 #include "accommon.h"
 119 #include "acdebug.h"
 120
 121 #ifdef ACPI_DEBUGGER
 122
 123 #define _COMPONENT          ACPI_CA_DEBUGGER
 124         ACPI_MODULE_NAME    ("dbhistry")
 125
 126
 127 #define HI_NO_HISTORY       0
 128 #define HI_RECORD_HISTORY   1
 129 #define HISTORY_SIZE        20
 130
 131
 132 typedef struct HistoryInfo
 133 {
 134     char                    Command[80];
 135     UINT32                  CmdNum;
 136
 137 } HISTORY_INFO;
 138
 139
 140 static HISTORY_INFO         AcpiGbl_HistoryBuffer[HISTORY_SIZE];
 141 static UINT16               AcpiGbl_LoHistory = 0;
 142 static UINT16               AcpiGbl_NumHistory = 0;
 143 static UINT16               AcpiGbl_NextHistoryIndex = 0;
 144 static UINT32               AcpiGbl_NextCmdNum = 1;
 145
 146
 147 /*******************************************************************************
 148  *
 149  * FUNCTION:    AcpiDbAddToHistory
 150  *
 151  * PARAMETERS:  CommandLine     - Command to add
 152  *
 153  * RETURN:      None
 154  *
 155  * DESCRIPTION: Add a command line to the history buffer.
 156  *
 157  ******************************************************************************/
 158
 159 void
 160 AcpiDbAddToHistory (
 161     char                    *CommandLine)
 162 {
 163
 164     /* Put command into the next available slot */
 165
 166     ACPI_STRCPY (AcpiGbl_HistoryBuffer[AcpiGbl_NextHistoryIndex].Command,
 167         CommandLine);
 168
 169     AcpiGbl_HistoryBuffer[AcpiGbl_NextHistoryIndex].CmdNum = AcpiGbl_NextCmdNum;
 170
 171     /* Adjust indexes */
 172
 173     if ((AcpiGbl_NumHistory == HISTORY_SIZE) &&
 174         (AcpiGbl_NextHistoryIndex == AcpiGbl_LoHistory))
 175     {
 176         AcpiGbl_LoHistory++;
 177         if (AcpiGbl_LoHistory >= HISTORY_SIZE)
 178         {
 179             AcpiGbl_LoHistory = 0;
 180         }
 181     }
 182
 183     AcpiGbl_NextHistoryIndex++;
 184     if (AcpiGbl_NextHistoryIndex >= HISTORY_SIZE)
 185     {
 186         AcpiGbl_NextHistoryIndex = 0;
 187     }
 188
 189     AcpiGbl_NextCmdNum++;
 190     if (AcpiGbl_NumHistory < HISTORY_SIZE)
 191     {
 192         AcpiGbl_NumHistory++;
 193     }
 194 }
 195
 196
 197 /*******************************************************************************
 198  *
 199  * FUNCTION:    AcpiDbDisplayHistory
 200  *
 201  * PARAMETERS:  None
 202  *
 203  * RETURN:      None
 204  *
 205  * DESCRIPTION: Display the contents of the history buffer
 206  *
 207  ******************************************************************************/
 208
 209 void
 210 AcpiDbDisplayHistory (
 211     void)
 212 {
 213     UINT32                  i;
 214     UINT16                  HistoryIndex;
 215
 216
 217     HistoryIndex = AcpiGbl_LoHistory;
 218
 219     /* Dump entire history buffer */
 220
 221     for (i = 0; i < AcpiGbl_NumHistory; i++)
 222     {
 223         AcpiOsPrintf ("%ld  %s\n", AcpiGbl_HistoryBuffer[HistoryIndex].CmdNum,
 224                                    AcpiGbl_HistoryBuffer[HistoryIndex].Command);
 225
 226         HistoryIndex++;
 227         if (HistoryIndex >= HISTORY_SIZE)
 228         {
 229             HistoryIndex = 0;
 230         }
 231     }
 232 }
 233
 234
 235 /*******************************************************************************
 236  *
 237  * FUNCTION:    AcpiDbGetFromHistory
 238  *
 239  * PARAMETERS:  CommandNumArg           - String containing the number of the
 240  *                                        command to be retrieved
 241  *
 242  * RETURN:      Pointer to the retrieved command. Null on error.
 243  *
 244  * DESCRIPTION: Get a command from the history buffer
 245  *
 246  ******************************************************************************/
 247
 248 char *
 249 AcpiDbGetFromHistory (
 250     char                    *CommandNumArg)
 251 {
 252     UINT32                  i;
 253     UINT16                  HistoryIndex;
 254     UINT32                  CmdNum;
 255
 256
 257     if (CommandNumArg == NULL)
 258     {
 259         CmdNum = AcpiGbl_NextCmdNum - 1;
 260     }
 261
 262     else
 263     {
 264         CmdNum = ACPI_STRTOUL (CommandNumArg, NULL, 0);
 265     }
 266
 267     /* Search history buffer */
 268
 269     HistoryIndex = AcpiGbl_LoHistory;
 270     for (i = 0; i < AcpiGbl_NumHistory; i++)
 271     {
 272         if (AcpiGbl_HistoryBuffer[HistoryIndex].CmdNum == CmdNum)
 273         {
 274             /* Found the commnad, return it */
 275
 276             return (AcpiGbl_HistoryBuffer[HistoryIndex].Command);
 277         }
 278
 279
 280         HistoryIndex++;
 281         if (HistoryIndex >= HISTORY_SIZE)
 282         {
 283             HistoryIndex = 0;
 284         }
 285     }
 286
 287     AcpiOsPrintf ("Invalid history number: %u\n", HistoryIndex);
 288     return (NULL);
 289 }
 290
 291 #endif /* ACPI_DEBUGGER */
 292