1 /*
2  * Copyright (C) 2015 The Android Open Source Project
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *  * Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *  * Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *    the documentation and/or other materials provided with the
13  *    distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef DEBUG_MALLOC_DEBUGDATA_H
30 #define DEBUG_MALLOC_DEBUGDATA_H
31 
32 #include <stdint.h>
33 
34 #include <memory>
35 #include <vector>
36 
37 #include <private/bionic_macros.h>
38 
39 #include "BacktraceData.h"
40 #include "Config.h"
41 #include "FreeTrackData.h"
42 #include "GuardData.h"
43 #include "malloc_debug.h"
44 #include "TrackData.h"
45 
46 class DebugData {
47  public:
48   DebugData() = default;
49   ~DebugData() = default;
50 
51   bool Initialize();
52 
53   static bool Disabled();
54 
GetPointer(const Header * header)55   inline void* GetPointer(const Header* header) {
56     uintptr_t value = reinterpret_cast<uintptr_t>(header);
57     return reinterpret_cast<void*>(value + pointer_offset_);
58   }
59 
GetHeader(const void * pointer)60   Header* GetHeader(const void* pointer) {
61     uintptr_t value = reinterpret_cast<uintptr_t>(pointer);
62     return reinterpret_cast<Header*>(value - pointer_offset_);
63   }
64 
GetAllocBacktrace(const Header * header)65   BacktraceHeader* GetAllocBacktrace(const Header* header) {
66     uintptr_t value = reinterpret_cast<uintptr_t>(header);
67     return reinterpret_cast<BacktraceHeader*>(value + backtrace->alloc_offset());
68   }
69 
GetFrontGuard(const Header * header)70   uint8_t* GetFrontGuard(const Header* header) {
71     uintptr_t value = reinterpret_cast<uintptr_t>(header);
72     return reinterpret_cast<uint8_t*>(value + front_guard->offset());
73   }
74 
GetRearGuard(const Header * header)75   uint8_t* GetRearGuard(const Header* header) {
76     uintptr_t value = reinterpret_cast<uintptr_t>(GetPointer(header));
77     return reinterpret_cast<uint8_t*>(value + header->real_size());
78   }
79 
config()80   const Config& config() { return config_; }
pointer_offset()81   size_t pointer_offset() { return pointer_offset_; }
need_header()82   bool need_header() { return need_header_; }
extra_bytes()83   size_t extra_bytes() { return extra_bytes_; }
84 
85   void PrepareFork();
86   void PostForkParent();
87   void PostForkChild();
88 
89   std::unique_ptr<BacktraceData> backtrace;
90   std::unique_ptr<TrackData> track;
91   std::unique_ptr<FrontGuardData> front_guard;
92   std::unique_ptr<RearGuardData> rear_guard;
93   std::unique_ptr<FreeTrackData> free_track;
94 
95  private:
96   size_t extra_bytes_ = 0;
97 
98   size_t pointer_offset_ = 0;
99   bool need_header_ = false;
100 
101   Config config_;
102 
103   DISALLOW_COPY_AND_ASSIGN(DebugData);
104 };
105 
106 #endif // MALLOC_DEBUG_DEBUGDATA_H
107