tools/trace-malloc/adreader.h

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is the trace-malloc Allocation Dump Reader (adreader).
  15  *
  16  * The Initial Developer of the Original Code is L. David Baron.
  17  * Portions created by the Initial Developer are Copyright (C) 2002
  18  * the Initial Developer. All Rights Reserved.
  19  *
  20  * Contributor(s):
  21  *   L. David Baron <dbaron@dbaron.org> (original author)
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #include <stdlib.h>
  38
  39 #define ADLOG_ENTRY_BLOCK_SIZE 4096
  40
  41 class ADLog {
  42
  43 public:
  44
  45     // Use typedef in case somebody wants to process 64-bit output on a
  46     // 32-bit machine someday.
  47     typedef const char* Pointer;
  48
  49     struct Entry {
  50         Pointer address;
  51         const char *type;
  52
  53         const char *data;         // The contents of the memory.
  54         size_t datasize;
  55
  56         const char *allocation_stack;
  57     };
  58
  59     ADLog();
  60     ~ADLog();
  61
  62     /*
  63      * Returns false on failure and true on success.
  64      */
  65     bool Read(const char *aFilename);
  66
  67 private:
  68     // Link structure for a circularly linked list.
  69     struct EntryBlock;
  70     struct EntryBlockLink {
  71         EntryBlock *mPrev;
  72         EntryBlock *mNext;
  73     };
  74
  75     struct EntryBlock : public EntryBlockLink {
  76         Entry entries[ADLOG_ENTRY_BLOCK_SIZE];
  77     };
  78
  79     size_t mEntryCount;
  80     EntryBlockLink mEntries;
  81
  82 public:
  83
  84     class const_iterator {
  85         private:
  86             // Only |ADLog| member functions can construct iterators.
  87             friend class ADLog;
  88             const_iterator(EntryBlock *aBlock, size_t aOffset);
  89
  90         public:
  91             const Entry* operator*() { return mCur; }
  92             const Entry* operator->() { return mCur; }
  93
  94             const_iterator& operator++();
  95             const_iterator& operator--();
  96
  97             bool operator==(const const_iterator& aOther) const {
  98                 return mCur == aOther.mCur;
  99             }
 100
 101             bool operator!=(const const_iterator& aOther) const {
 102                 return mCur != aOther.mCur;
 103             }
 104
 105         private:
 106             void SetBlock(EntryBlock *aBlock) {
 107                 mBlock = aBlock;
 108                 mBlockStart = aBlock->entries;
 109                 mBlockEnd = aBlock->entries + ADLOG_ENTRY_BLOCK_SIZE;
 110             }
 111
 112             EntryBlock *mBlock;
 113             Entry *mCur, *mBlockStart, *mBlockEnd;
 114
 115             // Not to be implemented.
 116             const_iterator operator++(int);
 117             const_iterator operator--(int);
 118     };
 119
 120     const_iterator begin() {
 121         return const_iterator(mEntries.mNext, 0);
 122     }
 123     const_iterator end() {
 124         return const_iterator(mEntries.mPrev,
 125                               mEntryCount % ADLOG_ENTRY_BLOCK_SIZE);
 126     }
 127
 128     size_t count() { return mEntryCount; }
 129 };