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_H_
20#define DALVIK_ALLOCTRACKER_H_
21
22/* initialization */
23bool dvmAllocTrackerStartup(void);
24void dvmAllocTrackerShutdown(void);
25
26struct AllocRecord;
27
28/*
29 * Enable allocation tracking.  Does nothing if tracking is already enabled.
30 */
31bool dvmEnableAllocTracker(void);
32
33/*
34 * Disable allocation tracking.  Does nothing if tracking is not enabled.
35 */
36void dvmDisableAllocTracker(void);
37
38/*
39 * If allocation tracking is enabled, add a new entry to the set.
40 */
41#define dvmTrackAllocation(_clazz, _size)                                   \
42    {                                                                       \
43        if (gDvm.allocRecords != NULL)                                      \
44            dvmDoTrackAllocation(_clazz, _size);                            \
45    }
46void dvmDoTrackAllocation(ClassObject* clazz, size_t size);
47
48/*
49 * Generate a DDM packet with all of the tracked allocation data.
50 *
51 * On success, returns "true" with "*pData" and "*pDataLen" set.  "*pData"
52 * refers to newly-allocated storage that must be freed by the caller.
53 */
54bool dvmGenerateTrackedAllocationReport(u1** pData, size_t* pDataLen);
55
56/*
57 * Dump the tracked allocations to the log file.  If "enable" is set, this
58 * will enable tracking if it's not already on.
59 */
60void dvmDumpTrackedAllocations(bool enable);
61
62#endif  // DALVIK_ALLOCTRACKER_H_
63