vm/AllocTracker.h

   1 /*
   2  * Copyright (C) 2008 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 /*
  17  * Allocation tracking and reporting.
  18  */
  19 #ifndef _DALVIK_ALLOCTRACKER
  20 #define _DALVIK_ALLOCTRACKER
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25
  26 /* initialization */
  27 bool dvmAllocTrackerStartup(void);
  28 void dvmAllocTrackerShutdown(void);
  29
  30 struct AllocRecord;
  31 typedef struct AllocRecord AllocRecord;
  32
  33 /*
  34  * Enable allocation tracking.  Does nothing if tracking is already enabled.
  35  */
  36 bool dvmEnableAllocTracker(void);
  37
  38 /*
  39  * Disable allocation tracking.  Does nothing if tracking is not enabled.
  40  */
  41 void dvmDisableAllocTracker(void);
  42
  43 /*
  44  * If allocation tracking is enabled, add a new entry to the set.
  45  */
  46 #define dvmTrackAllocation(_clazz, _size)                                   \
  47     {                                                                       \
  48         if (gDvm.allocRecords != NULL)                                      \
  49             dvmDoTrackAllocation(_clazz, _size);                            \
  50     }
  51 void dvmDoTrackAllocation(ClassObject* clazz, int size);
  52
  53 /*
  54  * Generate a DDM packet with all of the tracked allocation data.
  55  *
  56  * On success, returns "true" with "*pData" and "*pDataLen" set.  "*pData"
  57  * refers to newly-allocated storage that must be freed by the caller.
  58  */
  59 bool dvmGenerateTrackedAllocationReport(u1** pData, size_t* pDataLen);
  60
  61 /*
  62  * Dump the tracked allocations to the log file.  If "enable" is set, this
  63  * will enable tracking if it's not already on.
  64  */
  65 void dvmDumpTrackedAllocations(bool enable);
  66
  67 #ifdef __cplusplus
  68 }
  69 #endif
  70
  71 #endif /*_DALVIK_ALLOCTRACKER*/