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