Method for Creating Stub File Supporting Remote Procedure Calls by Generating Common Code Including Code Utilized by Stub Procedures to Invoke Plurality of Service Procedures

1. Technical Field

The present invention relates in general to computer networks, and in particular to remote procedure calls. Still more particularly, the present invention relates to stub files utilized in remote procedure calls.

2. Description of the Related Art

Remote procedure calls allow for communication between application programs across a computer network. When a remote procedure is invoked, parameters are passed across the computer network to the application program which will execute the procedure. When the procedure finishes and produces its results, the results are then passed back to the calling application program, where execution of the calling application program resumes. Typically, the calling application program is called the client, and the application program which executes the procedure is called the server. As used herein, the term procedure will be used in a generic sense; program segments which are referred to in particular instances as procedures, functions, and subroutines will all be referred to herein as procedures.

Contemporary remote procedure calls utilize stub files to generate and transport messages which carry the parameters from the client to the server, and then carry the results back to the client. These stub files are generated by a compiler, and can demand large amounts of code. In some computer systems, such as personal computers, stub files which demand large amounts of code may cause the speed of procedure execution to decrease due to paging activity. This undesirable performance degradation caused by the large amounts of code may noticeably affect the operations in the computer systems.

Furthermore, the large amounts of code required by contemporary stub files results in the consumption of a large amount of space in memory and direct access storage devices (DASD) within the computer network. Preferably, as much space as possible in memory and DASD should be utilized by application programs. Those skilled in the art will recognize that this optimizes the efficiency and performance of the computer network. Thus, having stub files consume large amounts of space in memory and DASD limits the performance potential of a computer network.

It would therefore be desirable to reduce the size of stub files in a computer network which utilizes remote procedure calls. This would have the desirable effect of increasing the efficiency, space utilization and performance of the computer network.

It is therefore one object of the present invention to provide a stub file which may be implemented in remote procedure calls.

It is another object of the present invention to provide a stub file which reduces memory and DASD space consumed by the stub file in a computer network.

It is yet another object of the present invention to provide a stub file which improves the efficiency of a computer network.

The foregoing objects are achieved as is now described. A stub file to be utilized by remote procedure calls in a computer network. The stub file comprises a common code, wherein the common code contains shared code for a plurality of stub procedures. A block identifier is passed from the application program to the common code within the stub file and is utilized in conjunction with the common code to invoke the appropriate remote procedure.

The above as well as additional objects, features, and advantages of the present invention will become apparent in the following detailed written description.

The novel features believed characteristic of the invention are set forth in the appended claims. The invention itself however, as well as a preferred mode of use, further objects and advantages thereof, will best be understood by reference to the following detailed description of an illustrative embodiment when read in conjunction with the accompanying drawings, wherein:

FIG. 1 is a block diagram of a computer network which may be utilized to implement the present invention.

FIG. 2 is a block diagram illustrating a stub file according to the prior art.

FIG. 3 is a block diagram illustrating portions of multiple stub procedures according to the prior art.

FIGS. 4A-4B are block diagrams illustrating the concept of multiple stub procedures utilizing a common code in order to reduce the size of each of the multiple stub procedures.

FIG. 5 is a block diagram illustrating a stub file according to the present invention.

With reference now to the figures and in particular with reference to FIG. 1, a block diagram of a computer network is depicted which may be utilized to implement the present invention. The computer network 10 includes a first application program 12 and a first stub file 14. The first application program 12 and the first stub file 14 are located on a local node 16 of the computer network 10. The local node 16 of computer network 10 is typically known in the art as the "client."

If first application program 12 needs a procedure executed and that procedure resides in a remote node 18 on the computer network 10, first application program 12 makes a local call to first stub file 14. In response to the call, first stub file 14 packages parameters into a message and sends the message through a first network interface 20 and a second network interface 22 to the remote node 18. Those skilled in the art will recognize that remote node 18 is known in the art as the "server. "

When the message arrives at the server, a second stub file 24 receives the message and unpacks the parameters from the message. The second stub file 24 then calls a second application program 26 and passes the parameters to the second application program 26. The second application program 26 executes the requested process and then passes the results to the second stub file 24. The second stub file 24 packages the results into a message and transmits the message back through the second interface 22 and the first interface 20 to first stub file 14. Finally, the first stub file 14 receives the message, unpacks the message, and passes the results to the first application program 12.

This process is known in the art as a remote procedure call. A remote procedure call is designed to be transparent to the client. In other words, the first application program 12 is unaware that the called process is executed by an application program on a different computer.

FIG. 2 is a block diagram illustrating a stub file according to the prior art. As can be seen, stub file 28 consists of a header 30, a plurality of stub procedures 32, 34, and a plurality of auxiliary routines 36, 38, 40, 42. The ellipse indicate multiple stub procedures and auxiliary routines may exist in the stub file 28. The header 30 comprises standard includes, type declarations and global variable definitions. Each of the plurality of stub procedures 32, 34 correspond to an operation called by an application program. The plurality of auxiliary routines 36, 38, 40, 42 may be generated for packaging, or "marshalling" and "unmarshalling", structured data such as pointers to record.

Each of the plurality of stub procedures 32, 34 includes, among other items, three blocks of code. The first block 44, labeled A, includes code for defining and initializing local variables. The second block 46, labeled B, includes code for packaging, or "marshalling", input parameters, transport function invocations, and unpackaging, or "unmarshalling", results or output parameters. Finally, the third block 48, labeled C, includes code for memory reclamation and error reporting.

Referring to FIG. 3, a block diagram depicts portions of multiple stub procedures according to the prior art. As can be seen, each of the multiple stub procedures 50, 52, 54, 56 contain the code blocks A, B, and C. The ellipse indicate there may be a multiple number of stub procedures.

When two or more operations have the same set of operation attributes, the corresponding stub procedures will have identical code in blocks A and C. This is indicated in FIG. 3 by each of the stub procedures having a block A and a block C. Thus, for those stub procedures, the code in blocks A and C may be shared. By sharing the code in blocks A and C, the size of each of the stub procedures may be reduced.

FIG. 4a is a block diagram illustrating the concept of sharing the code in blocks A and C. Command stub procedures 56, 58, 60 call a common code 62 which contains the code from blocks A and C. When one of the command stub procedures 56, 58, 60 calls the common code 62, a block B pointer is passed to the common code 62 indicating which appropriate B block is to be called. One of the B blocks 64, 66, 68 is then called by the common code 62.

Parameter numbers and parameter data types vary from operation to operation. In order to make the common code 62 appear "common" to all operations, the common code 62 in the preferred embodiment has a generic list of formal parameters that all operations accept. To be generic, the list of formal parameters must have an adequate number of parameters with data types compatible to the corresponding data types in the operations. Furthermore, the call statement to the different B blocks in the common code 62 must be generic too. The generic call statement must have a variable name in order to be dynamically bound to the block B pointer. Finally, with the common code 62, the code in the B blocks is not able to access the local variables defined in block A. Thus, in the preferred embodiment, the variables utilized in only the B blocks are defined in the corresponding B blocks, and the variables used in both the A and B blocks are defined in the A block and then passed to the B block.

In addition to sharing the code from blocks A and C, in certain situations the code from block B may be shared. This occurs when certain operations have the same input and output parameters of the same data types. This means the marshalling and unmarshalling code in block B in each of the stub procedures will be the same. The only difference between the two routines is the operation number used to acquire the handle for invoking the remote service procedure. Thus, a single B code may be shared if different operation numbers are provided for different remote procedure calls.

For example, in FIG. 3, stub procedure 50 has an operation number of 1, and stub procedure 52 has an operation number of 2. If these two stub procedures have the same input and output parameters of the same data types, the code in each of their respective B blocks is identical. Therefore, the two stub routines 50, 52 may share the code in B, provided a different operation number is supplied for the different remote procedure calls.

Referring now to FIG. 4b, a block diagram illustrates the concept of a plurality of stub procedures 70, 72, 74 sharing code from blocks A, B and C. One of the plurality of stub procedures 70, 72, 74 calls common code 76 and passes a B block pointer (B.sub.i). The B block pointer indicates which shared B code is to be called. The common code 76 then calls the appropriate shared B block from the plurality of B blocks 78, 80 by utilizing the B block pointer. For example, in FIG. 4b, operations 1 and 2 share B code, and this is depicted by block B12. The B block pointer, B12, is included in the each of the call statements for operations 1 and 2.

Finally, the size of the stub file may be reduced even more by utilizing a menu structure for invoking the various B blocks and eliminating the command stub procedures. In the preferred embodiment, a menu structure is accomplished by utilizing a conditional construct switch statement in the common code. The command stub procedures are eliminated in the preferred embodiment by utilizing a macro definition in a generated header file included in front of the application program. Therefore, when the application program is complied, the macro definition substitutes the original stub procedure call with a call to the common code.

FIG. 5 is a block diagram depicting a stub file according to the present invention. As can be seen, stub file 82 includes a header 84, common code 86, and a plurality of auxiliary routines 88, 90, 92, 94. The ellipse indicate multiple auxiliary routines may exist in the stub file 82.

The common code 86 includes the shared code from blocks A and C, and has the B blocks merged into common code 86. A block B identifier, instead of the B block pointer, is specified at the call statement to common code 84 in macro definitions to select the appropriate B block. A conditional construct switch statement is utilized in the common code to select the appropriate B block. The same B block identifier may be utilized by multiple remote procedure call statements to different remote operations that share the same block B. As a result, a single common code 86 exists in the stub file and represents all stub procedures.

Upon the foregoing, those skilled in the art will appreciate that Applicant has provided a structure for stub procedures which greatly reduces the size of the stub procedures. Although the invention has been described with reference to stub procedures at a local node, the invention may also be utilized with stub procedures at a remote node on a computer network.

While the invention has been particularly shown and described with reference to a preferred embodiment, it will be understood by those skilled in the art that various changes in form and detail may be made therein without departing from the spirit and scope of the invention.