db/mork/src/orkinHeap.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-  */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1999
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef _ORKINHEAP_
  39 #define _ORKINHEAP_ 1
  40
  41 #ifndef _MDB_
  42 #include "mdb.h"
  43 #endif
  44
  45 #ifndef _MORK_
  46 #include "mork.h"
  47 #endif
  48
  49 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
  50
  51 #define orkinHeap_kTag 0x68456150 /* ascii 'hEaP' */
  52
  53 /*| orkinHeap:
  54 |*/
  55 class orkinHeap : public nsIMdbHeap { //
  56
  57 #ifdef MORK_DEBUG_HEAP_STATS
  58 protected:
  59   mork_num sHeap_AllocCount;  // number of times Alloc() is called
  60   mork_num sHeap_FreeCount;   // number of times Free() is called
  61   mork_num sHeap_BlockCount;  // number of outstanding blocks
  62
  63   mork_num sHeap_BlockVolume; // sum of sizes for all outstanding blocks
  64   mork_num sHeap_HighWaterVolume;  // largest value of sHeap_BlockVolume seen
  65   mork_num sHeap_HighWaterTenKilo; // HighWaterVolume in 10K granularity
  66   mork_num sHeap_HighWaterHundredKilo; // HighWaterVolume in 100K granularity
  67
  68 public: // getters
  69   mork_num HeapAllocCount() const { return sHeap_AllocCount; }
  70   mork_num HeapFreeCount() const { return sHeap_FreeCount; }
  71   mork_num HeapBlockCount() const { return sHeap_AllocCount - sHeap_FreeCount; }
  72
  73   mork_num HeapBlockVolume() const { return sHeap_BlockVolume; }
  74   mork_num HeapHighWaterVolume() const { return sHeap_HighWaterVolume; }
  75 #endif /*MORK_DEBUG_HEAP_STATS*/
  76
  77 public:
  78   orkinHeap(); // does nothing
  79   virtual ~orkinHeap(); // does nothing
  80
  81 private: // copying is not allowed
  82   orkinHeap(const orkinHeap& other);
  83   orkinHeap& operator=(const orkinHeap& other);
  84
  85 public:
  86
  87 // { ===== begin nsIMdbHeap methods =====
  88   NS_IMETHOD Alloc(nsIMdbEnv* ev, // allocate a piece of memory
  89     mdb_size inSize,   // requested size of new memory block
  90     void** outBlock);  // memory block of inSize bytes, or nil
  91
  92   NS_IMETHOD Free(nsIMdbEnv* ev, // free block allocated earlier by Alloc()
  93     void* inBlock);
  94
  95   NS_IMETHOD HeapAddStrongRef(nsIMdbEnv* ev); // does nothing
  96   NS_IMETHOD HeapCutStrongRef(nsIMdbEnv* ev); // does nothing
  97 // } ===== end nsIMdbHeap methods =====
  98
  99 };
 100
 101 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
 102
 103 #endif /* _ORKINHEAP_ */