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 #pragma once 30 31 #include <stdint.h> 32 33 #include <string> 34 #include <unordered_map> 35 36 constexpr uint64_t FRONT_GUARD = 0x1; 37 constexpr uint64_t REAR_GUARD = 0x2; 38 constexpr uint64_t BACKTRACE = 0x4; 39 constexpr uint64_t FILL_ON_ALLOC = 0x8; 40 constexpr uint64_t FILL_ON_FREE = 0x10; 41 constexpr uint64_t EXPAND_ALLOC = 0x20; 42 constexpr uint64_t FREE_TRACK = 0x40; 43 constexpr uint64_t TRACK_ALLOCS = 0x80; 44 constexpr uint64_t LEAK_TRACK = 0x100; 45 constexpr uint64_t RECORD_ALLOCS = 0x200; 46 47 // In order to guarantee posix compliance, set the minimum alignment 48 // to 8 bytes for 32 bit systems and 16 bytes for 64 bit systems. 49 #if defined(__LP64__) 50 constexpr size_t MINIMUM_ALIGNMENT_BYTES = 16; 51 #else 52 constexpr size_t MINIMUM_ALIGNMENT_BYTES = 8; 53 #endif 54 55 // If one or more of these options is set, then a special header is needed. 56 constexpr uint64_t HEADER_OPTIONS = FRONT_GUARD | REAR_GUARD; 57 58 class Config { 59 public: 60 bool Init(const char* options_str); 61 62 void LogUsage() const; 63 64 uint64_t options() const { return options_; } 65 66 int backtrace_signal() const { return backtrace_signal_; } 67 int backtrace_dump_signal() const { return backtrace_dump_signal_; } 68 size_t backtrace_frames() const { return backtrace_frames_; } 69 size_t backtrace_enabled() const { return backtrace_enabled_; } 70 size_t backtrace_enable_on_signal() const { return backtrace_enable_on_signal_; } 71 bool backtrace_dump_on_exit() const { return backtrace_dump_on_exit_; } 72 const std::string& backtrace_dump_prefix() const { return backtrace_dump_prefix_; } 73 74 size_t front_guard_bytes() const { return front_guard_bytes_; } 75 size_t rear_guard_bytes() const { return rear_guard_bytes_; } 76 uint8_t front_guard_value() const { return front_guard_value_; } 77 uint8_t rear_guard_value() const { return rear_guard_value_; } 78 79 size_t expand_alloc_bytes() const { return expand_alloc_bytes_; } 80 81 size_t free_track_allocations() const { return free_track_allocations_; } 82 size_t free_track_backtrace_num_frames() const { return free_track_backtrace_num_frames_; } 83 84 size_t fill_on_alloc_bytes() const { return fill_on_alloc_bytes_; } 85 size_t fill_on_free_bytes() const { return fill_on_free_bytes_; } 86 uint8_t fill_alloc_value() const { return fill_alloc_value_; } 87 uint8_t fill_free_value() const { return fill_free_value_; } 88 89 int record_allocs_signal() const { return record_allocs_signal_; } 90 size_t record_allocs_num_entries() const { return record_allocs_num_entries_; } 91 const std::string& record_allocs_file() const { return record_allocs_file_; } 92 93 private: 94 struct OptionInfo { 95 uint64_t option; 96 bool (Config::*process_func)(const std::string&, const std::string&); 97 }; 98 99 bool ParseValue(const std::string& option, const std::string& value, size_t default_value, 100 size_t min_value, size_t max_value, size_t* new_value) const; 101 102 bool ParseValue(const std::string& option, const std::string& value, size_t min_value, 103 size_t max_value, size_t* parsed_value) const; 104 105 bool SetGuard(const std::string& option, const std::string& value); 106 bool SetFrontGuard(const std::string& option, const std::string& value); 107 bool SetRearGuard(const std::string& option, const std::string& value); 108 109 bool SetFill(const std::string& option, const std::string& value); 110 bool SetFillOnAlloc(const std::string& option, const std::string& value); 111 bool SetFillOnFree(const std::string& option, const std::string& value); 112 113 bool SetBacktrace(const std::string& option, const std::string& value); 114 bool SetBacktraceEnableOnSignal(const std::string& option, const std::string& value); 115 bool SetBacktraceDumpOnExit(const std::string& option, const std::string& value); 116 bool SetBacktraceDumpPrefix(const std::string& option, const std::string& value); 117 118 bool SetExpandAlloc(const std::string& option, const std::string& value); 119 120 bool SetFreeTrack(const std::string& option, const std::string& value); 121 bool SetFreeTrackBacktraceNumFrames(const std::string& option, const std::string& value); 122 123 bool SetRecordAllocs(const std::string& option, const std::string& value); 124 bool SetRecordAllocsFile(const std::string& option, const std::string& value); 125 126 bool VerifyValueEmpty(const std::string& option, const std::string& value); 127 128 static bool GetOption(const char** option_str, std::string* option, std::string* value); 129 130 const static std::unordered_map<std::string, OptionInfo> kOptions; 131 132 size_t front_guard_bytes_ = 0; 133 size_t rear_guard_bytes_ = 0; 134 135 bool backtrace_enable_on_signal_ = false; 136 int backtrace_signal_ = 0; 137 int backtrace_dump_signal_ = 0; 138 bool backtrace_enabled_ = false; 139 size_t backtrace_frames_ = 0; 140 bool backtrace_dump_on_exit_ = false; 141 std::string backtrace_dump_prefix_; 142 143 size_t fill_on_alloc_bytes_ = 0; 144 size_t fill_on_free_bytes_ = 0; 145 146 size_t expand_alloc_bytes_ = 0; 147 148 size_t free_track_allocations_ = 0; 149 size_t free_track_backtrace_num_frames_ = 0; 150 151 int record_allocs_signal_ = 0; 152 size_t record_allocs_num_entries_ = 0; 153 std::string record_allocs_file_; 154 155 uint64_t options_ = 0; 156 uint8_t fill_alloc_value_; 157 uint8_t fill_free_value_; 158 uint8_t front_guard_value_; 159 uint8_t rear_guard_value_; 160 }; 161
