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 MALLOC_DEBUG_CONFIG_H
30 #define MALLOC_DEBUG_CONFIG_H
31 
32 #include <stdint.h>
33 
34 constexpr uint64_t FRONT_GUARD = 0x1;
35 constexpr uint64_t REAR_GUARD = 0x2;
36 constexpr uint64_t BACKTRACE = 0x4;
37 constexpr uint64_t FILL_ON_ALLOC = 0x8;
38 constexpr uint64_t FILL_ON_FREE = 0x10;
39 constexpr uint64_t EXPAND_ALLOC = 0x20;
40 constexpr uint64_t FREE_TRACK = 0x40;
41 constexpr uint64_t TRACK_ALLOCS = 0x80;
42 constexpr uint64_t LEAK_TRACK = 0x100;
43 
44 // In order to guarantee posix compliance, set the minimum alignment
45 // to 8 bytes for 32 bit systems and 16 bytes for 64 bit systems.
46 #if defined(__LP64__)
47 constexpr size_t MINIMUM_ALIGNMENT_BYTES = 16;
48 #else
49 constexpr size_t MINIMUM_ALIGNMENT_BYTES = 8;
50 #endif
51 
52 // If only one or more of these options is set, then no special header is needed.
53 constexpr uint64_t NO_HEADER_OPTIONS = FILL_ON_ALLOC | FILL_ON_FREE | EXPAND_ALLOC;
54 
55 struct Config {
56   bool SetFromProperties();
57 
58   size_t front_guard_bytes = 0;
59   size_t rear_guard_bytes = 0;
60 
61   bool backtrace_enable_on_signal = false;
62   int backtrace_signal = 0;
63   bool backtrace_enabled = false;
64   size_t backtrace_frames = 0;
65 
66   size_t fill_on_alloc_bytes = 0;
67   size_t fill_on_free_bytes = 0;
68 
69   size_t expand_alloc_bytes = 0;
70 
71   size_t free_track_allocations = 0;
72   size_t free_track_backtrace_num_frames = 0;
73 
74   uint64_t options = 0;
75   uint8_t fill_alloc_value;
76   uint8_t fill_free_value;
77   uint8_t front_guard_value;
78   uint8_t rear_guard_value;
79 };
80 
81 #endif  // MALLOC_DEBUG_CONFIG_H
82