/* vim:set ts=4 sw=4 sts=4 ci et: */ /* 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 nsSocketTransportService2_h__ #define nsSocketTransportService2_h__ #include "nsPISocketTransportService.h" #include "nsIThreadInternal.h" #include "nsIRunnable.h" #include "nsEventQueue.h" #include "nsCOMPtr.h" #include "prinrval.h" #include "mozilla/Logging.h" #include "prinit.h" #include "nsIObserver.h" #include "mozilla/Mutex.h" #include "mozilla/net/DashboardTypes.h" #include "mozilla/Atomics.h" #include "mozilla/TimeStamp.h" class nsASocketHandler; struct PRPollDesc; //----------------------------------------------------------------------------- // // set NSPR_LOG_MODULES=nsSocketTransport:5 // extern mozilla::LazyLogModule gSocketTransportLog; #define SOCKET_LOG(args) MOZ_LOG(gSocketTransportLog, mozilla::LogLevel::Debug, args) #define SOCKET_LOG_ENABLED() MOZ_LOG_TEST(gSocketTransportLog, mozilla::LogLevel::Debug) // // set NSPR_LOG_MODULES=UDPSocket:5 // extern mozilla::LazyLogModule gUDPSocketLog; #define UDPSOCKET_LOG(args) MOZ_LOG(gUDPSocketLog, mozilla::LogLevel::Debug, args) #define UDPSOCKET_LOG_ENABLED() MOZ_LOG_TEST(gUDPSocketLog, mozilla::LogLevel::Debug) //----------------------------------------------------------------------------- #define NS_SOCKET_POLL_TIMEOUT PR_INTERVAL_NO_TIMEOUT //----------------------------------------------------------------------------- namespace mozilla { namespace net { // These maximums are borrowed from the linux kernel. static const int32_t kMaxTCPKeepIdle = 32767; // ~9 hours. static const int32_t kMaxTCPKeepIntvl = 32767; static const int32_t kMaxTCPKeepCount = 127; static const int32_t kDefaultTCPKeepCount = #if defined (XP_WIN) 10; // Hardcoded in Windows. #elif defined (XP_MACOSX) 8; // Hardcoded in OSX. #else 4; // Specifiable in Linux. #endif } // namespace net } // namespace mozilla //----------------------------------------------------------------------------- class nsSocketTransportService final : public nsPISocketTransportService , public nsIEventTarget , public nsIThreadObserver , public nsIRunnable , public nsIObserver { typedef mozilla::Mutex Mutex; public: NS_DECL_THREADSAFE_ISUPPORTS NS_DECL_NSPISOCKETTRANSPORTSERVICE NS_DECL_NSISOCKETTRANSPORTSERVICE NS_DECL_NSIROUTEDSOCKETTRANSPORTSERVICE NS_DECL_NSIEVENTTARGET NS_DECL_NSITHREADOBSERVER NS_DECL_NSIRUNNABLE NS_DECL_NSIOBSERVER // missing from NS_DECL_NSIEVENTTARGET because MSVC nsresult Dispatch(nsIRunnable* aEvent, uint32_t aFlags) { return Dispatch(nsCOMPtr(aEvent).forget(), aFlags); } nsSocketTransportService(); // Max Socket count may need to get initialized/used by nsHttpHandler // before this class is initialized. static uint32_t gMaxCount; static PRCallOnceType gMaxCountInitOnce; static PRStatus DiscoverMaxCount(); // // the number of sockets that can be attached at any given time is // limited. this is done because some operating systems (e.g., Win9x) // limit the number of sockets that can be created by an application. // AttachSocket will fail if the limit is exceeded. consumers should // call CanAttachSocket and check the result before creating a socket. // bool CanAttachSocket() { return mActiveCount + mIdleCount < gMaxCount; } // Called by the networking dashboard on the socket thread only // Fills the passed array with socket information void GetSocketConnections(nsTArray *); uint64_t GetSentBytes() { return mSentBytesCount; } uint64_t GetReceivedBytes() { return mReceivedBytesCount; } // Returns true if keepalives are enabled in prefs. bool IsKeepaliveEnabled() { return mKeepaliveEnabledPref; } bool IsTelemetryEnabled() { return mTelemetryEnabledPref; } protected: virtual ~nsSocketTransportService(); private: //------------------------------------------------------------------------- // misc (any thread) //------------------------------------------------------------------------- nsCOMPtr mThread; // protected by mLock PRFileDesc *mThreadEvent; // protected by mLock. mThreadEvent may change // if the old pollable event is broken. only // the socket thread may change mThreadEvent; // it needs to lock mLock only when it changes // mThreadEvent. other threads don't change // mThreadEvent; they need to lock mLock // whenever they access mThreadEvent. bool mAutodialEnabled; // pref to control autodial code // Returns mThread, protecting the get-and-addref with mLock already_AddRefed GetThreadSafely(); //------------------------------------------------------------------------- // initialization and shutdown (any thread) //------------------------------------------------------------------------- Mutex mLock; bool mInitialized; bool mShuttingDown; // indicates whether we are currently in the // process of shutting down bool mOffline; bool mGoingOffline; // Detaches all sockets. void Reset(bool aGuardLocals); //------------------------------------------------------------------------- // socket lists (socket thread only) // // only "active" sockets are on the poll list. the active list is kept // in sync with the poll list such that: // // mActiveList[k].mFD == mPollList[k+1].fd // // where k=0,1,2,... //------------------------------------------------------------------------- struct SocketContext { PRFileDesc *mFD; nsASocketHandler *mHandler; uint16_t mElapsedTime; // time elapsed w/o activity }; SocketContext *mActiveList; /* mListSize entries */ SocketContext *mIdleList; /* mListSize entries */ uint32_t mActiveListSize; uint32_t mIdleListSize; uint32_t mActiveCount; uint32_t mIdleCount; nsresult DetachSocket(SocketContext *, SocketContext *); nsresult AddToIdleList(SocketContext *); nsresult AddToPollList(SocketContext *); void RemoveFromIdleList(SocketContext *); void RemoveFromPollList(SocketContext *); void MoveToIdleList(SocketContext *sock); void MoveToPollList(SocketContext *sock); bool GrowActiveList(); bool GrowIdleList(); void InitMaxCount(); // Total bytes number transfered through all the sockets except active ones uint64_t mSentBytesCount; uint64_t mReceivedBytesCount; //------------------------------------------------------------------------- // poll list (socket thread only) // // first element of the poll list is mThreadEvent (or null if the pollable // event cannot be created). //------------------------------------------------------------------------- PRPollDesc *mPollList; /* mListSize + 1 entries */ PRIntervalTime PollTimeout(); // computes ideal poll timeout nsresult DoPollIteration(bool wait, mozilla::TimeDuration *pollDuration); // perfoms a single poll iteration int32_t Poll(bool wait, uint32_t *interval, mozilla::TimeDuration *pollDuration); // calls PR_Poll. the out param // interval indicates the poll // duration in seconds. // pollDuration is used only for // telemetry //------------------------------------------------------------------------- // pending socket queue - see NotifyWhenCanAttachSocket //------------------------------------------------------------------------- mozilla::Mutex mEventQueueLock; nsEventQueue mPendingSocketQ; // queue of nsIRunnable objects // Preference Monitor for SendBufferSize and Keepalive prefs. nsresult UpdatePrefs(); int32_t mSendBufferSize; // Number of seconds of connection is idle before first keepalive ping. int32_t mKeepaliveIdleTimeS; // Number of seconds between retries should keepalive pings fail. int32_t mKeepaliveRetryIntervalS; // Number of keepalive probes to send. int32_t mKeepaliveProbeCount; // True if TCP keepalive is enabled globally. bool mKeepaliveEnabledPref; mozilla::Atomic mServingPendingQueue; mozilla::Atomic mMaxTimePerPollIter; mozilla::Atomic mTelemetryEnabledPref; void OnKeepaliveEnabledPrefChange(); void NotifyKeepaliveEnabledPrefChange(SocketContext *sock); // Socket thread only for dynamically adjusting max socket size #if defined(XP_WIN) void ProbeMaxCount(); #endif bool mProbedMaxCount; void AnalyzeConnection(nsTArray *data, SocketContext *context, bool aActive); void ClosePrivateConnections(); void DetachSocketWithGuard(bool aGuardLocals, SocketContext *socketList, int32_t index); void MarkTheLastElementOfPendingQueue(); }; extern nsSocketTransportService *gSocketTransportService; extern mozilla::Atomic gSocketThread; #endif // !nsSocketTransportService_h__