Abstract:
An apparatus and method for allocating, linking and using blocks of memory to represent a data object in an object-oriented programming environment, particularly COM programming environments. The invention eliminates the conventional viable pointers, reference counters, controlling unknown pointers and other infrastructure overhead from the data objects. This information is instead allocated on a temporary basis only while an object is in use, in object and interface wrappers.

Description:
BACKGROUND OF THE INVENTION 
     The present invention relates to the allocation of memory in a computer at the application level. In particular, the invention relates to the allocation of memory in order to represent objects supported in an object-oriented programming environment. 
     The Component Object Module model (COM) is a language- and location-independent software specification. A general overview of COM and the closely related Object Linked and Embedding model (OLE) are presented below. COM and OLE are described fully in Inside OLE, by Kraig Brockschmidt, published by Microsoft Press (1995, 2d Edition), and in the references listed therein. The Brockschmidt reference is incorporated by reference. However, the Brockschmidt publication is not prior art. 
     As the C++ language is the object-oriented programming language currently enjoying the greatest acceptance among object-oriented programmers, this invention is described in C++. Of course, any language capable of to adhering to the COM standard can realize this invention and its benefits. 
     COM is a binary standard whose primary characteristic are objects and the interfaces associated with particular objects. An interface for an object is a set of functions for manipulating the object. A single object typically has several interfaces. C++ can very conveniently represent COM objects and interfaces (COM classes) with C++ classes. 
     The defining of a COM class proceeds in two steps: the first is the defining of the instance data of the object class. The second step is the defining of a class for each of the object class&#39; interfaces. 
     Interface implementations are C++ classes derived from an abstract interface definition. 
     FIG. 1A schematically illustrates the layout of an example COM object 1A00, according to the conventional COM implementation. The object 1A00 contains some infrastructure, such as a pointer 1A10 to a controlling unknown interface and a reference counter 1A20. The object 1A00 also includes application data 1A30. Further, there is a pointer 1A40 for each interface which the object 1A00 supports, including the requisite IUnknown interface. (Each pointer 1A40 points directly to the vtable implementing the interface.) For each interface which the object 1A00 supports, the conventional implementation allocates a corresponding object 1A50 for the interface. This conventional and convenient implementation of COM interfaces takes advantage of C++&#39;s virtual function capability. 
     However, the conventional implementation has a number of deficiencies. Objects such as sample object 1A00 are allocated and initialized at application start-up and remain in the memory of the application, despite the fact that the application may never use the object and despite the fact that, at any given time, the application will not use most objects. Therefore, the conventional implementation incurs the memory costs of one pointer 1A10 to a controlling interface, the reference counter 1A20, pointers 1A40 and one object 1A50 for each interface supported for an object. 
     Accordingly, a goal of this invention is the reduction of the memory costs of implementing COM objects. 
     Another goal of the invention is the simplification of the programming interface to COM and the elimination of a substantial amount of the repetitive infrastructure of conventional COM. 
     Yet another goal of the invention is to relieve individual designers of the need to devise complicated schemes to reduce memory consumption. 
     SUMMARY OF THE INVENTION 
     The invention is an apparatus and method for allocating, linking and using separate blocks of memory to represent the application data and the object-oriented programming model infrastructure of a data object. The invention includes referencing an object, allocating an object wrapper and then binding the object wrapper to the object. 
     The invention is particularly useful in the COM programming model. There, an object wrapper preferably includes the address of the object, the address of a description of the class of the object, the address of the controlling unknown of the object and the reference count for the object. 
     In a preferred embodiment, this first system maintains descriptions of each object class available in the system. The binding involves selecting from these multiple descriptions that description describing the object class of the object referenced and then linking the object wrapper and the selected description together. 
     In preferred embodiments, the object wrapper implements only one interface, the IUnknown interface, and is termed the IUnknown Wrapper. 
     When the object is queried for an interface (other than the IUnknown interface), the description of the object class is searched for the function table of the desired interface. If the interface exists, a second object wrapper, an Interface Wrapper, is allocated and initialized. The address of the Interface Wrapper is returned as the result of the query. 
     The Interface Wrapper is used to emulate invocation of a function from the function table of the desired interface. The call frame generated by the compiler for the Interface Wrapper function actually invoked is modified to replace a pointer to the Interface Wrapper with a pointer to the object. The function whose invocation is being emulated is then executed. 
     By eliminating the conventional vtable pointers, reference counters, controlling unknown pointers and other overhead from the data objects and instead temporarily allocating these structures in wrappers while an object is in use, the invention reduces the memory cost of modeling data objects as COM objects. 
     Also, the invention defines classes by explicitly stating their instance data and providing a set of independent interfaces. Accordingly, the invention simplifies the programming interface to COM and eliminates much of the infrastructure of conventional COM. 
    
    
     BRIEF DESCRIPTION OF THE DRAWINGS 
     FIG. 1A is a schematic illustration of the memory consumption of a COM object at application start-up according to the prior art; 
     FIG. 1B is a schematic illustration of the memory consumption of a COM object at application start-up according to the present invention; 
     FIG. 2A is a schematic illustration of an object wrapper; 
     FIG. 2B is a schematic illustration of an interface wrapper; 
     FIG. 3 illustrates the relationship of a type map to a data object; 
     FIG. 4 is illustrates the contents of an Interface List; 
     FIG. 5 is a schematic of an unmodified stack according to the standard call compiler convention; and 
     FIG. 6 is a schematic of a modified stack according to the standard call compiler convention. 
    
    
     DESCRIPTION OF THE PREFERRED EMBODIMENT 
     The Dynamic Interfaces system of the invention is supported by a set of data structures which capture as data information that is conventionally captured as code in COM implementations. There are two main static data structures in the Dynamic Interfaces system: a Type Map with information about which classes are supported, and an Interface List with information about which interfaces are supported on each class. There are two types of object wrappers, the main dynamic data structure: IUnknown Wrappers and Interface Wrappers. A description of the static data structures follows immediately. A description of the dynamic data structures appears further below. 
     A Type Map is the root of the Dynamic Interfaces static data structures and is essentially a table of all of the classes involved in the Dynamic Interfaces system. This object is global. 
     Referring to FIG. 3, the Type Map is implemented as an array 310, indexed by integer identifiers discussed below. Each entry in the Type Map 310 is a Type Map Record 312 fully describing a particular class. A Type Map Record 312 for a class contains the following information: 
     a pointer 316 to an Interface List 314 specifying the interfaces that the class supports; 
     the CLSID of the class; and 
     the integer-type identifier (not shown) of the class. 
     The system uses the CLSID to load the class&#39; primary DLL (through CoGetClassObject). 
     (In an alternative embodiment, where the class identifiers are larger than the two-byte integers envisioned here, the Type Map 310 is preferably a hash table.) 
     Referring to FIG. 4, an Interface List 314 specifies the interfaces that a class supports. In a preferred embodiment, an Interface List 314 is an array 410 of pointers 412 to Interface Definition structures 414. An Interface Definition 414 defines the implementation of one interface and is a tuple pairing an interface ID (IID) with the vtable 416 that implements the interface. 
     The organization of a vtable 416 is part of the OLE specification. Accordingly, a vtable 416 is an array of pointers to the functions that implement the interface. 
     The creation of these static data structures results from the use of the various macros described below. Creation of most of the data structures occurs at compile time, but the system ties together some components at runtime. The runtime processing is initiated by the constructors and destructors of global variables declared with the macros. The loading into and unloading from memory of a DLL fires these functions. 
     Each vtable 416 is a static member variable of its interface&#39;s interface implementation class. Each interface implementation class includes the macro DECLARE --  DYN --  MAP which declares a vtable 416. Macros BEGIN --  DYN --  MAP and END --  DYN --  MAP begin and terminate, respectively, the initialization of a vtable 416. Between the BEGIN --  DYN --  MAP and END --  DYN --  MAP macros, a DYN --  MAP --  ENTRY macro specifies one entry in this array 416. The vtables 416 are thus completely specified at compile time. 
     The template for using the macros is as follows: 
     BEGIN --  DYN --  MAP (&lt;interface implementation class&gt;) 
     DYN --  MAP --  ENTRY (&lt;interface implementation class&gt;, &lt;member function&gt;) 
     DYN --  MAP ENTRY (&lt;interface implementation class&gt;, &lt;member function&gt;) 
     DYN --  MAP ENTRY (&lt;interface implementation class&gt;, &lt;member function&gt;) 
     END --  DYN --  MAP () 
     where &lt;interface implementation class&gt; is the name of the class implementing the interface and there is a &lt;member function&gt; entry for each member function in the interface. 
     Similarly, a BEGIN --  DYN --  CLASS macro initializes an Interface List 314, and a series of DYN --  INTERFACE --  ENTRY macros specify the array 410 of pointers 412 and the Interface Definitions 418 that make up the list. An END --  DYN --  CLASS macro terminates the initialization list. Thus, an Interface List 314 is also completely specified at compile time. 
     The template for using these macros is as follows: 
     BEGIN --  DYN --  CLASS (&lt;COM class&gt;) 
     DYN --  INTERFACE --  ENTRY (&lt;iid&gt;, &lt;interface implementation class&gt;) 
     DYN --  INTERFACE --  ENTRY (&lt;iid&gt;, &lt;interface implementation class&gt;) 
     DYN --  INTERFACE --  ENTRY (&lt;iid&gt;, &lt;interface implementation class&gt;) 
     END --  DYN --  CLASS () 
     Interface List objects have a constructor that accepts the address of the Interface Definition array 410 and the integer type of the class. This constructor counts the number of entries in the Interface Definition array 410 and stores that count in its instance data. The system updates the Type Map Record 312 identified by the integer-type number with this information and otherwise initializes the Type Map Record 312. 
     In one preferred embodiment, the Type Map 310 is a global variable containing a fixed-size, pre-allocated array. In another embodiment, the Type Map 310 is a reallocable array of pointers and the BEGIN --  DYN --  CLASS macros define and initialize the Type Map Record structures 312. 
     The runtime system is described below. 
     When an application accesses a Dynamic Interfaces object, the system assigns the object various wrappers that provide the COM behavior. There are two types of object wrappers: IUnknown Wrappers and Interface Wrappers. The invention maintains a cache of these object wrappers and can allocate one in a few instructions. 
     FIGS. 2A and 2B illustrate an IUnknown Wrapper 2A10 and Interface Wrappers 2B10, respectively. 
     In a preferred embodiment, in addition to a pointer to a vtable including the ubiquitous IUnknown functions, an IUnknown Wrapper 2A10 includes the following instance data: 
     the address 2A20 of the object 2A60 being wrapped; 
     the address 2A30 of the Type Map Record 312 describing the object 2A60&#39;s class; 
     the address 2A40 of the object 2A60&#39;s controlling Unknown 2A70; and 
     the IUnknown Wrapper 2A10&#39;s reference count 2A50. 
     An IUnknown Wrapper 2A10 is allocated when the object 2A60 is first referenced. When the system assigns the IUnknown Wrapper 2A10 to the object 2A60, the IUnknown Wrapper 2A10 goes through a binding process in which this instance data is initialized. 
     Binding is not expensive. The most substantial work involved is finding the appropriate Type Map Record 312. This is done by indexing the Type Map 310 with the object 2A60&#39;s integer-type ID for the Type Map Record 312. 
     There is ever only one IUnknown Wrapper 2A10 for an object 2A60 at any given time. The IUnknown Wrapper 2A10 remains bound to the object 2A60 until the reference count 2A50 of the object 2A60 goes to zero. The IUnknown Wrapper 2A10 is the IUnknown implementation for the class. The IUnknown Wrapper 2A10 is derived from IUnknown, and its address is returned when the application calls IUnknown::QueryInterface. 
     The IUnknown Wrapper 2A10 cannot implement any interface other than IUnknown. When a client requests an interface through QueryInterface, the system traverses the Interface List 314 and locates the vtable that implements the requested interface. The IUnknown Wrapper 2A10 then allocates an Interface Wrapper 2B10 and initializes it with this vtable 416. QueryInterface returns the address of the Interface Wrapper 2B10 as the interface implementation. 
     (Each 
     DYN --  INTERFACE --  ENTRY (&lt;iid&gt;, &lt;interface implementation class&gt;) 
     line described above is equivalent to the code: 
     
         ______________________________________if (IsEqualIID( riid, iid ))   *ppvObj = (LVVOID) &lt;class name&gt;;}______________________________________ 
    
     which would be found in a conventional QueryInterface.) 
     In a preferred embodiment, in addition to a pointer to a vtable including the IUnknown functions and Interface Wrapper member functions described below, each Interface Wrapper 2B10 includes: 
     the address 2B20 of the corresponding IUnknown Wrapper 2A10; 
     the address 2B30 of the vtable 416 implementing the interface; and 
     the reference count 2B40 of the Interface Wrapper 2B10. 
     The main function of the Interface Wrapper 2B10 is to masquerade as an implementation of whatever interface corresponds to the address 2B30 assigned by the system. Since the calling software does not know anything about Interface Wrappers, that software invokes member functions on the data object, thinking that it is invoking COM interface member functions (but actually invoking the Interface Wrapper member functions described below). 
     When an application invokes a COM member function, the compiler builds what is called a call frame, which includes the function&#39;s actual parameters, a pointer to the object on which to operate and the address to which to return. Typically, the compiler supports a number of calling conventions. However, the COM specification states that all interface calls must use a convention referred to as &#34;standard call&#34; (&#34; --  stdcall&#34;). (This is what the conventional STDMETHOD macro does.) In this convention, all parameters are passed on the stack, with the object&#39;s this pointer being captured in an implicit first argument. The program then branches to the invoked function, which extracts its this pointer and parameters from the stack. 
     When software calls a member function of an Interface Wrapper 2B10, the compiler gives the called function a valid call frame, formatted for the interface member function that the Interface Wrapper 2B10 is emulating. FIG. 5 is a schematic of such a call frame according to the standard call convention. 
     However, three issues present themselves: First, the call frame includes the this pointer 610 of the Interface Wrapper 2B10 instead of that of the data object. Second, one of the Interface Wrapper 2B10&#39;s member functions is executing instead of the required function of the interface implementation class. Third, Interface Wrapper member functions are written in assembly language, raising portability issues. 
     As to the Interface Wrapper pointer in the call frame, the Interface Wrapper member function which is executing extracts the address 2A20 of the data object from its instance data (through its pointer 2B20 to the IUnknown Wrapper 2A10) and writes this value to the stack in the appropriate position. FIG. 6 is a sketch of a modified stack according to the standard call convention. 
     As to execution of the correct function, the Interface Wrapper member function which is executing extracts the address of the function that should be executing from its instance data (via vtable pointer 2B30) and branches to that address. The required member function then starts executing. 
     A more serious issue is the fact that the Interface Wrapper member functions are written in assembly language. In a preferred embodiment, however, the portability of only one function is at issue here. The actual Interface Wrapper member functions are implemented with a macro that records the function&#39;s number and branches to a central function. Assuming it is possible to find the position of the first function parameter on the stack, this central function is very simple and easily portable. This first parameter is easy to find if the compiler pushes the parameters onto the stack right-to-left but is not as readily locatable if the compiler pushes the parameters left-to-right. Conventional COM binary seems to mandate the right-to-left convention, though no explicit statement to this effect is known. 
     With left-to-right parameters, the system must maintain an indicator of the number of bytes in the call frame of each member function of each interface. These indicators would have to be accessible through the Interface Wrapper. As one of skill in the art will appreciate, this can be accomplished with a few more table-building macros. 
     (The class of an Interface Wrapper declares a vtable of a certain fixed size (preferably, 30). The system cannot handle interfaces with more member functions than this. In a preferred embodiment, an assertion will occur in debug mode if an attempt is made to register a vtable that exceeds this limit.) 
     OBJECT AND INTERFACE CLASS DEFINITION IN A PREFERRED EMBODIMENT 
     According to the present invention, the designer defines COM classes in substantially the same way as before: defining one class for the instance data and defining one class for each of the class&#39; interfaces. However, the internals of a class and the mechanism of tying the classes together are quite different, as shown by a comparison of FIG. 1A with FIGS. 1B, 2A and 2B and as described herein. 
     The fundamental definition of a COM object class is its data C++ class. With Dynamic Interfaces, the designer defines a normal C++ class. When the object gets created, the mechanism that records the unique identifier for the object class must be initialized. For example, by means of an overload of the new operator, the unique identifier type can be stored as part of the data object, as illustrated by types 318 in FIG. 3. This mechanism can be reduced to a macro, herein termed, DECLARE --  NEW --  OVERLOAD, which takes the unique identifier as its one argument. 
     Preferably, this unique identifier is an unsigned short (two-byte) integer. However, COM objects are already identified by a CLSID, and the CLSID of a class can be the argument to the macro. There is a tradeoff between programming convenience and execution speed, the main advantage of a short integer being performance. In any event, the Type Map is indexed in accordance with the selection of the CLSID or the short integer. 
     An example data class is as follows: 
     
         ______________________________________class Pointprotected:int        m.sub.-- nX;int           m.sub.-- nY;int           m.sub.-- nSymbology;public:DECLARE NEW.sub.-- OVERLOAD( POINT.sub.-- TYPE )Point( void );};______________________________________ 
    
     The class is not derived from any other class and contains no virtual functions. While virtual functions are not prohibited, they are generally not necessary because COM functions as the &#34;object polymorphism&#34; machine. 
     Also, the class has no COM-support member data such as a reference counter (e.g., m --  cRef in FIG. 1A) or a pointer to a controlling interface (e.g., m --  pUnkOuter in FIG. 1A). This data is not necessary here, as the system handles it as described above. 
     With regard to interface definitions, a Dynamic Interfaces class definition implements each COM interface implementation for a particular data class independently of the other interfaces on that class. The Dynamic Interfaces class is publicly derived from the data class upon which the interface is defined and includes a DECLARE --  DYN --  MAP macro and the interface member function declarations. 
     The following is a generic IGraphic interface on the Point object defined above: 
     
         ______________________________________DECLARE.sub.-- INTERFACE.sub.--  (IGraphic, IUnknown)STDMETHOD(QueryInterface) (THIS REFIID riid,LPVOID FAR *ppvObj) PURE;STDMETHOD.sub.-- (ULONG, AddRef) (THIS) PURE;STDMETHOD.sub.-- (ULONG, Release) (THIS) PURE;STDMETHOD(Locate) (THIS.sub.--   int x, int y ) PURE;STDMETHOD(Display) (THIS.sub.--  HWND hWnd )PURE;STDMETHOD(PutGeometry) (THIS.sub.-- int x, int y ) PURE;STDMETHOD(GetGeometry) (THIS.sub.-- int *x, int *y )PURE;};______________________________________ 
    
     The implementation class would be 
     
         ______________________________________class PointIGraphic : public PointDECLARE.sub.-- DYN.sub.-- MAP(PointIGraphic)STDMETHODIMP Locate(int x, int y );STDMETHODIMP Display(HWND hWnd );STDMETHODIMP PutGeometry(int x, int y );STDMETHODIMP GetGeometry(int *x, int *y );};______________________________________ 
    
     Notably, the implementation class does not provide the standard IUnknown functions QueryInterface, AddRef and Release. 
     The vtable definition of the PointIGraphic class described above would be: 
     BEGIN --  DYN --  MAP (PointIGraphic) 
     DYN --  MAP --  ENTRY (PointIGraphic, Locate) 
     DYN --  MAP --  ENTRY (PointIGraphic, Display) 
     DYN --  MAP --  ENTRY (PointIGraphic, PutGeometry) 
     DYN --  MAP --  ENTRY (PointIGraphic, GetGeometry) 
     END --  DYN --  MAP () 
     These entries appear in the same order in which they appear in the interface definition. 
     Finally, general support for a COM InProc Server is described. The general DLL infrastructure for Dynamic Interfaces DLLs is identical to that for conventional COM DLLs. DllGetClassObject is used to obtain class objects. DllCanUnloadNow determines whether the DLL can be unloaded from memory. 
     Dynamic Interfaces DLLs specify the interfaces that the class supports. They do so by placing the BEGIN --  DYN --  CLASS, DYN --  INTERFACE --  ENTRY and END --  DYN --  CLASS macros at file scope. For example, if the Point class defined above supports two interfaces, IGraphic and ISymbology, then its registration section would be 
     BEGIN --  DYN --  CLASS (POINT --  TYPE) 
     DYN --  INTERFACE --  ENTRY (IID --  IGraphic, PointIGraphic) 
     DYN --  INTERFACE --  ENTRY (IID --  ISymbology, PointISymbology) 
     END --  DYN --  CLASS () 
     Since Dynamic Interfaces objects require less memory than conventional COM objects, using Dynamic Interface objects enhances general system performance, particularly as page faulting is reduced. Nevertheless, the wrapping system does incur some overhead: Obtaining the first interface on an object requires the allocation of two wrappers, and subsequent interfaces each require one wrapper. The QueryInterface function itself should not be significantly slower than that of conventional COM. Once an interface pointer has been obtained, invoking a member function will take a small number of extra machine instructions (e.g., 10 on an 80×86 processor), typically negligible compared to the function&#39;s processing. 
     Dynamic Interface objects fully support the published COM semantics. They are constructed with class objects, they are manipulated through interfaces, they support IUnknown identity and they can aggregate objects and be aggregated by others. 
     Of course, the program text for such software as is herein disclosed can exist in its static form on a magnetic, optical or other disk, in ROM, in RAM, or in another data storage medium. That data storage medium may be integral to or insertable into a computer system.