diff options
Diffstat (limited to 'netwerk/base/nsIOService.h')
| -rw-r--r-- | netwerk/base/nsIOService.h | 203 |
1 files changed, 203 insertions, 0 deletions
diff --git a/netwerk/base/nsIOService.h b/netwerk/base/nsIOService.h new file mode 100644 index 000000000..7ac23b791 --- /dev/null +++ b/netwerk/base/nsIOService.h @@ -0,0 +1,203 @@ +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#ifndef nsIOService_h__ +#define nsIOService_h__ + +#include "nsStringFwd.h" +#include "nsIIOService2.h" +#include "nsTArray.h" +#include "nsCOMPtr.h" +#include "nsWeakPtr.h" +#include "nsIObserver.h" +#include "nsWeakReference.h" +#include "nsINetUtil.h" +#include "nsIChannelEventSink.h" +#include "nsCategoryCache.h" +#include "nsISpeculativeConnect.h" +#include "nsDataHashtable.h" +#include "mozilla/Atomics.h" +#include "mozilla/Attributes.h" +#include "prtime.h" +#include "nsICaptivePortalService.h" + +#define NS_N(x) (sizeof(x)/sizeof(*x)) + +// We don't want to expose this observer topic. +// Intended internal use only for remoting offline/inline events. +// See Bug 552829 +#define NS_IPC_IOSERVICE_SET_OFFLINE_TOPIC "ipc:network:set-offline" +#define NS_IPC_IOSERVICE_SET_CONNECTIVITY_TOPIC "ipc:network:set-connectivity" + +static const char gScheme[][sizeof("moz-safe-about")] = + {"chrome", "file", "http", "https", "jar", "data", "about", "moz-safe-about", "resource"}; + +class nsINetworkLinkService; +class nsIPrefBranch; +class nsIProtocolProxyService2; +class nsIProxyInfo; +class nsPIDNSService; +class nsPISocketTransportService; + +namespace mozilla { +namespace net { +class NeckoChild; +class nsAsyncRedirectVerifyHelper; + +class nsIOService final : public nsIIOService2 + , public nsIObserver + , public nsINetUtil + , public nsISpeculativeConnect + , public nsSupportsWeakReference + , public nsIIOServiceInternal +{ +public: + NS_DECL_THREADSAFE_ISUPPORTS + NS_DECL_NSIIOSERVICE + NS_DECL_NSIIOSERVICE2 + NS_DECL_NSIOBSERVER + NS_DECL_NSINETUTIL + NS_DECL_NSISPECULATIVECONNECT + NS_DECL_NSIIOSERVICEINTERNAL + + // Gets the singleton instance of the IO Service, creating it as needed + // Returns nullptr on out of memory or failure to initialize. + // Returns an addrefed pointer. + static nsIOService* GetInstance(); + + nsresult Init(); + nsresult NewURI(const char* aSpec, nsIURI* aBaseURI, + nsIURI* *result, + nsIProtocolHandler* *hdlrResult); + + // Called by channels before a redirect happens. This notifies the global + // redirect observers. + nsresult AsyncOnChannelRedirect(nsIChannel* oldChan, nsIChannel* newChan, + uint32_t flags, + nsAsyncRedirectVerifyHelper *helper); + + bool IsOffline() { return mOffline; } + PRIntervalTime LastOfflineStateChange() { return mLastOfflineStateChange; } + PRIntervalTime LastConnectivityChange() { return mLastConnectivityChange; } + PRIntervalTime LastNetworkLinkChange() { return mLastNetworkLinkChange; } + bool IsNetTearingDown() { return mShutdown || mOfflineForProfileChange || + mHttpHandlerAlreadyShutingDown; } + PRIntervalTime NetTearingDownStarted() { return mNetTearingDownStarted; } + + // nsHttpHandler is going to call this function to inform nsIOService that network + // is in process of tearing down. Moving nsHttpConnectionMgr::Shutdown to nsIOService + // caused problems (bug 1242755) so we doing it in this way. + // As soon as nsIOService gets notification that it is shutdown it is going to + // reset mHttpHandlerAlreadyShutingDown. + void SetHttpHandlerAlreadyShutingDown(); + + bool IsLinkUp(); + + // Used to trigger a recheck of the captive portal status + nsresult RecheckCaptivePortal(); +private: + // These shouldn't be called directly: + // - construct using GetInstance + // - destroy using Release + nsIOService(); + ~nsIOService(); + nsresult SetConnectivityInternal(bool aConnectivity); + + nsresult OnNetworkLinkEvent(const char *data); + + nsresult GetCachedProtocolHandler(const char *scheme, + nsIProtocolHandler* *hdlrResult, + uint32_t start=0, + uint32_t end=0); + nsresult CacheProtocolHandler(const char *scheme, + nsIProtocolHandler* hdlr); + + nsresult InitializeCaptivePortalService(); + nsresult RecheckCaptivePortalIfLocalRedirect(nsIChannel* newChan); + + // Prefs wrangling + void PrefsChanged(nsIPrefBranch *prefs, const char *pref = nullptr); + void GetPrefBranch(nsIPrefBranch **); + void ParsePortList(nsIPrefBranch *prefBranch, const char *pref, bool remove); + + nsresult InitializeSocketTransportService(); + nsresult InitializeNetworkLinkService(); + + // consolidated helper function + void LookupProxyInfo(nsIURI *aURI, nsIURI *aProxyURI, uint32_t aProxyFlags, + nsCString *aScheme, nsIProxyInfo **outPI); + + nsresult NewChannelFromURIWithProxyFlagsInternal(nsIURI* aURI, + nsIURI* aProxyURI, + uint32_t aProxyFlags, + nsILoadInfo* aLoadInfo, + nsIChannel** result); + + nsresult SpeculativeConnectInternal(nsIURI *aURI, + nsIPrincipal *aPrincipal, + nsIInterfaceRequestor *aCallbacks, + bool aAnonymous); + +private: + bool mOffline; + mozilla::Atomic<bool, mozilla::Relaxed> mOfflineForProfileChange; + bool mManageLinkStatus; + bool mConnectivity; + // If true, the connectivity state will be mirrored by IOService.offline + // meaning if !mConnectivity, GetOffline() will return true + bool mOfflineMirrorsConnectivity; + + // Used to handle SetOffline() reentrancy. See the comment in + // SetOffline() for more details. + bool mSettingOffline; + bool mSetOfflineValue; + + mozilla::Atomic<bool, mozilla::Relaxed> mShutdown; + mozilla::Atomic<bool, mozilla::Relaxed> mHttpHandlerAlreadyShutingDown; + + nsCOMPtr<nsPISocketTransportService> mSocketTransportService; + nsCOMPtr<nsPIDNSService> mDNSService; + nsCOMPtr<nsIProtocolProxyService2> mProxyService; + nsCOMPtr<nsICaptivePortalService> mCaptivePortalService; + nsCOMPtr<nsINetworkLinkService> mNetworkLinkService; + bool mNetworkLinkServiceInitialized; + + // Cached protocol handlers, only accessed on the main thread + nsWeakPtr mWeakHandler[NS_N(gScheme)]; + + // cached categories + nsCategoryCache<nsIChannelEventSink> mChannelEventSinks; + + nsTArray<int32_t> mRestrictedPortList; + + bool mNetworkNotifyChanged; + + static bool sTelemetryEnabled; + + // These timestamps are needed for collecting telemetry on PR_Connect, + // PR_ConnectContinue and PR_Close blocking time. If we spend very long + // time in any of these functions we want to know if and what network + // change has happened shortly before. + mozilla::Atomic<PRIntervalTime> mLastOfflineStateChange; + mozilla::Atomic<PRIntervalTime> mLastConnectivityChange; + mozilla::Atomic<PRIntervalTime> mLastNetworkLinkChange; + + // Time a network tearing down started. + mozilla::Atomic<PRIntervalTime> mNetTearingDownStarted; +public: + // Used for all default buffer sizes that necko allocates. + static uint32_t gDefaultSegmentSize; + static uint32_t gDefaultSegmentCount; +}; + +/** + * Reference to the IO service singleton. May be null. + */ +extern nsIOService* gIOService; + +} // namespace net +} // namespace mozilla + +#endif // nsIOService_h__ |