2002-01-24 09:41:01 +03:00
|
|
|
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* ***** 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 mozilla.org code.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2001, 2002
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Suresh Duddi <dp@netscape.com>
|
|
|
|
*
|
|
|
|
* 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 ***** */
|
|
|
|
|
|
|
|
/*
|
|
|
|
* nsRecyclingAllocator
|
|
|
|
*
|
|
|
|
* This allocator is useful when we cycle through a small set of allocations
|
|
|
|
* repeatedly with minimal overlap. For eg. something we do for every gif
|
|
|
|
* file read (or) buffers required for decompression of every file from jar.
|
|
|
|
*
|
|
|
|
* What this does is keeps around the first set of memory allocated and
|
|
|
|
* reuses it subsequently. If all buckets are full, this falls back to
|
|
|
|
* malloc/free
|
|
|
|
*
|
|
|
|
* Uses a timer to release all memory allocated if not used for more than
|
|
|
|
* 10 secs automatically.
|
|
|
|
*
|
2002-07-02 03:36:03 +04:00
|
|
|
* Also there is a 4 byte maintenance overhead on every allocation.
|
|
|
|
*
|
2002-01-24 09:41:01 +03:00
|
|
|
* This allocator is thread safe.
|
|
|
|
*
|
|
|
|
* CAVEATS: As the number of buckets increases, this allocators performance
|
2005-12-23 03:08:21 +03:00
|
|
|
* will drop, as the list of freed items is a linked list sorted on size.
|
2002-01-24 09:41:01 +03:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef nsRecyclingAllocator_h__
|
|
|
|
#define nsRecyclingAllocator_h__
|
|
|
|
|
|
|
|
#include "nscore.h"
|
2002-07-02 03:36:03 +04:00
|
|
|
#include "prlock.h"
|
|
|
|
#include "nsIRecyclingAllocator.h"
|
|
|
|
#include "nsIGenericFactory.h"
|
2002-01-24 09:41:01 +03:00
|
|
|
|
|
|
|
#define NS_DEFAULT_RECYCLE_TIMEOUT 10 // secs
|
2005-12-23 03:08:21 +03:00
|
|
|
#define NS_ALLOCATOR_OVERHEAD_BYTES (sizeof(PRSize)) // bytes
|
2002-01-24 09:41:01 +03:00
|
|
|
|
|
|
|
class nsITimer;
|
2002-07-02 03:36:03 +04:00
|
|
|
class nsIMemory;
|
2002-01-24 09:41:01 +03:00
|
|
|
|
|
|
|
class NS_COM nsRecyclingAllocator {
|
|
|
|
protected:
|
2002-07-02 03:36:03 +04:00
|
|
|
struct Block {
|
2002-08-14 16:47:18 +04:00
|
|
|
PRSize bytes;
|
2005-12-23 03:08:21 +03:00
|
|
|
Block *next;
|
2002-01-24 09:41:01 +03:00
|
|
|
};
|
|
|
|
|
2002-07-02 03:36:03 +04:00
|
|
|
#define DATA(block) ((void *)(((char *)block) + NS_ALLOCATOR_OVERHEAD_BYTES))
|
|
|
|
#define DATA_TO_BLOCK(data) ((Block *)((char *)(data) - NS_ALLOCATOR_OVERHEAD_BYTES))
|
|
|
|
|
2005-12-23 03:08:21 +03:00
|
|
|
// mMaxBlocks: Maximum number of blocks that are kept in the mFreeList for recycling
|
2002-07-02 03:36:03 +04:00
|
|
|
PRUint32 mMaxBlocks;
|
|
|
|
|
2005-12-23 03:08:21 +03:00
|
|
|
// mFreeListCount: Current number of blocks in the mFreeList
|
|
|
|
PRUint32 mFreeListCount;
|
2002-07-02 03:36:03 +04:00
|
|
|
|
2005-12-23 03:08:21 +03:00
|
|
|
// mFreeList: linked list of free blocks sorted by increasing order of size
|
|
|
|
Block* mFreeList;
|
2002-01-24 09:41:01 +03:00
|
|
|
|
2005-12-23 03:08:21 +03:00
|
|
|
// mLock: Thread safety for the member variables:
|
|
|
|
// mFreeList, mFreeListCount, mRecycleTimer, and mTouched
|
2002-07-02 03:36:03 +04:00
|
|
|
PRLock *mLock;
|
|
|
|
|
|
|
|
// Timer for freeing unused memory
|
2002-01-24 09:41:01 +03:00
|
|
|
nsITimer *mRecycleTimer;
|
2002-07-02 03:36:03 +04:00
|
|
|
|
|
|
|
// mRecycleAfter:
|
|
|
|
// Allocator should be untouched for this many seconds for freeing
|
|
|
|
// unused Blocks.
|
2002-01-24 09:41:01 +03:00
|
|
|
PRUint32 mRecycleAfter;
|
|
|
|
|
2002-07-02 03:36:03 +04:00
|
|
|
// mTouched:
|
2005-12-23 03:08:21 +03:00
|
|
|
// says if the allocator touched the freelist. If allocator didn't touch
|
|
|
|
// the freelist over a time time interval, timer will call ClearFreeList()
|
|
|
|
PRBool mTouched;
|
2002-01-24 09:41:01 +03:00
|
|
|
|
2005-12-23 03:08:21 +03:00
|
|
|
#ifdef DEBUG
|
2002-07-02 03:36:03 +04:00
|
|
|
// mId:
|
|
|
|
// a string for identifying the user of nsRecyclingAllocator
|
|
|
|
// User mainly for debug prints
|
2002-02-19 01:59:58 +03:00
|
|
|
const char *mId;
|
|
|
|
|
2002-07-02 03:36:03 +04:00
|
|
|
// mNAllocated: Number of blocks allocated
|
|
|
|
PRInt32 mNAllocated;
|
|
|
|
#endif
|
|
|
|
|
2002-01-24 09:41:01 +03:00
|
|
|
public:
|
|
|
|
|
2002-02-19 01:59:58 +03:00
|
|
|
// nbucket : number of buckets to hold. Capped at NS_MAX_BUCKET
|
|
|
|
// recycleAfter : Try recycling allocated buckets after this many seconds
|
|
|
|
// id : a string used to identify debug prints. Will not be released.
|
2002-07-02 03:36:03 +04:00
|
|
|
nsRecyclingAllocator(PRUint32 nbucket = 0, PRUint32 recycleAfter = NS_DEFAULT_RECYCLE_TIMEOUT,
|
2002-02-19 01:59:58 +03:00
|
|
|
const char *id = NULL);
|
2002-01-24 09:41:01 +03:00
|
|
|
~nsRecyclingAllocator();
|
|
|
|
|
2002-07-02 22:11:53 +04:00
|
|
|
nsresult Init(PRUint32 nbucket, PRUint32 recycleAfter, const char *id);
|
2002-07-02 03:36:03 +04:00
|
|
|
|
2002-01-24 09:41:01 +03:00
|
|
|
// Allocation and free routines
|
2002-08-14 16:47:18 +04:00
|
|
|
void* Malloc(PRSize size, PRBool zeroit = PR_FALSE);
|
2002-01-24 09:41:01 +03:00
|
|
|
void Free(void *ptr);
|
|
|
|
|
2002-08-14 16:47:18 +04:00
|
|
|
void* Calloc(PRUint32 items, PRSize size)
|
2002-01-24 09:41:01 +03:00
|
|
|
{
|
|
|
|
return Malloc(items * size, PR_TRUE);
|
|
|
|
}
|
|
|
|
|
2005-12-23 03:08:21 +03:00
|
|
|
// ClearFreeList - Frees all blocks kept by mFreelist, and stops the timer
|
|
|
|
void ClearFreeList();
|
2002-01-24 09:41:01 +03:00
|
|
|
|
|
|
|
protected:
|
|
|
|
|
2002-07-02 03:36:03 +04:00
|
|
|
// Timer callback to trigger unused memory
|
2002-01-24 09:41:01 +03:00
|
|
|
static void nsRecycleTimerCallback(nsITimer *aTimer, void *aClosure);
|
|
|
|
friend void nsRecycleTimerCallback(nsITimer *aTimer, void *aClosure);
|
|
|
|
};
|
|
|
|
|
2002-07-02 03:36:03 +04:00
|
|
|
// ----------------------------------------------------------------------
|
|
|
|
// Wrapping the recyling allocator with nsIMemory
|
|
|
|
// ----------------------------------------------------------------------
|
|
|
|
|
|
|
|
// Wrapping the nsRecyclingAllocator with nsIMemory
|
2003-03-15 04:04:32 +03:00
|
|
|
class nsRecyclingAllocatorImpl : public nsRecyclingAllocator, public nsIRecyclingAllocator {
|
2002-07-02 03:36:03 +04:00
|
|
|
public:
|
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
NS_DECL_NSIMEMORY
|
|
|
|
NS_DECL_NSIRECYCLINGALLOCATOR
|
|
|
|
|
|
|
|
nsRecyclingAllocatorImpl()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2004-01-15 09:14:18 +03:00
|
|
|
private:
|
|
|
|
~nsRecyclingAllocatorImpl() {}
|
2002-07-02 03:36:03 +04:00
|
|
|
};
|
2002-01-24 09:41:01 +03:00
|
|
|
#endif // nsRecyclingAllocator_h__
|