2001-09-29 00:14:13 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
2004-04-18 18:21:17 +04:00
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
2000-06-03 11:02:20 +04:00
|
|
|
*
|
2004-04-18 18:21:17 +04:00
|
|
|
* 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/
|
2000-06-03 11:02:20 +04:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* 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.
|
2000-06-03 11:02:20 +04:00
|
|
|
*
|
|
|
|
* The Original Code is mozilla.org code.
|
|
|
|
*
|
2004-04-18 18:21:17 +04:00
|
|
|
* The Initial Developer of the Original Code is
|
2001-09-29 00:14:13 +04:00
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
2000-06-03 11:02:20 +04:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
2004-04-18 18:21:17 +04:00
|
|
|
* either of 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"),
|
2001-09-29 00:14:13 +04:00
|
|
|
* 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
|
2004-04-18 18:21:17 +04:00
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
2001-09-29 00:14:13 +04:00
|
|
|
* 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
|
2004-04-18 18:21:17 +04:00
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
2001-09-29 00:14:13 +04:00
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
2000-06-03 11:02:20 +04:00
|
|
|
|
2004-11-12 22:26:37 +03:00
|
|
|
#include "nsXPCOM.h"
|
2000-06-03 11:02:20 +04:00
|
|
|
#include "nsMemoryImpl.h"
|
2006-05-10 21:30:15 +04:00
|
|
|
#include "nsThreadUtils.h"
|
2004-11-12 22:26:37 +03:00
|
|
|
|
|
|
|
#include "nsIObserverService.h"
|
|
|
|
#include "nsIServiceManager.h"
|
|
|
|
#include "nsISupportsArray.h"
|
|
|
|
|
2000-06-03 11:02:20 +04:00
|
|
|
#include "prmem.h"
|
2006-05-10 21:30:15 +04:00
|
|
|
#include "prcvar.h"
|
|
|
|
#include "pratom.h"
|
2004-11-12 22:26:37 +03:00
|
|
|
|
2000-09-20 09:44:19 +04:00
|
|
|
#include "nsAlgorithm.h"
|
|
|
|
#include "nsAutoLock.h"
|
2004-11-12 22:26:37 +03:00
|
|
|
#include "nsCOMPtr.h"
|
2000-09-20 09:44:19 +04:00
|
|
|
#include "nsString.h"
|
2000-06-03 11:02:20 +04:00
|
|
|
|
2000-11-29 02:51:05 +03:00
|
|
|
#if defined(XP_WIN)
|
2000-08-24 12:35:13 +04:00
|
|
|
#include <windows.h>
|
2006-05-10 21:30:15 +04:00
|
|
|
#define NS_MEMORY_FLUSHER
|
2000-09-20 09:44:19 +04:00
|
|
|
#else
|
|
|
|
// Need to implement the nsIMemory::IsLowMemory() predicate
|
2006-05-10 21:30:15 +04:00
|
|
|
#undef NS_MEMORY_FLUSHER
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef NS_MEMORY_FLUSHER
|
|
|
|
#include "nsITimer.h"
|
2000-09-20 09:44:19 +04:00
|
|
|
#endif
|
|
|
|
|
2000-06-03 11:02:20 +04:00
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Define NS_OUT_OF_MEMORY_TESTER if you want to force memory failures
|
|
|
|
|
2000-08-24 12:35:13 +04:00
|
|
|
#ifdef DEBUG_xwarren
|
2000-06-03 11:02:20 +04:00
|
|
|
#define NS_OUT_OF_MEMORY_TESTER
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef NS_OUT_OF_MEMORY_TESTER
|
|
|
|
|
|
|
|
// flush memory one in this number of times:
|
|
|
|
#define NS_FLUSH_FREQUENCY 100000
|
|
|
|
|
|
|
|
// fail allocation one in this number of flushes:
|
|
|
|
#define NS_FAIL_FREQUENCY 10
|
|
|
|
|
|
|
|
PRUint32 gFlushFreq = 0;
|
|
|
|
PRUint32 gFailFreq = 0;
|
|
|
|
|
|
|
|
static void*
|
|
|
|
mallocator(PRSize size, PRUint32& counter, PRUint32 max)
|
|
|
|
{
|
|
|
|
if (counter++ >= max) {
|
|
|
|
counter = 0;
|
|
|
|
NS_ASSERTION(0, "about to fail allocation... watch out");
|
|
|
|
return nsnull;
|
|
|
|
}
|
|
|
|
return PR_Malloc(size);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void*
|
|
|
|
reallocator(void* ptr, PRSize size, PRUint32& counter, PRUint32 max)
|
|
|
|
{
|
|
|
|
if (counter++ >= max) {
|
|
|
|
counter = 0;
|
|
|
|
NS_ASSERTION(0, "about to fail reallocation... watch out");
|
|
|
|
return nsnull;
|
|
|
|
}
|
|
|
|
return PR_Realloc(ptr, size);
|
|
|
|
}
|
|
|
|
|
|
|
|
#define MALLOC1(s) mallocator(s, gFlushFreq, NS_FLUSH_FREQUENCY)
|
|
|
|
#define REALLOC1(p, s) reallocator(p, s, gFlushFreq, NS_FLUSH_FREQUENCY)
|
|
|
|
|
|
|
|
#else
|
|
|
|
|
|
|
|
#define MALLOC1(s) PR_Malloc(s)
|
|
|
|
#define REALLOC1(p, s) PR_Realloc(p, s)
|
|
|
|
|
|
|
|
#endif // NS_OUT_OF_MEMORY_TESTER
|
|
|
|
|
2004-11-12 22:26:37 +03:00
|
|
|
#if defined(XDEBUG_waterson)
|
|
|
|
#define NS_TEST_MEMORY_FLUSHER
|
|
|
|
#endif
|
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
#ifdef NS_MEMORY_FLUSHER
|
2004-11-12 22:26:37 +03:00
|
|
|
/**
|
2006-05-10 21:30:15 +04:00
|
|
|
* A class that is used to periodically check the status of the system,
|
|
|
|
* determine if too much memory is in use, and if so, trigger a "memory flush".
|
2004-11-12 22:26:37 +03:00
|
|
|
*/
|
2006-05-10 21:30:15 +04:00
|
|
|
class MemoryFlusher : public nsITimerCallback
|
2004-11-12 22:26:37 +03:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
// We don't use the generic macros because we are a special static object
|
|
|
|
NS_IMETHOD QueryInterface(REFNSIID aIID, void** aResult);
|
2006-05-10 21:30:15 +04:00
|
|
|
NS_IMETHOD_(nsrefcnt) AddRef(void) { return 2; }
|
2004-11-12 22:26:37 +03:00
|
|
|
NS_IMETHOD_(nsrefcnt) Release(void) { return 1; }
|
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
NS_DECL_NSITIMERCALLBACK
|
2004-11-12 22:26:37 +03:00
|
|
|
|
|
|
|
nsresult Init();
|
|
|
|
void StopAndJoin();
|
|
|
|
|
|
|
|
private:
|
|
|
|
static PRIntervalTime sTimeout;
|
|
|
|
static PRLock* sLock;
|
|
|
|
static PRCondVar* sCVar;
|
|
|
|
|
|
|
|
enum {
|
2006-05-10 21:30:15 +04:00
|
|
|
kTimeout = 60000 // milliseconds
|
2004-11-12 22:26:37 +03:00
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
static MemoryFlusher sGlobalMemoryFlusher;
|
2000-06-03 11:02:20 +04:00
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
#endif // NS_MEMORY_FLUSHER
|
2004-11-12 22:26:37 +03:00
|
|
|
|
|
|
|
static nsMemoryImpl sGlobalMemory;
|
|
|
|
|
|
|
|
NS_IMPL_QUERY_INTERFACE1(nsMemoryImpl, nsIMemory)
|
|
|
|
|
|
|
|
NS_IMETHODIMP_(void*)
|
2000-06-03 11:02:20 +04:00
|
|
|
nsMemoryImpl::Alloc(PRSize size)
|
|
|
|
{
|
2004-11-12 22:26:37 +03:00
|
|
|
return NS_Alloc(size);
|
2000-06-03 11:02:20 +04:00
|
|
|
}
|
|
|
|
|
2004-11-12 22:26:37 +03:00
|
|
|
NS_IMETHODIMP_(void*)
|
|
|
|
nsMemoryImpl::Realloc(void* ptr, PRSize size)
|
2000-06-03 11:02:20 +04:00
|
|
|
{
|
2004-11-12 22:26:37 +03:00
|
|
|
return NS_Realloc(ptr, size);
|
2000-06-03 11:02:20 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
NS_IMETHODIMP_(void)
|
2004-11-12 22:26:37 +03:00
|
|
|
nsMemoryImpl::Free(void* ptr)
|
2000-06-03 11:02:20 +04:00
|
|
|
{
|
2004-11-12 22:26:37 +03:00
|
|
|
NS_Free(ptr);
|
2000-06-03 11:02:20 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
NS_IMETHODIMP
|
2000-09-20 09:44:19 +04:00
|
|
|
nsMemoryImpl::HeapMinimize(PRBool aImmediate)
|
2000-06-03 11:02:20 +04:00
|
|
|
{
|
2001-10-26 04:09:22 +04:00
|
|
|
return FlushMemory(NS_LITERAL_STRING("heap-minimize").get(), aImmediate);
|
2000-06-03 11:02:20 +04:00
|
|
|
}
|
|
|
|
|
2000-08-24 12:35:13 +04:00
|
|
|
NS_IMETHODIMP
|
|
|
|
nsMemoryImpl::IsLowMemory(PRBool *result)
|
|
|
|
{
|
2005-06-02 08:24:07 +04:00
|
|
|
#if defined(WINCE)
|
|
|
|
MEMORYSTATUS stat;
|
|
|
|
GlobalMemoryStatus(&stat);
|
|
|
|
*result = ((float)stat.dwAvailPhys / stat.dwTotalPhys) < 0.1;
|
|
|
|
#elif defined(XP_WIN)
|
2000-08-24 12:35:13 +04:00
|
|
|
MEMORYSTATUS stat;
|
|
|
|
GlobalMemoryStatus(&stat);
|
|
|
|
*result = ((float)stat.dwAvailPageFile / stat.dwTotalPageFile) < 0.1;
|
|
|
|
#else
|
2000-09-20 09:44:19 +04:00
|
|
|
*result = PR_FALSE;
|
2000-08-24 12:35:13 +04:00
|
|
|
#endif
|
2000-09-20 09:44:19 +04:00
|
|
|
return NS_OK;
|
2000-08-24 12:35:13 +04:00
|
|
|
}
|
|
|
|
|
2004-11-12 22:26:37 +03:00
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
/*static*/ nsresult
|
|
|
|
nsMemoryImpl::InitFlusher()
|
2004-11-12 22:26:37 +03:00
|
|
|
{
|
2006-05-10 21:30:15 +04:00
|
|
|
#ifdef NS_MEMORY_FLUSHER
|
2004-11-12 22:26:37 +03:00
|
|
|
return sGlobalMemoryFlusher.Init();
|
|
|
|
#else
|
|
|
|
return NS_OK;
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
/*static*/ nsresult
|
2004-11-12 22:26:37 +03:00
|
|
|
nsMemoryImpl::Create(nsISupports* outer, const nsIID& aIID, void **aResult)
|
|
|
|
{
|
|
|
|
NS_ENSURE_NO_AGGREGATION(outer);
|
|
|
|
return sGlobalMemory.QueryInterface(aIID, aResult);
|
|
|
|
}
|
|
|
|
|
2000-06-03 11:02:20 +04:00
|
|
|
nsresult
|
2000-09-20 09:44:19 +04:00
|
|
|
nsMemoryImpl::FlushMemory(const PRUnichar* aReason, PRBool aImmediate)
|
2000-06-03 11:02:20 +04:00
|
|
|
{
|
|
|
|
nsresult rv;
|
2000-09-20 09:44:19 +04:00
|
|
|
|
|
|
|
if (aImmediate) {
|
|
|
|
// They've asked us to run the flusher *immediately*. We've
|
|
|
|
// got to be on the UI main thread for us to be able to do
|
|
|
|
// that...are we?
|
2006-05-10 21:30:15 +04:00
|
|
|
if (!NS_IsMainThread()) {
|
2000-09-20 09:44:19 +04:00
|
|
|
NS_ERROR("can't synchronously flush memory: not on UI thread");
|
|
|
|
return NS_ERROR_FAILURE;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
PRInt32 lastVal = PR_AtomicSet(&sIsFlushing, 1);
|
|
|
|
if (lastVal)
|
|
|
|
return NS_OK;
|
2000-09-20 09:44:19 +04:00
|
|
|
|
|
|
|
// Run the flushers immediately if we can; otherwise, proxy to the
|
|
|
|
// UI thread an run 'em asynchronously.
|
|
|
|
if (aImmediate) {
|
2004-11-12 22:26:37 +03:00
|
|
|
rv = RunFlushers(aReason);
|
2000-09-20 09:44:19 +04:00
|
|
|
}
|
|
|
|
else {
|
2006-05-10 21:30:15 +04:00
|
|
|
sFlushEvent.mReason = aReason;
|
|
|
|
rv = NS_DispatchToMainThread(&sFlushEvent, NS_DISPATCH_NORMAL);
|
2000-09-20 09:44:19 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
return rv;
|
|
|
|
}
|
|
|
|
|
|
|
|
nsresult
|
2004-11-12 22:26:37 +03:00
|
|
|
nsMemoryImpl::RunFlushers(const PRUnichar* aReason)
|
2000-09-20 09:44:19 +04:00
|
|
|
{
|
2001-10-23 02:01:27 +04:00
|
|
|
nsCOMPtr<nsIObserverService> os = do_GetService("@mozilla.org/observer-service;1");
|
2000-09-20 09:44:19 +04:00
|
|
|
if (os) {
|
2004-11-12 22:26:37 +03:00
|
|
|
os->NotifyObservers(this, "memory-pressure", aReason);
|
2000-06-03 11:02:20 +04:00
|
|
|
}
|
2000-09-20 09:44:19 +04:00
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
sIsFlushing = 0;
|
2000-06-03 11:02:20 +04:00
|
|
|
return NS_OK;
|
|
|
|
}
|
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
// XXX need NS_IMPL_STATIC_ADDREF/RELEASE
|
|
|
|
NS_IMETHODIMP_(nsrefcnt) nsMemoryImpl::FlushEvent::AddRef() { return 2; }
|
|
|
|
NS_IMETHODIMP_(nsrefcnt) nsMemoryImpl::FlushEvent::Release() { return 1; }
|
|
|
|
NS_IMPL_QUERY_INTERFACE1(nsMemoryImpl::FlushEvent, nsIRunnable)
|
2000-06-03 11:02:20 +04:00
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
NS_IMETHODIMP
|
|
|
|
nsMemoryImpl::FlushEvent::Run()
|
2000-06-03 11:02:20 +04:00
|
|
|
{
|
2006-05-10 21:30:15 +04:00
|
|
|
sGlobalMemory.RunFlushers(mReason);
|
|
|
|
return NS_OK;
|
2000-06-03 11:02:20 +04:00
|
|
|
}
|
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
PRInt32
|
|
|
|
nsMemoryImpl::sIsFlushing = 0;
|
2004-11-12 22:26:37 +03:00
|
|
|
|
|
|
|
nsMemoryImpl::FlushEvent
|
|
|
|
nsMemoryImpl::sFlushEvent;
|
|
|
|
|
2005-11-08 21:17:49 +03:00
|
|
|
XPCOM_API(void*)
|
2004-11-12 22:26:37 +03:00
|
|
|
NS_Alloc(PRSize size)
|
2000-09-29 03:17:49 +04:00
|
|
|
{
|
2004-11-12 22:26:37 +03:00
|
|
|
void* result = MALLOC1(size);
|
|
|
|
if (! result) {
|
|
|
|
// Request an asynchronous flush
|
|
|
|
sGlobalMemory.FlushMemory(NS_LITERAL_STRING("alloc-failure").get(), PR_FALSE);
|
|
|
|
}
|
|
|
|
return result;
|
2000-09-29 03:17:49 +04:00
|
|
|
}
|
2000-09-20 09:44:19 +04:00
|
|
|
|
2005-11-08 21:17:49 +03:00
|
|
|
XPCOM_API(void*)
|
2004-11-12 22:26:37 +03:00
|
|
|
NS_Realloc(void* ptr, PRSize size)
|
2000-06-03 11:02:20 +04:00
|
|
|
{
|
2004-11-12 22:26:37 +03:00
|
|
|
void* result = REALLOC1(ptr, size);
|
2006-01-10 23:39:35 +03:00
|
|
|
if (! result && size != 0) {
|
2004-11-12 22:26:37 +03:00
|
|
|
// Request an asynchronous flush
|
|
|
|
sGlobalMemory.FlushMemory(NS_LITERAL_STRING("alloc-failure").get(), PR_FALSE);
|
|
|
|
}
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
2005-11-08 21:17:49 +03:00
|
|
|
XPCOM_API(void)
|
2004-11-12 22:26:37 +03:00
|
|
|
NS_Free(void* ptr)
|
|
|
|
{
|
|
|
|
PR_Free(ptr);
|
|
|
|
}
|
2000-09-29 03:17:49 +04:00
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
#ifdef NS_MEMORY_FLUSHER
|
2004-11-12 22:26:37 +03:00
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
NS_IMPL_QUERY_INTERFACE1(MemoryFlusher, nsITimerCallback)
|
2004-11-12 22:26:37 +03:00
|
|
|
|
|
|
|
NS_IMETHODIMP
|
2006-05-10 21:30:15 +04:00
|
|
|
MemoryFlusher::Notify(nsITimer *timer)
|
2004-11-12 22:26:37 +03:00
|
|
|
{
|
2006-05-10 21:30:15 +04:00
|
|
|
PRBool isLowMemory;
|
|
|
|
sGlobalMemory.IsLowMemory(&isLowMemory);
|
2004-11-12 22:26:37 +03:00
|
|
|
|
|
|
|
#ifdef NS_TEST_MEMORY_FLUSHER
|
2006-05-10 21:30:15 +04:00
|
|
|
// Fire the flusher *every* time
|
|
|
|
isLowMemory = PR_TRUE;
|
2000-09-29 03:17:49 +04:00
|
|
|
#endif
|
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
if (isLowMemory)
|
|
|
|
sGlobalMemory.FlushMemory(NS_LITERAL_STRING("low-memory").get(),
|
|
|
|
PR_FALSE);
|
|
|
|
return NS_OK;
|
2000-08-06 20:23:04 +04:00
|
|
|
}
|
2000-07-11 10:03:08 +04:00
|
|
|
|
2004-11-12 22:26:37 +03:00
|
|
|
nsresult
|
|
|
|
MemoryFlusher::Init()
|
2000-08-06 20:23:04 +04:00
|
|
|
{
|
2006-05-10 21:30:15 +04:00
|
|
|
nsCOMPtr<nsITimer> timer = do_CreateInstance(NS_TIMER_CONTRACTID);
|
|
|
|
NS_ENSURE_STATE(timer);
|
2004-11-12 22:26:37 +03:00
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
// There is no need to keep a reference to the timer object because we
|
|
|
|
// don't need to kill the timer. It will be killed automatically when
|
|
|
|
// XPCOM is shutdown.
|
2004-11-12 22:26:37 +03:00
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
return timer->InitWithCallback(this, kTimeout,
|
|
|
|
nsITimer::TYPE_REPEATING_SLACK);
|
2004-11-12 22:26:37 +03:00
|
|
|
}
|
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
#endif // NS_MEMORY_FLUSHER
|
2004-11-12 22:26:37 +03:00
|
|
|
|
|
|
|
nsresult
|
|
|
|
NS_GetMemoryManager(nsIMemory* *result)
|
|
|
|
{
|
|
|
|
return sGlobalMemory.QueryInterface(NS_GET_IID(nsIMemory), (void**) result);
|
2000-06-03 11:02:20 +04:00
|
|
|
}
|