mcs/class/corlib/System.Runtime.Remoting.Proxies/RealProxy.cs

   1 //
   2 // System.Runtime.Remoting.Proxies.RealProxy.cs
   3 //
   4 // Authors:
   5 //   Dietmar Maurer (dietmar@ximian.com)
   6 //   Lluis Sanchez (lsg@ctv.es)
   7 //   Patrik Torstensson
   8 //
   9 // (C) 2001 Ximian, Inc.  http://www.ximian.com
  10 //
  11
  12 //
  13 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
  14 //
  15 // Permission is hereby granted, free of charge, to any person obtaining
  16 // a copy of this software and associated documentation files (the
  17 // "Software"), to deal in the Software without restriction, including
  18 // without limitation the rights to use, copy, modify, merge, publish,
  19 // distribute, sublicense, and/or sell copies of the Software, and to
  20 // permit persons to whom the Software is furnished to do so, subject to
  21 // the following conditions:
  22 //
  23 // The above copyright notice and this permission notice shall be
  24 // included in all copies or substantial portions of the Software.
  25 //
  26 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  27 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  28 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  29 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  30 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  31 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  32 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  33 //
  34
  35 using System;
  36 using System.Reflection;
  37 using System.Runtime.Remoting;
  38 using System.Runtime.Remoting.Messaging;
  39 using System.Runtime.Remoting.Activation;
  40 using System.Runtime.Remoting.Contexts;
  41 using System.Runtime.CompilerServices;
  42 using System.Runtime.Serialization;
  43 using System.Runtime.InteropServices;
  44 using System.Threading;
  45
  46 namespace System.Runtime.Remoting.Proxies
  47 {
  48 #pragma warning disable 169, 649
  49         [StructLayout (LayoutKind.Sequential)]
  50         internal class TransparentProxy {
  51                 public RealProxy _rp;
  52                 IntPtr _class;
  53                 bool _custom_type_info;
  54         }
  55 #pragma warning restore 169, 649
  56
  57         [ComVisible (true)]
  58         [StructLayout (LayoutKind.Sequential)]
  59         public abstract class RealProxy {
  60                 // other classes visible to the runtime
  61                 // derive from this class so keep these locals
  62                 // in sync with the definition RealProxy
  63                 // in object-internals.h
  64
  65 #pragma warning disable 169, 414
  66                 #region Sync with object-internals.h
  67                 Type class_to_proxy;
  68                 internal Context _targetContext;
  69                 MarshalByRefObject _server;
  70                 int _targetDomainId = -1;
  71                 internal string _targetUri;
  72                 internal Identity _objectIdentity;
  73                 Object _objTP;
  74                 object _stubData;
  75         #endregion
  76 #pragma warning restore 169, 414
  77
  78                 protected RealProxy ()
  79                 {
  80                 }
  81
  82                 protected RealProxy (Type classToProxy) : this(classToProxy, IntPtr.Zero, null)
  83                 {
  84                 }
  85
  86                 internal RealProxy (Type classToProxy, ClientIdentity identity) : this(classToProxy, IntPtr.Zero, null)
  87                 {
  88                         _objectIdentity = identity;
  89                 }
  90
  91                 protected RealProxy (Type classToProxy, IntPtr stub, object stubData)
  92                 {
  93                         if (!classToProxy.IsMarshalByRef && !classToProxy.IsInterface)
  94                                 throw new ArgumentException("object must be MarshalByRef");
  95
  96                         this.class_to_proxy = classToProxy;
  97
  98                         if (stub != IntPtr.Zero)
  99                                 throw new NotSupportedException ("stub is not used in Mono");
 100                 }
 101
 102                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
 103                 extern static Type InternalGetProxyType (object transparentProxy);
 104
 105                 public Type GetProxiedType()
 106                 {
 107                         if (_objTP == null) {
 108                                 if (class_to_proxy.IsInterface) return typeof(MarshalByRefObject);
 109                                 else return class_to_proxy;
 110                         }
 111                         return InternalGetProxyType (_objTP);
 112                 }
 113
 114                 public virtual ObjRef CreateObjRef (Type requestedType)
 115                 {
 116                         return RemotingServices.Marshal ((MarshalByRefObject) GetTransparentProxy(), null, requestedType);
 117                 }
 118
 119                 public virtual void GetObjectData (SerializationInfo info, StreamingContext context)
 120                 {
 121                         Object obj = GetTransparentProxy();
 122                         RemotingServices.GetObjectData (obj, info, context);
 123                 }
 124
 125                 internal Identity ObjectIdentity
 126                 {
 127                         get { return _objectIdentity; }
 128                         set { _objectIdentity = value; }
 129                 }
 130
 131                 [MonoTODO]
 132                 public virtual IntPtr GetCOMIUnknown (bool fIsMarshalled)
 133                 {
 134                         throw new NotImplementedException ();
 135                 }
 136
 137                 [MonoTODO]
 138                 public virtual void SetCOMIUnknown (IntPtr i)
 139                 {
 140                         throw new NotImplementedException ();
 141                 }
 142
 143                 [MonoTODO]
 144                 public virtual IntPtr SupportsInterface (ref Guid iid)
 145                 {
 146                         throw new NotImplementedException ();
 147                 }
 148
 149                 public static object GetStubData (RealProxy rp)
 150                 {
 151                         return rp._stubData;
 152                 }
 153
 154                 public static void SetStubData (RealProxy rp, object stubData)
 155                 {
 156                         rp._stubData = stubData;
 157                 }
 158
 159                 public abstract IMessage Invoke (IMessage msg);
 160
 161                 /* this is called from unmanaged code */
 162                 internal static object PrivateInvoke (RealProxy rp, IMessage msg, out Exception exc,
 163                                                       out object [] out_args)
 164                 {
 165                         MonoMethodMessage mMsg = (MonoMethodMessage) msg;
 166                         mMsg.LogicalCallContext = Thread.CurrentThread.GetMutableExecutionContext().LogicalCallContext;
 167                         CallType call_type = mMsg.CallType;
 168                         bool is_remproxy = (rp is RemotingProxy);
 169
 170                         out_args = null;
 171                         IMethodReturnMessage res_msg = null;
 172
 173                         if (call_type == CallType.BeginInvoke)
 174                                 // todo: set CallMessage in runtime instead
 175                                 mMsg.AsyncResult.CallMessage = mMsg;
 176
 177                         if (call_type == CallType.EndInvoke)
 178                                 res_msg = (IMethodReturnMessage)mMsg.AsyncResult.EndInvoke ();
 179
 180                         // Check for constructor msg
 181                         if (mMsg.MethodBase.IsConstructor)
 182                         {
 183                                 if (is_remproxy)
 184                                         res_msg = (IMethodReturnMessage) (rp as RemotingProxy).ActivateRemoteObject ((IMethodMessage) msg);
 185                                 else
 186                                         msg = new ConstructionCall (rp.GetProxiedType ());
 187                         }
 188
 189                         if (null == res_msg)
 190                         {
 191                                 bool failed = false;
 192
 193                                 try {
 194                                         res_msg = (IMethodReturnMessage)rp.Invoke (msg);
 195                                 } catch (Exception ex) {
 196                                         failed = true;
 197                                         if (call_type == CallType.BeginInvoke) {
 198                                                 // If async dispatch crashes, don't propagate the exception.
 199                                                 // The exception will be raised when calling EndInvoke.
 200                                                 mMsg.AsyncResult.SyncProcessMessage (new ReturnMessage (ex, msg as IMethodCallMessage));
 201                                                 res_msg = new ReturnMessage (null, null, 0, null, msg as IMethodCallMessage);
 202                                         } else
 203                                                 throw;
 204                                 }
 205
 206                                 // Note, from begining this code used AsyncResult.IsCompleted for
 207                                 // checking if it was a remoting or custom proxy, but in some
 208                                 // cases the remoting proxy finish before the call returns
 209                                 // causing this method to be called, therefore causing all kind of bugs.
 210                                 if ((!is_remproxy) && call_type == CallType.BeginInvoke && !failed)
 211                                 {
 212                                         IMessage asyncMsg = null;
 213
 214                                         // allow calltype EndInvoke to finish
 215                                         asyncMsg = mMsg.AsyncResult.SyncProcessMessage (res_msg as IMessage);
 216                                         out_args = res_msg.OutArgs;
 217                                         res_msg = new ReturnMessage (asyncMsg, null, 0, null, res_msg as IMethodCallMessage);
 218                                 }
 219                         }
 220
 221                         if (res_msg.LogicalCallContext != null && res_msg.LogicalCallContext.HasInfo) {
 222                                 Thread.CurrentThread.GetMutableExecutionContext().LogicalCallContext.Merge (res_msg.LogicalCallContext);
 223                         }
 224
 225                         exc = res_msg.Exception;
 226
 227                         // todo: remove throw exception from the runtime invoke
 228                         if (null != exc) {
 229                                 out_args = null;
 230                                 throw exc.FixRemotingException();
 231                         }
 232                         else if (res_msg is IConstructionReturnMessage) {
 233                                 if (out_args == null)
 234                                         out_args = res_msg.OutArgs;
 235                         }
 236                         else if (mMsg.CallType == CallType.BeginInvoke) {
 237                                 // We don't have OutArgs in this case.
 238                         }
 239                         else if (mMsg.CallType == CallType.Sync) {
 240                                 out_args = ProcessResponse (res_msg, mMsg);
 241                         }
 242                         else if (mMsg.CallType == CallType.EndInvoke) {
 243                                 out_args = ProcessResponse (res_msg, mMsg.AsyncResult.CallMessage);
 244                         }
 245                         else {
 246                                 if (out_args == null)
 247                                         out_args = res_msg.OutArgs;
 248                         }
 249
 250                         return res_msg.ReturnValue;
 251                 }
 252
 253                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
 254                 internal extern virtual object InternalGetTransparentProxy (string className);
 255
 256                 public virtual object GetTransparentProxy ()
 257                 {
 258                         if (_objTP == null)
 259                         {
 260                                 string name;
 261                                 IRemotingTypeInfo rti = this as IRemotingTypeInfo;
 262
 263                                 if (rti != null) {
 264                                         name = rti.TypeName;
 265                                         if (name == null || name == typeof(MarshalByRefObject).AssemblyQualifiedName)
 266                                                 name = class_to_proxy.AssemblyQualifiedName;
 267                                 }
 268                                 else
 269                                         name = class_to_proxy.AssemblyQualifiedName;
 270
 271                                 _objTP = InternalGetTransparentProxy (name);
 272                         }
 273                         return _objTP;
 274                 }
 275
 276                 [MonoTODO]
 277                 [ComVisible (true)]
 278                 public IConstructionReturnMessage InitializeServerObject(IConstructionCallMessage ctorMsg)
 279                 {
 280                         throw new NotImplementedException();
 281                 }
 282
 283                 protected void AttachServer(MarshalByRefObject s)
 284                 {
 285                         _server = s;
 286                 }
 287
 288                 protected MarshalByRefObject DetachServer()
 289                 {
 290                         MarshalByRefObject ob = _server;
 291                         _server = null;
 292                         return ob;
 293                 }
 294
 295                 protected MarshalByRefObject GetUnwrappedServer()
 296                 {
 297                         return _server;
 298                 }
 299
 300                 internal void SetTargetDomain (int domainId)
 301                 {
 302                         _targetDomainId = domainId;
 303                 }
 304
 305                 // Called by the runtime
 306                 internal object GetAppDomainTarget ()
 307                 {
 308                         if (_server == null) {
 309                                 ClientActivatedIdentity identity = RemotingServices.GetIdentityForUri (_targetUri) as ClientActivatedIdentity;
 310                                 if (identity == null) throw new RemotingException ("Server for uri '" + _targetUri + "' not found");
 311                                 _server = identity.GetServerObject ();
 312                         }
 313                         return _server;
 314                 }
 315
 316                 static object[] ProcessResponse (IMethodReturnMessage mrm, MonoMethodMessage call)
 317                 {
 318                         // Check return type
 319
 320                         MethodInfo mi = (MethodInfo) call.MethodBase;
 321                         if (mrm.ReturnValue != null && !mi.ReturnType.IsInstanceOfType (mrm.ReturnValue))
 322                                 throw new InvalidCastException ("Return value has an invalid type");
 323
 324                         // Check out parameters
 325
 326
 327                         int no;
 328
 329                         if (call.NeedsOutProcessing (out no))
 330                         {
 331                                 ParameterInfo[] parameters = mi.GetParameters();
 332                                 object[] outArgs = new object [no];
 333                                 int narg = 0;
 334
 335                                 foreach (ParameterInfo par in parameters)
 336                                 {
 337                                         if (par.IsOut && !par.ParameterType.IsByRef)
 338                                         {
 339                                                 // Special marshalling required
 340                                                 object outArg = par.Position < mrm.ArgCount ? mrm.GetArg (par.Position) : null;
 341                                                 if (outArg != null) {
 342                                                         object local = call.GetArg (par.Position);
 343                                                         if (local == null) throw new RemotingException ("Unexpected null value in local out parameter '" + par.Name + "'");
 344                                                         RemotingServices.UpdateOutArgObject (par, local, outArg);
 345                                                 }
 346                                         }
 347                                         else if (par.ParameterType.IsByRef)
 348                                         {
 349                                                 object outArg = par.Position < mrm.ArgCount ? mrm.GetArg (par.Position) : null;
 350                                                 if (outArg != null && !par.ParameterType.GetElementType ().IsInstanceOfType (outArg))
 351                                                 {
 352                                                         throw new InvalidCastException ("Return argument '" + par.Name + "' has an invalid type");
 353                                                 }
 354                                                 outArgs [narg++] = outArg;
 355                                         }
 356                                 }
 357                                 return outArgs;
 358                         }
 359                         else
 360                                 return new object [0];
 361                 }
 362         }
 363 }