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
  45 namespace System.Runtime.Remoting.Proxies
  46 {
  47 #pragma warning disable 169, 649
  48         internal class TransparentProxy {
  49                 public RealProxy _rp;
  50                 IntPtr _class;
  51                 bool _custom_type_info;
  52         }
  53 #pragma warning restore 169, 649
  54
  55         [ComVisible (true)]
  56         public abstract class RealProxy {
  57                 // other classes visible to the runtime
  58                 // derive from this class so keep these locals
  59                 // in sync with the definition RealProxy
  60                 // in object-internals.h
  61
  62 #pragma warning disable 169, 414
  63                 #region Sync with object-internals.h
  64                 Type class_to_proxy;
  65                 internal Context _targetContext;
  66                 MarshalByRefObject _server;
  67                 int _targetDomainId = -1;
  68                 internal string _targetUri;
  69                 internal Identity _objectIdentity;
  70                 Object _objTP;
  71                 object _stubData;
  72         #endregion
  73 #pragma warning restore 169, 414
  74
  75                 protected RealProxy ()
  76                 {
  77                 }
  78
  79                 protected RealProxy (Type classToProxy) : this(classToProxy, IntPtr.Zero, null)
  80                 {
  81                 }
  82
  83                 internal RealProxy (Type classToProxy, ClientIdentity identity) : this(classToProxy, IntPtr.Zero, null)
  84                 {
  85                         _objectIdentity = identity;
  86                 }
  87
  88                 protected RealProxy (Type classToProxy, IntPtr stub, object stubData)
  89                 {
  90                         if (!classToProxy.IsMarshalByRef && !classToProxy.IsInterface)
  91                                 throw new ArgumentException("object must be MarshalByRef");
  92
  93                         this.class_to_proxy = classToProxy;
  94
  95                         if (stub != IntPtr.Zero)
  96                                 throw new NotSupportedException ("stub is not used in Mono");
  97                 }
  98
  99                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
 100                 extern static Type InternalGetProxyType (object transparentProxy);
 101
 102                 public Type GetProxiedType()
 103                 {
 104                         if (_objTP == null) {
 105                                 if (class_to_proxy.IsInterface) return typeof(MarshalByRefObject);
 106                                 else return class_to_proxy;
 107                         }
 108                         return InternalGetProxyType (_objTP);
 109                 }
 110
 111                 public virtual ObjRef CreateObjRef (Type requestedType)
 112                 {
 113                         return RemotingServices.Marshal ((MarshalByRefObject) GetTransparentProxy(), null, requestedType);
 114                 }
 115
 116                 public virtual void GetObjectData (SerializationInfo info, StreamingContext context)
 117                 {
 118                         Object obj = GetTransparentProxy();
 119                         RemotingServices.GetObjectData (obj, info, context);
 120                 }
 121
 122                 internal Identity ObjectIdentity
 123                 {
 124                         get { return _objectIdentity; }
 125                         set { _objectIdentity = value; }
 126                 }
 127
 128                 [MonoTODO]
 129                 public virtual IntPtr GetCOMIUnknown (bool fIsMarshalled)
 130                 {
 131                         throw new NotImplementedException ();
 132                 }
 133
 134                 [MonoTODO]
 135                 public virtual void SetCOMIUnknown (IntPtr i)
 136                 {
 137                         throw new NotImplementedException ();
 138                 }
 139
 140                 [MonoTODO]
 141                 public virtual IntPtr SupportsInterface (ref Guid iid)
 142                 {
 143                         throw new NotImplementedException ();
 144                 }
 145
 146                 public static object GetStubData (RealProxy rp)
 147                 {
 148                         return rp._stubData;
 149                 }
 150
 151                 public static void SetStubData (RealProxy rp, object stubData)
 152                 {
 153                         rp._stubData = stubData;
 154                 }
 155
 156                 public abstract IMessage Invoke (IMessage msg);
 157
 158                 /* this is called from unmanaged code */
 159                 internal static object PrivateInvoke (RealProxy rp, IMessage msg, out Exception exc,
 160                                                       out object [] out_args)
 161                 {
 162                         MonoMethodMessage mMsg = (MonoMethodMessage) msg;
 163                         mMsg.LogicalCallContext = CallContext.CreateLogicalCallContext (true);
 164                         CallType call_type = mMsg.CallType;
 165                         bool is_remproxy = (rp is RemotingProxy);
 166
 167                         out_args = null;
 168                         IMethodReturnMessage res_msg = null;
 169
 170                         if (call_type == CallType.BeginInvoke)
 171                                 // todo: set CallMessage in runtime instead
 172                                 mMsg.AsyncResult.CallMessage = mMsg;
 173
 174                         if (call_type == CallType.EndInvoke)
 175                                 res_msg = (IMethodReturnMessage)mMsg.AsyncResult.EndInvoke ();
 176
 177                         // Check for constructor msg
 178                         if (mMsg.MethodBase.IsConstructor)
 179                         {
 180                                 if (is_remproxy)
 181                                         res_msg = (IMethodReturnMessage) (rp as RemotingProxy).ActivateRemoteObject ((IMethodMessage) msg);
 182                                 else
 183                                         msg = new ConstructionCall (rp.GetProxiedType ());
 184                         }
 185
 186                         if (null == res_msg)
 187                         {
 188                                 bool failed = false;
 189
 190                                 try {
 191                                         res_msg = (IMethodReturnMessage)rp.Invoke (msg);
 192                                 } catch (Exception ex) {
 193                                         failed = true;
 194                                         if (call_type == CallType.BeginInvoke) {
 195                                                 // If async dispatch crashes, don't propagate the exception.
 196                                                 // The exception will be raised when calling EndInvoke.
 197                                                 mMsg.AsyncResult.SyncProcessMessage (new ReturnMessage (ex, msg as IMethodCallMessage));
 198                                                 res_msg = new ReturnMessage (null, null, 0, null, msg as IMethodCallMessage);
 199                                         } else
 200                                                 throw;
 201                                 }
 202
 203                                 // Note, from begining this code used AsyncResult.IsCompleted for
 204                                 // checking if it was a remoting or custom proxy, but in some
 205                                 // cases the remoting proxy finish before the call returns
 206                                 // causing this method to be called, therefore causing all kind of bugs.
 207                                 if ((!is_remproxy) && call_type == CallType.BeginInvoke && !failed)
 208                                 {
 209                                         IMessage asyncMsg = null;
 210
 211                                         // allow calltype EndInvoke to finish
 212                                         asyncMsg = mMsg.AsyncResult.SyncProcessMessage (res_msg as IMessage);
 213                                         out_args = res_msg.OutArgs;
 214                                         res_msg = new ReturnMessage (asyncMsg, null, 0, null, res_msg as IMethodCallMessage);
 215                                 }
 216                         }
 217
 218                         if (res_msg.LogicalCallContext != null && res_msg.LogicalCallContext.HasInfo)
 219                                 CallContext.UpdateCurrentCallContext (res_msg.LogicalCallContext);
 220
 221                         exc = res_msg.Exception;
 222
 223                         // todo: remove throw exception from the runtime invoke
 224                         if (null != exc) {
 225                                 out_args = null;
 226                                 throw exc.FixRemotingException();
 227                         }
 228                         else if (res_msg is IConstructionReturnMessage) {
 229                                 if (out_args == null)
 230                                         out_args = res_msg.OutArgs;
 231                         }
 232                         else if (mMsg.CallType == CallType.BeginInvoke) {
 233                                 // We don't have OutArgs in this case.
 234                         }
 235                         else if (mMsg.CallType == CallType.Sync) {
 236                                 out_args = ProcessResponse (res_msg, mMsg);
 237                         }
 238                         else if (mMsg.CallType == CallType.EndInvoke) {
 239                                 out_args = ProcessResponse (res_msg, mMsg.AsyncResult.CallMessage);
 240                         }
 241                         else {
 242                                 if (out_args == null)
 243                                         out_args = res_msg.OutArgs;
 244                         }
 245
 246                         return res_msg.ReturnValue;
 247                 }
 248
 249                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
 250                 internal extern virtual object InternalGetTransparentProxy (string className);
 251
 252                 public virtual object GetTransparentProxy ()
 253                 {
 254                         if (_objTP == null)
 255                         {
 256                                 string name;
 257                                 IRemotingTypeInfo rti = this as IRemotingTypeInfo;
 258
 259                                 if (rti != null) {
 260                                         name = rti.TypeName;
 261                                         if (name == null || name == typeof(MarshalByRefObject).AssemblyQualifiedName)
 262                                                 name = class_to_proxy.AssemblyQualifiedName;
 263                                 }
 264                                 else
 265                                         name = class_to_proxy.AssemblyQualifiedName;
 266
 267                                 _objTP = InternalGetTransparentProxy (name);
 268                         }
 269                         return _objTP;
 270                 }
 271
 272                 [MonoTODO]
 273                 [ComVisible (true)]
 274                 public IConstructionReturnMessage InitializeServerObject(IConstructionCallMessage ctorMsg)
 275                 {
 276                         throw new NotImplementedException();
 277                 }
 278
 279                 protected void AttachServer(MarshalByRefObject s)
 280                 {
 281                         _server = s;
 282                 }
 283
 284                 protected MarshalByRefObject DetachServer()
 285                 {
 286                         MarshalByRefObject ob = _server;
 287                         _server = null;
 288                         return ob;
 289                 }
 290
 291                 protected MarshalByRefObject GetUnwrappedServer()
 292                 {
 293                         return _server;
 294                 }
 295
 296                 internal void SetTargetDomain (int domainId)
 297                 {
 298                         _targetDomainId = domainId;
 299                 }
 300
 301                 // Called by the runtime
 302                 internal object GetAppDomainTarget ()
 303                 {
 304                         if (_server == null) {
 305                                 ClientActivatedIdentity identity = RemotingServices.GetIdentityForUri (_targetUri) as ClientActivatedIdentity;
 306                                 if (identity == null) throw new RemotingException ("Server for uri '" + _targetUri + "' not found");
 307                                 _server = identity.GetServerObject ();
 308                         }
 309                         return _server;
 310                 }
 311
 312                 static object[] ProcessResponse (IMethodReturnMessage mrm, MonoMethodMessage call)
 313                 {
 314                         // Check return type
 315
 316                         MethodInfo mi = (MethodInfo) call.MethodBase;
 317                         if (mrm.ReturnValue != null && !mi.ReturnType.IsInstanceOfType (mrm.ReturnValue))
 318                                 throw new InvalidCastException ("Return value has an invalid type");
 319
 320                         // Check out parameters
 321
 322
 323                         int no;
 324
 325                         if (call.NeedsOutProcessing (out no))
 326                         {
 327                                 ParameterInfo[] parameters = mi.GetParameters();
 328                                 object[] outArgs = new object [no];
 329                                 int narg = 0;
 330
 331                                 foreach (ParameterInfo par in parameters)
 332                                 {
 333                                         if (par.IsOut && !par.ParameterType.IsByRef)
 334                                         {
 335                                                 // Special marshalling required
 336                                                 object outArg = par.Position < mrm.ArgCount ? mrm.GetArg (par.Position) : null;
 337                                                 if (outArg != null) {
 338                                                         object local = call.GetArg (par.Position);
 339                                                         if (local == null) throw new RemotingException ("Unexpected null value in local out parameter '" + par.Name + "'");
 340                                                         RemotingServices.UpdateOutArgObject (par, local, outArg);
 341                                                 }
 342                                         }
 343                                         else if (par.ParameterType.IsByRef)
 344                                         {
 345                                                 object outArg = par.Position < mrm.ArgCount ? mrm.GetArg (par.Position) : null;
 346                                                 if (outArg != null && !par.ParameterType.GetElementType ().IsInstanceOfType (outArg))
 347                                                 {
 348                                                         throw new InvalidCastException ("Return argument '" + par.Name + "' has an invalid type");
 349                                                 }
 350                                                 outArgs [narg++] = outArg;
 351                                         }
 352                                 }
 353                                 return outArgs;
 354                         }
 355                         else
 356                                 return new object [0];
 357                 }
 358         }
 359 }