WO2004079512A2 - Dynamic code generation - Google Patents

Abstract

A system and method for high level dynamic hot code generation. A class file container object is first created. Methods and code are then added to the class file container object. Byte code is then generated from the populated class file container object. From the byte code, instances of the new class object can by generated. The program code generator is configured to generate code at a programming language construct level, thereby working at a level of program language statements, expressions, variables, and other constructs.

Description

DYNAMIC CODE GENERATION

Claim to Priority

[0001] The present application claims priority to the following applications which are incorporated herein:

[0002] U.S. Provisional Patent Application entitled "A SYSTEM FOR GENERATING HOT CODE", Application No. 60/450,720, filed on February

28, 2003.

[0003] U.S. Patent Application entitled "HOT CODE GENERATION

METHOD," Application No. 60/450,987 by William John Gallagher and filed on February 28, 2003. [0004] United States Patent Application No. 10/706,516 "DYNAMIC CODE

GENERATION SYSTEM," filed on November 12, 2003, Attorney Docket No.

BEAS-1316US2, currently pending.

[0005] United States Patent Application No. 10/712,384, entitled "DYNAMIC

CODE GENERATION METHOD", filed on November 12, 2003, Attorney Docket No. BEAS- 1316US3, currently pending.

Copyright Notice [0006] A portion of the disclosure of this patent document contains material which is subject to copyright protection. The copyright owner has no objection to the facsimile reproduction by anyone of the patent document or the patent disclosure, as it appears in the Patent and Trademark Office patent file or records, but otherwise reserves all copyright rights whatsoever.

Cross Reference to Related Applications

[0007] The present application is related to the following United States Patents and Patent Applications, which patents/applications are assigned to the owner of the present invention, and which patents/applications are incorporated by reference herein in their entirety: [0008] United States Patent Application No.10/706,515 entitled "DYNAMICALLY GENERATED WRAPPER", filed on November 12, 2003 Attorney Docket No. BEAS-1339US2, currently pending.

Field of the Invention

[0009] The current invention relates generally to automatically generating program code, and more particularly to high level hot code generation in an object based programming language.

Background of the Invention

[0010] Application server systems provide an environment that allows client applications to implement services over a server network. The application server network may include vendor resources for providing services to the client applications. One such application server system is Web Logic Server, provided by BEA Systems of San Jose, CA.

[0011] As vendor resources and application server utilities are used by client applications, it is often necessary to introduce adapters or proxies to mediate requests between clients and application server resources. A proxy is a class that has the same interface as some other class that it is taking the place of. An adapter takes the place of some class and exposes it through a different interface. A typical application server system implements a large number of proxies as resources are invoked and other services are performed. Many of these proxies require substantial amounts of code while often utilized for limited periods of time. Thus, it is not desirable to implement the interfaces for the lifetime of the application server system.

[0012] One approach is to have a user initiate code generation for the interfaces only when the interface is actually needed. In this case, a client application may run a code generation tool to statically generate a Java file and compile the Java file into a class file. The user then makes the class available to the Java virtual machine. This approach is undesirable because it requires a user to manually perform many steps to generate the code. [0013] Another method for generating interfaces involves Java dynamic proxies. Java dynamic proxies require that an interface and an invocation handler be provided by a user, h return, the Java dynamic proxy generation system provides a class that will forward invocations to the invocation handler. Java dynamic proxies are limited in the types of classes that they generate. [0014] It not possible, for example, to generate a class that is a subclass of a user defined class. Another problem with dynamic proxies is that they are not as efficient as dynamic code generation. To implement many types of proxies, it is often necessary to use reflection within the invocation handler. Reflection is not as efficient as early bound invocation. There is also a cost associated with the way that dynamic proxies marshal the arguments for an invocation into an object array.

[0015] What is needed is an improved system and method for generating program code at runtime for any type of class. Summary of the Invention [0016] The present invention includes a system and method for high level dynamic hot code generation. A class file container object is first created. Methods and code are then added to the class file container object. Byte code is then generated from the populated class file container object. From the byte code, instances of the new class object can by generated. The program code generator is configured to generate code at a programming language construct level, thereby working at a level of program language statements, expressions, variables, and other constructs.

Brief Description of the Drawings

[0017] FIGURE 1 is an illustration of a method for automatically generating program code in accordance with one embodiment of the present invention.

Detailed Description [0018] The automatic program code generator of the present invention provides a high level means to dynamically generate code. The program code generator is configured to generate code at a programming language construct level, thereby working at a level of program language statements, expressions, variables, and other constructs. The code generation can occur as part of a stand-alone application or within the application server process. Typically, the code generated would be configured to exist for the life of the server. In one embodiment, the code generated could be configured to last for some time shorter or longer than the server it resides on, depending on the application and scope of the code generated.

[0019] In one embodiment, the Java based automatic program code generator may be used to generate code for any type of Java program. The invention is especially useful when used to build efficient adapters and proxies. Applications of the Java automatic code generator include but are not limited to remote method invocation (RMI) skeletons, RMI stubs, wrappers for JDBC connections, and proxies used to enforce call-by-value semantics between EJBs, the latter of which are applied to copying parameters. Typically, the code implementing a proxy or adaptor is dynamically generated when the code is needed, such as when a remote method is invoked on a resource. However, the dynamic code generation of the present invention may occur at any time depending on the particular application and resource available. [0020] An API may be used to define a method or code in the method that will comprise the class file container object. FIG. 1 illustrates a method 100 for automatically generating program code in accordance with one embodiment of the present invention. Method 100 begins with start step 105. Next, a class file container object is created in step 110. The class file container object is a representation of a class file. In one embodiment, creating a class file container object includes setting attributes for the class file. The attributes may include the class file name, parent super class, and other attributes. [0021] A method is then added to the class file object at step 120. At generation, the method is empty and contains no code. Step 120 may be repeated several times depending on the number of methods that will be contained within the class file. For example, for a stub generated for a remote object, the stub may include several methods. In this case, for each method in the remote interface, a method would be added to the new class file container object. Code may then be added to the method at step 130. In one embodiment, code is added to a method using constructs that correspond to Java language statements, expressions, variables, or any other programming elements. Each of these constructs may include parameters as necessary. [0022] Steps 120-130 generate a tree of statements and expressions. The tree represents at least one method containing at least one code statement, expression, variable, or other programming construct.

[0023] When the class file container is to be a known type, such as a proxy or adapter, the tree may form a known structure or interface. The organization of the objects in a particular structure or interface avoids the need for a compiler. In one embodiment of the present invention, each statement or expression type is represented as an object. The assembling of received objects into new class objects may be modified to fulfill specific program code implementations and applications. [0024] After the class file container object methods and code have been added, Java bytecode may be generated at step 140. In operation, each statement maintains the state of the program being generated. The maintained state includes, among other things, the contents of the stack and the contents of the local variables that are in use at each point of the program flow. The statement uses this state to generate an intermediate representation of the program flow that consists of Java objects that represent individual bytecode instructions. A bytecode assembler converts the intermediate representation into bytecode that can be interpreted by a Java virtual machine. [0025] After generating the byte code for the class file container object, an instance of the new class file object may be generated at step 150. Operation of method 100 then terminates at step 155. A class loader can be used to generate executable code from the generated byte code.

[0026] A pseudo code example of the API used to generate code as discussed above is shown below. Line numbers 201-206 are illustrated for reference purposes only. import java.io.*; 201 import j ava.lang.reflect. * ;

import weblogic.utils.classfile.*; import weblogic.utils.classfile.expr.*;

public class gen {

public static void main(String[] args) throws Exception { 210

FileOutputStream fos = new FileOutputStream("MyClass.class");

ClassFile classFile = new ClassFile(); 213 classFile.setClassName("MyClass"); classFile.setSuperClassName("java.lang.Object");

// adds the method:

// public static void main(String[] s) { ... } Methodh fo methodHandle = 219 classFile.addMethod("main", "([Ljava lang/String;)V", 220

Modifier.PUBLIC | Modifier. STATIC);

Field f = System.class.getField("out"); Method m =

PrintStream.class.getMethod("println", new Class[] { String.class}

); Expression[] arguments = new Expression^ { Const.get("Hello World!") }; 230

Compounds tatement code = new CompoundStatement();

// add the code:

// System.out.ρrintln("Hello World!"); code.add(new InvokeExpression(f, m, arguments)); 236

// add the code:

// return; code.add(new ReturnStatementQ); 240

methodHandle.setCode(code);

242

classFile.write(fos); 244

}

}

[0027] hi the pseudo code above, the class file container object is generated using the ClassFile statement at line 213. A method is added using the addMethod(NAME, DESCRIPTOR, MODIFIERS) method, wherein the NAME is the name associated with the method. At line 220, the NAME is "main". Information regarding the method "main" is provided at line 220 in the parameters DESCRIPTOR and MODIFIERS. The "addMethod" method returns a handle to the method called "methodHandle". Code is then compiled into a list of statements using the statements at lines 236 and 240. The code is associated with a particular method using a methodHandle. add( ) statement, wherein methodHandle refers to the method added at line 219. Code is added to a method using a methodHandle.setCode (XXX) format, wherein "methodHandle" is a handle to the method to populate with code and XXX identifies the code. In the pseudo code above, the statement method. setCode (code) adds two lines of code tagged with "code" to the method "method". The class file is then _/written using a classFile.write (YYY) format, wherein the YYY represents the file output stream.

[0028] The pseudo code above generates the following class.

import java.io.PrintStream;

public final class MyClass {

public static void main(String args[])

{ System.out.ρrintln("Hello World!");

} }

[0029] The class above is a simplified example that is configured to generate text that reads, "Hello World!". The pseudo code above illustrates code for generating two types of expressions, an invoke expression and a return statement. This illustration is for illustrative purposes only. Other expressions, statements, variables, and other programming constructs are within the scope of the present invention. These programming constructs may include, but are not limited to, switch statements, array expressions (such as an expression allowing one to index into an array), cast expressions (allowing a cast from one object type to another), compound statements (a list of statements), conditional expressions (including Boolean expressions), constant expressions (for all primitive programming types), invoke expressions (for invoking methods on different types of objects), expressions that represent local variables of a method, and expressions for creating new objects and arrays. In one embodiment, the code generation tool of the present invention may be configured to include an expression that represents each Java programming expression and a statement that represents each Java programming statement. [0030] Dynamic code generation can be used to implement an adaptor class in a similar manner to that discussed above. In this embodiment of the present invention, the generated adapter class that may look like the code shown below.

interface Foo

{ public void bar();

}

FooProxy implements Foo

{ Foolmpl delegate;

public void bar() {

// perform some pre-processing // invoke delegate.bar(); // perform some post-processing

} }

[0031] As will be understood by those in the field of programming, this is much more efficient than using an invocation handler with Dynamic Proxies. [0032] Other features, aspects and objects of the invention can be obtained from a review of the figures and the claims. It is to be understood that other embodiments of the invention can be developed and fall within the spirit and scope of the invention and claims.

[0033] The foregoing description of preferred embodiments of the present invention has been provided for the purposes of illustration and description. It is not intended to be exhaustive or to limit the invention to the precise forms disclosed. Obviously, many modifications and variations will be apparent to the practitioner skilled in the art. The embodiments were chosen and described in order to best explain the principles of the invention and its practical application, thereby enabling others skilled in the art to understand the invention for various embodiments and with various modifications that are suited to the particular use contemplated. It is intended that the scope of the invention be defined by the following claims and their equivalence.

[0034] hi addition to an embodiment consisting of specifically designed integrated circuits or other electronics, the present invention may be conveniently implemented using a conventional general purpose or a specialized digital computer or microprocessor programmed according to the teachings of the present disclosure, as will be apparent to those skilled in the computer art. [0035] Appropriate software coding can readily be prepared by skilled programmers based on the teachings of the present disclosure, as will be apparent to those skilled in the software art. The invention may also be implemented by the preparation of application specific integrated circuits or by interconnecting an appropriate network of conventional component circuits, as will be readily apparent to those skilled in the art.

[0036] The present invention includes a computer program product which is a storage medium (media) having instructions stored thereon/in which can be used to program a computer to perform any of the processes of the present invention. The storage medium can include, but is not limited to, any type of disk including floppy disks, optical discs, DVD, CD-ROMs, microdrive, and magneto-optical disks, ROMs, RAMs, EPROMs, EEPROMs, DRAMs, VRAMs, flash memory devices, magnetic or optical cards, nanosystems (including molecular memory ICs), or any type of media or device suitable for storing instructions and/or data.

[0037] Stored on any one of the computer readable medium (media), the present invention includes software for controlling both the hardware of the general purpose/specialized computer or microprocessor, and for enabling the computer or microprocessor to interact with a human user or other mechanism utilizing the results of the present invention. Such software may include, but is not limited to, device drivers, operating systems, and user applications. [0038] Included in the programming (software) of the general/specialized computer or microprocessor are software modules for implementing the teachings of the present invention, including, but not limited to, assembling class file objects, generating a parse tree, instantiating class file objects, and generating byte code.

Claims

hi the Claims:

1. A computer program product for execution by a server computer for automatically generating program code, comprising: computer code for creating a class file container object; computer code for adding a method to the class file object; computer code for adding code to the method; computer code for generating Java byte code for the class file container object; and computer code for generate an instance of the new class file object.

2. The computer program product of claim 1 wherein creating a class file container object includes: setting attributes for a class file.

3. The computer program product of claim 2 the attributes include at least one of class file name, parent super.

4. The computer program product of claim 1 wherein adding a method to the class file object includes: adding a plurality of methods to the class file object.

5. The computer program product of claim 1 wherein adding code to the method includes adding code to the method using constructs that correspond to programming language statements, expressions, and variables.

6. The computer program product of claim 5 wherein the constructs include parameters.

7. The computer program product of claim 5 wherein each statement, expression type, variable is represented as an object.

8. The computer program product of claim 1 wherein generating Java byte code for the class file container object includes: generating an intermediate representation of program flow.

9. The computer program product of claim 8 wherein generating Java byte code for the class file container object includes: converting the intermediate representation into byte code.

10. The computer program product of claim 1 wherein the program code implements an adaptor class.

11. The computer program product of claim 1 wherein the program code implements a proxy class.

12. A method for automatically generating program code, comprising: creating a class file container object; adding a method to the class file object; adding code to the method; generating Java byte code for the class file container object; and generate an instance of the new class file object.

13. The method of claim 12 wherein creating a class file container object includes: setting attributes for a class file.

14. The method of claim 13 the attributes include at least one of class file name, parent super.

15. The method of claim 12 wherein adding a method to the class file object includes: adding a plurality of methods to the class file object.

16. The method of claim 12 wherein adding code to the method includes adding code to the method using constructs that correspond to programming language statements, expressions, and variables.

17. The method of claim 16 wherein the constructs include parameters.

18. The method of claim 16 wherein each statement, expression type, variable is represented as an object.

19. The method of claim 16 wherein generating Java byte code for the class file container object includes: generating an intermediate representation of program flow.

20. The method of claim 19 wherein generating Java byte code for the class file container object includes: converting the intermediate representation into byte code.

21. The method of claim 12 wherein the program code implements an adaptor class.

22. The method of claim 12 wherein the program code implements a proxy class.