dlls/rpcrt4/ndr_contexthandle.c

   1 /*
   2  * NDR data marshalling
   3  *
   4  * Copyright 2006 Mike McCormack (for CodeWeavers)
   5  * Copyright 2006-2007 Robert Shearman (for CodeWeavers)
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  */
  21
  22 #include "ndr_misc.h"
  23 #include "rpc_assoc.h"
  24 #include "rpcndr.h"
  25 #include "cguid.h"
  26
  27 #include "wine/debug.h"
  28 #include "wine/list.h"
  29
  30 WINE_DEFAULT_DEBUG_CHANNEL(ole);
  31
  32 #define NDR_CONTEXT_HANDLE_MAGIC 0x4352444e
  33
  34 typedef struct ndr_context_handle
  35 {
  36     ULONG      attributes;
  37     GUID       uuid;
  38 } ndr_context_handle;
  39
  40 struct context_handle_entry
  41 {
  42     struct list entry;
  43     DWORD magic;
  44     RPC_BINDING_HANDLE handle;
  45     ndr_context_handle wire_data;
  46 };
  47
  48 static struct list context_handle_list = LIST_INIT(context_handle_list);
  49
  50 static CRITICAL_SECTION ndr_context_cs;
  51 static CRITICAL_SECTION_DEBUG ndr_context_debug =
  52 {
  53     0, 0, &ndr_context_cs,
  54     { &ndr_context_debug.ProcessLocksList, &ndr_context_debug.ProcessLocksList },
  55       0, 0, { (DWORD_PTR)(__FILE__ ": ndr_context") }
  56 };
  57 static CRITICAL_SECTION ndr_context_cs = { &ndr_context_debug, -1, 0, 0, 0, 0 };
  58
  59 static struct context_handle_entry *get_context_entry(NDR_CCONTEXT CContext)
  60 {
  61     struct context_handle_entry *che = CContext;
  62
  63     if (che->magic != NDR_CONTEXT_HANDLE_MAGIC)
  64         return NULL;
  65     return che;
  66 }
  67
  68 static struct context_handle_entry *context_entry_from_guid(LPCGUID uuid)
  69 {
  70     struct context_handle_entry *che;
  71     LIST_FOR_EACH_ENTRY(che, &context_handle_list, struct context_handle_entry, entry)
  72         if (IsEqualGUID(&che->wire_data.uuid, uuid))
  73             return che;
  74     return NULL;
  75 }
  76
  77 RPC_BINDING_HANDLE WINAPI NDRCContextBinding(NDR_CCONTEXT CContext)
  78 {
  79     struct context_handle_entry *che;
  80     RPC_BINDING_HANDLE handle = NULL;
  81
  82     TRACE("%p\n", CContext);
  83
  84     EnterCriticalSection(&ndr_context_cs);
  85     che = get_context_entry(CContext);
  86     if (che)
  87         handle = che->handle;
  88     LeaveCriticalSection(&ndr_context_cs);
  89
  90     if (!handle)
  91     {
  92         ERR("invalid handle %p\n", CContext);
  93         RpcRaiseException(RPC_X_SS_CONTEXT_MISMATCH);
  94     }
  95     return handle;
  96 }
  97
  98 void WINAPI NDRCContextMarshall(NDR_CCONTEXT CContext, void *pBuff)
  99 {
 100     struct context_handle_entry *che;
 101
 102     TRACE("%p %p\n", CContext, pBuff);
 103
 104     if (CContext)
 105     {
 106         EnterCriticalSection(&ndr_context_cs);
 107         che = get_context_entry(CContext);
 108         memcpy(pBuff, &che->wire_data, sizeof (ndr_context_handle));
 109         LeaveCriticalSection(&ndr_context_cs);
 110     }
 111     else
 112     {
 113         ndr_context_handle *wire_data = pBuff;
 114         wire_data->attributes = 0;
 115         wire_data->uuid = GUID_NULL;
 116     }
 117 }
 118
 119 /***********************************************************************
 120  *           RpcSmDestroyClientContext [RPCRT4.@]
 121  */
 122 RPC_STATUS WINAPI RpcSmDestroyClientContext(void **ContextHandle)
 123 {
 124     RPC_STATUS status = RPC_X_SS_CONTEXT_MISMATCH;
 125     struct context_handle_entry *che = NULL;
 126
 127     TRACE("(%p)\n", ContextHandle);
 128
 129     EnterCriticalSection(&ndr_context_cs);
 130     che = get_context_entry(*ContextHandle);
 131     *ContextHandle = NULL;
 132     if (che)
 133     {
 134         status = RPC_S_OK;
 135         list_remove(&che->entry);
 136     }
 137
 138     LeaveCriticalSection(&ndr_context_cs);
 139
 140     if (che)
 141     {
 142         RpcBindingFree(&che->handle);
 143         HeapFree(GetProcessHeap(), 0, che);
 144     }
 145
 146     return status;
 147 }
 148
 149 /***********************************************************************
 150  *           RpcSsDestroyClientContext [RPCRT4.@]
 151  */
 152 void WINAPI RpcSsDestroyClientContext(void **ContextHandle)
 153 {
 154     RPC_STATUS status = RpcSmDestroyClientContext(ContextHandle);
 155     if (status != RPC_S_OK)
 156         RpcRaiseException(status);
 157 }
 158
 159 /***********************************************************************
 160  *           RpcSsDontSerializeContext [RPCRT4.@]
 161  */
 162  void WINAPI RpcSsDontSerializeContext(void)
 163 {
 164     FIXME("stub\n");
 165 }
 166
 167 static RPC_STATUS ndr_update_context_handle(NDR_CCONTEXT *CContext,
 168                                       RPC_BINDING_HANDLE hBinding,
 169                                       const ndr_context_handle *chi)
 170 {
 171     struct context_handle_entry *che = NULL;
 172
 173     /* a null UUID means we should free the context handle */
 174     if (IsEqualGUID(&chi->uuid, &GUID_NULL))
 175     {
 176         if (*CContext)
 177         {
 178             che = get_context_entry(*CContext);
 179             if (!che)
 180                 return RPC_X_SS_CONTEXT_MISMATCH;
 181             list_remove(&che->entry);
 182             RpcBindingFree(&che->handle);
 183             HeapFree(GetProcessHeap(), 0, che);
 184             che = NULL;
 185         }
 186     }
 187     /* if there's no existing entry matching the GUID, allocate one */
 188     else if (!(che = context_entry_from_guid(&chi->uuid)))
 189     {
 190         che = HeapAlloc(GetProcessHeap(), 0, sizeof *che);
 191         if (!che)
 192             return RPC_X_NO_MEMORY;
 193         che->magic = NDR_CONTEXT_HANDLE_MAGIC;
 194         RpcBindingCopy(hBinding, &che->handle);
 195         list_add_tail(&context_handle_list, &che->entry);
 196         che->wire_data = *chi;
 197     }
 198
 199     *CContext = che;
 200
 201     return RPC_S_OK;
 202 }
 203
 204 /***********************************************************************
 205  *           NDRCContextUnmarshall [RPCRT4.@]
 206  */
 207 void WINAPI NDRCContextUnmarshall(NDR_CCONTEXT *CContext,
 208                                   RPC_BINDING_HANDLE hBinding,
 209                                   void *pBuff, ULONG DataRepresentation)
 210 {
 211     RPC_STATUS status;
 212
 213     TRACE("*%p=(%p) %p %p %08x\n",
 214           CContext, *CContext, hBinding, pBuff, DataRepresentation);
 215
 216     EnterCriticalSection(&ndr_context_cs);
 217     status = ndr_update_context_handle(CContext, hBinding, pBuff);
 218     LeaveCriticalSection(&ndr_context_cs);
 219     if (status)
 220         RpcRaiseException(status);
 221 }
 222
 223 /***********************************************************************
 224  *           NDRSContextMarshall [RPCRT4.@]
 225  */
 226 void WINAPI NDRSContextMarshall(NDR_SCONTEXT SContext,
 227                                void *pBuff,
 228                                NDR_RUNDOWN userRunDownIn)
 229 {
 230     TRACE("(%p %p %p)\n", SContext, pBuff, userRunDownIn);
 231     NDRSContextMarshall2(I_RpcGetCurrentCallHandle(), SContext, pBuff,
 232                          userRunDownIn, NULL, RPC_CONTEXT_HANDLE_DEFAULT_FLAGS);
 233 }
 234
 235 /***********************************************************************
 236  *           NDRSContextMarshallEx [RPCRT4.@]
 237  */
 238 void WINAPI NDRSContextMarshallEx(RPC_BINDING_HANDLE hBinding,
 239                                   NDR_SCONTEXT SContext,
 240                                   void *pBuff,
 241                                   NDR_RUNDOWN userRunDownIn)
 242 {
 243     TRACE("(%p %p %p %p)\n", hBinding, SContext, pBuff, userRunDownIn);
 244     NDRSContextMarshall2(hBinding, SContext, pBuff, userRunDownIn, NULL,
 245                          RPC_CONTEXT_HANDLE_DEFAULT_FLAGS);
 246 }
 247
 248 /***********************************************************************
 249  *           NDRSContextMarshall2 [RPCRT4.@]
 250  */
 251 void WINAPI NDRSContextMarshall2(RPC_BINDING_HANDLE hBinding,
 252                                  NDR_SCONTEXT SContext,
 253                                  void *pBuff,
 254                                  NDR_RUNDOWN userRunDownIn,
 255                                  void *CtxGuard, ULONG Flags)
 256 {
 257     RpcBinding *binding = hBinding;
 258     RPC_STATUS status;
 259     ndr_context_handle *ndr = pBuff;
 260
 261     TRACE("(%p %p %p %p %p %u)\n",
 262           hBinding, SContext, pBuff, userRunDownIn, CtxGuard, Flags);
 263
 264     if (!binding->server || !binding->Assoc)
 265         RpcRaiseException(RPC_S_INVALID_BINDING);
 266
 267     if (SContext->userContext)
 268     {
 269         status = RpcServerAssoc_UpdateContextHandle(binding->Assoc, SContext, CtxGuard, userRunDownIn);
 270         if (status != RPC_S_OK)
 271             RpcRaiseException(status);
 272         ndr->attributes = 0;
 273         RpcContextHandle_GetUuid(SContext, &ndr->uuid);
 274
 275         RPCRT4_RemoveThreadContextHandle(SContext);
 276         RpcServerAssoc_ReleaseContextHandle(binding->Assoc, SContext, TRUE);
 277     }
 278     else
 279     {
 280         if (!RpcContextHandle_IsGuardCorrect(SContext, CtxGuard))
 281             RpcRaiseException(RPC_X_SS_CONTEXT_MISMATCH);
 282         memset(ndr, 0, sizeof(*ndr));
 283
 284         RPCRT4_RemoveThreadContextHandle(SContext);
 285         /* Note: release the context handle twice in this case to release
 286          * one ref being kept around for the data and one ref for the
 287          * unmarshall/marshall sequence */
 288         if (!RpcServerAssoc_ReleaseContextHandle(binding->Assoc, SContext, TRUE))
 289             return; /* this is to cope with the case of the data not being valid
 290                      * before and so not having a further reference */
 291         RpcServerAssoc_ReleaseContextHandle(binding->Assoc, SContext, FALSE);
 292     }
 293 }
 294
 295 /***********************************************************************
 296  *           NDRSContextUnmarshall [RPCRT4.@]
 297  */
 298 NDR_SCONTEXT WINAPI NDRSContextUnmarshall(void *pBuff,
 299                                           ULONG DataRepresentation)
 300 {
 301     TRACE("(%p %08x)\n", pBuff, DataRepresentation);
 302     return NDRSContextUnmarshall2(I_RpcGetCurrentCallHandle(), pBuff,
 303                                   DataRepresentation, NULL,
 304                                   RPC_CONTEXT_HANDLE_DEFAULT_FLAGS);
 305 }
 306
 307 /***********************************************************************
 308  *           NDRSContextUnmarshallEx [RPCRT4.@]
 309  */
 310 NDR_SCONTEXT WINAPI NDRSContextUnmarshallEx(RPC_BINDING_HANDLE hBinding,
 311                                             void *pBuff,
 312                                             ULONG DataRepresentation)
 313 {
 314     TRACE("(%p %p %08x)\n", hBinding, pBuff, DataRepresentation);
 315     return NDRSContextUnmarshall2(hBinding, pBuff, DataRepresentation, NULL,
 316                                   RPC_CONTEXT_HANDLE_DEFAULT_FLAGS);
 317 }
 318
 319 /***********************************************************************
 320  *           NDRSContextUnmarshall2 [RPCRT4.@]
 321  */
 322 NDR_SCONTEXT WINAPI NDRSContextUnmarshall2(RPC_BINDING_HANDLE hBinding,
 323                                            void *pBuff,
 324                                            ULONG DataRepresentation,
 325                                            void *CtxGuard, ULONG Flags)
 326 {
 327     RpcBinding *binding = hBinding;
 328     NDR_SCONTEXT SContext;
 329     RPC_STATUS status;
 330     const ndr_context_handle *context_ndr = pBuff;
 331
 332     TRACE("(%p %p %08x %p %u)\n",
 333           hBinding, pBuff, DataRepresentation, CtxGuard, Flags);
 334
 335     if (!binding->server || !binding->Assoc)
 336         RpcRaiseException(RPC_S_INVALID_BINDING);
 337
 338     if (!pBuff || (!context_ndr->attributes &&
 339                    UuidIsNil((UUID *)&context_ndr->uuid, &status)))
 340         status = RpcServerAssoc_AllocateContextHandle(binding->Assoc, CtxGuard,
 341                                                       &SContext);
 342     else
 343     {
 344         if (context_ndr->attributes)
 345         {
 346             ERR("non-null attributes 0x%x\n", context_ndr->attributes);
 347             status = RPC_X_SS_CONTEXT_MISMATCH;
 348         }
 349         else
 350             status = RpcServerAssoc_FindContextHandle(binding->Assoc,
 351                                                       &context_ndr->uuid,
 352                                                       CtxGuard, Flags,
 353                                                       &SContext);
 354     }
 355
 356     if (status != RPC_S_OK)
 357         RpcRaiseException(status);
 358
 359     RPCRT4_PushThreadContextHandle(SContext);
 360     return SContext;
 361 }