Back to index

lightning-sunbird  0.9+nobinonly
orkinHeap.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-  */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef _ORKINHEAP_
00039 #define _ORKINHEAP_ 1
00040 
00041 #ifndef _MDB_
00042 #include "mdb.h"
00043 #endif
00044 
00045 #ifndef _MORK_
00046 #include "mork.h"
00047 #endif
00048 
00049 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
00050 
00051 #define orkinHeap_kTag 0x68456150 /* ascii 'hEaP' */
00052 
00053 /*| orkinHeap: 
00054 |*/
00055 class orkinHeap : public nsIMdbHeap { //
00056 
00057 #ifdef MORK_DEBUG_HEAP_STATS
00058 protected:
00059   mork_num sHeap_AllocCount;  // number of times Alloc() is called
00060   mork_num sHeap_FreeCount;   // number of times Free() is called
00061   mork_num sHeap_BlockCount;  // number of outstanding blocks
00062   
00063   mork_num sHeap_BlockVolume; // sum of sizes for all outstanding blocks
00064   mork_num sHeap_HighWaterVolume;  // largest value of sHeap_BlockVolume seen
00065   mork_num sHeap_HighWaterTenKilo; // HighWaterVolume in 10K granularity
00066   mork_num sHeap_HighWaterHundredKilo; // HighWaterVolume in 100K granularity
00067   
00068 public: // getters
00069   mork_num HeapAllocCount() const { return sHeap_AllocCount; }
00070   mork_num HeapFreeCount() const { return sHeap_FreeCount; }
00071   mork_num HeapBlockCount() const { return sHeap_AllocCount - sHeap_FreeCount; }
00072   
00073   mork_num HeapBlockVolume() const { return sHeap_BlockVolume; }
00074   mork_num HeapHighWaterVolume() const { return sHeap_HighWaterVolume; }
00075 #endif /*MORK_DEBUG_HEAP_STATS*/
00076   
00077 public:
00078   orkinHeap(); // does nothing
00079   virtual ~orkinHeap(); // does nothing
00080     
00081 private: // copying is not allowed
00082   orkinHeap(const orkinHeap& other);
00083   orkinHeap& operator=(const orkinHeap& other);
00084 
00085 public:
00086 
00087 // { ===== begin nsIMdbHeap methods =====
00088   NS_IMETHOD Alloc(nsIMdbEnv* ev, // allocate a piece of memory
00089     mdb_size inSize,   // requested size of new memory block 
00090     void** outBlock);  // memory block of inSize bytes, or nil
00091     
00092   NS_IMETHOD Free(nsIMdbEnv* ev, // free block allocated earlier by Alloc()
00093     void* inBlock);
00094     
00095   NS_IMETHOD HeapAddStrongRef(nsIMdbEnv* ev); // does nothing
00096   NS_IMETHOD HeapCutStrongRef(nsIMdbEnv* ev); // does nothing
00097 // } ===== end nsIMdbHeap methods =====
00098 
00099 };
00100 
00101 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
00102 
00103 #endif /* _ORKINHEAP_ */