proxy_resolver_v8.h revision a36e5920737c6adbddd3e43b760e5de8431db6e0
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2011 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef NET_PROXY_PROXY_RESOLVER_V8_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define NET_PROXY_PROXY_RESOLVER_V8_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/net_export.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/proxy/proxy_resolver.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace v8 { 142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class HeapStatistics; 152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class Isolate; 162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} // namespace v8 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace net { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Implementation of ProxyResolver that uses V8 to evaluate PAC scripts. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ---------------------------------------------------------------------------- 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// !!! Important note on threading model: 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ---------------------------------------------------------------------------- 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// There can be only one instance of V8 running at a time. To enforce this 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// constraint, ProxyResolverV8 holds a v8::Locker during execution. Therefore 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// it is OK to run multiple instances of ProxyResolverV8 on different threads, 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// since only one will be running inside V8 at a time. 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// It is important that *ALL* instances of V8 in the process be using 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// v8::Locker. If not there can be race conditions between the non-locked V8 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// instances and the locked V8 instances used by ProxyResolverV8 (assuming they 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// run on different threads). 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This is the case with the V8 instance used by chromium's renderer -- it runs 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// on a different thread from ProxyResolver (renderer thread vs PAC thread), 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// and does not use locking since it expects to be alone. 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT_PRIVATE ProxyResolverV8 : public ProxyResolver { 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Interface for the javascript bindings. 412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) class NET_EXPORT_PRIVATE JSBindings { 422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) public: 432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) enum ResolveDnsOperation { 442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) DNS_RESOLVE, 452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) DNS_RESOLVE_EX, 462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) MY_IP_ADDRESS, 472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) MY_IP_ADDRESS_EX, 482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) }; 492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) JSBindings() {} 512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Handler for "dnsResolve()", "dnsResolveEx()", "myIpAddress()", 532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // "myIpAddressEx()". Returns true on success and fills |*output| with the 542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // result. If |*terminate| is set to true, then the script execution will 552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // be aborted. Note that termination may not happen right away. 562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual bool ResolveDns(const std::string& host, 572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ResolveDnsOperation op, 582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) std::string* output, 592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool* terminate) = 0; 602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Handler for "alert(message)" 62c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void Alert(const base::string16& message) = 0; 632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Handler for when an error is encountered. |line_number| may be -1 652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // if a line number is not applicable to this error. 66c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void OnError(int line_number, const base::string16& error) = 0; 672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) protected: 692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual ~JSBindings() {} 702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) }; 712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Constructs a ProxyResolverV8. 732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ProxyResolverV8(); 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ProxyResolverV8(); 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) JSBindings* js_bindings() const { return js_bindings_; } 782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void set_js_bindings(JSBindings* js_bindings) { js_bindings_ = js_bindings; } 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ProxyResolver implementation: 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int GetProxyForURL(const GURL& url, 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ProxyInfo* results, 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::CompletionCallback& /*callback*/, 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) RequestHandle* /*request*/, 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const BoundNetLog& net_log) OVERRIDE; 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void CancelRequest(RequestHandle request) OVERRIDE; 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual LoadState GetLoadState(RequestHandle request) const OVERRIDE; 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void CancelSetPacScript() OVERRIDE; 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void PurgeMemory() OVERRIDE; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int SetPacScript( 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const scoped_refptr<ProxyResolverScriptData>& script_data, 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::CompletionCallback& /*callback*/) OVERRIDE; 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Remember the default Isolate, must be called from the main thread. This 952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // hack can be removed when the "default Isolate" concept is gone. 962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static void RememberDefaultIsolate(); 97a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) 98a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)#if defined(OS_WIN) 99a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) // Create an isolate to use for the proxy resolver. Until the "default 100a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) // Isolate" concept is gone, it is preferable to invoke 101a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) // RememberDefaultIsolate() as creating a new Isolate in additional to the 102a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) // default Isolate will waste a few MB of memory and the runtime it took to 103a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) // create the default Isolate. 104a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) static void CreateIsolate(); 105a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)#endif 106a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) 1072a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static v8::Isolate* GetDefaultIsolate(); 1082a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Get total/ued heap memory usage of all v8 instances used by the proxy 1102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // resolver. 1112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static size_t GetTotalHeapSize(); 1122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static size_t GetUsedHeapSize(); 1132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static v8::Isolate* g_default_isolate_; 1162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Context holds the Javascript state for the most recently loaded PAC 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // script. It corresponds with the data from the last call to 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // SetPacScript(). 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class Context; 1212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<Context> context_; 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) JSBindings* js_bindings_; 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(ProxyResolverV8); 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_PROXY_PROXY_RESOLVER_V8_H_ 132