include/rpcproxy.h

   1 /*
   2  * Copyright (C) 2001 Ove Kaaven
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #ifndef __RPCPROXY_H_VERSION__
  20 /* FIXME: Find an appropriate version number.  I guess something is better than nothing */
  21 #define __RPCPROXY_H_VERSION__ ( 399 )
  22 #endif
  23
  24 #ifndef __WINE_RPCPROXY_H
  25 #define __WINE_RPCPROXY_H
  26
  27 #define __midl_proxy
  28
  29 #include <basetsd.h>
  30 #ifndef GUID_DEFINED
  31 #include <guiddef.h>
  32 #endif
  33 #include <rpc.h>
  34 #include <rpcndr.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 typedef struct tagCInterfaceStubVtbl *PCInterfaceStubVtblList;
  41 typedef struct tagCInterfaceProxyVtbl *PCInterfaceProxyVtblList;
  42 typedef const char *PCInterfaceName;
  43 typedef int __stdcall IIDLookupRtn( const IID *pIID, int *pIndex );
  44 typedef IIDLookupRtn *PIIDLookup;
  45
  46 typedef struct tagProxyFileInfo
  47 {
  48   const PCInterfaceProxyVtblList *pProxyVtblList;
  49   const PCInterfaceStubVtblList *pStubVtblList;
  50   const PCInterfaceName *pNamesArray;
  51   const IID **pDelegatedIIDs;
  52   const PIIDLookup pIIDLookupRtn;
  53   unsigned short TableSize;
  54   unsigned short TableVersion;
  55   const IID **pAsyncIIDLookup;
  56   LONG_PTR Filler2;
  57   LONG_PTR Filler3;
  58   LONG_PTR Filler4;
  59 } ProxyFileInfo;
  60
  61 typedef ProxyFileInfo ExtendedProxyFileInfo;
  62
  63 typedef struct tagCInterfaceProxyHeader
  64 {
  65 #ifdef USE_STUBLESS_PROXY
  66   const void *pStublessProxyInfo;
  67 #endif
  68   const IID *piid;
  69 } CInterfaceProxyHeader;
  70
  71 #define CINTERFACE_PROXY_VTABLE(n) \
  72   struct \
  73   { \
  74     CInterfaceProxyHeader header; \
  75     void *Vtbl[n]; \
  76   }
  77
  78 typedef struct tagCInterfaceProxyVtbl
  79 {
  80   CInterfaceProxyHeader header;
  81 #if defined(__GNUC__)
  82   void *Vtbl[0];
  83 #else
  84   void *Vtbl[1];
  85 #endif
  86 } CInterfaceProxyVtbl;
  87
  88 typedef void (__RPC_STUB *PRPC_STUB_FUNCTION)(
  89   IRpcStubBuffer *This,
  90   IRpcChannelBuffer *_pRpcChannelBuffer,
  91   PRPC_MESSAGE _pRpcMessage,
  92   DWORD *pdwStubPhase);
  93
  94 typedef struct tagCInterfaceStubHeader
  95 {
  96   const IID *piid;
  97   const MIDL_SERVER_INFO *pServerInfo;
  98   ULONG DispatchTableCount;
  99   const PRPC_STUB_FUNCTION *pDispatchTable;
 100 } CInterfaceStubHeader;
 101
 102 typedef struct tagCInterfaceStubVtbl
 103 {
 104   CInterfaceStubHeader header;
 105   IRpcStubBufferVtbl Vtbl;
 106 } CInterfaceStubVtbl;
 107
 108 typedef struct tagCStdStubBuffer
 109 {
 110   const IRpcStubBufferVtbl *lpVtbl;
 111   LONG RefCount;
 112   struct IUnknown *pvServerObject;
 113   const struct ICallFactoryVtbl *pCallFactoryVtbl;
 114   const IID *pAsyncIID;
 115   struct IPSFactoryBuffer *pPSFactory;
 116 } CStdStubBuffer;
 117
 118 typedef struct tagCStdPSFactoryBuffer
 119 {
 120   const IPSFactoryBufferVtbl *lpVtbl;
 121   LONG RefCount;
 122   const ProxyFileInfo **pProxyFileList;
 123   LONG Filler1;
 124 } CStdPSFactoryBuffer;
 125
 126 #define STUB_FORWARDING_FUNCTION NdrStubForwardingFunction
 127
 128 #define CStdStubBuffer_DELEGATING_METHODS 0, 0, CStdStubBuffer2_Release, 0, 0, 0, 0, 0, 0, 0
 129
 130 RPCRTAPI HRESULT   WINAPI CStdStubBuffer_QueryInterface( IRpcStubBuffer *This, REFIID riid, void **ppvObject );
 131 RPCRTAPI ULONG     WINAPI CStdStubBuffer_AddRef( IRpcStubBuffer *This );
 132 RPCRTAPI HRESULT   WINAPI CStdStubBuffer_Connect( IRpcStubBuffer *This, IUnknown *pUnkServer );
 133 RPCRTAPI void      WINAPI CStdStubBuffer_Disconnect( IRpcStubBuffer *This );
 134 RPCRTAPI HRESULT   WINAPI CStdStubBuffer_Invoke( IRpcStubBuffer *This, RPCOLEMESSAGE *pRpcMsg, IRpcChannelBuffer *pRpcChannelBuffer );
 135 RPCRTAPI IRpcStubBuffer * WINAPI CStdStubBuffer_IsIIDSupported( IRpcStubBuffer *This, REFIID riid );
 136 RPCRTAPI ULONG     WINAPI CStdStubBuffer_CountRefs( IRpcStubBuffer *This );
 137 RPCRTAPI HRESULT   WINAPI CStdStubBuffer_DebugServerQueryInterface( IRpcStubBuffer *This, void **ppv );
 138 RPCRTAPI void      WINAPI CStdStubBuffer_DebugServerRelease( IRpcStubBuffer *This, void *pv );
 139 RPCRTAPI ULONG     WINAPI NdrCStdStubBuffer_Release( IRpcStubBuffer *This, IPSFactoryBuffer *pPSF );
 140 RPCRTAPI ULONG     WINAPI NdrCStdStubBuffer2_Release(IRpcStubBuffer *This, IPSFactoryBuffer *pPSF);
 141
 142 ULONG STDMETHODCALLTYPE CStdStubBuffer_Release( IRpcStubBuffer *This );
 143 ULONG STDMETHODCALLTYPE CStdStubBuffer2_Release(IRpcStubBuffer *This);
 144
 145 #define CStdStubBuffer_METHODS \
 146   CStdStubBuffer_QueryInterface, \
 147   CStdStubBuffer_AddRef, \
 148   CStdStubBuffer_Release, \
 149   CStdStubBuffer_Connect, \
 150   CStdStubBuffer_Disconnect, \
 151   CStdStubBuffer_Invoke, \
 152   CStdStubBuffer_IsIIDSupported, \
 153   CStdStubBuffer_CountRefs, \
 154   CStdStubBuffer_DebugServerQueryInterface, \
 155   CStdStubBuffer_DebugServerRelease
 156
 157 RPCRTAPI void RPC_ENTRY
 158   NdrProxyInitialize( void *This, PRPC_MESSAGE pRpcMsg, PMIDL_STUB_MESSAGE pStubMsg,
 159                       PMIDL_STUB_DESC pStubDescriptor, unsigned int ProcNum );
 160 RPCRTAPI void RPC_ENTRY
 161   NdrProxyGetBuffer( void *This, PMIDL_STUB_MESSAGE pStubMsg );
 162 RPCRTAPI void RPC_ENTRY
 163   NdrProxySendReceive( void *This, PMIDL_STUB_MESSAGE pStubMsg );
 164 RPCRTAPI void RPC_ENTRY
 165   NdrProxyFreeBuffer( void *This, PMIDL_STUB_MESSAGE pStubMsg );
 166 RPCRTAPI HRESULT RPC_ENTRY
 167   NdrProxyErrorHandler( DWORD dwExceptionCode );
 168
 169 RPCRTAPI void RPC_ENTRY
 170   NdrStubInitialize( PRPC_MESSAGE pRpcMsg, PMIDL_STUB_MESSAGE pStubMsg,
 171                      PMIDL_STUB_DESC pStubDescriptor, IRpcChannelBuffer *pRpcChannelBuffer );
 172 RPCRTAPI void RPC_ENTRY
 173   NdrStubInitializePartial( PRPC_MESSAGE pRpcMsg, PMIDL_STUB_MESSAGE pStubMsg,
 174                             PMIDL_STUB_DESC pStubDescriptor, IRpcChannelBuffer *pRpcChannelBuffer,
 175                             ULONG RequestedBufferSize );
 176 void __RPC_STUB NdrStubForwardingFunction( IRpcStubBuffer *This, IRpcChannelBuffer *pChannel,
 177                                            PRPC_MESSAGE pMsg, DWORD *pdwStubPhase );
 178 RPCRTAPI void RPC_ENTRY
 179   NdrStubGetBuffer( IRpcStubBuffer *This, IRpcChannelBuffer *pRpcChannelBuffer, PMIDL_STUB_MESSAGE pStubMsg );
 180 RPCRTAPI HRESULT RPC_ENTRY
 181   NdrStubErrorHandler( DWORD dwExceptionCode );
 182
 183 RPCRTAPI HRESULT RPC_ENTRY
 184   NdrDllGetClassObject( REFCLSID rclsid, REFIID riid, void **ppv, const ProxyFileInfo **pProxyFileList,
 185                         const CLSID *pclsid, CStdPSFactoryBuffer *pPSFactoryBuffer );
 186 RPCRTAPI HRESULT RPC_ENTRY
 187   NdrDllCanUnloadNow( CStdPSFactoryBuffer *pPSFactoryBuffer );
 188
 189 RPCRTAPI HRESULT RPC_ENTRY
 190   NdrDllRegisterProxy( HMODULE hDll, const ProxyFileInfo **pProxyFileList, const CLSID *pclsid );
 191 RPCRTAPI HRESULT RPC_ENTRY
 192   NdrDllUnregisterProxy( HMODULE hDll, const ProxyFileInfo **pProxyFileList, const CLSID *pclsid );
 193
 194 HRESULT __cdecl __wine_register_resources(void);
 195 HRESULT __cdecl __wine_unregister_resources(void);
 196
 197 #define CSTDSTUBBUFFERRELEASE(pFactory) \
 198 ULONG WINAPI CStdStubBuffer_Release(IRpcStubBuffer *This) \
 199   { return NdrCStdStubBuffer_Release(This, (IPSFactoryBuffer *)pFactory); }
 200
 201 #ifdef PROXY_DELEGATION
 202 #define CSTDSTUBBUFFER2RELEASE(pFactory) \
 203 ULONG WINAPI CStdStubBuffer2_Release(IRpcStubBuffer *This) \
 204   { return NdrCStdStubBuffer2_Release(This, (IPSFactoryBuffer *)pFactory); }
 205 #else
 206 #define CSTDSTUBBUFFER2RELEASE(pFactory)
 207 #endif
 208
 209 #define IID_GENERIC_CHECK_IID(name,pIID,index) memcmp(pIID, name##_ProxyVtblList[index]->header.piid, sizeof(IID))
 210
 211 /*
 212  * In these macros, BS stands for Binary Search. MIDL uses these to
 213  * "unroll" a binary search into the module's IID_Lookup function.
 214  * However, I haven't bothered to reimplement that stuff yet;
 215  * I've just implemented a linear search for now.
 216  */
 217 #define IID_BS_LOOKUP_SETUP \
 218   int c;
 219 #define IID_BS_LOOKUP_INITIAL_TEST(name, sz, split)
 220 #define IID_BS_LOOKUP_NEXT_TEST(name, split)
 221 #define IID_BS_LOOKUP_RETURN_RESULT(name, sz, index) \
 222   for (c=0; c<sz; c++) if (!name##_CHECK_IID(c)) { (index)=c; return 1; } \
 223   return 0;
 224
 225 /* macros used in dlldata.c files */
 226 #define EXTERN_PROXY_FILE(proxy) \
 227     EXTERN_C const ProxyFileInfo proxy##_ProxyFileInfo;
 228
 229 #define PROXYFILE_LIST_START \
 230     const ProxyFileInfo * aProxyFileList[] = \
 231     {
 232
 233 #define REFERENCE_PROXY_FILE(proxy) \
 234         & proxy##_ProxyFileInfo
 235
 236 #define PROXYFILE_LIST_END \
 237         NULL \
 238     };
 239
 240
 241 /* define PROXY_CLSID to use an existing CLSID */
 242 /* define PROXY_CLSID_IS to specify the CLSID data of the PSFactoryBuffer */
 243 /* define neither to use the GUID of the first interface */
 244 #ifdef PROXY_CLSID
 245 # define CLSID_PSFACTORYBUFFER extern CLSID PROXY_CLSID;
 246 #else
 247 # ifdef PROXY_CLSID_IS
 248 #  define CLSID_PSFACTORYBUFFER const CLSID CLSID_PSFactoryBuffer = PROXY_CLSID_IS;
 249 #  define PROXY_CLSID CLSID_PSFactoryBuffer
 250 # else
 251 #  define CLSID_PSFACTORYBUFFER
 252 # endif
 253 #endif
 254
 255 #ifndef PROXY_CLSID
 256 # define GET_DLL_CLSID (aProxyFileList[0]->pStubVtblList[0] ? \
 257     aProxyFileList[0]->pStubVtblList[0]->header.piid : NULL)
 258 #else
 259 # define GET_DLL_CLSID &PROXY_CLSID
 260 #endif
 261
 262 #ifdef ENTRY_PREFIX
 263 # define __rpc_macro_expand2(a, b) a##b
 264 # define __rpc_macro_expand(a, b) __rpc_macro_expand2(a, b)
 265 # define DLLREGISTERSERVER_ENTRY __rpc_macro_expand(ENTRY_PREFIX, DllRegisterServer)
 266 # define DLLUNREGISTERSERVER_ENTRY __rpc_macro_expand(ENTRY_PREFIX, DllUnregisterServer)
 267 # define DLLMAIN_ENTRY __rpc_macro_expand(ENTRY_PREFIX, DllMain)
 268 # define DLLGETCLASSOBJECT_ENTRY __rpc_macro_expand(ENTRY_PREFIX, DllGetClassObject)
 269 # define DLLCANUNLOADNOW_ENTRY __rpc_macro_expand(ENTRY_PREFIX, DllCanUnloadNow)
 270 #else
 271 # define DLLREGISTERSERVER_ENTRY DllRegisterServer
 272 # define DLLUNREGISTERSERVER_ENTRY DllUnregisterServer
 273 # define DLLMAIN_ENTRY DllMain
 274 # define DLLGETCLASSOBJECT_ENTRY DllGetClassObject
 275 # define DLLCANUNLOADNOW_ENTRY DllCanUnloadNow
 276 #endif
 277
 278 #ifdef WINE_REGISTER_DLL
 279 # define WINE_DO_REGISTER_DLL(pfl, clsid) return __wine_register_resources()
 280 # define WINE_DO_UNREGISTER_DLL(pfl, clsid) return __wine_unregister_resources()
 281 #else
 282 # define WINE_DO_REGISTER_DLL(pfl, clsid)   return NdrDllRegisterProxy( hProxyDll, (pfl), (clsid) )
 283 # define WINE_DO_UNREGISTER_DLL(pfl, clsid) return NdrDllUnregisterProxy( hProxyDll, (pfl), (clsid) )
 284 #endif
 285
 286
 287 #define DLLDATA_GETPROXYDLLINFO(pfl, rclsid) \
 288     void RPC_ENTRY GetProxyDllInfo(const ProxyFileInfo ***ppProxyFileInfo, \
 289                                    const CLSID **ppClsid); \
 290     void RPC_ENTRY GetProxyDllInfo(const ProxyFileInfo ***ppProxyFileInfo, \
 291                                    const CLSID **ppClsid) \
 292     { \
 293         *ppProxyFileInfo = (pfl); \
 294         *ppClsid = (rclsid); \
 295     }
 296
 297 #define DLLGETCLASSOBJECTROUTINE(pfl, factory_clsid, factory) \
 298     HRESULT WINAPI DLLGETCLASSOBJECT_ENTRY(REFCLSID rclsid, REFIID riid, void **ppv); \
 299     HRESULT WINAPI DLLGETCLASSOBJECT_ENTRY(REFCLSID rclsid, REFIID riid, \
 300                                            void **ppv) \
 301     { \
 302         return NdrDllGetClassObject(rclsid, riid, ppv, (pfl), \
 303                                     (factory_clsid), factory); \
 304     }
 305
 306 #define DLLCANUNLOADNOW(factory) \
 307     HRESULT WINAPI DLLCANUNLOADNOW_ENTRY(void); \
 308     HRESULT WINAPI DLLCANUNLOADNOW_ENTRY(void) \
 309     { \
 310         return NdrDllCanUnloadNow((factory)); \
 311     }
 312
 313 #define REGISTER_PROXY_DLL_ROUTINES(pfl, factory_clsid) \
 314     HINSTANCE hProxyDll = NULL; \
 315     \
 316     BOOL WINAPI DLLMAIN_ENTRY(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved); \
 317     BOOL WINAPI DLLMAIN_ENTRY(HINSTANCE hinstDLL, DWORD fdwReason, \
 318                               LPVOID lpvReserved) \
 319     { \
 320         if (fdwReason == DLL_PROCESS_ATTACH) \
 321         { \
 322             DisableThreadLibraryCalls(hinstDLL); \
 323             hProxyDll = hinstDLL; \
 324         } \
 325         return TRUE; \
 326     } \
 327     \
 328     HRESULT WINAPI DLLREGISTERSERVER_ENTRY(void); \
 329     HRESULT WINAPI DLLREGISTERSERVER_ENTRY(void) \
 330     { \
 331         WINE_DO_REGISTER_DLL( (pfl), (factory_clsid) ); \
 332     } \
 333     \
 334     HRESULT WINAPI DLLUNREGISTERSERVER_ENTRY(void); \
 335     HRESULT WINAPI DLLUNREGISTERSERVER_ENTRY(void) \
 336     { \
 337         WINE_DO_UNREGISTER_DLL( (pfl), (factory_clsid) ); \
 338     }
 339
 340 #if defined(REGISTER_PROXY_DLL) || defined(WINE_REGISTER_DLL)
 341 # define DLLREGISTRY_ROUTINES(pfl, factory_clsid) \
 342     REGISTER_PROXY_DLL_ROUTINES(pfl, factory_clsid)
 343 #else
 344 # define DLLREGISTRY_ROUTINES(pfl, factory_clsid)
 345 #endif
 346
 347 #define DLLDATA_ROUTINES(pfl, factory_clsid) \
 348     CLSID_PSFACTORYBUFFER \
 349     CStdPSFactoryBuffer gPFactory = { NULL, 0, NULL, 0 }; \
 350     DLLDATA_GETPROXYDLLINFO(pfl, factory_clsid) \
 351     DLLGETCLASSOBJECTROUTINE(pfl, factory_clsid, &gPFactory) \
 352     DLLCANUNLOADNOW(&gPFactory) \
 353     CSTDSTUBBUFFERRELEASE(&gPFactory) \
 354     CSTDSTUBBUFFER2RELEASE(&gPFactory) \
 355     DLLREGISTRY_ROUTINES(pfl, factory_clsid)
 356
 357 #if 0
 358
 359 RPCRTAPI HRESULT RPC_ENTRY
 360   CreateProxyFromTypeInfo( LPTYPEINFO pTypeInfo, LPUNKNOWN pUnkOuter, REFIID riid,
 361                            LPRPCPROXYBUFFER *ppProxy, LPVOID *ppv );
 362 RPCRTAPI HRESULT RPC_ENTRY
 363   CreateStubFromTypeInfo( LPTYPEINFO pTypeInfo, REFIID riid, LPUNKNOWN pUnkServer,
 364                           LPRPCSTUBBUFFER *ppStub );
 365
 366 #endif
 367
 368 #ifdef __cplusplus
 369 }
 370 #endif
 371
 372 #endif /*__WINE_RPCPROXY_H */