osgendbg.c revision 316303 
1/******************************************************************************
2 *
3 * Module Name: osgendbg - Generic debugger command singalling
4 *
5 *****************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2015, 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 <contrib/dev/acpica/include/acpi.h>
153#include <contrib/dev/acpica/include/accommon.h>
154#include <contrib/dev/acpica/include/acdebug.h>
155
156
157#define _COMPONENT          ACPI_CA_DEBUGGER
158        ACPI_MODULE_NAME    ("osgendbg")
159
160
161/* Local prototypes */
162
163static void
164AcpiDbRunRemoteDebugger (
165    char                    *BatchBuffer);
166
167
168static ACPI_MUTEX           AcpiGbl_DbCommandReady;
169static ACPI_MUTEX           AcpiGbl_DbCommandComplete;
170static BOOLEAN              AcpiGbl_DbCommandSignalsInitialized = FALSE;
171
172/******************************************************************************
173 *
174 * FUNCTION:    AcpiDbRunRemoteDebugger
175 *
176 * PARAMETERS:  BatchBuffer         - Buffer containing commands running in
177 *                                    the batch mode
178 *
179 * RETURN:      None
180 *
181 * DESCRIPTION: Run multi-threading debugger remotely
182 *
183 *****************************************************************************/
184
185static void
186AcpiDbRunRemoteDebugger (
187    char                    *BatchBuffer)
188{
189    ACPI_STATUS             Status;
190    char                    *Ptr = BatchBuffer;
191    char                    *Cmd = Ptr;
192
193
194    while (!AcpiGbl_DbTerminateLoop)
195    {
196        if (BatchBuffer)
197        {
198            if (*Ptr)
199            {
200                while (*Ptr)
201                {
202                    if (*Ptr == ',')
203                    {
204                        /* Convert commas to spaces */
205                        *Ptr = ' ';
206                    }
207                    else if (*Ptr == ';')
208                    {
209                        *Ptr = '\0';
210                        continue;
211                    }
212
213                    Ptr++;
214                }
215
216                strncpy (AcpiGbl_DbLineBuf, Cmd, ACPI_DB_LINE_BUFFER_SIZE);
217                Ptr++;
218                Cmd = Ptr;
219            }
220            else
221            {
222                return;
223            }
224        }
225        else
226        {
227            /* Force output to console until a command is entered */
228
229            AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT);
230
231            /* Different prompt if method is executing */
232
233            if (!AcpiGbl_MethodExecuting)
234            {
235                AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_COMMAND_PROMPT);
236            }
237            else
238            {
239                AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_EXECUTE_PROMPT);
240            }
241
242            /* Get the user input line */
243
244            Status = AcpiOsGetLine (AcpiGbl_DbLineBuf,
245                ACPI_DB_LINE_BUFFER_SIZE, NULL);
246            if (ACPI_FAILURE (Status))
247            {
248                return;
249            }
250        }
251
252        /*
253         * Signal the debug thread that we have a command to execute,
254         * and wait for the command to complete.
255         */
256        AcpiOsReleaseMutex (AcpiGbl_DbCommandReady);
257
258        Status = AcpiOsAcquireMutex (AcpiGbl_DbCommandComplete,
259            ACPI_WAIT_FOREVER);
260        if (ACPI_FAILURE (Status))
261        {
262            return;
263        }
264    }
265}
266
267
268/******************************************************************************
269 *
270 * FUNCTION:    AcpiOsWaitCommandReady
271 *
272 * PARAMETERS:  None
273 *
274 * RETURN:      Status
275 *
276 * DESCRIPTION: Negotiate with the debugger foreground thread (the user
277 *              thread) to wait the readiness of a command.
278 *
279 *****************************************************************************/
280
281ACPI_STATUS
282AcpiOsWaitCommandReady (
283    void)
284{
285    ACPI_STATUS             Status = AE_OK;
286
287
288    if (AcpiGbl_DebuggerConfiguration == DEBUGGER_MULTI_THREADED)
289    {
290        Status = AE_TIME;
291
292        while (Status == AE_TIME)
293        {
294            if (AcpiGbl_DbTerminateLoop)
295            {
296                Status = AE_CTRL_TERMINATE;
297            }
298            else
299            {
300                Status = AcpiOsAcquireMutex (AcpiGbl_DbCommandReady, 1000);
301            }
302        }
303    }
304    else
305    {
306        /* Force output to console until a command is entered */
307
308        AcpiDbSetOutputDestination (ACPI_DB_CONSOLE_OUTPUT);
309
310        /* Different prompt if method is executing */
311
312        if (!AcpiGbl_MethodExecuting)
313        {
314            AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_COMMAND_PROMPT);
315        }
316        else
317        {
318            AcpiOsPrintf ("%1c ", ACPI_DEBUGGER_EXECUTE_PROMPT);
319        }
320
321        /* Get the user input line */
322
323        Status = AcpiOsGetLine (AcpiGbl_DbLineBuf,
324            ACPI_DB_LINE_BUFFER_SIZE, NULL);
325    }
326
327    if (ACPI_FAILURE (Status) && Status != AE_CTRL_TERMINATE)
328    {
329        ACPI_EXCEPTION ((AE_INFO, Status,
330            "While parsing/handling command line"));
331    }
332    return (Status);
333}
334
335
336/******************************************************************************
337 *
338 * FUNCTION:    AcpiOsNotifyCommandComplete
339 *
340 * PARAMETERS:  void
341 *
342 * RETURN:      Status
343 *
344 * DESCRIPTION: Negotiate with the debugger foreground thread (the user
345 *              thread) to notify the completion of a command.
346 *
347 *****************************************************************************/
348
349ACPI_STATUS
350AcpiOsNotifyCommandComplete (
351    void)
352{
353
354    if (AcpiGbl_DebuggerConfiguration == DEBUGGER_MULTI_THREADED)
355    {
356        AcpiOsReleaseMutex (AcpiGbl_DbCommandComplete);
357    }
358    return (AE_OK);
359}
360
361
362/******************************************************************************
363 *
364 * FUNCTION:    AcpiOsInitializeDebugger
365 *
366 * PARAMETERS:  None
367 *
368 * RETURN:      Status
369 *
370 * DESCRIPTION: Initialize OSPM specific part of the debugger
371 *
372 *****************************************************************************/
373
374ACPI_STATUS
375AcpiOsInitializeDebugger (
376    void)
377{
378    ACPI_STATUS             Status;
379
380
381    /* Create command signals */
382
383    Status = AcpiOsCreateMutex (&AcpiGbl_DbCommandReady);
384    if (ACPI_FAILURE (Status))
385    {
386        return (Status);
387    }
388    Status = AcpiOsCreateMutex (&AcpiGbl_DbCommandComplete);
389    if (ACPI_FAILURE (Status))
390    {
391        goto ErrorReady;
392    }
393
394    /* Initialize the states of the command signals */
395
396    Status = AcpiOsAcquireMutex (AcpiGbl_DbCommandComplete,
397        ACPI_WAIT_FOREVER);
398    if (ACPI_FAILURE (Status))
399    {
400        goto ErrorComplete;
401    }
402    Status = AcpiOsAcquireMutex (AcpiGbl_DbCommandReady,
403        ACPI_WAIT_FOREVER);
404    if (ACPI_FAILURE (Status))
405    {
406        goto ErrorComplete;
407    }
408
409    AcpiGbl_DbCommandSignalsInitialized = TRUE;
410    return (Status);
411
412ErrorComplete:
413    AcpiOsDeleteMutex (AcpiGbl_DbCommandComplete);
414ErrorReady:
415    AcpiOsDeleteMutex (AcpiGbl_DbCommandReady);
416    return (Status);
417}
418
419
420/******************************************************************************
421 *
422 * FUNCTION:    AcpiOsTerminateDebugger
423 *
424 * PARAMETERS:  None
425 *
426 * RETURN:      None
427 *
428 * DESCRIPTION: Terminate signals used by the multi-threading debugger
429 *
430 *****************************************************************************/
431
432void
433AcpiOsTerminateDebugger (
434    void)
435{
436
437    if (AcpiGbl_DbCommandSignalsInitialized)
438    {
439        AcpiOsDeleteMutex (AcpiGbl_DbCommandReady);
440        AcpiOsDeleteMutex (AcpiGbl_DbCommandComplete);
441    }
442}
443
444
445/******************************************************************************
446 *
447 * FUNCTION:    AcpiRunDebugger
448 *
449 * PARAMETERS:  BatchBuffer         - Buffer containing commands running in
450 *                                    the batch mode
451 *
452 * RETURN:      None
453 *
454 * DESCRIPTION: Run a local/remote debugger
455 *
456 *****************************************************************************/
457
458void
459AcpiRunDebugger (
460    char                    *BatchBuffer)
461{
462    /* Check for single or multithreaded debug */
463
464    if (AcpiGbl_DebuggerConfiguration & DEBUGGER_MULTI_THREADED)
465    {
466        AcpiDbRunRemoteDebugger (BatchBuffer);
467    }
468    else
469    {
470        AcpiDbUserCommands ();
471    }
472}
473
474ACPI_EXPORT_SYMBOL (AcpiRunDebugger)
475