Byte code instrumentation

• US 6,314,558 B1
• Filed: 02/16/1999
• Issued: 11/06/2001
• Est. Priority Date: 08/27/1996
• Status: Expired due to Term

• Current Assignee: Borland Software Corporation (Open Text Corporation)
• Original Assignee: Compuware Corporation (KKR & Co., Inc.)
• Inventors: Morshed, Farokh, Seidel, David A., Angel, David J., Kumorek, James R.
• Primary Examiner(s): DAM, TUAN QUANG
• Application Number:
  US09/250,626
• Publication Number:
  US 20010047510A1
• Time in Patent Office: 994 Days
• Field of Search: 717/4, 717/5, 717/7, 714/35, 714/38, 713/2
• US Class Current: 717/118
• CPC Class Codes: G06F 11/3466 Performance evaluation by tracing or monitoring
• CPC Class Codes: G06F 11/3612 by runtime analysis performance monitoring G06F11/3466
• CPC Class Codes: G06F 11/3624 by performing operations on the source code, e.g. via a compiler
• CPC Class Codes: G06F 11/3636 by tracing the execution of the program
• CPC Class Codes: G06F 11/3644 by instrumenting at runtime
• CPC Class Codes: G06F 2201/865 Monitoring of software
• CPC Class Codes: G06F 8/41 Compilation
• CPC Class Codes: G06F 9/45516 Runtime code conversion or optimisation

Abstract

Instrumenting a computer program to provide instrumented byte code includes examining the byte code, selecting portions of the byte code for instrumentation, and instrumenting the portions to provide instrumented byte code. Selecting the portions may include choosing portions of the byte code corresponding to method entry, method exit, a throw, a method call, or a new line number. Instrumenting a portion of the byte code corresponding to a method call may include instrumenting a local line number of source code corresponding to the byte code being instrumented. Instrumenting the portions may include adding calls to instrumentation runtime functions that pass parameters indicative of the portions being instrumented. At least one of the parameters that is passed may include a line number of the source code corresponding to the portion being instrumented or a object pointer for the method corresponding to the portion being instrumented. Data from instrumentation may be passed via a message stream that is viewed as the data is being generated and/or stored.

Claims

1. A method of instrumenting an initial byte code computer program, comprising:

(a) examining the initial byte code to determine an identifier associated with at least one block of code included in the initial byte code;

(b) selecting portions of the initial byte code for instrumentation; and

(c) instrumenting, while loading the initial byte code, the portions by supplementing the initial byte code with additional byte code for instrumentation that facilitates runtime data gathering to monitor execution of the computer program, wherein a portion of the additional byte code uses the identifier to instrument portions of the initial byte code associated with said at least one block of code.

2. A method according to claim 1, wherein selecting the portions includes choosing portions of the byte code corresponding to at least one of:

method entry, method exit, a throw, a method call, and a new line number.

3. A method according to claim 2, wherein instrumenting a portion of the byte code corresponding to a method call includes instrumenting a local line number of source code corresponding to the byte code being instrumented.

4. A method, according to claim 1, wherein instrumenting the portions includes adding calls to instrumentation runtime functions that pass parameters indicative of the portions being instrumented.

5. A method, according to claim 4, wherein at least one of the parameters that is passed includes a line number of the source code corresponding to the portion being instrumented.

6. A method, according to claim 4, wherein at least one of the parameters that is passed includes a thispointer for the method corresponding to the portion being instrumented.

7. A method, according to claim 4, wherein at least one of the parameters that is passed corresponds to at least one method parameter provided to a method containing byte code that is being instrumented.

8. A method, according to claim 7, wherein data indicative of the at least one method parameter is passed in a message buffer from an instrumentation runtime function to at least one viewer routine that displays the data to a user.

9. A method, according to claim 8, wherein the message buffer includes scalar data, array data, and object data.

10. A method, according to claim 9, further comprising:

(d) placing an object header in the message buffer; and

(e) placing an array header in the message buffer.

11. A method, according to claim 10, further comprising:

(f) limiting the message buffer to a predetermined size.

12. A method, according to claim 4, wherein data indicative of the parameters are stored in a message buffer.

13. A method, according to claim 12, wherein data from the message buffer is passed to at least one viewer routine that displays the data to a user.

14. A method, according to claim 1, further comprising:

(d) instrumenting an end of a method to provide instrumentation for handling an abort.

15. A method according to claim 1, further comprising:

(d) instrumenting a call to a native function by adding a byte code wrapper to the native function and then instrumenting the wrapper.

16. A method, according to claim 15, wherein the wrapper includes byte code corresponding to method entry and exit portions.

17. A method, according to claim 1, further comprising:

(d) instrumenting a call to a native function by providing an native assembly language thunk that captures data passed to and from the native function.

18. A method, according to claim 17, further comprising:

(e) hooking the assembly language thunk between a virtual machine and the call to the native function.

19. A method, according to claim 18, wherein hooking the assembly language thunk includes intercepting a call that provides an address for a procedure.

20. A method, according to claim 1, further comprising:

(d) providing a routine to pass data via a message stream.

21. A method, according to claim 20, further comprising:

(e) providing a data storage to store data provided via the message stream.

22. A method, according to claim 20, further comprising:

(e) providing a viewer to allow viewing at least a subset of data from the message stream as the data is being generated.

23. A method of instrumenting a computer program, comprising:

(a) examining an initial byte code representation of the program to determine an identifier associated with at least one block of code included in the initial byte code;

(b) creating a program counter mapping table corresponding to the byte code representation;

(c) selecting portions of the initial byte code representation for instrumenting using the program counter mapping table;

(d) instrumenting, while loading the initial byte code representation, the portions by supplementing the initial byte code with calls to instrumentation runtime functions at at least some of the portions to facilitate runtime data gathering for monitoring execution of the computer program, wherein a portion of the additional byte code uses the identifier to instrument portions of the initial byte code representation associated with said at least one block of code; and

(e) modifying the program counter mapping table according to original byte code and supplemented byte code.

24. A method according to claim 23, wherein selecting the portions includes choosing portions of the initial intermediate representation corresponding to at least one of:

method entry, method exit, a throw, a method call, and a new line number.

25. A method, according to claim 23, wherein instrumenting the portions includes adding calls to instrumentation runtime functions that pass parameters indicative of the portions being instrumented.

26. A method according to claim 23, further comprising:

(f) instrumenting a call to a native function by adding a byte code wrapper to the native function and then instrumenting the wrapper.

27. A method, according to claim 26, wherein the wrapper includes byte code instrumentation corresponding to method entry and exit portions.

28. A method, according to claim 23, further comprising:

(f) instrumenting a call to a native function by providing an native assembly language thunk that captures data passed to and from the native function.

29. A method, according to claim 28, further comprising:

(g) hooking the assembly language thunk between a virtual machine and the call to the native function.

30. A method, according to claim 29, wherein hooking the assembly language thunk includes intercepting a call that provides an address for a procedure.

31. A method, according to claim 23, further comprising:

(f) following examining an initial byte code representation of the program, registering each of the methods and corresponding line numbers thereof with runtime instrumentation code.

32. A method, according to claim 31, wherein registering each of the methods and corresponding line numbers thereof facilitates determining the source code being executed during run time debugging.