Real-time software diagnostic tracing

• US 7,661,094 B2
• Filed: 05/10/2005
• Issued: 02/09/2010
• Est. Priority Date: 05/10/2005
• Status: Expired due to Fees

• Current Assignee: Nokia of America Corporation (Nokia Corporation)
• Original Assignee: Alcatel-Lucent USA, Inc. (Nokia Corporation)
• Inventors: Blevin, John Harris, Daudelin, Douglas Streeter, Buskens, Richard Wayne
• Primary Examiner(s): Dam; Tuan Q
• Assistant Examiner(s): Smith; Cheneca P
• Application Number:
  US11/125,952
• Publication Number:
  US 20060259830A1
• Time in Patent Office: 1,736 Days
• Field of Search: None
• US Class Current: 717/130
• CPC Class Codes: G06F 11/3476 Data logging G06F11/14, G06F11/2205 take precedence
• CPC Class Codes: G06F 11/3644 by instrumenting at runtime

Abstract

Techniques for tracing the real-time operation of software for the purposes of testing, debugging, or performance analysis are disclosed. Diagnostic instrumentation for generating records containing details of software operation is incorporated in the software by inserting calls to diverse macros or inline functions. Each macro takes an argument specifying both a subsystem and a category of instrumentation within the subsystem. Based on the specified subsystem and category, the instrumentation can be included or excluded from the compiled object code and, if included, can be dynamically enabled at run-time. Disabled instrumentation does not result in a function call, but only a single, inline “if,” thereby reducing overhead. One macro accepts both software parameters and a custom format specifier describing how the parameters should be displayed. However, the parameters are not formatted during logging, nor is the format specifier included in the record. Instead, the formatting is performed when displayed.

Claims

1. A method for instrumenting software comprising the steps of:

passing one or more arguments to a macro in an instrumentation line that invokes the macro; and

determining whether or not the instrumentation line is compiled to form a corresponding instance of instrumentation code, at least partly based on at least one of the one or more arguments, wherein the one or more arguments specify at least two dimensions; and

the method further comprises the step of determining at run-time whether or not the instance of instrumentation code is enabled for recording diagnostic information to a log, at least partly based on the at least two dimensions, wherein no function call overhead is incurred if disabled.

2. The method of claim 1 wherein:

at least one of the one or more arguments has at least one associated compile-time value; and

the determination of whether or not the instrumentation line is compiled to form the corresponding instance of instrumentation code is at least partly based on the at least one associated compile-time value.

3. The method of claim 1 wherein:

the method further comprises the step of outfitting the software with at least one header file containing one or more definitions related to the one or more arguments; and

the determination of whether or not the instrumentation line is compiled to form a corresponding instance of instrumentation code is at least partly based on the one or more definitions.

4. The method of claim 1 further comprising the steps of:

passing at least one format specifier to the macro in the instrumentation line for formatting the diagnostic information, wherein the formatting performed by the format specifier is defined in the instrumentation line;

recording into the log at least one identifier for ascertaining the at least one format specifier at a later time; and

recording the diagnostic information to the log without formatting the diagnostic information according to the at least one format specifier.

5. A method for diagnosing software comprising the steps of:

passing one or more arguments to a macro in an instrumentation line that does nothing other than invoke the macro, wherein the one or more arguments specify at least two dimensions;

compiling the instrumentation line to form a corresponding instance of instrumentation code; and

determining at run-time whether or not the instance of instrumentation code is enabled for recording diagnostic information to a log, at least partly based on the at least two dimensions, wherein no function call overhead is incurred if disabled.

6. The method of claim 5 further comprising the step of:

incurring overhead consisting of the equivalent of a single “

if ”

statement if the instance of instrumentation code is disabled.

7. The method of claim 5 further comprising the step of:

determining to which of a plurality of logs the instance of instrumentation code records diagnostic information to, based at least in part on the at least two dimensions.

8. The method of claim 7 further comprising the steps of:

communicating diagnostic information from the plurality of logs for user examination separately from the instance of instrumentation code recording the diagnostic information; and

communicating diagnostic information from at least one of the plurality of logs for user examination while diagnostic information is being recorded to the plurality of logs.

9. The method of claim 5 wherein:

the software has a plurality of instances of instrumentation code including the corresponding instance of instrumentation code; and

the method further comprises the step of recording at least one ID along with the diagnostic information, wherein the at least one ID may be specified so as to at least partly uniquely distinguish any given instance of instrumentation code from all other instances of instrumentation code in the software.

10. The method of claim 9 further comprising the step of utilizing the at least one ID for an action selected from the group consisting of:

specifying sequences upon which to start or stop logging;

invoking processing at record time;

post-processing of diagnostic information;

generating a record of encountered instances of instrumentation code; and

identifying for a post-processor constant information present in software source code but absent from both software object code and recorded diagnostic information.

11. The method of claim 5 further comprising the steps of, upon the occurrence of a stimulus:

stopping or starting the recording of the diagnostic information; and

starting or stopping other logging in progress on other processors in an intercommunicating system of processors that includes a processor executing the software.

12. The method of claim 5 further comprising the step of:

dynamically creating the log at run-time from free memory, and selectively at one or more specified locations in the free memory.

13. The method of claim 5 further comprising the step of:

time stamping the recorded diagnostic information.

14. The method of claim 5 further comprising the step of:

recording an array of data of a requested length if the instance of instrumentation code is enabled.

15. The method of claim 14 wherein:

the method further comprises the step of passing one or more arguments to the macro in the instrumentation line that specify at least one of a format specifier and a discrete software parameter that conveys additional diagnostic information; and

the step of recording the array of data comprises recording the smaller of the requested length and a run-time specified limit on the actual recorded length.

16. The method of claim 5 further comprising the steps of:

selectively examining the contents of a specified region of memory upon recording the diagnostic information to a log; and

conditionally or unconditionally generating a record containing information about the contents of the specified region of memory.

17. A software diagnostic method comprising the steps of:

specifying at least one format specifier in an instrumentation line configured to record software diagnostic information into a log, wherein;

the format specifier is configured for formatting the diagnostic information; and

the formatting performed by the format specifier is defined in the instrumentation line;

recording the diagnostic information to the log without formatting the diagnostic information according to the format specifier;

recording to the log, along with the diagnostic information, at least one identifier for ascertaining the format specifier at a later time;

communicating the diagnostic information from the log for user examination; and

concurrently with or subsequent to said step of communicating the diagnostic information, formatting the diagnostic information according to the format specifier as ascertained from the at least one identifier.

18. The method of claim 17 wherein the at least one identifier identifies a physical address in software object code which contains the format specifier.

19. The method of claim 17 further comprising the step of:

passing one or more arguments to a macro in the instrumentation line, wherein the instrumentation line invokes the macro;

wherein at least one of the one or more arguments at least partly identifies the at least one identifier, and wherein the format specifier is stored someplace other than in software object code.