1 /** 2 * Copyright (c) 2021-2022 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 #ifndef PANDA_VERIFIER_DEBUG_CONTEXT_H 17 #define PANDA_VERIFIER_DEBUG_CONTEXT_H 18 19 #include "verification/config/config.h" 20 #include "verification/config/debug_breakpoint/breakpoint.h" 21 #include "verification/public.h" 22 #include "verification/util/callable.h" 23 #include "verification/util/synchronized.h" 24 25 #include "runtime/include/mem/panda_containers.h" 26 #include "runtime/include/mem/panda_string.h" 27 28 #include <array> 29 #include <cstdint> 30 #include <unordered_map> 31 #include <unordered_set> 32 #include <vector> 33 34 namespace panda::verifier::debug { 35 36 enum class WhitelistKind : uint8_t { METHOD, METHOD_CALL, CLASS, LAST }; 37 38 struct DebugConfig { 39 // NOLINTBEGIN(misc-non-private-member-variables-in-classes) 40 PandaUnorderedMap<PandaString, panda::verifier::callable<bool(Config *cfg, const config::Section &)>> 41 sectionHandlers; 42 43 #ifndef NDEBUG 44 // note: this is assumed to be small so stored as a vector (not even sorted, so we use a linear search) 45 // if changed, a sorted vector or a PandaMap would likely be better than PandaUnorderedMap for faster comparison 46 PandaVector<std::pair<PandaString, Offsets>> managedBreakpoints; 47 void AddBreakpointConfig(const PandaString &methodName, Offset offset); 48 #else AddBreakpointConfigDebugConfig49 void AddBreakpointConfig([[maybe_unused]] const PandaString &methodName, [[maybe_unused]] Offset offset) {} 50 #endif 51 52 std::array<PandaVector<PandaString>, static_cast<size_t>(WhitelistKind::LAST)> whitelistNames; 53 bool whitelistNotEmpty = false; 54 // NOLINTEND(misc-non-private-member-variables-in-classes) 55 56 void AddWhitelistMethodConfig(WhitelistKind kind, const PandaString &name); 57 }; 58 59 struct DebugContext { 60 // NOLINTBEGIN(misc-non-private-member-variables-in-classes) 61 DebugConfig const *config = nullptr; 62 63 #ifndef NDEBUG 64 Synchronized<PandaUnorderedMap<Method::UniqId, PandaUnorderedSet<uint32_t>>> breakpoint; 65 #endif 66 67 struct { 68 // similar to ManagedBreakpoints.Config 69 std::array<PandaVector<PandaString>, static_cast<size_t>(WhitelistKind::LAST)> names; 70 std::array<Synchronized<PandaUnorderedSet<Method::UniqId>>, static_cast<size_t>(WhitelistKind::LAST)> id; 71 bool isNotEmpty = false; 72 } whitelist; 73 74 // NOLINTEND(misc-non-private-member-variables-in-classes) 75 76 public: SetConfigDebugContext77 void SetConfig(DebugConfig const *cfg) 78 { 79 config = cfg; 80 } 81 82 void AddMethod(const Method &method, bool isDebug); 83 SkipVerificationDebugContext84 bool SkipVerification(Method::UniqId id) const 85 { 86 return InWhitelist(WhitelistKind::METHOD, id) || InWhitelist(WhitelistKind::CLASS, id); 87 } 88 SkipVerificationOfCallDebugContext89 bool SkipVerificationOfCall(Method::UniqId id) const 90 { 91 return InWhitelist(WhitelistKind::METHOD_CALL, id) || InWhitelist(WhitelistKind::CLASS, id); 92 } 93 94 private: 95 #ifndef NDEBUG 96 void InsertBreakpoints(PandaString const &methodName, Method::UniqId id); 97 #else 98 void InsertBreakpoints([[maybe_unused]] PandaString const &methodName, [[maybe_unused]] Method::UniqId id) {} 99 #endif 100 101 void InsertIntoWhitelist(const PandaString &name, bool isClassName, Method::UniqId id); 102 bool InWhitelist(WhitelistKind kind, uint64_t id) const; 103 }; 104 } // namespace panda::verifier::debug 105 106 #endif // !PANDA_VERIFIER_DEBUG_CONTEXT_H 107