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 constexpr uint64_t BACKTRACE_FULL = 0x400; 47 constexpr uint64_t ABORT_ON_ERROR = 0x800; 48 constexpr uint64_t VERBOSE = 0x1000; 49 constexpr uint64_t CHECK_UNREACHABLE_ON_SIGNAL = 0x2000; 50 constexpr uint64_t BACKTRACE_SPECIFIC_SIZES = 0x4000; 51 52 // In order to guarantee posix compliance, set the minimum alignment 53 // to 8 bytes for 32 bit systems and 16 bytes for 64 bit systems. 54 #if defined(__LP64__) 55 constexpr size_t MINIMUM_ALIGNMENT_BYTES = 16; 56 #else 57 constexpr size_t MINIMUM_ALIGNMENT_BYTES = 8; 58 #endif 59 60 // If one or more of these options is set, then a special header is needed. 61 constexpr uint64_t HEADER_OPTIONS = FRONT_GUARD | REAR_GUARD; 62 63 class Config { 64 public: 65 bool Init(const char* options_str); 66 67 void LogUsage() const; 68 options()69 uint64_t options() const { return options_; } 70 backtrace_signal()71 int backtrace_signal() const { return backtrace_signal_; } backtrace_dump_signal()72 int backtrace_dump_signal() const { return backtrace_dump_signal_; } backtrace_frames()73 size_t backtrace_frames() const { return backtrace_frames_; } backtrace_enabled()74 size_t backtrace_enabled() const { return backtrace_enabled_; } backtrace_enable_on_signal()75 size_t backtrace_enable_on_signal() const { return backtrace_enable_on_signal_; } backtrace_dump_on_exit()76 bool backtrace_dump_on_exit() const { return backtrace_dump_on_exit_; } backtrace_dump_prefix()77 const std::string& backtrace_dump_prefix() const { return backtrace_dump_prefix_; } 78 front_guard_bytes()79 size_t front_guard_bytes() const { return front_guard_bytes_; } rear_guard_bytes()80 size_t rear_guard_bytes() const { return rear_guard_bytes_; } front_guard_value()81 uint8_t front_guard_value() const { return front_guard_value_; } rear_guard_value()82 uint8_t rear_guard_value() const { return rear_guard_value_; } 83 expand_alloc_bytes()84 size_t expand_alloc_bytes() const { return expand_alloc_bytes_; } 85 free_track_allocations()86 size_t free_track_allocations() const { return free_track_allocations_; } free_track_backtrace_num_frames()87 size_t free_track_backtrace_num_frames() const { return free_track_backtrace_num_frames_; } 88 fill_on_alloc_bytes()89 size_t fill_on_alloc_bytes() const { return fill_on_alloc_bytes_; } fill_on_free_bytes()90 size_t fill_on_free_bytes() const { return fill_on_free_bytes_; } fill_alloc_value()91 uint8_t fill_alloc_value() const { return fill_alloc_value_; } fill_free_value()92 uint8_t fill_free_value() const { return fill_free_value_; } 93 backtrace_min_size_bytes()94 size_t backtrace_min_size_bytes() const { return backtrace_min_size_bytes_; } backtrace_max_size_bytes()95 size_t backtrace_max_size_bytes() const { return backtrace_max_size_bytes_; } 96 record_allocs_signal()97 int record_allocs_signal() const { return record_allocs_signal_; } record_allocs_num_entries()98 size_t record_allocs_num_entries() const { return record_allocs_num_entries_; } record_allocs_file()99 const std::string& record_allocs_file() const { return record_allocs_file_; } 100 check_unreachable_signal()101 int check_unreachable_signal() const { return check_unreachable_signal_; } 102 103 private: 104 struct OptionInfo { 105 uint64_t option; 106 bool (Config::*process_func)(const std::string&, const std::string&); 107 }; 108 109 bool ParseValue(const std::string& option, const std::string& value, size_t default_value, 110 size_t min_value, size_t max_value, size_t* new_value) const; 111 112 bool ParseValue(const std::string& option, const std::string& value, size_t min_value, 113 size_t max_value, size_t* parsed_value) const; 114 115 bool SetGuard(const std::string& option, const std::string& value); 116 bool SetFrontGuard(const std::string& option, const std::string& value); 117 bool SetRearGuard(const std::string& option, const std::string& value); 118 119 bool SetFill(const std::string& option, const std::string& value); 120 bool SetFillOnAlloc(const std::string& option, const std::string& value); 121 bool SetFillOnFree(const std::string& option, const std::string& value); 122 123 bool SetBacktrace(const std::string& option, const std::string& value); 124 bool SetBacktraceEnableOnSignal(const std::string& option, const std::string& value); 125 bool SetBacktraceDumpOnExit(const std::string& option, const std::string& value); 126 bool SetBacktraceDumpPrefix(const std::string& option, const std::string& value); 127 128 bool SetBacktraceSize(const std::string& option, const std::string& value); 129 bool SetBacktraceMinSize(const std::string& option, const std::string& value); 130 bool SetBacktraceMaxSize(const std::string& option, const std::string& value); 131 132 bool SetExpandAlloc(const std::string& option, const std::string& value); 133 134 bool SetFreeTrack(const std::string& option, const std::string& value); 135 bool SetFreeTrackBacktraceNumFrames(const std::string& option, const std::string& value); 136 137 bool SetRecordAllocs(const std::string& option, const std::string& value); 138 bool SetRecordAllocsFile(const std::string& option, const std::string& value); 139 140 bool VerifyValueEmpty(const std::string& option, const std::string& value); 141 142 static bool GetOption(const char** option_str, std::string* option, std::string* value); 143 144 const static std::unordered_map<std::string, OptionInfo> kOptions; 145 146 size_t front_guard_bytes_ = 0; 147 size_t rear_guard_bytes_ = 0; 148 149 bool backtrace_enable_on_signal_ = false; 150 int backtrace_signal_ = 0; 151 int backtrace_dump_signal_ = 0; 152 bool backtrace_enabled_ = false; 153 size_t backtrace_frames_ = 0; 154 bool backtrace_dump_on_exit_ = false; 155 std::string backtrace_dump_prefix_; 156 size_t backtrace_min_size_bytes_ = 0; 157 size_t backtrace_max_size_bytes_ = 0; 158 159 size_t fill_on_alloc_bytes_ = 0; 160 size_t fill_on_free_bytes_ = 0; 161 162 size_t expand_alloc_bytes_ = 0; 163 164 size_t free_track_allocations_ = 0; 165 size_t free_track_backtrace_num_frames_ = 0; 166 167 int record_allocs_signal_ = 0; 168 size_t record_allocs_num_entries_ = 0; 169 std::string record_allocs_file_; 170 171 uint64_t options_ = 0; 172 uint8_t fill_alloc_value_; 173 uint8_t fill_free_value_; 174 uint8_t front_guard_value_; 175 uint8_t rear_guard_value_; 176 177 int check_unreachable_signal_ = 0; 178 }; 179