gecko/dom/workers/RuntimeService.h

264 lines
6.0 KiB
C++

/* -*- Mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 40 -*- */
/* vim: set ts=2 et sw=2 tw=80: */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Web Workers.
*
* The Initial Developer of the Original Code is
* The Mozilla Foundation.
* Portions created by the Initial Developer are Copyright (C) 2011
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Ben Turner <bent.mozilla@gmail.com> (Original Author)
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef mozilla_dom_workers_runtimeservice_h__
#define mozilla_dom_workers_runtimeservice_h__
#include "Workers.h"
#include "nsIObserver.h"
#include "jsapi.h"
#include "mozilla/Mutex.h"
#include "mozilla/TimeStamp.h"
#include "nsAutoPtr.h"
#include "nsClassHashtable.h"
#include "nsCOMPtr.h"
#include "nsHashKeys.h"
#include "nsStringGlue.h"
#include "nsTArray.h"
class nsIThread;
class nsITimer;
class nsPIDOMWindow;
BEGIN_WORKERS_NAMESPACE
class WorkerPrivate;
class RuntimeService : public nsIObserver
{
struct WorkerDomainInfo
{
nsCString mDomain;
nsTArray<WorkerPrivate*> mActiveWorkers;
nsTArray<WorkerPrivate*> mQueuedWorkers;
PRUint32 mChildWorkerCount;
WorkerDomainInfo() : mActiveWorkers(1), mChildWorkerCount(0) { }
PRUint32
ActiveWorkerCount() const
{
return mActiveWorkers.Length() + mChildWorkerCount;
}
};
struct IdleThreadInfo
{
nsCOMPtr<nsIThread> mThread;
mozilla::TimeStamp mExpirationTime;
};
mozilla::Mutex mMutex;
// Protected by mMutex.
nsClassHashtable<nsCStringHashKey, WorkerDomainInfo> mDomainMap;
// Protected by mMutex.
nsTArray<IdleThreadInfo> mIdleThreadArray;
// *Not* protected by mMutex.
nsClassHashtable<nsVoidPtrHashKey, nsTArray<WorkerPrivate*> > mWindowMap;
// Only used on the main thread.
nsCOMPtr<nsITimer> mIdleThreadTimer;
nsCString mDetectorName;
nsCString mSystemCharset;
static PRUint32 sDefaultJSContextOptions;
static PRInt32 sCloseHandlerTimeoutSeconds;
#ifdef JS_GC_ZEAL
static PRUint8 sDefaultGCZeal;
#endif
public:
struct NavigatorStrings
{
nsString mAppName;
nsString mAppVersion;
nsString mPlatform;
nsString mUserAgent;
};
private:
NavigatorStrings mNavigatorStrings;
// True when the observer service holds a reference to this object.
bool mObserved;
bool mShuttingDown;
bool mNavigatorStringsLoaded;
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIOBSERVER
static RuntimeService*
GetOrCreateService();
static RuntimeService*
GetService();
bool
RegisterWorker(JSContext* aCx, WorkerPrivate* aWorkerPrivate);
void
UnregisterWorker(JSContext* aCx, WorkerPrivate* aWorkerPrivate);
void
CancelWorkersForWindow(JSContext* aCx, nsPIDOMWindow* aWindow);
void
SuspendWorkersForWindow(JSContext* aCx, nsPIDOMWindow* aWindow);
void
ResumeWorkersForWindow(JSContext* aCx, nsPIDOMWindow* aWindow);
const nsACString&
GetDetectorName() const
{
return mDetectorName;
}
const nsACString&
GetSystemCharset() const
{
return mSystemCharset;
}
const NavigatorStrings&
GetNavigatorStrings() const
{
return mNavigatorStrings;
}
void
NoteIdleThread(nsIThread* aThread);
static PRUint32
GetDefaultJSContextOptions()
{
AssertIsOnMainThread();
return sDefaultJSContextOptions;
}
static void
SetDefaultJSContextOptions(PRUint32 aOptions)
{
AssertIsOnMainThread();
sDefaultJSContextOptions = aOptions;
}
void
UpdateAllWorkerJSContextOptions();
static PRUint32
GetCloseHandlerTimeoutSeconds()
{
return sCloseHandlerTimeoutSeconds > 0 ? sCloseHandlerTimeoutSeconds : 0;
}
#ifdef JS_GC_ZEAL
static PRUint8
GetDefaultGCZeal()
{
AssertIsOnMainThread();
return sDefaultGCZeal;
}
static void
SetDefaultGCZeal(PRUint8 aGCZeal)
{
AssertIsOnMainThread();
sDefaultGCZeal = aGCZeal;
}
void
UpdateAllWorkerGCZeal();
#endif
class AutoSafeJSContext
{
JSContext* mContext;
public:
AutoSafeJSContext(JSContext* aCx = nsnull);
~AutoSafeJSContext();
operator JSContext*() const
{
return mContext;
}
static JSContext*
GetSafeContext();
};
private:
RuntimeService();
~RuntimeService();
nsresult
Init();
void
Cleanup();
static PLDHashOperator
AddAllTopLevelWorkersToArray(const nsACString& aKey,
WorkerDomainInfo* aData,
void* aUserArg);
void
GetWorkersForWindow(nsPIDOMWindow* aWindow,
nsTArray<WorkerPrivate*>& aWorkers);
bool
ScheduleWorker(JSContext* aCx, WorkerPrivate* aWorkerPrivate);
static void
ShutdownIdleThreads(nsITimer* aTimer, void* aClosure);
};
END_WORKERS_NAMESPACE
#endif /* mozilla_dom_workers_runtimeservice_h__ */